createShipment
Topics: Logistics
Create a new shipment. Requires shipment:write permission.
Examples
Create Logistics Shipment
mutation CreateLogisticsShipment($input: CreateShipmentInput!) {
createShipment(input: $input) {
shipment { id shipmentNumber status }
errors { path message }
}
}Variables
{
"input": {
"orderId": "ord_000001648h848r248h248h248h",
"destinationSnapshot": {
"recipientOrganization": "North Street Books",
"street1": "18 Example Road",
"city": "Bristol",
"postalCode": "BS1 1AA",
"country": "GB"
},
"shipmentNumber": "SHIP-2026-1042",
"status": "DRAFT",
"notes": "First 2,000 copies of the 5,000-copy brochure delivery."
}
}Exact field SDL
"""Create a new shipment. Requires shipment:write permission."""
createShipment(
"""Shipment data"""
input: CreateShipmentInput!
): UpsertShipmentPayload! @topic(names: ["logistics"]) @topic_example(names: ["logistics.create-shipment"])Declared on Mutation. Access is checked by the platform for each operation.