ShipHero GraphQL Public API Reference

undefined

API Endpoints
https://public-api.shiphero.com/graphql

Queries

account

Response

Returns an AccountQueryResult

Arguments
Name Description
analyze - Boolean

Example

Query
query account($analyze: Boolean) {
  account(analyze: $analyze) {
    request_id
    complexity
    data {
      ...AccountFragment
    }
  }
}
Variables
{"analyze": false}
Response
{
  "data": {
    "account": {
      "request_id": "abc123",
      "complexity": 123,
      "data": Account
    }
  }
}
Queries

bill

Response

Returns a BillQueryResult

Arguments
Name Description
id - String!
analyze - Boolean

Example

Query
query bill(
  $id: String!,
  $analyze: Boolean
) {
  bill(
    id: $id,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...BillFragment
    }
  }
}
Variables
{"id": "xyz789", "analyze": true}
Response
{
  "data": {
    "bill": {
      "request_id": "xyz789",
      "complexity": 987,
      "data": Bill
    }
  }
}
Queries

bills

Response

Returns a BillsQueryResult

Arguments
Name Description
from_date - ISODateTime
to_date - ISODateTime
status - String
analyze - Boolean

Example

Query
query bills(
  $from_date: ISODateTime,
  $to_date: ISODateTime,
  $status: String,
  $analyze: Boolean
) {
  bills(
    from_date: $from_date,
    to_date: $to_date,
    status: $status,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...BillConnectionFragment
    }
  }
}
Variables
{
  "from_date": ISODateTime,
  "to_date": ISODateTime,
  "status": "xyz789",
  "analyze": true
}
Response
{
  "data": {
    "bills": {
      "request_id": "abc123",
      "complexity": 987,
      "data": BillConnection
    }
  }
}
Queries

expiration_lots

Response

Returns a LotsQueryResult

Arguments
Name Description
sku - String
po_id - String
analyze - Boolean

Example

Query
query expiration_lots(
  $sku: String,
  $po_id: String,
  $analyze: Boolean
) {
  expiration_lots(
    sku: $sku,
    po_id: $po_id,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...LotConnectionFragment
    }
  }
}
Variables
{
  "sku": "xyz789",
  "po_id": "abc123",
  "analyze": false
}
Response
{
  "data": {
    "expiration_lots": {
      "request_id": "xyz789",
      "complexity": 123,
      "data": LotConnection
    }
  }
}
Queries

fulfillment_invoice

Response

Returns a FulfillmentInvoiceQueryResult

Arguments
Name Description
id - String
analyze - Boolean

Example

Query
query fulfillment_invoice(
  $id: String,
  $analyze: Boolean
) {
  fulfillment_invoice(
    id: $id,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...FulfillmentInvoiceFragment
    }
  }
}
Variables
{"id": "xyz789", "analyze": false}
Response
{
  "data": {
    "fulfillment_invoice": {
      "request_id": "abc123",
      "complexity": 987,
      "data": FulfillmentInvoice
    }
  }
}
Queries

fulfillment_invoices

Response

Returns a FulfillmentInvoicesQueryResult

Arguments
Name Description
date_from - ISODateTime
date_to - ISODateTime
analyze - Boolean

Example

Query
query fulfillment_invoices(
  $date_from: ISODateTime,
  $date_to: ISODateTime,
  $analyze: Boolean
) {
  fulfillment_invoices(
    date_from: $date_from,
    date_to: $date_to,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...FulfillmentInvoiceConnectionFragment
    }
  }
}
Variables
{
  "date_from": ISODateTime,
  "date_to": ISODateTime,
  "analyze": true
}
Response
{
  "data": {
    "fulfillment_invoices": {
      "request_id": "abc123",
      "complexity": 987,
      "data": FulfillmentInvoiceConnection
    }
  }
}
Queries

inventory_changes

Response

Returns an InventoryChangesQueryResult

Arguments
Name Description
sku - String
warehouse_id - String
location_id - String
location_name - String
date_from - ISODateTime
date_to - ISODateTime
customer_account_id - String
reason - String It performs a contains / like search and requires a date range, with a maximum of 60 days
analyze - Boolean

Example

Query
query inventory_changes(
  $sku: String,
  $warehouse_id: String,
  $location_id: String,
  $location_name: String,
  $date_from: ISODateTime,
  $date_to: ISODateTime,
  $customer_account_id: String,
  $reason: String,
  $analyze: Boolean
) {
  inventory_changes(
    sku: $sku,
    warehouse_id: $warehouse_id,
    location_id: $location_id,
    location_name: $location_name,
    date_from: $date_from,
    date_to: $date_to,
    customer_account_id: $customer_account_id,
    reason: $reason,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...InventoryChangeConnectionFragment
    }
  }
}
Variables
{
  "sku": "abc123",
  "warehouse_id": "xyz789",
  "location_id": "xyz789",
  "location_name": "abc123",
  "date_from": ISODateTime,
  "date_to": ISODateTime,
  "customer_account_id": "xyz789",
  "reason": "xyz789",
  "analyze": false
}
Response
{
  "data": {
    "inventory_changes": {
      "request_id": "abc123",
      "complexity": 987,
      "data": InventoryChangeConnection
    }
  }
}
Queries

inventory_snapshot

Response

Returns an InventorySnapshotQueryResult

Arguments
Name Description
snapshot_id - String!
analyze - Boolean

Example

Query
query inventory_snapshot(
  $snapshot_id: String!,
  $analyze: Boolean
) {
  inventory_snapshot(
    snapshot_id: $snapshot_id,
    analyze: $analyze
  ) {
    request_id
    complexity
    snapshot {
      ...InventorySnapshotFragment
    }
  }
}
Variables
{"snapshot_id": "abc123", "analyze": true}
Response
{
  "data": {
    "inventory_snapshot": {
      "request_id": "abc123",
      "complexity": 987,
      "snapshot": InventorySnapshot
    }
  }
}
Queries

inventory_snapshots

Response

Returns an InventorySnapshotsQueryResult

Arguments
Name Description
warehouse_id - String
customer_account_id - String
status - String

Any of the following statuses:

pending: Request received

enqueued: Queued for processing

processing: Being processed

success: Finished successfully

error: Terminated early due to an exception

aborted: Aborted by the user

Multiple statuses can be combined using: , e.g. status: "pending,processing"

One or more statuses can be excluded using: ! e.g. status: "!error_all,error_partial"

analyze - Boolean

Example

Query
query inventory_snapshots(
  $warehouse_id: String,
  $customer_account_id: String,
  $status: String,
  $analyze: Boolean
) {
  inventory_snapshots(
    warehouse_id: $warehouse_id,
    customer_account_id: $customer_account_id,
    status: $status,
    analyze: $analyze
  ) {
    request_id
    complexity
    snapshots {
      ...InventorySnapshotConnectionFragment
    }
  }
}
Variables
{
  "warehouse_id": "abc123",
  "customer_account_id": "abc123",
  "status": "abc123",
  "analyze": true
}
Response
{
  "data": {
    "inventory_snapshots": {
      "request_id": "abc123",
      "complexity": 987,
      "snapshots": InventorySnapshotConnection
    }
  }
}
Queries

inventory_sync_items_status

Response

Returns an InventorySyncRowsQueryResult

Arguments
Name Description
id - String!
status - String

Any of the following statuses:

pending: Queued for processing

processing: Being processed

success: Finished successfully

error: Matches all error states below

error_unknown: Unknown error occurred

error_not_found: Product was not found

Multiple statuses can be combined using: , e.g. status: "pending,processing"

One or more statuses can be excluded using: ! e.g. status: "!error_not_found"

analyze - Boolean

Example

Query
query inventory_sync_items_status(
  $id: String!,
  $status: String,
  $analyze: Boolean
) {
  inventory_sync_items_status(
    id: $id,
    status: $status,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...InventorySyncItemStatusConnectionFragment
    }
  }
}
Variables
{
  "id": "xyz789",
  "status": "abc123",
  "analyze": false
}
Response
{
  "data": {
    "inventory_sync_items_status": {
      "request_id": "abc123",
      "complexity": 987,
      "data": InventorySyncItemStatusConnection
    }
  }
}
Queries

inventory_sync_status

Response

Returns an InventorySyncBatchQueryResult

Arguments
Name Description
id - String
analyze - Boolean

Example

Query
query inventory_sync_status(
  $id: String,
  $analyze: Boolean
) {
  inventory_sync_status(
    id: $id,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...InventorySyncStatusFragment
    }
  }
}
Variables
{"id": "xyz789", "analyze": true}
Response
{
  "data": {
    "inventory_sync_status": {
      "request_id": "abc123",
      "complexity": 987,
      "data": InventorySyncStatus
    }
  }
}
Queries

inventory_sync_statuses

Response

Returns an InventorySyncBatchesQueryResult

Arguments
Name Description
warehouse_id - String
customer_account_id - String
status - String

Any of the following statuses:

pending: Queued for processing

processing: Being processed

success: Finished successfully

error: Matches all error states below

error_all: All rows failed

error_partial: Some rows failed

error_unknown: Terminated early due to an error

aborted: Aborted by the user

Multiple statuses can be combined using: , e.g. status: "pending,processing"

One or more statuses can be excluded using: ! e.g. status: "!error_all,error_partial"

analyze - Boolean

Example

Query
query inventory_sync_statuses(
  $warehouse_id: String,
  $customer_account_id: String,
  $status: String,
  $analyze: Boolean
) {
  inventory_sync_statuses(
    warehouse_id: $warehouse_id,
    customer_account_id: $customer_account_id,
    status: $status,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...InventorySyncStatusConnectionFragment
    }
  }
}
Variables
{
  "warehouse_id": "abc123",
  "customer_account_id": "xyz789",
  "status": "xyz789",
  "analyze": false
}
Response
{
  "data": {
    "inventory_sync_statuses": {
      "request_id": "abc123",
      "complexity": 987,
      "data": InventorySyncStatusConnection
    }
  }
}
Queries

location

Response

Returns a LocationQueryResult

Arguments
Name Description
id - String
name - String
analyze - Boolean

Example

Query
query location(
  $id: String,
  $name: String,
  $analyze: Boolean
) {
  location(
    id: $id,
    name: $name,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...LocationFragment
    }
  }
}
Variables
{
  "id": "abc123",
  "name": "abc123",
  "analyze": true
}
Response
{
  "data": {
    "location": {
      "request_id": "abc123",
      "complexity": 123,
      "data": Location
    }
  }
}
Queries

locations

Response

Returns a LocationsQueryResult

Arguments
Name Description
warehouse_id - String
sku - String
analyze - Boolean

Example

Query
query locations(
  $warehouse_id: String,
  $sku: String,
  $analyze: Boolean
) {
  locations(
    warehouse_id: $warehouse_id,
    sku: $sku,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...LocationConnectionFragment
    }
  }
}
Variables
{
  "warehouse_id": "xyz789",
  "sku": "xyz789",
  "analyze": false
}
Response
{
  "data": {
    "locations": {
      "request_id": "xyz789",
      "complexity": 123,
      "data": LocationConnection
    }
  }
}
Queries

me

Response

Returns a CurrentUserQueryResult

Arguments
Name Description
analyze - Boolean

Example

Query
query me($analyze: Boolean) {
  me(analyze: $analyze) {
    request_id
    complexity
    data {
      ...UserFragment
    }
  }
}
Variables
{"analyze": true}
Response
{
  "data": {
    "me": {
      "request_id": "abc123",
      "complexity": 123,
      "data": User
    }
  }
}
Queries

node

Description

The ID of the object

Response

Returns a Node

Arguments
Name Description
id - ID!

Example

Query
query node($id: ID!) {
  node(id: $id) {
    id
  }
}
Variables
{"id": "4"}
Response
{"data": {"node": {"id": "4"}}}
Queries

order

Response

Returns an OrderQueryResult

Arguments
Name Description
id - String!
analyze - Boolean

Example

Query
query order(
  $id: String!,
  $analyze: Boolean
) {
  order(
    id: $id,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...OrderFragment
    }
  }
}
Variables
{"id": "abc123", "analyze": false}
Response
{
  "data": {
    "order": {
      "request_id": "xyz789",
      "complexity": 987,
      "data": Order
    }
  }
}
Queries

order_history

Response

Returns an OrderHistoryQueryResult

Arguments
Name Description
order_id - String
user_id - String
order_number - String
username - String
date_from - Date
date_to - Date
analyze - Boolean

Example

Query
query order_history(
  $order_id: String,
  $user_id: String,
  $order_number: String,
  $username: String,
  $date_from: Date,
  $date_to: Date,
  $analyze: Boolean
) {
  order_history(
    order_id: $order_id,
    user_id: $user_id,
    order_number: $order_number,
    username: $username,
    date_from: $date_from,
    date_to: $date_to,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...OrderHistoryConnectionFragment
    }
  }
}
Variables
{
  "order_id": "abc123",
  "user_id": "xyz789",
  "order_number": "xyz789",
  "username": "abc123",
  "date_from": "2007-12-03",
  "date_to": "2007-12-03",
  "analyze": true
}
Response
{
  "data": {
    "order_history": {
      "request_id": "abc123",
      "complexity": 987,
      "data": OrderHistoryConnection
    }
  }
}
Queries

orders

Response

Returns an OrdersQueryResult

Arguments
Name Description
shop_name - String
partner_order_id - String
order_number - String
warehouse_id - String
allocated_warehouse_id - String
fulfillment_status - String
sku - String
email - String
updated_from - ISODateTime
updated_to - ISODateTime
order_date_from - ISODateTime
order_date_to - ISODateTime
customer_account_id - String If you are a 3PL you can specify one of your customer's account
has_hold - Boolean
operator_hold - Boolean
address_hold - Boolean
payment_hold - Boolean
fraud_hold - Boolean
ready_to_ship - Boolean
profile - String
tag - String
has_backorder - Boolean
analyze - Boolean

Example

Query
query orders(
  $shop_name: String,
  $partner_order_id: String,
  $order_number: String,
  $warehouse_id: String,
  $allocated_warehouse_id: String,
  $fulfillment_status: String,
  $sku: String,
  $email: String,
  $updated_from: ISODateTime,
  $updated_to: ISODateTime,
  $order_date_from: ISODateTime,
  $order_date_to: ISODateTime,
  $customer_account_id: String,
  $has_hold: Boolean,
  $operator_hold: Boolean,
  $address_hold: Boolean,
  $payment_hold: Boolean,
  $fraud_hold: Boolean,
  $ready_to_ship: Boolean,
  $profile: String,
  $tag: String,
  $has_backorder: Boolean,
  $analyze: Boolean
) {
  orders(
    shop_name: $shop_name,
    partner_order_id: $partner_order_id,
    order_number: $order_number,
    warehouse_id: $warehouse_id,
    allocated_warehouse_id: $allocated_warehouse_id,
    fulfillment_status: $fulfillment_status,
    sku: $sku,
    email: $email,
    updated_from: $updated_from,
    updated_to: $updated_to,
    order_date_from: $order_date_from,
    order_date_to: $order_date_to,
    customer_account_id: $customer_account_id,
    has_hold: $has_hold,
    operator_hold: $operator_hold,
    address_hold: $address_hold,
    payment_hold: $payment_hold,
    fraud_hold: $fraud_hold,
    ready_to_ship: $ready_to_ship,
    profile: $profile,
    tag: $tag,
    has_backorder: $has_backorder,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...OrderConnectionFragment
    }
  }
}
Variables
{
  "shop_name": "xyz789",
  "partner_order_id": "abc123",
  "order_number": "abc123",
  "warehouse_id": "abc123",
  "allocated_warehouse_id": "abc123",
  "fulfillment_status": "xyz789",
  "sku": "abc123",
  "email": "xyz789",
  "updated_from": ISODateTime,
  "updated_to": ISODateTime,
  "order_date_from": ISODateTime,
  "order_date_to": ISODateTime,
  "customer_account_id": "abc123",
  "has_hold": false,
  "operator_hold": true,
  "address_hold": false,
  "payment_hold": false,
  "fraud_hold": false,
  "ready_to_ship": false,
  "profile": "xyz789",
  "tag": "xyz789",
  "has_backorder": true,
  "analyze": false
}
Response
{
  "data": {
    "orders": {
      "request_id": "abc123",
      "complexity": 123,
      "data": OrderConnection
    }
  }
}
Queries

packs_per_day

Description

Gets the detail of each shipment's package between the specified dates.Results are sorted by date, warehouse and user, but they can be filteredby warehouse_id if only interested in the packages from a particular warehouse.The sorting can be overriden by specifying any other field or list of fields from the output type.

Response

Returns a PacksPerDayQueryResult

Arguments
Name Description
warehouse_id - String
user_id - String
order_id - String
order_number - String
date_from - ISODateTime
date_to - ISODateTime
analyze - Boolean

Example

Query
query packs_per_day(
  $warehouse_id: String,
  $user_id: String,
  $order_id: String,
  $order_number: String,
  $date_from: ISODateTime,
  $date_to: ISODateTime,
  $analyze: Boolean
) {
  packs_per_day(
    warehouse_id: $warehouse_id,
    user_id: $user_id,
    order_id: $order_id,
    order_number: $order_number,
    date_from: $date_from,
    date_to: $date_to,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...PackageConnectionFragment
    }
  }
}
Variables
{
  "warehouse_id": "abc123",
  "user_id": "xyz789",
  "order_id": "abc123",
  "order_number": "abc123",
  "date_from": ISODateTime,
  "date_to": ISODateTime,
  "analyze": false
}
Response
{
  "data": {
    "packs_per_day": {
      "request_id": "xyz789",
      "complexity": 123,
      "data": PackageConnection
    }
  }
}
Queries

picks_per_day

Description

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

Response

Returns a PicksPerDayQueryResult

Arguments
Name Description
warehouse_id - String
date_from - ISODateTime
date_to - ISODateTime
analyze - Boolean

Example

Query
query picks_per_day(
  $warehouse_id: String,
  $date_from: ISODateTime,
  $date_to: ISODateTime,
  $analyze: Boolean
) {
  picks_per_day(
    warehouse_id: $warehouse_id,
    date_from: $date_from,
    date_to: $date_to,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...PickConnectionFragment
    }
  }
}
Variables
{
  "warehouse_id": "abc123",
  "date_from": ISODateTime,
  "date_to": ISODateTime,
  "analyze": true
}
Response
{
  "data": {
    "picks_per_day": {
      "request_id": "xyz789",
      "complexity": 987,
      "data": PickConnection
    }
  }
}
Queries

product

Response

Returns a ProductQueryResult

Arguments
Name Description
id - String
sku - String
analyze - Boolean

Example

Query
query product(
  $id: String,
  $sku: String,
  $analyze: Boolean
) {
  product(
    id: $id,
    sku: $sku,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...ProductFragment
    }
  }
}
Variables
{
  "id": "xyz789",
  "sku": "abc123",
  "analyze": true
}
Response
{
  "data": {
    "product": {
      "request_id": "xyz789",
      "complexity": 987,
      "data": Product
    }
  }
}
Queries

products

Response

Returns a ProductsQueryResult

Arguments
Name Description
sku - String
created_from - ISODateTime
created_to - ISODateTime
updated_from - ISODateTime
updated_to - ISODateTime
customer_account_id - String If you are a 3PL you can specify one of your customer's account
has_kits - Boolean
analyze - Boolean

Example

Query
query products(
  $sku: String,
  $created_from: ISODateTime,
  $created_to: ISODateTime,
  $updated_from: ISODateTime,
  $updated_to: ISODateTime,
  $customer_account_id: String,
  $has_kits: Boolean,
  $analyze: Boolean
) {
  products(
    sku: $sku,
    created_from: $created_from,
    created_to: $created_to,
    updated_from: $updated_from,
    updated_to: $updated_to,
    customer_account_id: $customer_account_id,
    has_kits: $has_kits,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...ProductConnectionFragment
    }
  }
}
Variables
{
  "sku": "abc123",
  "created_from": ISODateTime,
  "created_to": ISODateTime,
  "updated_from": ISODateTime,
  "updated_to": ISODateTime,
  "customer_account_id": "abc123",
  "has_kits": true,
  "analyze": true
}
Response
{
  "data": {
    "products": {
      "request_id": "abc123",
      "complexity": 123,
      "data": ProductConnection
    }
  }
}
Queries

purchase_order

Response

Returns a PurchaseOrderQueryResult

Arguments
Name Description
id - String
po_number - String
analyze - Boolean

Example

Query
query purchase_order(
  $id: String,
  $po_number: String,
  $analyze: Boolean
) {
  purchase_order(
    id: $id,
    po_number: $po_number,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...PurchaseOrderFragment
    }
  }
}
Variables
{
  "id": "abc123",
  "po_number": "abc123",
  "analyze": false
}
Response
{
  "data": {
    "purchase_order": {
      "request_id": "xyz789",
      "complexity": 123,
      "data": PurchaseOrder
    }
  }
}
Queries

purchase_orders

Response

Returns a PurchaseOrdersQueryResult

Arguments
Name Description
sku - String
warehouse_id - String
created_from - ISODateTime
created_to - ISODateTime
po_date_from - ISODateTime
po_date_to - ISODateTime
customer_account_id - String If you are a 3PL you can specify one of your customer's account
date_closed_from - ISODateTime
date_closed_to - ISODateTime
fulfillment_status - String
analyze - Boolean

Example

Query
query purchase_orders(
  $sku: String,
  $warehouse_id: String,
  $created_from: ISODateTime,
  $created_to: ISODateTime,
  $po_date_from: ISODateTime,
  $po_date_to: ISODateTime,
  $customer_account_id: String,
  $date_closed_from: ISODateTime,
  $date_closed_to: ISODateTime,
  $fulfillment_status: String,
  $analyze: Boolean
) {
  purchase_orders(
    sku: $sku,
    warehouse_id: $warehouse_id,
    created_from: $created_from,
    created_to: $created_to,
    po_date_from: $po_date_from,
    po_date_to: $po_date_to,
    customer_account_id: $customer_account_id,
    date_closed_from: $date_closed_from,
    date_closed_to: $date_closed_to,
    fulfillment_status: $fulfillment_status,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...PurchaseOrderConnectionFragment
    }
  }
}
Variables
{
  "sku": "xyz789",
  "warehouse_id": "abc123",
  "created_from": ISODateTime,
  "created_to": ISODateTime,
  "po_date_from": ISODateTime,
  "po_date_to": ISODateTime,
  "customer_account_id": "xyz789",
  "date_closed_from": ISODateTime,
  "date_closed_to": ISODateTime,
  "fulfillment_status": "abc123",
  "analyze": false
}
Response
{
  "data": {
    "purchase_orders": {
      "request_id": "xyz789",
      "complexity": 987,
      "data": PurchaseOrderConnection
    }
  }
}
Queries

return

Response

Returns a ReturnQueryResult

Arguments
Name Description
id - String!
analyze - Boolean

Example

Query
query return(
  $id: String!,
  $analyze: Boolean
) {
  return(
    id: $id,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...ReturnFragment
    }
  }
}
Variables
{"id": "xyz789", "analyze": false}
Response
{
  "data": {
    "return": {
      "request_id": "abc123",
      "complexity": 123,
      "data": Return
    }
  }
}
Queries

return_exchange

Response

Returns a ReturnExchangeQueryResult

Arguments
Name Description
id - String!
analyze - Boolean

Example

Query
query return_exchange(
  $id: String!,
  $analyze: Boolean
) {
  return_exchange(
    id: $id,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...ReturnExchangeFragment
    }
  }
}
Variables
{"id": "xyz789", "analyze": false}
Response
{
  "data": {
    "return_exchange": {
      "request_id": "abc123",
      "complexity": 987,
      "data": ReturnExchange
    }
  }
}
Queries

returns

Response

Returns a ReturnsQueryResult

Arguments
Name Description
order_id - String
warehouse_id - String
date_from - ISODateTime
date_to - ISODateTime
customer_account_id - String If you are a 3PL you can specify one of your customer's account
analyze - Boolean

Example

Query
query returns(
  $order_id: String,
  $warehouse_id: String,
  $date_from: ISODateTime,
  $date_to: ISODateTime,
  $customer_account_id: String,
  $analyze: Boolean
) {
  returns(
    order_id: $order_id,
    warehouse_id: $warehouse_id,
    date_from: $date_from,
    date_to: $date_to,
    customer_account_id: $customer_account_id,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...ReturnConnectionFragment
    }
  }
}
Variables
{
  "order_id": "xyz789",
  "warehouse_id": "xyz789",
  "date_from": ISODateTime,
  "date_to": ISODateTime,
  "customer_account_id": "abc123",
  "analyze": true
}
Response
{
  "data": {
    "returns": {
      "request_id": "xyz789",
      "complexity": 987,
      "data": ReturnConnection
    }
  }
}
Queries

shipment

Response

Returns a ShipmentQueryResult

Arguments
Name Description
id - String
analyze - Boolean

Example

Query
query shipment(
  $id: String,
  $analyze: Boolean
) {
  shipment(
    id: $id,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...ShipmentFragment
    }
  }
}
Variables
{"id": "xyz789", "analyze": true}
Response
{
  "data": {
    "shipment": {
      "request_id": "xyz789",
      "complexity": 987,
      "data": Shipment
    }
  }
}
Queries

