Update an order

patch /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

Endpoint destination URL

https://management-test.adyen.com/v1/companies/{companyId}/terminalOrders/{orderId}
Click to copy

Path parameters

orderId string Required

The unique identifier of the order.

companyId string Required

The unique identifier of the company account.

Request parameters

billingEntityId string

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

customerOrderReference string

The merchant-defined purchase order reference.

items [OrderItem] array

The products included in the order.

shippingLocationId string

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

taxId string

The tax number of the billing entity.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

  • 200 - OK

    The request has succeeded.

    Show more Show less
  • 400 - Bad Request

    A problem reading or understanding the request.

    Show more Show less
  • 401 - Unauthorized

    Authentication required.

    Show more Show less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show more Show less
  • 422 - Unprocessable Entity

    A request validation error.

    Show more Show less
  • 500 - Internal Server Error

    The server could not process the request.

    Show more Show less
  • Request
  • Click to copy
  • Response
  • Click to copy