inboundShipment

Fetch a single inbound shipment by its id.

Required scopes: inventory_read

Arguments

id · ID! · required

The id of the inbound shipment to fetch.

Returns

inboundShipment · InboundShipment

A shipment of inventory arriving at a location, fulfilling one or more purchase orders.

Show fields

actualArrivalDate · Date

The date the shipment actually arrived.

carrier · String

The carrier transporting the shipment.

createdAt · DateTime! · required

When the record was created.

dutyCost · Money

The duty cost incurred for the shipment.

Show fields

amount · Decimal! · required

The exact amount as a decimal string (e.g. “19.99”).

currency · String! · required

ISO 4217 currency code (e.g. USD).

estimatedArrivalDate · Date

The estimated date the shipment will arrive.

freightCost · Money

The cost of freight for the shipment.

Show fields

amount · Decimal! · required

The exact amount as a decimal string (e.g. “19.99”).

currency · String! · required

ISO 4217 currency code (e.g. USD).

freightType · String

The type of freight used for the shipment.

id · ID! · required

The id of this inbound shipment.

items · InboundShipmentItemConnection! · required

A paginated list of the shipment’s line items.

Requires: inventory_read

Show fields

Arguments

after · String

Forward pagination cursor — returns items after it. Pass an edges[].cursor or pageInfo.endCursor from a previous page.

before · String

Backward pagination cursor — returns items before it. Pass an edges[].cursor or pageInfo.startCursor from a previous page.

first · Int

Forward pagination: returns the first N items (max 100, default 25). Use with after; mutually exclusive with last/before.

last · Int

Backward pagination: returns the last N items (max 100, default 25). Use with before; mutually exclusive with first/after.

Fields

edges · [InboundShipmentItemEdge!]! · required

The list of edges (each a node plus its pagination cursor).

Show fields

cursor · String! · required

Opaque cursor for this item; pass to after/before to page from here.

node · InboundShipmentItem! · required

The item at this edge.

nodes · [InboundShipmentItem!]! · required

The nodes in this page, without the edge/cursor wrapper — a convenience over edges.

Show fields

createdAt · DateTime! · required

When the record was created.

damagedQuantity · Int! · required

The quantity received damaged for this line item.

id · ID! · required

The id of this shipment line item.

packingMode · PackingMode! · required

How this line item is packed.

product · Product

The product received on this line item.

Requires: products_read

purchaseOrder · PurchaseOrder

The purchase order this received item was ordered on, if any.

Requires: inventory_read

quantity · Int! · required

The quantity expected on this line item.

receivedQuantity · Int! · required

The quantity received for this line item.

updatedAt · DateTime! · required

When the record was last updated.

pageInfo · PageInfo! · required

Pagination metadata for the current page.

Show fields

endCursor · String

Cursor of the last edge in this page; pass to after to page forward.

hasNextPage · Boolean! · required

Whether more items exist after this page (drives forward pagination with first/after).

hasPreviousPage · Boolean! · required

Whether more items exist before this page (drives backward pagination with last/before).

startCursor · String

Cursor of the first edge in this page; pass to before to page backward.

location · Location

The location the shipment is arriving at.

Requires: locations_read

Show fields

city · String

The city of the location’s address.

company · String

The company name associated with the location.

countryCode · String

The country code, e.g. “US”.

createdAt · DateTime! · required

When the record was created.

id · ID! · required

The id of this location.

inventoryLevels · LocationInventoryLevelConnection! · required

Per-product inventory levels held at this location.

Requires: inventory_read

Show fields

Arguments

after · String

Forward pagination cursor — returns items after it. Pass an edges[].cursor or pageInfo.endCursor from a previous page.

before · String

Backward pagination cursor — returns items before it. Pass an edges[].cursor or pageInfo.startCursor from a previous page.

first · Int

Forward pagination: returns the first N items (max 100, default 25). Use with after; mutually exclusive with last/before.

last · Int

Backward pagination: returns the last N items (max 100, default 25). Use with before; mutually exclusive with first/after.

Fields

edges · [LocationInventoryLevelEdge!]! · required

The list of edges (each a node plus its pagination cursor).

nodes · [LocationInventoryLevel!]! · required

The nodes in this page, without the edge/cursor wrapper — a convenience over edges.

pageInfo · PageInfo! · required

Pagination metadata for the current page.

name · String! · required

The location’s display name.

phone · String

The contact phone number for the location.

postalCode · String

