mutation ShipOrder($request: ShipOrderCommandRequestInput!) {
ShipOrder(request: $request) {
deliveryNotes {
id
number
packages {
id
packageId
trackingId
isShipped
}
}
}
}{
"request": {
"orderId": "id",
"picklistId": "id",
"warehouseId": "id",
"userId": "id",
"packages": [
{
"positions": [
{
"quantity": "value"
}
],
"shippingMethodId": "id",
"weight": "value"
}
]
}
}{
"data": {
"ShipOrder": {
"deliveryNotes": [
{
"id": "id",
"number": "string",
"packages": [
{
"id": "id",
"packageId": "string",
"trackingId": "string",
"isShipped": true
}
]
}
]
}
}
}ShipOrder
Ships an order after batch picking — packs it into packages and persists it to the database. A package is marked shipped only when its DeliveryDate is supplied (and, for shipping methods that require a tracking id, only when its TrackingId is supplied); jtl-Shipping packages complete themselves. Each package carries its positions, shipping method, weight, dimensions, optional packaging materials, SSCC, tracking id and delivery date. Returns the created delivery note and packages. A per-package PackageId (for shipping-label retrieval) is only assigned when the shipping-preparation feature and licence are active.
If a request with this mutation’s Idempotency-Key was already completed, the response’s extensions contains an idempotency.{responseName} entry with wasReplayed: true.
ShipOrder(request: ShipOrderCommandRequestInput!): ShipOrderResponse!Arguments
Returns
The delivery notes created by this call (currently exactly one).
mutation ShipOrder($request: ShipOrderCommandRequestInput!) {
ShipOrder(request: $request) {
deliveryNotes {
id
number
packages {
id
packageId
trackingId
isShipped
}
}
}
}{
"request": {
"orderId": "id",
"picklistId": "id",
"warehouseId": "id",
"userId": "id",
"packages": [
{
"positions": [
{
"quantity": "value"
}
],
"shippingMethodId": "id",
"weight": "value"
}
]
}
}{
"data": {
"ShipOrder": {
"deliveryNotes": [
{
"id": "id",
"number": "string",
"packages": [
{
"id": "id",
"packageId": "string",
"trackingId": "string",
"isShipped": true
}
]
}
]
}
}
}Was this page helpful?