APIMatic Adyen APIs
Sign Up to APIMatic
HomeSDKsAPI ReferenceContext Plugin
ManagementTerminal ordersTerminal orders merchant level

Update an order

PATCH
/merchants/{merchantId}/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

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

Authorization

AuthorizationBasic <token>

In: header

Path Parameters

merchantId*string

The unique identifier of the merchant account.

orderId*string

The unique identifier of the order.

Request Body

application/json

billingEntityId?string

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.

customerOrderReference?string

The merchant-defined purchase order reference.

items?array<>

The products included in the order.

orderType?string

Type of order

shippingLocationId?string

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

taxId?string

The tax number of the billing entity.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/merchants/string/terminalOrders/string" \  -H "Content-Type: application/json" \  -d '{    "items": [      {        "id": "TBOX-V400m-684-EU",        "name": "V400m Package",        "quantity": 1      },      {        "id": "PART-287001-EU",        "name": "Bluetooth Charging Base - V400m",        "quantity": 2      },      {        "id": "PART-620222-EU",        "name": "Receipt Roll",        "quantity": 20      }    ]  }'

Example response after updating an order for terminal products

{  "id": "4154567890100682",  "customerOrderReference": "YOUR_REFERENCE",  "status": "Placed",  "shippingLocation": {    "id": "S2-73536B20665526704F30792642212044452F714622375D477270",    "name": "YOUR_MERCHANT_ACCOUNT Barcelona depot",    "contact": {      "firstName": "Rita",      "lastName": "Perengano",      "phoneNumber": "+34931234567",      "email": "Rita.Perengano@company.com"    },    "address": {      "companyName": "YOUR_COMPANY",      "streetAddress": "El quinto pino 42",      "postalCode": "08012",      "city": "Barcelona",      "stateOrProvince": "",      "country": "ES"    }  },  "billingEntity": {    "id": "MerchantAccount.YOUR_MERCHANT_ACCOUNT",    "name": "YOUR_MERCHANT_ACCOUNT",    "taxId": "ES1234567890",    "email": "Pablo.Mengano@company.com",    "address": {      "streetAddress": "Paseo de la Castellana 43, 7",      "postalCode": "28046",      "city": "Madrid",      "country": "ES"    }  },  "orderDate": "2022-01-21T16:12:33Z",  "items": [    {      "id": "TBOX-V400m-684-EU",      "name": "V400m Package",      "quantity": 1    },    {      "id": "PART-287001-EU",      "name": "Bluetooth Charging Base - V400m",      "quantity": 2    },    {      "id": "PART-620222-EU",      "name": "Receipt Roll",      "quantity": 20    }  ]}

Get an order GET

Returns the details of the terminal products order identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read * Management API—Terminal ordering read and write In the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).

Cancel an order POST

Cancels the terminal products order identified in the path. Cancelling is only possible while the order has the status **Placed**. To cancel an order, make a POST call without a request body. The response returns the full order details, but with the status changed to **Cancelled**. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Terminal ordering read and write In the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).