ShipHero GraphQL API
ShipHero's public API documentation.
API Endpoints
https://public-api.shiphero.com/graphql/Headers
# Your API token from the dashboard. Must be included in all API calls.
Authorization: Bearer <YOUR_TOKEN_HERE>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": "abc123",
"complexity": 123,
"data": Account
}
}
}
bill
Response
Returns a BillQueryResult
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": "xyz789",
"analyze": false
}
Response
{
"data": {
"bills": {
"request_id": "abc123",
"complexity": 123,
"data": BillConnection
}
}
}
expiration_lots
Response
Returns a LotsQueryResult
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
Example
Query
query fulfillment_invoice(
$id: String,
$analyze: Boolean
) {
fulfillment_invoice(
id: $id,
analyze: $analyze
) {
request_id
complexity
data {
...FulfillmentInvoiceFragment
}
}
}
Variables
{"id": "abc123", "analyze": false}
Response
{
"data": {
"fulfillment_invoice": {
"request_id": "abc123",
"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": false
}
Response
{
"data": {
"fulfillment_invoices": {
"request_id": "abc123",
"complexity": 123,
"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
|
|
reason - String
|
It performs a contains / like search and requires a date range, with a maximum of 60 days |
analyze - Boolean
|
Example
Query
query inventory_changes(
$sku: String,
$warehouse_id: String,
$location_id: String,
$location_name: String,
$date_from: ISODateTime,
$date_to: ISODateTime,
$customer_account_id: String,
$reason: String,
$analyze: Boolean
) {
inventory_changes(
sku: $sku,
warehouse_id: $warehouse_id,
location_id: $location_id,
location_name: $location_name,
date_from: $date_from,
date_to: $date_to,
customer_account_id: $customer_account_id,
reason: $reason,
analyze: $analyze
) {
request_id
complexity
data {
...InventoryChangeConnectionFragment
}
}
}
Variables
{
"sku": "xyz789",
"warehouse_id": "xyz789",
"location_id": "xyz789",
"location_name": "xyz789",
"date_from": ISODateTime,
"date_to": ISODateTime,
"customer_account_id": "abc123",
"reason": "abc123",
"analyze": true
}
Response
{
"data": {
"inventory_changes": {
"request_id": "xyz789",
"complexity": 987,
"data": InventoryChangeConnection
}
}
}
inventory_snapshot
Response
Returns an InventorySnapshotQueryResult
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": 987,
"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": "xyz789",
"status": "xyz789",
"analyze": false
}
Response
{
"data": {
"inventory_snapshots": {
"request_id": "abc123",
"complexity": 987,
"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": "abc123",
"status": "xyz789",
"analyze": true
}
Response
{
"data": {
"inventory_sync_items_status": {
"request_id": "xyz789",
"complexity": 123,
"data": InventorySyncItemStatusConnection
}
}
}
inventory_sync_status
Response
Returns an InventorySyncBatchQueryResult
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": false}
Response
{
"data": {
"inventory_sync_status": {
"request_id": "abc123",
"complexity": 987,
"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": "abc123",
"customer_account_id": "abc123",
"status": "xyz789",
"analyze": true
}
Response
{
"data": {
"inventory_sync_statuses": {
"request_id": "xyz789",
"complexity": 987,
"data": InventorySyncStatusConnection
}
}
}
lakehero_data_export
Response
Returns a LakeheroDataExportQueryResult
Example
Query
query lakehero_data_export(
$date: String,
$analyze: Boolean
) {
lakehero_data_export(
date: $date,
analyze: $analyze
) {
request_id
complexity
data {
...LakeheroDataExportFragment
}
}
}
Variables
{"date": "xyz789", "analyze": true}
Response
{
"data": {
"lakehero_data_export": {
"request_id": "xyz789",
"complexity": 123,
"data": LakeheroDataExport
}
}
}
location
Response
Returns a LocationQueryResult
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": "xyz789",
"analyze": false
}
Response
{
"data": {
"location": {
"request_id": "abc123",
"complexity": 987,
"data": Location
}
}
}
locations
Response
Returns a LocationsQueryResult
Example
Query
query locations(
$warehouse_id: String,
$sku: String,
$name: String,
$pickable: Boolean,
$sellable: Boolean,
$analyze: Boolean
) {
locations(
warehouse_id: $warehouse_id,
sku: $sku,
name: $name,
pickable: $pickable,
sellable: $sellable,
analyze: $analyze
) {
request_id
complexity
data {
...LocationConnectionFragment
}
}
}
Variables
{
"warehouse_id": "abc123",
"sku": "abc123",
"name": "abc123",
"pickable": false,
"sellable": false,
"analyze": false
}
Response
{
"data": {
"locations": {
"request_id": "abc123",
"complexity": 123,
"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": false}
Response
{
"data": {
"me": {
"request_id": "abc123",
"complexity": 123,
"data": User
}
}
}
mergeable_orders
Response
Returns a MergeableOrdersQueryResult
Arguments
| Name | Description |
|---|---|
analyze - Boolean
|
Example
Query
query mergeable_orders($analyze: Boolean) {
mergeable_orders(analyze: $analyze) {
request_id
complexity
data {
...MergeableOrderConnectionFragment
}
}
}
Variables
{"analyze": true}
Response
{
"data": {
"mergeable_orders": {
"request_id": "xyz789",
"complexity": 123,
"data": MergeableOrderConnection
}
}
}
node
order
Response
Returns an OrderQueryResult
Example
Query
query order(
$id: String!,
$analyze: Boolean
) {
order(
id: $id,
analyze: $analyze
) {
request_id
complexity
data {
...OrderFragment
}
}
}
Variables
{"id": "abc123", "analyze": true}
Response
{
"data": {
"order": {
"request_id": "abc123",
"complexity": 987,
"data": Order
}
}
}
order_history
Response
Returns an OrderHistoryQueryResult
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": "xyz789",
"order_number": "xyz789",
"username": "xyz789",
"date_from": "2007-12-03",
"date_to": "2007-12-03",
"analyze": true
}
Response
{
"data": {
"order_history": {
"request_id": "xyz789",
"complexity": 123,
"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 |
has_hold - Boolean
|
|
operator_hold - Boolean
|
|
address_hold - Boolean
|
|
payment_hold - Boolean
|
|
fraud_hold - Boolean
|
|
ready_to_ship - Boolean
|
|
profile - String
|
|
tag - String
|
|
has_backorder - Boolean
|
|
is_wholesale_order - Boolean
|
|
analyze - Boolean
|
Example
Query
query orders(
$shop_name: String,
$partner_order_id: String,
$order_number: String,
$warehouse_id: String,
$allocated_warehouse_id: String,
$fulfillment_status: String,
$sku: String,
$email: String,
$updated_from: ISODateTime,
$updated_to: ISODateTime,
$order_date_from: ISODateTime,
$order_date_to: ISODateTime,
$customer_account_id: String,
$has_hold: Boolean,
$operator_hold: Boolean,
$address_hold: Boolean,
$payment_hold: Boolean,
$fraud_hold: Boolean,
$ready_to_ship: Boolean,
$profile: String,
$tag: String,
$has_backorder: Boolean,
$is_wholesale_order: Boolean,
$analyze: Boolean
) {
orders(
shop_name: $shop_name,
partner_order_id: $partner_order_id,
order_number: $order_number,
warehouse_id: $warehouse_id,
allocated_warehouse_id: $allocated_warehouse_id,
fulfillment_status: $fulfillment_status,
sku: $sku,
email: $email,
updated_from: $updated_from,
updated_to: $updated_to,
order_date_from: $order_date_from,
order_date_to: $order_date_to,
customer_account_id: $customer_account_id,
has_hold: $has_hold,
operator_hold: $operator_hold,
address_hold: $address_hold,
payment_hold: $payment_hold,
fraud_hold: $fraud_hold,
ready_to_ship: $ready_to_ship,
profile: $profile,
tag: $tag,
has_backorder: $has_backorder,
is_wholesale_order: $is_wholesale_order,
analyze: $analyze
) {
request_id
complexity
data {
...OrderConnectionFragment
}
}
}
Variables
{
"shop_name": "xyz789",
"partner_order_id": "xyz789",
"order_number": "abc123",
"warehouse_id": "xyz789",
"allocated_warehouse_id": "abc123",
"fulfillment_status": "abc123",
"sku": "abc123",
"email": "xyz789",
"updated_from": ISODateTime,
"updated_to": ISODateTime,
"order_date_from": ISODateTime,
"order_date_to": ISODateTime,
"customer_account_id": "xyz789",
"has_hold": false,
"operator_hold": true,
"address_hold": true,
"payment_hold": true,
"fraud_hold": false,
"ready_to_ship": false,
"profile": "abc123",
"tag": "abc123",
"has_backorder": false,
"is_wholesale_order": false,
"analyze": false
}
Response
{
"data": {
"orders": {
"request_id": "xyz789",
"complexity": 123,
"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": "xyz789",
"order_number": "xyz789",
"date_from": ISODateTime,
"date_to": ISODateTime,
"analyze": false
}
Response
{
"data": {
"packs_per_day": {
"request_id": "abc123",
"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": "abc123",
"date_from": ISODateTime,
"date_to": ISODateTime,
"analyze": false
}
Response
{
"data": {
"picks_per_day": {
"request_id": "abc123",
"complexity": 987,
"data": PickConnection
}
}
}
product
Response
Returns a ProductQueryResult
Example
Query
query product(
$id: String,
$sku: String,
$barcode: String,
$customer_account_id: String,
$analyze: Boolean
) {
product(
id: $id,
sku: $sku,
barcode: $barcode,
customer_account_id: $customer_account_id,
analyze: $analyze
) {
request_id
complexity
data {
...ProductFragment
}
}
}
Variables
{
"id": "xyz789",
"sku": "abc123",
"barcode": "abc123",
"customer_account_id": "xyz789",
"analyze": false
}
Response
{
"data": {
"product": {
"request_id": "xyz789",
"complexity": 987,
"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": "abc123",
"created_from": ISODateTime,
"created_to": ISODateTime,
"updated_from": ISODateTime,
"updated_to": ISODateTime,
"customer_account_id": "abc123",
"has_kits": true,
"analyze": true
}
Response
{
"data": {
"products": {
"request_id": "xyz789",
"complexity": 987,
"data": ProductConnection
}
}
}
purchase_order
Response
Returns a PurchaseOrderQueryResult
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": "abc123",
"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
|
|
updated_from - DateTime
|
Based on updates to the Purchase Order Line Items |
updated_to - DateTime
|
Based on updates to the Purchase Order Line Items |
po_date_from - ISODateTime
|
|
po_date_to - ISODateTime
|
|
customer_account_id - String
|
If you are a 3PL you can specify one of your customer's account |
date_closed_from - ISODateTime
|
|
date_closed_to - ISODateTime
|
|
fulfillment_status - String
|
|
po_number - String
|
|
analyze - Boolean
|
Example
Query
query purchase_orders(
$sku: String,
$warehouse_id: String,
$created_from: ISODateTime,
$created_to: ISODateTime,
$updated_from: DateTime,
$updated_to: DateTime,
$po_date_from: ISODateTime,
$po_date_to: ISODateTime,
$customer_account_id: String,
$date_closed_from: ISODateTime,
$date_closed_to: ISODateTime,
$fulfillment_status: String,
$po_number: String,
$analyze: Boolean
) {
purchase_orders(
sku: $sku,
warehouse_id: $warehouse_id,
created_from: $created_from,
created_to: $created_to,
updated_from: $updated_from,
updated_to: $updated_to,
po_date_from: $po_date_from,
po_date_to: $po_date_to,
customer_account_id: $customer_account_id,
date_closed_from: $date_closed_from,
date_closed_to: $date_closed_to,
fulfillment_status: $fulfillment_status,
po_number: $po_number,
analyze: $analyze
) {
request_id
complexity
data {
...PurchaseOrderConnectionFragment
}
}
}
Variables
{
"sku": "xyz789",
"warehouse_id": "xyz789",
"created_from": ISODateTime,
"created_to": ISODateTime,
"updated_from": "2007-12-03T10:15:30Z",
"updated_to": "2007-12-03T10:15:30Z",
"po_date_from": ISODateTime,
"po_date_to": ISODateTime,
"customer_account_id": "abc123",
"date_closed_from": ISODateTime,
"date_closed_to": ISODateTime,
"fulfillment_status": "abc123",
"po_number": "xyz789",
"analyze": true
}
Response
{
"data": {
"purchase_orders": {
"request_id": "abc123",
"complexity": 987,
"data": PurchaseOrderConnection
}
}
}
return
Response
Returns a ReturnQueryResult
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": "xyz789",
"complexity": 123,
"data": Return
}
}
}
return_exchange
Response
Returns a ReturnExchangeQueryResult
Example
Query
query return_exchange(
$id: String!,
$analyze: Boolean
) {
return_exchange(
id: $id,
analyze: $analyze
) {
request_id
complexity
data {
...ReturnExchangeFragment
}
}
}
Variables
{"id": "xyz789", "analyze": false}
Response
{
"data": {
"return_exchange": {
"request_id": "xyz789",
"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 |
tracking_number - String
|
|
analyze - Boolean
|
Example
Query
query returns(
$order_id: String,
$warehouse_id: String,
$date_from: ISODateTime,
$date_to: ISODateTime,
$customer_account_id: String,
$tracking_number: 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,
tracking_number: $tracking_number,
analyze: $analyze
) {
request_id
complexity
data {
...ReturnConnectionFragment
}
}
}
Variables
{
"order_id": "abc123",
"warehouse_id": "abc123",
"date_from": ISODateTime,
"date_to": ISODateTime,
"customer_account_id": "abc123",
"tracking_number": "abc123",
"analyze": false
}
Response
{
"data": {
"returns": {
"request_id": "abc123",
"complexity": 123,
"data": ReturnConnection
}
}
}
shipment
Response
Returns a ShipmentQueryResult
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": 987,
"data": Shipment
}
}
}
shipments
Response
Returns a ShipmentsQueryResult
Arguments
| Name | Description |
|---|---|
customer_account_id - String
|
If you are a 3PL you can specify one of your customer's account |
order_id - String
|
|
date_from - ISODateTime
|
|
date_to - ISODateTime
|
|
order_date_from - ISODateTime
|
|
order_date_to - ISODateTime
|
|
tracking_number - String
|
|
alternate_tracking_id - String
|
|
voided - Boolean
|
|
analyze - Boolean
|
Example
Query
query shipments(
$customer_account_id: String,
$order_id: String,
$date_from: ISODateTime,
$date_to: ISODateTime,
$order_date_from: ISODateTime,
$order_date_to: ISODateTime,
$tracking_number: String,
$alternate_tracking_id: String,
$voided: Boolean,
$analyze: Boolean
) {
shipments(
customer_account_id: $customer_account_id,
order_id: $order_id,
date_from: $date_from,
date_to: $date_to,
order_date_from: $order_date_from,
order_date_to: $order_date_to,
tracking_number: $tracking_number,
alternate_tracking_id: $alternate_tracking_id,
voided: $voided,
analyze: $analyze
) {
request_id
complexity
data {
...ShipmentConnectionFragment
}
}
}
Variables
{
"customer_account_id": "xyz789",
"order_id": "abc123",
"date_from": ISODateTime,
"date_to": ISODateTime,
"order_date_from": ISODateTime,
"order_date_to": ISODateTime,
"tracking_number": "abc123",
"alternate_tracking_id": "abc123",
"voided": false,
"analyze": true
}
Response
{
"data": {
"shipments": {
"request_id": "xyz789",
"complexity": 987,
"data": ShipmentConnection
}
}
}
shipping_container
Response
Returns a ShippingContainerQueryResult
Example
Query
query shipping_container(
$id: String,
$analyze: Boolean
) {
shipping_container(
id: $id,
analyze: $analyze
) {
request_id
complexity
data {
...ShippingContainerFragment
}
}
}
Variables
{"id": "abc123", "analyze": false}
Response
{
"data": {
"shipping_container": {
"request_id": "abc123",
"complexity": 123,
"data": ShippingContainer
}
}
}
shipping_containers
Response
Returns a ShippingContainersQueryResult
Arguments
| Name | Description |
|---|---|
warehouse_id - String
|
|
carrier - String
|
|
shipping_method - String
|
|
created_from - ISODateTime
|
|
created_to - ISODateTime
|
|
updated_from - ISODateTime
|
|
updated_to - ISODateTime
|
|
shipped_date_from - ISODateTime
|
|
shipped_date_to - ISODateTime
|
|
analyze - Boolean
|
Example
Query
query shipping_containers(
$warehouse_id: String,
$carrier: String,
$shipping_method: String,
$created_from: ISODateTime,
$created_to: ISODateTime,
$updated_from: ISODateTime,
$updated_to: ISODateTime,
$shipped_date_from: ISODateTime,
$shipped_date_to: ISODateTime,
$analyze: Boolean
) {
shipping_containers(
warehouse_id: $warehouse_id,
carrier: $carrier,
shipping_method: $shipping_method,
created_from: $created_from,
created_to: $created_to,
updated_from: $updated_from,
updated_to: $updated_to,
shipped_date_from: $shipped_date_from,
shipped_date_to: $shipped_date_to,
analyze: $analyze
) {
request_id
complexity
data {
...ShippingContainerConnectionFragment
}
}
}
Variables
{
"warehouse_id": "xyz789",
"carrier": "abc123",
"shipping_method": "xyz789",
"created_from": ISODateTime,
"created_to": ISODateTime,
"updated_from": ISODateTime,
"updated_to": ISODateTime,
"shipped_date_from": ISODateTime,
"shipped_date_to": ISODateTime,
"analyze": true
}
Response
{
"data": {
"shipping_containers": {
"request_id": "abc123",
"complexity": 987,
"data": ShippingContainerConnection
}
}
}
shipping_plan
Response
Returns a ShippingPlanQueryResult
Example
Query
query shipping_plan(
$id: String,
$analyze: Boolean
) {
shipping_plan(
id: $id,
analyze: $analyze
) {
request_id
complexity
data {
...ShippingPlanFragment
}
}
}
Variables
{"id": "abc123", "analyze": false}
Response
{
"data": {
"shipping_plan": {
"request_id": "abc123",
"complexity": 123,
"data": ShippingPlan
}
}
}
tote
Response
Returns a ToteContentQueryResult
Example
Query
query tote(
$barcode: String!,
$analyze: Boolean
) {
tote(
barcode: $barcode,
analyze: $analyze
) {
request_id
complexity
data {
...ToteFragment
}
}
}
Variables
{"barcode": "xyz789", "analyze": false}
Response
{
"data": {
"tote": {
"request_id": "xyz789",
"complexity": 987,
"data": Tote
}
}
}
tote_history
Response
Returns a ToteHistoryQueryResult
Arguments
| Name | Description |
|---|---|
tote_name - String
|
|
tote_id - String
|
|
date_from - ISODateTime
|
|
date_to - ISODateTime
|
|
analyze - Boolean
|
Example
Query
query tote_history(
$tote_name: String,
$tote_id: String,
$date_from: ISODateTime,
$date_to: ISODateTime,
$analyze: Boolean
) {
tote_history(
tote_name: $tote_name,
tote_id: $tote_id,
date_from: $date_from,
date_to: $date_to,
analyze: $analyze
) {
request_id
complexity
data {
...ToteHistoryConnectionFragment
}
}
}
Variables
{
"tote_name": "xyz789",
"tote_id": "abc123",
"date_from": ISODateTime,
"date_to": ISODateTime,
"analyze": false
}
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": true,
"expiration_date": ISODateTime,
"time_remaining": "abc123",
"credits_remaining": 987,
"max_available": 123,
"increment_rate": 123
}
}
}
uuid
Description
When using the old webhooks you might receive resource ids as numeric ids.If you need any of those ids in one of our new queries or mutations, you can usethis query to retrieve the uuid corresponding to that resource/entity numeric id
Response
Returns a LegacyIdQueryResult
Arguments
| Name | Description |
|---|---|
legacy_id - Int!
|
|
entity - EntityType!
|
|
analyze - Boolean
|
Example
Query
query uuid(
$legacy_id: Int!,
$entity: EntityType!,
$analyze: Boolean
) {
uuid(
legacy_id: $legacy_id,
entity: $entity,
analyze: $analyze
) {
request_id
complexity
data {
...LegacyIdFragment
}
}
}
Variables
{"legacy_id": 123, "entity": "Account", "analyze": false}
Response
{
"data": {
"uuid": {
"request_id": "abc123",
"complexity": 987,
"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": false}
Response
{
"data": {
"vendors": {
"request_id": "abc123",
"complexity": 123,
"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": "abc123",
"active": true,
"sku": "xyz789",
"customer_account_id": "xyz789",
"created_from": ISODateTime,
"created_to": ISODateTime,
"updated_from": ISODateTime,
"updated_to": ISODateTime,
"analyze": true
}
Response
{
"data": {
"warehouse_products": {
"request_id": "abc123",
"complexity": 987,
"data": WarehouseProductConnection
}
}
}
webhooks
Response
Returns a WebhooksQueryResult
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": true
}
Response
{
"data": {
"webhooks": {
"request_id": "xyz789",
"complexity": 987,
"data": WebhookConnection
}
}
}
wholesale_order
Response
Returns a WholesaleOrderQueryResult
Example
Query
query wholesale_order(
$id: String,
$order_id: String,
$analyze: Boolean
) {
wholesale_order(
id: $id,
order_id: $order_id,
analyze: $analyze
) {
request_id
complexity
data {
...WholesaleOrderFragment
}
}
}
Variables
{
"id": "abc123",
"order_id": "abc123",
"analyze": false
}
Response
{
"data": {
"wholesale_order": {
"request_id": "abc123",
"complexity": 987,
"data": WholesaleOrder
}
}
}
wholesale_orders
Response
Returns a WholesaleOrdersQueryResult
Arguments
| Name | Description |
|---|---|
customer_account_id - String
|
If you are a 3PL you can specify one of your customer's account |
partner_order_id - String
|
|
updated_from - ISODateTime
|
|
updated_to - ISODateTime
|
|
order_date_from - ISODateTime
|
|
order_date_to - ISODateTime
|
|
analyze - Boolean
|
Example
Query
query wholesale_orders(
$customer_account_id: String,
$partner_order_id: String,
$updated_from: ISODateTime,
$updated_to: ISODateTime,
$order_date_from: ISODateTime,
$order_date_to: ISODateTime,
$analyze: Boolean
) {
wholesale_orders(
customer_account_id: $customer_account_id,
partner_order_id: $partner_order_id,
updated_from: $updated_from,
updated_to: $updated_to,
order_date_from: $order_date_from,
order_date_to: $order_date_to,
analyze: $analyze
) {
request_id
complexity
data {
...WholesaleOrderConnectionFragment
}
}
}
Variables
{
"customer_account_id": "abc123",
"partner_order_id": "abc123",
"updated_from": ISODateTime,
"updated_to": ISODateTime,
"order_date_from": ISODateTime,
"order_date_to": ISODateTime,
"analyze": false
}
Response
{
"data": {
"wholesale_orders": {
"request_id": "abc123",
"complexity": 123,
"data": WholesaleOrderConnection
}
}
}
wholesale_staging_location_candidates
Response
Example
Query
query wholesale_staging_location_candidates(
$warehouse_id: String!,
$search: String,
$analyze: Boolean
) {
wholesale_staging_location_candidates(
warehouse_id: $warehouse_id,
search: $search,
analyze: $analyze
) {
request_id
complexity
data {
...LocationConnectionFragment
}
}
}
Variables
{
"warehouse_id": "xyz789",
"search": "xyz789",
"analyze": false
}
Response
{
"data": {
"wholesale_staging_location_candidates": {
"request_id": "abc123",
"complexity": 123,
"data": LocationConnection
}
}
}
work_order
Response
Returns a WorkOrderQueryResult
Example
Query
query work_order(
$id: Int!,
$analyze: Boolean
) {
work_order(
id: $id,
analyze: $analyze
) {
request_id
complexity
data {
...WorkOrderIdentifiableTypeFragment
}
}
}
Variables
{"id": 987, "analyze": true}
Response
{
"data": {
"work_order": {
"request_id": "abc123",
"complexity": 123,
"data": WorkOrderIdentifiableType
}
}
}
work_orders
Response
Returns a WorkOrdersQueryResult
Arguments
| Name | Description |
|---|---|
status - [String]
|
|
wo_type - [String]
|
|
requested_date_from - ISODateTime
|
|
requested_date_to - ISODateTime
|
|
updated_at_from - ISODateTime
|
|
updated_at_to - ISODateTime
|
|
customer_account_id - Int
|
|
analyze - Boolean
|
Example
Query
query work_orders(
$status: [String],
$wo_type: [String],
$requested_date_from: ISODateTime,
$requested_date_to: ISODateTime,
$updated_at_from: ISODateTime,
$updated_at_to: ISODateTime,
$customer_account_id: Int,
$analyze: Boolean
) {
work_orders(
status: $status,
wo_type: $wo_type,
requested_date_from: $requested_date_from,
requested_date_to: $requested_date_to,
updated_at_from: $updated_at_from,
updated_at_to: $updated_at_to,
customer_account_id: $customer_account_id,
analyze: $analyze
) {
request_id
complexity
data {
...WorkOrderIdentifiableTypeConnectionFragment
}
}
}
Variables
{
"status": ["abc123"],
"wo_type": ["abc123"],
"requested_date_from": ISODateTime,
"requested_date_to": ISODateTime,
"updated_at_from": ISODateTime,
"updated_at_to": ISODateTime,
"customer_account_id": 987,
"analyze": true
}
Response
{
"data": {
"work_orders": {
"request_id": "xyz789",
"complexity": 987,
"data": WorkOrderIdentifiableTypeConnection
}
}
}
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": "abc123",
"complexity": 123,
"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": 123,
"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": 987
}
}
}
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": "xyz789",
"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": "abc123",
"complexity": 987,
"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": "xyz789",
"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": 987,
"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": "xyz789",
"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": 123,
"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": "xyz789",
"complexity": 987,
"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": 987,
"sync_id": "xyz789"
}
}
}
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": 123,
"sync": InventorySyncStatus
}
}
}
inventory_transfer
Response
Returns a TransferInventoryOutput
Arguments
| Name | Description |
|---|---|
data - TransferInventoryInput!
|
Example
Query
mutation inventory_transfer($data: TransferInventoryInput!) {
inventory_transfer(data: $data) {
request_id
complexity
ok
}
}
Variables
{"data": TransferInventoryInput}
Response
{
"data": {
"inventory_transfer": {
"request_id": "xyz789",
"complexity": 987,
"ok": true
}
}
}
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": 987,
"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": "xyz789",
"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": "abc123",
"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": "abc123",
"complexity": 987,
"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": "xyz789",
"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": 123,
"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": 987,
"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": "abc123",
"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": "xyz789",
"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": 987,
"ok": false
}
}
}
node
order_add_attachment
Response
Returns an OrderAddAttachmentOutput
Arguments
| Name | Description |
|---|---|
data - OrderAddAttachmentInput!
|
Example
Query
mutation order_add_attachment($data: OrderAddAttachmentInput!) {
order_add_attachment(data: $data) {
request_id
complexity
attachment {
...OrderAttachmentFragment
}
}
}
Variables
{"data": OrderAddAttachmentInput}
Response
{
"data": {
"order_add_attachment": {
"request_id": "abc123",
"complexity": 987,
"attachment": OrderAttachment
}
}
}
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_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": "xyz789",
"complexity": 123,
"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": "abc123",
"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": "abc123",
"complexity": 987,
"order": Order
}
}
}
order_fulfill
Response
Returns an OrderShipmentMutationOutput
Arguments
| Name | Description |
|---|---|
data - FulfillOrderInput!
|
Example
Query
mutation order_fulfill($data: FulfillOrderInput!) {
order_fulfill(data: $data) {
request_id
complexity
shipment {
...ShipmentFragment
}
}
}
Variables
{"data": FulfillOrderInput}
Response
{
"data": {
"order_fulfill": {
"request_id": "xyz789",
"complexity": 123,
"shipment": Shipment
}
}
}
order_merge
Response
Returns a MergeOrdersOutput
Arguments
| Name | Description |
|---|---|
data - MergeOrdersInput!
|
Example
Query
mutation order_merge($data: MergeOrdersInput!) {
order_merge(data: $data) {
request_id
complexity
order {
...OrderFragment
}
}
}
Variables
{"data": MergeOrdersInput}
Response
{
"data": {
"order_merge": {
"request_id": "abc123",
"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_set_line_item_sku
Response
Returns an OrderMutationOutput
Arguments
| Name | Description |
|---|---|
data - SetLineItemSkuInput!
|
Example
Query
mutation order_set_line_item_sku($data: SetLineItemSkuInput!) {
order_set_line_item_sku(data: $data) {
request_id
complexity
order {
...OrderFragment
}
}
}
Variables
{"data": SetLineItemSkuInput}
Response
{
"data": {
"order_set_line_item_sku": {
"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": "abc123",
"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": 123,
"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": 987,
"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": 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": 987,
"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": "abc123",
"complexity": 123
}
}
}
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": 123,
"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": "abc123",
"complexity": 123,
"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": "abc123",
"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": "xyz789",
"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": "xyz789",
"complexity": 123,
"purchase_order": PurchaseOrder
}
}
}
purchase_order_set_fulfillment_status
Response
Returns a SetPurchaseOrderFulfillmentStatusOutput
Arguments
| Name | Description |
|---|---|
data - SetPurchaseOrderFulfillmentStatusInput!
|
Example
Query
mutation purchase_order_set_fulfillment_status($data: SetPurchaseOrderFulfillmentStatusInput!) {
purchase_order_set_fulfillment_status(data: $data) {
request_id
complexity
purchase_order {
...PurchaseOrderFragment
}
}
}
Variables
{"data": SetPurchaseOrderFulfillmentStatusInput}
Response
{
"data": {
"purchase_order_set_fulfillment_status": {
"request_id": "xyz789",
"complexity": 987,
"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": "xyz789",
"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": "xyz789",
"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": "xyz789",
"complexity": 123,
"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": "abc123",
"complexity": 123,
"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": "abc123",
"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": "xyz789",
"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": 987
}
}
}
warehouse_product_delete
Response
Returns a MutationOutput
Arguments
| Name | Description |
|---|---|
data - DeleteWarehouseProductInput!
|
Example
Query
mutation warehouse_product_delete($data: DeleteWarehouseProductInput!) {
warehouse_product_delete(data: $data) {
request_id
complexity
}
}
Variables
{"data": DeleteWarehouseProductInput}
Response
{
"data": {
"warehouse_product_delete": {
"request_id": "abc123",
"complexity": 123
}
}
}
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": 123,
"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": 123
}
}
}
wholesale_order_auto_allocate_for_picking
Response
Returns a WholesaleOrderAutoAllocateForPickingMutationOutput
Arguments
| Name | Description |
|---|---|
data - WholesaleOrderAutoAllocateInput!
|
Example
Query
mutation wholesale_order_auto_allocate_for_picking($data: WholesaleOrderAutoAllocateInput!) {
wholesale_order_auto_allocate_for_picking(data: $data) {
request_id
complexity
line_items {
...WholesaleOrderAutoAllocateForPickingTypeFragment
}
}
}
Variables
{"data": WholesaleOrderAutoAllocateInput}
Response
{
"data": {
"wholesale_order_auto_allocate_for_picking": {
"request_id": "abc123",
"complexity": 123,
"line_items": [
WholesaleOrderAutoAllocateForPickingType
]
}
}
}
wholesale_order_create
Response
Returns a WholesaleOrderMutationOutput
Arguments
| Name | Description |
|---|---|
data - CreateWholesaleOrderInput!
|
Example
Query
mutation wholesale_order_create($data: CreateWholesaleOrderInput!) {
wholesale_order_create(data: $data) {
request_id
complexity
wholesale_order {
...WholesaleOrderFragment
}
}
}
Variables
{"data": CreateWholesaleOrderInput}
Response
{
"data": {
"wholesale_order_create": {
"request_id": "abc123",
"complexity": 987,
"wholesale_order": WholesaleOrder
}
}
}
wholesale_order_edit_outbound_schedule
Response
Returns a WholesaleOrderEditOutboundScheduleOutput
Arguments
| Name | Description |
|---|---|
data - WholesaleOrderEditOutboundScheduleInput!
|
Example
Query
mutation wholesale_order_edit_outbound_schedule($data: WholesaleOrderEditOutboundScheduleInput!) {
wholesale_order_edit_outbound_schedule(data: $data) {
request_id
complexity
ok
}
}
Variables
{"data": WholesaleOrderEditOutboundScheduleInput}
Response
{
"data": {
"wholesale_order_edit_outbound_schedule": {
"request_id": "abc123",
"complexity": 987,
"ok": true
}
}
}
wholesale_order_fulfill
Response
Returns a WholesaleOrderMutationOutput
Arguments
| Name | Description |
|---|---|
data - FulfillWholesaleOrderInput!
|
Example
Query
mutation wholesale_order_fulfill($data: FulfillWholesaleOrderInput!) {
wholesale_order_fulfill(data: $data) {
request_id
complexity
wholesale_order {
...WholesaleOrderFragment
}
}
}
Variables
{"data": FulfillWholesaleOrderInput}
Response
{
"data": {
"wholesale_order_fulfill": {
"request_id": "xyz789",
"complexity": 123,
"wholesale_order": WholesaleOrder
}
}
}
wholesale_order_generate_bol_document
Response
Returns a WholesaleOrderGenerateBOLOutput
Arguments
| Name | Description |
|---|---|
data - WholesaleOrderGenerateBOLInput!
|
Example
Query
mutation wholesale_order_generate_bol_document($data: WholesaleOrderGenerateBOLInput!) {
wholesale_order_generate_bol_document(data: $data) {
request_id
complexity
pdf_url
}
}
Variables
{"data": WholesaleOrderGenerateBOLInput}
Response
{
"data": {
"wholesale_order_generate_bol_document": {
"request_id": "xyz789",
"complexity": 987,
"pdf_url": "xyz789"
}
}
}
wholesale_order_print_manual_picking_sheet
Response
Arguments
| Name | Description |
|---|---|
data - WholesaleOrderPrintManualPickingSheetInput!
|
Example
Query
mutation wholesale_order_print_manual_picking_sheet($data: WholesaleOrderPrintManualPickingSheetInput!) {
wholesale_order_print_manual_picking_sheet(data: $data) {
request_id
complexity
picking_sheet_url
}
}
Variables
{"data": WholesaleOrderPrintManualPickingSheetInput}
Response
{
"data": {
"wholesale_order_print_manual_picking_sheet": {
"request_id": "xyz789",
"complexity": 123,
"picking_sheet_url": "xyz789"
}
}
}
wholesale_order_print_packing_list
Response
Returns a WholesaleOrderPrintPackingListOutput
Arguments
| Name | Description |
|---|---|
data - WholesaleOrderPrintPackingListInput!
|
Example
Query
mutation wholesale_order_print_packing_list($data: WholesaleOrderPrintPackingListInput!) {
wholesale_order_print_packing_list(data: $data) {
request_id
complexity
packing_list_url
}
}
Variables
{"data": WholesaleOrderPrintPackingListInput}
Response
{
"data": {
"wholesale_order_print_packing_list": {
"request_id": "abc123",
"complexity": 123,
"packing_list_url": "abc123"
}
}
}
wholesale_order_transfer_picks_to_staging
Response
Returns a WholesaleOrderMutationOutput
Arguments
| Name | Description |
|---|---|
data - UpdateWholesaleOrderInputBase!
|
Example
Query
mutation wholesale_order_transfer_picks_to_staging($data: UpdateWholesaleOrderInputBase!) {
wholesale_order_transfer_picks_to_staging(data: $data) {
request_id
complexity
wholesale_order {
...WholesaleOrderFragment
}
}
}
Variables
{"data": UpdateWholesaleOrderInputBase}
Response
{
"data": {
"wholesale_order_transfer_picks_to_staging": {
"request_id": "abc123",
"complexity": 123,
"wholesale_order": WholesaleOrder
}
}
}
wholesale_order_update
Response
Returns a WholesaleOrderMutationOutput
Arguments
| Name | Description |
|---|---|
data - UpdateWholesaleOrderInput!
|
Example
Query
mutation wholesale_order_update($data: UpdateWholesaleOrderInput!) {
wholesale_order_update(data: $data) {
request_id
complexity
wholesale_order {
...WholesaleOrderFragment
}
}
}
Variables
{"data": UpdateWholesaleOrderInput}
Response
{
"data": {
"wholesale_order_update": {
"request_id": "abc123",
"complexity": 987,
"wholesale_order": WholesaleOrder
}
}
}
wholesale_order_update_picking_flow
Response
Returns a WholesaleOrderMutationOutput
Arguments
| Name | Description |
|---|---|
data - UpdateWholesaleOrderPickingFlowInput!
|
Example
Query
mutation wholesale_order_update_picking_flow($data: UpdateWholesaleOrderPickingFlowInput!) {
wholesale_order_update_picking_flow(data: $data) {
request_id
complexity
wholesale_order {
...WholesaleOrderFragment
}
}
}
Variables
{"data": UpdateWholesaleOrderPickingFlowInput}
Response
{
"data": {
"wholesale_order_update_picking_flow": {
"request_id": "abc123",
"complexity": 987,
"wholesale_order": WholesaleOrder
}
}
}
wholesale_order_update_staging_location
Response
Returns a WholesaleOrderMutationOutput
Arguments
| Name | Description |
|---|---|
data - UpdateWholesaleOrderStagingLocationInput!
|
Example
Query
mutation wholesale_order_update_staging_location($data: UpdateWholesaleOrderStagingLocationInput!) {
wholesale_order_update_staging_location(data: $data) {
request_id
complexity
wholesale_order {
...WholesaleOrderFragment
}
}
}
Variables
{"data": UpdateWholesaleOrderStagingLocationInput}
Response
{
"data": {
"wholesale_order_update_staging_location": {
"request_id": "abc123",
"complexity": 987,
"wholesale_order": WholesaleOrder
}
}
}
wholesale_set_as_ready_to_pick
Response
Returns a WholesaleOrderSetReadyToPickOutput
Arguments
| Name | Description |
|---|---|
data - WholesaleOrderSetReadyToPickInput!
|
Example
Query
mutation wholesale_set_as_ready_to_pick($data: WholesaleOrderSetReadyToPickInput!) {
wholesale_set_as_ready_to_pick(data: $data) {
request_id
complexity
ok
}
}
Variables
{"data": WholesaleOrderSetReadyToPickInput}
Response
{
"data": {
"wholesale_set_as_ready_to_pick": {
"request_id": "abc123",
"complexity": 123,
"ok": true
}
}
}
work_order_create
Response
Returns a WorkOrderMutationOutput
Arguments
| Name | Description |
|---|---|
data - CreateWorkOrderInput!
|
Example
Query
mutation work_order_create($data: CreateWorkOrderInput!) {
work_order_create(data: $data) {
request_id
complexity
work_order {
...WorkOrderIdentifiableTypeFragment
}
}
}
Variables
{"data": CreateWorkOrderInput}
Response
{
"data": {
"work_order_create": {
"request_id": "abc123",
"complexity": 987,
"work_order": WorkOrderIdentifiableType
}
}
}
Types
AbortInventorySyncInput
AbortInventorySyncOutput
Fields
| Field Name | Description |
|---|---|
request_id - String
|
|
complexity - Int
|
|
sync - InventorySyncStatus
|
Example
{
"request_id": "abc123",
"complexity": 123,
"sync": InventorySyncStatus
}
Account
Example
{
"id": "abc123",
"legacy_id": 123,
"email": "abc123",
"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
AccountQueryResult
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": "abc123",
"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": "xyz789",
"line_items": [CreateLineItemInput]
}
AddProductToVendorInput
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
|
|
value - String
|
|
value_currency - String
|
|
active - Boolean
|
Example
{
"customer_account_id": "abc123",
"sku": "xyz789",
"warehouse_id": "abc123",
"on_hand": 987,
"inventory_bin": "xyz789",
"inventory_overstock_bin": "abc123",
"reserve_inventory": 987,
"replenishment_level": 987,
"reorder_level": 987,
"reorder_amount": 123,
"price": "xyz789",
"value": "abc123",
"value_currency": "xyz789",
"active": true
}
AddPurchaseOrderAttachmentInput
AddPurchaseOrderAttachmentOutput
Fields
| Field Name | Description |
|---|---|
request_id - String
|
|
complexity - Int
|
|
attachment - PurchaseOrderAttachment
|
Example
{
"request_id": "xyz789",
"complexity": 987,
"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": "abc123",
"state": "abc123",
"country": "xyz789",
"zip": "xyz789",
"phone": "xyz789"
}
AddressInput
Example
{
"name": "xyz789",
"address1": "xyz789",
"address2": "xyz789",
"city": "abc123",
"state": "abc123",
"country": "abc123",
"zip": "xyz789",
"phone": "xyz789"
}
AllocatedAllocationType
Fields
| Field Name | Description |
|---|---|
quantity - Int
|
|
status - PickingJobStatus
|
|
location - Location
|
Example
{"quantity": 987, "status": "DRAFT", "location": Location}
AllocationErrorType
AllocationType
Example
AllocatedAllocationType
AssemblySKUType
AssignLotToLocationInput
Description
GraphQL input type for assigning a Lot to a Location.
Example
{
"lot_id": "xyz789",
"location_id": "abc123"
}
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": 987,
"warehouse_product": WarehouseProduct
}
Authorization
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
|
|
bill_exports - BillExportsConnection
|
|
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
BillExports
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
BillingPeriod
Fields
| Field Name | Description |
|---|---|
start - ISODateTime
|
|
end - ISODateTime
|
Example
{
"start": ISODateTime,
"end": ISODateTime
}
BillsQueryResult
Boolean
Description
The Boolean scalar type represents true or false.
BuildKitComponentInput
BuildKitInput
Fields
| Input Field | Description |
|---|---|
sku - String!
|
|
components - [BuildKitComponentInput]!
|
|
kit_build - Boolean
|
|
customer_account_id - String
|
Example
{
"sku": "abc123",
"components": [BuildKitComponentInput],
"kit_build": false,
"customer_account_id": "abc123"
}
BulkMutationOutput
Fields
| Field Name | Description |
|---|---|
request_id - String
|
|
complexity - Int
|
|
errors - [OperationError]
|
Example
{
"request_id": "abc123",
"complexity": 987,
"errors": [OperationError]
}
BulkUpdateTagsInput
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": "abc123",
"order_id": "abc123",
"reason": "xyz789",
"void_on_platform": false,
"force": true
}
CancelPurchaseOrderInput
CancelPurchaseOrderOutput
Fields
| Field Name | Description |
|---|---|
request_id - String
|
|
complexity - Int
|
|
purchase_order - PurchaseOrder
|
Example
{
"request_id": "abc123",
"complexity": 987,
"purchase_order": PurchaseOrder
}
Case
ChangeOrderWarehouseInput
Example
{
"customer_account_id": "abc123",
"order_id": "xyz789",
"warehouse_id": "abc123"
}
ClearKitInput
ClosePurchaseOrderInput
ClosePurchaseOrderOutput
Fields
| Field Name | Description |
|---|---|
request_id - String
|
|
complexity - Int
|
|
purchase_order - PurchaseOrder
|
Example
{
"request_id": "xyz789",
"complexity": 987,
"purchase_order": PurchaseOrder
}
CreateBillInput
Fields
| Input Field | Description |
|---|---|
customer_account_id - String!
|
|
start_date - ISODateTime!
|
|
end_date - ISODateTime!
|
|
warehouse_id - String
|
Example
{
"customer_account_id": "xyz789",
"start_date": ISODateTime,
"end_date": ISODateTime,
"warehouse_id": "abc123"
}
CreateBillOutput
CreateExchangeItem
CreateLabelResourceInput
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": "xyz789",
"partner_line_item_id": "xyz789",
"quantity": 123,
"price": "abc123",
"product_name": "abc123",
"option_title": "xyz789",
"fulfillment_status": "xyz789",
"quantity_pending_fulfillment": 123,
"custom_options": GenericScalar,
"custom_barcode": "abc123",
"eligible_for_return": false,
"customs_value": "abc123",
"barcode": "xyz789",
"warehouse_id": "abc123"
}
CreateLocationInput
Example
{
"warehouse_id": "xyz789",
"name": "xyz789",
"zone": "xyz789",
"location_type_id": "abc123",
"pickable": false,
"sellable": true,
"is_cart": false,
"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": "abc123",
"name": "xyz789",
"sku": "abc123",
"expires_at": ISODateTime,
"is_active": true
}
CreateLotOutput
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": "abc123",
"zip": "abc123",
"country": "xyz789",
"country_code": "xyz789",
"email": "abc123",
"phone": "abc123"
}
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
|
|
total_discounts - String
|
|
box_name - String
|
|
currency - String
|
|
ready_to_ship - Boolean
|
|
insurance_amount - Decimal
|
|
shipping_lines - CreateShippingLinesInput
|
|
shipping_address - CreateOrderAddressInput!
|
|
billing_address - CreateOrderAddressInput
|
|
from_name - String
|
|
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
|
|
do_not_print_invoice - Boolean
|
|
ignore_payment_capture_errors - Boolean
|
Example
{
"customer_account_id": "abc123",
"order_number": "abc123",
"partner_order_id": "xyz789",
"shop_name": "xyz789",
"fulfillment_status": "xyz789",
"order_date": ISODateTime,
"total_tax": "abc123",
"total_discounts": "xyz789",
"box_name": "abc123",
"currency": "xyz789",
"ready_to_ship": false,
"insurance_amount": Decimal,
"shipping_lines": CreateShippingLinesInput,
"shipping_address": CreateOrderAddressInput,
"billing_address": CreateOrderAddressInput,
"from_name": "xyz789",
"tags": ["abc123"],
"line_items": [CreateLineItemInput],
"gift_note": "abc123",
"gift_invoice": true,
"require_signature": true,
"adult_signature_required": true,
"alcohol": true,
"insurance": true,
"allow_partial": false,
"allow_split": false,
"custom_invoice_url": "abc123",
"email": "abc123",
"profile": "xyz789",
"packing_note": "xyz789",
"required_ship_date": ISODateTime,
"auto_print_return_label": false,
"hold_until_date": ISODateTime,
"incoterms": "xyz789",
"tax_id": "xyz789",
"tax_type": "xyz789",
"flagged": false,
"saturday_delivery": true,
"ignore_address_validation_errors": true,
"skip_address_validation": false,
"priority_flag": false,
"allocation_priority": 987,
"holds": HoldsInput,
"dry_ice_weight_in_lbs": "xyz789",
"ftr_exemption": Decimal,
"address_is_business": true,
"do_not_print_invoice": true,
"ignore_payment_capture_errors": true
}
CreateProductCaseInput
CreateProductImageInput
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!
|
|
warehouse_products - [CreateWarehouseProductInput]!
|
|
barcode - String
|
|
country_of_manufacture - String
|
|
dimensions - DimensionsInput
|
|
tariff_code - String
|
|
product_note - String
|
|
kit - Boolean
|
|
kit_build - Boolean
|
|
no_air - Boolean
|
|
final_sale - Boolean
|
|
customs_value - String
|
|
customs_description - String
|
|
not_owned - Boolean
|
|
ignore_on_customs - Boolean
|
|
ignore_on_invoice - Boolean
|
|
dropship - Boolean
|
|
needs_serial_number - Boolean
|
|
virtual - Boolean
|
|
needs_lot_tracking - Boolean
|
|
packer_note - String
|
|
vendor_part_number - String
|
|
consumer_package_code - String
|
|
buyer_part_number - String
|
|
buyer_style_number - String
|
|
images - [CreateProductImageInput]
|
|
tags - [String]
|
|
vendors - [CreateProductVendorInput]
|
|
cases - [CreateProductCaseInput]
|
Example
{
"customer_account_id": "abc123",
"name": "abc123",
"sku": "xyz789",
"warehouse_products": [CreateWarehouseProductInput],
"barcode": "xyz789",
"country_of_manufacture": "xyz789",
"dimensions": DimensionsInput,
"tariff_code": "abc123",
"product_note": "abc123",
"kit": false,
"kit_build": false,
"no_air": true,
"final_sale": false,
"customs_value": "xyz789",
"customs_description": "xyz789",
"not_owned": true,
"ignore_on_customs": false,
"ignore_on_invoice": false,
"dropship": true,
"needs_serial_number": true,
"virtual": true,
"needs_lot_tracking": false,
"packer_note": "xyz789",
"vendor_part_number": "abc123",
"consumer_package_code": "xyz789",
"buyer_part_number": "xyz789",
"buyer_style_number": "xyz789",
"images": [CreateProductImageInput],
"tags": ["abc123"],
"vendors": [CreateProductVendorInput],
"cases": [CreateProductCaseInput]
}
CreateProductOutput
CreateProductVendorInput
CreatePurchaseOrderAttachmentInput
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": "xyz789",
"shipping_price": "abc123",
"total_price": "xyz789",
"warehouse_id": "abc123",
"line_items": [CreatePurchaseOrderLineItemInput],
"po_date": ISODateTime,
"po_note": "abc123",
"fulfillment_status": "abc123",
"discount": "abc123",
"vendor_id": "abc123",
"warehouse": "xyz789",
"packing_note": "xyz789",
"description": "abc123",
"partner_order_number": "xyz789",
"tax": "abc123",
"tracking_number": "abc123",
"attachments": [CreatePurchaseOrderAttachmentInput],
"origin_of_shipment": "xyz789"
}
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": "abc123",
"quantity": 987,
"expected_weight_in_lbs": "xyz789",
"price": "abc123",
"vendor_id": "xyz789",
"vendor_sku": "xyz789",
"variant_id": 987,
"quantity_received": 123,
"quantity_rejected": 123,
"product_name": "abc123",
"option_title": "xyz789",
"fulfillment_status": "xyz789",
"sell_ahead": 987,
"note": "abc123",
"partner_line_item_id": "abc123"
}
CreatePurchaseOrderOutput
Fields
| Field Name | Description |
|---|---|
request_id - String
|
|
complexity - Int
|
|
purchase_order - PurchaseOrder
|
Example
{
"request_id": "xyz789",
"complexity": 987,
"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": "xyz789",
"exchange_items": [CreateExchangeItem]
}
CreateReturnExchangeOutput
Fields
| Field Name | Description |
|---|---|
request_id - String
|
|
complexity - Int
|
|
return_exchange - ReturnExchange
|
Example
{
"request_id": "xyz789",
"complexity": 987,
"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]!
|
|
email_customer_return_label - Boolean
|
|
tracking_number - String
|
If a label was generated outside of ShipHero, you can send us that tracking number so we can create a generic label with it and assign it to the return. |
create_label - Boolean
|
If you want us to generate a label for the return |
partner_id - String
|
|
display_issue_refund - Boolean
|
If the user can have access to the refund form |
return_pickup_datetime - DateTime
|
If a scheduled return is needed |
Example
{
"customer_account_id": "abc123",
"order_id": "abc123",
"warehouse_id": "abc123",
"return_reason": "xyz789",
"label_type": "FREE",
"label_cost": "xyz789",
"address": AddressInput,
"dimensions": DimensionsInput,
"shipping_carrier": "abc123",
"shipping_method": "xyz789",
"line_items": [CreateReturnLineItemInput],
"email_customer_return_label": false,
"tracking_number": "abc123",
"create_label": true,
"partner_id": "xyz789",
"display_issue_refund": false,
"return_pickup_datetime": "2007-12-03T10:15:30Z"
}
CreateReturnItemExchangeInput
CreateReturnLineItemInput
Example
{
"sku": "xyz789",
"quantity": 987,
"return_reason": "abc123",
"condition": "xyz789",
"is_component": true,
"exchange_items": [CreateReturnItemExchangeInput]
}
CreateReturnOutput
CreateShipmentInput
Fields
| Input Field | Description |
|---|---|
customer_account_id - String
|
Use this when you are a 3PL acting on behalf of one of your customers |
order_id - String!
|
|
warehouse_id - String!
|
|
address - AddressInput!
|
|
line_items - [CreateShipmentLineItemInput]!
|
|
labels - [CreateShipmentShippingLabelInput]
|
|
notify_customer_via_shiphero - Boolean
|
|
notify_customer_via_store - Boolean
|
|
shipped_off_shiphero - Boolean
|
|
profile - String
|
Example
{
"customer_account_id": "xyz789",
"order_id": "abc123",
"warehouse_id": "abc123",
"address": AddressInput,
"line_items": [CreateShipmentLineItemInput],
"labels": [CreateShipmentShippingLabelInput],
"notify_customer_via_shiphero": false,
"notify_customer_via_store": true,
"shipped_off_shiphero": false,
"profile": "abc123"
}
CreateShipmentLineItemInput
CreateShipmentOutput
CreateShipmentShippingLabelInput
Fields
| Input Field | Description |
|---|---|
carrier - String!
|
|
shipping_name - String!
|
|
shipping_method - String!
|
|
cost - String!
|
|
address - AddressInput!
|
|
dimensions - DimensionsInput!
|
|
label - CreateLabelResourceInput!
|
|
line_item_ids - [String]!
|
Specify the line items that should be associated with the label been created. The ids can be shipment line item ids or order line item ids (the ones used to create the shipment line items) |
tracking_number - String
|
|
tracking_url - String
|
Example
{
"carrier": "xyz789",
"shipping_name": "abc123",
"shipping_method": "abc123",
"cost": "xyz789",
"address": AddressInput,
"dimensions": DimensionsInput,
"label": CreateLabelResourceInput,
"line_item_ids": ["xyz789"],
"tracking_number": "xyz789",
"tracking_url": "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": "abc123",
"carrier": "abc123",
"shipping_name": "xyz789",
"shipping_method": "abc123",
"cost": "xyz789",
"address": AddressInput,
"dimensions": DimensionsInput,
"label": CreateLabelResourceInput,
"line_item_ids": ["xyz789"],
"tracking_number": "xyz789",
"shipment_id": "abc123"
}
CreateShippingLabelOutput
Fields
| Field Name | Description |
|---|---|
request_id - String
|
|
complexity - Int
|
|
shipping_label - ShippingLabel
|
Example
{
"request_id": "abc123",
"complexity": 123,
"shipping_label": ShippingLabel
}
CreateShippingLinesInput
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": "abc123",
"shipping_price": "xyz789",
"total_price": "abc123",
"warehouse_id": "xyz789",
"warehouse_note": "xyz789",
"vendor_po_number": "xyz789",
"line_items": [LineItemInput],
"packages": [PackageInput],
"pallet": PalletData
}
CreateShippingPlanOutput
Fields
| Field Name | Description |
|---|---|
request_id - String
|
|
complexity - Int
|
|
shipping_plan - ShippingPlan
|
Example
{
"request_id": "abc123",
"complexity": 987,
"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": "xyz789",
"address": AddressInput,
"currency": "xyz789",
"internal_note": "abc123",
"default_po_note": "abc123",
"logo": "abc123",
"partner_vendor_id": 987
}
CreateVendorOutput
CreateWarehouseProductInput
Fields
| Input Field | Description |
|---|---|
warehouse_id - String!
|
|
on_hand - Int!
|
|
inventory_bin - String
|
|
inventory_overstock_bin - String
|
|
reserve_inventory - Int
|
|
replenishment_level - Int
|
|
replenishment_max_level - Int
|
|
replenishment_increment - Int
|
|
reorder_level - Int
|
|
reorder_amount - Int
|
|
price - String
|
|
custom - Boolean
|
|
warehouse - String
|
|
value - String
|
|
value_currency - String
|
Example
{
"warehouse_id": "abc123",
"on_hand": 987,
"inventory_bin": "xyz789",
"inventory_overstock_bin": "xyz789",
"reserve_inventory": 123,
"replenishment_level": 123,
"replenishment_max_level": 987,
"replenishment_increment": 123,
"reorder_level": 123,
"reorder_amount": 123,
"price": "abc123",
"custom": true,
"warehouse": "xyz789",
"value": "xyz789",
"value_currency": "xyz789"
}
CreateWebhookInput
CreateWebhookOutput
CreateWholesaleLineItemInput
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 |
unit_of_measure - String
|
Example
{
"sku": "abc123",
"partner_line_item_id": "abc123",
"quantity": 123,
"price": "xyz789",
"product_name": "xyz789",
"option_title": "xyz789",
"fulfillment_status": "abc123",
"quantity_pending_fulfillment": 123,
"custom_options": GenericScalar,
"custom_barcode": "xyz789",
"eligible_for_return": false,
"customs_value": "xyz789",
"barcode": "abc123",
"warehouse_id": "xyz789",
"unit_of_measure": "xyz789"
}
CreateWholesaleOrderInput
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
|
|
total_discounts - String
|
|
box_name - String
|
|
currency - String
|
|
ready_to_ship - Boolean
|
|
insurance_amount - Decimal
|
|
shipping_lines - CreateShippingLinesInput
|
|
shipping_address - CreateOrderAddressInput!
|
|
billing_address - CreateOrderAddressInput
|
|
from_name - String
|
|
tags - [String]
|
|
line_items - [CreateWholesaleLineItemInput]
|
|
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
|
|
do_not_print_invoice - Boolean
|
|
ignore_payment_capture_errors - Boolean
|
|
shipping_option - WholesaleShippingOptions
|
|
staging_location_id - Int
|
|
picking_flow - WholesaleOrderPickingFlow
|
|
outbound_progress - WholesaleOrderOutboundProgress
|
|
pickup_date - ISODateTime
|
|
preparation_date - ISODateTime
|
|
order_type - String
|
|
gs1_labels_required - Boolean
|
|
trading_partner_id - String
|
|
trading_partner_name - String
|
|
store_location_number - String
|
|
distribution_center - String
|
|
vendor - String
|
|
vendor_id - String
|
|
requested_delivery_date - ISODateTime
|
|
ship_not_before_date - ISODateTime
|
|
ship_no_later_than_date - ISODateTime
|
|
depositor_order_number - String
|
|
department - String
|
|
division - String
|
|
service_level - String
|
|
internal_supplier_number - String
|
|
terms_of_sale - String
|
|
retailer_notes - String
|
|
quote_number - String
|
|
sales_requirement_code - String
|
|
reference_fields - JSONObjectScalar
|
|
wholesale_shipping_details - WholesaleShippingDetailsInput
|
The shipping details to be used to create a new wholesale order |
Example
{
"customer_account_id": "xyz789",
"order_number": "xyz789",
"partner_order_id": "xyz789",
"shop_name": "xyz789",
"fulfillment_status": "abc123",
"order_date": ISODateTime,
"total_tax": "abc123",
"total_discounts": "xyz789",
"box_name": "xyz789",
"currency": "abc123",
"ready_to_ship": false,
"insurance_amount": Decimal,
"shipping_lines": CreateShippingLinesInput,
"shipping_address": CreateOrderAddressInput,
"billing_address": CreateOrderAddressInput,
"from_name": "xyz789",
"tags": ["xyz789"],
"line_items": [CreateWholesaleLineItemInput],
"gift_note": "abc123",
"gift_invoice": false,
"require_signature": true,
"adult_signature_required": false,
"alcohol": false,
"insurance": true,
"allow_partial": false,
"allow_split": false,
"custom_invoice_url": "abc123",
"email": "abc123",
"profile": "xyz789",
"packing_note": "abc123",
"required_ship_date": ISODateTime,
"auto_print_return_label": true,
"hold_until_date": ISODateTime,
"incoterms": "xyz789",
"tax_id": "abc123",
"tax_type": "xyz789",
"flagged": false,
"saturday_delivery": false,
"ignore_address_validation_errors": true,
"skip_address_validation": false,
"priority_flag": true,
"allocation_priority": 123,
"holds": HoldsInput,
"dry_ice_weight_in_lbs": "abc123",
"ftr_exemption": Decimal,
"address_is_business": false,
"do_not_print_invoice": false,
"ignore_payment_capture_errors": false,
"shipping_option": "COURIER",
"staging_location_id": 123,
"picking_flow": "DESKTOP",
"outbound_progress": "AWAITING_SCHEDULE",
"pickup_date": ISODateTime,
"preparation_date": ISODateTime,
"order_type": "xyz789",
"gs1_labels_required": true,
"trading_partner_id": "xyz789",
"trading_partner_name": "xyz789",
"store_location_number": "abc123",
"distribution_center": "xyz789",
"vendor": "abc123",
"vendor_id": "xyz789",
"requested_delivery_date": ISODateTime,
"ship_not_before_date": ISODateTime,
"ship_no_later_than_date": ISODateTime,
"depositor_order_number": "xyz789",
"department": "xyz789",
"division": "xyz789",
"service_level": "xyz789",
"internal_supplier_number": "abc123",
"terms_of_sale": "xyz789",
"retailer_notes": "abc123",
"quote_number": "xyz789",
"sales_requirement_code": "xyz789",
"reference_fields": JSONObjectScalar,
"wholesale_shipping_details": WholesaleShippingDetailsInput
}
CreateWorkOrderInput
Fields
| Input Field | Description |
|---|---|
customer_account_id - String
|
Use this when you are a 3PL acting on behalf of one of your customers |
warehouse_id - String!
|
|
requested_date - DateTime!
|
|
name - String
|
|
packing_details - String
|
|
assembly_details - String
|
|
type - WorkOrderType!
|
|
instructions - String
|
|
create_special_project - Boolean
|
|
priority - WorkOrderPriority
|
|
attachments - [WorkOrderAttachmentType]
|
|
assembly_sku - AssemblySKUType
|
Example
{
"customer_account_id": "abc123",
"warehouse_id": "xyz789",
"requested_date": "2007-12-03T10:15:30Z",
"name": "abc123",
"packing_details": "xyz789",
"assembly_details": "abc123",
"type": "ASSEMBLY",
"instructions": "abc123",
"create_special_project": true,
"priority": "HIGH",
"attachments": [WorkOrderAttachmentType],
"assembly_sku": AssemblySKUType
}
CurrentUserQueryResult
DataExportFile
Fields
| Field Name | Description |
|---|---|
table_name - String
|
Name of the table/dataset |
signed_url - String
|
Signed URL to download the file |
created_at - ISODateTime
|
|
size - Int
|
Size of the file in bytes |
Example
{
"table_name": "xyz789",
"signed_url": "abc123",
"created_at": ISODateTime,
"size": 987
}
Date
Description
The Date scalar type represents a Date value as specified by iso8601.
Example
"2007-12-03"
DateTime
Description
The DateTime scalar type represents a DateTime value as specified by iso8601.
Example
"2007-12-03T10:15:30Z"
Decimal
Description
The Decimal scalar type represents a python Decimal.
Example
Decimal
DeleteBillInput
DeleteLotInput
Description
GraphQL input type for Lot delete.
Fields
| Input Field | Description |
|---|---|
lot_id - String!
|
Example
{"lot_id": "xyz789"}
DeleteLotOutput
DeleteProductInput
DeleteVendorInput
DeleteWarehouseProductInput
DeleteWebhookInput
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": "abc123",
"width": "abc123",
"length": "xyz789"
}
EntityType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Account"
FbaInventory
FeeCategoryTotal
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
FulfillOrderInput
Fields
| Input Field | Description |
|---|---|
customer_account_id - String
|
Use this when you are a 3PL acting on behalf of one of your customers |
order_id - String!
|
The id of the order you want to modify |
tote_id - String!
|
|
packages - [ShippedPackagesInput]!
|
|
notify_customer_via_shiphero - Boolean
|
|
notify_customer_via_store - Boolean
|
|
shipped_off_shiphero - Boolean
|
|
note - String
|
Example
{
"customer_account_id": "abc123",
"order_id": "abc123",
"tote_id": "xyz789",
"packages": [ShippedPackagesInput],
"notify_customer_via_shiphero": false,
"notify_customer_via_store": true,
"shipped_off_shiphero": false,
"note": "abc123"
}
FulfillWholesaleOrderInput
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
|
|
inbound_shipping_items - FulfillmentInvoiceInboundShippingItemConnection
|
|
returns_items - FulfillmentInvoiceReturnItemConnection
|
|
storage_items - FulfillmentInvoiceStorageItemConnection
|
|
Example
{
"id": "abc123",
"legacy_id": 987,
"stripe_charge_id": "abc123",
"stripe_invoice_id": "xyz789",
"stripe_invoice_number": "xyz789",
"stripe_invoice_status": "xyz789",
"stripe_invoice_url": "abc123",
"stripe_next_payment_attempt": ISODateTime,
"account_id": "xyz789",
"cc_info": "abc123",
"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": "xyz789"
}
FulfillmentInvoiceInboundShippingItem
Example
{
"id": "abc123",
"legacy_id": 123,
"account_id": "xyz789",
"invoice_id": "abc123",
"purchase_order_id": "xyz789",
"shipment_id": "xyz789",
"shipping_label_id": "abc123",
"amount": "abc123",
"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
Example
{
"id": "abc123",
"legacy_id": 123,
"account_id": "abc123",
"invoice_id": "xyz789",
"order_id": "xyz789",
"rma_id": "abc123",
"rma_label_id": "abc123",
"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"
}
FulfillmentInvoiceShippingItem
Example
{
"id": "abc123",
"legacy_id": 987,
"account_id": "abc123",
"invoice_id": "xyz789",
"order_id": "abc123",
"shipment_id": "xyz789",
"shipping_label_id": "xyz789",
"amount": "xyz789",
"shipping_rate": "abc123",
"processing_fee": "abc123",
"picking_fee": "xyz789",
"overcharge_fee": "xyz789",
"created_at": ISODateTime
}
FulfillmentInvoiceShippingItemConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination data for this connection. |
edges - [FulfillmentInvoiceShippingItemEdge]!
|
Contains the nodes in this connection. |
Example
{
"pageInfo": PageInfo,
"edges": [FulfillmentInvoiceShippingItemEdge]
}
FulfillmentInvoiceShippingItemEdge
Description
A Relay edge containing a FulfillmentInvoiceShippingItem and its cursor.
Fields
| Field Name | Description |
|---|---|
node - FulfillmentInvoiceShippingItem
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": FulfillmentInvoiceShippingItem,
"cursor": "xyz789"
}
FulfillmentInvoiceStorageItem
Example
{
"id": "abc123",
"legacy_id": 987,
"account_id": "abc123",
"warehouse_id": "abc123",
"invoice_id": "xyz789",
"amount": "abc123",
"created_at": ISODateTime
}
FulfillmentInvoiceStorageItemConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination data for this connection. |
edges - [FulfillmentInvoiceStorageItemEdge]!
|
Contains the nodes in this connection. |
Example
{
"pageInfo": PageInfo,
"edges": [FulfillmentInvoiceStorageItemEdge]
}
FulfillmentInvoiceStorageItemEdge
Description
A Relay edge containing a FulfillmentInvoiceStorageItem and its cursor.
Fields
| Field Name | Description |
|---|---|
node - FulfillmentInvoiceStorageItem
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": FulfillmentInvoiceStorageItem,
"cursor": "xyz789"
}
FulfillmentInvoicesQueryResult
GenericScalar
Description
The GenericScalar scalar type represents a generic GraphQL scalar value that could be: String, Boolean, Int, Float, List or Object.
Example
GenericScalar
HoldsInput
HospitalAllocationType
Fields
| Field Name | Description |
|---|---|
quantity - Int
|
|
status - PickingJobStatus
|
Example
{"quantity": 123, "status": "DRAFT"}
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
"4"
ISODateTime
Description
A DateTime field type that understand ISO 8601 strings, besides datetime objects. It supports strings with and without times, as well as using T or space as delimiter
Ex.
- YYYY-mm-dd
- YYYY-mm-dd HH:MM:SS
- YYYY-mm-ddTHH:MM:SS
Example
ISODateTime
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
987
InventoryAbortSnapshotInput
InventoryChange
Fields
| Field Name | Description |
|---|---|
id - String
|
|
legacy_id - Int
|
For customers that transitioned from static slotting to dynamic slotting, there can be multiple records with the same legacy_id, please use the id field instead |
user_id - String
|
|
account_id - String
|
|
warehouse_id - String
|
|
sku - String
|
|
previous_on_hand - Int
|
|
change_in_on_hand - Int
|
|
reason - String
|
|
cycle_counted - Boolean
|
|
location_id - String
|
|
lot_id - String
|
|
lot_name - String
|
|
lot_expiration - String
|
|
created_at - ISODateTime
|
|
product - Product
|
|
location - Location
|
Example
{
"id": "abc123",
"legacy_id": 123,
"user_id": "abc123",
"account_id": "abc123",
"warehouse_id": "abc123",
"sku": "xyz789",
"previous_on_hand": 987,
"change_in_on_hand": 123,
"reason": "xyz789",
"cycle_counted": false,
"location_id": "xyz789",
"lot_id": "xyz789",
"lot_name": "abc123",
"lot_expiration": "xyz789",
"created_at": ISODateTime,
"product": Product,
"location": Location
}
InventoryChangeConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination data for this connection. |
edges - [InventoryChangeEdge]!
|
Contains the nodes in this connection. |
Example
{
"pageInfo": PageInfo,
"edges": [InventoryChangeEdge]
}
InventoryChangeEdge
Description
A Relay edge containing a InventoryChange and its cursor.
Fields
| Field Name | Description |
|---|---|
node - InventoryChange
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": InventoryChange,
"cursor": "xyz789"
}
InventoryChangesQueryResult
InventoryGenerateSnapshotInput
Fields
| Input Field | Description |
|---|---|
customer_account_id - String
|
Use this when you are a 3PL acting on behalf of one of your customers |
warehouse_id - String
|
|
notification_email - String
|
|
post_url - String
|
|
post_url_pre_check - Boolean
|
If false, a pre-check on the POST URL will not be performed. This eliminates immediate validation and feedback in the mutation response, before sending the request to the worker. Nonetheless, disabling this check can be useful if a one-time token is used to authenticate the endpoint. |
new_format - Boolean
|
If True, the snapshot structure will be organized by customer account id, rather than by SKU alone, adding support for different customer accounts having repeated SKUs. |
updated_from - ISODateTime
|
to filter out products updated since that time |
has_inventory - Boolean
|
to filter out products that don't have inventory |
Example
{
"customer_account_id": "abc123",
"warehouse_id": "xyz789",
"notification_email": "xyz789",
"post_url": "abc123",
"post_url_pre_check": true,
"new_format": false,
"updated_from": ISODateTime,
"has_inventory": false
}
InventorySnapshot
Fields
| Field Name | Description |
|---|---|
snapshot_id - String
|
|
job_user_id - String
|
|
job_account_id - String
|
|
warehouse_id - String
|
|
customer_account_id - String
|
|
notification_email - String
|
|
email_error - String
|
|
post_url - String
|
|
post_error - String
|
|
post_url_pre_check - Boolean
|
|
status - String
|
|
error - String
|
|
created_at - ISODateTime
|
|
enqueued_at - ISODateTime
|
|
updated_at - ISODateTime
|
|
snapshot_url - String
|
|
snapshot_expiration - ISODateTime
|
|
new_format - Boolean
|
Example
{
"snapshot_id": "abc123",
"job_user_id": "xyz789",
"job_account_id": "xyz789",
"warehouse_id": "xyz789",
"customer_account_id": "abc123",
"notification_email": "abc123",
"email_error": "abc123",
"post_url": "abc123",
"post_error": "abc123",
"post_url_pre_check": false,
"status": "abc123",
"error": "abc123",
"created_at": ISODateTime,
"enqueued_at": ISODateTime,
"updated_at": ISODateTime,
"snapshot_url": "abc123",
"snapshot_expiration": ISODateTime,
"new_format": false
}
InventorySnapshotConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination data for this connection. |
edges - [InventorySnapshotEdge]!
|
Contains the nodes in this connection. |
Example
{
"pageInfo": PageInfo,
"edges": [InventorySnapshotEdge]
}
InventorySnapshotEdge
Description
A Relay edge containing a InventorySnapshot and its cursor.
Fields
| Field Name | Description |
|---|---|
node - InventorySnapshot
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": InventorySnapshot,
"cursor": "xyz789"
}
InventorySnapshotOutput
Fields
| Field Name | Description |
|---|---|
request_id - String
|
|
complexity - Int
|
|
snapshot - InventorySnapshot
|
Example
{
"request_id": "abc123",
"complexity": 123,
"snapshot": InventorySnapshot
}
InventorySnapshotQueryResult
Fields
| Field Name | Description |
|---|---|
request_id - String
|
|
complexity - Int
|
|
snapshot - InventorySnapshot
|
Example
{
"request_id": "abc123",
"complexity": 123,
"snapshot": InventorySnapshot
}
InventorySnapshotsQueryResult
InventorySyncBatchQueryResult
Fields
| Field Name | Description |
|---|---|
request_id - String
|
|
complexity - Int
|
|
data - InventorySyncStatus
|
Example
{
"request_id": "xyz789",
"complexity": 987,
"data": InventorySyncStatus
}
InventorySyncBatchesQueryResult
InventorySyncInput
InventorySyncItemStatus
Example
{
"id": "xyz789",
"row": 123,
"sku": "abc123",
"quantity": 987,
"action": "abc123",
"reason": "abc123",
"location": 987,
"status": "xyz789",
"error": "abc123",
"created_at": ISODateTime,
"updated_at": ISODateTime
}
InventorySyncItemStatusConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination data for this connection. |
edges - [InventorySyncItemStatusEdge]!
|
Contains the nodes in this connection. |
Example
{
"pageInfo": PageInfo,
"edges": [InventorySyncItemStatusEdge]
}
InventorySyncItemStatusEdge
Description
A Relay edge containing a InventorySyncItemStatus and its cursor.
Fields
| Field Name | Description |
|---|---|
node - InventorySyncItemStatus
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": InventorySyncItemStatus,
"cursor": "xyz789"
}
InventorySyncOutput
InventorySyncRowsQueryResult
InventorySyncStatus
Fields
| Field Name | Description |
|---|---|
id - String
|
|
url - String
|
|
user_id - String
|
|
account_id - String
|
|
warehouse_id - String
|
|
customer_account_id - String
|
|
total_count - Int
|
|
status - String
|
|
error - String
|
|
created_at - ISODateTime
|
|
updated_at - ISODateTime
|
|
success_count - Int
|
|
error_count - Int
|
|
finished_count - Int
|
Example
{
"id": "abc123",
"url": "abc123",
"user_id": "abc123",
"account_id": "xyz789",
"warehouse_id": "abc123",
"customer_account_id": "xyz789",
"total_count": 123,
"status": "abc123",
"error": "xyz789",
"created_at": ISODateTime,
"updated_at": ISODateTime,
"success_count": 987,
"error_count": 987,
"finished_count": 123
}
InventorySyncStatusConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination data for this connection. |
edges - [InventorySyncStatusEdge]!
|
Contains the nodes in this connection. |
Example
{
"pageInfo": PageInfo,
"edges": [InventorySyncStatusEdge]
}
InventorySyncStatusEdge
Description
A Relay edge containing a InventorySyncStatus and its cursor.
Fields
| Field Name | Description |
|---|---|
node - InventorySyncStatus
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": InventorySyncStatus,
"cursor": "xyz789"
}
ItemLocation
Example
{
"id": "xyz789",
"legacy_id": 123,
"account_id": "abc123",
"warehouse_id": "abc123",
"location_id": "xyz789",
"sku": "abc123",
"quantity": 123,
"created_at": ISODateTime,
"location": Location,
"expiration_lot": Lot
}
ItemLocationConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination data for this connection. |
edges - [ItemLocationEdge]!
|
Contains the nodes in this connection. |
Example
{
"pageInfo": PageInfo,
"edges": [ItemLocationEdge]
}
ItemLocationEdge
Description
A Relay edge containing a ItemLocation and its cursor.
Fields
| Field Name | Description |
|---|---|
node - ItemLocation
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": ItemLocation,
"cursor": "xyz789"
}
JSONObjectScalar
Description
Custom scalar type for JSON objects only. This field will serialize Python dict objects to JSON strings, and deserialize JSON strings to Python dict objects. It will accept None and empty strings, and otherwise ensure the JSON value is an object.
Example
JSONObjectScalar
KitComponent
LabelResource
LakeheroDataExport
Fields
| Field Name | Description |
|---|---|
files - [DataExportFile]
|
List of export files with signed URLs |
expires_at - String
|
Expiration timestamp of the URLs |
Example
{
"files": [DataExportFile],
"expires_at": "abc123"
}
LakeheroDataExportQueryResult
Fields
| Field Name | Description |
|---|---|
request_id - String
|
|
complexity - Int
|
|
data - LakeheroDataExport
|
Example
{
"request_id": "xyz789",
"complexity": 987,
"data": LakeheroDataExport
}
LastMileLabel
Example
{
"id": "xyz789",
"legacy_id": 987,
"shipping_carrier": "abc123",
"shipping_method": "abc123",
"tracking_number": "abc123",
"tracking_url": "abc123"
}
LegacyId
LegacyIdQueryResult
LineItem
Fields
| Field Name | Description |
|---|---|
id - String
|
|
legacy_id - Int
|
|
sku - String
|
|
partner_line_item_id - String
|
|
product_id - String
|
Products should be referenced by sku |
quantity - Int
|
|
price - String
|
|
product_name - String
|
|
option_title - String
|
|
fulfillment_status - String
|
|
quantity_pending_fulfillment - Int
|
|
quantity_shipped - Int
|
|
warehouse - String
|
|
quantity_allocated - Int
|
|
backorder_quantity - Int
|
|
custom_options - GenericScalar
|
|
custom_barcode - String
|
|
eligible_for_return - Boolean
|
|
customs_value - String
|
|
warehouse_id - String
|
Use order allocations instead |
locked_to_warehouse_id - String
|
This field was deprecated on accounts with Multi Warehouse Allocation rules |
subtotal - String
|
|
barcode - String
|
|
created_at - ISODateTime
|
|
updated_at - ISODateTime
|
|
order_id - String
|
|
shipped_line_item_lots - [ShippedLineItemLot]
|
|
serial_numbers - [LineItemSerialNumber]
|
|
promotion_discount - String
|
|
product - Product
|
|
tote_picks - [TotePick]
|
Example
{
"id": "abc123",
"legacy_id": 987,
"sku": "abc123",
"partner_line_item_id": "xyz789",
"product_id": "xyz789",
"quantity": 123,
"price": "abc123",
"product_name": "abc123",
"option_title": "abc123",
"fulfillment_status": "xyz789",
"quantity_pending_fulfillment": 987,
"quantity_shipped": 987,
"warehouse": "abc123",
"quantity_allocated": 987,
"backorder_quantity": 987,
"custom_options": GenericScalar,
"custom_barcode": "xyz789",
"eligible_for_return": true,
"customs_value": "xyz789",
"warehouse_id": "xyz789",
"locked_to_warehouse_id": "xyz789",
"subtotal": "xyz789",
"barcode": "abc123",
"created_at": ISODateTime,
"updated_at": ISODateTime,
"order_id": "abc123",
"shipped_line_item_lots": [ShippedLineItemLot],
"serial_numbers": [LineItemSerialNumber],
"promotion_discount": "xyz789",
"product": Product,
"tote_picks": [TotePick]
}
LineItemInput
LineItemQuerySpecConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination data for this connection. |
edges - [LineItemQuerySpecEdge]!
|
Contains the nodes in this connection. |
total_count - Int
|
Example
{
"pageInfo": PageInfo,
"edges": [LineItemQuerySpecEdge],
"total_count": 123
}
LineItemQuerySpecEdge
LineItemSerialNumber
Fields
| Field Name | Description |
|---|---|
id - String
|
|
legacy_id - Int
|
|
sku - String
|
|
line_item_id - String
|
|
serial_number - String
|
|
scanned - Boolean
|
|
created_at - ISODateTime
|
|
updated_at - ISODateTime
|
Example
{
"id": "xyz789",
"legacy_id": 987,
"sku": "xyz789",
"line_item_id": "abc123",
"serial_number": "xyz789",
"scanned": false,
"created_at": ISODateTime,
"updated_at": ISODateTime
}
Location
Fields
| Field Name | Description |
|---|---|
id - String
|
|
legacy_id - Int
|
|
account_id - String
|
|
warehouse_id - String
|
|
type - LocationType
|
|
name - String
|
|
zone - String
|
|
pickable - Boolean
|
|
sellable - Boolean
|
|
is_cart - Boolean
|
|
pick_priority - Int
|
|
dimensions - Dimensions
|
|
length - String
|
Not used anymore. Use dimensions |
width - String
|
Not used anymore. Use dimensions |
height - String
|
Not used anymore. Use dimensions |
max_weight - String
|
Not used anymore. Use dimensions |
temperature - String
|
|
products - ProductConnection
|
|
last_counted - ISODateTime
|
|
created_at - ISODateTime
|
|
expiration_lots - LotConnection
|
|
Example
{
"id": "abc123",
"legacy_id": 123,
"account_id": "abc123",
"warehouse_id": "abc123",
"type": LocationType,
"name": "xyz789",
"zone": "xyz789",
"pickable": true,
"sellable": false,
"is_cart": false,
"pick_priority": 123,
"dimensions": Dimensions,
"length": "xyz789",
"width": "abc123",
"height": "abc123",
"max_weight": "xyz789",
"temperature": "xyz789",
"products": ProductConnection,
"last_counted": ISODateTime,
"created_at": ISODateTime,
"expiration_lots": LotConnection
}
LocationConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination data for this connection. |
edges - [LocationEdge]!
|
Contains the nodes in this connection. |
Example
{
"pageInfo": PageInfo,
"edges": [LocationEdge]
}
LocationEdge
LocationOutput
LocationQueryResult
LocationType
Example
{
"id": "abc123",
"legacy_id": 987,
"account_id": "xyz789",
"name": "xyz789",
"daily_storage_cost": "xyz789",
"category": "xyz789",
"is_lpn_allowed": false
}
LocationsQueryResult
Lot
Fields
| Field Name | Description |
|---|---|
id - String
|
|
legacy_id - Int
|
|
account_id - String
|
|
po_id - String
|
An expiration lot could have more than one purchase order associated. Check purchase_orders field. |
name - String
|
|
sku - String
|
|
created_at - ISODateTime
|
|
updated_at - ISODateTime
|
|
expires_at - ISODateTime
|
|
received_at - ISODateTime
|
|
is_active - Boolean
|
|
locations - LocationConnection
|
|
purchase_orders - PurchaseOrderConnection
|
|
Example
{
"id": "xyz789",
"legacy_id": 987,
"account_id": "abc123",
"po_id": "abc123",
"name": "xyz789",
"sku": "xyz789",
"created_at": ISODateTime,
"updated_at": ISODateTime,
"expires_at": ISODateTime,
"received_at": ISODateTime,
"is_active": true,
"locations": LocationConnection,
"purchase_orders": PurchaseOrderConnection
}
LotConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination data for this connection. |
edges - [LotEdge]!
|
Contains the nodes in this connection. |
Example
{
"pageInfo": PageInfo,
"edges": [LotEdge]
}
LotEdge
LotsQueryResult
MergeOrdersInput
MergeOrdersOutput
MergeableOrder
Fields
| Field Name | Description |
|---|---|
id - String
|
|
legacy_id - Int
|
|
order_number - String
|
The store's internal order number |
partner_order_id - String
|
The order ID assigned by the storefront |
shop_name - String
|
|
fulfillment_status - String
|
Status of the order (pending, fulfilled, cancelled, etc) |
order_date - ISODateTime
|
|
total_tax - String
|
|
subtotal - String
|
|
total_discounts - String
|
|
total_price - String
|
|
box_name - String
|
|
ready_to_ship - Boolean
|
This field is no longer being updated and should not be used or relied on |
auto_print_return_label - Boolean
|
|
custom_invoice_url - String
|
|
account_id - String
|
|
updated_at - ISODateTime
|
|
created_at - ISODateTime
|
|
email - String
|
|
profile - String
|
|
gift_note - String
|
|
packing_note - String
|
|
required_ship_date - ISODateTime
|
|
shipping_lines - ShippingLines
|
|
shipping_address - OrderAddress
|
|
billing_address - OrderAddress
|
|
tags - [String]
|
|
line_items - LineItemQuerySpecConnection
|
|
authorizations - [Authorization]
|
|
holds - OrderHolds
|
|
shipments - [Shipment]
|
|
returns - [Return]
|
|
rma_labels - [RMALabel]
|
|
flagged - Boolean
|
|
saturday_delivery - Boolean
|
|
ignore_address_validation_errors - Boolean
|
|
skip_address_validation - Boolean
|
|
priority_flag - Boolean
|
|
allocation_priority - Int
|
|
allocations - [OrderWarehouseAllocation]
|
|
source - String
|
|
third_party_shipper - OrderThirdPartyShipper
|
|
gift_invoice - Boolean
|
|
allow_partial - Boolean
|
|
require_signature - Boolean
|
|
adult_signature_required - Boolean
|
|
alcohol - Boolean
|
|
expected_weight_in_oz - String
|
|
insurance - Boolean
|
|
insurance_amount - String
|
|
currency - String
|
|
has_dry_ice - Boolean
|
|
allow_split - Boolean
|
|
hold_until_date - ISODateTime
|
|
incoterms - String
|
|
tax_id - String
|
|
tax_type - String
|
|
dry_ice_weight_in_lbs - String
|
|
ftr_exemption - Decimal
|
|
address_is_business - Boolean
|
|
do_not_print_invoice - Boolean
|
|
ignore_payment_capture_errors - Boolean
|
|
order_history - [OrderHistory]
|
|
merged_orders - [MergedOrder]
|
|
attachments - OrderAttachmentQuerySpecConnection
|
|
wholesale_order - WholesaleOrder
|
|
potential_merges - [Order]
|
|
Example
{
"id": "xyz789",
"legacy_id": 987,
"order_number": "abc123",
"partner_order_id": "xyz789",
"shop_name": "xyz789",
"fulfillment_status": "abc123",
"order_date": ISODateTime,
"total_tax": "abc123",
"subtotal": "xyz789",
"total_discounts": "xyz789",
"total_price": "xyz789",
"box_name": "abc123",
"ready_to_ship": false,
"auto_print_return_label": true,
"custom_invoice_url": "xyz789",
"account_id": "abc123",
"updated_at": ISODateTime,
"created_at": ISODateTime,
"email": "xyz789",
"profile": "xyz789",
"gift_note": "abc123",
"packing_note": "xyz789",
"required_ship_date": ISODateTime,
"shipping_lines": ShippingLines,
"shipping_address": OrderAddress,
"billing_address": OrderAddress,
"tags": ["abc123"],
"line_items": LineItemQuerySpecConnection,
"authorizations": [Authorization],
"holds": OrderHolds,
"shipments": [Shipment],
"returns": [Return],
"rma_labels": [RMALabel],
"flagged": true,
"saturday_delivery": true,
"ignore_address_validation_errors": true,
"skip_address_validation": false,
"priority_flag": false,
"allocation_priority": 987,
"allocations": [OrderWarehouseAllocation],
"source": "xyz789",
"third_party_shipper": OrderThirdPartyShipper,
"gift_invoice": true,
"allow_partial": false,
"require_signature": false,
"adult_signature_required": false,
"alcohol": false,
"expected_weight_in_oz": "abc123",
"insurance": true,
"insurance_amount": "xyz789",
"currency": "abc123",
"has_dry_ice": true,
"allow_split": false,
"hold_until_date": ISODateTime,
"incoterms": "xyz789",
"tax_id": "abc123",
"tax_type": "xyz789",
"dry_ice_weight_in_lbs": "abc123",
"ftr_exemption": Decimal,
"address_is_business": true,
"do_not_print_invoice": true,
"ignore_payment_capture_errors": false,
"order_history": [OrderHistory],
"merged_orders": [MergedOrder],
"attachments": OrderAttachmentQuerySpecConnection,
"wholesale_order": WholesaleOrder,
"potential_merges": [Order]
}
MergeableOrderConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination data for this connection. |
edges - [MergeableOrderEdge]!
|
Contains the nodes in this connection. |
Example
{
"pageInfo": PageInfo,
"edges": [MergeableOrderEdge]
}
MergeableOrderEdge
Description
A Relay edge containing a MergeableOrder and its cursor.
Fields
| Field Name | Description |
|---|---|
node - MergeableOrder
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": MergeableOrder,
"cursor": "xyz789"
}
MergeableOrdersQueryResult
Fields
| Field Name | Description |
|---|---|
request_id - String
|
|
complexity - Int
|
|
data - MergeableOrderConnection
|
|
Arguments
|
|
Example
{
"request_id": "abc123",
"complexity": 123,
"data": MergeableOrderConnection
}
MergedOrder
MissingAllocationType
Fields
| Field Name | Description |
|---|---|
message - String!
|
|
quantity - Int
|
|
status - PickingJobStatus
|
Example
{
"message": "xyz789",
"quantity": 123,
"status": "DRAFT"
}
Money
Example
Money
MutationOutput
Node
Description
An object with an ID
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the object |
Example
{"id": 4}
OperationError
Order
Fields
| Field Name | Description |
|---|---|
id - String
|
|
legacy_id - Int
|
|
order_number - String
|
The store's internal order number |
partner_order_id - String
|
The order ID assigned by the storefront |
shop_name - String
|
|
fulfillment_status - String
|
Status of the order (pending, fulfilled, cancelled, etc) |
order_date - ISODateTime
|
|
total_tax - String
|
|
subtotal - String
|
|
total_discounts - String
|
|
total_price - String
|
|
box_name - String
|
|
ready_to_ship - Boolean
|
This field is no longer being updated and should not be used or relied on |
auto_print_return_label - Boolean
|
|
custom_invoice_url - String
|
|
account_id - String
|
|
updated_at - ISODateTime
|
|
created_at - ISODateTime
|
|
email - String
|
|
profile - String
|
|
gift_note - String
|
|
packing_note - String
|
|
required_ship_date - ISODateTime
|
|
shipping_lines - ShippingLines
|
|
shipping_address - OrderAddress
|
|
billing_address - OrderAddress
|
|
tags - [String]
|
|
line_items - LineItemQuerySpecConnection
|
|
authorizations - [Authorization]
|
|
holds - OrderHolds
|
|
shipments - [Shipment]
|
|
returns - [Return]
|
|
rma_labels - [RMALabel]
|
|
flagged - Boolean
|
|
saturday_delivery - Boolean
|
|
ignore_address_validation_errors - Boolean
|
|
skip_address_validation - Boolean
|
|
priority_flag - Boolean
|
|
allocation_priority - Int
|
|
allocations - [OrderWarehouseAllocation]
|
|
source - String
|
|
third_party_shipper - OrderThirdPartyShipper
|
|
gift_invoice - Boolean
|
|
allow_partial - Boolean
|
|
require_signature - Boolean
|
|
adult_signature_required - Boolean
|
|
alcohol - Boolean
|
|
expected_weight_in_oz - String
|
|
insurance - Boolean
|
|
insurance_amount - String
|
|
currency - String
|
|
has_dry_ice - Boolean
|
|
allow_split - Boolean
|
|
hold_until_date - ISODateTime
|
|
incoterms - String
|
|
tax_id - String
|
|
tax_type - String
|
|
dry_ice_weight_in_lbs - String
|
|
ftr_exemption - Decimal
|
|
address_is_business - Boolean
|
|
do_not_print_invoice - Boolean
|
|
ignore_payment_capture_errors - Boolean
|
|
order_history - [OrderHistory]
|
|
merged_orders - [MergedOrder]
|
|
attachments - OrderAttachmentQuerySpecConnection
|
|
wholesale_order - WholesaleOrder
|
|
Example
{
"id": "abc123",
"legacy_id": 123,
"order_number": "abc123",
"partner_order_id": "abc123",
"shop_name": "abc123",
"fulfillment_status": "abc123",
"order_date": ISODateTime,
"total_tax": "xyz789",
"subtotal": "abc123",
"total_discounts": "abc123",
"total_price": "xyz789",
"box_name": "abc123",
"ready_to_ship": false,
"auto_print_return_label": true,
"custom_invoice_url": "abc123",
"account_id": "xyz789",
"updated_at": ISODateTime,
"created_at": ISODateTime,
"email": "xyz789",
"profile": "abc123",
"gift_note": "abc123",
"packing_note": "xyz789",
"required_ship_date": ISODateTime,
"shipping_lines": ShippingLines,
"shipping_address": OrderAddress,
"billing_address": OrderAddress,
"tags": ["xyz789"],
"line_items": LineItemQuerySpecConnection,
"authorizations": [Authorization],
"holds": OrderHolds,
"shipments": [Shipment],
"returns": [Return],
"rma_labels": [RMALabel],
"flagged": true,
"saturday_delivery": false,
"ignore_address_validation_errors": false,
"skip_address_validation": true,
"priority_flag": false,
"allocation_priority": 987,
"allocations": [OrderWarehouseAllocation],
"source": "xyz789",
"third_party_shipper": OrderThirdPartyShipper,
"gift_invoice": false,
"allow_partial": false,
"require_signature": false,
"adult_signature_required": true,
"alcohol": true,
"expected_weight_in_oz": "abc123",
"insurance": false,
"insurance_amount": "xyz789",
"currency": "xyz789",
"has_dry_ice": true,
"allow_split": false,
"hold_until_date": ISODateTime,
"incoterms": "abc123",
"tax_id": "xyz789",
"tax_type": "abc123",
"dry_ice_weight_in_lbs": "xyz789",
"ftr_exemption": Decimal,
"address_is_business": false,
"do_not_print_invoice": false,
"ignore_payment_capture_errors": true,
"order_history": [OrderHistory],
"merged_orders": [MergedOrder],
"attachments": OrderAttachmentQuerySpecConnection,
"wholesale_order": WholesaleOrder
}
OrderAddAttachmentInput
Example
{
"order_id": "xyz789",
"url": "http://www.test.com/",
"customer_account_id": "abc123",
"filename": "abc123",
"file_type": "abc123",
"description": "abc123"
}
OrderAddAttachmentOutput
Fields
| Field Name | Description |
|---|---|
request_id - String
|
|
complexity - Int
|
|
attachment - OrderAttachment
|
Example
{
"request_id": "xyz789",
"complexity": 123,
"attachment": OrderAttachment
}
OrderAddress
Description
Order type for addresses. Orders have addresses with more details than the rest of the system so we use our own types
Example
{
"first_name": "xyz789",
"last_name": "abc123",
"company": "abc123",
"address1": "abc123",
"address2": "xyz789",
"city": "abc123",
"state": "abc123",
"state_code": "xyz789",
"zip": "abc123",
"country": "abc123",
"country_code": "xyz789",
"email": "abc123",
"phone": "abc123"
}
OrderAttachment
Example
{
"id": "abc123",
"legacy_id": 123,
"order_id": "xyz789",
"account_id": "abc123",
"description": "xyz789",
"url": "abc123",
"filename": "abc123",
"file_type": "xyz789",
"file_size": 123,
"created_at": ISODateTime
}
OrderAttachmentQuerySpecConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination data for this connection. |
edges - [OrderAttachmentQuerySpecEdge]!
|
Contains the nodes in this connection. |
total_count - Int
|
Example
{
"pageInfo": PageInfo,
"edges": [OrderAttachmentQuerySpecEdge],
"total_count": 123
}
OrderAttachmentQuerySpecEdge
Description
A Relay edge containing a OrderAttachmentQuerySpec and its cursor.
Fields
| Field Name | Description |
|---|---|
node - OrderAttachment
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": OrderAttachment,
"cursor": "xyz789"
}
OrderConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination data for this connection. |
edges - [OrderEdge]!
|
Contains the nodes in this connection. |
Example
{
"pageInfo": PageInfo,
"edges": [OrderEdge]
}
OrderEdge
OrderHistory
Example
{
"id": "abc123",
"legacy_id": 987,
"order_id": "abc123",
"user_id": "xyz789",
"account_id": "abc123",
"username": "abc123",
"order_number": "xyz789",
"information": "xyz789",
"created_at": ISODateTime,
"order": Order
}
OrderHistoryConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination data for this connection. |
edges - [OrderHistoryEdge]!
|
Contains the nodes in this connection. |
Example
{
"pageInfo": PageInfo,
"edges": [OrderHistoryEdge]
}
OrderHistoryEdge
Description
A Relay edge containing a OrderHistory and its cursor.
Fields
| Field Name | Description |
|---|---|
node - OrderHistory
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": OrderHistory,
"cursor": "xyz789"
}
OrderHistoryQueryResult
OrderHolds
Example
{
"fraud_hold": true,
"address_hold": true,
"shipping_method_hold": true,
"operator_hold": true,
"payment_hold": true,
"client_hold": false
}
OrderLineItemAllocation
Example
{
"order_id": "xyz789",
"warehouse_id": "xyz789",
"allocated_at": ISODateTime,
"line_item_id": "xyz789",
"sku": "abc123",
"quantity_allocated": 123,
"is_kit_component": true,
"allocation_reference": "xyz789"
}
OrderMutationOutput
OrderQueryResult
OrderShipmentMutationOutput
OrderThirdPartyShipper
OrderWarehouseAllocation
Fields
| Field Name | Description |
|---|---|
order_id - String
|
|
warehouse_id - String
|
|
allocated_at - ISODateTime
|
|
allocation_reference - String
|
|
ready_to_ship - Boolean
|
|
line_items - [OrderLineItemAllocation]
|
|
is_locked - Boolean
|
Example
{
"order_id": "abc123",
"warehouse_id": "xyz789",
"allocated_at": ISODateTime,
"allocation_reference": "abc123",
"ready_to_ship": true,
"line_items": [OrderLineItemAllocation],
"is_locked": true
}
OrdersQueryResult
Package
Fields
| Field Name | Description |
|---|---|
id - String
|
|
legacy_id - Int
|
|
shipment_id - String
|
|
warehouse_id - String
|
|
order_id - String
|
|
order_number - String
|
|
user_id - String
|
|
user_first_name - String
|
|
user_last_name - String
|
|
total_items - Int
|
The sum of every shipped item's quantity in the package |
unique_items - Int
|
The number of unique shipped items in the package |
barcodes_scanned - Int
|
The nuber of barcodes scanned in the package |
created_at - ISODateTime
|
|
shipment - Shipment
|
|
order - Order
|
Example
{
"id": "abc123",
"legacy_id": 123,
"shipment_id": "xyz789",
"warehouse_id": "abc123",
"order_id": "abc123",
"order_number": "xyz789",
"user_id": "xyz789",
"user_first_name": "abc123",
"user_last_name": "abc123",
"total_items": 123,
"unique_items": 987,
"barcodes_scanned": 987,
"created_at": ISODateTime,
"shipment": Shipment,
"order": Order
}
PackageConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination data for this connection. |
edges - [PackageEdge]!
|
Contains the nodes in this connection. |
Example
{
"pageInfo": PageInfo,
"edges": [PackageEdge]
}
PackageEdge
PackageInput
Fields
| Input Field | Description |
|---|---|
line_items - [PackageLineItemInput]!
|
Example
{"line_items": [PackageLineItemInput]}
PackageLineItemInput
PacksPerDayQueryResult
PageInfo
Description
The Relay compliant PageInfo type, containing data necessary to paginate this connection.
Fields
| Field Name | Description |
|---|---|
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
endCursor - String
|
When paginating forwards, the cursor to continue. |
Example
{
"hasNextPage": true,
"hasPreviousPage": false,
"startCursor": "xyz789",
"endCursor": "abc123"
}
PalletData
Pick
Fields
| Field Name | Description |
|---|---|
id - String
|
|
legacy_id - Int
|
|
user_id - String
|
|
tote_id - String
|
|
line_item_id - String
|
|
pending_shipment_line_item_id - String
|
|
location_id - String
|
|
warehouse_id - String
|
|
order_id - String
|
|
order_number - String
|
|
user_first_name - String
|
|
user_last_name - String
|
|
inventory_bin - String
|
|
sku - String
|
|
quantity - Int
|
The number required |
picked_quantity - Int
|
The number that was picked |
pick_type - String
|
|
barcode_scanned - String
|
|
created_at - ISODateTime
|
|
line_item - LineItem
|
|
order - Order
|
Example
{
"id": "xyz789",
"legacy_id": 123,
"user_id": "abc123",
"tote_id": "abc123",
"line_item_id": "xyz789",
"pending_shipment_line_item_id": "abc123",
"location_id": "abc123",
"warehouse_id": "abc123",
"order_id": "abc123",
"order_number": "abc123",
"user_first_name": "xyz789",
"user_last_name": "abc123",
"inventory_bin": "abc123",
"sku": "xyz789",
"quantity": 123,
"picked_quantity": 123,
"pick_type": "xyz789",
"barcode_scanned": "abc123",
"created_at": ISODateTime,
"line_item": LineItem,
"order": Order
}
PickConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination data for this connection. |
edges - [PickEdge]!
|
Contains the nodes in this connection. |
Example
{
"pageInfo": PageInfo,
"edges": [PickEdge]
}
PickEdge
PickingJobStatus
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DRAFT"
PicksPerDayQueryResult
Product
Fields
| Field Name | Description |
|---|---|
id - String
|
|
legacy_id - Int
|
|
account_id - String
|
|
name - String
|
Name of the product |
sku - String
|
Stock Keeping Unit |
price - String
|
Price of the product This is a warehouse specific field |
value - String
|
Price paid for the product This is a warehouse specific field |
value_currency - String
|
This is a warehouse specific field |
barcode - String
|
Product barcode |
country_of_manufacture - String
|
|
dimensions - Dimensions
|
|
tariff_code - String
|
|
kit - Boolean
|
|
kit_build - Boolean
|
|
no_air - Boolean
|
|
final_sale - Boolean
|
|
customs_value - String
|
|
customs_description - String
|
|
not_owned - Boolean
|
|
dropship - Boolean
|
|
needs_serial_number - Boolean
|
|
thumbnail - String
|
|
large_thumbnail - String
|
|
created_at - ISODateTime
|
|
updated_at - ISODateTime
|
|
product_note - String
|
|
virtual - Boolean
|
|
ignore_on_invoice - Boolean
|
|
ignore_on_customs - Boolean
|
|
active - Boolean
|
This is a warehouse specific field |
needs_lot_tracking - Boolean
|
|
packer_note - String
|
|
vendor_part_number - String
|
|
consumer_package_code - String
|
|
buyer_part_number - String
|
|
buyer_style_number - String
|
|
warehouse_products - [WarehouseProduct]
|
The physical instances of the product, stored in warehouses |
fba_inventory - [FbaInventory]
|
Inventory available at FBA |
images - [ProductImage]
|
|
tags - [String]
|
|
vendors - [ProductVendor]
|
|
components - [Product]
|
For kits, this will be the list of products that make up the kit This has been replaced by kit_components |
kit_components - [KitComponent]
|
For kits, this will be the list of references to the products that make up the kit and their quantities |
cases - [Case]
|
Example
{
"id": "abc123",
"legacy_id": 987,
"account_id": "xyz789",
"name": "abc123",
"sku": "abc123",
"price": "abc123",
"value": "abc123",
"value_currency": "abc123",
"barcode": "xyz789",
"country_of_manufacture": "xyz789",
"dimensions": Dimensions,
"tariff_code": "abc123",
"kit": false,
"kit_build": false,
"no_air": true,
"final_sale": false,
"customs_value": "xyz789",
"customs_description": "abc123",
"not_owned": true,
"dropship": true,
"needs_serial_number": false,
"thumbnail": "xyz789",
"large_thumbnail": "abc123",
"created_at": ISODateTime,
"updated_at": ISODateTime,
"product_note": "abc123",
"virtual": false,
"ignore_on_invoice": true,
"ignore_on_customs": false,
"active": true,
"needs_lot_tracking": false,
"packer_note": "xyz789",
"vendor_part_number": "xyz789",
"consumer_package_code": "xyz789",
"buyer_part_number": "xyz789",
"buyer_style_number": "abc123",
"warehouse_products": [WarehouseProduct],
"fba_inventory": [FbaInventory],
"images": [ProductImage],
"tags": ["abc123"],
"vendors": [ProductVendor],
"components": [Product],
"kit_components": [KitComponent],
"cases": [Case]
}
ProductConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination data for this connection. |
edges - [ProductEdge]!
|
Contains the nodes in this connection. |
Example
{
"pageInfo": PageInfo,
"edges": [ProductEdge]
}
ProductEdge
ProductImage
ProductMutationOutput
ProductQueryResult
ProductVendor
ProductsQueryResult
PurchaseOrder
Fields
| Field Name | Description |
|---|---|
id - String
|
|
legacy_id - Int
|
|
po_number - String
|
|
account_id - String
|
|
warehouse_id - String
|
|
vendor_id - String
|
|
created_at - ISODateTime
|
|
po_date - ISODateTime
|
The expected date to arrive at the warehouse. |
date_closed - ISODateTime
|
|
arrived_at - ISODateTime
|
|
packing_note - String
|
|
fulfillment_status - String
|
|
po_note - String
|
|
description - String
|
|
partner_order_number - String
|
|
subtotal - String
|
|
discount - String
|
|
total_price - String
|
|
tax - String
|
|
shipping_method - String
|
|
shipping_carrier - String
|
|
shipping_name - String
|
|
shipping_price - String
|
|
tracking_number - String
|
|
pdf - String
|
|
images - String
|
|
payment_method - String
|
|
payment_due_by - String
|
|
payment_note - String
|
|
locking - String
|
|
locked_by_user_id - String
|
|
line_items - PurchaseOrderLineItemConnection
|
|
attachments - PurchaseOrderAttachmentConnection
|
|
vendor - Vendor
|
|
warehouse - Warehouse
|
|
origin_of_shipment - String
|
|
tracking_numbers - PurchaseOrderTrackingNumberConnection
|
|
ship_date - DateTime
|
|
Example
{
"id": "abc123",
"legacy_id": 987,
"po_number": "xyz789",
"account_id": "abc123",
"warehouse_id": "abc123",
"vendor_id": "abc123",
"created_at": ISODateTime,
"po_date": ISODateTime,
"date_closed": ISODateTime,
"arrived_at": ISODateTime,
"packing_note": "abc123",
"fulfillment_status": "xyz789",
"po_note": "xyz789",
"description": "abc123",
"partner_order_number": "abc123",
"subtotal": "abc123",
"discount": "xyz789",
"total_price": "abc123",
"tax": "abc123",
"shipping_method": "xyz789",
"shipping_carrier": "abc123",
"shipping_name": "abc123",
"shipping_price": "abc123",
"tracking_number": "abc123",
"pdf": "xyz789",
"images": "xyz789",
"payment_method": "xyz789",
"payment_due_by": "xyz789",
"payment_note": "abc123",
"locking": "abc123",
"locked_by_user_id": "abc123",
"line_items": PurchaseOrderLineItemConnection,
"attachments": PurchaseOrderAttachmentConnection,
"vendor": Vendor,
"warehouse": Warehouse,
"origin_of_shipment": "xyz789",
"tracking_numbers": PurchaseOrderTrackingNumberConnection,
"ship_date": "2007-12-03T10:15:30Z"
}
PurchaseOrderAttachment
Example
{
"id": "xyz789",
"legacy_id": 987,
"url": "xyz789",
"user_id": "abc123",
"account_id": "abc123",
"po_li_sku": "abc123",
"description": "xyz789",
"filename": "xyz789",
"file_type": "xyz789",
"file_size": 123,
"created_at": ISODateTime
}
PurchaseOrderAttachmentConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination data for this connection. |
edges - [PurchaseOrderAttachmentEdge]!
|
Contains the nodes in this connection. |
Example
{
"pageInfo": PageInfo,
"edges": [PurchaseOrderAttachmentEdge]
}
PurchaseOrderAttachmentEdge
Description
A Relay edge containing a PurchaseOrderAttachment and its cursor.
Fields
| Field Name | Description |
|---|---|
node - PurchaseOrderAttachment
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": PurchaseOrderAttachment,
"cursor": "xyz789"
}
PurchaseOrderConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination data for this connection. |
edges - [PurchaseOrderEdge]!
|
Contains the nodes in this connection. |
Example
{
"pageInfo": PageInfo,
"edges": [PurchaseOrderEdge]
}
PurchaseOrderEdge
Description
A Relay edge containing a PurchaseOrder and its cursor.
Fields
| Field Name | Description |
|---|---|
node - PurchaseOrder
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": PurchaseOrder,
"cursor": "xyz789"
}
PurchaseOrderLineItem
Fields
| Field Name | Description |
|---|---|
id - String
|
|
legacy_id - Int
|
|
po_id - String
|
|
account_id - String
|
|
warehouse_id - String
|
|
vendor_id - String
|
|
po_number - String
|
|
sku - String
|
|
vendor_sku - String
|
|
product_id - String
|
|
variant_id - Int
|
|
quantity - Int
|
|
quantity_received - Int
|
|
quantity_rejected - Int
|
|
price - String
|
|
product_name - String
|
|
option_title - String
|
|
expected_weight_in_lbs - String
|
|
fulfillment_status - String
|
|
sell_ahead - Int
|
|
note - String
|
|
partner_line_item_id - String
|
|
barcode - String
|
|
updated_at - ISODateTime
|
|
created_at - ISODateTime
|
|
vendor - Vendor
|
|
product - WarehouseProduct
|
|
expiration_lots - LotConnection
|
|
Example
{
"id": "abc123",
"legacy_id": 987,
"po_id": "abc123",
"account_id": "xyz789",
"warehouse_id": "abc123",
"vendor_id": "xyz789",
"po_number": "abc123",
"sku": "xyz789",
"vendor_sku": "abc123",
"product_id": "abc123",
"variant_id": 123,
"quantity": 123,
"quantity_received": 987,
"quantity_rejected": 123,
"price": "xyz789",
"product_name": "abc123",
"option_title": "abc123",
"expected_weight_in_lbs": "abc123",
"fulfillment_status": "xyz789",
"sell_ahead": 123,
"note": "abc123",
"partner_line_item_id": "xyz789",
"barcode": "xyz789",
"updated_at": ISODateTime,
"created_at": ISODateTime,
"vendor": Vendor,
"product": WarehouseProduct,
"expiration_lots": LotConnection
}
PurchaseOrderLineItemConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination data for this connection. |
edges - [PurchaseOrderLineItemEdge]!
|
Contains the nodes in this connection. |
Example
{
"pageInfo": PageInfo,
"edges": [PurchaseOrderLineItemEdge]
}
PurchaseOrderLineItemEdge
Description
A Relay edge containing a PurchaseOrderLineItem and its cursor.
Fields
| Field Name | Description |
|---|---|
node - PurchaseOrderLineItem
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": PurchaseOrderLineItem,
"cursor": "xyz789"
}
PurchaseOrderQueryResult
Fields
| Field Name | Description |
|---|---|
request_id - String
|
|
complexity - Int
|
|
data - PurchaseOrder
|
Example
{
"request_id": "xyz789",
"complexity": 987,
"data": PurchaseOrder
}
PurchaseOrderTrackingNumber
PurchaseOrderTrackingNumberConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination data for this connection. |
edges - [PurchaseOrderTrackingNumberEdge]!
|
Contains the nodes in this connection. |
Example
{
"pageInfo": PageInfo,
"edges": [PurchaseOrderTrackingNumberEdge]
}
PurchaseOrderTrackingNumberEdge
Description
A Relay edge containing a PurchaseOrderTrackingNumber and its cursor.
Fields
| Field Name | Description |
|---|---|
node - PurchaseOrderTrackingNumber
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": PurchaseOrderTrackingNumber,
"cursor": "abc123"
}
PurchaseOrdersQueryResult
RMALabel
Fields
| Field Name | Description |
|---|---|
id - String
|
|
legacy_id - Int
|
|
account_id - String
|
|
order_id - String
|
|
rma_id - String
|
|
shipment_id - String
|
|
shipping_name - String
|
|
tracking_number - String
|
|
status - String
|
|
carrier - String
|
|
shipping_method - String
|
|
cost - String
|
|
box_code - String
|
|
dimensions - Dimensions
|
|
address - Address
|
|
paper_pdf_location - String
|
|
thermal_pdf_location - String
|
|
pdf_location - String
|
|
image_location - String
|
|
delivered - Boolean
|
|
picked_up - Boolean
|
|
refunded - Boolean
|
|
needs_refund - Boolean
|
|
profile - String
|
|
full_size_to_print - String
|
|
partner_fulfillment_id - String
|
|
created_at - ISODateTime
|
|
updated_at - ISODateTime
|
Example
{
"id": "abc123",
"legacy_id": 123,
"account_id": "abc123",
"order_id": "abc123",
"rma_id": "abc123",
"shipment_id": "abc123",
"shipping_name": "xyz789",
"tracking_number": "xyz789",
"status": "xyz789",
"carrier": "xyz789",
"shipping_method": "xyz789",
"cost": "xyz789",
"box_code": "abc123",
"dimensions": Dimensions,
"address": Address,
"paper_pdf_location": "xyz789",
"thermal_pdf_location": "abc123",
"pdf_location": "xyz789",
"image_location": "abc123",
"delivered": true,
"picked_up": false,
"refunded": true,
"needs_refund": true,
"profile": "abc123",
"full_size_to_print": "xyz789",
"partner_fulfillment_id": "xyz789",
"created_at": ISODateTime,
"updated_at": ISODateTime
}
RMALabelType
Fields
| Field Name | Description |
|---|---|
id - String
|
|
legacy_id - Int
|
|
tracking_number - String
|
|
status - String
|
|
created_date - ISODateTime
|
|
carrier - String
|
|
shipping_method - String
|
|
cost - String
|
|
dimensions - Dimensions
|
|
length - Float
|
Use dimensions instead |
width - Float
|
Use dimensions instead |
height - Float
|
Use dimensions instead |
weight - Float
|
Use dimensions instead |
to_name - String
|
|
address1 - String
|
|
address2 - String
|
|
address_city - String
|
|
address_state - String
|
|
address_zip - String
|
|
address_country - String
|
|
pdf_location - String
|
Example
{
"id": "xyz789",
"legacy_id": 123,
"tracking_number": "xyz789",
"status": "xyz789",
"created_date": ISODateTime,
"carrier": "xyz789",
"shipping_method": "abc123",
"cost": "xyz789",
"dimensions": Dimensions,
"length": 123.45,
"width": 123.45,
"height": 123.45,
"weight": 123.45,
"to_name": "xyz789",
"address1": "xyz789",
"address2": "xyz789",
"address_city": "xyz789",
"address_state": "abc123",
"address_zip": "abc123",
"address_country": "xyz789",
"pdf_location": "abc123"
}
RecalculateBillInput
RecalculateBillOutput
RemoveKitComponentInput
RemoveKitComponentsInput
Fields
| Input Field | Description |
|---|---|
customer_account_id - String
|
Use this when you are a 3PL acting on behalf of one of your customers |
sku - String!
|
|
components - [RemoveKitComponentInput]!
|
Example
{
"customer_account_id": "abc123",
"sku": "abc123",
"components": [RemoveKitComponentInput]
}
RemoveLineItemsInput
Example
{
"customer_account_id": "xyz789",
"order_id": "xyz789",
"line_item_ids": ["abc123"]
}
RemoveProductFromVendorInput
ReplaceInventoryInput
Example
{
"customer_account_id": "abc123",
"sku": "xyz789",
"warehouse_id": "abc123",
"quantity": 123,
"reason": "abc123",
"location_id": "abc123",
"lpn_id": "xyz789",
"includes_non_sellable": false
}
Return
Fields
| Field Name | Description |
|---|---|
id - String
|
|
legacy_id - Int
|
|
account_id - String
|
|
order_id - String
|
|
partner_id - String
|
|
reason - String
|
|
status - String
|
|
label_type - ReturnLabelType
|
|
label_cost - String
|
|
labels - [RMALabelType]
|
|
cost_to_customer - String
|
|
shipping_carrier - String
|
|
shipping_method - String
|
|
dimensions - Dimensions
|
|
address - Address
|
|
line_items - [ReturnLineItem]
|
|
total_items_expected - Int
|
|
total_items_received - Int
|
|
total_items_restocked - Int
|
|
created_at - ISODateTime
|
|
display_issue_refund - Boolean
|
|
order - Order
|
|
exchanges - [ReturnExchange]
|
|
return_history - [ReturnHistory]
|
Example
{
"id": "abc123",
"legacy_id": 987,
"account_id": "xyz789",
"order_id": "xyz789",
"partner_id": "abc123",
"reason": "xyz789",
"status": "abc123",
"label_type": "FREE",
"label_cost": "abc123",
"labels": [RMALabelType],
"cost_to_customer": "abc123",
"shipping_carrier": "xyz789",
"shipping_method": "abc123",
"dimensions": Dimensions,
"address": Address,
"line_items": [ReturnLineItem],
"total_items_expected": 987,
"total_items_received": 123,
"total_items_restocked": 123,
"created_at": ISODateTime,
"display_issue_refund": true,
"order": Order,
"exchanges": [ReturnExchange],
"return_history": [ReturnHistory]
}
ReturnConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination data for this connection. |
edges - [ReturnEdge]!
|
Contains the nodes in this connection. |
Example
{
"pageInfo": PageInfo,
"edges": [ReturnEdge]
}
ReturnEdge
ReturnExchange
Example
{
"id": "xyz789",
"legacy_id": 123,
"exchange_order_id": "abc123",
"return_id": "abc123",
"account_id": "xyz789",
"exchange_order": Order,
"exchange_items": [ReturnExchangeItem],
"original_return": Return
}
ReturnExchangeItem
ReturnExchangeQueryResult
Fields
| Field Name | Description |
|---|---|
request_id - String
|
|
complexity - Int
|
|
data - ReturnExchange
|
Example
{
"request_id": "xyz789",
"complexity": 987,
"data": ReturnExchange
}
ReturnHistory
Example
{
"id": "abc123",
"legacy_id": 123,
"return_id": "xyz789",
"account_id": "xyz789",
"user_id": "xyz789",
"created_at": ISODateTime,
"body": "abc123"
}
ReturnLabelType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"FREE"
ReturnLineItem
Fields
| Field Name | Description |
|---|---|
id - String
|
|
legacy_id - Int
|
|
account_id - String
|
|
line_item_id - String
|
|
warehouse_id - String
|
|
product_id - String
|
|
return_id - String
|
|
quantity - Int
|
|
quantity_received - Int
|
|
restock - Int
|
|
condition - String
|
|
is_component - Boolean
|
|
type - String
|
|
reason - String
|
|
created_at - ISODateTime
|
|
updated_at - ISODateTime
|
|
line_item - LineItem
|
|
product - Product
|
|
warehouse - Warehouse
|
Example
{
"id": "xyz789",
"legacy_id": 987,
"account_id": "abc123",
"line_item_id": "xyz789",
"warehouse_id": "xyz789",
"product_id": "abc123",
"return_id": "abc123",
"quantity": 123,
"quantity_received": 123,
"restock": 123,
"condition": "xyz789",
"is_component": false,
"type": "abc123",
"reason": "abc123",
"created_at": ISODateTime,
"updated_at": ISODateTime,
"line_item": LineItem,
"product": Product,
"warehouse": Warehouse
}
ReturnQueryResult
ReturnsQueryResult
SetLineItemSkuInput
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 |
old_sku - String!
|
The SKU of the product of the line item to be updated |
new_sku - String!
|
The SKU of the the new product to assign to the line item |
Example
{
"customer_account_id": "abc123",
"order_id": "abc123",
"old_sku": "xyz789",
"new_sku": "abc123"
}
SetPurchaseOrderFulfillmentStatusInput
SetPurchaseOrderFulfillmentStatusOutput
Fields
| Field Name | Description |
|---|---|
request_id - String
|
|
complexity - Int
|
|
purchase_order - PurchaseOrder
|
Example
{
"request_id": "abc123",
"complexity": 123,
"purchase_order": PurchaseOrder
}
Shipment
Fields
| Field Name | Description |
|---|---|
id - String
|
|
legacy_id - Int
|
|
order_id - String
|
|
user_id - String
|
|
warehouse_id - String
|
|
pending_shipment_id - String
|
|
address - Address
|
|
profile - String
|
|
picked_up - Boolean
|
|
needs_refund - Boolean
|
|
refunded - Boolean
|
|
delivered - Boolean
|
|
shipped_off_shiphero - Boolean
|
|
dropshipment - Boolean
|
|
completed - Boolean
|
This field indicates if store was notified about the shipment. It should be 'true' by default and 'false' when using the Bulk Ship UI. |
created_date - ISODateTime
|
|
line_items - ShipmentLineItemConnection
|
|
shipping_labels - [ShippingLabel]
|
|
warehouse - Warehouse
|
|
order - Order
|
|
total_packages - Int
|
|
Example
{
"id": "abc123",
"legacy_id": 987,
"order_id": "xyz789",
"user_id": "xyz789",
"warehouse_id": "abc123",
"pending_shipment_id": "abc123",
"address": Address,
"profile": "abc123",
"picked_up": true,
"needs_refund": true,
"refunded": true,
"delivered": true,
"shipped_off_shiphero": false,
"dropshipment": false,
"completed": true,
"created_date": ISODateTime,
"line_items": ShipmentLineItemConnection,
"shipping_labels": [ShippingLabel],
"warehouse": Warehouse,
"order": Order,
"total_packages": 987
}
ShipmentConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination data for this connection. |
edges - [ShipmentEdge]!
|
Contains the nodes in this connection. |
total_count - Int
|
Example
{
"pageInfo": PageInfo,
"edges": [ShipmentEdge],
"total_count": 123
}
ShipmentEdge
ShipmentLineItem
Example
{
"id": "abc123",
"legacy_id": 987,
"line_item_id": "abc123",
"shipment_id": "abc123",
"shipping_label_id": "abc123",
"quantity": 123,
"line_item": LineItem
}
ShipmentLineItemConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination data for this connection. |
edges - [ShipmentLineItemEdge]!
|
Contains the nodes in this connection. |
Example
{
"pageInfo": PageInfo,
"edges": [ShipmentLineItemEdge]
}
ShipmentLineItemEdge
Description
A Relay edge containing a ShipmentLineItem and its cursor.
Fields
| Field Name | Description |
|---|---|
node - ShipmentLineItem
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": ShipmentLineItem,
"cursor": "xyz789"
}
ShipmentQueryResult
ShipmentsQueryResult
Fields
| Field Name | Description |
|---|---|
request_id - String
|
|
complexity - Int
|
|
data - ShipmentConnection
|
|
Example
{
"request_id": "xyz789",
"complexity": 123,
"data": ShipmentConnection
}
ShippedLineItemInput
ShippedLineItemLot
ShippedPackagesInput
Fields
| Input Field | Description |
|---|---|
address - CreateOrderAddressInput!
|
|
carrier - String!
|
|
method - String!
|
|
tracking_number - String
|
|
tracking_url - String
|
|
label_url - String
|
|
cost - String
|
|
line_items - [ShippedLineItemInput]
|
|
dimensions - DimensionsInput
|
Example
{
"address": CreateOrderAddressInput,
"carrier": "xyz789",
"method": "abc123",
"tracking_number": "xyz789",
"tracking_url": "xyz789",
"label_url": "abc123",
"cost": "abc123",
"line_items": [ShippedLineItemInput],
"dimensions": DimensionsInput
}
ShippingContainer
Fields
| Field Name | Description |
|---|---|
id - String
|
|
legacy_id - Int
|
|
account_id - String
|
|
warehouse_id - String
|
|
container_id - String
|
|
carrier - String
|
|
shipping_methods - [String]
|
|
shipping_labels - ShippingLabelConnection
|
|
note - String
|
|
needs_manifest - Boolean
|
|
created_at - ISODateTime
|
|
updated_at - ISODateTime
|
|
shipped_at - ISODateTime
|
|
Example
{
"id": "xyz789",
"legacy_id": 123,
"account_id": "abc123",
"warehouse_id": "abc123",
"container_id": "abc123",
"carrier": "xyz789",
"shipping_methods": ["abc123"],
"shipping_labels": ShippingLabelConnection,
"note": "xyz789",
"needs_manifest": true,
"created_at": ISODateTime,
"updated_at": ISODateTime,
"shipped_at": ISODateTime
}
ShippingContainerConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination data for this connection. |
edges - [ShippingContainerEdge]!
|
Contains the nodes in this connection. |
total_count - Int
|
Example
{
"pageInfo": PageInfo,
"edges": [ShippingContainerEdge],
"total_count": 123
}
ShippingContainerEdge
Description
A Relay edge containing a ShippingContainer and its cursor.
Fields
| Field Name | Description |
|---|---|
node - ShippingContainer
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": ShippingContainer,
"cursor": "xyz789"
}
ShippingContainerQueryResult
Fields
| Field Name | Description |
|---|---|
request_id - String
|
|
complexity - Int
|
|
data - ShippingContainer
|
Example
{
"request_id": "abc123",
"complexity": 123,
"data": ShippingContainer
}
ShippingContainersQueryResult
Fields
| Field Name | Description |
|---|---|
request_id - String
|
|
complexity - Int
|
|
data - ShippingContainerConnection
|
|
Example
{
"request_id": "abc123",
"complexity": 123,
"data": ShippingContainerConnection
}
ShippingLabel
Fields
| Field Name | Description |
|---|---|
id - String
|
|
legacy_id - Int
|
|
account_id - String
|
|
shipment_id - String
|
|
order_id - String
|
|
box_id - String
|
|
box_name - String
|
|
status - String
|
|
tracking_number - String
|
|
alternate_tracking_id - String
|
|
order_number - String
|
|
order_account_id - String
|
|
carrier - String
|
|
shipping_name - String
|
|
shipping_method - String
|
|
cost - String
|
|
box_code - String
|
|
device_id - String
|
|
delivered - Boolean
|
|
picked_up - Boolean
|
|
refunded - Boolean
|
|
needs_refund - Boolean
|
|
profile - String
|
|
partner_fulfillment_id - String
|
|
full_size_to_print - String
|
|
packing_slip - String
|
|
warehouse - String
|
|
warehouse_id - String
|
|
insurance_amount - String
|
|
carrier_account_id - String
|
|
source - String
|
|
created_date - ISODateTime
|
|
tracking_url - String
|
|
dimensions - Dimensions
|
|
label - LabelResource
|
|
address - Address
|
|
order - Order
|
|
shipment_line_items - ShipmentLineItemConnection
|
|
package_number - Int
|
|
parcelview_url - String
|
|
tracking_status - String
|
|
in_shipping_container - Boolean
|
|
shipping_container_id - String
|
|
last_mile_labels - LastMileLabel
|
|
serial_numbers - [LineItemSerialNumber]
|
|
Example
{
"id": "abc123",
"legacy_id": 987,
"account_id": "xyz789",
"shipment_id": "xyz789",
"order_id": "abc123",
"box_id": "abc123",
"box_name": "xyz789",
"status": "xyz789",
"tracking_number": "abc123",
"alternate_tracking_id": "abc123",
"order_number": "xyz789",
"order_account_id": "abc123",
"carrier": "abc123",
"shipping_name": "xyz789",
"shipping_method": "abc123",
"cost": "xyz789",
"box_code": "abc123",
"device_id": "abc123",
"delivered": true,
"picked_up": false,
"refunded": false,
"needs_refund": true,
"profile": "xyz789",
"partner_fulfillment_id": "abc123",
"full_size_to_print": "abc123",
"packing_slip": "abc123",
"warehouse": "abc123",
"warehouse_id": "abc123",
"insurance_amount": "xyz789",
"carrier_account_id": "xyz789",
"source": "xyz789",
"created_date": ISODateTime,
"tracking_url": "xyz789",
"dimensions": Dimensions,
"label": LabelResource,
"address": Address,
"order": Order,
"shipment_line_items": ShipmentLineItemConnection,
"package_number": 123,
"parcelview_url": "xyz789",
"tracking_status": "xyz789",
"in_shipping_container": true,
"shipping_container_id": "xyz789",
"last_mile_labels": LastMileLabel,
"serial_numbers": [LineItemSerialNumber]
}
ShippingLabelConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination data for this connection. |
edges - [ShippingLabelEdge]!
|
Contains the nodes in this connection. |
Example
{
"pageInfo": PageInfo,
"edges": [ShippingLabelEdge]
}
ShippingLabelEdge
Description
A Relay edge containing a ShippingLabel and its cursor.
Fields
| Field Name | Description |
|---|---|
node - ShippingLabel
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": ShippingLabel,
"cursor": "abc123"
}
ShippingLines
ShippingPlan
Fields
| Field Name | Description |
|---|---|
id - String
|
|
legacy_id - Int
|
|
account_id - String
|
|
warehouse_id - String
|
|
created_at - ISODateTime
|
|
fulfillment_status - String
|
|
warehouse_note - String
|
|
vendor_po_number - String
|
|
subtotal - String
|
|
shipping_price - String
|
|
total_price - String
|
|
shipping_method - String
|
|
shipping_carrier - String
|
|
shipping_name - String
|
|
tracking_number - String
|
|
warehouse - Warehouse
|
|
pdf_location - String
|
|
line_items - ShippingPlanLineItemConnection
|
|
packages - ShippingPlanPackageConnection
|
|
pallets - ShippingPlanPalletConnection
|
|
origin_of_shipment - String
|
|
tracking_numbers - ShippingPlanTrackingNumberConnection
|
|
Example
{
"id": "abc123",
"legacy_id": 123,
"account_id": "abc123",
"warehouse_id": "abc123",
"created_at": ISODateTime,
"fulfillment_status": "abc123",
"warehouse_note": "abc123",
"vendor_po_number": "abc123",
"subtotal": "xyz789",
"shipping_price": "abc123",
"total_price": "xyz789",
"shipping_method": "abc123",
"shipping_carrier": "xyz789",
"shipping_name": "abc123",
"tracking_number": "abc123",
"warehouse": Warehouse,
"pdf_location": "xyz789",
"line_items": ShippingPlanLineItemConnection,
"packages": ShippingPlanPackageConnection,
"pallets": ShippingPlanPalletConnection,
"origin_of_shipment": "abc123",
"tracking_numbers": ShippingPlanTrackingNumberConnection
}
ShippingPlanLineItem
Fields
| Field Name | Description |
|---|---|
id - String
|
|
legacy_id - Int
|
|
account_id - String
|
|
warehouse_id - String
|
|
sku - String
|
|
vendor_sku - String
|
|
product_id - String
|
|
variant_id - Int
|
|
quantity - Int
|
|
quantity_received - Int
|
|
quantity_rejected - Int
|
|
price - String
|
|
product_name - String
|
|
option_title - String
|
|
expected_weight_in_lbs - String
|
|
fulfillment_status - String
|
|
sell_ahead - Int
|
|
note - String
|
|
partner_line_item_id - String
|
|
barcode - String
|
|
updated_at - ISODateTime
|
|
created_at - ISODateTime
|
|
product - WarehouseProduct
|
Example
{
"id": "abc123",
"legacy_id": 123,
"account_id": "xyz789",
"warehouse_id": "abc123",
"sku": "abc123",
"vendor_sku": "abc123",
"product_id": "xyz789",
"variant_id": 123,
"quantity": 123,
"quantity_received": 987,
"quantity_rejected": 123,
"price": "xyz789",
"product_name": "abc123",
"option_title": "xyz789",
"expected_weight_in_lbs": "abc123",
"fulfillment_status": "xyz789",
"sell_ahead": 123,
"note": "abc123",
"partner_line_item_id": "abc123",
"barcode": "abc123",
"updated_at": ISODateTime,
"created_at": ISODateTime,
"product": WarehouseProduct
}
ShippingPlanLineItemConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination data for this connection. |
edges - [ShippingPlanLineItemEdge]!
|
Contains the nodes in this connection. |
Example
{
"pageInfo": PageInfo,
"edges": [ShippingPlanLineItemEdge]
}
ShippingPlanLineItemEdge
Description
A Relay edge containing a ShippingPlanLineItem and its cursor.
Fields
| Field Name | Description |
|---|---|
node - ShippingPlanLineItem
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": ShippingPlanLineItem,
"cursor": "abc123"
}
ShippingPlanPackage
Example
{
"id": "xyz789",
"legacy_id": 987,
"box_number": "abc123",
"line_items": ShippingPlanPackageLineItemConnection
}
ShippingPlanPackageConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination data for this connection. |
edges - [ShippingPlanPackageEdge]!
|
Contains the nodes in this connection. |
Example
{
"pageInfo": PageInfo,
"edges": [ShippingPlanPackageEdge]
}
ShippingPlanPackageEdge
Description
A Relay edge containing a ShippingPlanPackage and its cursor.
Fields
| Field Name | Description |
|---|---|
node - ShippingPlanPackage
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": ShippingPlanPackage,
"cursor": "abc123"
}
ShippingPlanPackageLineItem
ShippingPlanPackageLineItemConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination data for this connection. |
edges - [ShippingPlanPackageLineItemEdge]!
|
Contains the nodes in this connection. |
Example
{
"pageInfo": PageInfo,
"edges": [ShippingPlanPackageLineItemEdge]
}
ShippingPlanPackageLineItemEdge
Description
A Relay edge containing a ShippingPlanPackageLineItem and its cursor.
Fields
| Field Name | Description |
|---|---|
node - ShippingPlanPackageLineItem
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": ShippingPlanPackageLineItem,
"cursor": "abc123"
}
ShippingPlanPallet
ShippingPlanPalletConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination data for this connection. |
edges - [ShippingPlanPalletEdge]!
|
Contains the nodes in this connection. |
Example
{
"pageInfo": PageInfo,
"edges": [ShippingPlanPalletEdge]
}
ShippingPlanPalletEdge
Description
A Relay edge containing a ShippingPlanPallet and its cursor.
Fields
| Field Name | Description |
|---|---|
node - ShippingPlanPallet
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": ShippingPlanPallet,
"cursor": "xyz789"
}
ShippingPlanQueryResult
Fields
| Field Name | Description |
|---|---|
request_id - String
|
|
complexity - Int
|
|
data - ShippingPlan
|
Example
{
"request_id": "abc123",
"complexity": 987,
"data": ShippingPlan
}
ShippingPlanTrackingNumber
ShippingPlanTrackingNumberConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination data for this connection. |
edges - [ShippingPlanTrackingNumberEdge]!
|
Contains the nodes in this connection. |
Example
{
"pageInfo": PageInfo,
"edges": [ShippingPlanTrackingNumberEdge]
}
ShippingPlanTrackingNumberEdge
Description
A Relay edge containing a ShippingPlanTrackingNumber and its cursor.
Fields
| Field Name | Description |
|---|---|
node - ShippingPlanTrackingNumber
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": ShippingPlanTrackingNumber,
"cursor": "abc123"
}
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"xyz789"
SubmitBillInput
Tote
ToteContentQueryResult
ToteHistory
Fields
| Field Name | Description |
|---|---|
tote_name - String
|
|
tote_id - String
|
|
action - String
|
|
created_at - ISODateTime
|
Example
{
"tote_name": "abc123",
"tote_id": "xyz789",
"action": "abc123",
"created_at": ISODateTime
}
ToteHistoryConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination data for this connection. |
edges - [ToteHistoryEdge]!
|
Contains the nodes in this connection. |
Example
{
"pageInfo": PageInfo,
"edges": [ToteHistoryEdge]
}
ToteHistoryEdge
Description
A Relay edge containing a ToteHistory and its cursor.
Fields
| Field Name | Description |
|---|---|
node - ToteHistory
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": ToteHistory,
"cursor": "abc123"
}
ToteHistoryQueryResult
TotePick
Example
{
"id": "xyz789",
"legacy_id": 123,
"sku": "xyz789",
"created_at": ISODateTime,
"updated_at": ISODateTime,
"tote_id": "abc123",
"current": 123,
"picked_quantity": 123,
"quantity": 123,
"inventory_bin": "xyz789",
"line_item": LineItem,
"location": Location,
"deducted": true
}
TransferInventoryInput
Example
{
"customer_account_id": "xyz789",
"sku": "xyz789",
"warehouse_id": "xyz789",
"quantity": 987,
"location_from_id": "xyz789",
"location_to_id": "xyz789",
"reason": "abc123",
"lpn_from_id": "abc123",
"lpn_to_id": "abc123"
}
TransferInventoryOutput
URL
Example
"http://www.test.com/"
UpdateBillInput
UpdateInventoryInput
Example
{
"customer_account_id": "abc123",
"sku": "abc123",
"warehouse_id": "xyz789",
"quantity": 987,
"reason": "abc123",
"location_id": "xyz789",
"lpn_id": "abc123"
}
UpdateInventoryOutput
Fields
| Field Name | Description |
|---|---|
request_id - String
|
|
complexity - Int
|
|
warehouse_product - WarehouseProduct
|
Example
{
"request_id": "xyz789",
"complexity": 123,
"warehouse_product": WarehouseProduct
}
UpdateLineItemInput
Fields
| Input Field | Description |
|---|---|
id - String!
|
|
partner_line_item_id - String
|
|
quantity - Int
|
|
price - String
|
|
product_name - String
|
|
option_title - String
|
|
fulfillment_status - String
|
|
quantity_pending_fulfillment - Int
|
|
custom_options - GenericScalar
|
|
custom_barcode - String
|
|
eligible_for_return - Boolean
|
|
customs_value - String
|
A decimal value used for customs |
warehouse_id - String
|
Set to lock to that warehouse. The item will not be moved in any multi-warhouse processing |
barcode - String
|
Example
{
"id": "xyz789",
"partner_line_item_id": "abc123",
"quantity": 987,
"price": "xyz789",
"product_name": "abc123",
"option_title": "xyz789",
"fulfillment_status": "xyz789",
"quantity_pending_fulfillment": 987,
"custom_options": GenericScalar,
"custom_barcode": "abc123",
"eligible_for_return": true,
"customs_value": "xyz789",
"warehouse_id": "abc123",
"barcode": "abc123"
}
UpdateLineItemsInput
Fields
| Input Field | Description |
|---|---|
customer_account_id - String
|
Use this when you are a 3PL acting on behalf of one of your customers |
order_id - String!
|
The id of the order you want to modify |
line_items - [UpdateLineItemInput]
|
Example
{
"customer_account_id": "abc123",
"order_id": "xyz789",
"line_items": [UpdateLineItemInput]
}
UpdateLocationInput
Example
{
"location_id": "xyz789",
"zone": "abc123",
"location_type_id": "abc123",
"pickable": false,
"sellable": true,
"is_cart": false,
"pick_priority": 987,
"dimensions": DimensionsInput,
"temperature": "xyz789"
}
UpdateLotInput
Description
GraphQL input type for Lot update.
Fields
| Input Field | Description |
|---|---|
lot_id - String!
|
|
name - String
|
|
sku - String
|
|
expires_at - ISODateTime
|
|
is_active - Boolean
|
Example
{
"lot_id": "abc123",
"name": "xyz789",
"sku": "abc123",
"expires_at": ISODateTime,
"is_active": false
}
UpdateLotOutput
UpdateLotsInput
UpdateLotsOutput
UpdateOrderFulfillmentStatusInput
Fields
| Input Field | Description |
|---|---|
customer_account_id - String
|
Use this when you are a 3PL acting on behalf of one of your customers |
order_id - String!
|
The id of the order you want to modify |
fulfillment_status - String!
|
|
remove_inventory - Boolean
|
Whether or not to remove inventory if the order is being cancelled |
reason - String
|
|
void_on_platform - Boolean
|
Whether or not to void the order on the sales platform if the order is being cancelled |
Example
{
"customer_account_id": "abc123",
"order_id": "xyz789",
"fulfillment_status": "xyz789",
"remove_inventory": true,
"reason": "xyz789",
"void_on_platform": false
}
UpdateOrderHoldsInput
Fields
| Input Field | Description |
|---|---|
customer_account_id - String
|
Use this when you are a 3PL acting on behalf of one of your customers |
order_id - String!
|
The id of the order you want to modify |
payment_hold - Boolean
|
|
operator_hold - Boolean
|
|
fraud_hold - Boolean
|
|
address_hold - Boolean
|
|
client_hold - Boolean
|
Example
{
"customer_account_id": "xyz789",
"order_id": "abc123",
"payment_hold": false,
"operator_hold": false,
"fraud_hold": true,
"address_hold": true,
"client_hold": true
}
UpdateOrderInput
Fields
| Input Field | Description |
|---|---|
customer_account_id - String
|
Use this when you are a 3PL acting on behalf of one of your customers |
order_id - String!
|
The id of the order you want to modify |
order_number - String
|
|
partner_order_id - String
|
|
fulfillment_status - String
|
|
order_date - ISODateTime
|
|
total_tax - String
|
|
total_discounts - String
|
|
box_name - String
|
|
ready_to_ship - Boolean
|
|
insurance_amount - Decimal
|
|
required_ship_date - ISODateTime
|
|
allocation_priority - Int
|
|
shipping_lines - CreateShippingLinesInput
|
|
shipping_address - CreateOrderAddressInput
|
|
billing_address - CreateOrderAddressInput
|
|
profile - String
|
|
packing_note - String
|
|
tags - [String]
|
|
gift_note - String
|
|
gift_invoice - Boolean
|
|
require_signature - Boolean
|
|
adult_signature_required - Boolean
|
|
alcohol - Boolean
|
|
insurance - Boolean
|
|
allow_partial - Boolean
|
|
allow_split - Boolean
|
|
priority_flag - Boolean
|
|
hold_until_date - ISODateTime
|
|
incoterms - String
|
|
tax_id - String
|
|
tax_type - String
|
|
history_entry - UserNoteInput
|
|
ignore_address_validation_errors - Boolean
|
US addresses are be validated and when errors occur the order will have an address hold created. If this flag is set then the error validation is skipped and no address hold is created |
skip_address_validation - Boolean
|
Not address validation will be performed |
custom_invoice_url - String
|
|
auto_print_return_label - Boolean
|
|
dry_ice_weight_in_lbs - String
|
|
ftr_exemption - Decimal
|
|
address_is_business - Boolean
|
|
do_not_print_invoice - Boolean
|
|
ignore_payment_capture_errors - Boolean
|
Example
{
"customer_account_id": "abc123",
"order_id": "abc123",
"order_number": "xyz789",
"partner_order_id": "xyz789",
"fulfillment_status": "abc123",
"order_date": ISODateTime,
"total_tax": "abc123",
"total_discounts": "xyz789",
"box_name": "xyz789",
"ready_to_ship": false,
"insurance_amount": Decimal,
"required_ship_date": ISODateTime,
"allocation_priority": 123,
"shipping_lines": CreateShippingLinesInput,
"shipping_address": CreateOrderAddressInput,
"billing_address": CreateOrderAddressInput,
"profile": "abc123",
"packing_note": "abc123",
"tags": ["abc123"],
"gift_note": "abc123",
"gift_invoice": true,
"require_signature": false,
"adult_signature_required": true,
"alcohol": false,
"insurance": false,
"allow_partial": true,
"allow_split": false,
"priority_flag": true,
"hold_until_date": ISODateTime,
"incoterms": "abc123",
"tax_id": "xyz789",
"tax_type": "abc123",
"history_entry": UserNoteInput,
"ignore_address_validation_errors": false,
"skip_address_validation": false,
"custom_invoice_url": "xyz789",
"auto_print_return_label": true,
"dry_ice_weight_in_lbs": "xyz789",
"ftr_exemption": Decimal,
"address_is_business": false,
"do_not_print_invoice": false,
"ignore_payment_capture_errors": false
}
UpdateOrderInputBase
UpdateProductCaseInput
UpdateProductImageInput
UpdateProductInput
Fields
| Input Field | Description |
|---|---|
customer_account_id - String
|
Use this when you are a 3PL acting on behalf of one of your customers |
sku - String!
|
|
name - String
|
|
dimensions - DimensionsInput
|
|
tariff_code - String
|
|
product_note - String
|
|
country_of_manufacture - String
|
|
needs_serial_number - Boolean
|
|
dropship - Boolean
|
|
barcode - String
|
|
customs_description - String
|
|
ignore_on_customs - Boolean
|
|
ignore_on_invoice - Boolean
|
|
tags - [String]
|
Fully replaces existen tags with the ones provided |
vendors - [UpdateProductVendorInput]
|
|
final_sale - Boolean
|
|
virtual - Boolean
|
|
needs_lot_tracking - Boolean
|
|
images - [UpdateProductImageInput]
|
|
cases - [UpdateProductCaseInput]
|
|
packer_note - String
|
|
vendor_part_number - String
|
|
consumer_package_code - String
|
|
buyer_part_number - String
|
|
buyer_style_number - String
|
Example
{
"customer_account_id": "abc123",
"sku": "xyz789",
"name": "xyz789",
"dimensions": DimensionsInput,
"tariff_code": "abc123",
"product_note": "xyz789",
"country_of_manufacture": "xyz789",
"needs_serial_number": true,
"dropship": false,
"barcode": "xyz789",
"customs_description": "abc123",
"ignore_on_customs": false,
"ignore_on_invoice": false,
"tags": ["xyz789"],
"vendors": [UpdateProductVendorInput],
"final_sale": true,
"virtual": true,
"needs_lot_tracking": false,
"images": [UpdateProductImageInput],
"cases": [UpdateProductCaseInput],
"packer_note": "abc123",
"vendor_part_number": "abc123",
"consumer_package_code": "xyz789",
"buyer_part_number": "xyz789",
"buyer_style_number": "abc123"
}
UpdateProductVendorInput
UpdatePurchaseOrderInput
Fields
| Input Field | Description |
|---|---|
customer_account_id - String
|
Use this when you are a 3PL acting on behalf of one of your customers |
po_id - String!
|
|
packing_note - String
|
|
po_note - String
|
|
description - String
|
|
partner_order_number - String
|
|
discount - String
|
|
tax - String
|
|
line_items - [UpdatePurchaseOrderLineItemInput]
|
|
shipping_method - String
|
|
shipping_carrier - String
|
|
shipping_name - String
|
|
shipping_price - String
|
|
tracking_number - String
|
|
pdf - String
|
|
payment_method - String
|
|
payment_due_by - String
|
|
payment_note - String
|
|
po_date - ISODateTime
|
|
clear_po_date - Boolean
|
Example
{
"customer_account_id": "abc123",
"po_id": "abc123",
"packing_note": "xyz789",
"po_note": "abc123",
"description": "xyz789",
"partner_order_number": "xyz789",
"discount": "abc123",
"tax": "abc123",
"line_items": [UpdatePurchaseOrderLineItemInput],
"shipping_method": "abc123",
"shipping_carrier": "xyz789",
"shipping_name": "abc123",
"shipping_price": "xyz789",
"tracking_number": "xyz789",
"pdf": "xyz789",
"payment_method": "xyz789",
"payment_due_by": "abc123",
"payment_note": "abc123",
"po_date": ISODateTime,
"clear_po_date": false
}
UpdatePurchaseOrderLineItemInput
Example
{
"sku": "abc123",
"quantity": 987,
"quantity_received": 987,
"quantity_rejected": 123,
"sell_ahead": 123,
"price": "xyz789",
"note": "xyz789"
}
UpdatePurchaseOrderOutput
Fields
| Field Name | Description |
|---|---|
request_id - String
|
|
complexity - Int
|
|
purchase_order - PurchaseOrder
|
Example
{
"request_id": "xyz789",
"complexity": 987,
"purchase_order": PurchaseOrder
}
UpdateReturnStatusInput
UpdateReturnStatusOutput
UpdateTagsInput
UpdateWarehouseProductInput
Fields
| Input Field | Description |
|---|---|
customer_account_id - String
|
Use this when you are a 3PL acting on behalf of one of your customers |
sku - String!
|
|
warehouse_id - String!
|
|
on_hand - Int
|
|
price - String
|
|
value - String
|
|
value_currency - String
|
|
inventory_bin - String
|
|
inventory_overstock_bin - String
|
|
reserve_inventory - Int
|
|
replenishment_level - Int
|
|
reorder_amount - Int
|
|
reorder_level - Int
|
|
customs_value - String
|
|
active - Boolean
|
|
replenishment_max_level - Int
|
|
replenishment_increment - Int
|
Example
{
"customer_account_id": "xyz789",
"sku": "xyz789",
"warehouse_id": "xyz789",
"on_hand": 123,
"price": "xyz789",
"value": "abc123",
"value_currency": "abc123",
"inventory_bin": "xyz789",
"inventory_overstock_bin": "xyz789",
"reserve_inventory": 123,
"replenishment_level": 123,
"reorder_amount": 987,
"reorder_level": 123,
"customs_value": "abc123",
"active": false,
"replenishment_max_level": 987,
"replenishment_increment": 123
}
UpdateWholesaleLineItemInput
UpdateWholesaleOrderInput
Fields
| Input Field | Description |
|---|---|
order_id - String!
|
The id of the order associated with the wholesale order you want to modify |
staging_location_id - Int
|
|
pickup_date - ISODateTime
|
|
preparation_date - ISODateTime
|
|
order_type - String
|
|
gs1_labels_required - Boolean
|
|
trading_partner_id - String
|
|
trading_partner_name - String
|
|
store_location_number - String
|
|
distribution_center - String
|
|
vendor - String
|
|
vendor_id - String
|
|
requested_delivery_date - ISODateTime
|
|
ship_not_before_date - ISODateTime
|
|
ship_no_later_than_date - ISODateTime
|
|
depositor_order_number - String
|
|
department - String
|
|
division - String
|
|
service_level - String
|
|
internal_supplier_number - String
|
|
terms_of_sale - String
|
|
retailer_notes - String
|
|
quote_number - String
|
|
sales_requirement_code - String
|
|
reference_fields - JSONObjectScalar
|
|
wholesale_shipping_details - WholesaleShippingDetailsInput
|
|
wholesale_line_items - [UpdateWholesaleLineItemInput]
|
|
shipping_option - WholesaleShippingOptions
|
Example
{
"order_id": "abc123",
"staging_location_id": 987,
"pickup_date": ISODateTime,
"preparation_date": ISODateTime,
"order_type": "abc123",
"gs1_labels_required": false,
"trading_partner_id": "xyz789",
"trading_partner_name": "xyz789",
"store_location_number": "xyz789",
"distribution_center": "abc123",
"vendor": "xyz789",
"vendor_id": "abc123",
"requested_delivery_date": ISODateTime,
"ship_not_before_date": ISODateTime,
"ship_no_later_than_date": ISODateTime,
"depositor_order_number": "abc123",
"department": "abc123",
"division": "xyz789",
"service_level": "abc123",
"internal_supplier_number": "abc123",
"terms_of_sale": "xyz789",
"retailer_notes": "abc123",
"quote_number": "abc123",
"sales_requirement_code": "xyz789",
"reference_fields": JSONObjectScalar,
"wholesale_shipping_details": WholesaleShippingDetailsInput,
"wholesale_line_items": [UpdateWholesaleLineItemInput],
"shipping_option": "COURIER"
}
UpdateWholesaleOrderInputBase
Description
Base class of all wholesale order update inputs to allow users to reference the order by its id or its associated order_id.
Fields
| Input Field | Description |
|---|---|
order_id - String!
|
The id of the order associated with the wholesale order you want to modify |
Example
{"order_id": "xyz789"}
UpdateWholesaleOrderPickingFlowInput
Fields
| Input Field | Description |
|---|---|
order_id - String!
|
The id of the order associated with the wholesale order you want to modify |
picking_flow - WholesaleOrderPickingFlow
|
Example
{
"order_id": "abc123",
"picking_flow": "DESKTOP"
}
UpdateWholesaleOrderStagingLocationInput
User
UserError
Description
Base Interface all user-facing GraphQL errors should implement. This is used to provide a common way to handle errors in the frontend.
A possible scenario would be having a create_user mutation that returns different types of error if the email is already in use, the password is too short, etc.
It could be declared like this:
class UsernameTakenError(ObjectType):
class Meta:
interfaces = (UserError, )
suggestedUsernames = List(String)
class PasswordTooShortError(ObjectType):
class Meta:
interfaces = (UserError, )
class UserCreationError(Union):
class Meta:
types = (UsernameTakenError, PasswordTooShortError)
class CreateUser(Mutation):
user = Field(User)
errors = List(UserCreationError)
And it would be queried like this:
mutation {
createUser(email: foo@bar.com, password: "123") {
user {
id
}
errors {
__typename
... on UserError {
message
}
... on UsernameTakenError {
message
suggestedUsername
}
... on PasswordTooShortError {
message
}
}
}
}
If new errors are added, and they implement the UserError interface, the frontend will be able to handle at least the message field without any changes.
based on: https://productionreadygraphql.com/2020-08-01-guide-to-graphql-errors
Fields
| Field Name | Description |
|---|---|
message - String!
|
Possible Types
| UserError Types |
|---|
Example
{"message": "xyz789"}
UserNoteInput
UserQuota
Fields
| Field Name | Description |
|---|---|
is_expired - Boolean
|
There's no time window anymore, this will be always False |
expiration_date - ISODateTime
|
There's no time window anymore, this will be always empty |
time_remaining - String
|
There's no time window anymore, this will be always empty |
credits_remaining - Int
|
|
max_available - Int
|
|
increment_rate - Int
|
Example
{
"is_expired": false,
"expiration_date": ISODateTime,
"time_remaining": "abc123",
"credits_remaining": 987,
"max_available": 123,
"increment_rate": 123
}
Vendor
Example
{
"id": "xyz789",
"legacy_id": 987,
"name": "abc123",
"email": "xyz789",
"account_number": "xyz789",
"account_id": "abc123",
"address": Address,
"currency": "xyz789",
"internal_note": "abc123",
"default_po_note": "xyz789",
"logo": "abc123",
"partner_vendor_id": 123,
"created_at": ISODateTime
}
VendorConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination data for this connection. |
edges - [VendorEdge]!
|
Contains the nodes in this connection. |
Example
{
"pageInfo": PageInfo,
"edges": [VendorEdge]
}
VendorEdge
VendorsQueryResult
Warehouse
Fields
| Field Name | Description |
|---|---|
id - String
|
|
legacy_id - Int
|
|
account_id - String
|
|
identifier - String
|
Name of the warehouse |
dynamic_slotting - Boolean
|
|
invoice_email - String
|
|
phone_number - String
|
|
profile - String
|
|
address - Address
|
|
return_address - Address
|
|
company_name - String
|
|
company_alias - String
|
|
products - ProductConnection
|
|
Example
{
"id": "xyz789",
"legacy_id": 987,
"account_id": "xyz789",
"identifier": "abc123",
"dynamic_slotting": true,
"invoice_email": "abc123",
"phone_number": "abc123",
"profile": "xyz789",
"address": Address,
"return_address": Address,
"company_name": "xyz789",
"company_alias": "xyz789",
"products": ProductConnection
}
WarehouseProduct
Fields
| Field Name | Description |
|---|---|
id - String
|
|
legacy_id - Int
|
|
account_id - String
|
|
sku - String
|
Stock Keeping Unit |
warehouse_id - String
|
|
warehouse_identifier - String
|
The warehouse identifier, usually Primary/Secondary |
price - String
|
Price of the product |
value - String
|
Price paid for the product |
value_currency - String
|
|
on_hand - Int
|
The total count of a SKU physically in the warehouse. (Note, Available is the count indicated in your sales channels) |
inventory_bin - String
|
The name of the bin where the product is stored |
inventory_overstock_bin - String
|
The name of the bin where overstock is stored |
reserve_inventory - Int
|
Count of a SKU that is not to be sold in your sales channel.For example, if you’re running a flash sale and want to hold some stock for returns or exchanges, you would enter your full inventory of say 100 units as the On Hand and a Reserve of 5 units. We’ll then tell the platform that you have 95 available for sale (On Hand minus Reserve). The Available count will remain 100 |
replenishment_level - Int
|
Available only for accounts that use Dynamic Slotting and used specifically for replenishment reports. SKUs will appear on the replenishment report if inventory allocated and not enough in pickable bins, or if the pickable bin inventory is less than the replenishment level |
reorder_amount - Int
|
The number that should be reordered when a SKU reaches the Reorder Level |
reorder_level - Int
|
The Available value a SKU must reach to trigger a Reorder. (See Reorder Amount). Setting this to 0 will prevent a SKU from automatically being added to a PO |
backorder - Int
|
Count of how many units you owe to customers for open orders and don’t have stock for in the warehouse |
allocated - Int
|
Count of how many units you have in stock and owe to customers for open orders |
available - Int
|
The number of available stock for any given SKU that is pushed to any connected sales channel. This is On Hand minus any allocations to open orders. |
non_sellable_quantity - Int
|
Count of non sellable units of a SKU in the warehouse. |
in_tote - Int
|
Total number of units picked in totes |
custom - Boolean
|
|
customs_value - String
|
|
created_at - ISODateTime
|
|
updated_at - ISODateTime
|
|
sell_ahead - Int
|
|
active - Boolean
|
|
warehouse - Warehouse
|
|
product - Product
|
|
inbounds - WarehouseProductInboundConnection
|
|
Arguments
|
|
locations - ItemLocationConnection
|
|
Example
{
"id": "xyz789",
"legacy_id": 123,
"account_id": "xyz789",
"sku": "abc123",
"warehouse_id": "xyz789",
"warehouse_identifier": "abc123",
"price": "xyz789",
"value": "abc123",
"value_currency": "xyz789",
"on_hand": 123,
"inventory_bin": "xyz789",
"inventory_overstock_bin": "xyz789",
"reserve_inventory": 123,
"replenishment_level": 123,
"reorder_amount": 987,
"reorder_level": 987,
"backorder": 123,
"allocated": 123,
"available": 987,
"non_sellable_quantity": 123,
"in_tote": 123,
"custom": true,
"customs_value": "xyz789",
"created_at": ISODateTime,
"updated_at": ISODateTime,
"sell_ahead": 123,
"active": true,
"warehouse": Warehouse,
"product": Product,
"inbounds": WarehouseProductInboundConnection,
"locations": ItemLocationConnection
}
WarehouseProductConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination data for this connection. |
edges - [WarehouseProductEdge]!
|
Contains the nodes in this connection. |
Example
{
"pageInfo": PageInfo,
"edges": [WarehouseProductEdge]
}
WarehouseProductEdge
Description
A Relay edge containing a WarehouseProduct and its cursor.
Fields
| Field Name | Description |
|---|---|
node - WarehouseProduct
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": WarehouseProduct,
"cursor": "xyz789"
}
WarehouseProductInbound
Example
{
"id": "xyz789",
"legacy_id": 123,
"sku": "abc123",
"warehouse_id": "abc123",
"po_id": "xyz789",
"purchase_order_line_item_id": "xyz789",
"po_date": ISODateTime,
"quantity": 123,
"quantity_received": 123,
"quantity_rejected": 987,
"sell_ahead": 123,
"status": "xyz789"
}
WarehouseProductInboundConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination data for this connection. |
edges - [WarehouseProductInboundEdge]!
|
Contains the nodes in this connection. |
Example
{
"pageInfo": PageInfo,
"edges": [WarehouseProductInboundEdge]
}
WarehouseProductInboundEdge
Description
A Relay edge containing a WarehouseProductInbound and its cursor.
Fields
| Field Name | Description |
|---|---|
node - WarehouseProductInbound
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": WarehouseProductInbound,
"cursor": "xyz789"
}
WarehouseProductMutationOutput
Fields
| Field Name | Description |
|---|---|
request_id - String
|
|
complexity - Int
|
|
warehouse_product - WarehouseProduct
|
Example
{
"request_id": "xyz789",
"complexity": 123,
"warehouse_product": WarehouseProduct
}
WarehouseProductsQueryResult
Webhook
Example
{
"id": "xyz789",
"legacy_id": 123,
"account_id": "xyz789",
"shop_name": "abc123",
"name": "abc123",
"url": "xyz789",
"source": "xyz789",
"shared_signature_secret": "abc123"
}
WebhookConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination data for this connection. |
edges - [WebhookEdge]!
|
Contains the nodes in this connection. |
Example
{
"pageInfo": PageInfo,
"edges": [WebhookEdge]
}
WebhookEdge
WebhooksQueryResult
WholesaleFulfillmentFlowOptions
Description
Allowed label formats
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"B2B_FULFILLMENT"
WholesaleLineItem
WholesaleLineItemsQuerySpecConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination data for this connection. |
edges - [WholesaleLineItemsQuerySpecEdge]!
|
Contains the nodes in this connection. |
total_count - Int
|
Example
{
"pageInfo": PageInfo,
"edges": [WholesaleLineItemsQuerySpecEdge],
"total_count": 123
}
WholesaleLineItemsQuerySpecEdge
Description
A Relay edge containing a WholesaleLineItemsQuerySpec and its cursor.
Fields
| Field Name | Description |
|---|---|
node - WholesaleLineItem
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": WholesaleLineItem,
"cursor": "abc123"
}
WholesaleLocationType
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"PICKABLE"
WholesaleOrder
Fields
| Field Name | Description |
|---|---|
id - String
|
|
legacy_id - Int
|
|
version - WholesaleOrderVersion
|
|
fulfillment_flow - WholesaleFulfillmentFlowOptions
|
|
shipping_option - WholesaleShippingOptions
|
|
staging_location_id - Int
|
|
picking_flow - WholesaleOrderPickingFlow
|
|
outbound_progress - WholesaleOrderOutboundProgress
|
|
pickup_date - ISODateTime
|
|
status - WholesaleOrderStatus
|
|
status_message - String
|
|
preparation_date - ISODateTime
|
|
packing_layout - GenericScalar
|
We will return this field only after the packing layout is completely defined, which happens once the order is in 'packed' status or has moved further along in the processing line. |
order_type - String
|
|
gs1_labels_required - Boolean
|
|
trading_partner_id - String
|
|
trading_partner_name - String
|
|
store_location_number - String
|
|
distribution_center - String
|
|
vendor - String
|
|
vendor_id - String
|
|
requested_delivery_date - ISODateTime
|
|
ship_not_before_date - ISODateTime
|
|
ship_no_later_than_date - ISODateTime
|
|
depositor_order_number - String
|
|
department - String
|
|
division - String
|
|
service_level - String
|
|
internal_supplier_number - String
|
|
terms_of_sale - String
|
|
retailer_notes - String
|
|
quote_number - String
|
|
sales_requirement_code - String
|
|
reference_fields - JSONObjectScalar
|
|
order_id - String
|
The id of the order associated with the wholesale order |
order - Order
|
|
wholesale_shipping_details - [WholesaleShippingDetails]
|
|
wholesale_line_items - WholesaleLineItemsQuerySpecConnection
|
|
Example
{
"id": "abc123",
"legacy_id": 123,
"version": "LEGACY",
"fulfillment_flow": "B2B_FULFILLMENT",
"shipping_option": "COURIER",
"staging_location_id": 123,
"picking_flow": "DESKTOP",
"outbound_progress": "AWAITING_SCHEDULE",
"pickup_date": ISODateTime,
"status": "pending",
"status_message": "abc123",
"preparation_date": ISODateTime,
"packing_layout": GenericScalar,
"order_type": "xyz789",
"gs1_labels_required": false,
"trading_partner_id": "abc123",
"trading_partner_name": "abc123",
"store_location_number": "xyz789",
"distribution_center": "xyz789",
"vendor": "abc123",
"vendor_id": "xyz789",
"requested_delivery_date": ISODateTime,
"ship_not_before_date": ISODateTime,
"ship_no_later_than_date": ISODateTime,
"depositor_order_number": "xyz789",
"department": "xyz789",
"division": "xyz789",
"service_level": "xyz789",
"internal_supplier_number": "abc123",
"terms_of_sale": "xyz789",
"retailer_notes": "xyz789",
"quote_number": "xyz789",
"sales_requirement_code": "abc123",
"reference_fields": JSONObjectScalar,
"order_id": "xyz789",
"order": Order,
"wholesale_shipping_details": [
WholesaleShippingDetails
],
"wholesale_line_items": WholesaleLineItemsQuerySpecConnection
}
WholesaleOrderAutoAllocateForPickingMutationOutput
Fields
| Field Name | Description |
|---|---|
request_id - String
|
|
complexity - Int
|
|
line_items - [WholesaleOrderAutoAllocateForPickingType]
|
Example
{
"request_id": "abc123",
"complexity": 123,
"line_items": [WholesaleOrderAutoAllocateForPickingType]
}
WholesaleOrderAutoAllocateForPickingType
WholesaleOrderAutoAllocateInput
Fields
| Input Field | Description |
|---|---|
order_id - String!
|
The id of the order associated with the wholesale order you want to modify |
prioritized_location_ids - [String!]
|
|
sort_lots - WholesaleSortBinByLotsDate
|
|
location_type - WholesaleLocationType
|
|
sort_stock - WholesaleSortBinByStock
|
|
prioritize_largest_uom - Boolean
|
|
lot_expires_in_days - Int
|
Example
{
"order_id": "xyz789",
"prioritized_location_ids": ["abc123"],
"sort_lots": "RECEIVING_FIFO",
"location_type": "PICKABLE",
"sort_stock": "LEAST",
"prioritize_largest_uom": false,
"lot_expires_in_days": 123
}
WholesaleOrderConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination data for this connection. |
edges - [WholesaleOrderEdge]!
|
Contains the nodes in this connection. |
Example
{
"pageInfo": PageInfo,
"edges": [WholesaleOrderEdge]
}
WholesaleOrderEdge
Description
A Relay edge containing a WholesaleOrder and its cursor.
Fields
| Field Name | Description |
|---|---|
node - WholesaleOrder
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": WholesaleOrder,
"cursor": "xyz789"
}
WholesaleOrderEditOutboundScheduleInput
Fields
| Input Field | Description |
|---|---|
order_id - String!
|
The id of the order associated with the wholesale order you want to modify |
outbound_progress - WholesaleOrderOutboundProgress
|
|
pickup_date - Date
|
Example
{
"order_id": "xyz789",
"outbound_progress": "AWAITING_SCHEDULE",
"pickup_date": "2007-12-03"
}
WholesaleOrderEditOutboundScheduleOutput
WholesaleOrderGenerateBOLInput
Fields
| Input Field | Description |
|---|---|
order_id - String!
|
The id of the order associated with the wholesale order you want to modify |
Example
{"order_id": "xyz789"}
WholesaleOrderGenerateBOLOutput
WholesaleOrderMutationOutput
Fields
| Field Name | Description |
|---|---|
request_id - String
|
|
complexity - Int
|
|
wholesale_order - WholesaleOrder
|
Example
{
"request_id": "abc123",
"complexity": 123,
"wholesale_order": WholesaleOrder
}
WholesaleOrderOutboundProgress
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"AWAITING_SCHEDULE"
WholesaleOrderPickingFlow
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DESKTOP"
WholesaleOrderPrintManualPickingSheetInput
Fields
| Input Field | Description |
|---|---|
order_id - String!
|
The id of the order associated with the wholesale order you want to modify |
Example
{"order_id": "xyz789"}
WholesaleOrderPrintManualPickingSheetOutput
WholesaleOrderPrintPackingListInput
WholesaleOrderPrintPackingListOutput
WholesaleOrderQueryResult
Fields
| Field Name | Description |
|---|---|
request_id - String
|
|
complexity - Int
|
|
data - WholesaleOrder
|
Example
{
"request_id": "xyz789",
"complexity": 123,
"data": WholesaleOrder
}
WholesaleOrderSetReadyToPickInput
Fields
| Input Field | Description |
|---|---|
order_id - String!
|
The id of the order associated with the wholesale order you want to modify |
Example
{"order_id": "xyz789"}
WholesaleOrderSetReadyToPickOutput
WholesaleOrderStatus
Description
Overall status for the entire label generation workflow of an order accross all batches
Public usage. Not to be confused with fulfillment status. The reason why this exists is
due to reprocessing, there could be multiple print batches per order.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"pending"
WholesaleOrderVersion
Description
The version of the order. This is used to determine which version of the wholesale view to
display these orders in, amongst other things.
The versioning is based on multiples of ten for the major and the integers between them as minors:
11 -> 1 1
| |__> Minor, in this case, Downgrade from EARTH to LEGACY
|_____> Major, in this case, LEGACY
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"LEGACY"
WholesaleOrdersQueryResult
WholesaleShippingDetails
Fields
| Field Name | Description |
|---|---|
id - String
|
|
legacy_id - Int
|
|
account_number - String
|
Account number |
scac - String
|
SCAC code for the shipping details |
carrier - String
|
Shipping carrier |
shipping_method - String
|
Shipping method |
bill_of_lading - String
|
Bill of lading number |
cost - Decimal
|
Shipping cost |
trailer_number - String
|
Trailer number |
pro_number - String
|
PRO number |
gs1_company_prefix - String
|
Company prefix for GS1 labels |
Example
{
"id": "xyz789",
"legacy_id": 987,
"account_number": "xyz789",
"scac": "xyz789",
"carrier": "xyz789",
"shipping_method": "abc123",
"bill_of_lading": "xyz789",
"cost": Decimal,
"trailer_number": "abc123",
"pro_number": "abc123",
"gs1_company_prefix": "xyz789"
}
WholesaleShippingDetailsInput
Fields
| Input Field | Description |
|---|---|
scac - String
|
SCAC code for the shipping details |
freighter - String
|
Freighter information |
bill_of_lading - String
|
Bill of lading number |
cost - Float
|
Shipping cost |
trailer_number - String
|
Trailer number |
pro_number - String
|
PRO number |
gs1_company_prefix - String
|
Company prefix for GS1 labels |
carrier - String
|
Shipping carrier (overrides order.shipping_carrier) |
shipping_method - String
|
Shipping method (overrides order.shipping_method) |
Example
{
"scac": "abc123",
"freighter": "abc123",
"bill_of_lading": "xyz789",
"cost": 987.65,
"trailer_number": "abc123",
"pro_number": "xyz789",
"gs1_company_prefix": "xyz789",
"carrier": "xyz789",
"shipping_method": "abc123"
}
WholesaleShippingOptions
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"COURIER"
WholesaleSortBinByLotsDate
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"RECEIVING_FIFO"
WholesaleSortBinByStock
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"LEAST"
WholesaleStagingLocationCandidatesQueryResult
WorkOrderAssemblyComponentType
WorkOrderAssemblySkuType
Fields
| Field Name | Description |
|---|---|
to_create_quantity - Int
|
|
created_quantity - Int
|
|
receiving_location - Location
|
|
staging_location - Location
|
|
account_id - ID
|
|
sku - String
|
|
created_at - DateTime
|
|
updated_at - DateTime
|
|
components - [WorkOrderAssemblyComponentType]
|
|
items_to_pick - Int
|
|
items_per_kit - Int
|
|
lot_name - String
|
|
lot_expiration_date - Date
|
Example
{
"to_create_quantity": 123,
"created_quantity": 987,
"receiving_location": Location,
"staging_location": Location,
"account_id": 4,
"sku": "abc123",
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"components": [WorkOrderAssemblyComponentType],
"items_to_pick": 123,
"items_per_kit": 987,
"lot_name": "xyz789",
"lot_expiration_date": "2007-12-03"
}
WorkOrderAttachmentType
WorkOrderIdentifiableType
Fields
| Field Name | Description |
|---|---|
id - String
|
|
legacy_id - Int
|
|
account_id - ID
|
|
warehouse_id - ID
|
|
name - String
|
|
configuration - String
|
|
type - WorkOrderType
|
|
scheduled_date - DateTime
|
|
requested_date - DateTime
|
|
started_at - DateTime
|
|
ended_at - DateTime
|
|
ready_to_pick_at - DateTime
|
|
assembly_in_progress_at - DateTime
|
|
completed_at - DateTime
|
|
created_at - DateTime
|
|
updated_at - DateTime
|
|
status - WorkOrderStatus
|
|
has_special_project - Boolean
|
|
priority - WorkOrderPriority
|
|
notes - [WorkOrderNotesType]
|
|
assembly_sku - WorkOrderAssemblySkuType
|
Example
{
"id": "abc123",
"legacy_id": 987,
"account_id": "4",
"warehouse_id": "4",
"name": "abc123",
"configuration": "abc123",
"type": "ASSEMBLY",
"scheduled_date": "2007-12-03T10:15:30Z",
"requested_date": "2007-12-03T10:15:30Z",
"started_at": "2007-12-03T10:15:30Z",
"ended_at": "2007-12-03T10:15:30Z",
"ready_to_pick_at": "2007-12-03T10:15:30Z",
"assembly_in_progress_at": "2007-12-03T10:15:30Z",
"completed_at": "2007-12-03T10:15:30Z",
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z",
"status": "PENDING_APPROVAL",
"has_special_project": false,
"priority": "HIGH",
"notes": [WorkOrderNotesType],
"assembly_sku": WorkOrderAssemblySkuType
}
WorkOrderIdentifiableTypeConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination data for this connection. |
edges - [WorkOrderIdentifiableTypeEdge]!
|
Contains the nodes in this connection. |
Example
{
"pageInfo": PageInfo,
"edges": [WorkOrderIdentifiableTypeEdge]
}
WorkOrderIdentifiableTypeEdge
Description
A Relay edge containing a WorkOrderIdentifiableType and its cursor.
Fields
| Field Name | Description |
|---|---|
node - WorkOrderIdentifiableType
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": WorkOrderIdentifiableType,
"cursor": "abc123"
}
WorkOrderMutationOutput
Fields
| Field Name | Description |
|---|---|
request_id - String
|
|
complexity - Int
|
|
work_order - WorkOrderIdentifiableType
|
Example
{
"request_id": "abc123",
"complexity": 123,
"work_order": WorkOrderIdentifiableType
}
WorkOrderNotesType
Fields
| Field Name | Description |
|---|---|
note - String
|
|
type - WorkOrdersNoteType
|
|
account_id - ID
|
|
created_at - DateTime
|
|
updated_at - DateTime
|
Example
{
"note": "xyz789",
"type": "NOTE",
"account_id": "4",
"created_at": "2007-12-03T10:15:30Z",
"updated_at": "2007-12-03T10:15:30Z"
}
WorkOrderPriority
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"HIGH"
WorkOrderQueryResult
Fields
| Field Name | Description |
|---|---|
request_id - String
|
|
complexity - Int
|
|
data - WorkOrderIdentifiableType
|
Example
{
"request_id": "xyz789",
"complexity": 987,
"data": WorkOrderIdentifiableType
}
WorkOrderStatus
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"PENDING_APPROVAL"
WorkOrderType
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ASSEMBLY"
WorkOrdersNoteType
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"NOTE"