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": true}
Response
{
  "data": {
    "account": {
      "request_id": "xyz789",
      "complexity": 123,
      "data": Account
    }
  }
}

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": "abc123", "analyze": false}
Response
{
  "data": {
    "bill": {
      "request_id": "xyz789",
      "complexity": 987,
      "data": Bill
    }
  }
}

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": "abc123",
  "analyze": false
}
Response
{
  "data": {
    "bills": {
      "request_id": "abc123",
      "complexity": 987,
      "data": BillConnection
    }
  }
}

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": "abc123",
  "po_id": "xyz789",
  "analyze": true
}
Response
{
  "data": {
    "expiration_lots": {
      "request_id": "xyz789",
      "complexity": 123,
      "data": LotConnection
    }
  }
}

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": "xyz789",
      "complexity": 987,
      "data": FulfillmentInvoice
    }
  }
}

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
    }
  }
}

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
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,
  $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,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...InventoryChangeConnectionFragment
    }
  }
}
Variables
{
  "sku": "xyz789",
  "warehouse_id": "xyz789",
  "location_id": "abc123",
  "location_name": "xyz789",
  "date_from": ISODateTime,
  "date_to": ISODateTime,
  "customer_account_id": "xyz789",
  "analyze": false
}
Response
{
  "data": {
    "inventory_changes": {
      "request_id": "xyz789",
      "complexity": 987,
      "data": InventoryChangeConnection
    }
  }
}

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": "xyz789",
      "complexity": 123,
      "snapshot": InventorySnapshot
    }
  }
}

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": "xyz789",
  "analyze": true
}
Response
{
  "data": {
    "inventory_snapshots": {
      "request_id": "xyz789",
      "complexity": 123,
      "snapshots": InventorySnapshotConnection
    }
  }
}

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": true
}
Response
{
  "data": {
    "inventory_sync_items_status": {
      "request_id": "abc123",
      "complexity": 987,
      "data": InventorySyncItemStatusConnection
    }
  }
}

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": "abc123", "analyze": true}
Response
{
  "data": {
    "inventory_sync_status": {
      "request_id": "xyz789",
      "complexity": 123,
      "data": InventorySyncStatus
    }
  }
}

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": "xyz789",
  "customer_account_id": "xyz789",
  "status": "abc123",
  "analyze": true
}
Response
{
  "data": {
    "inventory_sync_statuses": {
      "request_id": "xyz789",
      "complexity": 987,
      "data": InventorySyncStatusConnection
    }
  }
}

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": false
}
Response
{
  "data": {
    "location": {
      "request_id": "abc123",
      "complexity": 987,
      "data": Location
    }
  }
}

locations

Response

Returns a LocationsQueryResult

Arguments
Name Description
warehouse_id - String
analyze - Boolean

Example

