Update a terminal order
PATCH {{baseUrl}}/companies/:companyId/terminalOrders/:orderId
Updates the terminal products order identified in the path. Updating is only possible while the order has the status Placed. The request body only needs to contain what you want to change. However, to update the products in the items array, you must provide the entire array. For example, if the array has three items: To remove one item, the array must include the remaining two items. Or to add one item, the array must include all four items. To make this request, your API credential must have the following role: * Management API—Terminal ordering read and write
Request Body
{"items"=>[{"id"=>"TBOX-V400m-684-EU", "name"=>"V400m Package", "quantity"=>1}, {"id"=>"PART-175746-EU", "name"=>"Adyen Test Card", "quantity"=>1}, {"id"=>"PART-620222-EU", "name"=>"Receipt Roll", "quantity"=>5}]}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"id":"5265677890100681","customerOrderReference":"YOUR_REFERENCE_1","status":"Placed","shippingLocation":{"id":"S2-7973536B20662642215526704F302044452F714622375D476169","name":"YOUR_COMPANY Rokin depot","contact":{"firstName":"Paul","lastName":"Green","phoneNumber":"+31 020 1234567","email":"Paul.Green@company.com"},"address":{"companyName":"YOUR_COMPANY","streetAddress":"Rokin 21","postalCode":"1012 KS","city":"Amsterdam","stateOrProvince":"","country":"NL"}},"billingEntity":{"id":"Company.YOUR_COMPANY","name":"YOUR_COMPANY","taxId":"NL1234567890","email":"Paul.Green@company.com","address":{"streetAddress":"Simon Carmiggeltstraat 6-50","postalCode":"1011 DJ","city":"Amsterdam","country":"NL"}},"orderDate":"2022-01-20T14:12:33Z","items":[{"id":"TBOX-V400m-684-EU","name":"V400m Package","quantity":1},{"id":"PART-175746-EU","name":"Adyen Test Card","quantity":1},{"id":"PART-620222-EU","name":"Receipt Roll","quantity":5}]}