Skip to main content

Get List

Get orders list.

Request Parametersapplication/json
OrdersListRequestModel
object
skip
integer
Define how many results you want to skip. The default value is 0.
take
integer
Define how many first results to display after the skipped ones.
Default - 50. Maximum - 100.
search
object
The search options.
orderIds
array[integer]
The list of order IDs for which you want to get the details.
subscriptionId
integer
The subscription ID for which you want to get the details.
customerEmail
string
The customer's billing email. Only domain in the format example.com
can also be used to retrieve the data
orderStatusId
integer
The ID of the order status. Possible values: 1 - Waiting, 2 - Canceled,
3 - Refunded, 4 - Chargeback, 5 - Processed.
sortByDate
string
Sort the orders by the creation date. Possible values:
"asc" - ascending order. Default.
"desc" - descending order.
includeTestOrders
boolean
Possible values are true or false. False by default.
vendorAccountId
integer
required
The vendor account ID identifies your PayPro Global account.
It can be found in Account settings > Business info.
apiSecretKey
string
required
The vendor account API secret key is a unique key
that was generated specifically for authenticating API requests.
It can be found in Store settings > General settings > Integration tab.
Response Parametersapplication/json
OrdersListResponseModel
object
response
object
skip
integer
Define how many results you want to skip. The default value is 0.
take
integer
Define how many first results to display after the skipped ones. Default - 50. Maximum - 100.
totalCount
integer
Total results count.
orders
array[object]
The collection of orders.
id
integer
The order ID value.
placedAtUtc
string<date-time>
The date when the order was placed in UTC time zone.
invoiceUrl
string
The invoice URL. It can be empty.
customerBillingEmail
string
The customer's billing email address.
customerBillingFirstName
string
The customer's billing first name.
customerBillingLastName
string
The customer's billing last name.
orderStatusId
integer
The ID of the order status. Possible values: 1 – Waiting, 2 – Canceled,
3 –Refunded, 4 – Chargeback, 5 – Processed.
paymentMethodId
integer
The payment method ID.
orderStatusName
string
The text representation of the order status.
paymentMethodName
string
The text representation of the payment method.
request
object
skip
integer
Define how many results you want to skip. The default value is 0.
take
integer
Define how many first results to display after the skipped ones. Default - 50. Maximum - 100.
search
object
The search options.
orderIds
array[integer]
The list of order IDs for which you want to get the details.
subscriptionId
integer
The subscription ID for which you want to get the details.
customerEmail
string
The customer's billing email. Only domain in the format example.com
can also be used to retrieve the data
orderStatusId
integer
The ID of the order status. Possible values: 1 - Waiting, 2 - Canceled,
3 - Refunded, 4 - Chargeback, 5 - Processed.
sortByDate
string
Sort the orders by the creation date. Possible values:
"asc" - ascending order. Default.
"desc" - descending order.
includeTestOrders
boolean
Possible values are true or false. False by default.
vendorAccountId
integer
The vendor account ID identifies your PayPro Global account.
It can be found in Account settings > Business info.
apiSecretKey
string
The vendor account API secret key is a unique key
that was generated specifically for authenticating API requests.
It can be found in Store settings > General settings > Integration tab.
errors
array[object]
propertyWithError
string
propertyErrorMessages
array[string]
isSuccess
boolean
Request Sample
{
"skip": 1,
"take": 1,
"search": {
"orderIds": [
5458995,
5458996
],
"subscriptionId": 1,
"customerEmail": "[email protected]",
"orderStatusId": 1
},
"sortByDate": "sample string 1",
"includeTestOrders": false,
"vendorAccountId": 123456,
"apiSecretKey": "your_api_secret_key"
}
Response Sample
{
"response": {
"skip": 1,
"take": 2,
"totalCount": 3,
"orders": [
{
"id": 1,
"placedAtUtc": "2022-12-28T10:29:34.7381622-05:00",
"invoiceUrl": "sample string 3",
"customerBillingEmail": "sample string 4",
"customerBillingFirstName": "sample string 5",
"customerBillingLastName": "sample string 6",
"orderStatusId": 5,
"paymentMethodId": 8,
"orderStatusName": "Processed",
"paymentMethodName": "Solo"
},
{
"id": 1,
"placedAtUtc": "2022-12-28T10:29:34.7381622-05:00",
"invoiceUrl": "sample string 3",
"customerBillingEmail": "sample string 4",
"customerBillingFirstName": "sample string 5",
"customerBillingLastName": "sample string 6",
"orderStatusId": 5,
"paymentMethodId": 8,
"orderStatusName": "Processed",
"paymentMethodName": "Solo"
}
]
},
"request": {
"skip": 1,
"take": 1,
"search": {
"orderIds": [
5458995,
5458996
],
"subscriptionId": 1,
"customerEmail": "[email protected]",
"orderStatusId": 1
},
"sortByDate": "sample string 1",
"includeTestOrders": false,
"vendorAccountId": 123456,
"apiSecretKey": "your_api_secret_key"
},
"errors": [
{
"propertyWithError": "orderId",
"propertyErrorMessages": [
"Error message 1",
"Error message 2"
]
},
{
"propertyWithError": "orderId",
"propertyErrorMessages": [
"Error message 1",
"Error message 2"
]
}
],
"isSuccess": false
}