GetShippingOrderList

Endpoint

Overview

The "GetShippingOrderList" endpoint is a GET request. It is used to retrieve the shipping orders list 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_GetShippingOrderList.

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 GET request with the following parameters:

Input Parameter	Type	Description
ShippingMethod	integer	1 for DHL 2 for ARAMEX
orderStatus	integer	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
start	integer, optional
length	integer, optional

---

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
ShippingMethod	string	1 for DHL 2 for ARAMEX
OrderStatus	string
TotalOrders	integer	The numbers of total shipping orders.
OrderNumbers	array of integers	A list of MyFatoorah order IDs
ShippingOrders	array of ShippingOrder objects

ShippingOrder

Response Field	Type	Description
OrderNumber	integer	The MyFatoorah order ID
OrderType	string
OrderStatus	string	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
CustomerName	string
ShippingMethod	string	1 for DHL 2 for ARAMEX
ShippingValue	number

---

Sample Message

Request

/v2/GetShippingOrderList?ShippingMethod=1&orderStatus=0

Response

{
    "IsSuccess": true,
    "Message": null,
    "FieldsErrors": null,
    "Data": {
        "ShippingMethod": "DHL",
        "OrderStatus": "Pending",
        "TotalOrders": 98,
        "OrderNumbers": [
            299466,
            299462,
            286498,
            .............
        ],
        "ShippingOrders": [
            {
                "OrderNumber": 299466,
                "OrderType": "Shipping",
                "OrderStatus": "Pending",
                "CustomerName": "[email protected]",
                "ShippingMethod": "DHL",
                "ShippingValue": 3.669
            },
            {
                "OrderNumber": 299462,
                "OrderType": "Shipping",
                "OrderStatus": "Pending",
                "CustomerName": "Other country",
                "ShippingMethod": "DHL",
                "ShippingValue": 3.669
            },
            {
                "OrderNumber": 286498,
                "OrderType": "Shipping",
                "OrderStatus": "Pending",
                "CustomerName": "test",
                "ShippingMethod": "DHL",
                "ShippingValue": 27.385
            },
            .............
        ]
    }
}

---