Products

Integrating Product Details with Orders

The Order Products relation in the Babel Licensing API establishes a crucial link between customer orders and the specific products contained within those orders. This relationship is essential for providing a detailed and accurate overview of the products that are part of each transaction.

Get

Roles: Administrator, Sales

The GET method is designed to access detailed information about the products included in a specific order. It enables users to query and view product details such as type, quantity, specifications, and any other relevant data tied to the products within an order.

Retrieves a list of products for a specific order.

GET/v1/orders/{orderId}/products

Path parameters

orderId*integer (int32)

order_id is the ID of the order.

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.

orderProductsarray of ProductOrder (object)

order_products is the list of products in the order.

totalOrderProductsCountinteger (int32)

total_order_products_count is the total number of products in the order.

Request

JavaScriptCurl

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

Response

{
  "success": false,
  "message": "text",
  "orderProducts": [
    {
      "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"
      }
    }
  ]
}

Post

Roles: Administrator, Sales

The POST method facilitates adding new products to an existing order. It is used to update an order with additional products, specifying details like product IDs, quantities, and other pertinent product information.

Inserts a new order product association.

POST/v1/orders/{orderId}/products/{productId}

Path parameters

orderId*integer (int32)

order_id is the ID of the order.

productId*integer (int32)

product_id is the ID of the product.

Body

application/json

productIdinteger (int32)

product_id is the ID of the product.

orderIdinteger (int32)

order_id is the ID of the order.

productOrderProductOrder (object)

ProductOrder represents an order of a product.

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}/products/{productId}', {
    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 product details of existing orders. This could involve changing product types, adjusting quantities, or updating other product-related information in the order.

Updates an existing order product relation.

PUT/v1/orders/{orderId}/products/{productId}

Path parameters

orderId*integer (int32)

order_id is the ID of the order.

productId*integer (int32)

product_id is the ID of the product.

Body

application/json

productIdinteger (int32)

product_id is the ID of the product.

orderIdinteger (int32)

order_id is the ID of the order.

productOrderProductOrder (object)

ProductOrder represents an order of a product.

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}/products/{productId}', {
    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 specific products from an order.

Deletes an order product relation.

DELETE/v1/orders/{orderId}/products/{productId}

Path parameters

orderId*integer (int32)

order_id is the ID of the order.

productId*integer (int32)

product_id is the ID of the product.

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}/products/{productId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

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