Orders

Streamlining Order Management in Babel Licensing

The 'Orders' section of the Babel Licensing API is a dedicated and comprehensive interface designed for the management of orders and their associated elements, such as products and licenses. This section is integral to the operational framework of the Babel Licensing system, as it deals with the orchestration and tracking of orders, ensuring seamless and efficient transaction processing.

Get

Roles: Administrator, Sales

The GET method in the Orders section is designed for accessing comprehensive information about existing orders.

Retrieves a list of orders.

get

Authorizations

Query parameters

selectstringoptional

filterstringoptional

sortstringoptional

takeinteger · int32optional

skipinteger · int32optional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/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

Post

Roles: Administrator, Sales

The POST method facilitates the creation of new orders within the Babel Licensing system. It is used to initiate orders for products or licenses, capturing essential details such as customer information, product or license IDs, quantities, and transaction dates.

Inserts a new order.

post

Authorizations

Body

orderobjectoptional

Order represents an order in the system.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1/orders' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
    }
  }'

application/json

200

default

200

{
  "orderId": 1,
  "success": true,
  "code": 1,
  "message": "text"
}

Success

Put

Roles: Administrator, Sales

Utilizing the PUT method allows for modifications to the details of existing orders.

Updates an existing order.

put

Authorizations

Body

orderobjectoptional

Order represents an order in the system.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/v1/orders' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
    }
  }'

application/json

200

default

200

{
  "success": true,
  "code": 1,
  "message": "text"
}

Success

Delete

Roles: Administrator, Sales

The DELETE method is used to remove order records from the Babel Licensing system. This action may be necessary when an order is canceled, completed, or needs to be removed for any other reason.

Deletes an order by ID.

delete

Authorizations

Path parameters

orderIdinteger · int32required

order_id is the ID of the order to delete.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/v1/orders/{orderId}' \
  --header 'x-api-key: YOUR_API_KEY'

200

default

200

{
  "success": true,
  "code": 1,
  "message": "text"
}

Success