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

Authorizations

Path parameters

orderIdinteger · int32required

order_id is the ID of the order.

Query parameters

selectstringoptional

filterstringoptional

sortstringoptional

takeinteger · int32optional

skipinteger · int32optional

includestringoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

{
  "success": true,
  "code": 1,
  "message": "text",
  "orderProducts": [
    {
      "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"
      }
    }
  ],
  "totalOrderProductsCount": 1
}

Success

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

Authorizations

Path parameters

orderIdinteger · int32required

order_id is the ID of the order.

productIdinteger · int32required

product_id is the ID of the product.

Body

productIdinteger · int32optional

product_id is the ID of the product.

orderIdinteger · int32optional

order_id is the ID of the order.

productOrderobjectoptional

ProductOrder represents an order of a product.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

application/json

200

default

200

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

Success

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

Authorizations

Path parameters

orderIdinteger · int32required

order_id is the ID of the order.

productIdinteger · int32required

product_id is the ID of the product.

Body

productIdinteger · int32optional

product_id is the ID of the product.

orderIdinteger · int32optional

order_id is the ID of the order.

productOrderobjectoptional

ProductOrder represents an order of a product.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

application/json

200

default

200

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

Success

Delete

Roles: Administrator, Sales

The DELETE method is used to remove specific products from an order.

Deletes an order product relation.

delete

Authorizations

Path parameters

orderIdinteger · int32required

order_id is the ID of the order.

productIdinteger · int32required

product_id is the ID of the product.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

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

Success