Orders

The 'Orders' endpoints in this section of the Babel Licensing API, are used for tracking and managing the purchase transactions of Products. This endpoint focuses on capturing and presenting detailed information about orders placed for the specified Product, offering a comprehensive view of sales.

Get

Roles: Administrator, Sales

This GET method is designed to provide a comprehensive view of all orders related to the Products within the Babel Licensing Service. This method enables users to access detailed information about each order.

Retrieves a list of orders for a specific product.

GET/v1/products/{productId}/orders

Path parameters

productId*integer (int32)

product_id is the ID of the product.

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.

productOrdersarray of ProductOrder (object)

product_orders is the list of product orders.

totalProductOrdersCountinteger (int32)

total_product_orders_count is the total number of product orders.

Request

JavaScriptCurl

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

Response

{
  "success": false,
  "message": "text",
  "productOrders": [
    {
      "unitPrice": 0,
      "discount": 0,
      "taxes": 0,
      "description": "text",
      "product": {
        "code": "text",
        "name": "text",
        "description": "text",
        "url": "text",
        "copyright": "text",
        "createdAt": "text",
        "image": "text",
        "price": 0,
        "resellerPrice": 0,
        "currency": "text"
      },
      "order": {
        "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"
      }
    }
  ]
}