Skip to main content

Export orders to file

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

Export orders matching the filter criteria to a file.

Returns a base64-encoded file (typically CSV or Excel) containing order details.

Filtering​

Use the same filter parameters as GET /orders to select which orders to export.

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​

NameTypeRequiredDescription
projectsarrayFilter by project IDs (array)
order_statusesarrayFilter by order statuses (array)
receiver_country_codestringFilter by receiver country (ISO 3166-1 alpha-2)
receiver_name_partstringPartial match for receiver name
receiver_phone_partstringPartial match for receiver phone
receiver_street_partstringPartial match for receiver street
created_date_fromstringStart date (required unless using number/tracking filters)
created_date_tillstringEnd date (required unless using number/tracking filters)
numberstringExact match for order number (comma-separated list)
number_partialstringPartial match for order number
tracking_codestringFilter by tracking code
shipping_gateway_codestringFilter by gateway code
with_manifestbooleanFilter by manifest existence
with_labelbooleanFilter by label existence
eshop_order_idstringFilter by e-shop order ID
test_modebooleanFilter test mode orders
limitintegerMaximum number of results
offsetintegerNumber of results to skip
order_bystringSort field
order_directionstringSort direction
afterstringCursor for pagination
beforestringCursor for pagination

Example​

Request​

GET https://delivery-api.paysera.com/rest/v1/orders-export?projects=value&order_statuses=value&receiver_country_code=value&receiver_name_part=value&receiver_phone_part=value&receiver_street_part=value&created_date_from=value&created_date_till=value&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 (required unless using number/tracking filters)
created_date_till
End date (required unless using number/tracking filters)
number
Exact match for order number (comma-separated list)
number_partial
Partial match for order number
tracking_code
Filter by tracking code
shipping_gateway_code
Filter by 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
before
Cursor for pagination

RESPONSE

Export file generated successfully
{}