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
Endpoint destination URL
Click to copy

Path Parameters


The unique identifier of the order.


The unique identifier of the company account.

Request Parameters


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.


The merchant-defined purchase order reference.


The products included in the order.


Type of order


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


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 moreShow less
  • 400 - Bad Request

    A problem reading or understanding the request.

    Show moreShow less
  • 401 - Unauthorized

    Authentication required.

    Show moreShow less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show moreShow less
  • 422 - Unprocessable Entity

    A request validation error.

    Show moreShow less
  • 500 - Internal Server Error

    The server could not process the request.

    Show moreShow less