Get Catalog details by Code

Retriving Catalogs by Code

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

Actors

API Client: The system or user initiating the request.

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

Preconditions

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

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.

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

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

{
    "catalog": {
        "catalog_code": "string",
        "description_it": "string",
        "description_en": "string",
        "description_de": "string",
        "description_es": "string",
        "description_fr": "string",
        "description_pt": "string",
        "description_ru": "string",
        "description_ar": "string",
        "description_ja": "string",
        "description_zh": "string",
        "start_date": "2019-08-24",
        "end_date": "2019-08-24",
        "channel_code": "ECOMMERCE",
        "active": true
    }
}

Example CURL Commands

Retrieve All Catalogs

Retrieve a Specific Catalog

Responses

🟢200OK

application/json

Body

Example

{
    "catalog": {
        "prog_id": 0,
        "company_id": "strin",
        "site_id": 0,
        "catalog_code": "string",
        "description_it": "string",
        "description_en": "string",
        "description_de": "string",
        "description_es": "string",
        "description_fr": "string",
        "description_pt": "string",
        "description_ru": "string",
        "description_ar": "string",
        "description_ja": "string",
        "description_zh": "string",
        "start_date": "2019-08-24",
        "end_date": "2019-08-24",
        "channel_code": "ECOMMERCE",
        "active": true,
        "pricelist_code": "string",
        "retail_pricelist_code": "string",
        "user_id_create": "string",
        "create_date": "2019-08-24T14:15:22Z",
        "user_id_update": "string",
        "last_update": "2019-08-24T14:15:22Z",
        "data_source": "string",
        "row_version": "0",
        "status": "E"
    }
}

🟠422Invalid pageSize

🟠401Authentication failed

🟠403Operation not allowed

Get Catalog details by Code

Retriving Catalogs by Code

Actors

Preconditions

Scenarios

Path Parameters

Response Example for All Catalogs

Example CURL Commands

Request

Request Code Samples

Responses

Get Catalog details by Code

Retriving Catalogs by Code#

Actors#

Preconditions#

Scenarios#

Path Parameters#

Response Example for All Catalogs#

Example CURL Commands#

Request

Request Code Samples

Responses

Retriving Catalogs by Code

Actors

Preconditions

Scenarios

Path Parameters

Response Example for All Catalogs

Example CURL Commands