Get Orders

GET {{baseUrl}}/orders?merchantId=&reference=&lessThanTotalAmount=&greaterThanTotalAmount=&purchaseDateFrom=&purchaseDateTo=&status=&from=&to=&locale.baseLocale.language=&locale.baseLocale.script=&locale.baseLocale.region=&locale.baseLocale.variant=&page=1&size=20&sort=&sort=

Description

This endpoint get orderss

Headers

• "tenantId" (Required)
• "userId" (Required)
• "Accept" with the value "/"

Components:

• Host: {{baseUrl}}
• Path: /orders

Query Parameters

• merchantId: <string>
• reference: <string>
• lessThanTotalAmount: <double>
• greaterThanTotalAmount: <double>
• purchaseDateFrom: <string>
• purchaseDateTo: <string>
• status: <string>
• from: <string>
• to: <string>
• locale.baseLocale.language: <string>
• locale.baseLocale.script: <string>
• locale.baseLocale.region: <string>
• locale.baseLocale.variant: <string>
• page: 1 (One-based page index (1..N))
• size: 20 (The size of the page to be returned)
• sort: <string> (Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.)

Sample Request

curl --location -g '{{baseUrl}}/orders?merchantId=&reference=&lessThanTotalAmount=&greaterThanTotalAmount=&purchaseDateFrom=&purchaseDateTo=&status=&from=&to=&locale.baseLocale.language=&locale.baseLocale.script=&locale.baseLocale.region=&locale.baseLocale.variant=&page=1&size=20&sort=&sort=' \
--header 'tenantId: <string>' \
--header 'userId: <string>' \
--header 'Accept: */*'

Sample Response

{
  "data": [
    {
      "orderId": "<string>",
      "orderNumber": "<string>",
      "merchantId": "<string>",
      "customerId": "<string>",
      "totalAmount": "<double>",
      "status": "<string>",
      "purchaseDate": "<string>",
      "deliveryDate": "<string>",
      "items": [
        {
          "productId": "<string>",
          "quantity": "<integer>",
          "price": "<double>",
          "totalPrice": "<double>"
        }
      ]
    }
  ],
  "meta": {
    "currentPage": "<long>",
    "from": "<long>",
    "to": "<long>",
    "perPage": "<long>",
    "total": "<long>",
    "lastPage": "<long>"
  }
}