Standard API Calls

  Other

URL

Each instance of the CurierManager app has its own base URL. The generic api url is:

BaseURL?Main?api_key=<api key>&…

For example, if the CurierManager instance is at http://app.curiermanager.ro/cscourier/

Then the API URL to create an AWB will be:

http://app.curiermanager.ro/cscourier/Main?api_key=<api_key>&API_createAWB=true&…

The API Key can be created by the courier company. Note: the client using the api key needs to have a working user.

 

Create AWB

BaseURL?Main?api_key=<api key>&API_createAWB=true

The following fields can be added:

“type”, “service_type”, “retur”, “retur_type”, “ramburs”, “ramburs_type”, “insurance”, “weight”, “content”, “comments”, “pick_ship”, “pick_return”, “cnt”,

“from_name”, “from_contact”, “from_str”, “from_nr”, “from_bl”, “from_sc”, “from_et”, “from_ap”, “from_interfon”, “from_sector”, “from_city”, “from_county”, “from_country”, “from_phone”,

“to_name”, “to_contact”, “to_str”, “to_nr”, “to_bl”, “to_sc”, “to_et”, “to_ap”, “to_interfon”, “to_sector”, “to_city”, “to_county”, “to_country”, “to_zipcode”, “to_phone”, “to_extra”

 

type: plic | colet

service_type: obtain from courier company

retur: 0 | 1

cnt: number of packages/envelopes

retur_type: colet | document ramburs: <amount ramburs> ramburs_type: cont | cash weight: <wight in kg>

from_name: <receiver name, company name if applicable> from_contact: <contact within receiver company>

 

Any number of extra services (like “Delivery Saturday”) can be specified, each by adding a parameter like service_<service id> with the value true. For example if Delivery Saturday has the id 57, you would have: service_57=true

 

The full list of available services can be obtained through the API using the URL:

BaseURL?Main?api_key=<api key>&API_listServices=true

 

The Create AWB API call returns one string, containing the number of the created AWB.

 

The status for the created AWB will be “in_curs” or “neridicat”, depending on the default setting the courier company is using.

awb_event_handler

awb_event_handler is an optional parameter which can be used when creating the awb. It contains an URL towards which the system will send event call – POST requests containing a JSON map with the following fields:

  • awb – awb number
  • status – awb status

 

Right now there are only status-changed events, but this may change in the future.

Events are being sent asynchronously, with a delay of max 60s.

 

Finding out an expedition price

 

BaseURL?Main?api_key=<api key>&API_getPrice=true

 

Works by creating and immediately deleting an awb. Takes the same fields as API_createAWB, and returns a single number – the price of the expedition.

 

Printing an AWB

 

BaseURL/Main?api_key=<apikey>& API_printAWB=true &awbno=<awbno>

If you want to save the awb in a pdf format add &pdf=true to the previous link, as shown in the following example:

BaseURL/Main?api_key=<apikey>& API_printAWB=true&pdf=true&awbno=<awbno>

 

Get AWB status:

 

BaseURL/Main?api_key=<apikey>&API_getStatus=true&awbno=<awbno>

 

Get AWB info:

 

BaseURL/Main?api_key=<apikey>&API_getAWBInfo=true&awbno=<awbno>

 

Returns a JSON map, consisting of:

  • text fields with awb info (“id”, “no”, “status”, “from_address”, “to_address”, “from_city”, “to_city”, “from_country”, “to_country”, “ramburs”, “ramburs_type”)
  • “invoice”, which contains a map with invoice info (date as unixtime, series, no, value – invoice value without VAT)
  • “decont_client”, which contains a map with decont info: date as unixtime, transaction_no, value

 

Cancel an AWB:

 

BaseURL/Main?api_key=<apikey>&API_cancelAWB=true&awbno=<awbno>

 

The life-cycle of an AWB

 

An AWB can have one of the following statuses:

  • initial (not ready) – the awb can still be edited by the client. It is not ready for pick-up
  • neridicat (ready-for-pickyup) – the awb is ready and waiting for pickup
  • in_curs (in transit) being delivered
  • livrat (delivered) the awb has been delivered successfully
  • returnat (returned) the awb has been returned for some reason
  • anulat (canceled) the awb has been canceled before pickup
  • exceptie (exception) anything else