Get Products

Production

https://api.b2b.retter.io/5p1hp1d2t

POST

/CALL/PIMAPI/getProducts/{B2B_PROJECT_ID}

Last modified:2024-09-17 11:22:35

You can access this API using an API key.

With this method, you can list and filter products, product models, product variants and product bundles.

Request

Authorization

Add parameter in header

x-api-key

Example:

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

Path Params

Body Params application/json

Example

{
    "sorts": {
        "family": "asc",
        "enabled": "desc",
        "id": "asc",
        "createdAt": "asc",
        "updatedAt": "desc"
    },
    "filters": {
        "idList": [
            "123456"
        ],
        "createdAt": {
            "gte": "2023-05-10T09:02:00.000Z",
            "lte": "2023-05-17T22:02:00.000Z"
        },
        "updatedAt": {
            "gte": "2023-05-18T09:02:00.000Z",
            "lte": "2023-05-09T23:02:00.000Z"
        },
        "sku": "123456",
        "family": "testfamily",
        "parent": "testparent",
        "variant": "testvariant",
        "dataType": "PRODUCT,PRODUCT_MODEL",
        "group": "testgroup",
        "enabled": "true",
        "forceGroupFilter": true
    },
    "pageFrom": 1,
    "pageSize": 5,
    "searchText": "search",
    "source": true
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.b2b.retter.io/5p1hp1d2t/CALL/PIMAPI/getProducts/' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--data-raw '{
    "sorts": {
        "family": "asc",
        "enabled": "desc",
        "id": "asc",
        "createdAt": "asc",
        "updatedAt": "desc"
    },
    "filters": {
        "idList": [
            "123456"
        ],
        "createdAt": {
            "gte": "2023-05-10T09:02:00.000Z",
            "lte": "2023-05-17T22:02:00.000Z"
        },
        "updatedAt": {
            "gte": "2023-05-18T09:02:00.000Z",
            "lte": "2023-05-09T23:02:00.000Z"
        },
        "sku": "123456",
        "family": "testfamily",
        "parent": "testparent",
        "variant": "testvariant",
        "dataType": "PRODUCT,PRODUCT_MODEL",
        "group": "testgroup",
        "enabled": "true",
        "forceGroupFilter": true
    },
    "pageFrom": 1,
    "pageSize": 5,
    "searchText": "search",
    "source": true
}'

Responses

🟢200OK

application/json

Successful response

Body

Example

{}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

Modified at 2024-09-17 11:22:35

Change Logs

Get Product Settings