Update brand

Updating Product Brand Information

Use Case Description

This API allows an external system to update the details (e.g., description or name) of a product brand that already exists in the system.

Languages

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

Actors

API Client: The system or user initiating the request.

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

Preconditions

The brand must already exist in the 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 brand update is successful, the system will return an HTTP 200 response with the internal program ID (prog_id) and the brand_code.

Example Success Response:

{
  "brand": {
    "prog_id": 1064,
    "brand_code": "prova"
  }
}

Alternate Flows

Brand Not Found:
If the prog_id does not match any existing brand, the following error will be returned:

{
  "message": "brand_code with {brand_code} not found"
}

HTTP Status: 422 Unprocessable Entity

Best Practices

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

Sequence Diagram

Below is the sequence diagram for updating the brand information using this API:

Code Example in Node.js

This Node.js example demonstrates how to update the brand description using the API.

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Updating Product Brand Information#

Use Case Description#

Languages#

Actors#

Preconditions#

Main Success Scenario#

Alternate Flows#

Sequence Diagram#

Code Example in Node.js#

Request

Request Code Samples

Responses

Updating Product Brand Information

Use Case Description

Languages

Actors

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Example in Node.js