Share

Get categorization attributes for multiple items

GET /api/bom/v2/item-versions/category-attributes gets all attributes and their values for all item IDs specified in the request.

Request schema

Method URL
GET /api/bom/v2/item-versions/category-attributes

Request header

*indicates required parameters

Field Value Type Description
*Authorization String Enter: Bearer access token.
*Upc-Selected-Company Integer Company’s ID. Use the value returned in the id field received in response to the following request: GET /api/auth/v1/companies.
*Id Array of integers An array of item version IDs for which to get categorization attributes.
X-User-Id Text Enter the email address of the user being impersonated. This value is required if you are using a two-legged token. If you are using a three-legged token, then this field is not required.

Response schema

Response body

200 response

Field Value Type Description
No field name An array of attributes and values The array contains JSON objects with item version ID and an array of categorization attributes for every item ID specified in the request. For every attribute on an item, the following parameters are returned:

  • attributeId - Categorization attribute ID
  • type - Type of the categorization attribute (will be one of STRING, FLOAT, DATE, INTEGER, LOV, or CHECKBOX)
  • name - Name of the categorization attribute
  • value - Value of the categorization attribute for that item
  • valueId - ID of the categorization attribute for that item (set for LOV (drop-down) attributes)

Sample response body

[
  {
    "itemVersionId": 2813342,
    "categoryAttributes": [
      {
        "attributeId": 9532,
        "type": "LOV",
        "name": "Material",
        "value": "100% Brushed Poly Flannel",
        "valueId": 3152
      }
    ]
  },
  {
    "itemVersionId": 1269575,
    "categoryAttributes": [
      {
        "attributeId": 9533,
        "type": "LOV",
        "name": "Materials new",
        "value": "80% Brushed Poly Flannel",
        "valueId": 3153
      },
      {
        "attributeId": 9531,
        "type": "FLOAT",
        "name": "Fill weight",
        "value": "10002.0",
        "valueId": null
      }
    ]
  }
]

Was this information helpful?