Get a list of orders

get/merchants/{merchantId}/terminalOrders

API Version

Returns a list of terminal products orders for the merchant account identified in the path.

To make this request, your API credential must have one of the following roles:

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.

Endpoint destination URL

https://management-test.adyen.com/v3/merchants/{merchantId}/terminalOrders

Query Parameters

Required

Optional

The number of orders to return.

The number of orders to skip.

The order status. Possible values (not case-sensitive): Placed, Confirmed, Cancelled, Shipped, Delivered.

Your purchase order number.

Path Parameters

Required

Optional

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.
dataarray[object]
List of orders for payment terminal packages and parts.
billingEntityobject
The details of the entity that the order is billed to.
addressobject
The address details of the billing entity.
citystring
The name of the city.
companyNamestring
The name of the company.
countrystring
The two-letter country code, in ISO 3166-1 alpha-2 format.
postalCodestring
The postal code.
stateOrProvincestring
The state or province as defined in ISO 3166-2. For example, ON for Ontario, Canada.

Applicable for the following countries:

Australia

Brazil

Canada

India

Mexico

New Zealand

United States

streetAddressstring
The name of the street, and the house or building number.
streetAddress2string
Additional address details, if any.
emailstring
The email address of the billing entity.
idstring
The unique identifier of the billing entity, for use as billingEntityId when creating an order.
namestring
The unique name of the billing entity.
taxIdstring
The tax number of the billing entity.
customerOrderReferencestring
The merchant-defined purchase order number. This will be printed on the packing list.
idstring
The unique identifier of the order.
itemsarray[object]
The products included in the order.
idstring
The unique identifier of the product.
installmentsinteger
The number of installments for the specified product id.
namestring
The name of the product.
quantityinteger
The number of items with the specified product id included in the order.
orderDatestring
The date and time that the order was placed, in UTC ISO 8601 format. For example, "2011-12-03T10:15:30Z".
shippingLocationobject
The details of the location where the order is shipped to.
addressobject
The address details of the shipping location.
citystring
The name of the city.
companyNamestring
The name of the company.
countrystring
The two-letter country code, in ISO 3166-1 alpha-2 format.
postalCodestring
The postal code.
stateOrProvincestring
The state or province as defined in ISO 3166-2. For example, ON for Ontario, Canada.

Applicable for the following countries:

Australia

Brazil

Canada

India

Mexico

New Zealand

United States

streetAddressstring
The name of the street, and the house or building number.
streetAddress2string
Additional address details, if any.
contactobject
The contact details for the shipping location.
emailstring
The individual's email address.
firstNamestring
The individual's first name.
infixstring
The infix in the individual's name, if any.
lastNamestring
The individual's last name.
phoneNumberstring
The individual's phone number, specified as 10-14 digits with an optional + prefix.
idstring
The unique identifier of the shipping location, for use as shippingLocationId when creating an order.
namestring
The unique name of the shipping location.
statusstring
The processing status of the order.
trackingUrlstring
The URL, provided by the carrier company, where the shipment can be tracked.
204 - No Content
The request has been successfully processed, but there is no additional content.
400 - Bad Request
A problem reading or understanding the request.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
401 - Unauthorized
Authentication required.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
403 - Forbidden
Insufficient permissions to process the request.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
422 - Unprocessable Entity
A request validation error.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
500 - Internal Server Error
The server could not process the request.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.

Get a list of orders

HTTP Responses

200 - OK

204 - No Content

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error