Query
query locations(
  $warehouse_id: String,
  $analyze: Boolean
) {
  locations(
    warehouse_id: $warehouse_id,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...LocationConnectionFragment
    }
  }
}
Variables
{"warehouse_id": "xyz789", "analyze": true}
Response
{
  "data": {
    "locations": {
      "request_id": "abc123",
      "complexity": 987,
      "data": LocationConnection
    }
  }
}

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
    }
  }
}

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"}}}

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": "xyz789", "analyze": true}
Response
{
  "data": {
    "order": {
      "request_id": "xyz789",
      "complexity": 123,
      "data": Order
    }
  }
}

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": "xyz789",
  "user_id": "abc123",
  "order_number": "xyz789",
  "username": "xyz789",
  "date_from": "2007-12-03",
  "date_to": "2007-12-03",
  "analyze": false
}
Response
{
  "data": {
    "order_history": {
      "request_id": "abc123",
      "complexity": 987,
      "data": OrderHistoryConnection
    }
  }
}

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
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,
  $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,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...OrderConnectionFragment
    }
  }
}
Variables
{
  "shop_name": "xyz789",
  "partner_order_id": "xyz789",
  "order_number": "abc123",
  "warehouse_id": "abc123",
  "allocated_warehouse_id": "xyz789",
  "fulfillment_status": "abc123",
  "sku": "xyz789",
  "email": "xyz789",
  "updated_from": ISODateTime,
  "updated_to": ISODateTime,
  "order_date_from": ISODateTime,
  "order_date_to": ISODateTime,
  "customer_account_id": "abc123",
  "analyze": true
}
Response
{
  "data": {
    "orders": {
      "request_id": "abc123",
      "complexity": 987,
      "data": OrderConnection
    }
  }
}

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": 987,
      "data": PackageConnection
    }
  }
}

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": "xyz789",
  "date_from": ISODateTime,
  "date_to": ISODateTime,
  "analyze": true
}
Response
{
  "data": {
    "picks_per_day": {
      "request_id": "xyz789",
      "complexity": 123,
      "data": PickConnection
    }
  }
}

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": "xyz789",
  "analyze": false
}
Response
{
  "data": {
    "product": {
      "request_id": "abc123",
      "complexity": 123,
      "data": Product
    }
  }
}

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": "xyz789",
  "created_from": ISODateTime,
  "created_to": ISODateTime,
  "updated_from": ISODateTime,
  "updated_to": ISODateTime,
  "customer_account_id": "xyz789",
  "has_kits": false,
  "analyze": false
}
Response
{
  "data": {
    "products": {
      "request_id": "xyz789",
      "complexity": 987,
      "data": ProductConnection
    }
  }
}

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": "xyz789",
  "po_number": "xyz789",
  "analyze": true
}
Response
{
  "data": {
    "purchase_order": {
      "request_id": "abc123",
      "complexity": 987,
      "data": PurchaseOrder
    }
  }
}

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
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,
  $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,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...PurchaseOrderConnectionFragment
    }
  }
}
Variables
{
  "sku": "abc123",
  "warehouse_id": "xyz789",
  "created_from": ISODateTime,
  "created_to": ISODateTime,
  "po_date_from": ISODateTime,
  "po_date_to": ISODateTime,
  "customer_account_id": "abc123",
  "analyze": false
}
Response
{
  "data": {
    "purchase_orders": {
      "request_id": "xyz789",
      "complexity": 987,
      "data": PurchaseOrderConnection
    }
  }
}

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
    }
  }
}

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": "abc123", "analyze": true}
Response
{
  "data": {
    "return_exchange": {
      "request_id": "abc123",
      "complexity": 987,
      "data": ReturnExchange
    }
  }
}

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": "abc123",
  "warehouse_id": "xyz789",
  "date_from": ISODateTime,
  "date_to": ISODateTime,
  "customer_account_id": "xyz789",
  "analyze": false
}
Response
{
  "data": {
    "returns": {
      "request_id": "xyz789",
      "complexity": 123,
      "data": ReturnConnection
    }
  }
}

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": "abc123", "analyze": false}
Response
{
  "data": {
    "shipment": {
      "request_id": "abc123",
      "complexity": 123,
      "data": Shipment
    }
  }
}

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
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,
  $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,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...ShipmentConnectionFragment
    }
  }
}
Variables
{
  "order_id": "abc123",
  "date_from": ISODateTime,
  "date_to": ISODateTime,
  "order_date_from": ISODateTime,
  "order_date_to": ISODateTime,
  "tracking_number": "abc123",
  "analyze": false
}
Response
{
  "data": {
    "shipments": {
      "request_id": "xyz789",
      "complexity": 987,
      "data": ShipmentConnection
    }
  }
}

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": "abc123", "analyze": true}
Response
{
  "data": {
    "shipping_plan": {
      "request_id": "xyz789",
      "complexity": 987,
      "data": ShippingPlan
    }
  }
}

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": "abc123",
  "tote_id": "xyz789",
  "date_from": ISODateTime,
  "date_to": ISODateTime,
  "analyze": true
}
Response
{
  "data": {
    "tote_history": {
      "request_id": "xyz789",
      "complexity": 123,
      "data": ToteHistoryConnection
    }
  }
}

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": false,
      "expiration_date": ISODateTime,
      "time_remaining": "abc123",
      "credits_remaining": 987,
      "max_available": 987,
      "increment_rate": 987
    }
  }
}

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": true}
Response
{
  "data": {
    "uuid": {
      "request_id": "abc123",
      "complexity": 123,
      "data": LegacyId
    }
  }
}

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": 987,
      "data": VendorConnection
    }
  }
}

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": false,
  "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": 987,
      "data": WarehouseProductConnection
    }
  }
}

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": "xyz789",
  "analyze": false
}
Response
{
  "data": {
    "webhooks": {
      "request_id": "abc123",
      "complexity": 123,
      "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
    }
  }
}

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
    }
  }
}

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
    }
  }
}

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": "xyz789",
      "complexity": 123
    }
  }
}

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": 123
    }
  }
}

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": "xyz789",
      "complexity": 123,
      "snapshot": InventorySnapshot
    }
  }
}

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
    }
  }
}

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
    }
  }
}

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": "abc123",
      "complexity": 123,
      "warehouse_product": WarehouseProduct
    }
  }
}

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": "abc123",
      "complexity": 987,
      "warehouse_product": WarehouseProduct
    }
  }
}

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": "abc123",
      "complexity": 123,
      "warehouse_product": WarehouseProduct
    }
  }
}

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": "abc123"
    }
  }
}

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": "abc123",
      "complexity": 987,
      "sync": InventorySyncStatus
    }
  }
}

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": "xyz789",
      "complexity": 123,
      "product": Product
    }
  }
}

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
    }
  }
}

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": 123,
      "product": Product
    }
  }
}

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
    }
  }
}

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
    }
  }
}

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": "xyz789",
      "complexity": 987,
      "warehouse_product": WarehouseProduct
    }
  }
}

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
    }
  }
}

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": "xyz789",
      "complexity": 987,
      "lot": Lot
    }
  }
}

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
    }
  }
}

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": 123,
      "ok": false
    }
  }
}

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}}}

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": "xyz789",
      "complexity": 987,
      "order": Order
    }
  }
}

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": "abc123",
      "complexity": 987,
      "order": Order
    }
  }
}

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": "abc123",
      "complexity": 123,
      "order": Order
    }
  }
}

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": 987,
      "order": Order
    }
  }
}

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": 123,
      "order": Order
    }
  }
}

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": 987,
      "order": Order
    }
  }
}

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": "xyz789",
      "complexity": 123,
      "order": Order
    }
  }
}

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": "abc123",
      "complexity": 123,
      "order": Order
    }
  }
}

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": "xyz789",
      "complexity": 123,
      "order": Order
    }
  }
}

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": "abc123",
      "complexity": 987,
      "order": Order
    }
  }
}

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": "abc123",
      "complexity": 123,
      "order": Order
    }
  }
}

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": 987,
      "order": Order
    }
  }
}

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": "xyz789",
      "complexity": 123,
      "order": Order
    }
  }
}

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": "abc123",
      "complexity": 987,
      "warehouse_product": WarehouseProduct
    }
  }
}

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": 123,
      "product": Product
    }
  }
}

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
    }
  }
}

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
    }
  }
}

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
    }
  }
}

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": 123,
      "purchase_order": PurchaseOrder
    }
  }
}

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": "abc123",
      "complexity": 123,
      "purchase_order": PurchaseOrder
    }
  }
}

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": "abc123",
      "complexity": 987,
      "purchase_order": PurchaseOrder
    }
  }
}

