Tag an item with an attribute value

Operation ID: createItemAttribute

Group: Inventory › Item Attributes

Open in the interactive reference

POST /inventory/item-attributes

Retry-safe: A write that accepts Idempotency-Key: repeating a request with the same key replays the stored answer instead of executing twice.

Tags an item with one value of one attribute. The value must be one the attribute defines: assigning a value that belongs to a different attribute fails with VALUE_MISMATCH. An item holds one value per attribute, so tagging it with an attribute it already carries fails with DUPLICATE_ASSIGNMENT — delete the existing assignment first. There is no update — an assignment is only the item, the attribute and the value, so a change is this call and a DELETE.

Parameters

Name In Type Required Description
Api-Version header string · v1 yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
Idempotency-Key header string no An opaque caller-chosen string (1-255 characters) that makes this request safe to retry. Repeating the same key with an identical request body replays the original response instead of re-executing - but only once that original request succeeded; a failed attempt re-executes on retry. Repeating the key with a different body is answered with 422. A key still in flight is answered with 409 - as is a key whose original request was interrupted before it finished, for a few minutes afterwards, until that attempt is presumed dead. A completed response stays replayable for 24 hours. The key is scoped to the caller, not to the action: reusing it for a different action is answered with 409 or 422 rather than treated independently. On read actions this header is ignored. On write actions that cannot offer the guarantee it is answered with 400 IDEMPOTENCY_NOT_SUPPORTED rather than silently ignored.

Request body

Required, application/json: createItemAttributeInput.

Field Type Required Description
itemId string yes The identifier of the item to tag. See id on GET inventory/items/:id. Example: "5f21c8b0-9d34-4a76-8e12-04b93c7de5a8".
attributeId string yes The identifier of the attribute definition to assign. Example: "c7a84f92-1e63-4d55-b0a1-6f7e3b9c2d48".
valueId string yes The identifier of the value to assign. It must be a value the attribute defines. Example: "2b6d0e14-8f77-4a91-95c3-1d4e8a7f6b03". 
{
  "itemId": "5f21c8b0-9d34-4a76-8e12-04b93c7de5a8",
  "attributeId": "c7a84f92-1e63-4d55-b0a1-6f7e3b9c2d48",
  "valueId": "2b6d0e14-8f77-4a91-95c3-1d4e8a7f6b03"
}

Response

200 Success

Under data (createItemAttributeOutput):

Field Type Required Description
id string yes The unique identifier for the new item attribute. Example: "9f2c1d77-5b41-4e0a-9a33-8c5d2e61b704".
itemId string yes The identifier of the item carrying the attribute. Example: "5f21c8b0-9d34-4a76-8e12-04b93c7de5a8".
itemCode string no The item's code, for example 'WIDGET-01'. Example: "WIDGET-01".
attributeId string yes The identifier of the attribute definition. Example: "c7a84f92-1e63-4d55-b0a1-6f7e3b9c2d48".
attributeName string no The attribute's name, for example 'Colour'. Example: "Colour".
valueId string no The identifier of the chosen value. Example: "2b6d0e14-8f77-4a91-95c3-1d4e8a7f6b03".
value string no The chosen value's text, for example 'Red'. Example: "Red". 
{
  "data": {
    "id": "9f2c1d77-5b41-4e0a-9a33-8c5d2e61b704",
    "itemId": "5f21c8b0-9d34-4a76-8e12-04b93c7de5a8",
    "itemCode": "WIDGET-01",
    "attributeId": "c7a84f92-1e63-4d55-b0a1-6f7e3b9c2d48",
    "attributeName": "Colour",
    "valueId": "2b6d0e14-8f77-4a91-95c3-1d4e8a7f6b03",
    "value": "Red"
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Response headers

Errors

Code Status
REFERENCE_NOT_FOUND 400
VALUE_MISMATCH 400
DUPLICATE_ASSIGNMENT 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses