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

Authorizations

Path parameters

productIdinteger · int32required

product_id is the ID of the product.

Query parameters

selectstringoptional

filterstringoptional

sortstringoptional

takeinteger · int32optional

skipinteger · int32optional

includestringoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

{
  "success": true,
  "code": 1,
  "message": "text",
  "productOrders": [
    {
      "productId": 1,
      "orderId": 1,
      "quantity": 1,
      "unitPrice": 1,
      "discount": 1,
      "taxes": 1,
      "description": "text",
      "product": {
        "id": 1,
        "code": "text",
        "name": "text",
        "description": "text",
        "url": "text",
        "copyright": "text",
        "createdAt": "text",
        "image": "text",
        "price": 1,
        "resellerPrice": 1,
        "currency": "text",
        "signatureKeysId": 1
      },
      "order": {
        "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"
      }
    }
  ],
  "totalProductOrdersCount": 1
}

Success