purchase_order_set_fulfillment_status

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": "xyz789",
      "complexity": 123,
      "purchase_order": PurchaseOrder
    }
  }
}

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": "abc123",
      "complexity": 987,
      "purchase_order": PurchaseOrder
    }
  }
}

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": "abc123",
      "complexity": 123,
      "return": Return
    }
  }
}

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": 123,
      "return_exchange": ReturnExchange
    }
  }
}

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": "xyz789",
      "complexity": 123,
      "return": Return
    }
  }
}

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": "abc123",
      "complexity": 987,
      "shipment": Shipment
    }
  }
}

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
    }
  }
}

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": 987,
      "shipping_plan": ShippingPlan
    }
  }
}

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
    }
  }
}

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": "xyz789",
      "complexity": 123,
      "vendor": Vendor
    }
  }
}

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
    }
  }
}

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": "abc123",
      "complexity": 123
    }
  }
}

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": "xyz789",
      "complexity": 123
    }
  }
}

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": "xyz789",
      "complexity": 987,
      "warehouse_product": WarehouseProduct
    }
  }
}

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": "abc123",
      "complexity": 987,
      "webhook": Webhook
    }
  }
}

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": "xyz789",
      "complexity": 987
    }
  }
}

Types

AbortInventorySyncInput

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

