Inventory Shipment Create Payload
Return type for mutation.
Anchor to FieldsFields
- inventoryShipment (InventoryShipment)
- userErrors ([InventoryShipmentCreateUserError!]!)
- Anchor to inventoryShipmentinventory•Inventory
Shipment Shipment The created inventory shipment.
- Anchor to userErrorsuser•[Inventory
Errors Shipment Create User Error!]! non-null The list of errors that occurred from executing the mutation.
Anchor to Mutations with this payloadMutations with this payload
- inventoryShipmentCreate (InventoryShipmentCreatePayload)
- •mutation
Adds a draft shipment to an inventory transfer.
CautionAs of 2026-01, this mutation supports an optional idempotency key using the
@idempotentdirective. As of 2026-04, the idempotency key is required and must be provided using the@idempotentdirective. For more information, see the idempotency documentation.Caution:As of 2026-01, this mutation supports an optional idempotency key using the
@idempotentdirective. As of 2026-04, the idempotency key is required and must be provided using the@idempotentdirective. For more information, see the idempotency documentation.Caution: As of 2026-01, this mutation supports an optional idempotency key using the <code>@idempotent</code> directive. As of 2026-04, the idempotency key is required and must be provided using the <code>@idempotent</code> directive. For more information, see the <a href="https://shopify.dev/docs/api/usage/idempotent-requests">idempotency documentation</a>.
- Anchor to inputinput•Inventory
Shipment Create Input! required The input fields for the inventory shipment.
Arguments