Request Parameters

Complete reference guide for all parameters used in Paysera Delivery API requests.

Service Availability

Delivery API operates only in Lithuania (LT), Latvia (LV), and Estonia (EE). Use these country codes in your requests.

Top-Level Parameters

Parameter	Type	Required	Default	Description
project_id	string	Conditional	—	Unique project HASH. Required in some methods.
sender_id	string	No	—	Distinctive identifier for the sender
sender	object	No	—	Contains sender information including contacts and addresses
receiver_id	string	No	—	Distinctive identifier for the receiver
receiver	object	No	—	Contains receiver information including contacts and addresses
limit	integer	No	20	Number of items to retrieve
offset	integer	No	—	Used for paginating results
order_by	string	No	id	Field designation for sorting
order_direction	string	No	—	Sort direction: asc or desc
after	string	No	—	Date filter for items created after a specific date
before	string	No	—	Date filter for items created before a specific date
from_country_code	string	No	—	ISO format country code for shipment origin
to_country_code	string	No	—	ISO format country code for destination
shipments	array	No	—	Collection of shipment details
shipment_method_code	string	No	—	Identifier for specific shipping method or carrier
shipment_gateway_code	string	No	—	Associated shipment gateway code
city	string	No	—	City identifier (example: Vilnius)
country	string	No	—	ISO format country code
name	string	No	—	Post office designation
eshop_order_id	string	No	—	Unique identifier associated with a specific order in the e-shop system

Example Usage

{
  "project_id": "abc123xyz",
  "from_country_code": "LT",
  "to_country_code": "LV",
  "limit": 50,
  "offset": 0,
  "order_by": "created_at",
  "order_direction": "desc"
}

Shipment Object

Nested within the shipments array. All dimensions are required.

Parameter	Type	Required	Description
weight	integer	Yes	The weight of the package in grams
width	integer	Yes	The width of the package in millimeters
length	integer	Yes	The length of the package in millimeters
height	integer	Yes	The height of the package in millimeters

Example

{
  "shipments": [
    {
      "weight": 1500,
      "width": 300,
      "length": 400,
      "height": 200
    }
  ]
}

Measurement Units

• Weight: Always in grams (g)
• Dimensions: Always in millimeters (mm)

ShipmentPoint Parameters

Used for both sender and receiver objects.

Parameter	Type	Required	Description
type	string	Yes	Must be "sender" or "receiver"
saved	boolean	Yes	Indicates whether the contact persists for future usage
contact	object	Yes	Object representing the contact details for the ShipmentPoint
default_contact	boolean	No	Whether shipment point is default contact
post_office_id	string	No	Post office identifier
parcel_machine_id	string	No	Parcel machine identifier

Example

{
  "sender": {
    "type": "sender",
    "saved": true,
    "contact": {
      "party": { ... },
      "address": { ... }
    },
    "default_contact": true
  }
}

Contact Object

Nested within sender or receiver objects. Contains party and address sub-objects.

Party Object

Contact party information.

Parameter	Type	Required	Description
title	string	Yes	Required string representing the full name of the contact party
company_code	string	No	Company identifier if applicable
email	string	No	Email address if available
phone	string	No	Mobile phone numbers only; landline numbers are rejected

Phone Number Format

Only mobile phone numbers are accepted. Landline numbers will be rejected by the API.

Format examples:

• ✅ +37060000001 (valid)
• ✅ +37065000000 (valid)
• ❌ +37052000000 (landline - rejected)

Address Object

Physical address information.

Parameter	Type	Required	Description
country	string	Yes	Required string representing the country code in ISO format (e.g., LT)
state	string	No	State designation if applicable
municipality	string	No	Municipality designation if applicable
street	string	No	Street designation if applicable
house_number	string	No	House number if applicable
apartment_number	string	No	Apartment number if applicable
postal_code	string	No	Postal code if applicable

Complete Contact Example