AbortInventorySyncOutput

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

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": "abc123",
  "legacy_id": 123,
  "email": "xyz789",
  "username": "xyz789",
  "status": "xyz789",
  "dynamic_slotting": true,
  "is_multi_warehouse": false,
  "is_3pl": true,
  "cycle_count_enabled": true,
  "ship_backorders": false,
  "customers": AccountConnection,
  "warehouses": [Warehouse]
}

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]
}

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": "abc123"
}

AccountQueryResult

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

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": "abc123",
  "order_id": "xyz789",
  "history_entry": UserNoteInput
}

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": "xyz789",
  "order_id": "abc123",
  "line_items": [CreateLineItemInput]
}

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": "xyz789",
  "vendor_id": "abc123",
  "sku": "abc123",
  "manufacturer_sku": "abc123",
  "price": "xyz789"
}

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
Example
{
  "customer_account_id": "abc123",
  "sku": "xyz789",
  "warehouse_id": "abc123",
  "on_hand": 123,
  "inventory_bin": "xyz789",
  "inventory_overstock_bin": "xyz789",
  "reserve_inventory": 123,
  "replenishment_level": 987,
  "reorder_level": 123,
  "reorder_amount": 123,
  "price": "abc123"
}

AddPurchaseOrderAttachmentInput

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

AddPurchaseOrderAttachmentOutput

Fields
Field Name Description
request_id - String
complexity - Int
attachment - PurchaseOrderAttachment
Example
{
  "request_id": "abc123",
  "complexity": 123,
  "attachment": PurchaseOrderAttachment
}

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": "xyz789",
  "address1": "xyz789",
  "address2": "abc123",
  "city": "xyz789",
  "state": "xyz789",
  "country": "xyz789",
  "zip": "abc123",
  "phone": "xyz789"
}

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": "abc123",
  "city": "abc123",
  "state": "abc123",
  "country": "xyz789",
  "zip": "xyz789",
  "phone": "xyz789"
}

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": "xyz789",
  "location_id": "xyz789"
}

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": "xyz789",
  "complexity": 123,
  "warehouse_product": WarehouseProduct
}

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": "xyz789",
  "card_type": "xyz789",
  "date": ISODateTime
}

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": "xyz789",
  "legacy_id": 987,
  "status": "xyz789",
  "customer_name": "xyz789",
  "profile_name": "xyz789",
  "created_at": ISODateTime,
  "due_date": ISODateTime,
  "amount": Money,
  "totals": FeeCategoryTotalConnection,
  "bill_exports": BillExportsConnection,
  "billing_period": BillingPeriod,
  "billing_frequency": "xyz789"
}

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]
}

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": "abc123"
}

BillExports

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

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]
}

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"
}

BillQueryResult

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

BillingPeriod

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

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": "xyz789",
  "complexity": 123,
  "data": BillConnection
}

Boolean

Description

The Boolean scalar type represents true or false.

Example
true

BuildKitComponentInput

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

BuildKitInput

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

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": "abc123",
  "void_on_platform": false,
  "force": true
}

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": "abc123",
  "po_id": "abc123"
}

CancelPurchaseOrderOutput

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

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": "xyz789"
}

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": "xyz789"
}

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": "xyz789",
  "po_id": "xyz789"
}

ClosePurchaseOrderOutput

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

CreateBillInput

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

CreateBillOutput

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

CreateExchangeItem

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

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": "xyz789"
}

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": 123,
  "price": "xyz789",
  "product_name": "abc123",
  "option_title": "abc123",
  "fulfillment_status": "abc123",
  "quantity_pending_fulfillment": 123,
  "custom_options": GenericScalar,
  "custom_barcode": "abc123",
  "eligible_for_return": false,
  "customs_value": "abc123",
  "barcode": "abc123",
  "warehouse_id": "abc123"
}

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": "xyz789",
  "name": "abc123",
  "zone": "abc123",
  "location_type_id": "abc123",
  "pickable": false,
  "sellable": false,
  "is_cart": true,
  "pick_priority": 123,
  "dimensions": DimensionsInput,
  "temperature": "xyz789"
}

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": "xyz789",
  "name": "xyz789",
  "sku": "abc123",
  "expires_at": ISODateTime,
  "is_active": false
}

CreateLotOutput

Description

GraphQL output type for Lot creation.

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

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": "xyz789",
  "last_name": "abc123",
  "company": "xyz789",
  "address1": "xyz789",
  "address2": "abc123",
  "city": "abc123",
  "state": "xyz789",
  "state_code": "xyz789",
  "zip": "abc123",
  "country": "abc123",
  "country_code": "abc123",
  "email": "abc123",
  "phone": "xyz789"
}

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
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": "xyz789",
  "partner_order_id": "xyz789",
  "shop_name": "abc123",
  "fulfillment_status": "xyz789",
  "order_date": ISODateTime,
  "total_tax": "xyz789",
  "subtotal": "abc123",
  "total_discounts": "abc123",
  "total_price": "xyz789",
  "box_name": "xyz789",
  "currency": "xyz789",
  "ready_to_ship": false,
  "shipping_lines": CreateShippingLinesInput,
  "shipping_address": CreateOrderAddressInput,
  "billing_address": CreateOrderAddressInput,
  "from_name": "xyz789",
  "note_attributes": [OrderNoteAttributeInput],
  "tags": ["abc123"],
  "line_items": [CreateLineItemInput],
  "gift_note": "xyz789",
  "gift_invoice": false,
  "require_signature": true,
  "adult_signature_required": true,
  "alcohol": true,
  "insurance": true,
  "allow_partial": true,
  "allow_split": true,
  "custom_invoice_url": "abc123",
  "email": "xyz789",
  "profile": "xyz789",
  "packing_note": "abc123",
  "required_ship_date": ISODateTime,
  "auto_print_return_label": true,
  "hold_until_date": ISODateTime,
  "incoterms": "xyz789",
  "tax_id": "xyz789",
  "tax_type": "abc123",
  "flagged": true,
  "saturday_delivery": false,
  "ignore_address_validation_errors": true,
  "skip_address_validation": true,
  "priority_flag": false,
  "allocation_priority": 987,
  "holds": HoldsInput,
  "dry_ice_weight_in_lbs": "xyz789",
  "ftr_exemption": Decimal,
  "address_is_business": true
}

CreateProductImageInput

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

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 priceis defined on them.

value - String

Will be used as the default value for each warehouse product, if no valueis defined on them.

