Contents

Get Order IDs

POST /v1/order/search

The request allows you to get a list of order identifiers that match the search criteria provided.

This request can also be used to get a list of order identifiers via Softline Payments

content-type
string
required
MIME-type

It must be equal to "application/json".
AuthorizationJWT
required
Authorization token
  • Format: Bearer [token]
  • Replace [token] with the token value you get in response to the request sent to the Authentication API
status
string
Order status

Value options:
  • not paid
  • paid
  • deleted
More details on order statuses.
external_id
string
Checkout page identifier
It is used if an order for a product with dynamic characteristics has been placed. You receive this identifier in response to the request used for generating a buy link to purchase a product with dynamic characteristics (buy_link).

(For payments in Softline Payments) Payment identifiers on your end
create_date_from
string
Period start date when order was created
The system finds the orders that meet the following condition: [date and time of order creation] ≥ [create_date_from].

Format: YYYY-MM-DDThh:mm:ss±hh:mm.
create_date_to
string
Period end date when order was created
The system finds the orders that meet the following condition: [date and time of order creation] ≤ [create_date_to].

Format: YYYY-MM-DDThh:mm:ss±hh:mm.
pay_date_from
string
Period start date when order was paid for
The system finds the orders that meet the following condition: [date and time of successful order payment] ≥ [pay_date_from].

Format: YYYY-MM-DDThh:mm:ss±hh:mm.
pay_date_to
string
Period end date when order was paid
The system finds the orders that meet the following condition: [date and time of order paid] ≤ [pay_date_to].

Format: YYYY-MM-DDThh:mm:ss±hh:mm.
currency
string
Currency code of order
  • Format: ISO 4217 alpha-3, 3 characters
  • For the value options, see the reference guide
email
string
Customer's email
payment_method
string
Payment method code
For the value options, see the reference guide
limit
number
Quantity of orders to be returned in response
If the parameter is not transferred, the default value of order quantity returns in response. Please contact our support team if you require to change this value.
offset
number
Offset: by how many orders you want to shift result outputting
  • If not transferred or equal to 0, you will get the list that starts from the 1st order found
  • For example, if 10 is transferred, you will get the list that starts from the 11th order found
{
  "status": "not paid",
  "external_id": "12345",
  "create_date_from": "2022-01-01T00:00:00+00:00",
  "create_date_to": "2022-01-31T00:00:00+00:00",
  "pay_date_from": "2022-01-01T00:00:00+00:00",
  "pay_date_to": "2022-01-31T00:00:00+00:00",
  "currency": "EUR",
  "email": "customer@mail.com",
  "payment_method": "CreditCard",
  "limit": 100,
  "offset": 10
}
{}

In response to the request, you receive the server response code corresponding to the processing result. Depending on the code, the response body may contain additional parameters.

If processing is successful, the following will return in response server response code: HTTP/1.1 200 OК. Response body: list of found order IDs in JSON format.

count_all
number
required
Number of orders found
limit
number
Order quantity in response
offset
number
Offset
Starting order position followed by orderss that return in response.
ids
array [numbers]
Array of order IDs
The array may return empty if no products are found, e.g.:
  • No orders created
  • Offset (offset) is greater than available order quantity (count_all)
{
  "count_all": 155,
  "limit": 5,
  "offset": 5,
  "ids": [
    11111111,
    22222222,
    33333333
  ]
}

If an error occurs while processing the request, you receive a server response code corresponding to the result of processing. 
Depending on the code, the response body may contain additional parameters.

HTTP code Description
HTTP/1.1 400 Bad Request The request is not valid (error in parameters; necessary data is not transferred, etc.).
An additional error code (one or more) will be transferred in the response bodу.
HTTP/1.1 401 Unauthorized Unsuccessful authorization.
An additional error code (one or more) will be transferred in the response bodу.
HTTP/1.1 404 Not found Invalid request URL.
HTTP/1.1 500 Request Error Internal Server Error. Please try again later or contact support.
Error Message Description
If at least one error from the list below is found, then it returns in response to a request, other errors are not validated.
110 JSON is not valid. The request cannot be processed. Request field structure is not valid. Check the fields in the request body against the JSON format.
111 Invalid data format (Content-type). The request cannot be processed. Invalid request header. Content-type must be equal to application/json.
15000 Unable to identify your configuration for accessing this API. Please contact technical support. During processing, we could not identify your account setting unambiguously. Please contact support team.
If at least one error from the list below is found, then request validation is not interrupted. Several errors may return in response.
15010 Invalid field value: [parameter name] The request is not valid, e.g., the parameter name is incorrect, the parameter value does not match with the data type provided, or the value format is incorrect. Moreover, the error will return if null is transferred in the parameter, and this value option is not set as valid in the parameter description.

The errors are the same for all the APIs that use token authorization.

errors
array [objects]
required
Error list
errors / [error object]
/
error
number
required
Error code
errors / [error object]
/
message
string
Error description
{
  "errors": [{
      "error": 15010,
      "message": "Invalid field value: email"
    }
  ]
}