Get Catalogs details

Retriving Catalogs

This API allows an external system, such as an e-commerce platform or a B2B order collection website, to get product catalogs.

The API supports pagination to navigate through large lists of catalogs.

Paginated Responses

The service is paginated to handle large sets of data efficiently.
For detailed information on how to handle pagination, refer to our Paginated Responses

Languages

The API response includes multilingual descriptions. The fields description_it and description_en provide Product Catalogs descriptions in Italian and English, respectively.

Manage languages

For detailed information on how to handle languages, refer to our Managing Languages

Actors

API Client: The system or user initiating the request.

Ecommerce site: The ecommerce site.

4ws.trade: The backend system that processes the request.

Preconditions

The external system must have the necessary permissions and access to the service, please refer to Authentication.

Pagination parameters cursor and nextCursor must be correctly configured in the request.

Scenarios

Retrieving All Catalogs: If no specific catalog code is provided, the API will return a paginated list of all available catalogs.

Retrieving a Specific Catalog: If a catalog code is provided in the path, the API will return details for the specified catalog.

Path Parameters

{CATALOG_CODE}: The code of the specific catalog to retrieve. If provided, the API will return only the catalog corresponding to this code.

Response Example for All Catalogs

Example CURL Commands

Retrieve All Catalogs

Response Example

Retrieve a Specific Catalog

Response Example

Alternate Flows

Authentication Error: If the client does not provide valid credentials, an error response is returned.

Error Example

If CATALOG_CODE is incorrect or does not exist, the API will return an error.

Error Example: invalid `CATALOG_CODE`

Empty Result: If no collections exist, the entities array will be empty.

Cursor & PageSize Used Together: Cursor and PageSize parameters in the request: If you specify a Cursor you cannot specify the page size. This information will already be contained within the cursor.

Error Example

Pagination Error: If invalid cursor parameters are provided, an error response is returned.

Rate Limiting: If the API rate limits are exceeded, the client must respect the retry interval indicated in the response headers Rate Limits.

Sequence Diagram in Mermaid

Code Examples in Node.js

Responses

🟢200OK

application/json

Body

Example

{
    "catalogs": [
        {
            "prog_id": -23526288.63344273,
            "company_id": "t",
            "site_id": 595849.8669679463,
            "catalog_code": "80",
            "description_it": "pariatur ipsum proident consequat Excepteur",
            "description_en": "aliquip Lorem",
            "description_de": "dolor sit",
            "description_es": "pariatur in sed Duis proident",
            "description_fr": "commodo culpa ex",
            "description_pt": "Excepteur paria",
            "description_ru": "velit dolore",
            "description_ar": "qui in mo",
            "description_ja": "ipsum in",
            "description_zh": "fugiat",
            "start_date": "2024-09-18",
            "end_date": "2025-04-20",
            "channel_code": "DIGITAL",
            "active": true,
            "pricelist_code": "395.69",
            "retail_pricelist_code": "426.99",
            "user_id_create": "elit culpa",
            "create_date": "2024-04-13",
            "user_id_update": "2025-09-14",
            "last_update": "2024-07-16",
            "data_source": "deserunt commodo",
            "row_version": -892702716,
            "status": "E"
        },
        {
            "prog_id": -63216036.64985198,
            "company_id": "q",
            "site_id": -20913343.277634054,
            "catalog_code": "100",
            "description_it": "sed",
            "description_en": "dolor ea dolore exercitation esse",
            "description_de": "dolor culpa et",
            "description_es": "mollit aliqua cillum in consectetur",
            "description_fr": "eu aute occaecat",
            "description_pt": "officia minim sed magna",
            "description_ru": "in",
            "description_ar": "mollit",
            "description_ja": "ullamco ipsum",
            "description_zh": "fugiat sit anim ipsum",
            "start_date": "2024-03-21",
            "end_date": "2024-09-23",
            "channel_code": "ECOMMERCE",
            "active": false,
            "pricelist_code": "318.85",
            "retail_pricelist_code": "628.89",
            "user_id_create": "reprehenderit veniam nostrud",
            "create_date": "2025-07-04",
            "user_id_update": "2024-08-10",
            "last_update": "2025-05-06",
            "data_source": "et culpa eu esse qui",
            "row_version": -2136240508,
            "status": "v"
        }
    ],
    "moreRows": false,
    "cursor": "esse cillum eiusmod elit ipsum"
}

🟠422Invalid pageSize

🟠401Authentication failed

🟠403Operation not allowed

Get Catalogs details

Retriving Catalogs

Languages

Actors

Preconditions

Scenarios

Path Parameters

Response Example for All Catalogs

Example CURL Commands

Alternate Flows

Sequence Diagram in Mermaid

Code Examples in Node.js

Request

Request Code Samples

Responses

Get Catalogs details

Retriving Catalogs#

Languages#

Actors#

Preconditions#

Scenarios#

Path Parameters#

Response Example for All Catalogs#

Example CURL Commands#

Alternate Flows#

Sequence Diagram in Mermaid#

Code Examples in Node.js#

Request

Request Code Samples

Responses

Retriving Catalogs

Languages

Actors

Preconditions

Scenarios

Path Parameters

Response Example for All Catalogs

Example CURL Commands

Alternate Flows

Sequence Diagram in Mermaid

Code Examples in Node.js