Get Attribute Type

Retrieve a Single Attribute Type

This API retrieves details for a specified attribute type. Given an attribute type identifier (e.g., ECOMMERCE), it returns a detailed profile, including multilingual descriptions and position.

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.

A valid attribute_type identifier must be specified in the path.

Main Success Scenario

The client sends a GET request to the API endpoint, specifying the attribute type in the path parameter {ATTRIBUTE_TYPE}.

The server returns the details for the specified attribute type, including multilingual descriptions and position.

Alternate Flows

Invalid Attribute Type: If the specified attribute type does not exist, the server returns a 404 error.

Unauthorized Access: If the client is unauthorized, the server returns a 403 error.

Rate Limiting: If the API rate limits are exceeded, the client must respect the retry interval indicated in the response headers Rate Limits.

JSON Sample

Here’s an example of the JSON response for an attribute type:

{
    "attributeType": {
        "attribute_type": "ECOMMERCE",
        "description_it": "string",
        "description_en": "string",
        "description_de": "string",
        "description_es": "string",
        "description_pt": "string",
        "description_fr": "string",
        "description_ja": "string",
        "description_ru": "string",
        "description_zh": "string",
        "description_ar": "string",
        "position": 1
    }
}

Sequence Diagram

Best Practices

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

Code Examples in Node.js

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Responses

🟢200Success

application/json

Body

Example

{
    "attributeType": {
        "attribute_type": "ECOMMERCE",
        "description_it": "Ecommerce",
        "description_en": "Ecommerce",
        "description_de": "Ecommerce",
        "description_es": "Ecommerce",
        "description_pt": "Ecommerce",
        "description_fr": "Ecommerce",
        "description_ja": "Ecommerce",
        "description_ru": "Ecommerce",
        "description_zh": "Ecommerce",
        "description_ar": "Ecommerce",
        "position": 1
    }
}

🟠401Authentication failed

🟠403Operation not allowed

🟠422Invalid pageSize

🟠404Attribute Type not found

🟠422Unique constraint error

Get Attribute Type

Retrieve a Single Attribute Type

Actors

Preconditions

Main Success Scenario

Alternate Flows

JSON Sample

Sequence Diagram

Code Examples in Node.js

Request

Request Code Samples

Responses

Get Attribute Type

Retrieve a Single Attribute Type#

Actors#

Preconditions#

Main Success Scenario#

Alternate Flows#

JSON Sample#

Sequence Diagram#

Code Examples in Node.js#

Request

Request Code Samples

Responses

Retrieve a Single Attribute Type

Actors

Preconditions

Main Success Scenario

Alternate Flows

JSON Sample

Sequence Diagram

Code Examples in Node.js