Order - Storefront GraphQL API

mutation

updateShipmentStatus

Update current status of a specific shipment using its shipment ID. Supports both partial and full transition as per the configured settings.

Arguments

shipmentId

String!

Required

ID of the shipment. An order may contain multiple items and may get divided into one or more shipment, each having its own ID.

updateShipmentStatusRequestInput

UpdateShipmentStatusRequestInput!

Required

Schema for update shipment status request.

Response

statuses

[StatusesBodyResponse]

An array containing different status options of shipments.

Mutation

1mutation updateShipmentStatus(
2  $shipmentId: String!
3  $updateShipmentStatusRequestInput: UpdateShipmentStatusRequestInput!
4) {
5  updateShipmentStatus(
6    shipmentId: $shipmentId
7    updateShipmentStatusRequestInput: $updateShipmentStatusRequestInput
8  ) {
9    statuses {
10      shipments
11    }
12  }
13}

Try it

Input Variables

1{
2  "shipmentId": "shipmentId",
3  "updateShipmentStatusRequestInput": {
4    "force_transition": true,
5    "lock_after_transition": true,
6    "statuses": [
7      {
8        "exclude_bags_next_state": "exclude_bags_next_state",
9        "shipments": [
10          {
11            "data_updates": {
12              "entities": [
13                {
14                  "data": {},
15                  "filters": [
16                    {}
17                  ]
18                }
19              ],
20              "products": [
21                {
22                  "data": {},
23                  "filters": [
24                    {
25                      "identifier": "08a16b83-9094-4e89-8c05-2ccadd5c1c7e",
26                      "line_number": 42
27                    }
28                  ]
29                }
30              ]
31            },
32            "identifier": "08a16b83-9094-4e89-8c05-2ccadd5c1c7e",
33            "products": [
34              {
35                "identifier": "08a16b83-9094-4e89-8c05-2ccadd5c1c7e",
36                "line_number": 42,
37                "quantity": 42
38              }
39            ],
40            "reasons": {
41              "entities": [
42                {
43                  "data": {
44                    "reason_id": 42,
45                    "reason_text": "reason_text"
46                  },
47                  "filters": [
48                    {}
49                  ]
50                }
51              ],
52              "products": [
53                {
54                  "data": {
55                    "reason_id": 42,
56                    "reason_text": "reason_text"
57                  },
58                  "filters": [
59                    {
60                      "identifier": "08a16b83-9094-4e89-8c05-2ccadd5c1c7e",
61                      "line_number": 42,
62                      "quantity": 42
63                    }
64                  ]
65                }
66              ]
67            }
68          }
69        ],
70        "status": "status"
71      }
72    ],
73    "task": true,
74    "unlock_before_transition": true
75  }
76}

Response

1{
2  "updateShipmentStatus": {
3    "statuses": [
4      {
5        "shipments": [
6          {}
7        ]
8      }
9    ]
10  }
11}

Was this section helpful?

« ValidateAddressResponse

order »