Insert brand

Creating a New Product Brand

The API allows external systems to create new brands for products they manage. The external system sends the necessary information (e.g., brand code, description) to register the brand within the product management 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 code should not 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 is created successfully, the system will return an HTTP 200 response with the internal program ID (prog_id) and the created brand_code.

Example Response:

{
  "brand": {
    "prog_id": 1065,
    "brand_code": "Heathcote, Mosciski and Paucek"
  }
}

Alternate Flows

Brand code already exists:
If the brand_code already exists in the system, the following error will be returned:

{
  "message": "brand_code with {brand_code} already exists"
}

HTTP Status: 422 Unprocessable Entity

Best Practices

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

Code Example in Node.js

This Node.js example demonstrates how to create a new brand using the provided API.

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Creating a New Product Brand#

Languages#

Actors#

Preconditions#

Main Success Scenario#

Alternate Flows#

Code Example in Node.js#

Request

Request Code Samples

Responses

Creating a New Product Brand

Languages

Actors

Preconditions

Main Success Scenario

Alternate Flows

Code Example in Node.js