Developer Resources > Examples

Examples

 

In this section, we will explore some examples of the different queries & mutations available on the API.

Note: For better readability, all of the available fields are not included in our example queries. To navigate through the Schema and see all of the fields available, please check our Documentation section.

Queries:

uuid:

When using the old webhooks you might receive resource ids as numeric ids. If you need any of those ids in one of our new queries or mutations, you can use this query to retrieve the uuid corresponding to that resource/entity numeric id as:

 query { 
    uuid(legacy_id:100579698, entity: Order) { 
        data { 
            legacy_id 
            id
        }
    }
}

and the response should look something like this:

{
  "data": {
    "uuid": {
      "data": {
        "legacy_id": 100579698,
        "id": "T3JkZXI6MTAwNTc5Njk4"
      }
    }
  }
}

Order:

This feature of the API allows to access a order’s details. To make it you should specify the order_id:

query {
  order(id: "T3JkZXI6MTAwNTc0MjM1") {
    request_id
    complexity
    data {
      id
      legacy_id
      order_number
      shop_name
      fulfillment_status
      order_date
      profile
      required_ship_date
      shipping_lines {
        carrier
        method
        price
      }
      shipping_address {
        first_name
        last_name
        address1
        address2
        city
        state
        state_code
        zip
        country
      }
      tags
      line_items(first: 2) {
        edges {
          node {
            id
            sku
            quantity
            product_name
            fulfillment_status
            quantity_allocated
            backorder_quantity
            barcode
          }
          cursor
        }
      }
      shipments {
        id
        order_id
        user_id
        warehouse_id
        address {
          name
          address1
          address2
          city
          state
          country
          zip
        }
        shipped_off_shiphero
        dropshipment
      }
      returns {
        id
        reason
        status
      }
    }
  }
}

Response:

{
  "data": {
    "order": {
      "request_id": "5d5454dd47de2ba3e95322c5",
      "complexity": 3,
      "data": {
        "id": "T3JkZXI6MTAwNTc0MjM1",
        "legacy_id": 100574235,
        "order_number": "MO519",
        "shop_name": "Manual Order",
        "fulfillment_status": "pending",
        "order_date": "2019-07-16T14:46:03+00:00",
        "profile": "default",
        "required_ship_date": "2019-07-18T00:00:00+00:00",
        "shipping_lines": {
          "carrier": "amazon",
          "method": "99",
          "price": null
        },
        "shipping_address": {
          "first_name": null,
          "last_name": null,
          "address1": "55 W RAILROAD AVE BLDG 4",
          "address2": null,
          "city": "GARNERVILLE",
          "state": "NY",
          "state_code": null,
          "zip": "10923-1261",
          "country": "US"
        },
        "tags": null,
        "line_items": {
          "edges": [
            {
              "node": {
                "id": "TGluZUl0ZW06Mjk0MDc2OTEw",
                "sku": "leandro-build-kit",
                "quantity": 1,
                "product_name": "Leandro Build Kit",
                "fulfillment_status": "broken_in_sets",
                "quantity_allocated": 0,
                "backorder_quantity": 0,
                "barcode": null
              },
              "cursor": "YXJyYXljb25uZWN0aW9uOjA="
            },
            {
              "node": {
                "id": "TGluZUl0ZW06Mjk0MDc2OTI0",
                "sku": "regular-kit-item-1",
                "quantity": 1,
                "product_name": "Regular Kit Item 1",
                "fulfillment_status": "pending",
                "quantity_allocated": 1,
                "backorder_quantity": 0,
                "barcode": null
              },
              "cursor": "YXJyYXljb25uZWN0aW9uOjE="
            }
          ]
        },
        "shipments": [],
        "returns": []
      }
    }
  }
}

Orders:

Similar to the order query, you could query for, many orders using the orders query and using a filter like:

  • shop_name
  • partner_order_id
  • order_number
  • warehouse_id
  • fulfillment_status
  • sku
  • email
  • updated_from & updated_to
  • order_date_from & order_date_to
  • customer_account_id

And the Query could be something like this:

