Comparative Rate
Preventive analysis of shipment costs
The Comparative Network endpoint allows to estimate in advance the costs of a shipment via your (active or passive) price lists, that have been saved on Gsped, such as;
Rental (base cost of the shipment)
Predictable incidental expenses
COD Cost
Insurance cost
FUEL
Remote areas or islands
Additional services (delivery to the floor or on Saturday, etc)
Charges due to oversize
Etc.
There are two kinds of rating:
ACTIVE: needs a costs analysis only related to active price lists
PASSIVE:costs analysis related to the price lists agreed upon with the courier in the contracting stage. This modality takes account of the ACTIVE rating to compare the shipping costs and incomes.
ComparativeRate
GET
https://api.gsped.it/[INSTANCE]/RateComparativa
Path Parameters
Name | Type | Description |
---|---|---|
istanza | string | Instance to call; if not setted, redirected on shared instance. |
Query Parameters
Name | Type | Description |
---|---|---|
departure_date_time | string | Datetime in YYYY-MM-DD HH:MM:SS format. \ If not valued, the datetime is setted at the time of request. |
tipo_listino | string | {attivo|passivo} Identifies the kind of rating to execute \ PLEASE NOTE:If PASSIVE, both are returned |
gls_exchange | string | {N|S} Identifies the request for EXCHANGE service to the GSped courier. |
al_piano | string | {0|1} Identifies if the delivery to the floor is requested (only if the service is provided by the courier) |
al_sabato | string | {0|1} Identifies if the Saturday delivery is requested (only if the service is provided by the courier) |
client_id | integer | Client ID to be rated |
invoiced_client_id | integer | Client ID to be rated with the ACTIVE costs in the RESELLER instances. |
colli | integer | Number of parcels of the shipment |
daticolli | array | Parcel size in CM | KG | CU M \ - height \ - width \ - lenght \ - weight \ - volume |
peso | number | Overall weight of the shipment (KG) |
volume | number | Total volume of the shipment (M CU) |
sender_addr | string | Adress of the sender |
sender_city | string | City of the sender |
sender_prov | string | Province code of the sender |
sender_cap | string | Zip code of the sender |
sender_country_code | string | ISO 2 code of the sender's country |
rcpt_addr | string | Address of the recipient |
rcpt_city | string | City of the recipient |
rcpt_prov | string | Province code of the recipient |
rcpt_cap | string | Zip code of the recipient |
rcpt_country_code | string | ISO 2 code of the recipient's country |
contrassegno | number | COD value |
valore | number | Amount of the insurance |
documenti | string | {0|1} Identifies a document shipment |
preavviso_telefonico | string | {S|N} Identifies if a telephone notice is required |
Headers
Name | Type | Description |
---|---|---|
accept | string | Gzip,deflate |
x-api-key | string | Authentication Key given by GSped |
Some example snippets in different languages:
Last updated