Get Attribute

Retrieving Attribute Type Values

This API retrieves the list of values that a specific attribute type can assume, filtering based on the provided attribute_type parameter. This endpoint is useful for obtaining the permissible values for a defined attribute type, as part of managing product attributes or settings within the 4ws.trade suite.

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 code is available, representing the specific attribute type for which values are being fetched.

Pagination parameters (page and pageSize) may be required depending on the dataset size.

Main Success Scenario

The client application sends a GET request to the API with attribute_type as a query parameter.

The API returns a JSON array of attribute values matching the specified attribute_type.

If moreRows is true, the client repeats the request with incremented page until moreRows is false.

The client processes and displays or stores the returned attribute values.

Alternate Flows

Error Handling: If the request fails or the attribute_type is invalid, the API responds with an error. The client should implement retry logic or error logging to handle failed requests.

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

{
  "attributes": [
    {
      "attribute_type": "ECOMMERCE",
      "attribute_level": "Y",
      "description_it": "Sì",
      "description_en": "Yes",
      "description_de": "Ja",
      "active": "true"
    },
    {
      "attribute_type": "ECOMMERCE",
      "attribute_level": "N",
      "description_it": "No",
      "description_en": "No",
      "description_de": "Nein",
      "active": "true"
    },
    {
      "attribute_type": "ECOMMERCE",
      "attribute_level": "No",
      "description_it": "No",
      "description_en": "No",
      "description_de": "Nein",
      "active": "false"
    }
  ],
  "moreRows": false
}

The API response includes:

attributes: An array of attribute objects, each containing attribute_type, attribute_level, and multilingual descriptions.

moreRows: A boolean indicating if there are more rows to fetch.

Paginated Responses

The service is paginated to handle large sets of data efficiently.
For detailed information on how to handle pagination, refer to our Paginated Responses

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

{
    "attributes": [
        {
            "attribute_type": "ECOMMERCE",
            "attribute_level": "Y",
            "description_it": "Sì",
            "description_en": "Yes",
            "description_de": "Ja",
            "active": "true"
        },
        {
            "attribute_type": "ECOMMERCE",
            "attribute_level": "N",
            "description_it": "No",
            "description_en": "No",
            "description_de": "Nein",
            "active": "true"
        },
        {
            "attribute_type": "ECOMMERCE",
            "attribute_level": "No",
            "description_it": "No",
            "description_en": "No",
            "description_de": "Nein",
            "active": "false"
        }
    ],
    "moreRows": false
}

🟠401Authentication failed

🟠404Attribute not found

🟠404Attribute not found with attribute_level

🟠422Invalid pageSize

🟠403Operation not allowed

🟠422Unique constraint error

Retrieving Attribute Type Values

Actors

Preconditions

Main Success Scenario

Alternate Flows

JSON Sample

Sequence Diagram

Code Examples in Node.js

Request

Request Code Samples

Responses

Get Attribute

Retrieving Attribute Type Values#

Actors#

Preconditions#

Main Success Scenario#

Alternate Flows#

JSON Sample#

Sequence Diagram#

Code Examples in Node.js#

Request

Request Code Samples

Responses

Retrieving Attribute Type Values

Actors

Preconditions

Main Success Scenario

Alternate Flows

JSON Sample

Sequence Diagram

Code Examples in Node.js