query {
  orders(warehouse_id: "V2FyZWhvdXNlOjExNzkw") {
    request_id
    complexity
    data(first: 10) {
      edges {
        node {
          id
          legacy_id
          order_number
          partner_order_id
          shop_name
          fulfillment_status
          order_date
          total_tax
          subtotal
          total_discounts
          total_price
          auto_print_return_label
          custom_invoice_url
          account_id
          email
          profile
          packing_note
          required_ship_date
          flagged
          saturday_delivery
          ignore_address_validation_errors
          priority_flag
          source
          third_party_shipper {
            zip
            account_number
            country
          }

          gift_invoice
          order_history {
            created_at
            information
            user_id
          }
          allow_partial
          require_signature
          adult_signature_required
          alcohol
          expected_weight_in_oz
          insurance
          insurance_amount
          currency
          has_dry_ice
          allocation_priority
          allow_split
          line_items(first: 10) {
            edges {
              node {
                sku
                quantity
                quantity_allocated
                quantity_pending_fulfillment
                backorder_quantity
                promotion_discount
              }
            }
          }
        }
      }
    }
  }
}

Product:

This feature of the API allows you to get information about a product. To make it you should specify the id of the product:

query {
  product(id:"UHJvZHVjdEluZm86MjY5NTg0MTAw") {
    request_id
    complexity
    data {
      id
      legacy_id
      account_id
      name
      sku
      price
      value
      barcode
      country_of_manufacture
      dimensions {
        weight
        height
        width
        length
      }
      tariff_code
      value_currency
      kit
      kit_build
      no_air
      final_sale
      customs_value
      customs_description
      not_owned
      dropship
      created_at
      warehouse_products {
        warehouse_id
        warehouse_identifier
        on_hand
        inventory_bin
        inventory_overstock_bin
        reserve_inventory
        replenishment_level
        reorder_amount
        reorder_level
        custom
      }
      images {
        src
        position
      }
      tags
      vendors {
        vendor_id
        vendor_sku
      }
      product_note
      virtual
      ignore_on_invoice
      ignore_on_customs
      active
      kit_components {
        quantity
        sku
      }
    }
  }
}

Products:

Similar to the product query, you could also query for more than one product using the products query:

query {
  products {
    request_id
    complexity
    data(first: 100) {
      edges {
        node {
          id
          legacy_id
          account_id
          name
          sku
          barcode
          country_of_manufacture
          dimensions {
            height
            width
            length
            weight
          }
          tariff_code
          kit
          kit_build
          no_air
          final_sale
          customs_value
          customs_description
          not_owned
          dropship
          needs_serial_number
          thumbnail
          large_thumbnail
          created_at
          updated_at
          product_note
          virtual
          ignore_on_invoice
          ignore_on_customs
          active
          warehouse_products {
            warehouse_id
            on_hand
          }
          images {
            src
          }
          tags
          kit_components {
            sku
            quantity
          }
        }
      }
    }
  }
}

Note: The warehouse_products the section will allow you to see inventory levels and different characteristics of the product on each of your warehouses.

Returns:

We now have a more robust and complete way of accessing returns by using both the returns and return queries.
For example, if we needed to get information about a specific return, we will use the return Query, specifying the id.
The query should look something like this:

query {
  return(id: "UmV0dXJuOjc1MzYyNA==") {
    request_id
    complexity
    data {
      id
      legacy_id
      account_id
      order_id
      reason
      status
      label_type
      label_cost
      total_items_expected
      total_items_received
      total_items_restocked
      cost_to_customer
      shipping_carrier
      shipping_method
      address {
        address1
        address2
        city
        state
        country
        zip
      }
      line_items {
        id
        line_item_id
        warehouse_id
        product_id
        return_id
        quantity
        condition
      }
    }
  }
}

And the response should look something like this:

{
  "data": {
    "return": {
      "request_id": "5f46b7577b7f0383ea23378e",
      "complexity": 1,
      "data": {
        "id": "UmV0dXJuOjEzMjkwMDE=",
        "legacy_id": 1329001,
        "account_id": "QWNjb3VudDo2MzM0",
        "order_id": "T3JkZXI6MTI3MTQ4NDU3",
        "reason": "Too small",
        "status": "warehouse complete",
        "label_type": "FREE",
        "label_cost": "0.00",
        "total_items_expected": 1,
        "total_items_received": 0,
        "total_items_restocked": 0,
        "cost_to_customer": "0.00",
        "shipping_carrier": "UPS",
        "shipping_method": "Ground",
        "address": {
          "address1": "55 W RAILROAD AVE",
          "address2": "BLDG 4",
          "city": "GARNERVILLE",
          "state": "NY",
          "country": "US",
          "zip": "10923-1261"
        },
        "line_items": [
          {
            "id": "UmV0dXJuSXRlbToyMTM4NTI4",
            "line_item_id": "TGluZUl0ZW06MzcwODgwNjMw",
            "warehouse_id": "V2FyZWhvdXNlOjExNzkw",
            "product_id": "UHJvZHVjdDozMDE3MDU0MzI=",
            "return_id": "UmV0dXJuOjEzMjkwMDE=",
            "quantity": 1,
            "condition": "Good"
          }
        ]
      }
    }
  }
}

