Get product compositions - LogicTrade API

Request

Authorization

Add parameter in header

api-key

Example:

api-key: ********************

Query Params

pageSize

integer

optional

This specifies the number of objects to returned, ranging between 10 and 100.

Example:

100

pageNumber

integer

optional

The parameter pageNumber indicates which page of the result should be requested.

Example:

1

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.logictrade.cloud/rest/v1/products/compositions?pageSize=100&pageNumber=1' \
--header 'api-key;'

Responses

🟢200Success

application/json

Body

pagination

object

optional

totalResults

integer

optional

The total number of records.

pageNumber

integer

optional

The current page number.

pageSize

integer

optional

The number of records returned per page.

totalPages

integer

optional

The total number of pages.

results

array[object (Composition) {4}]

optional

id

integer

optional

The unique identifier of the composition

parentProductId

integer

optional

The parent product ID

childProductId

integer

optional

The child product ID

quantity

integer

optional

The quantity of the child product

Example

{
    "pagination": {
        "totalResults": 2,
        "pageNumber": 1,
        "pageSize": 100,
        "totalPages": 1
    },
    "results": [
        {
            "id": 1,
            "parentProductId": 1,
            "childProductId": 2,
            "quantity": 4
        },
        {
            "id": 2,
            "parentProductId": 3,
            "childProductId": 4,
            "quantity": 1
        }
    ]
}