{
  "contact": {
    "party": {
      "title": "John Doe",
      "company_code": "123456789",
      "email": "john.doe@example.com",
      "phone": "+37060000001"
    },
    "address": {
      "country": "LT",
      "state": "Vilnius County",
      "municipality": "Vilnius",
      "street": "Gedimino Ave.",
      "house_number": "1",
      "apartment_number": "5A",
      "postal_code": "01103"
    }
  }
}

Document Parameters

Used when uploading or managing documents related to shipments.

Parameter	Type	Required	Description
content	string	Yes	Contact information, including receiver's name, company code, email address, phone number
mime_type	string	No	Content MIME type (example: text/plain, application/pdf)
size	integer	No	Content size in bytes

Example

{
  "content": "Base64EncodedContentHere...",
  "mime_type": "application/pdf",
  "size": 204800
}

Order Status Parameters

Contains detailed information about delivery orders.

Parameter	Type	Required	Description
order_statuses	array	Yes	Array of objects containing detailed information about delivery orders

Example

{
  "order_statuses": [
    {
      "status": "in_transit",
      "timestamp": "2025-11-26T10:30:00Z",
      "location": "Vilnius Distribution Center"
    },
    {
      "status": "delivered",
      "timestamp": "2025-11-26T15:45:00Z",
      "location": "Kaunas - Customer Address"
    }
  ]
}

Complete Request Example

Here's a complete example showing how parameters work together:

{
  "project_id": "abc123xyz",
  "eshop_order_id": "ORDER-2025-001",
  "shipment_gateway_code": "dpd",
  "shipment_method_code": "standard",
  "shipments": [
    {
      "weight": 2500,
      "width": 350,
      "length": 450,
      "height": 250
    }
  ],
  "sender": {
    "type": "sender",
    "saved": true,
    "default_contact": true,
    "contact": {
      "party": {
        "title": "My E-Shop",
        "company_code": "987654321",
        "email": "warehouse@myshop.com",
        "phone": "+37060000001"
      },
      "address": {
        "country": "LT",
        "city": "Vilnius",
        "street": "Warehouse Street",
        "house_number": "5",
        "postal_code": "01001"
      }
    }
  },
  "receiver": {
    "type": "receiver",
    "saved": false,
    "contact": {
      "party": {
        "title": "Jane Smith",
        "email": "jane.smith@example.com",
        "phone": "+37065000000"
      },
      "address": {
        "country": "LT",
        "city": "Kaunas",
        "street": "Customer Avenue",
        "house_number": "15",
        "apartment_number": "3B",
        "postal_code": "44001"
      }
    }
  },
  "notes": "Fragile - Handle with care"
}

Pagination Parameters

When working with list endpoints that return multiple items:

{
  "limit": 50,
  "offset": 100,
  "order_by": "created_at",
  "order_direction": "desc",
  "after": "2025-11-01T00:00:00Z",
  "before": "2025-11-30T23:59:59Z"
}

This will:

• Return 50 items
• Skip the first 100 items
• Sort by creation date in descending order
• Filter items created in November 2025

Country Codes

Use ISO 3166-1 alpha-2 country codes. The Delivery API currently supports:

Country	Code	Status
Lithuania	LT	✅ Supported
Latvia	LV	✅ Supported
Estonia	EE	✅ Supported

Supported Countries Only

The Delivery API is available exclusively for shipments within and between Lithuania, Latvia, and Estonia. Other country codes will not be accepted.

Validation Rules

Required Field Combinations

Some parameter combinations are required depending on the operation:

Creating an order requires:

• Either sender_id OR complete sender object
• Either receiver_id OR complete receiver object
• shipments array with at least one shipment
• project_id

Querying gateways requires:

• from_country_code
• to_country_code
• shipments (to determine available options)

Data Type Validation

• Integers: Must be positive whole numbers
• Strings: UTF-8 encoded
• Country codes: Must be valid ISO 3166-1 alpha-2 codes
• Email: Must be valid email format
• Phone: Must be valid mobile number in international format

Next Steps

• Integration with Library - PHP library usage
• API Fundamentals - Request/response formats
• Examples - Code examples with parameters
• Endpoints - API endpoint reference

Support

Need help with complex integrations?

Contact: tech_support@paysera.com