Orders

Retrieving Customer Order History

Get

Roles: Administrator, Sales

The GET method for the Orders endpoint under the Customers section is a specialized function designed to access the order history of individual customers. This endpoint allows for a detailed view of all orders placed by a specific customer, providing insights into their purchasing patterns, preferences, and transaction history. It's an invaluable tool for understanding customer behavior, tailoring services to meet individual needs, and enhancing customer relationship management

Retrieves a list of orders for a specific customer.

get

Authorizations

Path parameters

customerIdinteger · int32required

customer_id is the ID of the customer.

Query parameters

selectstringoptional

filterstringoptional

sortstringoptional

takeinteger · int32optional

skipinteger · int32optional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/customers/{customerId}/orders' \
  --header 'x-api-key: YOUR_API_KEY'

200

default

200

{
  "success": true,
  "code": 1,
  "message": "text",
  "orders": [
    {
      "id": 1,
      "orderNumber": "text",
      "status": "text",
      "processedBy": "text",
      "purchaseOrder": "text",
      "total": 1,
      "currency": "text",
      "createdAt": "text",
      "updatedAt": "text",
      "invoiceNumber": "text",
      "paymentType": "text",
      "paymentNumber": "text",
      "paymentStatus": "text",
      "paymentDate": "text",
      "description": "text",
      "customerId": 1,
      "resellerId": 1,
      "createdById": "text"
    }
  ],
  "totalOrdersCount": 1
}

Success