Get a list of orders

get /companies/{companyId}/terminalOrders

Was this page helpful?

Returns a lists of terminal products orders for the company identified in the path. To filter the list, use one or more of the query parameters.

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

Endpoint destination URL

https://management-test.adyen.com/v1/companies/{companyId}/terminalOrders

Query parameters

Required Optional

limit integer

The number of orders to return.

offset integer

The number of orders to skip.

status string

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

customerOrderReference string

Your purchase order number.

Path parameters

Required Optional

companyId string Required

The unique identifier of the company account.

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
data array [object]

List of orders for payment terminal packages and parts.

Show children Hide children

billingEntity object

The details of the entity that the order is billed to.

Show children Hide children

address object

The address details of the billing entity.

Show children Hide children

city string

The name of the city.

companyName string

The name of the company.

country string

The two-letter country code, in ISO 3166-1 alpha-2 format.

postalCode string

The postal code.

stateOrProvince string

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

streetAddress string

The name of the street, and the house or building number.

streetAddress2 string

Additional address details, if any.

email string

The email address of the billing entity.

id string

The unique identifier of the billing entity, for use as billingEntityId when creating an order.

name string

The unique name of the billing entity.

taxId string

The tax number of the billing entity.

customerOrderReference string

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

id string

The unique identifier of the order.

items array [object]

The products included in the order.

Show children Hide children

id string

The unique identifier of the product.

installments integer

The number of installments for the specified product id.

name string

The name of the product.

quantity integer

The number of items with the specified product id included in the order.

orderDate string

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

shippingLocation object

The details of the location where the order is shipped to.

Show children Hide children

address object

The address details of the shipping location.

Show children Hide children

city string

The name of the city.

companyName string

The name of the company.

country string

The two-letter country code, in ISO 3166-1 alpha-2 format.

postalCode string

The postal code.

stateOrProvince string

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

streetAddress string

The name of the street, and the house or building number.

streetAddress2 string

Additional address details, if any.

contact object

The contact details for the shipping location.

Show children Hide children

email string

The individual's email address.

firstName string

The individual's first name.

infix string

The infix in the individual's name, if any.

lastName string

The individual's last name.

phoneNumber string

The individual's phone number, specified as 10-14 digits with an optional + prefix.

id string

The unique identifier of the shipping location, for use as shippingLocationId when creating an order.

name string

The unique name of the shipping location.

status string

The processing status of the order.

trackingUrl string

The URL, provided by the carrier company, where the shipment can be tracked.
400 - Bad Request

A problem reading or understanding the request.
Show more Show less
detail string

A human-readable explanation specific to this occurrence of the problem.

errorCode string

A code that identifies the problem type.

instance string

A unique URI that identifies the specific occurrence of the problem.

invalidFields array [InvalidFieldWrapper]

Detailed explanation of each validation error, when applicable.

Show children Hide children

InvalidField object

Show children Hide children

message string

Description of the validation error.

name string

The field that has an invalid value.

value string

The invalid value.

requestId string

A unique reference for the request, essentially the same as pspReference.

response object

JSON response payload.

Show children Hide children

paths array [JSONPathWrapper]

Show children Hide children

JSONPath object

Show children Hide children

content array [string]

rootPath object

Show children Hide children

content array [string]

status integer

The HTTP status code.

title string

A short, human-readable summary of the problem type.

type string

A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
401 - Unauthorized

Authentication required.
Show more Show less
detail string

A human-readable explanation specific to this occurrence of the problem.

errorCode string

A code that identifies the problem type.

instance string

A unique URI that identifies the specific occurrence of the problem.

invalidFields array [InvalidFieldWrapper]

Detailed explanation of each validation error, when applicable.

Show children Hide children

InvalidField object

Show children Hide children

message string

Description of the validation error.

name string

The field that has an invalid value.

value string

The invalid value.

requestId string

A unique reference for the request, essentially the same as pspReference.

response object

JSON response payload.

Show children Hide children

paths array [JSONPathWrapper]

Show children Hide children

JSONPath object

Show children Hide children

content array [string]

rootPath object

Show children Hide children

content array [string]

status integer

The HTTP status code.

title string

A short, human-readable summary of the problem type.

type string

A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
403 - Forbidden

Insufficient permissions to process the request.
Show more Show less
detail string

A human-readable explanation specific to this occurrence of the problem.

errorCode string

A code that identifies the problem type.

instance string

A unique URI that identifies the specific occurrence of the problem.

invalidFields array [InvalidFieldWrapper]

Detailed explanation of each validation error, when applicable.

Show children Hide children

InvalidField object

Show children Hide children

message string

Description of the validation error.

name string

The field that has an invalid value.

value string

The invalid value.

requestId string

A unique reference for the request, essentially the same as pspReference.

response object

JSON response payload.

Show children Hide children

paths array [JSONPathWrapper]

Show children Hide children

JSONPath object

Show children Hide children

content array [string]

rootPath object

Show children Hide children

content array [string]

status integer

The HTTP status code.

title string

A short, human-readable summary of the problem type.

type string

A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
422 - Unprocessable Entity

A request validation error.
Show more Show less
detail string

A human-readable explanation specific to this occurrence of the problem.

errorCode string

A code that identifies the problem type.

instance string

A unique URI that identifies the specific occurrence of the problem.

invalidFields array [InvalidFieldWrapper]

Detailed explanation of each validation error, when applicable.

Show children Hide children

InvalidField object

Show children Hide children

message string

Description of the validation error.

name string

The field that has an invalid value.

value string

The invalid value.

requestId string

A unique reference for the request, essentially the same as pspReference.

response object

JSON response payload.

Show children Hide children

paths array [JSONPathWrapper]

Show children Hide children

JSONPath object

Show children Hide children

content array [string]

rootPath object

Show children Hide children

content array [string]

status integer

The HTTP status code.

title string

A short, human-readable summary of the problem type.

type string

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.
Show more Show less
detail string

A human-readable explanation specific to this occurrence of the problem.

errorCode string

A code that identifies the problem type.

instance string

A unique URI that identifies the specific occurrence of the problem.

invalidFields array [InvalidFieldWrapper]

Detailed explanation of each validation error, when applicable.

Show children Hide children

InvalidField object

Show children Hide children

message string

Description of the validation error.

name string

The field that has an invalid value.

value string

The invalid value.

requestId string

A unique reference for the request, essentially the same as pspReference.

response object

JSON response payload.

Show children Hide children

paths array [JSONPathWrapper]

Show children Hide children

JSONPath object

Show children Hide children

content array [string]

rootPath object

Show children Hide children

content array [string]

status integer

The HTTP status code.

title string

A short, human-readable summary of the problem type.

type string

A URI that identifies the problem type, pointing to human-readable documentation on this problem type.

Get a list of orders

Endpoint destination URL

Query parameters

Path parameters

Response parameters

HTTP Responses

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error