The postal or ZIP code, e.g. “84101”.

stateCode · String

The state or province code, e.g. “UT”.

street1 · String

The first line of the street address.

street2 · String

The second line of the street address.

updatedAt · DateTime! · required

When the record was last updated.

paymentTerms · String

The payment terms agreed for the shipment.

purchaseOrders · PurchaseOrderConnection! · required

Purchase orders this shipment fulfills.

Requires: inventory_read

Show fields

Arguments

after · String

Forward pagination cursor — returns items after it. Pass an edges[].cursor or pageInfo.endCursor from a previous page.

before · String

Backward pagination cursor — returns items before it. Pass an edges[].cursor or pageInfo.startCursor from a previous page.

first · Int

Forward pagination: returns the first N items (max 100, default 25). Use with after; mutually exclusive with last/before.

last · Int

Backward pagination: returns the last N items (max 100, default 25). Use with before; mutually exclusive with first/after.

Fields

edges · [PurchaseOrderEdge!]! · required

The list of edges (each a node plus its pagination cursor).

Show fields

cursor · String! · required

Opaque cursor for this item; pass to after/before to page from here.

node · PurchaseOrder! · required

The item at this edge.

nodes · [PurchaseOrder!]! · required

The nodes in this page, without the edge/cursor wrapper — a convenience over edges.

Show fields

closedAt · DateTime

When the purchase order was closed.

createdAt · DateTime! · required

When the record was created.

id · ID! · required

The id of this purchase order.

items · PurchaseOrderItemConnection! · required

A paginated list of the order’s line items.

Requires: inventory_read

Show fields

Arguments

after · String

Forward pagination cursor — returns items after it. Pass an edges[].cursor or pageInfo.endCursor from a previous page.

before · String

Backward pagination cursor — returns items before it. Pass an edges[].cursor or pageInfo.startCursor from a previous page.

first · Int

Forward pagination: returns the first N items (max 100, default 25). Use with after; mutually exclusive with last/before.

last · Int

Backward pagination: returns the last N items (max 100, default 25). Use with before; mutually exclusive with first/after.

location · Location

The location the order’s inventory is destined for.

Requires: locations_read

note · String

An internal note on the purchase order.

orderedAt · Date

The date the order was placed with the supplier.

poNumber · String! · required

The merchant-facing purchase order number.

referenceNumber · String

An external reference for the purchase order.

shipments · InboundShipmentConnection! · required

Inbound shipments fulfilling this purchase order.

Requires: inventory_read

Show fields

Arguments

after · String

Forward pagination cursor — returns items after it. Pass an edges[].cursor or pageInfo.endCursor from a previous page.

before · String

Backward pagination cursor — returns items before it. Pass an edges[].cursor or pageInfo.startCursor from a previous page.

first · Int

Forward pagination: returns the first N items (max 100, default 25). Use with after; mutually exclusive with last/before.

last · Int

Backward pagination: returns the last N items (max 100, default 25). Use with before; mutually exclusive with first/after.

status · PurchaseOrderStatus! · required

The current lifecycle status of the purchase order.

supplier · Supplier

The supplier the order was placed with.

Requires: inventory_read

supplierNote · String

A note shared with the supplier.

tags · [String!]! · required

Free-form tags applied to the purchase order.

updatedAt · DateTime! · required

When the record was last updated.

pageInfo · PageInfo! · required

Pagination metadata for the current page.

Show fields

endCursor · String

Cursor of the last edge in this page; pass to after to page forward.

hasNextPage · Boolean! · required

Whether more items exist after this page (drives forward pagination with first/after).

hasPreviousPage · Boolean! · required

Whether more items exist before this page (drives backward pagination with last/before).

startCursor · String

Cursor of the first edge in this page; pass to before to page backward.

shipmentId · String

The carrier’s identifier for the shipment.

status · InboundShipmentStatus! · required

The current status of the shipment.

trackingNumber · String

The shipment’s tracking number.

trackingUrl · String

A URL to track the shipment.

updatedAt · DateTime! · required

When the record was last updated.

Example

query {
  inboundShipment(id: "...") {
    actualArrivalDate
    carrier
    createdAt
    estimatedArrivalDate
    freightType
    id
    items {
      nodes {
        createdAt
        damagedQuantity
        id
        packingMode
        quantity
        receivedQuantity
        updatedAt
      }
      pageInfo {
        hasNextPage
        endCursor
      }
    }
    paymentTerms
    # ...
  }
}