Mircate

Get Products

Production

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

POST

/CALL/PIMAPI/getProducts/{B2B_PROJECT_ID}

PIM

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

B2B_PROJECT_ID

string

required

Body Params application/json

sorts

object

optional

Record<string,string>: family: asc, enabled: desc etc...

family

string

optional

The product family it belongs to.

enabled

string

optional

string

optional

The unique identifier assigned to each product.

createdAt

string

optional

The date and time when the product was created.

updatedAt

string

optional

The date and time of the most recent update to the product.

filters

object

optional

Filters allow you to narrow down the product list based on specific criteria.

idList

array[string]

optional

createdAt

object

optional

updatedAt

object

optional

sku

string

optional

Exactly, "SKU" (Stock Keeping Unit) refers to a unique product identifier or number used for inventory tracking purposes.

family

string

optional

Displays the product's family.

parent

string

optional

If the product is a variant, you can access the parent product model using the "Parent" link.

variant

string

optional

Indicates if the product is a variant of a product model.

dataType

string

optional

group

string

optional

enabled

string

optional

forceGroupFilter

boolean

optional

pageFrom

integer

optional

pageSize

integer

optional

searchText

string

optional

source

boolean

optional

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

object {0}

Example

{}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

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

Change Logs

Get Product Settings