shipments

Response

Returns a ShipmentsQueryResult

Arguments
Name Description
order_id - String
date_from - ISODateTime
date_to - ISODateTime
order_date_from - ISODateTime
order_date_to - ISODateTime
tracking_number - String
alternate_tracking_id - String
voided - Boolean
analyze - Boolean

Example

Query
query shipments(
  $order_id: String,
  $date_from: ISODateTime,
  $date_to: ISODateTime,
  $order_date_from: ISODateTime,
  $order_date_to: ISODateTime,
  $tracking_number: String,
  $alternate_tracking_id: String,
  $voided: Boolean,
  $analyze: Boolean
) {
  shipments(
    order_id: $order_id,
    date_from: $date_from,
    date_to: $date_to,
    order_date_from: $order_date_from,
    order_date_to: $order_date_to,
    tracking_number: $tracking_number,
    alternate_tracking_id: $alternate_tracking_id,
    voided: $voided,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...ShipmentConnectionFragment
    }
  }
}
Variables
{
  "order_id": "xyz789",
  "date_from": ISODateTime,
  "date_to": ISODateTime,
  "order_date_from": ISODateTime,
  "order_date_to": ISODateTime,
  "tracking_number": "xyz789",
  "alternate_tracking_id": "xyz789",
  "voided": false,
  "analyze": false
}
Response
{
  "data": {
    "shipments": {
      "request_id": "abc123",
      "complexity": 123,
      "data": ShipmentConnection
    }
  }
}
Queries

shipping_plan

Response

Returns a ShippingPlanQueryResult

Arguments
Name Description
id - String
analyze - Boolean

Example

Query
query shipping_plan(
  $id: String,
  $analyze: Boolean
) {
  shipping_plan(
    id: $id,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...ShippingPlanFragment
    }
  }
}
Variables
{"id": "xyz789", "analyze": true}
Response
{
  "data": {
    "shipping_plan": {
      "request_id": "abc123",
      "complexity": 123,
      "data": ShippingPlan
    }
  }
}
Queries

tote

Response

Returns a ToteContentQueryResult

Arguments
Name Description
barcode - String!
analyze - Boolean

Example

Query
query tote(
  $barcode: String!,
  $analyze: Boolean
) {
  tote(
    barcode: $barcode,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...ToteFragment
    }
  }
}
Variables
{"barcode": "abc123", "analyze": false}
Response
{
  "data": {
    "tote": {
      "request_id": "abc123",
      "complexity": 123,
      "data": Tote
    }
  }
}
Queries

tote_history

Response

Returns a ToteHistoryQueryResult

Arguments
Name Description
tote_name - String
tote_id - String
date_from - ISODateTime
date_to - ISODateTime
analyze - Boolean

Example

Query
query tote_history(
  $tote_name: String,
  $tote_id: String,
  $date_from: ISODateTime,
  $date_to: ISODateTime,
  $analyze: Boolean
) {
  tote_history(
    tote_name: $tote_name,
    tote_id: $tote_id,
    date_from: $date_from,
    date_to: $date_to,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...ToteHistoryConnectionFragment
    }
  }
}
Variables
{
  "tote_name": "xyz789",
  "tote_id": "xyz789",
  "date_from": ISODateTime,
  "date_to": ISODateTime,
  "analyze": false
}
Response
{
  "data": {
    "tote_history": {
      "request_id": "abc123",
      "complexity": 123,
      "data": ToteHistoryConnection
    }
  }
}
Queries

user_quota

Response

Returns a UserQuota

Example

Query
query user_quota {
  user_quota {
    is_expired
    expiration_date
    time_remaining
    credits_remaining
    max_available
    increment_rate
  }
}
Response
{
  "data": {
    "user_quota": {
      "is_expired": true,
      "expiration_date": ISODateTime,
      "time_remaining": "abc123",
      "credits_remaining": 987,
      "max_available": 987,
      "increment_rate": 987
    }
  }
}
Queries

uuid

Description

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 usethis query to retrieve the uuid corresponding to that resource/entity numeric id

Response

Returns a LegacyIdQueryResult

Arguments
Name Description
legacy_id - Int!
entity - EntityType!
analyze - Boolean

Example

Query
query uuid(
  $legacy_id: Int!,
  $entity: EntityType!,
  $analyze: Boolean
) {
  uuid(
    legacy_id: $legacy_id,
    entity: $entity,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...LegacyIdFragment
    }
  }
}
Variables
{"legacy_id": 123, "entity": "Account", "analyze": false}
Response
{
  "data": {
    "uuid": {
      "request_id": "abc123",
      "complexity": 123,
      "data": LegacyId
    }
  }
}
Queries

vendors

Response

Returns a VendorsQueryResult

Arguments
Name Description
analyze - Boolean

Example

Query
query vendors($analyze: Boolean) {
  vendors(analyze: $analyze) {
    request_id
    complexity
    data {
      ...VendorConnectionFragment
    }
  }
}
Variables
{"analyze": true}
Response
{
  "data": {
    "vendors": {
      "request_id": "xyz789",
      "complexity": 123,
      "data": VendorConnection
    }
  }
}
Queries

warehouse_products

Response

Returns a WarehouseProductsQueryResult

Arguments
Name Description
warehouse_id - String
active - Boolean
sku - String
customer_account_id - String If you are a 3PL you can specify one of your customer's account
created_from - ISODateTime
created_to - ISODateTime
updated_from - ISODateTime
updated_to - ISODateTime
analyze - Boolean

Example

Query
query warehouse_products(
  $warehouse_id: String,
  $active: Boolean,
  $sku: String,
  $customer_account_id: String,
  $created_from: ISODateTime,
  $created_to: ISODateTime,
  $updated_from: ISODateTime,
  $updated_to: ISODateTime,
  $analyze: Boolean
) {
  warehouse_products(
    warehouse_id: $warehouse_id,
    active: $active,
    sku: $sku,
    customer_account_id: $customer_account_id,
    created_from: $created_from,
    created_to: $created_to,
    updated_from: $updated_from,
    updated_to: $updated_to,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...WarehouseProductConnectionFragment
    }
  }
}
Variables
{
  "warehouse_id": "xyz789",
  "active": true,
  "sku": "xyz789",
  "customer_account_id": "xyz789",
  "created_from": ISODateTime,
  "created_to": ISODateTime,
  "updated_from": ISODateTime,
  "updated_to": ISODateTime,
  "analyze": false
}
Response
{
  "data": {
    "warehouse_products": {
      "request_id": "xyz789",
      "complexity": 123,
      "data": WarehouseProductConnection
    }
  }
}
Queries

webhooks

Response

Returns a WebhooksQueryResult

Arguments
Name Description
customer_account_id - String If you are a 3PL you can specify one of your customer's account
analyze - Boolean

Example

Query
query webhooks(
  $customer_account_id: String,
  $analyze: Boolean
) {
  webhooks(
    customer_account_id: $customer_account_id,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...WebhookConnectionFragment
    }
  }
}
Variables
{
  "customer_account_id": "abc123",
  "analyze": true
}
Response
{
  "data": {
    "webhooks": {
      "request_id": "abc123",
      "complexity": 987,
      "data": WebhookConnection
    }
  }
}

Mutations

bill_create

Response

Returns a CreateBillOutput

Arguments
Name Description
data - CreateBillInput!

Example

Query
mutation bill_create($data: CreateBillInput!) {
  bill_create(data: $data) {
    request_id
    complexity
    bill {
      ...BillFragment
    }
  }
}
Variables
{"data": CreateBillInput}
Response
{
  "data": {
    "bill_create": {
      "request_id": "xyz789",
      "complexity": 987,
      "bill": Bill
    }
  }
}
Mutations

bill_delete

Response

Returns a MutationOutput

Arguments
Name Description
data - DeleteBillInput!

Example

Query
mutation bill_delete($data: DeleteBillInput!) {
  bill_delete(data: $data) {
    request_id
    complexity
  }
}
Variables
{"data": DeleteBillInput}
Response
{
  "data": {
    "bill_delete": {
      "request_id": "xyz789",
      "complexity": 123
    }
  }
}
Mutations

bill_recalculate

Response

Returns a RecalculateBillOutput

Arguments
Name Description
data - RecalculateBillInput!

Example

Query
mutation bill_recalculate($data: RecalculateBillInput!) {
  bill_recalculate(data: $data) {
    request_id
    complexity
    bill {
      ...BillFragment
    }
  }
}
Variables
{"data": RecalculateBillInput}
Response
{
  "data": {
    "bill_recalculate": {
      "request_id": "xyz789",
      "complexity": 987,
      "bill": Bill
    }
  }
}
Mutations

bill_submit

Response

Returns a MutationOutput

Arguments
Name Description
data - SubmitBillInput!

Example

Query
mutation bill_submit($data: SubmitBillInput!) {
  bill_submit(data: $data) {
    request_id
    complexity
  }
}
Variables
{"data": SubmitBillInput}
Response
{
  "data": {
    "bill_submit": {
      "request_id": "abc123",
      "complexity": 987
    }
  }
}
Mutations

bill_update

Response

Returns a MutationOutput

Arguments
Name Description
data - UpdateBillInput!

Example

Query
mutation bill_update($data: UpdateBillInput!) {
  bill_update(data: $data) {
    request_id
    complexity
  }
}
Variables
{"data": UpdateBillInput}
Response
{
  "data": {
    "bill_update": {
      "request_id": "abc123",
      "complexity": 987
    }
  }
}
Mutations

inventory_abort_snapshot

Response

Returns an InventorySnapshotOutput

Arguments
Name Description
data - InventoryAbortSnapshotInput!

Example

Query
mutation inventory_abort_snapshot($data: InventoryAbortSnapshotInput!) {
  inventory_abort_snapshot(data: $data) {
    request_id
    complexity
    snapshot {
      ...InventorySnapshotFragment
    }
  }
}
Variables
{"data": InventoryAbortSnapshotInput}
Response
{
  "data": {
    "inventory_abort_snapshot": {
      "request_id": "abc123",
      "complexity": 987,
      "snapshot": InventorySnapshot
    }
  }
}
Mutations

inventory_add

Response

Returns an UpdateInventoryOutput

Arguments
Name Description
data - UpdateInventoryInput!

Example

Query
mutation inventory_add($data: UpdateInventoryInput!) {
  inventory_add(data: $data) {
    request_id
    complexity
    warehouse_product {
      ...WarehouseProductFragment
    }
  }
}
Variables
{"data": UpdateInventoryInput}
Response
{
  "data": {
    "inventory_add": {
      "request_id": "abc123",
      "complexity": 123,
      "warehouse_product": WarehouseProduct
    }
  }
}
Mutations

inventory_generate_snapshot

Response

Returns an InventorySnapshotOutput

Arguments
Name Description
data - InventoryGenerateSnapshotInput!

Example

Query
mutation inventory_generate_snapshot($data: InventoryGenerateSnapshotInput!) {
  inventory_generate_snapshot(data: $data) {
    request_id
    complexity
    snapshot {
      ...InventorySnapshotFragment
    }
  }
}
Variables
{"data": InventoryGenerateSnapshotInput}
Response
{
  "data": {
    "inventory_generate_snapshot": {
      "request_id": "abc123",
      "complexity": 123,
      "snapshot": InventorySnapshot
    }
  }
}
Mutations

inventory_remove

Response

Returns an UpdateInventoryOutput

Arguments
Name Description
data - UpdateInventoryInput!

Example

Query
mutation inventory_remove($data: UpdateInventoryInput!) {
  inventory_remove(data: $data) {
    request_id
    complexity
    warehouse_product {
      ...WarehouseProductFragment
    }
  }
}
Variables
{"data": UpdateInventoryInput}
Response
{
  "data": {
    "inventory_remove": {
      "request_id": "xyz789",
      "complexity": 987,
      "warehouse_product": WarehouseProduct
    }
  }
}
Mutations

inventory_replace

Response

Returns an UpdateInventoryOutput

Arguments
Name Description
data - ReplaceInventoryInput!

Example

Query
mutation inventory_replace($data: ReplaceInventoryInput!) {
  inventory_replace(data: $data) {
    request_id
    complexity
    warehouse_product {
      ...WarehouseProductFragment
    }
  }
}
Variables
{"data": ReplaceInventoryInput}
Response
{
  "data": {
    "inventory_replace": {
      "request_id": "xyz789",
      "complexity": 123,
      "warehouse_product": WarehouseProduct
    }
  }
}
Mutations

inventory_subtract

Response

Returns an UpdateInventoryOutput

Arguments
Name Description
data - UpdateInventoryInput!

Example

Query
mutation inventory_subtract($data: UpdateInventoryInput!) {
  inventory_subtract(data: $data) {
    request_id
    complexity
    warehouse_product {
      ...WarehouseProductFragment
    }
  }
}
Variables
{"data": UpdateInventoryInput}
Response
{
  "data": {
    "inventory_subtract": {
      "request_id": "xyz789",
      "complexity": 123,
      "warehouse_product": WarehouseProduct
    }
  }
}
Mutations

inventory_sync

Response

Returns an InventorySyncOutput

Arguments
Name Description
data - InventorySyncInput!

Example

Query
mutation inventory_sync($data: InventorySyncInput!) {
  inventory_sync(data: $data) {
    request_id
    complexity
    sync_id
  }
}
Variables
{"data": InventorySyncInput}
Response
{
  "data": {
    "inventory_sync": {
      "request_id": "abc123",
      "complexity": 123,
      "sync_id": "xyz789"
    }
  }
}
Mutations

inventory_sync_abort

Response

Returns an AbortInventorySyncOutput

Arguments
Name Description
data - AbortInventorySyncInput!

Example

Query
mutation inventory_sync_abort($data: AbortInventorySyncInput!) {
  inventory_sync_abort(data: $data) {
    request_id
    complexity
    sync {
      ...InventorySyncStatusFragment
    }
  }
}
Variables
{"data": AbortInventorySyncInput}
Response
{
  "data": {
    "inventory_sync_abort": {
      "request_id": "xyz789",
      "complexity": 987,
      "sync": InventorySyncStatus
    }
  }
}
Mutations

inventory_transfer

Response

Returns a TransferInventoryOutput

Arguments
Name Description
data - TransferInventoryInput!

Example

Query
mutation inventory_transfer($data: TransferInventoryInput!) {
  inventory_transfer(data: $data) {
    request_id
    complexity
    ok
  }
}
Variables
{"data": TransferInventoryInput}
Response
{
  "data": {
    "inventory_transfer": {
      "request_id": "xyz789",
      "complexity": 123,
      "ok": false
    }
  }
}
Mutations

kit_build

Response

Returns a ProductMutationOutput

Arguments
Name Description
data - BuildKitInput!

Example

Query
mutation kit_build($data: BuildKitInput!) {
  kit_build(data: $data) {
    request_id
    complexity
    product {
      ...ProductFragment
    }
  }
}
Variables
{"data": BuildKitInput}
Response
{
  "data": {
    "kit_build": {
      "request_id": "abc123",
      "complexity": 987,
      "product": Product
    }
  }
}
Mutations

kit_clear

Response

Returns a MutationOutput

Arguments
Name Description
data - ClearKitInput!

Example

Query
mutation kit_clear($data: ClearKitInput!) {
  kit_clear(data: $data) {
    request_id
    complexity
  }
}
Variables
{"data": ClearKitInput}
Response
{
  "data": {
    "kit_clear": {
      "request_id": "abc123",
      "complexity": 987
    }
  }
}
Mutations

kit_remove_components

Response

Returns a ProductMutationOutput

Arguments
Name Description
data - RemoveKitComponentsInput!

Example

Query
mutation kit_remove_components($data: RemoveKitComponentsInput!) {
  kit_remove_components(data: $data) {
    request_id
    complexity
    product {
      ...ProductFragment
    }
  }
}
Variables
{"data": RemoveKitComponentsInput}
Response
{
  "data": {
    "kit_remove_components": {
      "request_id": "xyz789",
      "complexity": 987,
      "product": Product
    }
  }
}
Mutations

location_create

Response

Returns a LocationOutput

Arguments
Name Description
data - CreateLocationInput!

Example

Query
mutation location_create($data: CreateLocationInput!) {
  location_create(data: $data) {
    request_id
    complexity
    location {
      ...LocationFragment
    }
  }
}
Variables
{"data": CreateLocationInput}
Response
{
  "data": {
    "location_create": {
      "request_id": "xyz789",
      "complexity": 123,
      "location": Location
    }
  }
}
Mutations

location_update

Response

Returns a LocationOutput

Arguments
Name Description
data - UpdateLocationInput!

Example

Query
mutation location_update($data: UpdateLocationInput!) {
  location_update(data: $data) {
    request_id
    complexity
    location {
      ...LocationFragment
    }
  }
}
Variables
{"data": UpdateLocationInput}
Response
{
  "data": {
    "location_update": {
      "request_id": "abc123",
      "complexity": 987,
      "location": Location
    }
  }
}
Mutations

lot_assign_to_location

Response

Returns an AssignLotToLocationOutput

Arguments
Name Description
data - AssignLotToLocationInput!

Example

Query
mutation lot_assign_to_location($data: AssignLotToLocationInput!) {
  lot_assign_to_location(data: $data) {
    request_id
    complexity
    warehouse_product {
      ...WarehouseProductFragment
    }
  }
}
Variables
{"data": AssignLotToLocationInput}
Response
{
  "data": {
    "lot_assign_to_location": {
      "request_id": "abc123",
      "complexity": 123,
      "warehouse_product": WarehouseProduct
    }
  }
}
Mutations

lot_create

Response

Returns a CreateLotOutput

Arguments
Name Description
data - CreateLotInput!

Example

Query
mutation lot_create($data: CreateLotInput!) {
  lot_create(data: $data) {
    request_id
    complexity
    lot {
      ...LotFragment
    }
  }
}
Variables
{"data": CreateLotInput}
Response
{
  "data": {
    "lot_create": {
      "request_id": "xyz789",
      "complexity": 123,
      "lot": Lot
    }
  }
}
Mutations

lot_delete

Response

Returns a DeleteLotOutput

Arguments
Name Description
data - DeleteLotInput!

Example

Query
mutation lot_delete($data: DeleteLotInput!) {
  lot_delete(data: $data) {
    request_id
    complexity
    lot {
      ...LotFragment
    }
  }
}
Variables
{"data": DeleteLotInput}
Response
{
  "data": {
    "lot_delete": {
      "request_id": "abc123",
      "complexity": 123,
      "lot": Lot
    }
  }
}
Mutations

lot_update

Response

Returns an UpdateLotOutput

Arguments
Name Description
data - UpdateLotInput!

Example

Query
mutation lot_update($data: UpdateLotInput!) {
  lot_update(data: $data) {
    request_id
    complexity
    lot {
      ...LotFragment
    }
  }
}
Variables
{"data": UpdateLotInput}
Response
{
  "data": {
    "lot_update": {
      "request_id": "abc123",
      "complexity": 123,
      "lot": Lot
    }
  }
}
Mutations

lots_update

Response

Returns an UpdateLotsOutput

Arguments
Name Description
data - UpdateLotsInput!

Example

Query
mutation lots_update($data: UpdateLotsInput!) {
  lots_update(data: $data) {
    request_id
    complexity
    ok
  }
}
Variables
{"data": UpdateLotsInput}
Response
{
  "data": {
    "lots_update": {
      "request_id": "xyz789",
      "complexity": 987,
      "ok": false
    }
  }
}
Mutations

node

Description

The ID of the object

Response

Returns a Node

Arguments
Name Description
id - ID!

Example

Query
mutation node($id: ID!) {
  node(id: $id) {
    id
  }
}
Variables
{"id": "4"}
Response
{"data": {"node": {"id": 4}}}
Mutations

order_add_attachment

Response

Returns an OrderAddAttachmentOutput

Arguments
Name Description
data - OrderAddAttachmentInput!

Example

Query
mutation order_add_attachment($data: OrderAddAttachmentInput!) {
  order_add_attachment(data: $data) {
    request_id
    complexity
    attachment {
      ...OrderAttachmentFragment
    }
  }
}
Variables
{"data": OrderAddAttachmentInput}
Response
{
  "data": {
    "order_add_attachment": {
      "request_id": "abc123",
      "complexity": 123,
      "attachment": OrderAttachment
    }
  }
}
Mutations

order_add_history_entry

Response

Returns an OrderMutationOutput

Arguments
Name Description
data - AddHistoryInput!

Example

Query
mutation order_add_history_entry($data: AddHistoryInput!) {
  order_add_history_entry(data: $data) {
    request_id
    complexity
    order {
      ...OrderFragment
    }
  }
}
Variables
{"data": AddHistoryInput}
Response
{
  "data": {
    "order_add_history_entry": {
      "request_id": "abc123",
      "complexity": 123,
      "order": Order
    }
  }
}
Mutations

order_add_line_items

Response

Returns an OrderMutationOutput

Arguments
Name Description
data - AddLineItemsInput!

Example

Query
mutation order_add_line_items($data: AddLineItemsInput!) {
  order_add_line_items(data: $data) {
    request_id
    complexity
    order {
      ...OrderFragment
    }
  }
}
Variables
{"data": AddLineItemsInput}
Response
{
  "data": {
    "order_add_line_items": {
      "request_id": "xyz789",
      "complexity": 987,
      "order": Order
    }
  }
}
Mutations

order_add_tags

Response

Returns an OrderMutationOutput

Arguments
Name Description
data - UpdateTagsInput!

Example

Query
mutation order_add_tags($data: UpdateTagsInput!) {
  order_add_tags(data: $data) {
    request_id
    complexity
    order {
      ...OrderFragment
    }
  }
}
Variables
{"data": UpdateTagsInput}
Response
{
  "data": {
    "order_add_tags": {
      "request_id": "xyz789",
      "complexity": 123,
      "order": Order
    }
  }
}
Mutations

order_cancel

Response

Returns an OrderMutationOutput

Arguments
Name Description
data - CancelOrderInput!

Example

Query
mutation order_cancel($data: CancelOrderInput!) {
  order_cancel(data: $data) {
    request_id
    complexity
    order {
      ...OrderFragment
    }
  }
}
Variables
{"data": CancelOrderInput}
Response
{
  "data": {
    "order_cancel": {
      "request_id": "abc123",
      "complexity": 123,
      "order": Order
    }
  }
}
Mutations

order_change_warehouse

Response

Returns an OrderMutationOutput

Arguments
Name Description
data - ChangeOrderWarehouseInput!

Example

Query
mutation order_change_warehouse($data: ChangeOrderWarehouseInput!) {
  order_change_warehouse(data: $data) {
    request_id
    complexity
    order {
      ...OrderFragment
    }
  }
}
Variables
{"data": ChangeOrderWarehouseInput}
Response
{
  "data": {
    "order_change_warehouse": {
      "request_id": "xyz789",
      "complexity": 987,
      "order": Order
    }
  }
}
Mutations

order_clear_tags

Response

Returns an OrderMutationOutput

Arguments
Name Description
data - UpdateOrderInputBase!

Example

Query
mutation order_clear_tags($data: UpdateOrderInputBase!) {
  order_clear_tags(data: $data) {
    request_id
    complexity
    order {
      ...OrderFragment
    }
  }
}
Variables
{"data": UpdateOrderInputBase}
Response
{
  "data": {
    "order_clear_tags": {
      "request_id": "xyz789",
      "complexity": 123,
      "order": Order
    }
  }
}
Mutations

order_create

Response

Returns an OrderMutationOutput

Arguments
Name Description
data - CreateOrderInput!

Example

Query
mutation order_create($data: CreateOrderInput!) {
  order_create(data: $data) {
    request_id
    complexity
    order {
      ...OrderFragment
    }
  }
}
Variables
{"data": CreateOrderInput}
Response
{
  "data": {
    "order_create": {
      "request_id": "abc123",
      "complexity": 987,
      "order": Order
    }
  }
}
Mutations

order_fulfill

Response

Returns an OrderShipmentMutationOutput

Arguments
Name Description
data - FulfillOrderInput!

Example

Query
mutation order_fulfill($data: FulfillOrderInput!) {
  order_fulfill(data: $data) {
    request_id
    complexity
    shipment {
      ...ShipmentFragment
    }
  }
}
Variables
{"data": FulfillOrderInput}
Response
{
  "data": {
    "order_fulfill": {
      "request_id": "xyz789",
      "complexity": 987,
      "shipment": Shipment
    }
  }
}
Mutations

order_remove_line_items

Response

Returns an OrderMutationOutput

Arguments
Name Description
data - RemoveLineItemsInput!

Example

Query
mutation order_remove_line_items($data: RemoveLineItemsInput!) {
  order_remove_line_items(data: $data) {
    request_id
    complexity
    order {
      ...OrderFragment
    }
  }
}
Variables
{"data": RemoveLineItemsInput}
Response
{
  "data": {
    "order_remove_line_items": {
      "request_id": "xyz789",
      "complexity": 987,
      "order": Order
    }
  }
}
Mutations

