Delete a orderlist by id
DELETE/v2/orderlists/:id
Delete a orderlist by id
Request
Path Parameters
Orderlist id
Responses
- 200
- 400
- 403
- 404
- 500
Orderlist deleted
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
]
Orderlist primary identifier
Orderlist creation date
Orderlist last modified date
descriptions
object[]
required
Orderlist description per language
Possible values: >= 2 characters
and <= 2 characters
Language is set as 2 character country code.
Localized field value
extras
object[]
Extra field per language
Possible values: >= 2 characters
and <= 2 characters
Language is set as 2 character country code.
Localized field value
Orderlist code
Valid from (Display only)
Valid to (Display only)
Possible values: [POSITIVE
, NEGATIVE
]
Orderlist type
Partner entity
Default value: Y
Shows if the orderlist is active
List of product ids
List of cluster ids
List of user ids
List of company ids
{
"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
]
}
Bad request
Forbidden
Orderlist not found
Unknown delete orderlist error