Get products by Catalog Code

Retrive Products by Catalog Code

This API allows clients to retrieve a paginated list of products updated in a specific catalog after a specified date (fromDate).
The response includes a list of products updated after the provided fromDate (up to 24 hours before the request). To retrieve full product details or pricing, additional API endpoints are required.

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

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

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.

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

The fromDate parameter must be within the last 24 hours.

The catalog code (e.g., "ECOMMERCE") must exist and be active.

APIs Used

Retrieve updated products: Get products Catalog

Retrieve product details: Get product

Retrieve product dimensions details: Get SKU's barcodes

Retrieve product prices: Get product prices

Main Success Scenario

The external system sends a GET request with CATALOG_CODE, and a valid fromDate
If the request is successful, the system will return an HTTP 200 response with the paginated list of products on requested catalog and a nextCursor indicating whether there are more products to retrieve. If nextCursor is setted, the external system must be call again, this service, setting cursor as nextCursor value.

Response Example

How get all enable and disabled products with `returnDisabled` param

returnDisabled the query param allows you to invoke the service by specifying that any deactivated products are also returned in the response, in order to update the catalog by removing them.
The default if the value is not specified is false.

How get latest modify product with`fromDatetime` param

The fromDatetime parameter is used to retrieve the list of products in a catalog that have been modified after the specified date.
This parameter allows filtering results based on the last modification date, ensuring that only products updated after the given value are returned.
However, the date provided via fromDatetime cannot be earlier than yesterday, meaning the minimum acceptable value is always "today minus one day."
This constraint ensures that data retrieval focuses only on recent updates, preventing requests over excessively long time periods.

Alternate Flows

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

Error Example

Invalid fromDate: If the fromDate is more than 24 hours old, the API will return an error.

Empty response: If no products have been updated after the specified fromDate, the API will return an empty list.

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

Best Practices

Please refer to Best Practices for Error Handling in External System for best practices on implementation.

Code Examples in Node.js

Fetching Updated Products:

Fetching Product Details:

Fetching Product Prices:

application/json

Body

Example

{
    "catalog_code": "33",
    "products": [
        {
            "item_code": "ITEM_123",
            "status": false
        },
        {
            "item_code": "ITEM_123",
            "status": false
        },
        {
            "item_code": "ITEM_123",
            "status": false
        }
    ],
    "nextCursor": "eyJwYWdlIjoyLCJwYWdlU2l6ZSI6MTB2"
}

Get products by Catalog Code

Retrive Products by Catalog Code

Actors

Preconditions

APIs Used

Main Success Scenario

How get all enable and disabled products with `returnDisabled` param

How get latest modify product with`fromDatetime` param

Alternate Flows

Sequence Diagram

Code Examples in Node.js

Request

Request Code Samples

Responses

Get products by Catalog Code

Retrive Products by Catalog Code#

Actors#

Preconditions#

APIs Used#

Main Success Scenario#

How get all enable and disabled products with returnDisabled param#

How get latest modify product withfromDatetime param#

Alternate Flows#

Sequence Diagram#

Code Examples in Node.js#

Request

Request Code Samples

Responses

Retrive Products by Catalog Code

Actors

Preconditions

APIs Used

Main Success Scenario

How get all enable and disabled products with `returnDisabled` param

How get latest modify product with`fromDatetime` param

Alternate Flows

Sequence Diagram

Code Examples in Node.js