more


The Gcouriers application can be called through the API, so that any site such as Online Store, Sales Site, home delivery application, etc. can integrate the fast courier services (deliveries in 1-2 hours, As soon as possible - ASAP) or Next Days (Postal service through established fast couriers) that Gcouriers offers.

It is recommended that the integration be at the / admin level of the applications / sites, so that the courier is requested only when the site administrators have the package already ready for delivery. Basically, at the check-out level, you can only display an estimated average cost, and in / admin you will find the real quotation that the couriers offer through the auction.

Also, a fixed cost can be contracted within a city / county, and a fixed cost for deliveries ASAP to the store's customers is also displayed.

Through Gcouriers, immediate deliveries can be made, and the connection parameters are presented below, as follows:

We define the following constants:
Constants Stock Description
API_URL https://www.gcouriers.com/apiMagazine Gcouriers platform url
ASAP_SHIPPING_TYPE ASAP This type will be sent if the shipment is wanted on the same day
POSTAL_SHIPPING_TYPE POSTAL_SERVICE This type will be sent if you want to ship it in 1-3 days by Consecrated Couriers


An API call will be made in the form of a POST request to a URL in the form

API_URL/action

Ex: https://www.gcouriers.com/apiMagazine/getCostEstimat

Each call to the Gcouriers API must contain the following variables:

Variabila Type Description
apiKey STRING Your Gcouriers account key
orderId INTEGER Unique command id


Available requests:
Action URL Description
getCostEstimate API_URL/getCostEstimat Get an estimated cost without creating a shipment
sendExpedition API_URL/sendExpedition Save or update a shipment, return the estimated cost and distance between addresses
searchCouriers API_URL/searchCouriers Search for couriers for a shipment, if it is of type POSTAL_SHIPPING_TYPE it will return the list of available couriers
getCouriersList API_URL/getCouriersList Get the list of couriers who applied for the shipment
selectCourier API_URL/selectCourier Choose the courier who will deliver the shipment
getExpeditionStatus API_URL/getExpeditionStatus Get shipping status
getAwb API_URL/getAwb Get the awb of the expedition in pdf format


Except for getAWB, all requests will return a JSON

1. getEstimatedCost


Returns the estimated cost of the shipment without saving the shipment


Extra data required:

Variable Type Description
AddressSender ARRAY Sender data, for details see 1.a.
AddressReceiver ARRAY Recipient data, for details see 1.a
weight INTEGER Total weight of the package
envelopes* INTEGER Total number of envelopes
packages* INTEGER Total number of packages
size ARRAY Package size data, see 1.b
type STRING Only accepted:
ASAP_SHIPPING_TYPE
Or
POSTAL_SHIPPING_TYPE

*Please note that an expedition must contain at least one envelope or package


1.a Address

Variables Type Description
country STRING Country
county STRING County
local STRING Local
the street STRING The street
no. STRING Street number


1.b Dimension

Variables Type Description
length STRING The length of the package
width STRING The width of the package
height STRING The height of the package


Response:

Variables Type Condition Description
error INTEGER Always appears 0 - no errors
1 - there are errors
messages ARRAY Error = 1 List of error messages
estimatedCost DOUBLE Error = 0 Estimated cost


2.sendExpedition


We send the order data to create a shipment. If there is an already associated shipment already orderId the data will be updated. Please note that the shipment may be updated as long as a courier has not been selected or has been canceled, also the type of shipment cannot be changed.


Extra data required:

Variables Type Description
Sender ARRAY Sender data, for details see 2.a
Receiver ARRAY Receiver data, for details see 2.a
Weight INTEGER Total weight of the package
envelopes* INTEGER Total number of envelopes
packages* INTEGER Total number of packages
size ARRAY For package dimensions, see 2.b
remarks STRING Remarks on the expedition
type STRING Only accepted:
ASAP_SHIPPING_TYPE
Or
POSTAL_SHIPPING_TYPE

*Please note that an expedition must contain at least one envelope or package


2.a Contact Data (sender / recipient)

Variables Type Description
name STRING Name of sender / receiver
e-mail STRING Email Address
phone STRING Phone number to be able to contact the sender / recipient
address STRING See address 2.a.1


2.a.1 Address

Variables Type Description
country STRING Country
county STRING County
local STRING Local
street STRING Street
no. INTEGER No.
details STRING Details


2.b Dimension

Variables Type Description
length INTEGER The length of the package
width INTEGER The width of the package
height INTEGER The height of the package


Response:

Variables Type Condition Description
error INTEGER Always appears 0 - no errors
1 - there are errors
messages ARRAY Error = 1 List of error messages
estimatedCost DOUBLE Error = 0 Estimated cost
distanta DOUBLE Error = 0 Distance between sender and receiver


3.searchCouriers


We are looking for couriers available to deliver the shipment. No extra data is sent

Cases:

  • ASAP_SHIPPING_TYPE - you have to wait 140 seconds to be able to call getCouriersList to get the list of couriers who applied to deliver the shipment
  • POSTAL_SHIPPING_TYPE - return couriers for this service


Response:

Variables Type Condition Description
error INTEGER Always appears 0 - no errors
1 - there are errors
messages ARRAY Error = 1
Or
Error = 0
And
the expedition is of the type
ASAP_SHIPPING_TYPE
List of error messages or success message
couriers ARRAY Error = 0
And
the expedition is of the type
POSTAL_SHIPPING_TYPE
For a list of available couriers, see 4.1 for details


4.getCouriersList


We get the list of couriers for the shipment. No extra data is sent


Cases:

  • ASAP_SHIPPING_TYPE - you have to wait 140 seconds for the searchCouriers call, during which time the active couriers will apply and appear in the returned list
  • POSTAL_SHIPPING_type - can be called immediately to get couriers for this service


Response:

Variables Type Condition Description
error INTEGER Always appears 0 - no errors
1 - there are errors
messages ARRAY Error = 1 List of error messages
couriers ARRAY Error = 0 For a list of available couriers, see 4.1 for details


4.1 Courier item

Variables Type Description
id INTEGER The unique ID associated with the courier
name STRING The name of the courier
pick-up_time STRING Estimated parcel pick-up time
delivery_time STRING Estimated parcel delivery time
cost DOUBLE Total shipping cost
currency STRING Currency
distance STRING Distance between courier and sender
raiting INTEGER Courier rating
img_byte STRING The image of the courier in base64 format
courier_type STRING Courier type


5.selectCourier


We send the id of the chosen courier to start the delivery.


Extra data required:

Variables Type Description
courierId INTEGER The courier ID received from getCouriersList or searchCouriers


Response:

Variables Type Description
error INTEGER 0 - no errors
1 - there are errors
messages ARRAY List of error messages or success message


6.getExpeditionStatus

Returns the status of the shipment, no extra data is sent


Response:

Variables Type Condition Description
error INTEGER It always appears 0 - no errors
1 - there are errors
messages ARRAY Error = 1 List of error messages or success message
status STRING Error = 0 Shipment status


7.getAwb


Get the awb of a shipment as a pdf, if there is no orderId associated shipment sent, the pdf will be empty. No extra data is sent

Our clients


Our skills


What are you looking for?

We are here for you

GO Send Request