PUDO (punti di ritiro)

I punti di ritiro sono gestiti per diversi corrieri, in questa pagina sono indicati i dati da passare nella chiamata POST alla shipment per passare le informazioni relative al punto di ritiro al corriere.

BRT - TNT - DHL - GLS - COLISSIMO-InPOST

Inserire il codice identificativo del PUDO / dropoff point nel campo generic_service_point

{
    "generic_service_point":""
}

Campo	Required	Type	Description
generic_service_point		string	Codice identificativo del PUDO N.B. per GLS nella forma {PARTNER_SHOP_ID}-{SHOP_ID}

COLISSIMO: gestione service point possibile solo con servizio corriere OUT HOME, id servizio Gsped 3

UPS

Questo corriere richiede i dati completi del punto di ritiro e del suo codice identificativo.

"ups_uap_id": "",
"uap": [
    {
        "address": "",
        "city": "",
        "country_code": "",
        "name": "",
        "postal_code": "",
        "state_province_code": ""
    }
]

Campo	Required	Type	Description
ups_uap_id		string	Codice identificativo del PUDO
uap.address		string	Indirizzo PUDO
uap.city		string	Città PUDO
uap.country_code		string	ISO 2 Char nazione PUDO
uap.name		string	Nome PUDO
uap.postal_code		string	CAP PUDO
uap.state_province_code		string	Sigla provincia PUDO

SDA/Crono

Questo corriere richiede i dati completi del punto di ritiro e del suo codice identificativo.

"sda_id_fermoposta":"",
"sda_fermoposta":{
    "state_province_code":"",
    "name":"",
    "address":"",
    "city":"",
    "postal_code":""
}

Campo	Required	Type	Description
sda_id_fermoposta		string	Codice identificativo del PUDO
sda_fermoposta.state_province_code		string	Codice provincia/stato PUDO
sda_fermoposta.name		string	Nome PUDO
sda_fermoposta.address		string	Indirizzo PUDO
sda_fermoposta.city		string	Città PUDO
sda_fermoposta.postal_code		string	CAP PUDO

POSTE Delivery Business

PosteDB gestisce il punto di ritiro come accessorio, distinguendo in base alla tipologia del punto, per i punti di ritiro andrà compilato un oggetto nell'array pdb_accessori con gli elementi accessorio, param1 e param2. Param1 conterrà il codice del punto, param2 la denominazione del punto e accessorio sarà una di queste stringhe in base al tipo di punto.

"pdb_accessori":[
    {
        "accessorio":"",
        "param1":"",
        "param2":"",
        "param3":"",
        "param4":""
    }
]

Campo	Required	Type	Description
accessorio		enum	In base al PUDO: - ConsegnaPUDOUPS - ConsegnaPuntoPoste - ConsegnaLocker - ConsegnaUfficioPostale
param1		string	Codice identificativo PUDO
param2		string	Nome PUDO
param3		string	non utilizzato
param4		string	non utilizzato

TNT (vecchia implementazione, deprecata nel 2024)

Questa implementazione verrà rimossa in favore di quella nuova nel corso del 2024.

Nella chiamata andrà inserito un array a indici numerici denominato tnt_options

"tnt_options":[
    "",    // 1° valore
    ""     // 2° valore
]

Campo	Required	Type	Description
1° valore		enum	Valorizzare con 3 (TNT Point)
2° valore		string	Codice identificativo PUDO

DHL Parcel Connect (169)

Attenzione : Attualmente in fase di sviluppo. Indicativamente sarà attivo a fine Aprile

Questo corriere richiede il codice identificativo dell'accesspoint (KeywordID) insieme a CAP, città e nazione in cui si trova.

Esempio :

"accessPoint": {
        "apId": "501",
        "apCity": "Zukowo",
        "apPostalCode": "83-330",
        "apCountryCode": "PL"
}

Per la Germania e Lussemburgo viene richiesto anche un codice identificativo del destinatario, in quanto questi ultimi devono essere registrati per poter ricevere spedizioni negli Access Points.

Esempio :

"accessPoint": {
        "apId": "501",
        "apCity": "Berlin",
        "apPostalCode": "10557",
        "apCountryCode": "DE",
        "apAncillaryData": {
                "customerId": "123456"
        }
}