order_update

Response

Returns an OrderMutationOutput

Arguments
Name Description
data - UpdateOrderInput!

Example

Query
mutation order_update($data: UpdateOrderInput!) {
  order_update(data: $data) {
    request_id
    complexity
    order {
      ...OrderFragment
    }
  }
}
Variables
{"data": UpdateOrderInput}
Response
{
  "data": {
    "order_update": {
      "request_id": "abc123",
      "complexity": 987,
      "order": Order
    }
  }
}
Mutations

order_update_fulfillment_status

Response

Returns an OrderMutationOutput

Arguments
Name Description
data - UpdateOrderFulfillmentStatusInput!

Example

Query
mutation order_update_fulfillment_status($data: UpdateOrderFulfillmentStatusInput!) {
  order_update_fulfillment_status(data: $data) {
    request_id
    complexity
    order {
      ...OrderFragment
    }
  }
}
Variables
{"data": UpdateOrderFulfillmentStatusInput}
Response
{
  "data": {
    "order_update_fulfillment_status": {
      "request_id": "xyz789",
      "complexity": 123,
      "order": Order
    }
  }
}
Mutations

order_update_holds

Response

Returns an OrderMutationOutput

Arguments
Name Description
data - UpdateOrderHoldsInput!

Example

Query
mutation order_update_holds($data: UpdateOrderHoldsInput!) {
  order_update_holds(data: $data) {
    request_id
    complexity
    order {
      ...OrderFragment
    }
  }
}
Variables
{"data": UpdateOrderHoldsInput}
Response
{
  "data": {
    "order_update_holds": {
      "request_id": "xyz789",
      "complexity": 123,
      "order": Order
    }
  }
}
Mutations

order_update_line_items

Response

Returns an OrderMutationOutput

Arguments
Name Description
data - UpdateLineItemsInput!

Example

Query
mutation order_update_line_items($data: UpdateLineItemsInput!) {
  order_update_line_items(data: $data) {
    request_id
    complexity
    order {
      ...OrderFragment
    }
  }
}
Variables
{"data": UpdateLineItemsInput}
Response
{
  "data": {
    "order_update_line_items": {
      "request_id": "abc123",
      "complexity": 123,
      "order": Order
    }
  }
}
Mutations

order_update_tags

Response

Returns an OrderMutationOutput

Arguments
Name Description
data - UpdateTagsInput!

Example

Query
mutation order_update_tags($data: UpdateTagsInput!) {
  order_update_tags(data: $data) {
    request_id
    complexity
    order {
      ...OrderFragment
    }
  }
}
Variables
{"data": UpdateTagsInput}
Response
{
  "data": {
    "order_update_tags": {
      "request_id": "abc123",
      "complexity": 123,
      "order": Order
    }
  }
}
Mutations

product_add_to_warehouse

Response

Returns a WarehouseProductMutationOutput

Arguments
Name Description
data - AddProductToWarehouseInput!

Example

Query
mutation product_add_to_warehouse($data: AddProductToWarehouseInput!) {
  product_add_to_warehouse(data: $data) {
    request_id
    complexity
    warehouse_product {
      ...WarehouseProductFragment
    }
  }
}
Variables
{"data": AddProductToWarehouseInput}
Response
{
  "data": {
    "product_add_to_warehouse": {
      "request_id": "xyz789",
      "complexity": 123,
      "warehouse_product": WarehouseProduct
    }
  }
}
Mutations

product_create

Response

Returns a CreateProductOutput

Arguments
Name Description
data - CreateProductInput!

Example

Query
mutation product_create($data: CreateProductInput!) {
  product_create(data: $data) {
    request_id
    complexity
    product {
      ...ProductFragment
    }
  }
}
Variables
{"data": CreateProductInput}
Response
{
  "data": {
    "product_create": {
      "request_id": "xyz789",
      "complexity": 987,
      "product": Product
    }
  }
}
Mutations

product_delete

Response

Returns a MutationOutput

Arguments
Name Description
data - DeleteProductInput!

Example

Query
mutation product_delete($data: DeleteProductInput!) {
  product_delete(data: $data) {
    request_id
    complexity
  }
}
Variables
{"data": DeleteProductInput}
Response
{
  "data": {
    "product_delete": {
      "request_id": "xyz789",
      "complexity": 987
    }
  }
}
Mutations

product_update

Response

Returns a ProductMutationOutput

Arguments
Name Description
data - UpdateProductInput!

Example

Query
mutation product_update($data: UpdateProductInput!) {
  product_update(data: $data) {
    request_id
    complexity
    product {
      ...ProductFragment
    }
  }
}
Variables
{"data": UpdateProductInput}
Response
{
  "data": {
    "product_update": {
      "request_id": "xyz789",
      "complexity": 987,
      "product": Product
    }
  }
}
Mutations

purchase_order_add_attachment

Response

Returns an AddPurchaseOrderAttachmentOutput

Arguments
Name Description
data - AddPurchaseOrderAttachmentInput!

Example

Query
mutation purchase_order_add_attachment($data: AddPurchaseOrderAttachmentInput!) {
  purchase_order_add_attachment(data: $data) {
    request_id
    complexity
    attachment {
      ...PurchaseOrderAttachmentFragment
    }
  }
}
Variables
{"data": AddPurchaseOrderAttachmentInput}
Response
{
  "data": {
    "purchase_order_add_attachment": {
      "request_id": "xyz789",
      "complexity": 987,
      "attachment": PurchaseOrderAttachment
    }
  }
}
Mutations

purchase_order_cancel

Response

Returns a CancelPurchaseOrderOutput

Arguments
Name Description
data - CancelPurchaseOrderInput!

Example

Query
mutation purchase_order_cancel($data: CancelPurchaseOrderInput!) {
  purchase_order_cancel(data: $data) {
    request_id
    complexity
    purchase_order {
      ...PurchaseOrderFragment
    }
  }
}
Variables
{"data": CancelPurchaseOrderInput}
Response
{
  "data": {
    "purchase_order_cancel": {
      "request_id": "xyz789",
      "complexity": 987,
      "purchase_order": PurchaseOrder
    }
  }
}
Mutations

purchase_order_close

Response

Returns a ClosePurchaseOrderOutput

Arguments
Name Description
data - ClosePurchaseOrderInput!

Example

Query
mutation purchase_order_close($data: ClosePurchaseOrderInput!) {
  purchase_order_close(data: $data) {
    request_id
    complexity
    purchase_order {
      ...PurchaseOrderFragment
    }
  }
}
Variables
{"data": ClosePurchaseOrderInput}
Response
{
  "data": {
    "purchase_order_close": {
      "request_id": "xyz789",
      "complexity": 987,
      "purchase_order": PurchaseOrder
    }
  }
}
Mutations

purchase_order_create

Response

Returns a CreatePurchaseOrderOutput

Arguments
Name Description
data - CreatePurchaseOrderInput!

Example

Query
mutation purchase_order_create($data: CreatePurchaseOrderInput!) {
  purchase_order_create(data: $data) {
    request_id
    complexity
    purchase_order {
      ...PurchaseOrderFragment
    }
  }
}
Variables
{"data": CreatePurchaseOrderInput}
Response
{
  "data": {
    "purchase_order_create": {
      "request_id": "xyz789",
      "complexity": 123,
      "purchase_order": PurchaseOrder
    }
  }
}
Mutations

purchase_order_set_fulfillment_status

Response

Returns a SetPurchaseOrderFulfillmentStatusOutput

Arguments
Name Description
data - SetPurchaseOrderFulfillmentStatusInput!

Example

Query
mutation purchase_order_set_fulfillment_status($data: SetPurchaseOrderFulfillmentStatusInput!) {
  purchase_order_set_fulfillment_status(data: $data) {
    request_id
    complexity
    purchase_order {
      ...PurchaseOrderFragment
    }
  }
}
Variables
{"data": SetPurchaseOrderFulfillmentStatusInput}
Response
{
  "data": {
    "purchase_order_set_fulfillment_status": {
      "request_id": "abc123",
      "complexity": 123,
      "purchase_order": PurchaseOrder
    }
  }
}
Mutations

purchase_order_update

Response

Returns an UpdatePurchaseOrderOutput

Arguments
Name Description
data - UpdatePurchaseOrderInput!

Example

Query
mutation purchase_order_update($data: UpdatePurchaseOrderInput!) {
  purchase_order_update(data: $data) {
    request_id
    complexity
    purchase_order {
      ...PurchaseOrderFragment
    }
  }
}
Variables
{"data": UpdatePurchaseOrderInput}
Response
{
  "data": {
    "purchase_order_update": {
      "request_id": "xyz789",
      "complexity": 123,
      "purchase_order": PurchaseOrder
    }
  }
}
Mutations

return_create

Response

Returns a CreateReturnOutput

Arguments
Name Description
data - CreateReturnInput!

Example

Query
mutation return_create($data: CreateReturnInput!) {
  return_create(data: $data) {
    request_id
    complexity
    return {
      ...ReturnFragment
    }
  }
}
Variables
{"data": CreateReturnInput}
Response
{
  "data": {
    "return_create": {
      "request_id": "xyz789",
      "complexity": 123,
      "return": Return
    }
  }
}
Mutations

return_create_exchange

Response

Returns a CreateReturnExchangeOutput

Arguments
Name Description
data - CreateReturnExchangeInput!

Example

Query
mutation return_create_exchange($data: CreateReturnExchangeInput!) {
  return_create_exchange(data: $data) {
    request_id
    complexity
    return_exchange {
      ...ReturnExchangeFragment
    }
  }
}
Variables
{"data": CreateReturnExchangeInput}
Response
{
  "data": {
    "return_create_exchange": {
      "request_id": "xyz789",
      "complexity": 987,
      "return_exchange": ReturnExchange
    }
  }
}
Mutations

return_update_status

Response

Returns an UpdateReturnStatusOutput

Arguments
Name Description
data - UpdateReturnStatusInput!

Example

Query
mutation return_update_status($data: UpdateReturnStatusInput!) {
  return_update_status(data: $data) {
    request_id
    complexity
    return {
      ...ReturnFragment
    }
  }
}
Variables
{"data": UpdateReturnStatusInput}
Response
{
  "data": {
    "return_update_status": {
      "request_id": "abc123",
      "complexity": 123,
      "return": Return
    }
  }
}
Mutations

shipment_create

Response

Returns a CreateShipmentOutput

Arguments
Name Description
data - CreateShipmentInput!

Example

Query
mutation shipment_create($data: CreateShipmentInput!) {
  shipment_create(data: $data) {
    request_id
    complexity
    shipment {
      ...ShipmentFragment
    }
  }
}
Variables
{"data": CreateShipmentInput}
Response
{
  "data": {
    "shipment_create": {
      "request_id": "xyz789",
      "complexity": 123,
      "shipment": Shipment
    }
  }
}
Mutations

shipment_create_shipping_label

Response

Returns a CreateShippingLabelOutput

Arguments
Name Description
data - CreateShippingLabelInput!

Example

Query
mutation shipment_create_shipping_label($data: CreateShippingLabelInput!) {
  shipment_create_shipping_label(data: $data) {
    request_id
    complexity
    shipping_label {
      ...ShippingLabelFragment
    }
  }
}
Variables
{"data": CreateShippingLabelInput}
Response
{
  "data": {
    "shipment_create_shipping_label": {
      "request_id": "xyz789",
      "complexity": 987,
      "shipping_label": ShippingLabel
    }
  }
}
Mutations

shipping_plan_create

Response

Returns a CreateShippingPlanOutput

Arguments
Name Description
data - CreateShippingPlanInput!

Example

Query
mutation shipping_plan_create($data: CreateShippingPlanInput!) {
  shipping_plan_create(data: $data) {
    request_id
    complexity
    shipping_plan {
      ...ShippingPlanFragment
    }
  }
}
Variables
{"data": CreateShippingPlanInput}
Response
{
  "data": {
    "shipping_plan_create": {
      "request_id": "abc123",
      "complexity": 123,
      "shipping_plan": ShippingPlan
    }
  }
}
Mutations

vendor_add_product

Response

Returns a MutationOutput

Arguments
Name Description
data - AddProductToVendorInput!

Example

Query
mutation vendor_add_product($data: AddProductToVendorInput!) {
  vendor_add_product(data: $data) {
    request_id
    complexity
  }
}
Variables
{"data": AddProductToVendorInput}
Response
{
  "data": {
    "vendor_add_product": {
      "request_id": "xyz789",
      "complexity": 123
    }
  }
}
Mutations

vendor_create

Response

Returns a CreateVendorOutput

Arguments
Name Description
data - CreateVendorInput!

Example

Query
mutation vendor_create($data: CreateVendorInput!) {
  vendor_create(data: $data) {
    request_id
    complexity
    vendor {
      ...VendorFragment
    }
  }
}
Variables
{"data": CreateVendorInput}
Response
{
  "data": {
    "vendor_create": {
      "request_id": "abc123",
      "complexity": 987,
      "vendor": Vendor
    }
  }
}
Mutations

vendor_delete

Response

Returns a MutationOutput

Arguments
Name Description
data - DeleteVendorInput!

Example

Query
mutation vendor_delete($data: DeleteVendorInput!) {
  vendor_delete(data: $data) {
    request_id
    complexity
  }
}
Variables
{"data": DeleteVendorInput}
Response
{
  "data": {
    "vendor_delete": {
      "request_id": "abc123",
      "complexity": 123
    }
  }
}
Mutations

vendor_remove_product

Response

Returns a MutationOutput

Arguments
Name Description
data - RemoveProductFromVendorInput!

Example

Query
mutation vendor_remove_product($data: RemoveProductFromVendorInput!) {
  vendor_remove_product(data: $data) {
    request_id
    complexity
  }
}
Variables
{"data": RemoveProductFromVendorInput}
Response
{
  "data": {
    "vendor_remove_product": {
      "request_id": "xyz789",
      "complexity": 987
    }
  }
}
Mutations

warehouse_product_delete

Response

Returns a MutationOutput

Arguments
Name Description
data - DeleteWarehouseProductInput!

Example

Query
mutation warehouse_product_delete($data: DeleteWarehouseProductInput!) {
  warehouse_product_delete(data: $data) {
    request_id
    complexity
  }
}
Variables
{"data": DeleteWarehouseProductInput}
Response
{
  "data": {
    "warehouse_product_delete": {
      "request_id": "abc123",
      "complexity": 123
    }
  }
}
Mutations

warehouse_product_update

Response

Returns a WarehouseProductMutationOutput

Arguments
Name Description
data - UpdateWarehouseProductInput!

Example

Query
mutation warehouse_product_update($data: UpdateWarehouseProductInput!) {
  warehouse_product_update(data: $data) {
    request_id
    complexity
    warehouse_product {
      ...WarehouseProductFragment
    }
  }
}
Variables
{"data": UpdateWarehouseProductInput}
Response
{
  "data": {
    "warehouse_product_update": {
      "request_id": "abc123",
      "complexity": 987,
      "warehouse_product": WarehouseProduct
    }
  }
}
Mutations

webhook_create

Response

Returns a CreateWebhookOutput

Arguments
Name Description
data - CreateWebhookInput!

Example

Query
mutation webhook_create($data: CreateWebhookInput!) {
  webhook_create(data: $data) {
    request_id
    complexity
    webhook {
      ...WebhookFragment
    }
  }
}
Variables
{"data": CreateWebhookInput}
Response
{
  "data": {
    "webhook_create": {
      "request_id": "xyz789",
      "complexity": 987,
      "webhook": Webhook
    }
  }
}
Mutations

webhook_delete

Response

Returns a MutationOutput

Arguments
Name Description
data - DeleteWebhookInput!

Example

Query
mutation webhook_delete($data: DeleteWebhookInput!) {
  webhook_delete(data: $data) {
    request_id
    complexity
  }
}
Variables
{"data": DeleteWebhookInput}
Response
{
  "data": {
    "webhook_delete": {
      "request_id": "abc123",
      "complexity": 123
    }
  }
}

Types

AbortInventorySyncInput

Fields
Input Field Description
sync_id - String!
reason - String
Example
{
  "sync_id": "xyz789",
  "reason": "xyz789"
}
Types

AbortInventorySyncOutput

Fields
Field Name Description
request_id - String
complexity - Int
sync - InventorySyncStatus
Example
{
  "request_id": "xyz789",
  "complexity": 123,
  "sync": InventorySyncStatus
}
Types

Account

Fields
Field Name Description
id - String
legacy_id - Int
email - String
username - String
status - String
dynamic_slotting - Boolean
is_multi_warehouse - Boolean
is_3pl - Boolean
cycle_count_enabled - Boolean
ship_backorders - Boolean
customers - AccountConnection
Arguments
warehouse_id - String
sort - String
before - String
after - String
first - Int
last - Int
warehouses - [Warehouse]
Example
{
  "id": "xyz789",
  "legacy_id": 987,
  "email": "xyz789",
  "username": "abc123",
  "status": "abc123",
  "dynamic_slotting": false,
  "is_multi_warehouse": false,
  "is_3pl": true,
  "cycle_count_enabled": true,
  "ship_backorders": true,
  "customers": AccountConnection,
  "warehouses": [Warehouse]
}
Types

AccountConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [AccountEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [AccountEdge]
}
Types

AccountEdge

Description

A Relay edge containing a Account and its cursor.

Fields
Field Name Description
node - Account The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": Account,
  "cursor": "xyz789"
}
Types

AccountQueryResult

Fields
Field Name Description
request_id - String
complexity - Int
data - Account
Example
{
  "request_id": "xyz789",
  "complexity": 123,
  "data": Account
}
Types

AddHistoryInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
order_id - String!

The id of the order you want to modify
history_entry - UserNoteInput
Example
{
  "customer_account_id": "xyz789",
  "order_id": "xyz789",
  "history_entry": UserNoteInput
}
Types

AddLineItemsInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
order_id - String!

The id of the order you want to modify
line_items - [CreateLineItemInput]!
Example
{
  "customer_account_id": "abc123",
  "order_id": "abc123",
  "line_items": [CreateLineItemInput]
}
Types

AddProductToVendorInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
vendor_id - String!
sku - String!
manufacturer_sku - String
price - String
Example
{
  "customer_account_id": "abc123",
  "vendor_id": "abc123",
  "sku": "abc123",
  "manufacturer_sku": "xyz789",
  "price": "xyz789"
}
Types

AddProductToWarehouseInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
sku - String!
warehouse_id - String!
on_hand - Int
inventory_bin - String
inventory_overstock_bin - String
reserve_inventory - Int
replenishment_level - Int
reorder_level - Int
reorder_amount - Int
price - String
value - String
value_currency - String
active - Boolean
Example
{
  "customer_account_id": "xyz789",
  "sku": "abc123",
  "warehouse_id": "abc123",
  "on_hand": 987,
  "inventory_bin": "abc123",
  "inventory_overstock_bin": "xyz789",
  "reserve_inventory": 123,
  "replenishment_level": 123,
  "reorder_level": 123,
  "reorder_amount": 123,
  "price": "xyz789",
  "value": "abc123",
  "value_currency": "abc123",
  "active": false
}
Types

AddPurchaseOrderAttachmentInput

Fields
Input Field Description
po_id - String!
url - String!
description - String
filename - String
file_type - String
Example
{
  "po_id": "xyz789",
  "url": "xyz789",
  "description": "abc123",
  "filename": "xyz789",
  "file_type": "abc123"
}
Types

AddPurchaseOrderAttachmentOutput

Fields
Field Name Description
request_id - String
complexity - Int
attachment - PurchaseOrderAttachment
Example
{
  "request_id": "xyz789",
  "complexity": 987,
  "attachment": PurchaseOrderAttachment
}
Types

Address

Fields
Field Name Description
name - String The address's name or name of the person assigned to the address
address1 - String Address line 1
address2 - String Address line 2
city - String Address's City
state - String Address's State
country - String Address's Country
zip - String Address's Postal Code
phone - String
Example
{
  "name": "abc123",
  "address1": "xyz789",
  "address2": "xyz789",
  "city": "abc123",
  "state": "abc123",
  "country": "abc123",
  "zip": "xyz789",
  "phone": "abc123"
}
Types

AddressInput

Fields
Input Field Description
name - String
address1 - String
address2 - String
city - String
state - String
country - String
zip - String
phone - String
Example
{
  "name": "abc123",
  "address1": "xyz789",
  "address2": "xyz789",
  "city": "xyz789",
  "state": "xyz789",
  "country": "xyz789",
  "zip": "xyz789",
  "phone": "abc123"
}
Types

AssignLotToLocationInput

Description

GraphQL input type for assigning a Lot to a Location.

Fields
Input Field Description
lot_id - String!

Unique identifier of the Lot the product belongs to
location_id - String!

Unique identifier of the Location the product is placed at
Example
{
  "lot_id": "abc123",
  "location_id": "xyz789"
}
Types

AssignLotToLocationOutput

Description

GraphQL output type for assigning a Lot to a Location.

Fields
Field Name Description
request_id - String
complexity - Int
warehouse_product - WarehouseProduct
Example
{
  "request_id": "abc123",
  "complexity": 123,
  "warehouse_product": WarehouseProduct
}
Types

Authorization

Fields
Field Name Description
transaction_id - String
authorized_amount - String
postauthed_amount - String
refunded_amount - String
card_type - String
date - ISODateTime
Example
{
  "transaction_id": "abc123",
  "authorized_amount": "abc123",
  "postauthed_amount": "abc123",
  "refunded_amount": "abc123",
  "card_type": "abc123",
  "date": ISODateTime
}
Types

Bill

Fields
Field Name Description
id - String
legacy_id - Int
status - String
customer_name - String
profile_name - String
created_at - ISODateTime
due_date - ISODateTime
amount - Money
totals - FeeCategoryTotalConnection
Arguments
sort - String
before - String
after - String
first - Int
last - Int
bill_exports - BillExportsConnection
Arguments
sort - String
before - String
after - String
first - Int
last - Int
billing_period - BillingPeriod
billing_frequency - String
Example
{
  "id": "abc123",
  "legacy_id": 123,
  "status": "abc123",
  "customer_name": "xyz789",
  "profile_name": "abc123",
  "created_at": ISODateTime,
  "due_date": ISODateTime,
  "amount": Money,
  "totals": FeeCategoryTotalConnection,
  "bill_exports": BillExportsConnection,
  "billing_period": BillingPeriod,
  "billing_frequency": "abc123"
}
Types

BillConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [BillEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [BillEdge]
}
Types

BillEdge

Description

A Relay edge containing a Bill and its cursor.

Fields
Field Name Description
node - Bill The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": Bill,
  "cursor": "xyz789"
}
Types

BillExports

Fields
Field Name Description
id - String
legacy_id - Int
status - String
file_url - String
Example
{
  "id": "xyz789",
  "legacy_id": 123,
  "status": "xyz789",
  "file_url": "abc123"
}
Types

BillExportsConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [BillExportsEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [BillExportsEdge]
}
Types

BillExportsEdge

Description

A Relay edge containing a BillExports and its cursor.

Fields
Field Name Description
node - BillExports The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": BillExports,
  "cursor": "abc123"
}
Types

BillQueryResult

Fields
Field Name Description
request_id - String
complexity - Int
data - Bill
Example
{
  "request_id": "xyz789",
  "complexity": 123,
  "data": Bill
}
Types

BillingPeriod

Fields
Field Name Description
start - ISODateTime
end - ISODateTime
Example
{
  "start": ISODateTime,
  "end": ISODateTime
}
Types

BillsQueryResult

Fields
Field Name Description
request_id - String
complexity - Int
data - BillConnection
Arguments
sort - String
before - String
after - String
first - Int
last - Int
Example
{
  "request_id": "abc123",
  "complexity": 987,
  "data": BillConnection
}
Types

Boolean

Description

The Boolean scalar type represents true or false.

Example
true
Types

BuildKitComponentInput

Fields
Input Field Description
sku - String!
quantity - Int!
Example
{"sku": "xyz789", "quantity": 987}
Types

BuildKitInput

Fields
Input Field Description
sku - String!
components - [BuildKitComponentInput]!
kit_build - Boolean
customer_account_id - String
warehouse_id - String
Example
{
  "sku": "xyz789",
  "components": [BuildKitComponentInput],
  "kit_build": false,
  "customer_account_id": "abc123",
  "warehouse_id": "abc123"
}
Types

CancelOrderInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
order_id - String!

The id of the order you want to modify
reason - String
void_on_platform - Boolean

Whether or not to void the order on the sales platform
force - Boolean

Cancel an order even if it has valid labels and completed shipments
Example
{
  "customer_account_id": "xyz789",
  "order_id": "xyz789",
  "reason": "xyz789",
  "void_on_platform": false,
  "force": false
}
Types

CancelPurchaseOrderInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
po_id - String!
Example
{
  "customer_account_id": "xyz789",
  "po_id": "abc123"
}
Types

CancelPurchaseOrderOutput

Fields
Field Name Description
request_id - String
complexity - Int
purchase_order - PurchaseOrder
Example
{
  "request_id": "xyz789",
  "complexity": 987,
  "purchase_order": PurchaseOrder
}
Types

