Skip to content

Lookup list

Get Single

This returns a represenation of a lookup list.

URL : /:organizationid/:pimid/api/v0.1/lookuplist:id

URL Parameters:

organizationid=[string] is the ID of the chainbox.io organization.

pimid=[string] is the APP ID of the PIM application.

productid=[string] is the ID of the lookup list.

Method: GET

Auth required: YES

Authorization required: read

Response body example

{
  "code": "variant1",
  "label": "længde",
  "sortorder": 100,
  "fields": [],
  "createdby": "Kød Hans",
  "createdate": "2025-06-30T07:29:31.624Z",
  "lastupdatedby": "PIM-API",
  "lastupdated": "2025-09-18T10:11:03.225Z"
}

Error Responses

Condition: If the id doesn't exist Code: 404 NOTFOUND

Get All

This returns a list of all lookup list.

URL : /:organizationid/:pimid/api/v0.1/lookuplist/lookuplists

URL Parameters:

organizationid=[string] is the ID of the chainbox.io organization.

pimid=[string] is the APP ID of the PIM application.

Method: GET

Auth required: YES

Authorization required: read

Response example

Success Response

Code: 200 OK

{
  "variant1": {
    "code": "variant1",
    "label": "længde",
    "sortorder": 100,
    "fields": [],
    "createdby": "Kød Hans",
    "createdate": "2025-06-30T07:29:31.624Z",
    "lastupdatedby": "PIM-API",
    "lastupdated": "2025-09-18T10:11:03.225Z"
  },
  "variant2": {
    "code": "variant2",
    "label": "Størrelse",
    "sortorder": 100,
    "fields": [],
    "createdby": "Kød Hans",
    "createdate": "2025-06-30T07:29:48.964Z",
    "lastupdatedby": "Kød Hans",
    "lastupdated": "2025-06-30T07:29:48.964Z"
  }
}

Update lookup list

URL : /:organizationid/:pimid/api/v0.1/lookuplist

URL Parameters:

organizationid=[string] is the ID of the chainbox.io organization.

pimid=[string] is the APP ID of the PIM application.

productid=[string] is the ID of the lookup list.

Method: PUT

Auth required: YES

Authorization required: write

Body Parameters:

code: The code of the lookup list .

label: Label name of the lookup list.

sortorder: The sort order value used for sorting.

fields: key/value fields.

Request example

{
  "code": "variant1",
  "label": "Længde",
  "sortorder": "100"
  "fields": {
    "field1": {
      "code": "field1",
      "label": "Test field",
      "sortorder": "100"
    }
  }
}

Success Response

Code: 200 OK

Error Responses

Condition: If basic auth header is not present in request or is incorrect. Code: 401 UNAUTHORIZED Condition: If the data is not valid. Includes a message with the error. Code: 422 UNPROCESSABLEENTITY Condition: If the id doesn't exist Code: 404 NOTFOUND