Parcels

Parcel management operations

List parcels

get

Retrieve a paginated list of parcels with filtering and sorting options

Authorizations
AuthorizationstringRequired

Laravel Sanctum token authentication. Include the token in the Authorization header: Bearer {your-token}

Query parameters
pageinteger · min: 1Optional

Page number for pagination

Default: 1
limitinteger · enumOptional

Number of items per page

Default: 50Possible values:
sortstring · enumOptional

Field to sort by

Default: idPossible values:
orderstring · enumOptional

Sort order

Default: descPossible values:
searchstringOptional

Search term for parcels, contacts, or tracking IDs

Example: PRC#1234567
providers[]integer[]Optional

Filter by provider IDs

Example: [1,2,3]
codsstring · enumOptional

Filter by COD status

Default: allPossible values:
order_idintegerOptional

Filter by order ID

Example: 123
Responses
get
/v3/parcels

Create a new parcel

post

Create a new parcel with contact and shipping details

Authorizations
AuthorizationstringRequired

Laravel Sanctum token authentication. Include the token in the Authorization header: Bearer {your-token}

Body
service_idintegerRequired

Provider service ID

Example: 1
place_idinteger | nullableOptional

Provider place ID (required for some services)

Example: 5
custom_idstring | nullableOptional

Custom parcel identifier

Example: CUST-001
contact_idinteger | nullableOptional

Existing contact ID (alternative to contact details)

Example: 1
contact_first_namestring | nullableOptional

Contact first name

Example: John
contact_family_namestring | nullableOptional

Contact family name

Example: Doe
contact_phonestring | nullableOptional

Contact phone number

Example: +36123456789
contact_emailstring · email | nullableOptional

Contact email address

Example: [email protected]
contact_country_idinteger | nullableOptional

Contact country ID

Example: 1
contact_zipstring | nullableOptional

Contact postal code

Example: 1051
contact_citystring | nullableOptional

Contact city

Example: Budapest
contact_addressstring | nullableOptional

Contact address

Example: Váci utca 1
warehouse_idinteger | nullableOptional

Warehouse contact ID (alternative to warehouse details)

Example: 2
warehouse_zipstring | nullableOptional

Warehouse postal code

Example: 1051
warehouse_citystring | nullableOptional

Warehouse city

Example: Budapest
warehouse_addressstring | nullableOptional

Warehouse address

Example: Warehouse Street 1
warehouse_emailstring · email | nullableOptional

Warehouse email

Example: [email protected]
warehouse_phonestring | nullableOptional

Warehouse phone

Example: +36123456789
weightnumber · min: 0.1 · max: 40Required

Package weight in kg

Example: 2.5
sizestring · enumRequired

Package size category

Example: mPossible values:
codnumberRequired

Cash on delivery amount

Example: 15000
cod_currency_idintegerRequired

COD currency ID

Example: 1
insurancenumberRequired

Insurance amount

Example: 50000
insurance_currency_idintegerRequired

Insurance currency ID

Example: 1
is_fragilebooleanRequired

Whether package is fragile

Example: false
is_amorfbooleanRequired

Whether package is amorphous

Example: false
customer_notestring | nullableOptional

Customer note

Example: Handle with care
Responses
chevron-right
201

Parcel created successfully

application/json
post
/v3/parcels

Get parcel details

get

Retrieve detailed information about a specific parcel

Authorizations
AuthorizationstringRequired

Laravel Sanctum token authentication. Include the token in the Authorization header: Bearer {your-token}

Path parameters
idintegerRequired

Parcel ID

Example: 1000001
Responses
get
/v3/parcels/{id}

Update parcel

put

Update an existing parcel

Authorizations
AuthorizationstringRequired

Laravel Sanctum token authentication. Include the token in the Authorization header: Bearer {your-token}

Path parameters
idintegerRequired

Parcel ID

Example: 1000001
Body
service_idintegerRequired

Provider service ID

Example: 1
place_idinteger | nullableOptional

Provider place ID (required for some services)

Example: 5
custom_idstring | nullableOptional

Custom parcel identifier

Example: CUST-001
contact_idinteger | nullableOptional

Existing contact ID (alternative to contact details)

Example: 1
contact_first_namestring | nullableOptional

Contact first name

Example: John
contact_family_namestring | nullableOptional

Contact family name

Example: Doe
contact_phonestring | nullableOptional

Contact phone number

Example: +36123456789
contact_emailstring · email | nullableOptional

Contact email address

Example: [email protected]
contact_country_idinteger | nullableOptional

Contact country ID

Example: 1
contact_zipstring | nullableOptional

Contact postal code

Example: 1051
contact_citystring | nullableOptional

Contact city

Example: Budapest
contact_addressstring | nullableOptional

Contact address

Example: Váci utca 1
warehouse_idinteger | nullableOptional

Warehouse contact ID (alternative to warehouse details)

Example: 2
warehouse_zipstring | nullableOptional

Warehouse postal code

Example: 1051
warehouse_citystring | nullableOptional

Warehouse city

Example: Budapest
warehouse_addressstring | nullableOptional

Warehouse address

Example: Warehouse Street 1
warehouse_emailstring · email | nullableOptional

Warehouse email

Example: [email protected]
warehouse_phonestring | nullableOptional

Warehouse phone

Example: +36123456789
weightnumber · min: 0.1 · max: 40Required

Package weight in kg

Example: 2.5
sizestring · enumRequired

Package size category

Example: mPossible values:
codnumberRequired

Cash on delivery amount

Example: 15000
cod_currency_idintegerRequired

COD currency ID

Example: 1
insurancenumberRequired

Insurance amount

Example: 50000
insurance_currency_idintegerRequired

Insurance currency ID

Example: 1
is_fragilebooleanRequired

Whether package is fragile

Example: false
is_amorfbooleanRequired

Whether package is amorphous

Example: false
customer_notestring | nullableOptional

Customer note

Example: Handle with care
Responses
put
/v3/parcels/{id}

Delete parcel

delete

Delete a parcel

Authorizations
AuthorizationstringRequired

Laravel Sanctum token authentication. Include the token in the Authorization header: Bearer {your-token}

Path parameters
idintegerRequired

Parcel ID

Example: 1000001
Responses
delete
/v3/parcels/{id}

Calculate shipping price

get

Calculate shipping cost for a parcel configuration

Authorizations
AuthorizationstringRequired

Laravel Sanctum token authentication. Include the token in the Authorization header: Bearer {your-token}

Query parameters
weightnumber · min: 0.1Required

Package weight in kg

Example: 2.5
service_idintegerRequired

Provider service ID

Example: 1
warehouse_idintegerRequired

Warehouse contact ID

Example: 2
contact_countryintegerRequired

Destination country ID

Example: 1
codnumberRequired

Cash on delivery amount

Example: 15000
cod_currencyintegerRequired

COD currency ID

Example: 1
insurancenumberRequired

Insurance amount

Example: 50000
insurance_currencyintegerRequired

Insurance currency ID

Example: 1
extra_services[]boolean[]Required

Extra services configuration

Example: [false,true,false]
Responses
get
/v3/calculate-price

Last updated