Pickup (pickup request)
Pick-up management
Pickup - GET
It returns information about the pick-up requests.
Pick-up information retrieval .
GET
https://api.gsped.it/[INSTANCE]/pickup
Query Parameters
id*
Integer
Pick-up ID
Headers
x-api-key*
String
API key given by Gsped
Snippets example
Pickup - POST
It sends the courier a pick-up request.
Send pick-up request
POST
https://api.gsped.it/[INSTANCE]/pickup
Headers
Content-Type*
String
application/json
x-api-key*
String
API key given by GSped
Request Body
client_id*
Integer
Id of the registry you want to generate the shipment with (given value)
corriere*
Integer
Courier code
servizio*
Integer
Service code
colli*
Integer
NUmber of parcels of the shipment
peso*
Float
Total weight (KG)
date_req_ritiro*
String
Date of pick-up (YYYY-MM-DD)
opening_time*
String
Goods ready time (HH:MM:SS)
closing_time*
String
Closing time (HH:MM:SS)
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
note_sender
String
Sender name
ddt_alpha
String
Customer alphanumeric reference
ddt_num
Integer
Customer numeric reference
sender_name
String
Name/ designation/business name of the sender
sender_addr
String
Sender address (street and number)
sender_cap
String
Zip code of the sender
sender_city
String
City of the sender
sender_prov
String
Province of the sender (2 characters)
sender_country_code
String
Country of the sender (ISO 3166-1 alpha-2)
sender_contact
String
Additional sender contact
sender_email
String
E-mail of the sender
sender_phone
String
Phone number of the sender
rcpt_name
String
Name/ designation/business name of the recipient
rcpt_addr
String
Recipient address (street and number)
rcpt_cap
String
Zip code of the recipient
rcpt_city
String
City of the recipient
rcpt_prov
String
Province of the recipient (2 characters)
rcpt_country_code
String
Country of the recipient (ISO 3166-1 alpha-2)
rcpt_contact
String
Additional recipient contact
rcpt_phone
String
Phone number of the recipient
rcpt_email
String
E-mail of the recipient
merce
String
Goods description
daticolli
Array
Size of the parcels (if available)
daticolli.n_collo
Integer
Progressive number
daticolli.altezza
Integer
Height (cm)
daticolli.larghezza
Integer
Width (cm)
daticolli.lunghezza
Integer
Lenght (cm)
daticolli.peso
Float
Weight (kg)
daticolli.volume
Float
Volume (cu m)
Example snippets
Last updated