Get Product Extra

Get individual extra. This current version of the Products API includes localizedContent to support multi-locale catalogs, which was not present in the previous API model. If you were a client prior to May 2024 and have upgraded your implementation to support this feature, you can still access product data that has not yet been rewritten to the new model by providing an x-api-version header set to “1”.

GET /commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}

Error

A valid request URL is required to generate request examples

200

{
  "attributeFQN": "<string>",
  "isMultiSelect": true,
  "isRequired": true,
  "values": [
    {
      "attributeVocabularyValueDetail": {
        "content": {
          "localeCode": "<string>",
          "stringValue": "<string>"
        },
        "displayOrder": 123,
        "localizedContent": [
          {
            "localeCode": "<string>",
            "stringValue": "<string>"
          }
        ],
        "mappedGenericValues": [
          "<unknown>"
        ],
        "productName": "<string>",
        "value": "<unknown>",
        "valueSequence": 123
      },
      "deltaPrice": {
        "currencyCode": "<string>",
        "deltaPrice": 123
      },
      "deltaWeight": 123,
      "isDefaulted": true,
      "localizedDeltaPrice": [
        {
          "currencyCode": "<string>",
          "deltaPrice": 123
        }
      ],
      "quantity": 123,
      "value": null
    }
  ]
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Path Parameters

productCode · string · required

attributeFQN · string · required

Query Parameters

responseFields · string

limits which fields are returned in the response body

Response

200

application/json

OK

Product options for configurable or stand-alone products. A configurable option is one that the shopper chooses when ordering, for example, the color of a T-shirt. A stand-alone option is independent of the product and can be added to the product order. For example, a monogram.

attributeFQN · string | null

Unique identifier of the Attribute.

isMultiSelect · boolean | null

isRequired · boolean | null

values · object[] | null

Show child attributes