Note: For more information about returns visit our Returns section

Browse order history:

This new feature of the API allows navigating through an order’s history. To make it you should specify the order_id:

query {
  order_history(order_id: "T3JkZXI6OTkxMzAxMjE=") {
    request_id
    complexity
    data(first: 2) {
      edges {
        node {
          id
          order_id
          account_id
          order_number
          information
          order {
            shop_name
            fulfillment_status
            order_date
            email
            profile
            packing_note
            required_ship_date
            shipping_address {
              first_name
              last_name
              company
              address1
              address2
              city
              state
              state_code
              zip
              country
              country_code
              email
              phone
            }
          }
        }
        cursor
      }
    }
  }
}

Response:

{
  "data": {
    "order_history": {
      "request_id": "5d3b5f77233bd12e389388dc",
      "complexity": 3,
      "data": {
        "edges": [
          {
            "node": {
              "id": "T3JkZXJIaXN0b3J5OjIxMDk4MzkzNQ==",
              "order_id": "T3JkZXI6OTkxMzAxMjE=",
              "account_id": "QWNjb3VudDozODAx",
              "order_number": "MO506",
              "information": "Order Created.",
              "order": {
                "shop_name": "Manual Order",
                "fulfillment_status": "pending",
                "order_date": "2019-06-25T13:46:21+00:00",
                "ready_to_ship": false,
                "email": null,
                "profile": "default",
                "packing_note": null,
                "required_ship_date": "2019-06-27T00:00:00+00:00",
                "shipping_address": {
                  "first_name": null,
                  "last_name": null,
                  "company": null,
                  "address1": "54 W RAILROAD AVE BLDG 4",
                  "address2": "BLDG 4",
                  "city": "GARNERVILLE",
                  "state": "NY",
                  "state_code": null,
                  "zip": "10923",
                  "country": "US",
                  "country_code": null,
                  "email": null,
                  "phone": "8556055222"
                }
              }
            },
            "cursor": "YXJyYXljb25uZWN0aW9uOjA="
          },
          {
            "node": {
              "id": "T3JkZXJIaXN0b3J5OjIxMTAzNTcxNA==",
              "order_id": "T3JkZXI6OTkxMzAxMjE=",
              "account_id": "QWNjb3VudDozODAx",
              "order_number": null,
              "information": "Order lock was cleared manually by using the \"Remove Order Locks\" button for this user.",
              "order": {
                "shop_name": "Manual Order",
                "fulfillment_status": "pending",
                "order_date": "2019-06-25T13:46:21+00:00",
                "email": null,
                "profile": "default",
                "packing_note": null,
                "required_ship_date": "2019-06-27T00:00:00+00:00",
                "shipping_address": {
                  "first_name": null,
                  "last_name": null,
                  "company": null,
                  "address1": "54 W RAILROAD AVE BLDG 4",
                  "address2": "BLDG 4",
                  "city": "GARNERVILLE",
                  "state": "NY",
                  "state_code": null,
                  "zip": "10923",
                  "country": "US",
                  "country_code": null,
                  "email": null,
                  "phone": "8556055222"
                }
              }
            },
            "cursor": "YXJyYXljb25uZWN0aW9uOjE="
          }
        ]
      }
    }
  }
}

Shipment:

If you want to query for a specific shipment, you could query for a shipment, using the shipment_id, for example:

