Partner Orders¶

Retrieve orders placed by users through the partner integration.

Caution

This endpoint is protected by an IP whitelisting middleware. Only requests originating from pre-approved IP addresses will be allowed access.

Endpoint¶

POST https://partners.waffarx.com/api/{partner}/getorders

Request Headers¶

Header	Description
wxc-id	Your WaffarX Client Id
wxc-auth	Signature auth header for the request
wxc-date	UTC timestamp of the request, e.g. `2024-04-24T12:34:56Z`
authorization	JWT Token a short-lived token`
Accept-Language	Response language preference (e.g. `en \| ar`)
Content-Type	Must be `application/json`

Important

Token Expiry: The generated token is valid for 15 minutes. Be sure to refresh it before expiry to maintain uninterrupted access to protected endpoints.

Usage: Include the token directly in the request header, without any prefix.

Note

wxc-id: The WaffarX client ID specified in your integration data.

ShoppingUrlBase will be used in the signature as ACTION_NAME

Request Body Parameters¶

Name	Type	Description
PageNumber	integer	Minimum value: 1
PageSize	integer	Range: 1–100
FromDate	string \| null	Start of date range (required if ToDate is provided; must not be later than ToDate)
ToDate	string \| null	End of date range (required if FromDate is provided; must not be earlier than FromDate)
Orders	array of string \| null	List of order IDs (max 100 items)

Note

If you supply FromDate, you must also supply ToDate, and vice versa.
FromDate must be on or before ToDate, and their span cannot exceed one month.
FromDate, ToDate, and Orders are nullable and can be omitted entirely.

Request Body Example¶

Example Request Body¶

{
  "PageNumber": "1",
  "PageSize":"100",
  "FromDate":"2025-06-01T00:00:00",
  "ToDate":"2025-06-11T00:00:00",
  "Orders":["21B6CF11-DA36-45EB-9809-51E749AB35E4"]
 }

cURL Example¶

curl --location 'https://partners.waffarx.com/api/{partner}/getorders' \
     --header 'Content-Type: application/json' \
     --header 'Accept-Language: en' \
     --header 'wxc-id: {YOUR_CLIENT_ID}' \
     --header 'wxc-date: 2025-07-01T17:06:06Z' \
     --header 'wxc-auth: c9132343295553cc468c45657f49554258' \
     --header 'authorization: eyJhbGciOiJSUzI1NiI....UE4WGw' \
     --data '{"PageNumber":"1","PageSize":"100","FromDate":"2025-06-01T00:00:00","ToDate":"2025-06-30T00:00:00","Orders":null}'

Responses¶

Success (HTTP 200)¶

Success Response Example¶

 {
     "totalCount": 1,
     "status": "Success",
     "data": [
         {
             "id": "21b6cf11-da36-45eb-9809-51e749ab35e4",
             "status": "Pending",
             "storeId": "f6b09c19-a0ed-4279-95fd-f950525dbe09",
             "orderId": "ORD-076327",
             "orderDate": "2025-06-30T00:07:02.957",
             "orderValue": 4519.410000,
             "orderCurrency": "EGP",
             "partnerUId": "PU_63108_DA4DFFB7",
             "subId": "web_4854",
             "userCashBack": 383.250000,
             "userReward": 58.750000,
             "partnerRevenue": 213.320000,
             "creationDate": "2025-06-30T00:36:02.957",
             "products": [
                 {
                     "productId": "PROD-49918",
                     "title": "Backpack",
                     "quantity": 4,
                     "offerId": "OFF-5809",
                     "rewardPercentage": 6,
                     "rewardAmount": 95.310000
                 },
                 {
                     "productId": "PROD-36621",
                     "title": "Coffee Maker",
                     "quantity": 5,
                     "offerId": "OFF-5240",
                     "rewardPercentage": 5,
                     "rewardAmount": 146.540000
                 }
             ]
         }
     ],
     "message": null,
     "errors": null
 }

Error (HTTP 4XX/5XX)¶

Error Response Example¶

 {
   "status": "Error",
   "message": "",
   "errors": [ "Page number must be greater than or equal to 1." ]
 }