warehouse_products - [CreateWarehouseProductInput]!
barcode - String
country_of_manufacture - String
dimensions - DimensionsInput
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
virtual - Boolean
needs_lot_tracking - Boolean
images - [CreateProductImageInput]
tags - [String]
vendors - [CreateProductVendorInput]
packer_note - String
Example
{
  "customer_account_id": "xyz789",
  "name": "xyz789",
  "sku": "abc123",
  "price": "xyz789",
  "value": "xyz789",
  "warehouse_products": [CreateWarehouseProductInput],
  "barcode": "xyz789",
  "country_of_manufacture": "xyz789",
  "dimensions": DimensionsInput,
  "tariff_code": "abc123",
  "kit": false,
  "kit_build": true,
  "no_air": true,
  "final_sale": true,
  "customs_value": "abc123",
  "customs_description": "xyz789",
  "not_owned": false,
  "dropship": false,
  "needs_serial_number": false,
  "virtual": true,
  "needs_lot_tracking": true,
  "images": [CreateProductImageInput],
  "tags": ["xyz789"],
  "vendors": [CreateProductVendorInput],
  "packer_note": "xyz789"
}

CreateProductOutput

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

CreateProductVendorInput

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

CreatePurchaseOrderAttachmentInput

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

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": "xyz789",
  "po_number": "abc123",
  "subtotal": "abc123",
  "shipping_price": "abc123",
  "total_price": "abc123",
  "warehouse_id": "xyz789",
  "line_items": [CreatePurchaseOrderLineItemInput],
  "po_date": ISODateTime,
  "po_note": "abc123",
  "fulfillment_status": "abc123",
  "discount": "xyz789",
  "vendor_id": "xyz789",
  "warehouse": "xyz789",
  "packing_note": "abc123",
  "description": "abc123",
  "partner_order_number": "abc123",
  "tax": "abc123",
  "tracking_number": "abc123",
  "attachments": [CreatePurchaseOrderAttachmentInput],
  "origin_of_shipment": "abc123"
}

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": "abc123",
  "price": "xyz789",
  "vendor_id": "xyz789",
  "vendor_sku": "xyz789",
  "variant_id": 123,
  "quantity_received": 123,
  "quantity_rejected": 123,
  "product_name": "abc123",
  "option_title": "xyz789",
  "fulfillment_status": "abc123",
  "sell_ahead": 987,
  "note": "abc123",
  "partner_line_item_id": "xyz789"
}

CreatePurchaseOrderOutput

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

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": "abc123",
  "return_id": "abc123",
  "exchange_items": [CreateExchangeItem]
}

CreateReturnExchangeOutput

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

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

Example
{
  "customer_account_id": "abc123",
  "order_id": "xyz789",
  "warehouse_id": "xyz789",
  "return_reason": "xyz789",
  "label_type": "FREE",
  "label_cost": "abc123",
  "address": AddressInput,
  "dimensions": DimensionsInput,
  "shipping_carrier": "abc123",
  "shipping_method": "abc123",
  "line_items": [CreateReturnLineItemInput],
  "tracking_number": "xyz789",
  "create_label": false,
  "partner_id": "xyz789",
  "display_issue_refund": true
}

CreateReturnItemExchangeInput

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

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": 987,
  "return_reason": "abc123",
  "condition": "abc123",
  "is_component": false,
  "exchange_items": [CreateReturnItemExchangeInput]
}

CreateReturnOutput

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

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": "abc123",
  "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": "xyz789"
}

CreateShipmentLineItemInput

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

CreateShipmentOutput

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

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
Example
{
  "carrier": "abc123",
  "shipping_name": "xyz789",
  "shipping_method": "abc123",
  "cost": "xyz789",
  "address": AddressInput,
  "dimensions": DimensionsInput,
  "label": CreateLabelResourceInput,
  "line_item_ids": ["xyz789"],
  "tracking_number": "abc123"
}

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": "xyz789",
  "shipping_name": "abc123",
  "shipping_method": "abc123",
  "cost": "abc123",
  "address": AddressInput,
  "dimensions": DimensionsInput,
  "label": CreateLabelResourceInput,
  "line_item_ids": ["abc123"],
  "tracking_number": "abc123",
  "shipment_id": "xyz789"
}

CreateShippingLabelOutput

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

CreateShippingLinesInput

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

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": "xyz789",
  "total_price": "abc123",
  "warehouse_id": "abc123",
  "warehouse_note": "xyz789",
  "vendor_po_number": "abc123",
  "line_items": [LineItemInput],
  "packages": [PackageInput],
  "pallet": PalletData
}

