---
title: "GetShippingOrderList"
method: GET
path: "/v2/GetShippingOrderList"
tags: ["Shipping"]
---

# GetShippingOrderList

`GET /v2/GetShippingOrderList`

## Request

- Base URL: `https://apitest.myfatoorah.com`
- URL: `https://apitest.myfatoorah.com/v2/GetShippingOrderList`
- Auth: HTTP bearer

Retrieves the shipping orders list that belongs to either DHL or ARAMEX.

## Query parameters

- `ShippingMethod` 1 | 2, required: 1 for DHL, 2 for ARAMEX
- `orderStatus` 0 | 1 | 2 | 3 | 4, required: 0 for Pending Status, 1 for Prepared Status, 2 for RequestPickup Status, 3 for Picked Status, 4 for Delivered Status
- `start` integer
- `length` integer

## Response `200`

Successful response

- object
  - `IsSuccess` boolean: Indicates if the request was successful
  - `Message` string: Response message
  - `FieldsErrors` unknown[]: List of validation errors if any
    - unknown
  - `Data` object: Shipping orders data
    - `ShippingMethod` string: 1 for DHL, 2 for ARAMEX
    - `OrderStatus` string: The order status
    - `TotalOrders` integer: The number of total shipping orders
    - `OrderNumbers` integer[]: A list of MyFatoorah order IDs
    - `ShippingOrders` object[]: Array of shipping order details
      - `OrderNumber` integer: The MyFatoorah order ID
      - `OrderType` string: The order type
      - `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: The customer name
      - `ShippingMethod` string: DHL or ARAMEX
      - `ShippingValue` number: The shipping value

---

[API](https://skmtc.dev/myfatoorah/apis/myfatoorah-api-v2.md) - [All operations](https://skmtc.dev/myfatoorah/apis/myfatoorah-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/myfatoorah/apis/myfatoorah-api-v2/revisions/4c0c2a3af558?raw)