Get the descriptions for a product

Request

Authorization

Add parameter in header

api-key

Example:

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

Path Params

product id

string

required

The unique identifier of the product.

Example:

1

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

language

string

optional

The language of the product description.

type

string

optional

The type of the product description.

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/1/descriptions?pageSize=100&pageNumber=1&language&type' \
--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 {3}]

optional

type

string

optional

The type of the product description.

language

string

optional

The language of the product description (the language is empty for Dutch).

description

string

optional

The descripion of the product.

Example

{
    "pagination": {
        "totalResults": 0,
        "pageNumber": 0,
        "pageSize": 0,
        "totalPages": 0
    },
    "results": [
        {
            "type": "string",
            "language": "string",
            "description": "string"
        }
    ]
}