query{
  shipment(id:"U2hpcG1lbnQ6ODAxOTAwMTc="){
    request_id
    complexity
    data{
      id
          legacy_id
          order_id
          user_id
          warehouse_id
          pending_shipment_id
          address {
            name
            address1
            address2
            city
            state
            country
            zip
            phone
          }
          shipped_off_shiphero
          dropshipment
          created_date
          line_items(first: 10) {
            edges {
              node {
                line_item_id
                quantity
              }
            }
          }
          shipping_labels {
            id
            legacy_id
            account_id
            tracking_number
            carrier
            shipping_name
            shipping_method
            cost
            profile
            packing_slip
            warehouse
            insurance_amount
            carrier_account_id
            source
            created_date
          }
        }
      }
    }

Response:

  {
  "data": {
    "shipment": {
      "request_id": "5f46b99994b45764ed356d52",
      "complexity": 11,
      "data": {
        "id": "U2hpcG1lbnQ6ODAxOTAwMTc=",
        "legacy_id": 80190017,
        "order_id": "T3JkZXI6MTI3MTQ4NDU3",
        "user_id": null,
        "warehouse_id": "V2FyZWhvdXNlOjExNzkw",
        "pending_shipment_id": "UGVuZGluZ1NoaXBtZW50OjIwODczODAzOA==",
        "address": null,
        "shipped_off_shiphero": false,
        "dropshipment": false,
        "created_date": "2020-05-15T04:23:06+00:00",
        "line_items": {
          "edges": [
            {
              "node": {
                "line_item_id": "TGluZUl0ZW06MzcwODgwNjMw",
                "quantity": 1
              }
            }
          ]
        },
        "shipping_labels": [
          {
            "id": "U2hpcHBpbmdMYWJlbDo1NTk4MDYyMQ==",
            "legacy_id": 55980621,
            "account_id": "QWNjb3VudDo2MzM0",
            "tracking_number": null,
            "carrier": "genericlabel",
            "shipping_name": "Manual Order Shipping Method",
            "shipping_method": "genericlabel",
            "cost": "0.00",
            "profile": "default",
            "packing_slip": null,
            "warehouse": "Primary",
            "insurance_amount": "0.00",
            "carrier_account_id": null,
            "source": "endeavour mobil",
            "created_date": "2020-05-15T04:23:06+00:00"
          }
        ]
      }
    }
  }
}

Shipments:

This new feature of the API allows you to get all the shipments made on an order by using the order_id filter, or even get all the shipments made on a specific time frame, for example:

query {
  shipments(order_id: "141683690") {
    request_id
    complexity
    data {
      edges {
        node {
          id
          legacy_id
          order_id
          user_id
          warehouse_id
          pending_shipment_id
          address {
            name
            address1
            address2
            city
            state
            country
            zip
            phone
          }
          shipped_off_shiphero
          dropshipment
          created_date
          line_items(first: 10) {
            edges {
              node {
                line_item_id
                quantity
              }
            }
          }
          shipping_labels {
            id
            legacy_id
            account_id
            tracking_number
            carrier
            shipping_name
            shipping_method
            cost
            profile
            packing_slip
            warehouse
            insurance_amount
            carrier_account_id
            source
            created_date
          }
        }
      }
    }
  }
}

Response:

  "data": {
    "shipments": {
      "request_id": "5f3aeced950bae264fdd84d6",
      "complexity": 1001,
      "data": {
        "edges": [
          {
            "node": {
              "id": "U2hpcG1lbnQ6OTQyMzY4NjU=",
              "legacy_id": 94236865,
              "order_id": "T3JkZXI6MTQxNjgzNjkw",
              "user_id": null,
              "warehouse_id": "V2FyZWhvdXNlOjExNzkw",
              "pending_shipment_id": "UGVuZGluZ1NoaXBtZW50OjI0NDk4MTA5Ng==",
              "address": null,
              "shipped_off_shiphero": false,
              "dropshipment": false,
              "created_date": "2020-08-14T02:44:41+00:00",
              "line_items": {
                "edges": [
                  {
                    "node": {
                      "line_item_id": "TGluZUl0ZW06NDA0NDM2MzQ0",
                      "quantity": 1
                    }
                  }
                ]
              },
              "shipping_labels": [
                {
                  "id": "U2hpcHBpbmdMYWJlbDo2Nzk5NDkwMA==",
                  "legacy_id": 67994900,
                  "account_id": "QWNjb3VudDo2MzM0",
                  "tracking_number": null,
                  "carrier": "genericlabel",
                  "shipping_name": "Manual Order Shipping Method",
                  "shipping_method": "genericlabel",
                  "cost": "0.00",
                  "profile": "default",
                  "packing_slip": null,
                  "warehouse": "Primary",
                  "insurance_amount": "0.00",
                  "carrier_account_id": null,
                  "source": "shiphero v3 web",
                  "created_date": "2020-08-14T02:44:41+00:00"
                }
              ]
            }
          }
        ]
      }
    }
  }
}

