---
updatedAt: 2026-02-16T08:50:06.000Z
agentTools:
  projectIndex: https://docs.myfatoorah.com/llms.txt
---

# 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](https://docs.myfatoorah.com/docs/shipping) section.

The endpoint on Swagger is: [Shipping\_UpdateShippingStatus](https://apitest.myfatoorah.com/swagger/ui/index#!/Shipping/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](https://docs.myfatoorah.com/docs/test-token).

<hr />

## **Request Model**

The request is a POST request with the following parameters:

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th>
        Input Parameter
      </th>

      <th>
        Type
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        **ShippingMethod**
      </td>

      <td>
        integer
      </td>

      <td>
        * \*1\*\* for DHL  
        * \*2\*\* for ARAMEX
      </td>
    </tr>

    <tr>
      <td>
        **InvoiceNumbers**
      </td>

      <td>
        Array[integer], optional
      </td>

      <td>
        A list of the invoice IDs to update their status
      </td>
    </tr>

    <tr>
      <td>
        **OrderStatusChangedTo**
      </td>

      <td>
        integer, optional
      </td>

      <td>
        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
      </td>
    </tr>
  </tbody>
</Table>

<hr />

## **Response Model**

After viewing the [Response Model](https://docs.myfatoorah.com/docs/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  |             |

<hr />

## **Sample Message**

```json Request
{
  "ShippingMethod":1,
  "InvoiceNumbers": [
  	40481,40480
  ],
  "OrderStatusChangedTo": 1
}
```
```json Response
{
    "IsSuccess": true,
    "Message": null,
    "FieldsErrors": null,
    "Data": {
        "ShippingOrder": [
            {
                "OrderNumber": 40480,
                "OrderStatus": "Prepared"
            },
            {
                "OrderNumber": 40481,
                "OrderStatus": "Prepared"
            }
        ]
    }
}
```

<hr />