Case

Fields
Field Name Description
id - String
legacy_id - Int
case_barcode - String
case_quantity - Int
Example
{
  "id": "xyz789",
  "legacy_id": 987,
  "case_barcode": "xyz789",
  "case_quantity": 987
}
Types

ChangeOrderWarehouseInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
order_id - String!

The id of the order you want to modify
warehouse_id - String!
Example
{
  "customer_account_id": "xyz789",
  "order_id": "xyz789",
  "warehouse_id": "abc123"
}
Types

ClearKitInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
sku - String!
Example
{
  "customer_account_id": "xyz789",
  "sku": "abc123"
}
Types

ClosePurchaseOrderInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
po_id - String!
Example
{
  "customer_account_id": "abc123",
  "po_id": "xyz789"
}
Types

ClosePurchaseOrderOutput

Fields
Field Name Description
request_id - String
complexity - Int
purchase_order - PurchaseOrder
Example
{
  "request_id": "xyz789",
  "complexity": 123,
  "purchase_order": PurchaseOrder
}
Types

CreateBillInput

Fields
Input Field Description
customer_account_id - String!
start_date - ISODateTime!
end_date - ISODateTime!
Example
{
  "customer_account_id": "xyz789",
  "start_date": ISODateTime,
  "end_date": ISODateTime
}
Types

CreateBillOutput

Fields
Field Name Description
request_id - String
complexity - Int
bill - Bill
Example
{
  "request_id": "abc123",
  "complexity": 987,
  "bill": Bill
}
Types

CreateExchangeItem

Fields
Input Field Description
return_item_id - String!
exchange_product_sku - String!
quantity - Int!
Example
{
  "return_item_id": "abc123",
  "exchange_product_sku": "xyz789",
  "quantity": 123
}
Types

CreateLabelResourceInput

Fields
Input Field Description
paper_pdf_location - String
thermal_pdf_location - String
pdf_location - String
image_location - String
Example
{
  "paper_pdf_location": "abc123",
  "thermal_pdf_location": "abc123",
  "pdf_location": "xyz789",
  "image_location": "abc123"
}
Types

CreateLineItemInput

Fields
Input Field Description
sku - String!
partner_line_item_id - String!

A unique identifier, usually the customer's internal id. It should be unique across all the order's line items, and is recommended to be unique accross the entire store.
quantity - Int!
price - String!
product_name - String
option_title - String
fulfillment_status - String
quantity_pending_fulfillment - Int
custom_options - GenericScalar
custom_barcode - String
eligible_for_return - Boolean
customs_value - String

A decimal value used for customs
barcode - String
warehouse_id - String

Set to lock to that warehouse. The item will not be moved in any multi-warehouse processing
Example
{
  "sku": "abc123",
  "partner_line_item_id": "abc123",
  "quantity": 987,
  "price": "xyz789",
  "product_name": "xyz789",
  "option_title": "abc123",
  "fulfillment_status": "xyz789",
  "quantity_pending_fulfillment": 123,
  "custom_options": GenericScalar,
  "custom_barcode": "abc123",
  "eligible_for_return": true,
  "customs_value": "abc123",
  "barcode": "abc123",
  "warehouse_id": "xyz789"
}
Types

CreateLocationInput

Fields
Input Field Description
warehouse_id - String!
name - String!
zone - String!
location_type_id - String
pickable - Boolean
sellable - Boolean
is_cart - Boolean
pick_priority - Int
dimensions - DimensionsInput
temperature - String
Example
{
  "warehouse_id": "abc123",
  "name": "xyz789",
  "zone": "xyz789",
  "location_type_id": "abc123",
  "pickable": true,
  "sellable": true,
  "is_cart": false,
  "pick_priority": 123,
  "dimensions": DimensionsInput,
  "temperature": "xyz789"
}
Types

CreateLotInput

Description

GraphQL input type for Lot creation.

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
name - String!
sku - String!
expires_at - ISODateTime
is_active - Boolean
Example
{
  "customer_account_id": "abc123",
  "name": "xyz789",
  "sku": "abc123",
  "expires_at": ISODateTime,
  "is_active": true
}
Types

CreateLotOutput

Description

GraphQL output type for Lot creation.

Fields
Field Name Description
request_id - String
complexity - Int
lot - Lot
Example
{
  "request_id": "xyz789",
  "complexity": 123,
  "lot": Lot
}
Types

CreateOrderAddressInput

Description

Order type for addresses. Orders have addresses with more details than the rest of the system so we use our own types

Fields
Input Field Description
first_name - String
last_name - String
company - String
address1 - String
address2 - String
city - String
state - String
state_code - String
zip - String
country - String
country_code - String
email - String

Order email takes precedence, followed by shipping address email, then billing address email
phone - String
Example
{
  "first_name": "abc123",
  "last_name": "xyz789",
  "company": "xyz789",
  "address1": "abc123",
  "address2": "xyz789",
  "city": "xyz789",
  "state": "abc123",
  "state_code": "abc123",
  "zip": "abc123",
  "country": "abc123",
  "country_code": "abc123",
  "email": "abc123",
  "phone": "xyz789"
}
Types

CreateOrderInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
order_number - String

The store's internal order number
partner_order_id - String
shop_name - String
fulfillment_status - String

Status of the order (pending, fulfilled, cancelled, etc)
order_date - ISODateTime
total_tax - String
subtotal - String
total_discounts - String
total_price - String
box_name - String
currency - String
ready_to_ship - Boolean
insurance_amount - Decimal
shipping_lines - CreateShippingLinesInput
shipping_address - CreateOrderAddressInput!
billing_address - CreateOrderAddressInput
from_name - String
note_attributes - [OrderNoteAttributeInput]
tags - [String]
line_items - [CreateLineItemInput]
gift_note - String
gift_invoice - Boolean
require_signature - Boolean
adult_signature_required - Boolean
alcohol - Boolean
insurance - Boolean
allow_partial - Boolean
allow_split - Boolean
custom_invoice_url - String
email - String
profile - String
packing_note - String
required_ship_date - ISODateTime
auto_print_return_label - Boolean
hold_until_date - ISODateTime
incoterms - String
tax_id - String
tax_type - String
flagged - Boolean
saturday_delivery - Boolean
ignore_address_validation_errors - Boolean

US addresses are be validated and when errors occur the order will have an address hold created. If this flag is set then the error validation is skipped and no address hold is created
skip_address_validation - Boolean

Not address validation will be performed
priority_flag - Boolean
allocation_priority - Int
holds - HoldsInput
dry_ice_weight_in_lbs - String
ftr_exemption - Decimal
address_is_business - Boolean
Example
{
  "customer_account_id": "xyz789",
  "order_number": "abc123",
  "partner_order_id": "abc123",
  "shop_name": "abc123",
  "fulfillment_status": "xyz789",
  "order_date": ISODateTime,
  "total_tax": "abc123",
  "subtotal": "xyz789",
  "total_discounts": "xyz789",
  "total_price": "xyz789",
  "box_name": "xyz789",
  "currency": "abc123",
  "ready_to_ship": true,
  "insurance_amount": Decimal,
  "shipping_lines": CreateShippingLinesInput,
  "shipping_address": CreateOrderAddressInput,
  "billing_address": CreateOrderAddressInput,
  "from_name": "xyz789",
  "note_attributes": [OrderNoteAttributeInput],
  "tags": ["abc123"],
  "line_items": [CreateLineItemInput],
  "gift_note": "abc123",
  "gift_invoice": true,
  "require_signature": true,
  "adult_signature_required": false,
  "alcohol": true,
  "insurance": false,
  "allow_partial": true,
  "allow_split": true,
  "custom_invoice_url": "abc123",
  "email": "abc123",
  "profile": "abc123",
  "packing_note": "abc123",
  "required_ship_date": ISODateTime,
  "auto_print_return_label": true,
  "hold_until_date": ISODateTime,
  "incoterms": "abc123",
  "tax_id": "xyz789",
  "tax_type": "xyz789",
  "flagged": false,
  "saturday_delivery": true,
  "ignore_address_validation_errors": true,
  "skip_address_validation": true,
  "priority_flag": true,
  "allocation_priority": 123,
  "holds": HoldsInput,
  "dry_ice_weight_in_lbs": "abc123",
  "ftr_exemption": Decimal,
  "address_is_business": true
}
Types

CreateProductCaseInput

Fields
Input Field Description
case_barcode - String!
case_quantity - Int!
Example
{
  "case_barcode": "xyz789",
  "case_quantity": 987
}
Types

CreateProductImageInput

Fields
Input Field Description
src - String!
position - Int
Example
{"src": "abc123", "position": 987}
Types

CreateProductInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
name - String!
sku - String!
price - String

Will be used as the default price for each warehouse product, if no price is defined on them.
value - String

Will be used as the default value for each warehouse product, if no value is defined on them.
warehouse_products - [CreateWarehouseProductInput]!
barcode - String
country_of_manufacture - String
dimensions - DimensionsInput
tariff_code - String
product_note - String
kit - Boolean
kit_build - Boolean
no_air - Boolean
final_sale - Boolean
customs_value - String
customs_description - String
not_owned - Boolean
ignore_on_customs - Boolean
ignore_on_invoice - Boolean
dropship - Boolean
needs_serial_number - Boolean
virtual - Boolean
needs_lot_tracking - Boolean
images - [CreateProductImageInput]
tags - [String]
vendors - [CreateProductVendorInput]
packer_note - String
cases - [CreateProductCaseInput]
Example
{
  "customer_account_id": "abc123",
  "name": "xyz789",
  "sku": "abc123",
  "price": "xyz789",
  "value": "abc123",
  "warehouse_products": [CreateWarehouseProductInput],
  "barcode": "xyz789",
  "country_of_manufacture": "xyz789",
  "dimensions": DimensionsInput,
  "tariff_code": "abc123",
  "product_note": "abc123",
  "kit": false,
  "kit_build": false,
  "no_air": false,
  "final_sale": false,
  "customs_value": "xyz789",
  "customs_description": "abc123",
  "not_owned": true,
  "ignore_on_customs": true,
  "ignore_on_invoice": false,
  "dropship": true,
  "needs_serial_number": false,
  "virtual": true,
  "needs_lot_tracking": true,
  "images": [CreateProductImageInput],
  "tags": ["abc123"],
  "vendors": [CreateProductVendorInput],
  "packer_note": "abc123",
  "cases": [CreateProductCaseInput]
}
Types

CreateProductOutput

Fields
Field Name Description
request_id - String
complexity - Int
product - Product
Example
{
  "request_id": "abc123",
  "complexity": 123,
  "product": Product
}
Types

CreateProductVendorInput

Fields
Input Field Description
vendor_id - String!
vendor_sku - String!
price - String
Example
{
  "vendor_id": "xyz789",
  "vendor_sku": "abc123",
  "price": "abc123"
}
Types

CreatePurchaseOrderAttachmentInput

Fields
Input Field Description
url - String!
description - String
filename - String
file_type - String
Example
{
  "url": "abc123",
  "description": "abc123",
  "filename": "abc123",
  "file_type": "abc123"
}
Types

CreatePurchaseOrderInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
po_number - String!
subtotal - String!
shipping_price - String!
total_price - String!
warehouse_id - String!
line_items - [CreatePurchaseOrderLineItemInput]!
po_date - ISODateTime
po_note - String
fulfillment_status - String
discount - String
vendor_id - String
warehouse - String
packing_note - String
description - String
partner_order_number - String
tax - String
tracking_number - String
attachments - [CreatePurchaseOrderAttachmentInput]
origin_of_shipment - String
Example
{
  "customer_account_id": "abc123",
  "po_number": "abc123",
  "subtotal": "abc123",
  "shipping_price": "xyz789",
  "total_price": "abc123",
  "warehouse_id": "abc123",
  "line_items": [CreatePurchaseOrderLineItemInput],
  "po_date": ISODateTime,
  "po_note": "xyz789",
  "fulfillment_status": "xyz789",
  "discount": "abc123",
  "vendor_id": "xyz789",
  "warehouse": "xyz789",
  "packing_note": "abc123",
  "description": "abc123",
  "partner_order_number": "xyz789",
  "tax": "abc123",
  "tracking_number": "xyz789",
  "attachments": [CreatePurchaseOrderAttachmentInput],
  "origin_of_shipment": "abc123"
}
Types

CreatePurchaseOrderLineItemInput

Fields
Input Field Description
sku - String!
quantity - Int!
expected_weight_in_lbs - String!
price - String!
vendor_id - String
vendor_sku - String
variant_id - Int
quantity_received - Int
quantity_rejected - Int
product_name - String
option_title - String
fulfillment_status - String
sell_ahead - Int
note - String
partner_line_item_id - String
Example
{
  "sku": "xyz789",
  "quantity": 123,
  "expected_weight_in_lbs": "xyz789",
  "price": "abc123",
  "vendor_id": "abc123",
  "vendor_sku": "xyz789",
  "variant_id": 123,
  "quantity_received": 123,
  "quantity_rejected": 123,
  "product_name": "xyz789",
  "option_title": "xyz789",
  "fulfillment_status": "xyz789",
  "sell_ahead": 987,
  "note": "xyz789",
  "partner_line_item_id": "xyz789"
}
Types

CreatePurchaseOrderOutput

Fields
Field Name Description
request_id - String
complexity - Int
purchase_order - PurchaseOrder
Example
{
  "request_id": "abc123",
  "complexity": 123,
  "purchase_order": PurchaseOrder
}
Types

CreateReturnExchangeInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
return_id - String!
exchange_items - [CreateExchangeItem]!
Example
{
  "customer_account_id": "xyz789",
  "return_id": "xyz789",
  "exchange_items": [CreateExchangeItem]
}
Types

CreateReturnExchangeOutput

Fields
Field Name Description
request_id - String
complexity - Int
return_exchange - ReturnExchange
Example
{
  "request_id": "xyz789",
  "complexity": 123,
  "return_exchange": ReturnExchange
}
Types

CreateReturnInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
order_id - String!
warehouse_id - String!
return_reason - String!
label_type - ReturnLabelType!
label_cost - String!
address - AddressInput!
dimensions - DimensionsInput!
shipping_carrier - String!
shipping_method - String!
line_items - [CreateReturnLineItemInput]!
tracking_number - String

If a label was generated outside of ShipHero, you can send us that tracking number so we can create a generic label with it and assign it to the return.
create_label - Boolean

If you want us to generate a label for the return
partner_id - String
display_issue_refund - Boolean

If the user can have access to the refund form
return_pickup_datetime - DateTime

If a scheduled return is needed
Example
{
  "customer_account_id": "xyz789",
  "order_id": "xyz789",
  "warehouse_id": "xyz789",
  "return_reason": "xyz789",
  "label_type": "FREE",
  "label_cost": "xyz789",
  "address": AddressInput,
  "dimensions": DimensionsInput,
  "shipping_carrier": "abc123",
  "shipping_method": "xyz789",
  "line_items": [CreateReturnLineItemInput],
  "tracking_number": "abc123",
  "create_label": false,
  "partner_id": "xyz789",
  "display_issue_refund": true,
  "return_pickup_datetime": "2007-12-03T10:15:30Z"
}
Types

CreateReturnItemExchangeInput

Fields
Input Field Description
exchange_product_sku - String!
quantity - Int!
Example
{
  "exchange_product_sku": "xyz789",
  "quantity": 123
}
Types

CreateReturnLineItemInput

Fields
Input Field Description
sku - String!

The sku of one of the order's line items that is been returned
quantity - Int!
return_reason - String!
condition - String
is_component - Boolean
exchange_items - [CreateReturnItemExchangeInput]
Example
{
  "sku": "xyz789",
  "quantity": 123,
  "return_reason": "xyz789",
  "condition": "abc123",
  "is_component": false,
  "exchange_items": [CreateReturnItemExchangeInput]
}
Types

CreateReturnOutput

Fields
Field Name Description
request_id - String
complexity - Int
return - Return
Example
{
  "request_id": "xyz789",
  "complexity": 987,
  "return": Return
}
Types

CreateShipmentInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
order_id - String!
warehouse_id - String!
address - AddressInput!
line_items - [CreateShipmentLineItemInput]!
labels - [CreateShipmentShippingLabelInput]
notify_customer_via_shiphero - Boolean
notify_customer_via_store - Boolean
shipped_off_shiphero - Boolean
profile - String
Example
{
  "customer_account_id": "xyz789",
  "order_id": "abc123",
  "warehouse_id": "abc123",
  "address": AddressInput,
  "line_items": [CreateShipmentLineItemInput],
  "labels": [CreateShipmentShippingLabelInput],
  "notify_customer_via_shiphero": false,
  "notify_customer_via_store": false,
  "shipped_off_shiphero": false,
  "profile": "abc123"
}
Types

CreateShipmentLineItemInput

Fields
Input Field Description
line_item_id - String!
quantity - Int!
Example
{"line_item_id": "abc123", "quantity": 123}
Types

CreateShipmentOutput

Fields
Field Name Description
request_id - String
complexity - Int
shipment - Shipment
Example
{
  "request_id": "abc123",
  "complexity": 123,
  "shipment": Shipment
}
Types

CreateShipmentShippingLabelInput

Fields
Input Field Description
carrier - String!
shipping_name - String!
shipping_method - String!
cost - String!
address - AddressInput!
dimensions - DimensionsInput!
label - CreateLabelResourceInput!
line_item_ids - [String]!

Specify the line items that should be associated with the label been created. The ids can be shipment line item ids or order line item ids (the ones used to create the shipment line items)
tracking_number - String
tracking_url - String
Example
{
  "carrier": "xyz789",
  "shipping_name": "abc123",
  "shipping_method": "abc123",
  "cost": "xyz789",
  "address": AddressInput,
  "dimensions": DimensionsInput,
  "label": CreateLabelResourceInput,
  "line_item_ids": ["abc123"],
  "tracking_number": "xyz789",
  "tracking_url": "xyz789"
}
Types

CreateShippingLabelInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
carrier - String!
shipping_name - String!
shipping_method - String!
cost - String!
address - AddressInput!
dimensions - DimensionsInput!
label - CreateLabelResourceInput!
line_item_ids - [String]!

Specify the line items that should be associated with the label been created. The ids can be shipment line item ids or order line item ids (the ones used to create the shipment line items)
tracking_number - String
shipment_id - String!
Example
{
  "customer_account_id": "xyz789",
  "carrier": "abc123",
  "shipping_name": "xyz789",
  "shipping_method": "xyz789",
  "cost": "abc123",
  "address": AddressInput,
  "dimensions": DimensionsInput,
  "label": CreateLabelResourceInput,
  "line_item_ids": ["xyz789"],
  "tracking_number": "abc123",
  "shipment_id": "abc123"
}
Types

CreateShippingLabelOutput

Fields
Field Name Description
request_id - String
complexity - Int
shipping_label - ShippingLabel
Example
{
  "request_id": "abc123",
  "complexity": 123,
  "shipping_label": ShippingLabel
}
Types

CreateShippingLinesInput

Fields
Input Field Description
title - String!
price - String!
carrier - String
method - String
Example
{
  "title": "abc123",
  "price": "xyz789",
  "carrier": "xyz789",
  "method": "xyz789"
}
Types

CreateShippingPlanInput

Fields
Input Field Description
subtotal - String
shipping_price - String
total_price - String
warehouse_id - String!
warehouse_note - String
vendor_po_number - String
line_items - [LineItemInput]!
packages - [PackageInput]
pallet - PalletData
Example
{
  "subtotal": "xyz789",
  "shipping_price": "abc123",
  "total_price": "abc123",
  "warehouse_id": "abc123",
  "warehouse_note": "abc123",
  "vendor_po_number": "abc123",
  "line_items": [LineItemInput],
  "packages": [PackageInput],
  "pallet": PalletData
}
Types

CreateShippingPlanOutput

Fields
Field Name Description
request_id - String
complexity - Int
shipping_plan - ShippingPlan
Example
{
  "request_id": "abc123",
  "complexity": 987,
  "shipping_plan": ShippingPlan
}
Types

CreateVendorInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
name - String!
email - String!
account_number - String
address - AddressInput
currency - String
internal_note - String
default_po_note - String
logo - String
partner_vendor_id - Int
Example
{
  "customer_account_id": "abc123",
  "name": "xyz789",
  "email": "xyz789",
  "account_number": "abc123",
  "address": AddressInput,
  "currency": "abc123",
  "internal_note": "xyz789",
  "default_po_note": "xyz789",
  "logo": "xyz789",
  "partner_vendor_id": 123
}
Types

CreateVendorOutput

Fields
Field Name Description
request_id - String
complexity - Int
vendor - Vendor
Example
{
  "request_id": "abc123",
  "complexity": 123,
  "vendor": Vendor
}
Types

CreateWarehouseProductInput

Fields
Input Field Description
warehouse_id - String!
on_hand - Int!
inventory_bin - String
inventory_overstock_bin - String
reserve_inventory - Int
replenishment_level - Int
replenishment_max_level - Int
replenishment_increment - Int
reorder_level - Int
reorder_amount - Int
custom - Boolean
warehouse - String
value - String
value_currency - String
price - String
Example
{
  "warehouse_id": "abc123",
  "on_hand": 123,
  "inventory_bin": "abc123",
  "inventory_overstock_bin": "abc123",
  "reserve_inventory": 123,
  "replenishment_level": 987,
  "replenishment_max_level": 123,
  "replenishment_increment": 987,
  "reorder_level": 123,
  "reorder_amount": 123,
  "custom": false,
  "warehouse": "xyz789",
  "value": "abc123",
  "value_currency": "xyz789",
  "price": "abc123"
}
Types

CreateWebhookInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
name - String!
url - String!
shop_name - String
Example
{
  "customer_account_id": "xyz789",
  "name": "xyz789",
  "url": "abc123",
  "shop_name": "xyz789"
}
Types

CreateWebhookOutput

Fields
Field Name Description
request_id - String
complexity - Int
webhook - Webhook
Example
{
  "request_id": "xyz789",
  "complexity": 123,
  "webhook": Webhook
}
Types

CurrentUserQueryResult

Fields
Field Name Description
request_id - String
complexity - Int
data - User
Example
{
  "request_id": "xyz789",
  "complexity": 987,
  "data": User
}
Types

Date

Description

The Date scalar type represents a Date value as specified by iso8601.

Example
"2007-12-03"
Types

DateTime

Description

The DateTime scalar type represents a DateTime value as specified by iso8601.

Example
"2007-12-03T10:15:30Z"
Types

Decimal

Description

The Decimal scalar type represents a python Decimal.

Example
Decimal
Types

DeleteBillInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
id - String!
Example
{
  "customer_account_id": "abc123",
  "id": "xyz789"
}
Types

DeleteLotInput

Description

GraphQL input type for Lot delete.

Fields
Input Field Description
lot_id - String!
Example
{"lot_id": "xyz789"}
Types

DeleteLotOutput

Description

GraphQL output type for Lot delete.

Fields
Field Name Description
request_id - String
complexity - Int
lot - Lot
Example
{
  "request_id": "abc123",
  "complexity": 123,
  "lot": Lot
}
Types

DeleteProductInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
sku - String!
Example
{
  "customer_account_id": "abc123",
  "sku": "xyz789"
}
Types

DeleteVendorInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
vendor_id - String!
Example
{
  "customer_account_id": "abc123",
  "vendor_id": "abc123"
}
Types

DeleteWarehouseProductInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
sku - String!
warehouse_id - String!
Example
{
  "customer_account_id": "xyz789",
  "sku": "abc123",
  "warehouse_id": "abc123"
}
Types

DeleteWebhookInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
name - String!
shop_name - String
Example
{
  "customer_account_id": "abc123",
  "name": "xyz789",
  "shop_name": "abc123"
}
Types

Dimensions

Fields
Field Name Description
weight - String Weight in unit configured in the account (Oz by default)
height - String Height in unit configured in the account (In by default)
width - String Width in unit configured in the account (In by default)
length - String Lenght in unit configured in the account (In by default)
Example
{
  "weight": "abc123",
  "height": "abc123",
  "width": "xyz789",
  "length": "abc123"
}
Types

DimensionsInput

Fields
Input Field Description
weight - String

Weight in unit configured in the account (Oz by default)
height - String

Height in unit configured in the account (In by default)
width - String

Width in unit configured in the account (In by default)
length - String

Lenght in unit configured in the account (In by default)
Example
{
  "weight": "xyz789",
  "height": "abc123",
  "width": "abc123",
  "length": "abc123"
}
Types

EntityType

Values
Enum Value Description

Account

User

Warehouse

PurchaseOrder

Order

LineItem

Return

Product

Bin

LocationType

PurchaseOrderLineItem

ReturnItem

Shipment

ShippedLineItem

WarehouseProduct

Vendor

Tote
Example
"Account"
Types

FbaInventory

Fields
Field Name Description
id - String
legacy_id - Int
quantity - Int
marketplace_id - String
merchant_id - String
Example
{
  "id": "xyz789",
  "legacy_id": 987,
  "quantity": 123,
  "marketplace_id": "xyz789",
  "merchant_id": "xyz789"
}
Types

