ADadyen
Terminal orders - company level

Update an order

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

In the live environment, requests to this endpoint are subject to rate limits.

patch/companies/{companyId}/terminalOrders/{orderId}

Request

  • Base URL
    https://management-test.adyen.com/v3
  • URL
    https://management-test.adyen.com/v3/companies/{companyId}/terminalOrders/{orderId}
  • Auth
    • HTTP basic
    • or API key in header X-API-Key

Path parameters

companyIdstring required

The unique identifier of the company account.

orderIdstring required

The unique identifier of the order.

Request body

billingEntityIdstring

The identification of the billing entity to use for the order.

When ordering products in Brazil, you do not need to include the billingEntityId in the request.

customerOrderReferencestring

The merchant-defined purchase order reference.

orderTypestring

Type of order

shippingLocationIdstring

The identification of the shipping location to use for the order.

taxIdstring

The tax number of the billing entity.

Response

OK - the request has succeeded.

customerOrderReferencestring

The merchant-defined purchase order number. This will be printed on the packing list.

idstring

The unique identifier of the order.

orderDatestring

The date and time that the order was placed, in UTC ISO 8601 format. For example, "2011-12-03T10:15:30Z".

statusstring

The processing status of the order.

trackingUrlstring

The URL, provided by the carrier company, where the shipment can be tracked.

Changes

No recorded changes to this operation across all 50 revisions of this API.