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/v1/orders

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/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"
    }
  ]
}

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/v1/orders

Body

application/json

orderOrder (object)

Order represents an order in the system.

Response

200default

Success

Body

application/json

orderIdinteger (int32)

order_id is the ID of the inserted order.

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.

Request

JavaScriptCurl

const response = await fetch('/v1/orders', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text"
}

Put

Roles: Administrator, Sales

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

Updates an existing order.

PUT/v1/orders

Body

application/json

orderOrder (object)

Order represents an order in the system.

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.

Request

JavaScriptCurl

const response = await fetch('/v1/orders', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text"
}

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

Path parameters

orderId*integer (int32)

order_id is the ID of the order to delete.

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.

Request

JavaScriptCurl

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

Response

{
  "success": false,
  "message": "text"
}