RequestPickup

Endpoint

Overview

The "RequestPickup" endpoint is a GET request. It is used to request a pickup for orders with Prepared status to be delivered via DHL or ARAMEX. Detailed functionality of how to use this endpoint is explained in the Shipping section.

The endpoint on Swagger is Shipping_RequestPickup.

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

---

Response Model

After viewing the Response Model that you will get as a result of your request, the Data Model will be an array of ShippingOrderStatus objects. This array lists the shipping order numbers whose status has changed from Prepared status to RequestPickup status within a specific shipping method.

Response Field	Type	Description
OrderNumber	integer	MyFatoorah order ID.
OrderStatus	string	The order status.

---

Sample Message

Request

/v2/RequestPickup?ShippingMethod=1

Response 1

{
  "IsSuccess": true,
  "Message": null,
  "FieldsErrors": null,
  "Data": [
    {
      "OrderNumber": 105039,
      "OrderStatus": "RequestPickup"
    },
    {
      "OrderNumber": 301761,
      "OrderStatus": "RequestPickup"
    }
  ]
}

Response 2

{
    "Id": 0,
    "IsSuccess": false,
    "Message": "No prepared Items",
    "FieldsErrors": null
}

---