FeeCategoryTotal

Fields
Field Name Description
id - String
legacy_id - Int
amount - Money
label - String
category - String
quantity - Int
Example
{
  "id": "xyz789",
  "legacy_id": 123,
  "amount": Money,
  "label": "abc123",
  "category": "abc123",
  "quantity": 123
}
Types

FeeCategoryTotalConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [FeeCategoryTotalEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [FeeCategoryTotalEdge]
}
Types

FeeCategoryTotalEdge

Description

A Relay edge containing a FeeCategoryTotal and its cursor.

Fields
Field Name Description
node - FeeCategoryTotal The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": FeeCategoryTotal,
  "cursor": "xyz789"
}
Types

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example
987.65
Types

FulfillOrderInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
order_id - String!

The id of the order you want to modify
tote_id - String!
packages - [ShippedPackagesInput]!
notify_customer_via_shiphero - Boolean
notify_customer_via_store - Boolean
shipped_off_shiphero - Boolean
note - String
Example
{
  "customer_account_id": "xyz789",
  "order_id": "xyz789",
  "tote_id": "abc123",
  "packages": [ShippedPackagesInput],
  "notify_customer_via_shiphero": true,
  "notify_customer_via_store": true,
  "shipped_off_shiphero": true,
  "note": "xyz789"
}
Types

FulfillmentInvoice

Fields
Field Name Description
id - String
legacy_id - Int
stripe_charge_id - String
stripe_invoice_id - String
stripe_invoice_number - String
stripe_invoice_status - String
stripe_invoice_url - String
stripe_next_payment_attempt - ISODateTime
account_id - String
cc_info - String
amount - String
created_at - ISODateTime
shipping_items - FulfillmentInvoiceShippingItemConnection
Arguments
sort - String
before - String
after - String
first - Int
last - Int
inbound_shipping_items - FulfillmentInvoiceInboundShippingItemConnection
Arguments
sort - String
before - String
after - String
first - Int
last - Int
returns_items - FulfillmentInvoiceReturnItemConnection
Arguments
sort - String
before - String
after - String
first - Int
last - Int
storage_items - FulfillmentInvoiceStorageItemConnection
Arguments
sort - String
before - String
after - String
first - Int
last - Int
Example
{
  "id": "xyz789",
  "legacy_id": 987,
  "stripe_charge_id": "xyz789",
  "stripe_invoice_id": "xyz789",
  "stripe_invoice_number": "abc123",
  "stripe_invoice_status": "abc123",
  "stripe_invoice_url": "abc123",
  "stripe_next_payment_attempt": ISODateTime,
  "account_id": "xyz789",
  "cc_info": "xyz789",
  "amount": "xyz789",
  "created_at": ISODateTime,
  "shipping_items": FulfillmentInvoiceShippingItemConnection,
  "inbound_shipping_items": FulfillmentInvoiceInboundShippingItemConnection,
  "returns_items": FulfillmentInvoiceReturnItemConnection,
  "storage_items": FulfillmentInvoiceStorageItemConnection
}
Types

FulfillmentInvoiceConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [FulfillmentInvoiceEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [FulfillmentInvoiceEdge]
}
Types

FulfillmentInvoiceEdge

Description

A Relay edge containing a FulfillmentInvoice and its cursor.

Fields
Field Name Description
node - FulfillmentInvoice The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": FulfillmentInvoice,
  "cursor": "xyz789"
}
Types

FulfillmentInvoiceInboundShippingItem

Fields
Field Name Description
id - String
legacy_id - Int
account_id - String
invoice_id - String
purchase_order_id - String
shipment_id - String
shipping_label_id - String
amount - String
cost - String
created_at - ISODateTime
Example
{
  "id": "abc123",
  "legacy_id": 123,
  "account_id": "abc123",
  "invoice_id": "abc123",
  "purchase_order_id": "abc123",
  "shipment_id": "abc123",
  "shipping_label_id": "xyz789",
  "amount": "abc123",
  "cost": "xyz789",
  "created_at": ISODateTime
}
Types

FulfillmentInvoiceInboundShippingItemConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [FulfillmentInvoiceInboundShippingItemEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [FulfillmentInvoiceInboundShippingItemEdge]
}
Types

FulfillmentInvoiceInboundShippingItemEdge

Description

A Relay edge containing a FulfillmentInvoiceInboundShippingItem and its cursor.

Fields
Field Name Description
node - FulfillmentInvoiceInboundShippingItem The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": FulfillmentInvoiceInboundShippingItem,
  "cursor": "xyz789"
}
Types

FulfillmentInvoiceQueryResult

Fields
Field Name Description
request_id - String
complexity - Int
data - FulfillmentInvoice
Example
{
  "request_id": "xyz789",
  "complexity": 123,
  "data": FulfillmentInvoice
}
Types

FulfillmentInvoiceReturnItem

Fields
Field Name Description
id - String
legacy_id - Int
account_id - String
invoice_id - String
order_id - String
rma_id - String
rma_label_id - String
amount - String
shipping_rate - String
picking_fee - String
inspection_fee - String
restocking_fee - String
created_at - ISODateTime
Example
{
  "id": "xyz789",
  "legacy_id": 987,
  "account_id": "xyz789",
  "invoice_id": "abc123",
  "order_id": "abc123",
  "rma_id": "abc123",
  "rma_label_id": "abc123",
  "amount": "xyz789",
  "shipping_rate": "xyz789",
  "picking_fee": "xyz789",
  "inspection_fee": "xyz789",
  "restocking_fee": "xyz789",
  "created_at": ISODateTime
}
Types

FulfillmentInvoiceReturnItemConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [FulfillmentInvoiceReturnItemEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [FulfillmentInvoiceReturnItemEdge]
}
Types

FulfillmentInvoiceReturnItemEdge

Description

A Relay edge containing a FulfillmentInvoiceReturnItem and its cursor.

Fields
Field Name Description
node - FulfillmentInvoiceReturnItem The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": FulfillmentInvoiceReturnItem,
  "cursor": "abc123"
}
Types

FulfillmentInvoiceShippingItem

Fields
Field Name Description
id - String
legacy_id - Int
account_id - String
invoice_id - String
order_id - String
shipment_id - String
shipping_label_id - String
amount - String
shipping_rate - String
processing_fee - String
picking_fee - String
overcharge_fee - String
created_at - ISODateTime
Example
{
  "id": "xyz789",
  "legacy_id": 987,
  "account_id": "abc123",
  "invoice_id": "abc123",
  "order_id": "xyz789",
  "shipment_id": "abc123",
  "shipping_label_id": "abc123",
  "amount": "abc123",
  "shipping_rate": "xyz789",
  "processing_fee": "xyz789",
  "picking_fee": "xyz789",
  "overcharge_fee": "xyz789",
  "created_at": ISODateTime
}
Types

FulfillmentInvoiceShippingItemConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [FulfillmentInvoiceShippingItemEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [FulfillmentInvoiceShippingItemEdge]
}
Types

FulfillmentInvoiceShippingItemEdge

Description

A Relay edge containing a FulfillmentInvoiceShippingItem and its cursor.

Fields
Field Name Description
node - FulfillmentInvoiceShippingItem The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": FulfillmentInvoiceShippingItem,
  "cursor": "abc123"
}
Types

FulfillmentInvoiceStorageItem

Fields
Field Name Description
id - String
legacy_id - Int
account_id - String
warehouse_id - String
invoice_id - String
amount - String
created_at - ISODateTime
Example
{
  "id": "abc123",
  "legacy_id": 987,
  "account_id": "xyz789",
  "warehouse_id": "abc123",
  "invoice_id": "xyz789",
  "amount": "xyz789",
  "created_at": ISODateTime
}
Types

FulfillmentInvoiceStorageItemConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [FulfillmentInvoiceStorageItemEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [FulfillmentInvoiceStorageItemEdge]
}
Types

FulfillmentInvoiceStorageItemEdge

Description

A Relay edge containing a FulfillmentInvoiceStorageItem and its cursor.

Fields
Field Name Description
node - FulfillmentInvoiceStorageItem The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": FulfillmentInvoiceStorageItem,
  "cursor": "xyz789"
}
Types

FulfillmentInvoicesQueryResult

Fields
Field Name Description
request_id - String
complexity - Int
data - FulfillmentInvoiceConnection
Arguments
sort - String
before - String
after - String
first - Int
last - Int
Example
{
  "request_id": "abc123",
  "complexity": 987,
  "data": FulfillmentInvoiceConnection
}
Types

GenericScalar

Description

The GenericScalar scalar type represents a generic GraphQL scalar value that could be: String, Boolean, Int, Float, List or Object.

Example
GenericScalar
Types

HoldsInput

Fields
Input Field Description
payment_hold - Boolean
operator_hold - Boolean
fraud_hold - Boolean
address_hold - Boolean
client_hold - Boolean
Example
{
  "payment_hold": false,
  "operator_hold": true,
  "fraud_hold": false,
  "address_hold": true,
  "client_hold": false
}
Types

ID

Description

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Example
"4"
Types

ISODateTime

Description

A DateTime field type that understand ISO 8601 strings, besides datetime objects. It supports strings with and without times, as well as using T or space as delimiter

Ex.

  • YYYY-mm-dd
  • YYYY-mm-dd HH:MM:SS
  • YYYY-mm-ddTHH:MM:SS
Example
ISODateTime
Types

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31 - 1) and 2^31 - 1 since represented in JSON as double-precision floating point numbers specifiedby IEEE 754.

Example
123
Types

InventoryAbortSnapshotInput

Fields
Input Field Description
snapshot_id - String!
reason - String
Example
{
  "snapshot_id": "abc123",
  "reason": "xyz789"
}
Types

InventoryChange

Fields
Field Name Description
id - String
legacy_id - Int For customers that transitioned from static slotting to dynamic slotting, there can be multiple records with the same legacy_id, please use the id field instead
user_id - String
account_id - String
warehouse_id - String
sku - String
previous_on_hand - Int
change_in_on_hand - Int
reason - String
cycle_counted - Boolean
location_id - String
created_at - ISODateTime
product - Product
location - Location
Example
{
  "id": "abc123",
  "legacy_id": 123,
  "user_id": "abc123",
  "account_id": "xyz789",
  "warehouse_id": "xyz789",
  "sku": "abc123",
  "previous_on_hand": 987,
  "change_in_on_hand": 987,
  "reason": "abc123",
  "cycle_counted": true,
  "location_id": "xyz789",
  "created_at": ISODateTime,
  "product": Product,
  "location": Location
}
Types

InventoryChangeConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [InventoryChangeEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [InventoryChangeEdge]
}
Types

InventoryChangeEdge

Description

A Relay edge containing a InventoryChange and its cursor.

Fields
Field Name Description
node - InventoryChange The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": InventoryChange,
  "cursor": "xyz789"
}
Types

InventoryChangesQueryResult

Fields
Field Name Description
request_id - String
complexity - Int
data - InventoryChangeConnection
Arguments
sort - String
before - String
after - String
first - Int
last - Int
Example
{
  "request_id": "xyz789",
  "complexity": 123,
  "data": InventoryChangeConnection
}
Types

InventoryGenerateSnapshotInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
warehouse_id - String
notification_email - String
post_url - String
post_url_pre_check - Boolean

If false, a pre-check on the POST URL will not be performed. This eliminates immediate validation and feedback in the mutation response, before sending the request to the worker. Nonetheless, disabling this check can be useful if a one-time token is used to authenticate the endpoint.
new_format - Boolean

If True, the snapshot structure will be organized by customer account id, rather than by SKU alone, adding support for different customer accounts having repeated SKUs.
updated_from - ISODateTime

to filter out products updated since that time
has_inventory - Boolean

to filter out products that don't have inventory
Example
{
  "customer_account_id": "abc123",
  "warehouse_id": "abc123",
  "notification_email": "abc123",
  "post_url": "abc123",
  "post_url_pre_check": false,
  "new_format": true,
  "updated_from": ISODateTime,
  "has_inventory": false
}
Types

InventorySnapshot

Fields
Field Name Description
snapshot_id - String
job_user_id - String
job_account_id - String
warehouse_id - String
customer_account_id - String
notification_email - String
email_error - String
post_url - String
post_error - String
post_url_pre_check - Boolean
status - String
error - String
created_at - ISODateTime
enqueued_at - ISODateTime
updated_at - ISODateTime
snapshot_url - String
snapshot_expiration - ISODateTime
new_format - Boolean
Example
{
  "snapshot_id": "abc123",
  "job_user_id": "abc123",
  "job_account_id": "abc123",
  "warehouse_id": "abc123",
  "customer_account_id": "abc123",
  "notification_email": "xyz789",
  "email_error": "xyz789",
  "post_url": "abc123",
  "post_error": "abc123",
  "post_url_pre_check": true,
  "status": "abc123",
  "error": "abc123",
  "created_at": ISODateTime,
  "enqueued_at": ISODateTime,
  "updated_at": ISODateTime,
  "snapshot_url": "abc123",
  "snapshot_expiration": ISODateTime,
  "new_format": true
}
Types

InventorySnapshotConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [InventorySnapshotEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [InventorySnapshotEdge]
}
Types

InventorySnapshotEdge

Description

A Relay edge containing a InventorySnapshot and its cursor.

Fields
Field Name Description
node - InventorySnapshot The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": InventorySnapshot,
  "cursor": "abc123"
}
Types

InventorySnapshotOutput

Fields
Field Name Description
request_id - String
complexity - Int
snapshot - InventorySnapshot
Example
{
  "request_id": "abc123",
  "complexity": 123,
  "snapshot": InventorySnapshot
}
Types

InventorySnapshotQueryResult

Fields
Field Name Description
request_id - String
complexity - Int
snapshot - InventorySnapshot
Example
{
  "request_id": "xyz789",
  "complexity": 123,
  "snapshot": InventorySnapshot
}
Types

InventorySnapshotsQueryResult

Fields
Field Name Description
request_id - String
complexity - Int
snapshots - InventorySnapshotConnection
Arguments
sort - String
before - String
after - String
first - Int
last - Int
Example
{
  "request_id": "abc123",
  "complexity": 123,
  "snapshots": InventorySnapshotConnection
}
Types

InventorySyncBatchQueryResult

Fields
Field Name Description
request_id - String
complexity - Int
data - InventorySyncStatus
Example
{
  "request_id": "abc123",
  "complexity": 987,
  "data": InventorySyncStatus
}
Types

InventorySyncBatchesQueryResult

Fields
Field Name Description
request_id - String
complexity - Int
data - InventorySyncStatusConnection
Arguments
sort - String
before - String
after - String
first - Int
last - Int
Example
{
  "request_id": "abc123",
  "complexity": 987,
  "data": InventorySyncStatusConnection
}
Types

InventorySyncInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
url - String!
warehouse_id - String!
Example
{
  "customer_account_id": "abc123",
  "url": "xyz789",
  "warehouse_id": "xyz789"
}
Types

InventorySyncItemStatus

Fields
Field Name Description
id - String
row - Int
sku - String
quantity - Int
action - String
reason - String
location - Int
status - String
error - String
created_at - ISODateTime
updated_at - ISODateTime
Example
{
  "id": "xyz789",
  "row": 987,
  "sku": "abc123",
  "quantity": 987,
  "action": "xyz789",
  "reason": "abc123",
  "location": 987,
  "status": "xyz789",
  "error": "abc123",
  "created_at": ISODateTime,
  "updated_at": ISODateTime
}
Types

InventorySyncItemStatusConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [InventorySyncItemStatusEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [InventorySyncItemStatusEdge]
}
Types

InventorySyncItemStatusEdge

Description

A Relay edge containing a InventorySyncItemStatus and its cursor.

Fields
Field Name Description
node - InventorySyncItemStatus The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": InventorySyncItemStatus,
  "cursor": "xyz789"
}
Types

InventorySyncOutput

Fields
Field Name Description
request_id - String
complexity - Int
sync_id - String
Example
{
  "request_id": "xyz789",
  "complexity": 123,
  "sync_id": "xyz789"
}
Types

InventorySyncRowsQueryResult

Fields
Field Name Description
request_id - String
complexity - Int
data - InventorySyncItemStatusConnection
Arguments
sort - String
before - String
after - String
first - Int
last - Int
Example
{
  "request_id": "abc123",
  "complexity": 123,
  "data": InventorySyncItemStatusConnection
}
Types

InventorySyncStatus

Fields
Field Name Description
id - String
url - String
user_id - String
account_id - String
warehouse_id - String
customer_account_id - String
total_count - Int
status - String
error - String
created_at - ISODateTime
updated_at - ISODateTime
success_count - Int
error_count - Int
finished_count - Int
Example
{
  "id": "abc123",
  "url": "xyz789",
  "user_id": "abc123",
  "account_id": "abc123",
  "warehouse_id": "xyz789",
  "customer_account_id": "abc123",
  "total_count": 123,
  "status": "abc123",
  "error": "xyz789",
  "created_at": ISODateTime,
  "updated_at": ISODateTime,
  "success_count": 987,
  "error_count": 123,
  "finished_count": 123
}
Types

InventorySyncStatusConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [InventorySyncStatusEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [InventorySyncStatusEdge]
}
Types

InventorySyncStatusEdge

Description

A Relay edge containing a InventorySyncStatus and its cursor.

Fields
Field Name Description
node - InventorySyncStatus The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": InventorySyncStatus,
  "cursor": "xyz789"
}
Types

ItemLocation

Fields
Field Name Description
id - String
legacy_id - Int
account_id - String
warehouse_id - String
location_id - String
sku - String
quantity - Int
created_at - ISODateTime
location - Location
expiration_lot - Lot
Example
{
  "id": "xyz789",
  "legacy_id": 987,
  "account_id": "abc123",
  "warehouse_id": "abc123",
  "location_id": "xyz789",
  "sku": "abc123",
  "quantity": 987,
  "created_at": ISODateTime,
  "location": Location,
  "expiration_lot": Lot
}
Types

ItemLocationConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [ItemLocationEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [ItemLocationEdge]
}
Types

ItemLocationEdge

Description

A Relay edge containing a ItemLocation and its cursor.

Fields
Field Name Description
node - ItemLocation The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": ItemLocation,
  "cursor": "abc123"
}
Types

KitComponent

Fields
Field Name Description
id - String
legacy_id - Int
account_id - String
sku - String Stock Keeping Unit
quantity - Int Amount of product units within the kit
Example
{
  "id": "xyz789",
  "legacy_id": 987,
  "account_id": "xyz789",
  "sku": "xyz789",
  "quantity": 123
}
Types

LabelResource

Fields
Field Name Description
pdf_location - String
paper_pdf_location - String
thermal_pdf_location - String
image_location - String
Example
{
  "pdf_location": "xyz789",
  "paper_pdf_location": "abc123",
  "thermal_pdf_location": "xyz789",
  "image_location": "xyz789"
}
Types

LastMileLabel

Fields
Field Name Description
id - String
legacy_id - Int
shipping_carrier - String
shipping_method - String
tracking_number - String
tracking_url - String
Example
{
  "id": "xyz789",
  "legacy_id": 987,
  "shipping_carrier": "abc123",
  "shipping_method": "xyz789",
  "tracking_number": "xyz789",
  "tracking_url": "xyz789"
}
Types

LegacyId

Fields
Field Name Description
legacy_id - Int
id - String
Example
{"legacy_id": 123, "id": "xyz789"}
Types

LegacyIdQueryResult

Fields
Field Name Description
request_id - String
complexity - Int
data - LegacyId
Example
{
  "request_id": "abc123",
  "complexity": 123,
  "data": LegacyId
}
Types

LineItem

Fields
Field Name Description
id - String
legacy_id - Int
sku - String
partner_line_item_id - String
product_id - String Products should be referenced by sku
quantity - Int
price - String
product_name - String
option_title - String
fulfillment_status - String
quantity_pending_fulfillment - Int
quantity_shipped - Int
warehouse - String
quantity_allocated - Int
backorder_quantity - Int
custom_options - GenericScalar
custom_barcode - String
eligible_for_return - Boolean
customs_value - String
warehouse_id - String Use order allocations instead
locked_to_warehouse_id - String This field was deprecated on accounts with Multi Warehouse Allocation rules
subtotal - String
barcode - String
created_at - ISODateTime
updated_at - ISODateTime
order_id - String
shipped_line_item_lots - [ShippedLineItemLot]
serial_numbers - [LineItemSerialNumber]
promotion_discount - String
product - Product
tote_picks - [TotePick]
Example
{
  "id": "xyz789",
  "legacy_id": 123,
  "sku": "xyz789",
  "partner_line_item_id": "xyz789",
  "product_id": "abc123",
  "quantity": 987,
  "price": "xyz789",
  "product_name": "xyz789",
  "option_title": "xyz789",
  "fulfillment_status": "xyz789",
  "quantity_pending_fulfillment": 987,
  "quantity_shipped": 123,
  "warehouse": "xyz789",
  "quantity_allocated": 123,
  "backorder_quantity": 987,
  "custom_options": GenericScalar,
  "custom_barcode": "xyz789",
  "eligible_for_return": false,
  "customs_value": "xyz789",
  "warehouse_id": "abc123",
  "locked_to_warehouse_id": "abc123",
  "subtotal": "abc123",
  "barcode": "xyz789",
  "created_at": ISODateTime,
  "updated_at": ISODateTime,
  "order_id": "abc123",
  "shipped_line_item_lots": [ShippedLineItemLot],
  "serial_numbers": [LineItemSerialNumber],
  "promotion_discount": "abc123",
  "product": Product,
  "tote_picks": [TotePick]
}
Types

LineItemInput

Fields
Input Field Description
product_name - String!
sku - String!
quantity - Int!
Example
{
  "product_name": "abc123",
  "sku": "abc123",
  "quantity": 987
}
Types

LineItemQuerySpecConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [LineItemQuerySpecEdge]! Contains the nodes in this connection.
total_count - Int
Example
{
  "pageInfo": PageInfo,
  "edges": [LineItemQuerySpecEdge],
  "total_count": 987
}
Types

LineItemQuerySpecEdge

Description

A Relay edge containing a LineItemQuerySpec and its cursor.

Fields
Field Name Description
node - LineItem The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": LineItem,
  "cursor": "xyz789"
}
Types

LineItemSerialNumber

Fields
Field Name Description
id - String
legacy_id - Int
line_item_id - String
serial_number - String
scanned - Boolean
created_at - ISODateTime
updated_at - ISODateTime
Example
{
  "id": "xyz789",
  "legacy_id": 987,
  "line_item_id": "abc123",
  "serial_number": "xyz789",
  "scanned": false,
  "created_at": ISODateTime,
  "updated_at": ISODateTime
}
Types

Location

Fields
Field Name Description
id - String
legacy_id - Int
account_id - String
warehouse_id - String
type - LocationType
name - String
zone - String
pickable - Boolean
sellable - Boolean
is_cart - Boolean
pick_priority - Int
dimensions - Dimensions
length - String Not used anymore. Use dimensions
width - String Not used anymore. Use dimensions
height - String Not used anymore. Use dimensions
max_weight - String Not used anymore. Use dimensions
temperature - String
products - ProductConnection
Arguments
sort - String
before - String
after - String
first - Int
last - Int
last_counted - ISODateTime
created_at - ISODateTime
expiration_lots - LotConnection
Arguments
customer_account_id - String
sort - String
before - String
after - String
first - Int
last - Int
Example
{
  "id": "abc123",
  "legacy_id": 987,
  "account_id": "xyz789",
  "warehouse_id": "abc123",
  "type": LocationType,
  "name": "xyz789",
  "zone": "xyz789",
  "pickable": false,
  "sellable": true,
  "is_cart": true,
  "pick_priority": 987,
  "dimensions": Dimensions,
  "length": "xyz789",
  "width": "abc123",
  "height": "xyz789",
  "max_weight": "abc123",
  "temperature": "abc123",
  "products": ProductConnection,
  "last_counted": ISODateTime,
  "created_at": ISODateTime,
  "expiration_lots": LotConnection
}
Types

LocationConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [LocationEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [LocationEdge]
}
Types

LocationEdge

Description

A Relay edge containing a Location and its cursor.

Fields
Field Name Description
node - Location The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": Location,
  "cursor": "abc123"
}
Types

LocationOutput

Fields
Field Name Description
request_id - String
complexity - Int
location - Location
Example
{
  "request_id": "abc123",
  "complexity": 987,
  "location": Location
}
Types

LocationQueryResult

Fields
Field Name Description
request_id - String
complexity - Int
data - Location
Example
{
  "request_id": "xyz789",
  "complexity": 987,
  "data": Location
}
Types

LocationType

Fields
Field Name Description
id - String
legacy_id - Int
account_id - String
name - String
daily_storage_cost - String
Example
{
  "id": "abc123",
  "legacy_id": 987,
  "account_id": "xyz789",
  "name": "xyz789",
  "daily_storage_cost": "abc123"
}
Types

LocationsQueryResult

