createShipmentItem

Topics: Logistics

Create a new shipment item. Requires shipment:write permission.

Returns

UpsertShipmentItemPayload!

Arguments

Shipment item data

Examples

Add Logistics Shipment Item

mutation AddLogisticsShipmentItem($input: CreateShipmentItemInput!) {
  createShipmentItem(input: $input) {
    shipmentItem { id packageId quantity orderLineId }
    errors { path message }
  }
}

Variables

{
  "input": {
    "packageId": "spk_000001048h848r248h248h248h",
    "jobId": "job_000000248h848r248h248h248h",
    "orderLineId": "oln_000001848h848r248h248h248h",
    "description": "Autumn brochures — first dispatch",
    "quantity": 2000
  }
}
Exact field SDL
"""Create a new shipment item. Requires shipment:write permission."""
createShipmentItem(
  """Shipment item data"""
  input: CreateShipmentItemInput!
): UpsertShipmentItemPayload! @topic(names: ["logistics"]) @topic_example(names: ["logistics.add-shipment-item"])

Declared on Mutation. Access is checked by the platform for each operation.