UpdateShippingStatus
Endpoint
Overview
The "UpdateShippingStatus" endpoint is a POST request. It is used to Update the Status of the Shipping supported by the MyFatoorah Shipping Module that belongs to either DHL or ARAMEX. Detailed functionality of how to use this endpoint is explained in the Shipping section.
The endpoint on Swagger is: Shipping_UpdateShippingStatus.
Now, we are going to declare the endpoint and its models along with each accepted parameter and possible value.
Request Header
Add "Authorization": "Bearer {Token}" to request header. Token of demo configuration can be found here.
Request Model
The request is a POST request with the following parameters:
| Input Parameter | Type | Description |
|---|---|---|
| ShippingMethod | integer | 1 for DHL 2 for ARAMEX |
| InvoiceNumbers | Array[integer], optional | A list of the invoice IDs to update their status |
| OrderStatusChangedTo | integer, optional | The range is from 0 to 4 as follows: 0 for Pending Status 1 for Prepared Status 2 for RequestPickup Status 3 for Picked Status 4 for Delivered Status |
Response Model
After viewing the Response Model that you will get as a result of your request, here, you will find full details about the Data Model of this API endpoint. Let's check it and its contents.
| Response Field | Type | Description |
|---|---|---|
| ShippingOrder | array of ShippingOrderStatuses |
ShippingOrderStatuses
| Response Field | Type | Description |
|---|---|---|
| OrderNumber | integer | |
| OrderStatus | string |
Sample Message
{
"ShippingMethod":1,
"InvoiceNumbers": [
40481,40480
],
"OrderStatusChangedTo": 1
}
{
"IsSuccess": true,
"Message": null,
"FieldsErrors": null,
"Data": {
"ShippingOrder": [
{
"OrderNumber": 40480,
"OrderStatus": "Prepared"
},
{
"OrderNumber": 40481,
"OrderStatus": "Prepared"
}
]
}
}
Updated 9 months ago