Get stock for products - 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/stock?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 {4}]

optional

productId

integer

optional

The unique identifier of the product.

configurationId

integer

optional

The unique identifier of the configuration. The value is NULL if the product is not configurable.

stock

number

optional

The total stock.

locations

array [object {3}]

optional

The locations where the product is stored.

Example

{
    "pagination": {
        "totalResults": 0,
        "pageNumber": 0,
        "pageSize": 0,
        "totalPages": 0
    },
    "results": [
        {
            "productId": 0,
            "configurationId": 0,
            "stock": 0,
            "locations": [
                {
                    "description": "string",
                    "code": "string",
                    "stock": 0
                }
            ]
        }
    ]
}