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/v1/customers/{customerId}/orders

Path parameters

customerId*integer (int32)

customer_id is the ID of the customer.

Query parameters

Response

200default

Success

Body

application/json

successboolean

success indicates whether the operation was successful.

codeinteger (int32)

code is the status code of the operation.

messagestring

message is a human-readable message indicating the result of the operation.

ordersarray of Order (object)

orders is the list of orders.

totalOrdersCountinteger (int32)

total_orders_count is the total number of orders.

Request

JavaScriptCurl

const response = await fetch('/v1/customers/{customerId}/orders', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text",
  "orders": [
    {
      "orderNumber": "text",
      "status": "text",
      "processedBy": "text",
      "purchaseOrder": "text",
      "total": 0,
      "currency": "text",
      "createdAt": "text",
      "updatedAt": "text",
      "invoiceNumber": "text",
      "paymentType": "text",
      "paymentNumber": "text",
      "paymentStatus": "text",
      "paymentDate": "text",
      "description": "text",
      "createdById": "text"
    }
  ]
}