Get a orderlist by id

GET 
/v2/orderlists/:id

Get a orderlist by id

Request

Path Parameters

id integerrequired

Orderlist identifier

Responses

200

Get a orderlist by id

application/json

Schema

Schema

id integerrequired

Orderlist primary identifier

createdAt date-timerequired

Orderlist creation date

lastModifiedAt date-timerequired

Orderlist last modified date

descriptions

object[]

required

Orderlist description per language

Array [

language stringrequired

Possible values: >= 2 characters and <= 2 characters

Language is set as 2 character country code.

value string

Localized field value

]

extras

object[]

Extra field per language

Array [

language stringrequired

Possible values: >= 2 characters and <= 2 characters

Language is set as 2 character country code.

value string

Localized field value

]

code string

Orderlist code

validFrom date-time

Valid from (Display only)

validTo date-time

Valid to (Display only)

type stringrequired

Possible values: [POSITIVE, NEGATIVE]

Orderlist type

partnerEntity string

Partner entity

active stringrequired

Default value: Y

Shows if the orderlist is active

productIds array[]required

List of product ids

clusterIds array[]required

List of cluster ids

userIds array[]required

List of user ids

companyIds array[]required

List of company ids

Example (from schema)

{
  "id": 1234,
  "createdAt": "2022-01-01T00:00:00.000Z",
  "lastModifiedAt": "2022-01-02T00:00:00.000Z",
  "descriptions": [
    {
      "language": "NL",
      "value": "Dutch desc."
    },
    {
      "language": "DE",
      "value": "German desc."
    }
  ],
  "extras": [
    {
      "language": "NL",
      "value": "Dutch"
    },
    {
      "language": "DE",
      "value": "German"
    }
  ],
  "code": "Code123",
  "validFrom": "2022-01-01T00:00:00.000Z",
  "validTo": "2022-01-01T00:00:00.000Z",
  "type": "POSITIVE",
  "partnerEntity": "Partner entity",
  "active": "Y",
  "productIds": [
    1111,
    2222,
    3333
  ],
  "clusterIds": [
    1111,
    2222,
    3333
  ],
  "userIds": [
    1111,
    2222,
    3333
  ],
  "companyIds": [
    1111,
    2222,
    3333
  ]
}

400

Bad request

401

Unauthorized

application/json

Schema

Schema

any

invalid_client_id

{
  "ErrorCode": "invalid_client",
  "Error": "ClientId is Invalid"
}

invalid_client_cred

{
  "ErrorCode": "invalid_client",
  "Error": "Client credentials are invalid"
}

403

Forbidden

404

Orderlist not found

500

Unknown get orderlist error

Loading...