CreateShippingPlanOutput

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

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": "abc123",
  "email": "xyz789",
  "account_number": "abc123",
  "address": AddressInput,
  "currency": "xyz789",
  "internal_note": "xyz789",
  "default_po_note": "abc123",
  "logo": "xyz789",
  "partner_vendor_id": 987
}

CreateVendorOutput

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

CreateWarehouseProductInput

Fields
Input Field Description
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
custom - Boolean
warehouse - String
value - String
value_currency - String
price - String
Example
{
  "warehouse_id": "xyz789",
  "on_hand": 987,
  "inventory_bin": "abc123",
  "inventory_overstock_bin": "xyz789",
  "reserve_inventory": 123,
  "replenishment_level": 987,
  "reorder_level": 123,
  "reorder_amount": 987,
  "custom": false,
  "warehouse": "xyz789",
  "value": "xyz789",
  "value_currency": "xyz789",
  "price": "xyz789"
}

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": "xyz789",
  "shop_name": "xyz789"
}

CreateWebhookOutput

Fields
Field Name Description
request_id - String
complexity - Int
webhook - Webhook
Example
{
  "request_id": "abc123",
  "complexity": 987,
  "webhook": Webhook
}

CurrentUserQueryResult

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

Date

Description

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

Example
"2007-12-03"

Decimal

Description

The Decimal scalar type represents a python Decimal.

Example
Decimal

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": "xyz789",
  "id": "abc123"
}

DeleteLotInput

Description

GraphQL input type for Lot delete.

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

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
}

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"
}

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": "xyz789"
}

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": "xyz789",
  "warehouse_id": "xyz789"
}

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": "abc123",
  "shop_name": "xyz789"
}

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": "xyz789",
  "height": "abc123",
  "width": "abc123",
  "length": "abc123"
}

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": "abc123",
  "height": "xyz789",
  "width": "abc123",
  "length": "abc123"
}

EntityType

Values
Enum Value Description

Account

User

Warehouse

PurchaseOrder

Order

LineItem

Return

Product

Bin

LocationType

PurchaseOrderLineItem

ReturnItem

Shipment

ShippedLineItem

WarehouseProduct

Vendor

Tote

Example
"Account"

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"
}

FeeCategoryTotal

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

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]
}

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": "abc123"
}

Float

Description

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

Example
123.45

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": "abc123",
  "legacy_id": 123,
  "stripe_charge_id": "abc123",
  "stripe_invoice_id": "abc123",
  "stripe_invoice_number": "abc123",
  "stripe_invoice_status": "xyz789",
  "stripe_invoice_url": "abc123",
  "stripe_next_payment_attempt": ISODateTime,
  "account_id": "abc123",
  "cc_info": "xyz789",
  "amount": "xyz789",
  "created_at": ISODateTime,
  "shipping_items": FulfillmentInvoiceShippingItemConnection,
  "inbound_shipping_items": FulfillmentInvoiceInboundShippingItemConnection,
  "returns_items": FulfillmentInvoiceReturnItemConnection,
  "storage_items": FulfillmentInvoiceStorageItemConnection
}

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]
}

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": "abc123"
}

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": 987,
  "account_id": "abc123",
  "invoice_id": "xyz789",
  "purchase_order_id": "xyz789",
  "shipment_id": "abc123",
  "shipping_label_id": "xyz789",
  "amount": "xyz789",
  "cost": "xyz789",
  "created_at": ISODateTime
}

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]
}

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"
}

FulfillmentInvoiceQueryResult

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

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": "abc123",
  "invoice_id": "abc123",
  "order_id": "abc123",
  "rma_id": "xyz789",
  "rma_label_id": "xyz789",
  "amount": "xyz789",
  "shipping_rate": "xyz789",
  "picking_fee": "xyz789",
  "inspection_fee": "abc123",
  "restocking_fee": "abc123",
  "created_at": ISODateTime
}

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]
}

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": "xyz789"
}