Update product

Updating a Product in 4WS.Trade

This use case allows an external system to update product information in the 4WS.Trade product catalog. The update might include changes to the product's description, composition, supplier codes, and dimension groups.

Actors

API Client: The system or user initiating the request.

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

Languages

To understand how languages are managed, please refer to our Managing Languages Documentation.

Preconditions

The product with the provided item_code must already exist in the 4WS.Trade catalog.

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

Main Success Scenario

The external system sends a PATCH request to the 4WS.Trade API with the product's updated attributes.

The 4WS.Trade system processes the update and modifies the product information.

If the update is successful, the system returns an HTTP 200 status with the updated product details.

    {
      "product": {
        "prog_id": "90941",
        "item_code": "MININTSAB-52311090940"
      }
    }

CAUTION

By default, you cannot change the dimension group of an item that has been used in a document. To bypass this check, specify ignore_movements as true.

Alternate Flows

**Product Not Found: If the item_code does not exist, the system returns a 422 error with a message like: Product not found with item_code: {{itemCode}}.

    {
      "message": "Product not found with item_code: {{itemCode}}"
    }

**Invalid Data: If any required fields are missing or incorrectly formatted, the system returns a relevant HTTP error, such as 400 (Bad Request) or 422 (Unprocessable Entity), with details about the issue.

Sequence Diagram

Below is a sequence diagram illustrating the interaction between the external system and 4WS.Trade for updating a product.

Best Practices

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

Code Examples in Node.js

Here is an example of how to use the API in Node.js:

This code demonstrates how to send a PATCH request using Axios in Node.js to update a product's details in 4WS.Trade.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Body Params application/json

Example

{
    "description_it" : "Articolo Modificato",
    "composition" : "Cotone 100%",
    "main_supplier_code": "2",
    "item_supplier_code": "Codice esterno",
    "dimension_group1": "10",
    "dimension_group2": "COLORE"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

Example

{
    "product": {
        "prog_id": "90941",
        "item_code": "MININTSAB-52311090940"
    }
}

🟠401Authentication failed

🟠404Product not found with item_code

🟠401Revoked refresh token

🟠403Operation not allowed

🟠423Fail to update item_code

🟠422Unique constraint error

Updating a Product in 4WS.Trade#

Actors#

Languages#

Preconditions#

Main Success Scenario#

Alternate Flows#

Sequence Diagram#

Code Examples in Node.js#

Request

Request Code Samples

Responses

Updating a Product in 4WS.Trade

Actors

Languages

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Examples in Node.js