Shipment
Shipment management
Shipment - GET
This endpoint allows to manage the creation, the data retrieval and the cancellation of any shipment on Gsped.
Shipment -GET
GET
https://api.gsped.it/[INSTANCE]/Shipment
Retrieves all the information about a shipment, including the labels.
Query Parameters
id*
String
Unique ID of the shipment
Headers
x-api-key*
String
Apikey given by Gsped
Example Snippets
Shipment - POST
The Shipment Post call allows to create the shipment.
If the operation is successful, it returns the shipment data together with their labels in all the available formats.
The shipment creation is not always successful; both Gsped and the courier's systems perform a series of checks on the data received. All the possible errors must be properly managed.
To check the outcome of the calls, follow these steps:
Check the response of the API on the shipment creation POST. There are two possible HTTP responses:
400: The data failed to pass the first series of controls. The type of problem is displayed in the field error (e.g. a required field is missing).
200: the data have been validated and the waybill generation has been started. At this point, the value of the field status must be checked; if it displays the value 0 the waybill has correctly been generated and could be downloaded from the right section. If the status field displays the value 0.6 the generation of the waybill has failed and the field error shows the occurred type of problem (eg. inconsistent zip code and city, address not accepted by the courier's systems, service not available for the destination, etc. )
Shipment POST
POST
https://api.gsped.it/[INSTANCE]/Shipment
Shipment creation
Headers
x-api-key*
String
Apikey given by Gsped
Request Body
client_id*
Int
Client ID given by Gsped
ddt_alpha
String
Alphanumeric reference of the shipment. If not defined, Gsped creates one automatically
ddt_num
String
Numeric reference of the shipment. If not defined, Gsped creates one automatically
merce*
String
Generic description of the shipped goods
origine*
String
Iso 2 char of the Provenience of the goods (nation)
contrassegno
Float
COD amount
tipo_incasso
Int
ID type of payment:see - ->
valuta
Iso 4217 currency symbol
valore
Float
Assurance amount
peso*
Float
Weight of the shipment (KG)
volume*
Float
Volume of the shipment (cu m)
colli*
Int
Number of parcels
daticolli
Array
Size of the parcels
daticolli.altezza
Int
Height of the single parcels in cm
daticolli.larghezza
Int
Width of the single parcels in cm
daticolli.lunghezza
Int
Height of the single parcels in cm
daticolli.peso
Float
Weight of the single parcel (KG)
daticolli.volume
Float
Volume of the single parcels (cu m)
sender_name
String
Name of the sender
sender_contact
String
Contact name of the sender
sender_addr
String
Address of the sender
sender_city
String
CIty of the sender
sender_cap
String
Zipcode of the sender
sender_prov
String
Province/country of the sender (iso 2 char)
sender_country_code
String
Country of the sender (iso 2 char)
sender_phone
String
Phone number of the sender
sender_email
String
Email of the sender
rcpt_name*
String
Name of the recipient
rcpt_contact*
String
Contact name of the recipient
rcpt_addr*
String
Address of the recipient
rcpt_city*
String
City of the recipient
rcpt_cap*
String
Zipcode of the recipient
rcpt_prov*
String
Province/country of the recipient (iso 2 char)
rcpt_country_code*
String
Country of the recipient (iso 2 char)
rcpt_phone*
String
Phone number of the recipient
rcpt_email*
String
Email of the recipient
addebito_dogana
Int
Custom charges.
Admitted values :
0 : Custom charges billed to the recipient
1 : Custom charges billed to the sender
2 : Custom charges billed to a third party
note_sender
String
Name of the sender
trade_documents
Array
Electronic documents (PLT) for the entitled couriers
trade_documents.nome
String
Name of the document
trade_documents.contenuto
String
Base 64 string of the document
dettagli_ordine
Array
Data of the order
dettagli_ordine.sku
String
SKU of the single item
dettagli_ordine.descripion
String
Description of the single item
dettagli_ordine.qty
Int
Amount of the single item
dettagli_ordine.barcode
String
Barcode string of the single item
dettagli_ordine.hs_code
String
HS/TARIC code of the single item
dettagli_ordine.prezzo_singolo
String
Price of the single item
dettagli_ordine.peso_riga
String
Peso singolo item - Weight of the single item
dettagli_ordine.country_of_origin
String
Provenience of the good
date_req_ritiro
String
Pick-up date (YYYY-MM-DD)
opening_time
String
Opening time for the pickup (HH:MM:SS )
closing_time
String
Closing time for the pickup (HH:MM:SS)
dropshipping
String
0|1 flag to identify a shipment in dropshipping
al_piano
String
S|N flag to activate the delivery to the floor (only for enabled couriers)
al_sabato
String
S|N flag to activate the saturday delivery service (only for enabled couriers)
reso_contestuale
String
S|N flag to activate the EXCHANGE service (only for enabled couriers)
fermo_deposito
String
S|N flag to identify a shipment in custody
generic_service_point
String
Service point ID of the couriers
documenti
String
0|1 flag to identify a document shipment
valore_doganale
Float
Customs value
opening_time2
String
Second goods ready time (HH:MM:SS) - only for TNT
closing_time2
String
Second closing time (HH:MM:SS) - only for TNT
invoice_date
String
Format YYYY-MM-DD of the invoice date
invoice_number
String
Invoice number
dettagli_ordine.qty*
String
As above but required to:
-- DHL ICS2
dettagli_ordine.um
String
Unit of measurement for the order row:
-- BOX (boxes)
-- KG (chilograms)
-- L (liters)
-- M (meters)
-- NO (number)
-- PCS (pieces)
dettagli_ordine.um*
String
As above but required to:
-- DHL ICS2
dettagli_ordine.descripion*
String
As above but required to:
-- DHL ICS2
dettagli_ordine.country_of_origin*
String
As above but required to:
-- DHL ICS2
dettagli_ordine.peso_riga*
String
As above but required to:
-- DHL ICS2
dettagli_ordine.prezzo_singolo*
String
As above but required to:
-- DHL ICS2
Example Snippets
Shipment - DELETE
This endpoint allows to delete the shipments just in case they have not already been confirmed
When a shipment is cancelled the labels returned by the POST are no longer valid and must be deleted.
Shipment DELETE
DELETE
https://api.gsped.it/[INSTANCE]/Shipment
Cancellation of a shipment from the systems of Gsped and of the couriers
Query Parameters
id*
String
Unique ID of the shipment
Headers
x-api-key*
String
Apikey given by Gsped
Example Snippets
Last updated