Get product

Retrieve a Specific Product from 4WS Trade System

The external system needs to retrieve the details of a specific product from the 4WS Trade system using the product’s code. The response will include all relevant product data, such as pricing information, descriptions, dimensions, and attributes.

Actors

API Client: The system or user initiating the request.

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

Preconditions

The product code provided must exist in the 4WS Trade system.

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

Main Success Scenario

If the product exists, the system will return an HTTP 200 response with the product's details in the response body.

Example Success Response:

{
  "product": {
    "prog_id": 10726794,
    "item_code": "ex non esse sit nulla",
    "item_type": "PRODUCT",
    "item_subtype": "ITEM",
    "price_management_type": "ITEM",
    "vat_code": "4",
    "vat_department": 1,
    "tax_rate": "22",
    "description_it": "velit",
    "description_en": "est ea occaecat",
    "shop_description_it": "adipisicing deserunt dolor voluptate",
    "shop_description_en": "esse in sed",
    "season_code": null,
    "season": "occaecat ad",
    "year": null,
    "season_sale_code": null,
    "season_sale": null,
    "season_sale_year": null,
    "brand_code": "cillum",
    "brand": "cillum",
    "made_in": null,
    "main_supplier_code": "non",
    "main_supplier": "culpa ut Lorem sint",
    "item_supplier_code": null,
    "hierarchy_level1": "probident",
    "hierarchy_level2": "proident Ut consectetur in",
    "hierarchy_level3": null,
    "hierarchy_level4": null,
    "hierarchy_level5": null,
    "hierarchy_level6": null,
    "hierarchy_level7": null,
    "hierarchy_level8": null,
    "hierarchy_level9": null,
    "hierarchy_level10": null,
    "attribute_level1": null,
    "attribute_level2": null,
    "attribute_level3": "ea do",
    "attribute_level4": null,
    "attribute_level5": "nisi veniam Duis dolore adipisicing",
    "attribute_level6": null,
    "attribute_level7": null,
    "attribute_level8": null,
    "attribute_level9": null,
    "attribute_level10": null,
    "dimension_group1": "incididunt",
    "dimension_group2": null,
    "dimension_group3": null,
    "dimension_group4": null,
    "dimension_group5": null,
    "minimum_pack": null,
    "measure_unit": null,
    "item_heigth": null,
    "item_width": null,
    "item_depth": null,
    "pack_heigth": null,
    "pack_width": null,
    "pack_depth": null,
    "set_item": null,
    "set_quantity": null,
    "exposition_type": null,
    "enabled_discount": false,
    "enabled_sale": null,
    "free_promotion": true,
    "free_sale": null,
    "manual_cost": null,
    "tailor_selection": null,
    "packages": "ullamco",
    "packages_hanging": "in ut",
    "weight": 335,
    "customs_category": null
  }
}

Alternate Flows

Product Not Found:
If the product code does not exist in the 4WS Trade system, the system will return an HTTP 422 error response.

Example Error Response:

{
  "message": "Product not found"
}

Invalid Product Code Format:
If the product code format is incorrect or invalid, the system may return an HTTP 400 Bad Request with a detailed error message.

Best Practices

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

Sequence Diagram

Code Examples in Node.js

This Node.js code demonstrates how to retrieve the details of a product from the 4WS Trade system by sending a GET request. It handles successful and error responses.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Responses

🟢200Success

application/json

Body

Example

{
    "product": {
        "prog_id": 10726794,
        "item_code": "ex non esse sit nulla",
        "item_type": "PRODUCT",
        "item_subtype": "ITEM",
        "price_management_type": "ITEM",
        "vat_code": "4",
        "vat_department": 1,
        "tax_rate": "22",
        "description_it": "velit",
        "description_en": "est ea occaecat",
        "shop_description_it": "adipisicing deserunt dolor voluptate",
        "shop_description_en": "esse in sed",
        "season_code": null,
        "season": "occaecat ad",
        "year": null,
        "season_sale_code": null,
        "season_sale": null,
        "season_sale_year": null,
        "brand_code": "cillum",
        "brand": "cillum",
        "made_in": null,
        "main_supplier_code": "non",
        "main_supplier": "culpa ut Lorem sint",
        "item_supplier_code": null,
        "hierarchy_level1": "probident",
        "hierarchy_level2": "proident Ut consectetur in",
        "hierarchy_level3": null,
        "hierarchy_level4": null,
        "hierarchy_level5": null,
        "hierarchy_level6": null,
        "hierarchy_level7": null,
        "hierarchy_level8": null,
        "hierarchy_level9": null,
        "hierarchy_level10": null,
        "attribute_level1": null,
        "attribute_level2": null,
        "attribute_level3": "ea do",
        "attribute_level4": null,
        "attribute_level5": "nisi veniam Duis dolore adipisicing",
        "attribute_level6": null,
        "attribute_level7": null,
        "attribute_level8": null,
        "attribute_level9": null,
        "attribute_level10": null,
        "dimension_group1": "incididunt",
        "dimension_group2": null,
        "dimension_group3": null,
        "dimension_group4": null,
        "dimension_group5": null,
        "minimum_pack": null,
        "measure_unit": null,
        "item_heigth": null,
        "item_width": null,
        "item_depth": null,
        "pack_heigth": null,
        "pack_width": null,
        "pack_depth": null,
        "set_item": null,
        "set_quantity": null,
        "exposition_type": null,
        "enabled_discount": false,
        "enabled_sale": null,
        "free_promotion": true,
        "free_sale": null,
        "manual_cost": null,
        "tailor_selection": null,
        "packages": "ullamco",
        "packages_hanging": "in ut",
        "weight": 335,
        "customs_category": null
    }
}

🟠422Product not found

🟠403Operation not allowed

🟠401Authentication failed

Retrieve a Specific Product from 4WS Trade System#

Actors#

Preconditions#

Main Success Scenario#

Alternate Flows#

Sequence Diagram#

Code Examples in Node.js#

Request

Request Code Samples

Responses

Retrieve a Specific Product from 4WS Trade System

Actors

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Examples in Node.js