Lookup list item

Get Single

This returns a represenation of a lookup list item.

URL : /:organizationid/:pimid/api/v0.1/lookuplistitem: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 item.

Method: GET

Auth required: YES

Authorization required: read

Response body example

{
  "code": "L3126",
  "fields": {},
  "label": "L3126",
  "lookuplist": "businesscentralvariants",
  "sortorder": 100
}

Get All

This returns a list of all lookup list items.

URL : /:organizationid/:pimid/api/v0.1/lookuplistitem/lookuplistitems

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

{
    "businesscentralvariants_L3126": {
        "code": "L3126",
        "fields": {},
        "label": "L3126",
        "lookuplist": "businesscentralvariants",
        "sortorder": 100
    },
    "businesscentralvariants_L3127": {
        "code": "L3127",
        "fields": {},
        "label": "L3127",
        "lookuplist": "businesscentralvariants",
        "sortorder": 100
    }
}

Create lookup list item

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

URL Parameters:

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

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

Method: POST

Auth required: YES

Authorization required: write

Body Parameters:

code: The code of the lookup list item.

fields: key/value string fields. the key must match a field on the lookup list.

label: Label name of the lookup list item.

lookuplist: The lookup list to add the lookup list item to.

sortorder: The sort order value used for sorting.

Request example

{
        "code": "L3126",
        "fields": {
          "field1": "value"
        },
        "label": "L3126",
        "lookuplist": "businesscentralvariants",
        "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: The member email has a conflict with another member Code: 409 CONFLICT