Add hierarchy link

Add a child product to this GTIN’s packaging hierarchy.

POST /products/api/v1/products/{gtin}/hierarchy

Add hierarchy link

cURL

curl --request POST \
  --url https://www.closient.com/products/api/v1/products/{gtin}/hierarchy \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "child_gtin": "<string>",
  "quantity": 123
}
'

200

{
  "id": "<string>",
  "parent_gtin": "<string>",
  "child_gtin": "<string>",
  "child_product_name": "<string>",
  "quantity": 123
}

Authorizations

APIKeyHeaderAuthOAuthTokenAuthSessionAuth

X-API-Key · string · header · required

Path Parameters

gtin · string · required

GTIN barcode of the parent product.

Body

application/json

child_gtin · string · required

GTIN of the child product to link.

quantity · integer · required

Number of child items contained in the parent.

hierarchy_level · enum<string> · required

GDSN packaging level.

Available options: UNIT, INNER_PACK, CASE, PALLET

Response

200 - application/json

OK

id · string<shortuuid> · required

URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

Required string length: 22

Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

parent_gtin · string · required

Parent product GTIN.

child_gtin · string · required

Child product GTIN.

child_product_name · string · required

Product name of the child product.

quantity · integer · required

Number of child items in the parent packaging.

hierarchy_level · enum<string> · required

GDSN packaging level.

Available options: UNIT, INNER_PACK, CASE, PALLET