You can also filter by using date_from or date_to.

Packs per day:

Gets the detail of each shipment’s package between the specified dates. Results are sorted by date, warehouse and user, but they can be filtered by warehouse_id if only interested in the packages from a particular warehouse.
The sorting can be overridden by specifying any other field or list of fields from the output type. In the following example, we want to retrieve certain info about what a user has packed on 2019-05-03. So the query for that would be something like:

query {
  packs_per_day(
    user_id: "VXNlcjo5MTIz"
    date_from: "2019-05-03"
    date_to: "2019-05-04"
  ) {
    request_id
    complexity
    data {
      edges {
        node {
          id
          shipment_id
          warehouse_id
          total_items
          unique_items
          barcodes_scanned
          created_at
          order {
            id
            order_number
          }
        }
        cursor
      }
    }
  }
}

And the response would look something like this:

{
  "data": {
    "packs_per_day": {
      "request_id": "5d3bd22669af712be6bacd54",
      "complexity": 101,
      "data": {
        "edges": [
          {
            "node": {
              "id": "UGFja1Jlc3VsdDoyOTkwNDc0Nw==",
              "shipment_id": "U2hpcG1lbnQ6NTA3OTI2ODI=",
              "warehouse_id": "V2FyZWhvdXNlOjY1NDU=",
              "total_items": 1,
              "unique_items": 1,
              "barcodes_scanned": 0,
              "created_at": "2019-05-03T20:11:05+00:00",
              "order": {
                "id": "T3JkZXI6OTYwMzI2NjU=",
                "order_number": "MO451"
              }
            },
            "cursor": "YXJyYXljb25uZWN0aW9uOjA="
          },
          {
            "node": {
              "id": "UGFja1Jlc3VsdDoyOTkwNTgzOQ==",
              "shipment_id": "U2hpcG1lbnQ6NTA3OTQxNzg=",
              "warehouse_id": "V2FyZWhvdXNlOjY1NDU=",
              "total_items": 2,
              "unique_items": 2,
              "barcodes_scanned": 0,
              "created_at": "2019-05-03T20:32:12+00:00",
              "order": {
                "id": "T3JkZXI6OTE3MDM5MTg=",
                "order_number": "MO335"
              }
            },
            "cursor": "YXJyYXljb25uZWN0aW9uOjE="
          },
          {
            "node": {
              "id": "UGFja1Jlc3VsdDoyOTkwNjI5Mg==",
              "shipment_id": "U2hpcG1lbnQ6NTA3OTQ3MDU=",
              "warehouse_id": "V2FyZWhvdXNlOjY1NDU=",
              "total_items": 1,
              "unique_items": 1,
              "barcodes_scanned": 0,
              "created_at": "2019-05-03T20:40:52+00:00",
              "order": {
                "id": "T3JkZXI6OTU2NzQ1MTQ=",
                "order_number": "MO420"
              }
            },
            "cursor": "YXJyYXljb25uZWN0aW9uOjI="
          }
        ]
      }
    }
  }
}

Line items pick:

Gets the detail of each line item picked between the specified dates. Results are sorted by date, warehouse, and user, but they can be filtered by warehouse_id if only interested in the picks from a particular warehouse. The sorting can be overridden by specifying any other field or list of fields from the output type.

For example, if we wanted to retrieve certain info about what items had been picked on 2019-04-30.

query {
  picks_per_day(date_from: "2019-04-30", date_to: "2019-05-01") {
    request_id
    complexity
    data {
      edges {
        node {
          id
          user_id
          tote_id
          line_item_id
          location_id
          order_id
          order_number
          user_first_name
          user_last_name
          inventory_bin
          sku
          quantity
          picked_quantity
          pick_type
          barcode_scanned
          created_at
        }
        cursor
      }
    }
  }
}

And the response would look something like this:

{
  "data": {
    "picks_per_day": {
      "request_id": "5d3bd9ee370a8cb90b7a8013",
      "complexity": 101,
      "data": {
        "edges": [
          {
            "node": {
              "id": "UGlja1Jlc3VsdDoxOTg0MzQ5OQ==",
              "user_id": "VXNlcjo5MTIz",
              "tote_id": "VG90ZToxMTk3OTc=",
              "line_item_id": "TGluZUl0ZW06Mjc4NDI2MDUw",
              "location_id": "QmluOjA=",
              "order_id": "T3JkZXI6OTU3MjQyNzk=",
              "order_number": "MO425",
              "user_first_name": "Tom",
              "user_last_name": "Wingord",
              "inventory_bin": null,
              "sku": "12347944271944",
              "quantity": 1,
              "picked_quantity": 1,
              "pick_type": null,
              "barcode_scanned": "No",
              "created_at": "2019-04-30T06:48:29+00:00"
            },
            "cursor": "YXJyYXljb25uZWN0aW9uOjA="
          },
          {
            "node": {
              "id": "UGlja1Jlc3VsdDoxOTg0MzUwMg==",
              "user_id": "VXNlcjo5MTIz",
              "tote_id": "VG90ZToxMTk3OTc=",
              "line_item_id": "TGluZUl0ZW06Mjc4NDI2MDQ5",
              "location_id": "QmluOjA=",
              "order_id": "T3JkZXI6OTU3MjQyNzk=",
              "order_number": "MO425",
              "user_first_name": "Tom",
              "user_last_name": "Wingord",
              "inventory_bin": null,
              "sku": "12280811454536",
              "quantity": 1,
              "picked_quantity": 1,
              "pick_type": null,
              "barcode_scanned": "No",
              "created_at": "2019-04-30T06:48:32+00:00"
            },
            "cursor": "YXJyYXljb25uZWN0aW9uOjE="
          },
          {
            "node": {
              "id": "UGlja1Jlc3VsdDoxOTg0MzUwOA==",
              "user_id": "VXNlcjo5MTIz",
              "tote_id": "VG90ZToxMTk3OTc=",
              "line_item_id": "TGluZUl0ZW06Mjc4NDI2MDQ3",
              "location_id": "QmluOjA=",
              "order_id": "T3JkZXI6OTU3MjQyNzk=",
              "order_number": "MO425",
              "user_first_name": "Tom",
              "user_last_name": "Wingord",
              "inventory_bin": null,
              "sku": "12838025822280",
              "quantity": 1,
              "picked_quantity": 1,
              "pick_type": null,
              "barcode_scanned": "No",
              "created_at": "2019-04-30T06:48:35+00:00"
            },
            "cursor": "YXJyYXljb25uZWN0aW9uOjI="
          }          
        ]
      }
    }
  }
}

Purchase Order:

With the purchase_order query, you can get the information about a purchase order, using the order_id

For example:

query {
  purchase_order(id: "473868") {
    request_id
    complexity
    data {
      id
      legacy_id
      po_number
      account_id
      warehouse_id
      vendor {
            id
            legacy_id
            name
            email
            account_number
            account_id
            address {
              name
              address1
              address2
              city
              state
              country
              zip
              phone
            }
            currency
            internal_note
            default_po_note
            logo
            partner_vendor_id
            created_at
          }
      created_at
      po_date
      date_closed
      packing_note
      fulfillment_status
      po_note
      description
      subtotal
      discount
      total_price
      tax
      shipping_method
      shipping_carrier
      shipping_name
      shipping_price
      tracking_number
      pdf
      images
      payment_method
      payment_due_by
      payment_note
      locking
      locked_by_user_id
      line_items(first: 100) {
        edges {
          node {
            id
            legacy_id
            po_id
            account_id
            warehouse_id
            vendor_id
            po_number
            sku
            barcode
            vendor_sku
            product_id
            variant_id
            quantity
            quantity_received
            quantity_rejected
            price
            product_name
            option_title
            expected_weight_in_lbs
            fulfillment_status
            sell_ahead
            note
            partner_line_item_id
            updated_at
            created_at
          }
        }
      }
    }
  }
}

Purchase Orders:

With the purchase_orders query, you can get the information about many purchase orders and filter by

  • sku
  • warehouse_id
  • created_from & created_to
  • po_date_from & po_date_to (a.k.a Expected Date)
  • customer_account_id

