4WS Suite
Home
API Reference
  • Data mangement API
  • Documents API
Home
API Reference
  • Data mangement API
  • Documents API
Fourwayshop
  1. Attribute
  • Login
    • login
      POST
  • Product
    • Brand
      • Get All Brands
      • Get A Brand
      • Insert brand
      • Update brand
    • Season
      • Get All Seasons
      • Get A Season
      • Insert season
      • Update season
    • Attribute
      • Get All Attribute Types
        GET
      • Get Attribute Type
        GET
      • Get Attribute
        GET
      • Insert attribute
        POST
      • Update attribute
        PATCH
    • Hierarchy
      • Insert hierarchy
      • Update hierarchy
    • Dimension groups
      • Insert dimension group
      • Update dimension group
    • Dimension
      • Insert dimension
      • Update dimension
      • Delete dimension
    • Product
      • Get products
      • Get product
      • Get product grouping
      • Get SKU's barcodes
      • Get product stock
      • Insert product
      • Update product
    • Activate dimensions on products
      • Insert active dimensions
      • Delete active dimensions
    • Barcode
      • Get SKU from barcode
      • Generate missing barcodes
      • Generate missing barcode for SKU
      • Insert barcode
      • Delete barcode
    • Prices
      • Get product prices
    • Price dimension groupings
      • Get Dimension Price Grouping
      • Get All Dimension Price Grouping
      • Insert dimension grouping
      • Update dimension grouping
      • Delete dimension grouping
    • Assortment
      • insert product assortment
      • delete product assortment
    • Image
      • Get images
      • Add image
      • Replace image
      • Delete image
    • Supplier
      • Get Item suppliers
      • Insert item supplier
      • Delete item supplier
      • Update item supplier
    • Custom category
      • Get Custom code
      • Insert Custom code
      • Update Custom code
    • Vat
      • Vat types
        • Get VAT type
        • Get VAT types
      • VATs
        • Get VATs
        • Get VATs by type
        • Get VAT
      • Vat rates
        • Get VAT rates
        • Get single VAT rates
    • Stock
      • Insert stock
      • Get stock
  • Price lists
    • Get price lists
      GET
    • Get price lists by type
      GET
    • Get price list
      GET
    • Get prices from price list
      GET
    • Get entities from price lists
      GET
    • Insert Price List
      POST
    • Insert Product Price
      POST
    • Insert Entity On Price Lists
      POST
    • Update price list
      PATCH
    • Delete all product prices
      DELETE
    • Delete single product price
      DELETE
    • Delete entity from a price lists
      DELETE
  • Supplier
    • Supplier contacts
    • Supplier addresses
    • Get Suppliers
    • Get A Specific Supplier
    • Insert supplier
    • Update supplier
  • Entities
    • Get entities
    • Get entity
    • Insert entity
    • Update entity
  • Miscellaneous
    • Get requests rate limits
  • Catalog
    • Get Catalogs details
    • Get Catalog details by Code
    • Get products by Catalog Code
  • Export
    • Get bulk CSV Export
  1. Attribute

Update attribute

PATCH
/api/v1/attributes/{ATTRIBUTE_TYPE}/{ATTRIBUTE_LEVEL}
Last modified:2025-02-07 14:40:04

Updating Attribute Values for Product Master Data#

This API enables external systems to update the descriptions of an existing attribute associated with a product's master data. For example, updating the Italian or English descriptions for an attribute.

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 attribute must exist in the system before the update request is made.
The external system must have the necessary permissions and access to the document creation service, please refer to Authentication.

Main Success Scenario#

If the attribute and hierarchy exist, the system will update the description successfully and return an HTTP 200 response with the updated attribute details.
Example Response:
{
  "attribute": {
    "attribute_level": {
      "prog_id": 14983
    }
  }
}

Alternate Flows#

1.
Attribute type not found:
If the specified attribute_type does not exist, the following error will be returned:
{
  "message": "attribute_type with {attribute_type*} not found"
}
HTTP Status: 422 Unprocessable Entity
2.
Attribute level already exists:
If the attribute level already exists, the following error will be returned:
{
  "message": "attribute_level with {attribute_level} 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 shows how to update the description of an existing attribute using the API.

Request

Path Params

Header Params

Body Params application/json

Example
{
    "description_it": "{{description_it}}",
    "description_en": "{{description_en}}"
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH '/api/v1/attributes/ECOMMERCE/YES' \
--header 'Authorization: Bearer XXX' \
--header 'Content-Type: application/json' \
--data-raw '{
    "description_it": "{{description_it}}",
    "description_en": "{{description_en}}"
}'

Responses

🟢200success
application/json
Body

Example
{
    "attribute": {
        "attribute_level": {
            "prog_id": 14983
        }
    }
}
🟠401Authentication failed
🟠403Operation not allowed
🟠422Unique constraint error
Modified at 2025-02-07 14:40:04
Previous
Insert attribute
Next
Insert hierarchy
Built with