Fields
Field Name Description
request_id - String
complexity - Int
data - LocationConnection
Arguments
sort - String
before - String
after - String
first - Int
last - Int
Example
{
  "request_id": "abc123",
  "complexity": 123,
  "data": LocationConnection
}
Types

Lot

Fields
Field Name Description
id - String
legacy_id - Int
account_id - String
po_id - String
name - String
sku - String
created_at - ISODateTime
updated_at - ISODateTime
expires_at - ISODateTime
received_at - ISODateTime
is_active - Boolean
locations - LocationConnection
Arguments
sort - String
before - String
after - String
first - Int
last - Int
Example
{
  "id": "abc123",
  "legacy_id": 123,
  "account_id": "abc123",
  "po_id": "xyz789",
  "name": "abc123",
  "sku": "xyz789",
  "created_at": ISODateTime,
  "updated_at": ISODateTime,
  "expires_at": ISODateTime,
  "received_at": ISODateTime,
  "is_active": false,
  "locations": LocationConnection
}
Types

LotConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [LotEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [LotEdge]
}
Types

LotEdge

Description

A Relay edge containing a Lot and its cursor.

Fields
Field Name Description
node - Lot The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": Lot,
  "cursor": "abc123"
}
Types

LotsQueryResult

Fields
Field Name Description
request_id - String
complexity - Int
data - LotConnection
Arguments
sort - String
before - String
after - String
first - Int
last - Int
Example
{
  "request_id": "xyz789",
  "complexity": 987,
  "data": LotConnection
}
Types

MergedOrder

Fields
Field Name Description
order_id - String
is_master - Boolean Indicates if it's the master order
Example
{"order_id": "xyz789", "is_master": false}
Types

Money

Example
Money
Types

MutationOutput

Fields
Field Name Description
request_id - String
complexity - Int
Example
{"request_id": "xyz789", "complexity": 987}
Types

Node

Description

An object with an ID

Fields
Field Name Description
id - ID! The ID of the object.
Example
{"id": "4"}
Types

Order

Fields
Field Name Description
id - String
legacy_id - Int
order_number - String The store's internal order number
partner_order_id - String The order ID assigned by the storefront
shop_name - String
fulfillment_status - String Status of the order (pending, fulfilled, cancelled, etc)
order_date - ISODateTime
total_tax - String
subtotal - String
total_discounts - String
total_price - String
box_name - String
ready_to_ship - Boolean This field is no longer being updated and should not be used or relied on
auto_print_return_label - Boolean
custom_invoice_url - String
account_id - String
updated_at - ISODateTime
email - String
profile - String
gift_note - String
packing_note - String
required_ship_date - ISODateTime
shipping_lines - ShippingLines
shipping_address - OrderAddress
billing_address - OrderAddress
tags - [String]
line_items - LineItemQuerySpecConnection
Arguments
sort - String
search - GenericScalar
before - String
after - String
first - Int
last - Int
authorizations - [Authorization]
holds - OrderHolds
shipments - [Shipment]
returns - [Return]
rma_labels - [RMALabel]
flagged - Boolean
saturday_delivery - Boolean
ignore_address_validation_errors - Boolean
skip_address_validation - Boolean
priority_flag - Boolean
allocation_priority - Int
allocations - [OrderWarehouseAllocation]
source - String
third_party_shipper - OrderThirdPartyShipper
gift_invoice - Boolean
allow_partial - Boolean
require_signature - Boolean
adult_signature_required - Boolean
alcohol - Boolean
expected_weight_in_oz - String
insurance - Boolean
insurance_amount - String
currency - String
has_dry_ice - Boolean
allow_split - Boolean
hold_until_date - ISODateTime
incoterms - String
tax_id - String
tax_type - String
dry_ice_weight_in_lbs - String
ftr_exemption - Decimal
address_is_business - Boolean
order_history - [OrderHistory]
merged_orders - [MergedOrder]
attachments - OrderAttachmentQuerySpecConnection
Arguments
sort - String
search - GenericScalar
before - String
after - String
first - Int
last - Int
Example
{
  "id": "xyz789",
  "legacy_id": 123,
  "order_number": "abc123",
  "partner_order_id": "xyz789",
  "shop_name": "xyz789",
  "fulfillment_status": "xyz789",
  "order_date": ISODateTime,
  "total_tax": "abc123",
  "subtotal": "abc123",
  "total_discounts": "abc123",
  "total_price": "abc123",
  "box_name": "xyz789",
  "ready_to_ship": true,
  "auto_print_return_label": true,
  "custom_invoice_url": "xyz789",
  "account_id": "abc123",
  "updated_at": ISODateTime,
  "email": "xyz789",
  "profile": "xyz789",
  "gift_note": "xyz789",
  "packing_note": "xyz789",
  "required_ship_date": ISODateTime,
  "shipping_lines": ShippingLines,
  "shipping_address": OrderAddress,
  "billing_address": OrderAddress,
  "tags": ["abc123"],
  "line_items": LineItemQuerySpecConnection,
  "authorizations": [Authorization],
  "holds": OrderHolds,
  "shipments": [Shipment],
  "returns": [Return],
  "rma_labels": [RMALabel],
  "flagged": true,
  "saturday_delivery": false,
  "ignore_address_validation_errors": true,
  "skip_address_validation": true,
  "priority_flag": true,
  "allocation_priority": 123,
  "allocations": [OrderWarehouseAllocation],
  "source": "abc123",
  "third_party_shipper": OrderThirdPartyShipper,
  "gift_invoice": true,
  "allow_partial": true,
  "require_signature": true,
  "adult_signature_required": false,
  "alcohol": false,
  "expected_weight_in_oz": "xyz789",
  "insurance": false,
  "insurance_amount": "abc123",
  "currency": "xyz789",
  "has_dry_ice": false,
  "allow_split": true,
  "hold_until_date": ISODateTime,
  "incoterms": "abc123",
  "tax_id": "abc123",
  "tax_type": "abc123",
  "dry_ice_weight_in_lbs": "xyz789",
  "ftr_exemption": Decimal,
  "address_is_business": false,
  "order_history": [OrderHistory],
  "merged_orders": [MergedOrder],
  "attachments": OrderAttachmentQuerySpecConnection
}
Types

OrderAddAttachmentInput

Fields
Input Field Description
order_id - String!
url - URL!
customer_account_id - String
filename - String
file_type - String
description - String
Example
{
  "order_id": "abc123",
  "url": "http://www.test.com/",
  "customer_account_id": "xyz789",
  "filename": "abc123",
  "file_type": "xyz789",
  "description": "xyz789"
}
Types

OrderAddAttachmentOutput

Fields
Field Name Description
request_id - String
complexity - Int
attachment - OrderAttachment
Example
{
  "request_id": "xyz789",
  "complexity": 987,
  "attachment": OrderAttachment
}
Types

OrderAddress

Description

Order type for addresses. Orders have addresses with more details than the rest of the system so we use our own types

Fields
Field Name Description
first_name - String
last_name - String
company - String
address1 - String
address2 - String
city - String
state - String
state_code - String
zip - String
country - String
country_code - String
email - String
phone - String
Example
{
  "first_name": "abc123",
  "last_name": "xyz789",
  "company": "xyz789",
  "address1": "xyz789",
  "address2": "abc123",
  "city": "abc123",
  "state": "xyz789",
  "state_code": "xyz789",
  "zip": "abc123",
  "country": "xyz789",
  "country_code": "abc123",
  "email": "xyz789",
  "phone": "abc123"
}
Types

OrderAttachment

Fields
Field Name Description
id - String
legacy_id - Int
order_id - String
account_id - String
description - String
url - String
filename - String
file_type - String
file_size - Int
created_at - ISODateTime
Example
{
  "id": "abc123",
  "legacy_id": 987,
  "order_id": "xyz789",
  "account_id": "abc123",
  "description": "xyz789",
  "url": "abc123",
  "filename": "abc123",
  "file_type": "abc123",
  "file_size": 123,
  "created_at": ISODateTime
}
Types

OrderAttachmentQuerySpecConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [OrderAttachmentQuerySpecEdge]! Contains the nodes in this connection.
total_count - Int
Example
{
  "pageInfo": PageInfo,
  "edges": [OrderAttachmentQuerySpecEdge],
  "total_count": 987
}
Types

OrderAttachmentQuerySpecEdge

Description

A Relay edge containing a OrderAttachmentQuerySpec and its cursor.

Fields
Field Name Description
node - OrderAttachment The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": OrderAttachment,
  "cursor": "abc123"
}
Types

OrderConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [OrderEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [OrderEdge]
}
Types

OrderEdge

Description

A Relay edge containing a Order and its cursor.

Fields
Field Name Description
node - Order The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": Order,
  "cursor": "abc123"
}
Types

OrderHistory

Fields
Field Name Description
id - String
legacy_id - Int
order_id - String
user_id - String
account_id - String
username - String
order_number - String
information - String
created_at - ISODateTime
order - Order
Example
{
  "id": "xyz789",
  "legacy_id": 123,
  "order_id": "xyz789",
  "user_id": "abc123",
  "account_id": "abc123",
  "username": "abc123",
  "order_number": "xyz789",
  "information": "abc123",
  "created_at": ISODateTime,
  "order": Order
}
Types

OrderHistoryConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [OrderHistoryEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [OrderHistoryEdge]
}
Types

OrderHistoryEdge

Description

A Relay edge containing a OrderHistory and its cursor.

Fields
Field Name Description
node - OrderHistory The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": OrderHistory,
  "cursor": "abc123"
}
Types

OrderHistoryQueryResult

Fields
Field Name Description
request_id - String
complexity - Int
data - OrderHistoryConnection
Arguments
sort - String
before - String
after - String
first - Int
last - Int
Example
{
  "request_id": "abc123",
  "complexity": 123,
  "data": OrderHistoryConnection
}
Types

OrderHolds

Fields
Field Name Description
fraud_hold - Boolean
address_hold - Boolean
shipping_method_hold - Boolean
operator_hold - Boolean
payment_hold - Boolean
client_hold - Boolean
Example
{
  "fraud_hold": false,
  "address_hold": false,
  "shipping_method_hold": false,
  "operator_hold": true,
  "payment_hold": false,
  "client_hold": true
}
Types

OrderLineItemAllocation

Fields
Field Name Description
order_id - String
warehouse_id - String
allocated_at - ISODateTime
line_item_id - String
sku - String
quantity_allocated - Int
is_kit_component - Boolean
allocation_reference - String
Example
{
  "order_id": "xyz789",
  "warehouse_id": "abc123",
  "allocated_at": ISODateTime,
  "line_item_id": "abc123",
  "sku": "xyz789",
  "quantity_allocated": 987,
  "is_kit_component": true,
  "allocation_reference": "xyz789"
}
Types

OrderMutationOutput

Fields
Field Name Description
request_id - String
complexity - Int
order - Order
Example
{
  "request_id": "abc123",
  "complexity": 123,
  "order": Order
}
Types

OrderNoteAttributeInput

Fields
Input Field Description
name - String
value - String
Example
{
  "name": "abc123",
  "value": "xyz789"
}
Types

OrderQueryResult

Fields
Field Name Description
request_id - String
complexity - Int
data - Order
Example
{
  "request_id": "abc123",
  "complexity": 123,
  "data": Order
}
Types

OrderShipmentMutationOutput

Fields
Field Name Description
request_id - String
complexity - Int
shipment - Shipment
Example
{
  "request_id": "xyz789",
  "complexity": 123,
  "shipment": Shipment
}
Types

OrderThirdPartyShipper

Fields
Field Name Description
account_number - String
zip - String
country - String
Example
{
  "account_number": "xyz789",
  "zip": "xyz789",
  "country": "abc123"
}
Types

OrderWarehouseAllocation

Fields
Field Name Description
order_id - String
warehouse_id - String
allocated_at - ISODateTime
allocation_reference - String
ready_to_ship - Boolean
line_items - [OrderLineItemAllocation]
is_locked - Boolean
Example
{
  "order_id": "xyz789",
  "warehouse_id": "xyz789",
  "allocated_at": ISODateTime,
  "allocation_reference": "xyz789",
  "ready_to_ship": false,
  "line_items": [OrderLineItemAllocation],
  "is_locked": false
}
Types

OrdersQueryResult

Fields
Field Name Description
request_id - String
complexity - Int
data - OrderConnection
Arguments
sort - String
before - String
after - String
first - Int
last - Int
Example
{
  "request_id": "abc123",
  "complexity": 987,
  "data": OrderConnection
}
Types

Package

Fields
Field Name Description
id - String
legacy_id - Int
shipment_id - String
warehouse_id - String
order_id - String
order_number - String
user_id - String
user_first_name - String
user_last_name - String
total_items - Int The sum of every shipped item's quantity in the package
unique_items - Int The number of unique shipped items in the package
barcodes_scanned - Int The nuber of barcodes scanned in the package
created_at - ISODateTime
shipment - Shipment
order - Order
Example
{
  "id": "xyz789",
  "legacy_id": 123,
  "shipment_id": "abc123",
  "warehouse_id": "xyz789",
  "order_id": "abc123",
  "order_number": "abc123",
  "user_id": "xyz789",
  "user_first_name": "xyz789",
  "user_last_name": "abc123",
  "total_items": 987,
  "unique_items": 987,
  "barcodes_scanned": 987,
  "created_at": ISODateTime,
  "shipment": Shipment,
  "order": Order
}
Types

PackageConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [PackageEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [PackageEdge]
}
Types

PackageEdge

Description

A Relay edge containing a Package and its cursor.

Fields
Field Name Description
node - Package The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": Package,
  "cursor": "abc123"
}
Types

PackageInput

Fields
Input Field Description
line_items - [PackageLineItemInput]!
Example
{"line_items": [PackageLineItemInput]}
Types

PackageLineItemInput

Fields
Input Field Description
sku - String!
quantity - Int!
Example
{"sku": "xyz789", "quantity": 123}
Types

PacksPerDayQueryResult

Fields
Field Name Description
request_id - String
complexity - Int
data - PackageConnection
Arguments
sort - String
before - String
after - String
first - Int
last - Int
Example
{
  "request_id": "xyz789",
  "complexity": 123,
  "data": PackageConnection
}
Types

PageInfo

Description

The Relay compliant PageInfo type, containing data necessary to paginate this connection.

Fields
Field Name Description
hasNextPage - Boolean! When paginating forwards, are there more items?
hasPreviousPage - Boolean! When paginating backwards, are there more items?
startCursor - String When paginating backwards, the cursor to continue.
endCursor - String When paginating forwards, the cursor to continue.
Example
{
  "hasNextPage": true,
  "hasPreviousPage": true,
  "startCursor": "abc123",
  "endCursor": "xyz789"
}
Types

PalletData

Fields
Input Field Description
quantity - Int!
kind - String

One of 'ftl', 'ltl', 'container'
page_size - String

One of '4x6', 'letter'
floor_loaded - Boolean
Example
{
  "quantity": 987,
  "kind": "abc123",
  "page_size": "xyz789",
  "floor_loaded": false
}
Types

Pick

Fields
Field Name Description
id - String
legacy_id - Int
user_id - String
tote_id - String
line_item_id - String
pending_shipment_line_item_id - String
location_id - String
warehouse_id - String
order_id - String
order_number - String
user_first_name - String
user_last_name - String
inventory_bin - String
sku - String
quantity - Int The number required
picked_quantity - Int The number that was picked
pick_type - String
barcode_scanned - String
created_at - ISODateTime
line_item - LineItem
order - Order
Example
{
  "id": "abc123",
  "legacy_id": 987,
  "user_id": "xyz789",
  "tote_id": "abc123",
  "line_item_id": "xyz789",
  "pending_shipment_line_item_id": "xyz789",
  "location_id": "xyz789",
  "warehouse_id": "abc123",
  "order_id": "xyz789",
  "order_number": "xyz789",
  "user_first_name": "xyz789",
  "user_last_name": "xyz789",
  "inventory_bin": "xyz789",
  "sku": "abc123",
  "quantity": 123,
  "picked_quantity": 123,
  "pick_type": "xyz789",
  "barcode_scanned": "abc123",
  "created_at": ISODateTime,
  "line_item": LineItem,
  "order": Order
}
Types

PickConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [PickEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [PickEdge]
}
Types

PickEdge

Description

A Relay edge containing a Pick and its cursor.

Fields
Field Name Description
node - Pick The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": Pick,
  "cursor": "xyz789"
}
Types

PicksPerDayQueryResult

Fields
Field Name Description
request_id - String
complexity - Int
data - PickConnection
Arguments
sort - String
before - String
after - String
first - Int
last - Int
Example
{
  "request_id": "abc123",
  "complexity": 987,
  "data": PickConnection
}
Types

Product

Fields
Field Name Description
id - String
legacy_id - Int
account_id - String
name - String Name of the product
sku - String Stock Keeping Unit
price - String Price of the product This is a warehouse specific field
value - String Price paid for the product This is a warehouse specific field
value_currency - String This is a warehouse specific field
barcode - String
country_of_manufacture - String
dimensions - Dimensions
tariff_code - String
kit - Boolean
kit_build - Boolean
no_air - Boolean
final_sale - Boolean
customs_value - String
customs_description - String
not_owned - Boolean
dropship - Boolean
needs_serial_number - Boolean
thumbnail - String
large_thumbnail - String
created_at - ISODateTime
updated_at - ISODateTime
product_note - String
virtual - Boolean
ignore_on_invoice - Boolean
ignore_on_customs - Boolean
active - Boolean This is a warehouse specific field
needs_lot_tracking - Boolean
warehouse_products - [WarehouseProduct] The physical instances of the product, stored in warehouses
fba_inventory - [FbaInventory] Inventory available at FBA
images - [ProductImage]
tags - [String]
vendors - [ProductVendor]
components - [Product] For kits, this will be the list of products that make up the kit This has been replaced by kit_components
kit_components - [KitComponent] For kits, this will be the list of references to the products that make up the kit and their quantities
cases - [Case]
packer_note - String
Example
{
  "id": "abc123",
  "legacy_id": 987,
  "account_id": "xyz789",
  "name": "xyz789",
  "sku": "abc123",
  "price": "xyz789",
  "value": "abc123",
  "value_currency": "abc123",
  "barcode": "abc123",
  "country_of_manufacture": "xyz789",
  "dimensions": Dimensions,
  "tariff_code": "xyz789",
  "kit": true,
  "kit_build": true,
  "no_air": true,
  "final_sale": true,
  "customs_value": "xyz789",
  "customs_description": "abc123",
  "not_owned": true,
  "dropship": true,
  "needs_serial_number": false,
  "thumbnail": "xyz789",
  "large_thumbnail": "xyz789",
  "created_at": ISODateTime,
  "updated_at": ISODateTime,
  "product_note": "abc123",
  "virtual": false,
  "ignore_on_invoice": true,
  "ignore_on_customs": false,
  "active": false,
  "needs_lot_tracking": false,
  "warehouse_products": [WarehouseProduct],
  "fba_inventory": [FbaInventory],
  "images": [ProductImage],
  "tags": ["xyz789"],
  "vendors": [ProductVendor],
  "components": [Product],
  "kit_components": [KitComponent],
  "cases": [Case],
  "packer_note": "abc123"
}
Types

ProductConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [ProductEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [ProductEdge]
}
Types

ProductEdge

Description

A Relay edge containing a Product and its cursor.

Fields
Field Name Description
node - Product The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": Product,
  "cursor": "abc123"
}
Types

ProductImage

Fields
Field Name Description
src - String The url where the image is hosted
position - Int The order in which the image should appear
Example
{"src": "xyz789", "position": 123}
Types

ProductMutationOutput

Fields
Field Name Description
request_id - String
complexity - Int
product - Product
Example
{
  "request_id": "xyz789",
  "complexity": 987,
  "product": Product
}
Types

ProductQueryResult

Fields
Field Name Description
request_id - String
complexity - Int
data - Product
Example
{
  "request_id": "xyz789",
  "complexity": 123,
  "data": Product
}
Types

ProductVendor

Fields
Field Name Description
vendor_id - String
vendor_sku - String
price - String
Example
{
  "vendor_id": "xyz789",
  "vendor_sku": "abc123",
  "price": "xyz789"
}
Types

ProductsQueryResult

Fields
Field Name Description
request_id - String
complexity - Int
data - ProductConnection
Arguments
sort - String
before - String
after - String
first - Int
last - Int
Example
{
  "request_id": "xyz789",
  "complexity": 987,
  "data": ProductConnection
}
Types

PurchaseOrder

Fields
Field Name Description
id - String
legacy_id - Int
po_number - String
account_id - String
warehouse_id - String
vendor_id - String
created_at - ISODateTime
po_date - ISODateTime The expected date to arrive at the warehouse.
date_closed - ISODateTime
arrived_at - ISODateTime
packing_note - String
fulfillment_status - String
po_note - String
description - String
partner_order_number - String
subtotal - String
discount - String
total_price - String
tax - String
shipping_method - String
shipping_carrier - String
shipping_name - String
shipping_price - String
tracking_number - String
pdf - String
images - String
payment_method - String
payment_due_by - String
payment_note - String
locking - String
locked_by_user_id - String
line_items - PurchaseOrderLineItemConnection
Arguments
sort - String
before - String
after - String
first - Int
last - Int
attachments - PurchaseOrderAttachmentConnection
Arguments
sort - String
before - String
after - String
first - Int
last - Int
vendor - Vendor
warehouse - Warehouse
origin_of_shipment - String
tracking_numbers - PurchaseOrderTrackingNumberConnection
Arguments
sort - String
before - String
after - String
first - Int
last - Int
ship_date - DateTime
Example
{
  "id": "abc123",
  "legacy_id": 987,
  "po_number": "abc123",
  "account_id": "abc123",
  "warehouse_id": "xyz789",
  "vendor_id": "xyz789",
  "created_at": ISODateTime,
  "po_date": ISODateTime,
  "date_closed": ISODateTime,
  "arrived_at": ISODateTime,
  "packing_note": "xyz789",
  "fulfillment_status": "xyz789",
  "po_note": "abc123",
  "description": "abc123",
  "partner_order_number": "xyz789",
  "subtotal": "xyz789",
  "discount": "xyz789",
  "total_price": "xyz789",
  "tax": "abc123",
  "shipping_method": "xyz789",
  "shipping_carrier": "abc123",
  "shipping_name": "abc123",
  "shipping_price": "abc123",
  "tracking_number": "abc123",
  "pdf": "xyz789",
  "images": "xyz789",
  "payment_method": "abc123",
  "payment_due_by": "abc123",
  "payment_note": "xyz789",
  "locking": "xyz789",
  "locked_by_user_id": "xyz789",
  "line_items": PurchaseOrderLineItemConnection,
  "attachments": PurchaseOrderAttachmentConnection,
  "vendor": Vendor,
  "warehouse": Warehouse,
  "origin_of_shipment": "abc123",
  "tracking_numbers": PurchaseOrderTrackingNumberConnection,
  "ship_date": "2007-12-03T10:15:30Z"
}
Types

PurchaseOrderAttachment

Fields
Field Name Description
id - String
legacy_id - Int
user_id - String
account_id - String
po_li_sku - String
description - String
filename - String
file_type - String
file_size - Int
created_at - ISODateTime
url - String
Example
{
  "id": "xyz789",
  "legacy_id": 987,
  "user_id": "xyz789",
  "account_id": "abc123",
  "po_li_sku": "abc123",
  "description": "xyz789",
  "filename": "abc123",
  "file_type": "xyz789",
  "file_size": 987,
  "created_at": ISODateTime,
  "url": "abc123"
}
Types

PurchaseOrderAttachmentConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [PurchaseOrderAttachmentEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [PurchaseOrderAttachmentEdge]
}
Types

PurchaseOrderAttachmentEdge

Description

A Relay edge containing a PurchaseOrderAttachment and its cursor.

Fields
Field Name Description
node - PurchaseOrderAttachment The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": PurchaseOrderAttachment,
  "cursor": "abc123"
}
Types

PurchaseOrderConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [PurchaseOrderEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [PurchaseOrderEdge]
}
Types

PurchaseOrderEdge

Description

A Relay edge containing a PurchaseOrder and its cursor.

Fields
Field Name Description
node - PurchaseOrder The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": PurchaseOrder,
  "cursor": "abc123"
}
Types

PurchaseOrderLineItem

Fields
Field Name Description
id - String
legacy_id - Int
po_id - String
account_id - String
warehouse_id - String
vendor_id - String
po_number - String
sku - String
vendor_sku - String
product_id - String
variant_id - Int
quantity - Int
quantity_received - Int
quantity_rejected - Int
price - String
product_name - String
option_title - String
expected_weight_in_lbs - String
fulfillment_status - String
sell_ahead - Int
note - String
partner_line_item_id - String
barcode - String
updated_at - ISODateTime
created_at - ISODateTime
vendor - Vendor
product - WarehouseProduct
expiration_lots - LotConnection
Arguments
sort - String
before - String
after - String
first - Int
last - Int
Example
{
  "id": "abc123",
  "legacy_id": 987,
  "po_id": "abc123",
  "account_id": "xyz789",
  "warehouse_id": "abc123",
  "vendor_id": "abc123",
  "po_number": "abc123",
  "sku": "abc123",
  "vendor_sku": "abc123",
  "product_id": "abc123",
  "variant_id": 987,
  "quantity": 987,
  "quantity_received": 123,
  "quantity_rejected": 987,
  "price": "xyz789",
  "product_name": "xyz789",
  "option_title": "xyz789",
  "expected_weight_in_lbs": "abc123",
  "fulfillment_status": "abc123",
  "sell_ahead": 987,
  "note": "abc123",
  "partner_line_item_id": "abc123",
  "barcode": "xyz789",
  "updated_at": ISODateTime,
  "created_at": ISODateTime,
  "vendor": Vendor,
  "product": WarehouseProduct,
  "expiration_lots": LotConnection
}
Types

PurchaseOrderLineItemConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [PurchaseOrderLineItemEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [PurchaseOrderLineItemEdge]
}
Types

PurchaseOrderLineItemEdge

Description

A Relay edge containing a PurchaseOrderLineItem and its cursor.

Fields
Field Name Description
node - PurchaseOrderLineItem The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": PurchaseOrderLineItem,
  "cursor": "xyz789"
}
Types

PurchaseOrderQueryResult

Fields
Field Name Description
request_id - String
complexity - Int
data - PurchaseOrder
Example
{
  "request_id": "abc123",
  "complexity": 987,
  "data": PurchaseOrder
}
Types

PurchaseOrderTrackingNumber

Fields
Field Name Description
id - String
legacy_id - Int
po_id - String
carrier_id - String
carrier_value - String
tracking_number - String
Example
{
  "id": "abc123",
  "legacy_id": 123,
  "po_id": "abc123",
  "carrier_id": "abc123",
  "carrier_value": "xyz789",
  "tracking_number": "abc123"
}
Types

PurchaseOrderTrackingNumberConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [PurchaseOrderTrackingNumberEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [PurchaseOrderTrackingNumberEdge]
}
Types

PurchaseOrderTrackingNumberEdge

Description

A Relay edge containing a PurchaseOrderTrackingNumber and its cursor.

Fields
Field Name Description
node - PurchaseOrderTrackingNumber The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": PurchaseOrderTrackingNumber,
  "cursor": "abc123"
}
Types

PurchaseOrdersQueryResult

Fields
Field Name Description
request_id - String
complexity - Int
data - PurchaseOrderConnection
Arguments
sort - String
before - String
after - String
first - Int
last - Int
Example
{
  "request_id": "abc123",
  "complexity": 123,
  "data": PurchaseOrderConnection
}
Types

RMALabel

Fields
Field Name Description
id - String
legacy_id - Int
account_id - String
order_id - String
rma_id - String
shipment_id - String
shipping_name - String
tracking_number - String
status - String
carrier - String
shipping_method - String
cost - String
box_code - String
dimensions - Dimensions
address - Address
paper_pdf_location - String
thermal_pdf_location - String
pdf_location - String
image_location - String
delivered - Boolean
picked_up - Boolean
refunded - Boolean
needs_refund - Boolean
profile - String
full_size_to_print - String
partner_fulfillment_id - String
created_at - ISODateTime
updated_at - ISODateTime
Example
{
  "id": "abc123",
  "legacy_id": 123,
  "account_id": "abc123",
  "order_id": "xyz789",
  "rma_id": "xyz789",
  "shipment_id": "abc123",
  "shipping_name": "abc123",
  "tracking_number": "xyz789",
  "status": "abc123",
  "carrier": "abc123",
  "shipping_method": "abc123",
  "cost": "xyz789",
  "box_code": "abc123",
  "dimensions": Dimensions,
  "address": Address,
  "paper_pdf_location": "abc123",
  "thermal_pdf_location": "abc123",
  "pdf_location": "xyz789",
  "image_location": "abc123",
  "delivered": false,
  "picked_up": false,
  "refunded": false,
  "needs_refund": false,
  "profile": "xyz789",
  "full_size_to_print": "abc123",
  "partner_fulfillment_id": "abc123",
  "created_at": ISODateTime,
  "updated_at": ISODateTime
}
Types

RMALabelType

Fields
Field Name Description
id - String
legacy_id - Int
tracking_number - String
status - String
created_date - ISODateTime
carrier - String
shipping_method - String
cost - String
dimensions - Dimensions
length - Float Use dimensions instead
width - Float Use dimensions instead
height - Float Use dimensions instead
weight - Float Use dimensions instead
to_name - String
address1 - String
address2 - String
address_city - String
address_state - String
address_zip - String
address_country - String
pdf_location - String
Example
{
  "id": "abc123",
  "legacy_id": 987,
  "tracking_number": "abc123",
  "status": "abc123",
  "created_date": ISODateTime,
  "carrier": "abc123",
  "shipping_method": "xyz789",
  "cost": "abc123",
  "dimensions": Dimensions,
  "length": 987.65,
  "width": 123.45,
  "height": 987.65,
  "weight": 987.65,
  "to_name": "abc123",
  "address1": "xyz789",
  "address2": "xyz789",
  "address_city": "abc123",
  "address_state": "xyz789",
  "address_zip": "xyz789",
  "address_country": "xyz789",
  "pdf_location": "abc123"
}
Types

RecalculateBillInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
id - String!
Example
{
  "customer_account_id": "xyz789",
  "id": "xyz789"
}
Types

RecalculateBillOutput

Fields
Field Name Description
request_id - String
complexity - Int
bill - Bill
Example
{
  "request_id": "abc123",
  "complexity": 987,
  "bill": Bill
}
Types

RemoveKitComponentInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
sku - String!
Example
{
  "customer_account_id": "abc123",
  "sku": "xyz789"
}
Types

RemoveKitComponentsInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
sku - String!
components - [RemoveKitComponentInput]!
Example
{
  "customer_account_id": "xyz789",
  "sku": "xyz789",
  "components": [RemoveKitComponentInput]
}
Types

RemoveLineItemsInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
order_id - String!

The id of the order you want to modify
line_item_ids - [String]
Example
{
  "customer_account_id": "xyz789",
  "order_id": "abc123",
  "line_item_ids": ["abc123"]
}
Types

RemoveProductFromVendorInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
vendor_id - String!
sku - String!
Example
{
  "customer_account_id": "xyz789",
  "vendor_id": "xyz789",
  "sku": "abc123"
}
Types

ReplaceInventoryInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
sku - String!
warehouse_id - String!
quantity - Int!
reason - String
location_id - String
includes_non_sellable - Boolean
Example
{
  "customer_account_id": "xyz789",
  "sku": "abc123",
  "warehouse_id": "xyz789",
  "quantity": 123,
  "reason": "abc123",
  "location_id": "abc123",
  "includes_non_sellable": false
}
Types

Return

Fields
Field Name Description
id - String
legacy_id - Int
account_id - String
order_id - String
partner_id - String
reason - String
status - String
label_type - ReturnLabelType
label_cost - String
labels - [RMALabelType]
cost_to_customer - String
shipping_carrier - String
shipping_method - String
dimensions - Dimensions
address - Address
line_items - [ReturnLineItem]
total_items_expected - Int
total_items_received - Int
total_items_restocked - Int
created_at - ISODateTime
display_issue_refund - Boolean
order - Order
exchanges - [ReturnExchange]
return_history - [ReturnHistory]
Example
{
  "id": "abc123",
  "legacy_id": 987,
  "account_id": "xyz789",
  "order_id": "xyz789",
  "partner_id": "xyz789",
  "reason": "abc123",
  "status": "xyz789",
  "label_type": "FREE",
  "label_cost": "abc123",
  "labels": [RMALabelType],
  "cost_to_customer": "xyz789",
  "shipping_carrier": "xyz789",
  "shipping_method": "abc123",
  "dimensions": Dimensions,
  "address": Address,
  "line_items": [ReturnLineItem],
  "total_items_expected": 987,
  "total_items_received": 123,
  "total_items_restocked": 987,
  "created_at": ISODateTime,
  "display_issue_refund": true,
  "order": Order,
  "exchanges": [ReturnExchange],
  "return_history": [ReturnHistory]
}
Types

ReturnConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [ReturnEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [ReturnEdge]
}
Types

ReturnEdge

Description

A Relay edge containing a Return and its cursor.

Fields
Field Name Description
node - Return The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": Return,
  "cursor": "xyz789"
}
Types

ReturnExchange

Fields
Field Name Description
id - String
legacy_id - Int
exchange_order_id - String
return_id - String
account_id - String
exchange_order - Order
exchange_items - [ReturnExchangeItem]
original_return - Return
Example
{
  "id": "abc123",
  "legacy_id": 987,
  "exchange_order_id": "abc123",
  "return_id": "abc123",
  "account_id": "abc123",
  "exchange_order": Order,
  "exchange_items": [ReturnExchangeItem],
  "original_return": Return
}
Types

ReturnExchangeItem

Fields
Field Name Description
id - String
legacy_id - Int
return_item_id - String
sku - String
quantity - Int
Example
{
  "id": "abc123",
  "legacy_id": 123,
  "return_item_id": "xyz789",
  "sku": "abc123",
  "quantity": 987
}
Types

ReturnExchangeQueryResult

Fields
Field Name Description
request_id - String
complexity - Int
data - ReturnExchange
Example
{
  "request_id": "xyz789",
  "complexity": 987,
  "data": ReturnExchange
}
Types

ReturnHistory

Fields
Field Name Description
id - String
legacy_id - Int
return_id - String
account_id - String
user_id - String
created_at - ISODateTime
body - String
Example
{
  "id": "xyz789",
  "legacy_id": 987,
  "return_id": "abc123",
  "account_id": "xyz789",
  "user_id": "abc123",
  "created_at": ISODateTime,
  "body": "xyz789"
}
Types

ReturnLabelType

Values
Enum Value Description

FREE

PAID

SELF_RETURN

FLAT_RATE

RETURN_TO_SENDER
Example
"FREE"
Types

ReturnLineItem

Fields
Field Name Description
id - String
legacy_id - Int
account_id - String
line_item_id - String
warehouse_id - String
product_id - String
return_id - String
quantity - Int
quantity_received - Int
restock - Int
condition - String
is_component - Boolean
type - String
reason - String
created_at - ISODateTime
updated_at - ISODateTime
line_item - LineItem
product - Product
warehouse - Warehouse
Example
{
  "id": "abc123",
  "legacy_id": 987,
  "account_id": "xyz789",
  "line_item_id": "xyz789",
  "warehouse_id": "abc123",
  "product_id": "xyz789",
  "return_id": "abc123",
  "quantity": 123,
  "quantity_received": 123,
  "restock": 987,
  "condition": "abc123",
  "is_component": false,
  "type": "abc123",
  "reason": "abc123",
  "created_at": ISODateTime,
  "updated_at": ISODateTime,
  "line_item": LineItem,
  "product": Product,
  "warehouse": Warehouse
}
Types

ReturnQueryResult

Fields
Field Name Description
request_id - String
complexity - Int
data - Return
Example
{
  "request_id": "abc123",
  "complexity": 123,
  "data": Return
}
Types

ReturnsQueryResult

Fields
Field Name Description
request_id - String
complexity - Int
data - ReturnConnection
Arguments
sort - String
before - String
after - String
first - Int
last - Int
Example
{
  "request_id": "abc123",
  "complexity": 123,
  "data": ReturnConnection
}
Types

SetPurchaseOrderFulfillmentStatusInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
po_id - String!
status - String!
Example
{
  "customer_account_id": "xyz789",
  "po_id": "xyz789",
  "status": "abc123"
}
Types

SetPurchaseOrderFulfillmentStatusOutput

Fields
Field Name Description
request_id - String
complexity - Int
purchase_order - PurchaseOrder
Example
{
  "request_id": "abc123",
  "complexity": 987,
  "purchase_order": PurchaseOrder
}
Types

Shipment

Fields
Field Name Description
id - String
legacy_id - Int
order_id - String
user_id - String
warehouse_id - String
pending_shipment_id - String
address - Address
profile - String
picked_up - Boolean
needs_refund - Boolean
refunded - Boolean
delivered - Boolean
dropshipment - Boolean
shipped_off_shiphero - Boolean
completed - Boolean This field indicates if store was notified about the shipment. It should be 'true' by default and 'false' when using the Bulk Ship UI.
created_date - ISODateTime
line_items - ShipmentLineItemConnection
Arguments
sort - String
before - String
after - String
first - Int
last - Int
shipping_labels - [ShippingLabel]
warehouse - Warehouse
order - Order
total_packages - Int
Example
{
  "id": "xyz789",
  "legacy_id": 987,
  "order_id": "xyz789",
  "user_id": "abc123",
  "warehouse_id": "abc123",
  "pending_shipment_id": "xyz789",
  "address": Address,
  "profile": "xyz789",
  "picked_up": true,
  "needs_refund": false,
  "refunded": false,
  "delivered": true,
  "dropshipment": false,
  "shipped_off_shiphero": true,
  "completed": false,
  "created_date": ISODateTime,
  "line_items": ShipmentLineItemConnection,
  "shipping_labels": [ShippingLabel],
  "warehouse": Warehouse,
  "order": Order,
  "total_packages": 987
}
Types

ShipmentConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [ShipmentEdge]! Contains the nodes in this connection.
total_count - Int
Example
{
  "pageInfo": PageInfo,
  "edges": [ShipmentEdge],
  "total_count": 987
}
Types

ShipmentEdge

Description

A Relay edge containing a Shipment and its cursor.

Fields
Field Name Description
node - Shipment The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": Shipment,
  "cursor": "abc123"
}
Types

ShipmentLineItem

Fields
Field Name Description
id - String
legacy_id - Int
line_item_id - String
shipment_id - String
shipping_label_id - String
quantity - Int
line_item - LineItem
Example
{
  "id": "abc123",
  "legacy_id": 123,
  "line_item_id": "abc123",
  "shipment_id": "abc123",
  "shipping_label_id": "xyz789",
  "quantity": 123,
  "line_item": LineItem
}
Types

ShipmentLineItemConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [ShipmentLineItemEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [ShipmentLineItemEdge]
}
Types

ShipmentLineItemEdge

Description

A Relay edge containing a ShipmentLineItem and its cursor.

Fields
Field Name Description
node - ShipmentLineItem The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": ShipmentLineItem,
  "cursor": "xyz789"
}
Types

ShipmentQueryResult

Fields
Field Name Description
request_id - String
complexity - Int
data - Shipment
Example
{
  "request_id": "abc123",
  "complexity": 123,
  "data": Shipment
}
Types

ShipmentsQueryResult

Fields
Field Name Description
request_id - String
complexity - Int
data - ShipmentConnection
Arguments
sort - String
search - GenericScalar
before - String
after - String
first - Int
last - Int
Example
{
  "request_id": "abc123",
  "complexity": 987,
  "data": ShipmentConnection
}
Types

ShippedLineItemInput

Fields
Input Field Description
quantity - Int!
sku - String!
Example
{"quantity": 987, "sku": "abc123"}
Types

ShippedLineItemLot

Fields
Field Name Description
id - String
legacy_id - Int
line_item_id - String
lot_id - String
lot_name - String
lot_expiration_date - ISODateTime
Example
{
  "id": "xyz789",
  "legacy_id": 987,
  "line_item_id": "xyz789",
  "lot_id": "abc123",
  "lot_name": "xyz789",
  "lot_expiration_date": ISODateTime
}
Types

ShippedPackagesInput

Fields
Input Field Description
address - CreateOrderAddressInput!
carrier - String!
method - String!
tracking_number - String
tracking_url - String
label_url - String
cost - String
line_items - [ShippedLineItemInput]
dimensions - DimensionsInput
Example
{
  "address": CreateOrderAddressInput,
  "carrier": "abc123",
  "method": "xyz789",
  "tracking_number": "abc123",
  "tracking_url": "abc123",
  "label_url": "abc123",
  "cost": "abc123",
  "line_items": [ShippedLineItemInput],
  "dimensions": DimensionsInput
}
Types

ShippingLabel

Fields
Field Name Description
id - String
legacy_id - Int
account_id - String
shipment_id - String
order_id - String
box_id - String
box_name - String
status - String
tracking_number - String
alternate_tracking_id - String
order_number - String
order_account_id - String
carrier - String
shipping_name - String
shipping_method - String
cost - String
box_code - String
device_id - String
delivered - Boolean
picked_up - Boolean
refunded - Boolean
needs_refund - Boolean
profile - String
partner_fulfillment_id - String
full_size_to_print - String
packing_slip - String
warehouse - String
warehouse_id - String
insurance_amount - String
carrier_account_id - String
source - String
created_date - ISODateTime
tracking_url - String
dimensions - Dimensions
label - LabelResource
address - Address
order - Order
shipment_line_items - ShipmentLineItemConnection
Arguments
sort - String
before - String
after - String
first - Int
last - Int
package_number - Int
parcelview_url - String
tracking_status - String
in_shipping_container - Boolean
last_mile_labels - LastMileLabel
Example
{
  "id": "xyz789",
  "legacy_id": 123,
  "account_id": "abc123",
  "shipment_id": "abc123",
  "order_id": "xyz789",
  "box_id": "abc123",
  "box_name": "abc123",
  "status": "abc123",
  "tracking_number": "xyz789",
  "alternate_tracking_id": "xyz789",
  "order_number": "abc123",
  "order_account_id": "xyz789",
  "carrier": "xyz789",
  "shipping_name": "xyz789",
  "shipping_method": "abc123",
  "cost": "xyz789",
  "box_code": "xyz789",
  "device_id": "abc123",
  "delivered": true,
  "picked_up": false,
  "refunded": false,
  "needs_refund": false,
  "profile": "xyz789",
  "partner_fulfillment_id": "abc123",
  "full_size_to_print": "abc123",
  "packing_slip": "abc123",
  "warehouse": "abc123",
  "warehouse_id": "abc123",
  "insurance_amount": "abc123",
  "carrier_account_id": "abc123",
  "source": "xyz789",
  "created_date": ISODateTime,
  "tracking_url": "xyz789",
  "dimensions": Dimensions,
  "label": LabelResource,
  "address": Address,
  "order": Order,
  "shipment_line_items": ShipmentLineItemConnection,
  "package_number": 987,
  "parcelview_url": "abc123",
  "tracking_status": "xyz789",
  "in_shipping_container": false,
  "last_mile_labels": LastMileLabel
}
Types

ShippingLines

Fields
Field Name Description
title - String
carrier - String
method - String
price - String
Example
{
  "title": "abc123",
  "carrier": "xyz789",
  "method": "xyz789",
  "price": "xyz789"
}
Types

ShippingPlan

Fields
Field Name Description
id - String
legacy_id - Int
account_id - String
warehouse_id - String
created_at - ISODateTime
fulfillment_status - String
warehouse_note - String
vendor_po_number - String
subtotal - String
shipping_price - String
total_price - String
shipping_method - String
shipping_carrier - String
shipping_name - String
tracking_number - String
warehouse - Warehouse
pdf_location - String
line_items - ShippingPlanLineItemConnection
Arguments
sort - String
before - String
after - String
first - Int
last - Int
packages - ShippingPlanPackageConnection
Arguments
sort - String
before - String
after - String
first - Int
last - Int
pallets - ShippingPlanPalletConnection
Arguments
sort - String
before - String
after - String
first - Int
last - Int
origin_of_shipment - String
tracking_numbers - ShippingPlanTrackingNumberConnection
Arguments
sort - String
before - String
after - String
first - Int
last - Int
Example
{
  "id": "xyz789",
  "legacy_id": 123,
  "account_id": "abc123",
  "warehouse_id": "xyz789",
  "created_at": ISODateTime,
  "fulfillment_status": "xyz789",
  "warehouse_note": "xyz789",
  "vendor_po_number": "abc123",
  "subtotal": "abc123",
  "shipping_price": "abc123",
  "total_price": "abc123",
  "shipping_method": "xyz789",
  "shipping_carrier": "abc123",
  "shipping_name": "abc123",
  "tracking_number": "xyz789",
  "warehouse": Warehouse,
  "pdf_location": "xyz789",
  "line_items": ShippingPlanLineItemConnection,
  "packages": ShippingPlanPackageConnection,
  "pallets": ShippingPlanPalletConnection,
  "origin_of_shipment": "xyz789",
  "tracking_numbers": ShippingPlanTrackingNumberConnection
}
Types

ShippingPlanLineItem

Fields
Field Name Description
id - String
legacy_id - Int
account_id - String
warehouse_id - String
sku - String
vendor_sku - String
product_id - String
variant_id - Int
quantity - Int
quantity_received - Int
quantity_rejected - Int
price - String
product_name - String
option_title - String
expected_weight_in_lbs - String
fulfillment_status - String
sell_ahead - Int
note - String
partner_line_item_id - String
barcode - String
updated_at - ISODateTime
created_at - ISODateTime
product - WarehouseProduct
Example
{
  "id": "xyz789",
  "legacy_id": 987,
  "account_id": "abc123",
  "warehouse_id": "xyz789",
  "sku": "abc123",
  "vendor_sku": "abc123",
  "product_id": "abc123",
  "variant_id": 123,
  "quantity": 123,
  "quantity_received": 123,
  "quantity_rejected": 987,
  "price": "abc123",
  "product_name": "abc123",
  "option_title": "xyz789",
  "expected_weight_in_lbs": "xyz789",
  "fulfillment_status": "xyz789",
  "sell_ahead": 123,
  "note": "abc123",
  "partner_line_item_id": "xyz789",
  "barcode": "xyz789",
  "updated_at": ISODateTime,
  "created_at": ISODateTime,
  "product": WarehouseProduct
}
Types

ShippingPlanLineItemConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [ShippingPlanLineItemEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [ShippingPlanLineItemEdge]
}
Types

ShippingPlanLineItemEdge

Description

A Relay edge containing a ShippingPlanLineItem and its cursor.

Fields
Field Name Description
node - ShippingPlanLineItem The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": ShippingPlanLineItem,
  "cursor": "abc123"
}
Types

ShippingPlanPackage

Fields
Field Name Description
id - String
legacy_id - Int
box_number - String
line_items - ShippingPlanPackageLineItemConnection
Arguments
sort - String
before - String
after - String
first - Int
last - Int
Example
{
  "id": "xyz789",
  "legacy_id": 123,
  "box_number": "xyz789",
  "line_items": ShippingPlanPackageLineItemConnection
}
Types

ShippingPlanPackageConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [ShippingPlanPackageEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [ShippingPlanPackageEdge]
}
Types

ShippingPlanPackageEdge

Description

A Relay edge containing a ShippingPlanPackage and its cursor.

Fields
Field Name Description
node - ShippingPlanPackage The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": ShippingPlanPackage,
  "cursor": "xyz789"
}
Types

ShippingPlanPackageLineItem

Fields
Field Name Description
id - String
legacy_id - Int
sku - String
quantity - Int
created_at - ISODateTime
product - Product
Example
{
  "id": "xyz789",
  "legacy_id": 123,
  "sku": "abc123",
  "quantity": 123,
  "created_at": ISODateTime,
  "product": Product
}
Types

ShippingPlanPackageLineItemConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [ShippingPlanPackageLineItemEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [ShippingPlanPackageLineItemEdge]
}
Types

ShippingPlanPackageLineItemEdge

Description

A Relay edge containing a ShippingPlanPackageLineItem and its cursor.

Fields
Field Name Description
node - ShippingPlanPackageLineItem The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": ShippingPlanPackageLineItem,
  "cursor": "xyz789"
}
Types

ShippingPlanPallet

Fields
Field Name Description
id - String
legacy_id - Int
kind - String
quantity - Int
floor_loaded - Boolean
page_size - String
Example
{
  "id": "abc123",
  "legacy_id": 987,
  "kind": "xyz789",
  "quantity": 123,
  "floor_loaded": true,
  "page_size": "abc123"
}
Types

ShippingPlanPalletConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [ShippingPlanPalletEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [ShippingPlanPalletEdge]
}
Types

ShippingPlanPalletEdge

Description

A Relay edge containing a ShippingPlanPallet and its cursor.

Fields
Field Name Description
node - ShippingPlanPallet The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": ShippingPlanPallet,
  "cursor": "abc123"
}
Types

ShippingPlanQueryResult

Fields
Field Name Description
request_id - String
complexity - Int
data - ShippingPlan
Example
{
  "request_id": "abc123",
  "complexity": 987,
  "data": ShippingPlan
}
Types

ShippingPlanTrackingNumber

Fields
Field Name Description
id - String
legacy_id - Int
po_id - String
carrier_id - String
carrier_value - String
tracking_number - String
Example
{
  "id": "abc123",
  "legacy_id": 987,
  "po_id": "abc123",
  "carrier_id": "abc123",
  "carrier_value": "abc123",
  "tracking_number": "xyz789"
}
Types

ShippingPlanTrackingNumberConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [ShippingPlanTrackingNumberEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [ShippingPlanTrackingNumberEdge]
}
Types

ShippingPlanTrackingNumberEdge

Description

A Relay edge containing a ShippingPlanTrackingNumber and its cursor.