For example:

query {
  purchase_orders(warehouse_id:"V2FyZWhvdXNlOjExNzkw") {
    request_id
    complexity
    data(first: 2) {
      edges {
        node {
          id
          legacy_id
          po_number
          account_id
          warehouse_id
          vendor_id
          created_at
          po_date
          date_closed
          packing_note
          fulfillment_status
          po_note
          description
          subtotal
          discount
          total_price
          tax
          shipping_method
          shipping_carrier
          shipping_name
          shipping_price
          tracking_number
          pdf
          images
          payment_method
          payment_due_by
          payment_note
          locking
          locked_by_user_id
        }
      }
    }
  }
}

Vendors:

To get the list of all available Vendors, you can use the vendor’s query, which is something like this:

query {
  vendors {
    request_id
    complexity
    data(first: 10) {
      edges {
        node {
          id
          legacy_id
          name
          email
          account_number
          account_id
          address {
            name
            address1
            address2
            city
            state
            country
            zip
            phone
          }
          currency
          internal_note
          default_po_note
          logo
          partner_vendor_id
          created_at
        }
      }
    }
  }
}

Inventory Changes:

You can also use this query to get all the inventory changes made to one SKU, for example:

query {
  inventory_changes(sku: "1122334888") {
    request_id
    complexity
    data(first: 10) {
      edges {
        node {
          user_id
          account_id
          warehouse_id
          sku
          previous_on_hand
          change_in_on_hand
          reason
          cycle_counted
          location_id
          created_at
          location {
            id
            legacy_id
            account_id
            warehouse_id
            name
            zone
            pickable
            sellable
            is_cart
            temperature
            last_counted
            created_at
          }
        }
      }
    }
  }
}

This query slightly changes if you are on Dynamic or Static Slotting. For example, Location will only populate for Dynamic Slotting accounts.

Other filters available for this Query can be:

  • Location ID
  • Location Name
  • Date From
  • Date To

Warehouse products:

Using the warehouse_id you can retreive the products from that warehouse, for example:

query {
  warehouse_products(warehouse_id: "V2FyZWhvdXNlOjgwNzU=") {
    request_id
    complexity
    data(first: 2) {
      edges {
        node {
          id
          account_id
          on_hand
          inventory_bin
          reserve_inventory
          reorder_amount
          reorder_level
          custom
          warehouse {
            id
            dynamic_slotting
            profile
          }
          product {
            id
            name
            sku
          }
        }
        cursor
      }
    }
  }
}

And the response should look something like this:

{
  "data": {
    "warehouse_products": {
      "request_id": "5d3bdbbf69af712be6bacd5c",
      "complexity": 3,
      "data": {
        "edges": [
          {
            "node": {
              "id": "UHJvZHVjdDoyODkxOTYyNjY=",
              "account_id": "QWNjb3VudDozODAx",
              "on_hand": 0,
              "inventory_bin": null,
              "reserve_inventory": 0,
              "reorder_amount": 1,
              "reorder_level": 0,
              "custom": false,
              "warehouse": {
                "id": "V2FyZWhvdXNlOjgwNzU=",
                "dynamic_slotting": false,
                "profile": "default"
              },
              "product": {
                "id": "UHJvZHVjdEluZm86MjYyODc2NDA3",
                "name": "8th of LA Short Overalls- Ally Wash Large",
                "sku": "12258196226120"
              }
            },
            "cursor": "YXJyYXljb25uZWN0aW9uOjA="
          },
          {
            "node": {
              "id": "UHJvZHVjdDoyODcxNTM4OTA=",
              "account_id": "QWNjb3VudDozODAx",
              "on_hand": 0,
              "inventory_bin": null,
              "reserve_inventory": 0,
              "reorder_amount": 1,
              "reorder_level": 0,
              "custom": false,
              "warehouse": {
                "id": "V2FyZWhvdXNlOjgwNzU=",
                "dynamic_slotting": false,
                "profile": "default"
              },
              "product": {
                "id": "UHJvZHVjdEluZm86MjYyODc5NTI5",
                "name": "Deep Mint Ombre Hoodie X-Small",
                "sku": "12266021355592"
              }
            },
            "cursor": "YXJyYXljb25uZWN0aW9uOjE="
          }
        ]
      }
    }
  }
}