Search orderlists

POST 
/v2/orderlists/search

Search orderlists

Request

application/json

Body

required

Search orderlists

page number

Default value: 1

Pagination page number. [Default to 1]

offset number

Default value: 12

Pagination offset number. [Default to 12]

createdAt object
lastModifiedAt object
ids string[]

List of Orderlist primary identifiers

codes string[]

List of codes

validTo object
validFrom object
type string

Possible values: [POSITIVE, NEGATIVE]

Orderlist type. One of: [POSITIVE, NEGATIVE]

partnerEntities string[]

Partner entity

active string

Shows if the orderlist is active

userIds string[]

List of user ids

userSources string[]

List of user sources

companyIds string[]

List of company ids

companySources string[]

List of company sources

productIds string[]

List of product ids

productSources string[]

List of product sources

clusterIds string[]

List of cluster ids

clusterSources string[]

List of cluster sources

sortInputs string[]

Inputs to sort by

Responses

200

Paginated list of orderlists

application/json

Schema

Schema

items

object[]

required

List of items of type Orderlist

Array [

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 string[]required

List of product ids

clusterIds string[]required

List of cluster ids

userIds string[]required

List of user ids

companyIds string[]required

List of company ids

]

itemsFound integerrequired

Total number of items found

offset integernullablerequired

Possible values: >= 1

Default value: 12

The amount of items to show per page

page integernullablerequired

Possible values: >= 1

Default value: 1

The current page

pages integernullablerequired

Possible values: >= 1

Total amount of pages

start integernullablerequired

Possible values: >= 1

Start position of the current page

end integernullablerequired

Possible values: >= 1

End position of the current page

Example (from schema)

{
  "items": [
    {
      "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
      ]
    }
  ],
  "itemsFound": 12,
  "offset": 12,
  "page": 4,
  "pages": 1,
  "start": 1,
  "end": 12
}

400

Bad request

403

Forbidden.

500

Unknown get orderlists error

Loading...