Fields
Field Name Description
node - ShippingPlanTrackingNumber The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": ShippingPlanTrackingNumber,
  "cursor": "abc123"
}
Types

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example
"abc123"
Types

SubmitBillInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
id - String!
Example
{
  "customer_account_id": "xyz789",
  "id": "xyz789"
}
Types

Tote

Fields
Field Name Description
id - String
legacy_id - Int
name - String
barcode - String
warehouse - Warehouse
orders - [Order]
picks - [TotePick]
Example
{
  "id": "xyz789",
  "legacy_id": 123,
  "name": "abc123",
  "barcode": "abc123",
  "warehouse": Warehouse,
  "orders": [Order],
  "picks": [TotePick]
}
Types

ToteContentQueryResult

Fields
Field Name Description
request_id - String
complexity - Int
data - Tote
Example
{
  "request_id": "xyz789",
  "complexity": 123,
  "data": Tote
}
Types

ToteHistory

Fields
Field Name Description
tote_name - String
tote_id - String
action - String
created_at - ISODateTime
Example
{
  "tote_name": "xyz789",
  "tote_id": "xyz789",
  "action": "abc123",
  "created_at": ISODateTime
}
Types

ToteHistoryConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [ToteHistoryEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [ToteHistoryEdge]
}
Types

ToteHistoryEdge

Description

A Relay edge containing a ToteHistory and its cursor.

Fields
Field Name Description
node - ToteHistory The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": ToteHistory,
  "cursor": "xyz789"
}
Types

ToteHistoryQueryResult

Fields
Field Name Description
request_id - String
complexity - Int
data - ToteHistoryConnection
Arguments
sort - String
before - String
after - String
first - Int
last - Int
Example
{
  "request_id": "xyz789",
  "complexity": 987,
  "data": ToteHistoryConnection
}
Types

TotePick

Fields
Field Name Description
id - String
legacy_id - Int
sku - String
created_at - ISODateTime
updated_at - ISODateTime
tote_id - String
current - Int
picked_quantity - Int
quantity - Int
inventory_bin - String
line_item - LineItem
location - Location
deducted - Boolean
Example
{
  "id": "xyz789",
  "legacy_id": 987,
  "sku": "xyz789",
  "created_at": ISODateTime,
  "updated_at": ISODateTime,
  "tote_id": "abc123",
  "current": 987,
  "picked_quantity": 123,
  "quantity": 987,
  "inventory_bin": "xyz789",
  "line_item": LineItem,
  "location": Location,
  "deducted": false
}
Types

TransferInventoryInput

Fields
Input Field Description
customer_account_id - String
sku - String!
warehouse_id - String!
quantity - Int!
location_from_id - String!
location_to_id - String!
reason - String
Example
{
  "customer_account_id": "abc123",
  "sku": "abc123",
  "warehouse_id": "abc123",
  "quantity": 987,
  "location_from_id": "xyz789",
  "location_to_id": "xyz789",
  "reason": "abc123"
}
Types

TransferInventoryOutput

Fields
Field Name Description
request_id - String
complexity - Int
ok - Boolean
Example
{
  "request_id": "xyz789",
  "complexity": 123,
  "ok": false
}
Types

URL

Example
"http://www.test.com/"
Types

UpdateBillInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
id - String!
status - String!

Bill status: draft, paid, finalize
Example
{
  "customer_account_id": "abc123",
  "id": "abc123",
  "status": "xyz789"
}
Types

UpdateInventoryInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
sku - String!
warehouse_id - String!
quantity - Int!
reason - String
location_id - String
Example
{
  "customer_account_id": "abc123",
  "sku": "xyz789",
  "warehouse_id": "abc123",
  "quantity": 123,
  "reason": "xyz789",
  "location_id": "abc123"
}
Types

UpdateInventoryOutput

Fields
Field Name Description
request_id - String
complexity - Int
warehouse_product - WarehouseProduct
Example
{
  "request_id": "abc123",
  "complexity": 123,
  "warehouse_product": WarehouseProduct
}
Types

UpdateLineItemInput

Fields
Input Field Description
id - String!
partner_line_item_id - String
quantity - Int
price - String
product_name - String
option_title - String
fulfillment_status - String
quantity_pending_fulfillment - Int
custom_options - GenericScalar
custom_barcode - String
eligible_for_return - Boolean
customs_value - String

A decimal value used for customs
warehouse_id - String

Set to lock to that warehouse. The item will not be moved in any multi-warhouse processing
barcode - String
Example
{
  "id": "xyz789",
  "partner_line_item_id": "xyz789",
  "quantity": 987,
  "price": "xyz789",
  "product_name": "abc123",
  "option_title": "abc123",
  "fulfillment_status": "abc123",
  "quantity_pending_fulfillment": 123,
  "custom_options": GenericScalar,
  "custom_barcode": "xyz789",
  "eligible_for_return": true,
  "customs_value": "xyz789",
  "warehouse_id": "xyz789",
  "barcode": "xyz789"
}
Types

UpdateLineItemsInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
order_id - String!

The id of the order you want to modify
line_items - [UpdateLineItemInput]
Example
{
  "customer_account_id": "xyz789",
  "order_id": "xyz789",
  "line_items": [UpdateLineItemInput]
}
Types

UpdateLocationInput

Fields
Input Field Description
location_id - String!

The id of the location you want to modify
zone - String
location_type_id - String
pickable - Boolean
sellable - Boolean
is_cart - Boolean
pick_priority - Int
dimensions - DimensionsInput
temperature - String
Example
{
  "location_id": "abc123",
  "zone": "abc123",
  "location_type_id": "xyz789",
  "pickable": true,
  "sellable": true,
  "is_cart": true,
  "pick_priority": 987,
  "dimensions": DimensionsInput,
  "temperature": "abc123"
}
Types

UpdateLotInput

Description

GraphQL input type for Lot update.

Fields
Input Field Description
lot_id - String!
name - String
sku - String
expires_at - ISODateTime
is_active - Boolean
Example
{
  "lot_id": "abc123",
  "name": "xyz789",
  "sku": "xyz789",
  "expires_at": ISODateTime,
  "is_active": false
}
Types

UpdateLotOutput

Description

GraphQL output type for Lot update.

Fields
Field Name Description
request_id - String
complexity - Int
lot - Lot
Example
{
  "request_id": "abc123",
  "complexity": 987,
  "lot": Lot
}
Types

UpdateLotsInput

Description

GraphQL input type for Lots update.

Fields
Input Field Description
lots_ids - [String]!
is_active - Boolean
Example
{"lots_ids": ["abc123"], "is_active": false}
Types

UpdateLotsOutput

Description

GraphQL output type for Lots update.

Fields
Field Name Description
request_id - String
complexity - Int
ok - Boolean
Example
{
  "request_id": "xyz789",
  "complexity": 123,
  "ok": true
}
Types

UpdateOrderFulfillmentStatusInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
order_id - String!

The id of the order you want to modify
fulfillment_status - String!
remove_inventory - Boolean

Whether or not to remove inventory if the order is being cancelled
reason - String
void_on_platform - Boolean

Whether or not to void the order on the sales platform if the order is being cancelled
Example
{
  "customer_account_id": "xyz789",
  "order_id": "xyz789",
  "fulfillment_status": "abc123",
  "remove_inventory": false,
  "reason": "abc123",
  "void_on_platform": true
}
Types

UpdateOrderHoldsInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
order_id - String!

The id of the order you want to modify
payment_hold - Boolean
operator_hold - Boolean
fraud_hold - Boolean
address_hold - Boolean
client_hold - Boolean
Example
{
  "customer_account_id": "xyz789",
  "order_id": "xyz789",
  "payment_hold": false,
  "operator_hold": false,
  "fraud_hold": true,
  "address_hold": true,
  "client_hold": false
}
Types

UpdateOrderInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
order_id - String!

The id of the order you want to modify
order_number - String
partner_order_id - String
fulfillment_status - String
order_date - ISODateTime
total_tax - String
subtotal - String
total_discounts - String
total_price - String
box_name - String
ready_to_ship - Boolean
insurance_amount - Decimal
required_ship_date - ISODateTime
allocation_priority - Int
shipping_lines - CreateShippingLinesInput
shipping_address - CreateOrderAddressInput
billing_address - CreateOrderAddressInput
profile - String
packing_note - String
note_attributes - [OrderNoteAttributeInput]
tags - [String]
gift_note - String
gift_invoice - Boolean
require_signature - Boolean
adult_signature_required - Boolean
alcohol - Boolean
insurance - Boolean
allow_partial - Boolean
allow_split - Boolean
priority_flag - Boolean
hold_until_date - ISODateTime
incoterms - String
tax_id - String
tax_type - String
history_entry - UserNoteInput
ignore_address_validation_errors - Boolean

US addresses are be validated and when errors occur the order will have an address hold created. If this flag is set then the error validation is skipped and no address hold is created
skip_address_validation - Boolean

Not address validation will be performed
custom_invoice_url - String
auto_print_return_label - Boolean
dry_ice_weight_in_lbs - String
ftr_exemption - Decimal
address_is_business - Boolean
Example
{
  "customer_account_id": "xyz789",
  "order_id": "xyz789",
  "order_number": "abc123",
  "partner_order_id": "abc123",
  "fulfillment_status": "abc123",
  "order_date": ISODateTime,
  "total_tax": "xyz789",
  "subtotal": "abc123",
  "total_discounts": "abc123",
  "total_price": "abc123",
  "box_name": "abc123",
  "ready_to_ship": false,
  "insurance_amount": Decimal,
  "required_ship_date": ISODateTime,
  "allocation_priority": 987,
  "shipping_lines": CreateShippingLinesInput,
  "shipping_address": CreateOrderAddressInput,
  "billing_address": CreateOrderAddressInput,
  "profile": "xyz789",
  "packing_note": "abc123",
  "note_attributes": [OrderNoteAttributeInput],
  "tags": ["xyz789"],
  "gift_note": "xyz789",
  "gift_invoice": false,
  "require_signature": false,
  "adult_signature_required": true,
  "alcohol": true,
  "insurance": false,
  "allow_partial": true,
  "allow_split": true,
  "priority_flag": true,
  "hold_until_date": ISODateTime,
  "incoterms": "xyz789",
  "tax_id": "xyz789",
  "tax_type": "abc123",
  "history_entry": UserNoteInput,
  "ignore_address_validation_errors": false,
  "skip_address_validation": true,
  "custom_invoice_url": "abc123",
  "auto_print_return_label": true,
  "dry_ice_weight_in_lbs": "xyz789",
  "ftr_exemption": Decimal,
  "address_is_business": false
}
Types

UpdateOrderInputBase

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
order_id - String!

The id of the order you want to modify
Example
{
  "customer_account_id": "xyz789",
  "order_id": "abc123"
}
Types

UpdateProductCaseInput

Fields
Input Field Description
case_barcode - String!
case_quantity - Int!
Example
{
  "case_barcode": "xyz789",
  "case_quantity": 987
}
Types

UpdateProductImageInput

Fields
Input Field Description
src - String!
position - Int
Example
{"src": "xyz789", "position": 987}
Types

UpdateProductInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
sku - String!
name - String
dimensions - DimensionsInput
tariff_code - String
product_note - String
country_of_manufacture - String
needs_serial_number - Boolean
dropship - Boolean
barcode - String
customs_description - String
ignore_on_customs - Boolean
ignore_on_invoice - Boolean
tags - [String]

Fully replaces existen tags with the ones provided
vendors - [UpdateProductVendorInput]
final_sale - Boolean
virtual - Boolean
needs_lot_tracking - Boolean
images - [UpdateProductImageInput]
packer_note - String
cases - [UpdateProductCaseInput]
Example
{
  "customer_account_id": "xyz789",
  "sku": "xyz789",
  "name": "xyz789",
  "dimensions": DimensionsInput,
  "tariff_code": "xyz789",
  "product_note": "abc123",
  "country_of_manufacture": "xyz789",
  "needs_serial_number": false,
  "dropship": true,
  "barcode": "xyz789",
  "customs_description": "xyz789",
  "ignore_on_customs": false,
  "ignore_on_invoice": false,
  "tags": ["xyz789"],
  "vendors": [UpdateProductVendorInput],
  "final_sale": false,
  "virtual": false,
  "needs_lot_tracking": true,
  "images": [UpdateProductImageInput],
  "packer_note": "xyz789",
  "cases": [UpdateProductCaseInput]
}
Types

UpdateProductVendorInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
vendor_id - String!
vendor_sku - String
price - String
Example
{
  "customer_account_id": "xyz789",
  "vendor_id": "xyz789",
  "vendor_sku": "xyz789",
  "price": "abc123"
}
Types

UpdatePurchaseOrderInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
po_id - String!
packing_note - String
po_note - String
description - String
partner_order_number - String
discount - String
tax - String
line_items - [UpdatePurchaseOrderLineItemInput]
shipping_method - String
shipping_carrier - String
shipping_name - String
shipping_price - String
tracking_number - String
pdf - String
payment_method - String
payment_due_by - String
payment_note - String
po_date - ISODateTime
clear_po_date - Boolean
Example
{
  "customer_account_id": "xyz789",
  "po_id": "abc123",
  "packing_note": "abc123",
  "po_note": "xyz789",
  "description": "abc123",
  "partner_order_number": "abc123",
  "discount": "xyz789",
  "tax": "xyz789",
  "line_items": [UpdatePurchaseOrderLineItemInput],
  "shipping_method": "abc123",
  "shipping_carrier": "abc123",
  "shipping_name": "abc123",
  "shipping_price": "xyz789",
  "tracking_number": "xyz789",
  "pdf": "xyz789",
  "payment_method": "abc123",
  "payment_due_by": "abc123",
  "payment_note": "abc123",
  "po_date": ISODateTime,
  "clear_po_date": false
}
Types

UpdatePurchaseOrderLineItemInput

Fields
Input Field Description
sku - String!
quantity - Int
quantity_received - Int
quantity_rejected - Int
sell_ahead - Int
price - String
note - String
Example
{
  "sku": "abc123",
  "quantity": 123,
  "quantity_received": 123,
  "quantity_rejected": 123,
  "sell_ahead": 987,
  "price": "xyz789",
  "note": "abc123"
}
Types

UpdatePurchaseOrderOutput

Fields
Field Name Description
request_id - String
complexity - Int
purchase_order - PurchaseOrder
Example
{
  "request_id": "xyz789",
  "complexity": 987,
  "purchase_order": PurchaseOrder
}
Types

UpdateReturnStatusInput

Fields
Input Field Description
return_id - String!
status - String!
Example
{
  "return_id": "abc123",
  "status": "abc123"
}
Types

UpdateReturnStatusOutput

Fields
Field Name Description
request_id - String
complexity - Int
return - Return
Example
{
  "request_id": "abc123",
  "complexity": 987,
  "return": Return
}
Types

UpdateTagsInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
order_id - String!

The id of the order you want to modify
tags - [String]
Example
{
  "customer_account_id": "xyz789",
  "order_id": "xyz789",
  "tags": ["abc123"]
}
Types

UpdateWarehouseProductInput

Fields
Input Field Description
customer_account_id - String

Use this when you are a 3PL acting on behalf of one of your customers
sku - String!
warehouse_id - String!
on_hand - Int
price - String
value - String
value_currency - String
inventory_bin - String
inventory_overstock_bin - String
reserve_inventory - Int
replenishment_level - Int
reorder_amount - Int
reorder_level - Int
customs_value - String
active - Boolean
replenishment_max_level - Int
replenishment_increment - Int
Example
{
  "customer_account_id": "xyz789",
  "sku": "xyz789",
  "warehouse_id": "xyz789",
  "on_hand": 987,
  "price": "abc123",
  "value": "abc123",
  "value_currency": "xyz789",
  "inventory_bin": "abc123",
  "inventory_overstock_bin": "xyz789",
  "reserve_inventory": 987,
  "replenishment_level": 987,
  "reorder_amount": 123,
  "reorder_level": 123,
  "customs_value": "xyz789",
  "active": true,
  "replenishment_max_level": 123,
  "replenishment_increment": 123
}
Types

User

Fields
Field Name Description
id - String
legacy_id - Int
email - String
first_name - String
last_name - String
account - Account
Example
{
  "id": "abc123",
  "legacy_id": 123,
  "email": "abc123",
  "first_name": "xyz789",
  "last_name": "xyz789",
  "account": Account
}
Types

UserNoteInput

Fields
Input Field Description
source - String
message - String
Example
{
  "source": "xyz789",
  "message": "xyz789"
}
Types

UserQuota

Fields
Field Name Description
is_expired - Boolean There's no time window anymore, this will be always False
expiration_date - ISODateTime There's no time window anymore, this will be always empty
time_remaining - String There's no time window anymore, this will be always empty
credits_remaining - Int
max_available - Int
increment_rate - Int
Example
{
  "is_expired": false,
  "expiration_date": ISODateTime,
  "time_remaining": "abc123",
  "credits_remaining": 123,
  "max_available": 987,
  "increment_rate": 987
}
Types

Vendor

Fields
Field Name Description
id - String
legacy_id - Int
name - String
email - String
account_number - String
account_id - String
address - Address
currency - String
internal_note - String
default_po_note - String
logo - String
partner_vendor_id - Int
created_at - ISODateTime
Example
{
  "id": "xyz789",
  "legacy_id": 987,
  "name": "xyz789",
  "email": "abc123",
  "account_number": "xyz789",
  "account_id": "abc123",
  "address": Address,
  "currency": "xyz789",
  "internal_note": "abc123",
  "default_po_note": "abc123",
  "logo": "abc123",
  "partner_vendor_id": 987,
  "created_at": ISODateTime
}
Types

VendorConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [VendorEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [VendorEdge]
}
Types

VendorEdge

Description

A Relay edge containing a Vendor and its cursor.

Fields
Field Name Description
node - Vendor The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": Vendor,
  "cursor": "abc123"
}
Types

VendorsQueryResult

Fields
Field Name Description
request_id - String
complexity - Int
data - VendorConnection
Arguments
sort - String
before - String
after - String
first - Int
last - Int
Example
{
  "request_id": "abc123",
  "complexity": 987,
  "data": VendorConnection
}
Types

Warehouse

Fields
Field Name Description
id - String
legacy_id - Int
account_id - String
identifier - String Name of the warehouse
dynamic_slotting - Boolean
invoice_email - String
phone_number - String
profile - String
address - Address
return_address - Address
company_name - String
company_alias - String
products - ProductConnection
Arguments
sort - String
before - String
after - String
first - Int
last - Int
Example
{
  "id": "xyz789",
  "legacy_id": 987,
  "account_id": "abc123",
  "identifier": "xyz789",
  "dynamic_slotting": true,
  "invoice_email": "xyz789",
  "phone_number": "abc123",
  "profile": "xyz789",
  "address": Address,
  "return_address": Address,
  "company_name": "abc123",
  "company_alias": "abc123",
  "products": ProductConnection
}
Types

WarehouseProduct

Fields
Field Name Description
id - String
legacy_id - Int
account_id - String
sku - String Stock Keeping Unit
warehouse_id - String
warehouse_identifier - String The warehouse identifier, usually Primary/Secondary
price - String Price of the product
value - String Price paid for the product
value_currency - String
on_hand - Int The total count of a SKU physically in the warehouse. (Note, Available is the count indicated in your sales channels)
inventory_bin - String The name of the bin where the product is stored
inventory_overstock_bin - String The name of the bin where overstock is stored
reserve_inventory - Int Count of a SKU that is not to be sold in your sales channel.For example, if you’re running a flash sale and want to hold some stock for returns or exchanges, you would enter your full inventory of say 100 units as the On Hand and a Reserve of 5 units. We’ll then tell the platform that you have 95 available for sale (On Hand minus Reserve). The Available count will remain 100
replenishment_level - Int Available only for accounts that use Dynamic Slotting and used specifically for replenishment reports. SKUs will appear on the replenishment report if inventory allocated and not enough in pickable bins, or if the pickable bin inventory is less than the replenishment level
reorder_amount - Int The number that should be reordered when a SKU reaches the Reorder Level
reorder_level - Int The Available value a SKU must reach to trigger a Reorder. (See Reorder Amount). Setting this to 0 will prevent a SKU from automatically being added to a PO
backorder - Int Count of how many units you owe to customers for open orders and don’t have stock for in the warehouse
allocated - Int Count of how many units you have in stock and owe to customers for open orders
available - Int The number of available stock for any given SKU that is pushed to any connected sales channel. This is On Hand minus any allocations to open orders.
non_sellable_quantity - Int Count of non sellable units of a SKU in the warehouse.
in_tote - Int Total number of units picked in totes
custom - Boolean
customs_value - String
created_at - ISODateTime
updated_at - ISODateTime
sell_ahead - Int
active - Boolean
warehouse - Warehouse
product - Product
inbounds - WarehouseProductInboundConnection
Arguments
status - String
created_from - ISODateTime
created_to - ISODateTime
sort - String
before - String
after - String
first - Int
last - Int
locations - ItemLocationConnection
Arguments
customer_account_id - String
sort - String
before - String
after - String
first - Int
last - Int
Example
{
  "id": "abc123",
  "legacy_id": 987,
  "account_id": "xyz789",
  "sku": "abc123",
  "warehouse_id": "xyz789",
  "warehouse_identifier": "abc123",
  "price": "abc123",
  "value": "xyz789",
  "value_currency": "xyz789",
  "on_hand": 123,
  "inventory_bin": "abc123",
  "inventory_overstock_bin": "abc123",
  "reserve_inventory": 123,
  "replenishment_level": 123,
  "reorder_amount": 123,
  "reorder_level": 123,
  "backorder": 987,
  "allocated": 987,
  "available": 987,
  "non_sellable_quantity": 987,
  "in_tote": 123,
  "custom": true,
  "customs_value": "abc123",
  "created_at": ISODateTime,
  "updated_at": ISODateTime,
  "sell_ahead": 987,
  "active": true,
  "warehouse": Warehouse,
  "product": Product,
  "inbounds": WarehouseProductInboundConnection,
  "locations": ItemLocationConnection
}
Types

WarehouseProductConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [WarehouseProductEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [WarehouseProductEdge]
}
Types

WarehouseProductEdge

Description

A Relay edge containing a WarehouseProduct and its cursor.

Fields
Field Name Description
node - WarehouseProduct The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": WarehouseProduct,
  "cursor": "xyz789"
}
Types

WarehouseProductInbound

Fields
Field Name Description
id - String
legacy_id - Int
sku - String
warehouse_id - String
po_id - String
purchase_order_line_item_id - String
po_date - ISODateTime
quantity - Int
quantity_received - Int
quantity_rejected - Int
sell_ahead - Int
status - String
Example
{
  "id": "xyz789",
  "legacy_id": 987,
  "sku": "abc123",
  "warehouse_id": "abc123",
  "po_id": "xyz789",
  "purchase_order_line_item_id": "xyz789",
  "po_date": ISODateTime,
  "quantity": 987,
  "quantity_received": 987,
  "quantity_rejected": 123,
  "sell_ahead": 987,
  "status": "xyz789"
}
Types

WarehouseProductInboundConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [WarehouseProductInboundEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [WarehouseProductInboundEdge]
}
Types

WarehouseProductInboundEdge

Description

A Relay edge containing a WarehouseProductInbound and its cursor.

Fields
Field Name Description
node - WarehouseProductInbound The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": WarehouseProductInbound,
  "cursor": "abc123"
}
Types

WarehouseProductMutationOutput

Fields
Field Name Description
request_id - String
complexity - Int
warehouse_product - WarehouseProduct
Example
{
  "request_id": "abc123",
  "complexity": 987,
  "warehouse_product": WarehouseProduct
}
Types

WarehouseProductsQueryResult

Fields
Field Name Description
request_id - String
complexity - Int
data - WarehouseProductConnection
Arguments
sort - String
before - String
after - String
first - Int
last - Int
Example
{
  "request_id": "xyz789",
  "complexity": 987,
  "data": WarehouseProductConnection
}
Types

Webhook

Fields
Field Name Description
id - String
legacy_id - Int
account_id - String
shop_name - String
name - String
url - String
source - String
shared_signature_secret - String This will only be returned once when the webhook is created.
Example
{
  "id": "abc123",
  "legacy_id": 987,
  "account_id": "xyz789",
  "shop_name": "xyz789",
  "name": "abc123",
  "url": "xyz789",
  "source": "xyz789",
  "shared_signature_secret": "xyz789"
}
Types

WebhookConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [WebhookEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [WebhookEdge]
}
Types

WebhookEdge

Description

A Relay edge containing a Webhook and its cursor.

Fields
Field Name Description
node - Webhook The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": Webhook,
  "cursor": "xyz789"
}
Types

WebhooksQueryResult

Fields
Field Name Description
request_id - String
complexity - Int
data - WebhookConnection
Arguments
sort - String
before - String
after - String
first - Int
last - Int
Example
{
  "request_id": "abc123",
  "complexity": 123,
  "data": WebhookConnection
}
Documentation by Anvil SpectaQL