Generate AWBs, place shipment orders
| Authorization required | string <Bearer> Api token pleaced into the header to allow access to the api service |
| courier_id | integer The selected courier |
| order_id | string The order identifier |
| order_total | number Order total value |
| order_total_currency_code | string Order currency code (eg. RON, EUR, USD etc.) |
object The AWB details |
{- "courier_id": 0,
- "order_id": "string",
- "order_total": 0,
- "order_total_currency_code": "string",
- "awb_details": {
- "recipient_name": "string",
- "recipient_contact_person": "string",
- "contact_person": "string",
- "phone": "string",
- "fax": "string",
- "email": "string",
- "county": "string",
- "destintatiom_county": "string",
- "destintatiom_locality": "string",
- "street": "string",
- "number": "string",
- "postal_code": "string",
- "block_building": "string",
- "enterance": "string",
- "floor": "string",
- "flat": "string",
- "no_of_envelopes": "string",
- "no_of_parcels": "string",
- "payment_of_shipment": "string",
- "reimbursement": 0,
- "bank_reimbursement": 0,
- "country": "string",
- "reimbursement_transport_payment": "string",
- "declared_value": 0,
- "bank": "string",
- "iban": "string",
- "weight": 0,
- "length": 0,
- "height": 0,
- "packing": "string",
- "personal_data": "string",
- "options": "string",
- "service": {
- "label": "string",
- "value": 0
}, - "other_details": {
- "cash_on_delivery": 0,
- "confirmation": 0,
- "exchange_pack": 0,
- "locker_id": 0,
- "notes": "string",
- "package_type": 0,
- "parcels": [
- {
- "height": 0,
- "length": 0,
- "weight": 0,
- "width": 0
}
], - "third_party_pickup": 0,
- "third_party": {
- "address": "string",
- "city": "string",
- "county": "string",
- "name": "string",
- "phoneNumber": "string",
- "postalCode": "string",
- "personType": {
- "label": "string",
- "value": 0
}, - "companyName": "string",
- "companyBank": "string",
- "companyCui": "string",
- "companyIban": "string",
- "companyOnrcNumber": 0
}, - "client_reference": "string",
- "cod_reference": "string",
- "content": "string",
- "recipient_country_iso_code": "string",
- "open_package": 0,
- "pickup_point": {
- "id": 0,
- "name": "string",
- "postalCode": 0,
- "city": "string",
- "street": "string",
- "blockApartment": "string",
- "houseNo": "string",
- "phone": "string",
- "email": "string"
}
}
}
}{- "status": "string",
- "message": "string",
- "data": {
- "awb_number": "string",
- "status_id": 0,
- "status_description": "string",
- "other_details": { }
}
}Get cost estimation
| Authorization required | string <Bearer> Api token pleaced into the header to allow access to the api service |
| courier_id | integer The selected courier |
| service | string The selected service |
| destination_locality | string The destination locality |
| destination_county | string The destination county |
| envelopes | number Number of envelopes |
| parcels | number Number of parces |
| payment_of_shipment | string Who pays for the shipment (sender / receiver) |
| length | string Lenght |
| width | string Width |
| height | string Heigh |
| declared_value | string Shipment delcared value |
| payment_for_reimbursment | string Who pays for reimbursement |
| options | string Aditonal options depending on the courier service |
| reimbursement | string Reimbursement value |
| other_details | object Other details that the courier accepts (properties that can be sent directly to the courier) |
{- "courier_id": 0,
- "service": "string",
- "destination_locality": "string",
- "destination_county": "string",
- "envelopes": 0,
- "parcels": 0,
- "payment_of_shipment": "string",
- "length": "string",
- "width": "string",
- "height": "string",
- "declared_value": "string",
- "payment_for_reimbursment": "string",
- "options": "string",
- "reimbursement": "string",
- "other_details": { }
}{- "status": "string",
- "message": "string",
- "data": {
- "value": 0,
- "other_details": { }
}
}Get last AWB status
| Authorization required | string <Bearer> Api token pleaced into the header to allow access to the api service |
| courier_id | integer The selected courier |
| awb | string The awb number |
{- "courier_id": 0,
- "awb": "string"
}{- "status": "string",
- "message": "string",
- "data": {
- "status_id": 0,
- "status_description": "string"
}
}Delete the awb order
| Authorization required | string <Bearer> Api token pleaced into the header to allow access to the api service |
| courier_id | integer The selected courier |
| awb | string The awb number |
{- "courier_id": 0,
- "awb": "string"
}{- "status": "string",
- "message": "string",
- "data": "string"
}Get the AWB label
| Authorization required | string <Bearer> Api token pleaced into the header to allow access to the api service |
| courier_id | integer The selected courier |
| awb | string The awb number |
| html | integer Enum: 0 1 The html |
{- "courier_id": 0,
- "awb": "string",
- "html": 0
}{- "status": "string",
- "message": "string",
- "data": {
- "pdf": "string",
- "html": "string"
}
}Get full list of localities
| Authorization required | string <Bearer> Api token pleaced into the header to allow access to the api service |
| api_key | string The api key |
| api_secret | string The api secret |
| courier_id | integer The selected courier |
{- "api_key": "string",
- "api_secret": "string",
- "courier_id": 0
}{- "id": 0,
- "county": "string",
- "city": "string",
- "agency": "string",
- "km": 0
}Get the geolocation for postal code
| Authorization required | string <Bearer> Api token pleaced into the header to allow access to the api service |
| courier_id | integer The selected courier |
| postal_code | string The postal code |
{- "courier_id": 0,
- "postal_code": "string"
}{- "id": 0,
- "county": "string",
- "city": "string",
- "street": "string",
- "from": "string",
- "to": "string",
- "postal_code": "string",
- "agency": "string"
}Get all geolocations for importing using the platform plug
| Authorization required | string <Bearer> Api token pleaced into the header to allow access to the api service |
| courier_id | integer The selected courier |
{- "courier_id": 0
}[- {
- "country_code": "string",
- "county": "string",
- "city": "string",
- "street": "string",
- "postal_code": "string"
}
]Get the services supported by the courier
| Authorization required | string <Bearer> Api token pleaced into the header to allow access to the api service |
| courier_id | integer The selected courier |
{- "courier_id": 0
}{- "id": 0,
- "name": "string"
}Generate token for the subscription
| id | integer The user id |
| subscription_id | integer The subscription id |
{- "id": 0,
- "subscription_id": 0
}{- "status": "string",
- "message": "string",
- "data": {
- "token": "string"
}
}Validates token and registers the domain
| token | string The subscription token |
{- "token": "string"
}{- "status": "string",
- "message": "string",
- "data": { }
}Checks if token is connected to domain
| token | string The subscription token |
{- "token": "string"
}{- "status": "string",
- "message": "string",
- "data": { }
}Disconnects domain from token
| token | string The subscription token |
{- "token": "string"
}{- "status": "string",
- "message": "string",
- "data": { }
}