> ## Documentation Index
> Fetch the complete documentation index at: https://developers.redo.com/llms.txt
> Use this file to discover all available pages before exploring further.
# createInboundShipment
> Create an inbound shipment fulfilling a purchase order. Its line items are derived from that order, not supplied: when this is the order's only shipment they mirror the order exactly, but once an order has several shipments new order lines are left unassigned and quantity changes stop propagating. Throws a 409 CONFLICT error (with an extension code of PURCHASE_ORDER_NOT_EDITABLE) if the order is closed or cancelled.
**Required scopes:** [`inventory_write`](/docs/api-reference/v3/reference/scopes#scope-inventory_write)
## Arguments
CreateInboundShipmentInput!} required>
The details of the inbound shipment to create.
Date}>
The date the shipment actually arrived.
The carrier transporting the shipment.
MoneyInput}>
The duty cost incurred. Defaults to zero in the purchase order's currency.
Decimal!} required>
The amount as an exact decimal string (e.g. "19.99").
ISO 4217 currency code (e.g. USD).
Date}>
The estimated date the shipment will arrive.
MoneyInput}>
The cost of freight. Defaults to zero in the purchase order's currency.
Decimal!} required>
The amount as an exact decimal string (e.g. "19.99").
ISO 4217 currency code (e.g. USD).
The type of freight used for the shipment.
The location the shipment is arriving at. Defaults to the purchase order's location.
The payment terms agreed for the shipment.
The purchase order this shipment fulfills.
Your own shipment number. Auto-generated as SH-#### when omitted.
The shipment's tracking number.
A URL to track the shipment.
## Returns
InboundShipment!} required>
A shipment of inventory arriving at a location, fulfilling one or more purchase orders.
Date}>
The date the shipment actually arrived.
The carrier transporting the shipment.
DateTime!} required>
When the record was created.
Money}>
The duty cost incurred for the shipment.
Decimal!} required>
The exact amount as a decimal string (e.g. "19.99").
ISO 4217 currency code (e.g. USD).
Date}>
The estimated date the shipment will arrive.
Money}>
The cost of freight for the shipment.
Decimal!} required>
The exact amount as a decimal string (e.g. "19.99").
ISO 4217 currency code (e.g. USD).
The type of freight used for the shipment.
The id of this inbound shipment.
InboundShipmentItemConnection!} required>
A paginated list of the shipment's line items.
**Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)
**Arguments**
Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
**Fields**
[InboundShipmentItemEdge!]!} required>
The list of edges (each a node plus its pagination `cursor`).
Opaque cursor for this item; pass to `after`/`before` to page from here.
InboundShipmentItem!} required>
The item at this edge.
[InboundShipmentItem!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
DateTime!} required>
When the record was created.
The quantity received damaged for this line item.
The id of this shipment line item.
PackingMode!} required>
How this line item is packed.
Product}>
The product received on this line item.
**Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)
PurchaseOrder}>
The purchase order this received item was ordered on, if any.
**Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)
The quantity expected on this line item.
The quantity received for this line item.
DateTime!} required>
When the record was last updated.
PageInfo!} required>
Pagination metadata for the current page.
Cursor of the last edge in this page; pass to `after` to page forward.
Whether more items exist after this page (drives forward pagination with `first`/`after`).
Whether more items exist before this page (drives backward pagination with `last`/`before`).
Cursor of the first edge in this page; pass to `before` to page backward.
Location}>
The location the shipment is arriving at.
**Requires:** [`locations_read`](/docs/api-reference/v3/reference/scopes#scope-locations_read)
The city of the location's address.
The company name associated with the location.
The country code, e.g. "US".
DateTime!} required>
When the record was created.
The id of this location.
InventoryItemConnection!} required>
Traceable inventory units at this warehouse.
**Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)
**Arguments**
Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
**Fields**
[InventoryItemEdge!]!} required>
The list of edges (each a node plus its pagination `cursor`).
[InventoryItem!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
PageInfo!} required>
Pagination metadata for the current page.
LocationInventoryLevelConnection!} required>
Per-product inventory levels held at this location.
**Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)
**Arguments**
Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
**Fields**
[LocationInventoryLevelEdge!]!} required>
The list of edges (each a node plus its pagination `cursor`).
[LocationInventoryLevel!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
PageInfo!} required>
Pagination metadata for the current page.
The location's display name.
The contact phone number for the location.
The postal or ZIP code, e.g. "84101".
The state or province code, e.g. "UT".
StorageLocationConnection!} required>
Bins and other storage locations within this warehouse.
**Requires:** [`locations_read`](/docs/api-reference/v3/reference/scopes#scope-locations_read)
**Arguments**
Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
**Fields**
[StorageLocationEdge!]!} required>
The list of edges (each a node plus its pagination `cursor`).
[StorageLocation!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
PageInfo!} required>
Pagination metadata for the current page.
The first line of the street address.
The second line of the street address.
DateTime!} required>
When the record was last updated.
The payment terms agreed for the shipment.
PurchaseOrderConnection!} required>
Purchase orders this shipment fulfills.
**Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)
**Arguments**
Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
**Fields**
[PurchaseOrderEdge!]!} required>
The list of edges (each a node plus its pagination `cursor`).
Opaque cursor for this item; pass to `after`/`before` to page from here.
PurchaseOrder!} required>
The item at this edge.
[PurchaseOrder!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
DateTime}>
When the purchase order was closed.
DateTime!} required>
When the record was created.
The id of this purchase order.
PurchaseOrderItemConnection!} required>
A paginated list of the order's line items.
**Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)
**Arguments**
Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
Location}>
The location the order's inventory is destined for.
**Requires:** [`locations_read`](/docs/api-reference/v3/reference/scopes#scope-locations_read)
An internal note on the purchase order.
Date}>
The date the order was placed with the supplier.
The merchant-facing purchase order number.
An external reference for the purchase order.
InboundShipmentConnection!} required>
Inbound shipments fulfilling this purchase order.
**Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)
**Arguments**
Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
PurchaseOrderStatus!} required>
The current lifecycle status of the purchase order.
Supplier}>
The supplier the order was placed with.
**Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)
A note shared with the supplier.
Free-form tags applied to the purchase order.
DateTime!} required>
When the record was last updated.
PageInfo!} required>
Pagination metadata for the current page.
Cursor of the last edge in this page; pass to `after` to page forward.
Whether more items exist after this page (drives forward pagination with `first`/`after`).
Whether more items exist before this page (drives backward pagination with `last`/`before`).
Cursor of the first edge in this page; pass to `before` to page backward.
The carrier's identifier for the shipment.
InboundShipmentStatus!} required>
The current status of the shipment.
The shipment's tracking number.
A URL to track the shipment.
DateTime!} required>
When the record was last updated.
## Example
```graphql theme={null}
mutation {
createInboundShipment(input: { ... }) {
actualArrivalDate
carrier
createdAt
estimatedArrivalDate
freightType
id
items {
nodes {
createdAt
damagedQuantity
id
packingMode
quantity
receivedQuantity
updatedAt
}
pageInfo { hasNextPage endCursor }
}
paymentTerms
# ...
}
}
```
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.