Inventory
Requires access scope.
Represents an inventory shipment.
Anchor to Fields and connectionsFields and connections
- •ID!non-null
A globally-unique ID.
- Anchor to lineItemCountline•Int!non-null
Item Count The number of items associated with the shipment.
- Anchor to lineItemsline•Inventory
Items Shipment Line Item Connection The line items included in this shipment.
- Anchor to lineItemTotalQuantityline•Int!non-null
Item Total Quantity The total quantity of all items in the shipment.
- Anchor to namename•String!non-null
The name of the inventory shipment.
- Anchor to statusstatus•Inventory
Shipment Status!non-null The current status of the shipment.
- Anchor to totalAcceptedQuantitytotal•Int!non-null
Accepted Quantity The total quantity of items accepted across all line items in this shipment.
- Anchor to totalReceivedQuantitytotal•Int!non-null
Received Quantity The total quantity of items received (both accepted and rejected) across all line items in this shipment.
- Anchor to totalRejectedQuantitytotal•Int!non-null
Rejected Quantity The total quantity of items rejected across all line items in this shipment.
- Anchor to trackingtracking•Inventory
Shipment Tracking The tracking information for the shipment.
Anchor to MutationsMutations
- •mutation
Adds items to a draft inventory shipment.
- •ID!required
The ID of the draft inventory shipment to modify.
- Anchor to lineItemsline•[Inventory
Items Shipment Line Item Input!]!required The list of line items to add to the inventory shipment.
Arguments
- Anchor to addedItemsadded•[Inventory
Items Shipment Line Item!] The list of added line items.
- Anchor to inventoryShipmentinventory•Inventory
Shipment Shipment The inventory shipment with the added items.
- Anchor to userErrorsuser•[Inventory
Errors Shipment Add Items User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Marks a draft inventory shipment as in transit.
- Anchor to inventoryShipmentIdinventory•ID!required
Shipment Id The ID of the inventory shipment to mark in transit.
Arguments
- Anchor to inventoryShipmentinventory•Inventory
Shipment Shipment The marked in transit inventory shipment.
- Anchor to userErrorsuser•[Inventory
Errors Shipment Mark In Transit User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Receive an inventory shipment.
- Anchor to bulkReceiveActionbulk•Inventory
Receive Action Shipment Receive Line Item Reason The bulk receive action for the inventory shipment.
- •ID!required
The ID of the inventory shipment to receive.
- Anchor to lineItemsline•[Inventory
Items Shipment Receive Item Input!] The list of receive line items for the inventory shipment.
Arguments
- Anchor to inventoryShipmentinventory•Inventory
Shipment Shipment The inventory shipment with received items.
- Anchor to userErrorsuser•[Inventory
Errors Shipment Receive User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Remove items from an inventory shipment.
- •ID!required
The ID of the inventory shipment to remove items from.
- Anchor to lineItemsline•[ID!]!required
Items A list of inventory shipment line item ids representing the items to be removed from the shipment.
Arguments
- Anchor to inventoryShipmentinventory•Inventory
Shipment Shipment The inventory shipment with items removed.
- Anchor to userErrorsuser•[Inventory
Errors Shipment Remove Items User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Edits the tracking info on an inventory shipment.
- •ID!required
The ID of the inventory shipment whose tracking info is being edited.
- Anchor to trackingtracking•Inventory
Shipment Tracking Input!required The tracking info to edit on the inventory shipment.
Arguments
- Anchor to inventoryShipmentinventory•Inventory
Shipment Shipment The inventory shipment with the edited tracking info.
- Anchor to userErrorsuser•[Inventory
Errors Shipment Set Tracking User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Updates items on a draft inventory shipment.
- •ID!required
The ID of the inventory shipment to update item quantities.
- Anchor to itemsitems•[Inventory
Shipment Update Item Quantities Input!]Default:[] The list of line items to be updated to the shipment.
Arguments
- Anchor to shipmentshipment•Inventory
Shipment The inventory shipment with updated item quantities.
- Anchor to updatedLineItemsupdated•[Inventory
Line Items Shipment Line Item!] The updated item quantities.
- Anchor to userErrorsuser•[Inventory
Errors Shipment Update Item Quantities User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Adds a draft shipment to an inventory transfer.
- Anchor to inputinput•Inventory
Transfer Add Shipment Input!required The input fields for the inventory shipment.
Arguments
- Anchor to inventoryShipmentinventory•Inventory
Shipment Shipment The created inventory shipment.
- Anchor to userErrorsuser•[Inventory
Errors Transfer Add Draft Shipment User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Adds an in-transit shipment to an inventory transfer.
- Anchor to inputinput•Inventory
Transfer Add Shipment Input!required The input fields for the inventory shipment.
Arguments
- Anchor to inventoryShipmentinventory•Inventory
Shipment Shipment The created inventory shipment.
- Anchor to userErrorsuser•[Inventory
Errors Transfer Add In Transit Shipment User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields