Create a new orderlist

POST 
/v1/orderlists

Create a new orderlist

Request

application/json

Body

required

Create orderlist input

productIds array[]

List of product ids

productSources

object[]

List of product sources

Array [

id stringrequired

Source ID

name stringrequired

Name of the source

]

clusterIds array[]

List of cluster ids

clusterSources

object[]

List of cluster sources

Array [

id stringrequired

Source ID

name stringrequired

Name of the source

]

type stringrequired

Possible values: [POSITIVE, NEGATIVE]

Orderlist type. One of: [POSITIVE, NEGATIVE]

descriptions

object[]

Orderlist descriptions per language

Array [

language stringrequired

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

Localized field language code

value stringnullablerequired

Localized field value

]

userIds array[]

List of user ids

userSources

object[]

List of user sources

Array [

id stringrequired

Source ID

name stringrequired

Name of the source

]

companyIds array[]

List of company ids

companySources

object[]

List of company sources

Array [

id stringrequired

Source ID

name stringrequired

Name of the source

]

Responses

201

Orderlist created

application/json

Schema

Schema

id integerrequired

Orderlist primary identifier

createdAt date-timerequired

Orderlist creation date

lastModifiedAt date-timerequired

Orderlist last modified date

descriptions

object[]

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

]

type stringrequired

Possible values: [POSITIVE, NEGATIVE]

Orderlist type

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."
    }
  ],
  "type": "POSITIVE",
  "productIds": [
    1111,
    2222,
    3333
  ],
  "clusterIds": [
    1111,
    2222,
    3333
  ],
  "userIds": [
    1111,
    2222,
    3333
  ],
  "companyIds": [
    1111,
    2222,
    3333
  ]
}

400

Bad request

403

Forbidden

500

Unknown create orderlist error

Loading...