List delivery orders

GET https://delivery-api.paysera.com/rest/v1/orders

Retrieve a list of delivery orders with extensive filtering options.

Date Filtering

Either provide date range (created_date_from and created_date_till) OR use specific filters like number, tracking_code, or eshop_order_id.

Pagination

Results are paginated. Use limit, offset, and cursor parameters for navigation.

Authorization

This endpoint requires MAC (Message Authentication Code) authentication.

Authorization Header Format:

Authorization: MAC id="YOUR_PROJECT_ID",ts="1234567890",nonce="xyz123",mac="GENERATED_MAC_HASH"

Example:

Authorization: MAC id="a9b8c7d6e5f4g3h2", ts="1234567890", nonce="xyz123abc456def", mac="dGhpcyBpcyBhIHJhbmRvbSBtYWMgaGFzaCB2YWx1ZQ==", ext="body_hash=cmFuZG9tQm9keUhhc2hWYWx1ZQ%3D%3D"

For more details, please refer to the Authentication section.

Parameters

Query Parameters

Name	Type	Required	Description
projects	array		Filter by project IDs (array)
order_statuses	array		Filter by order statuses (array)
receiver_country_code	string		Filter by receiver country (ISO 3166-1 alpha-2)
receiver_name_part	string		Partial match for receiver name
receiver_phone_part	string		Partial match for receiver phone
receiver_street_part	string		Partial match for receiver street
created_date_from	string		Start date for order creation (required unless using number/tracking filters)
created_date_till	string		End date for order creation (required unless using number/tracking filters)
number	string		Exact match for delivery order number (supports comma-separated list)
number_partial	string		Partial match for delivery order number
tracking_code	string		Filter by tracking code
shipping_gateway_code	string		Filter by shipping gateway code
with_manifest	boolean		Filter by manifest existence
with_label	boolean		Filter by label existence
eshop_order_id	string		Filter by e-shop order ID
test_mode	boolean		Filter test mode orders
limit	integer		Maximum number of results
offset	integer		Number of results to skip
order_by	string		Sort field
order_direction	string		Sort direction
after	string		Cursor for pagination (after)
before	string		Cursor for pagination (before)

Example

Request

GET https://delivery-api.paysera.com/rest/v1/orders?projects=value&order_statuses=value&receiver_country_code=value&receiver_name_part=value&receiver_phone_part=value&receiver_street_part=value&created_date_from=2024-01-01&created_date_till=2024-12-31&number=D323232323230,D323232323231&number_partial=value&tracking_code=value&shipping_gateway_code=value&with_manifest=value&with_label=value&eshop_order_id=value&test_mode=value&limit=value&offset=value&order_by=value&order_direction=value&after=value&before=value
Authorization: MAC id="CLIENT_ID", ts="TIMESTAMP", nonce="RANDOM_STRING", mac="MAC_HASH"

Response

{}

AUTHORIZATION: HTTP

REQUEST

Base URL

https://delivery-api.paysera.com

Query Parameters

projects

Filter by project IDs (array)

order_statuses

Filter by order statuses (array)

receiver_country_code

Filter by receiver country (ISO 3166-1 alpha-2)

receiver_name_part

Partial match for receiver name

receiver_phone_part

Partial match for receiver phone

receiver_street_part

Partial match for receiver street

created_date_from

Start date for order creation (required unless using number/tracking filters)

created_date_till

End date for order creation (required unless using number/tracking filters)

number

Exact match for delivery order number (supports comma-separated list)

number_partial

Partial match for delivery order number

tracking_code

Filter by tracking code

shipping_gateway_code

Filter by shipping gateway code

with_manifest

Filter by manifest existence

with_label

Filter by label existence

eshop_order_id

Filter by e-shop order ID

test_mode

Filter test mode orders

limit

Maximum number of results

offset

Number of results to skip

order_by

Sort field

order_direction

Sort direction

after

Cursor for pagination (after)

before

Cursor for pagination (before)

RESPONSE

Orders retrieved successfully

{}