Integration parameters
Integration Parameters
Parameter
Type
Required
Description
project_id
string
No
Unique project HASH. In some methods, it is required.
sender_id
string
No
Unique identifiers for the sender.
sender
object
No
This parameter is necessary to create a Sender_ID; it stores all important information such as contacts and addresses.
receiver_id
string
No
Unique identifiers for the sender.
receiver
object
No
This parameter is necessary to create a Receiver_ID; it stores all important information such as contacts and addresses.
limit
integer
No
Number of items to retrieve. By default value = 20.
offset
integer
No
Offset for paginating results.
order_by
string
No
Field to order by. By default value = id.
order_direction
sorting
No
Order 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
The country code representing the origin of the shipment. Country code in ISO format (i. e. LT,LV)
to_country_code
string
No
The country code representing the origin of the shipment. Country code in ISO format (i. e. LT,LV)
shipments
array
No
An array containing shipment details such as weight, width, length, and height.
weight
integer
Yes
The weight of the package in grams.
width
integer
Yes
The dimensions of the package in millimeters.
length
integer
Yes
The dimensions of the package in millimeters.
height
integer
Yes
The dimensions of the package in millimeters.
shipment_method_code
string
No
variable that holds the identifier for a specific shipping method or carrier, enabling accurate processing and handling of shipments in a logistics or e-commerce system.
city
string
No
Identifiers of a city in a system,(i. e. Vilnius) in the context of a specific location.
country
string
No
Parameter is a required string representing the country code in ISO format (e.g., "LT") within the context of the ShipmentPoint's contact address.
shipment_gateway_code
string
No
Code of the associated shipment gateway.
name
string
No
Name of the Post Office.
content
string
Yes
Parameter contains contact information, including the receiver's name, company code, email address, and phone number.
mime_type
string
No
Parameter indicates the content's MIME type, like "text/plain".
size
integer
No
Parameter denotes the content size and is represented as an integer.
type
integer
Yes
Is a required field, and it should be one of the values "sender" or "receiver".
saved
boolean
Yes
Parameter is a required boolean indicating whether the contract is saved for later usage.
contact
object
Yes
Parameter is an object representing the contact details for the ShipmentPoint.
party
object
Yes
Parameter is a required object representing the contact party within the context of the ShipmentPoint.
title
string
Yes
Parameter is a required string representing the full name of the contact party within the context of the ShipmentPoint.
company_code
string
No
Parameter is a string representing the company code, if applicable, within the context of the ShipmentPoint's contact party.
email
string
No
Parameter is a string representing the email address, if available, within the context of the ShipmentPoint's contact party.
phone
string
No
Parameter is a string representing the phone number, if available, within the context of the ShipmentPoint's contact party.
address
object
Yes
Parameter is a required object representing the contact address within the context of the ShipmentPoint.
country
string
Yes
Parameter is a required string representing the country code in ISO format (e.g., "LT") within the context of the ShipmentPoint's contact address.
state
string
No
Parameter is a string representing the state, if applicable, within the context of the ShipmentPoint's contact address.
municipality
string
No
parameter is a string representing the municipality, if applicable, within the context of the ShipmentPoint's contact address.
street
string
No
Parameter is a string representing the street name, if applicable, within the context of the ShipmentPoint's contact address.
house_number
string
No
Parameter is a string representing the house number, if applicable, within the context of the ShipmentPoint's contact address.
apartment_number
string
No
Parameter is a string representing the apartment number, if applicable, within the context of the ShipmentPoint's contact address.
postal_code
string
No
Parameter is a string representing the postal code, if applicable, within the context of the ShipmentPoint's contact address.
post_office_id
string
No
Parameter is a string representing the identifier associated with a post office within.
parcel_machine_id
string
No
Parameter is a string representing the identifier associated with a parcel machine within.
default_contact
boolean
No
Parameter is a required boolean indicating whether the shipment point is set as the default contact for the project.
order_statuses
array
Yes
Parameter is an array of objects containing detailed information about delivery orders.
eshop_order_id
string
No
It is a unique identifier associated with a specific order in the e-shop system.