Orders

Retrieving Customer Order History

The Orders endpoints are designed to provide customers with a comprehensive view of their purchasing history with the company. Customers can use this feature to review their past orders, track the status of current orders, and plan for future purchases.

Get

Role: Customer

This GET method is designed for customers to access their complete order history. By utilizing their customer code, they can view detailed records of their past orders, including dates, quantities, prices, and statuses of each order.

Retrieves a list of orders for a specific customer by their code.

GET/v1/customer/{customerCode}/orders

Path parameters

customerCode*string

customer_code is the code of the customer.

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 of the customer.

Request

JavaScriptCurl

const response = await fetch('/v1/customer/{customerCode}/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"
    }
  ]
}