Insert attribute

Creating Product Attributes

This API allows external systems to add new attributes to their product master data. These attributes provide detailed classification for product types, such as e-commerce settings, seasonal availability, and more.

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 external system must have the necessary permissions and access to the document creation service, please refer to Authentication.

The attribute type must already exist, or it will trigger an error response.

Main Success Scenario

When the request is successfully processed, the system returns an HTTP 200 response along with the created attribute details.

Example Response:

{
  "attribute": {
    "prog_id": 14983,
    "attribute_level": "Level API Test"
  }
}

Alternate Flows

If an invalid attribute_type is provided:

HTTP 422

{
  "message": "attribute_type with {attribute_type*} not found"
}

If the attribute_level already exists for the specified attribute_type:

HTTP 422

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

Best Practices

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

Code Example in Node.js

This example demonstrates how to interact with the API using Node.js, where the system creates a new attribute with an attribute type and attribute level and handles any potential errors.

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Creating Product Attributes#

Languages#

Actors#

Preconditions#

Main Success Scenario#

Alternate Flows#

Code Example in Node.js#

Request

Request Code Samples

Responses

Creating Product Attributes

Languages

Actors

Preconditions

Main Success Scenario

Alternate Flows

Code Example in Node.js