Shipment References

Questo endpoint permette di gestire riferimenti multipli per una spedizione.

ShipmentReferences - GET

GET https://api.gsped.it/[ISTANZA]/ShipmentReferences/[ID_SPEDIZIONE]

Recupera i riferimenti associati per la spedizione richiesta

URL Parameters

Name	Type	Description
ISTANZA	String	Nome dell'istanza di riferimento
ID_SPEDIZIONE	Integer	ID univoco Gsped della spedizione

Headers

Name	Type
x-api-key	String	Apikey fornita da Gsped

Response

200

Riferimenti recuperati con successo

{
    "primaryReference": "382993",
    "secondaryReference": [
        "ref1",
        "ref2",
        "ref3"
    ]
}

400

Richiesta mal formata

{
    "error": "Dati in ingresso non validi : Il campo 'id spedizione' è obbligatorio."
}

403

Non si hanno i permessi necessari per gestire la spedizione richiesta

{
    "error": "Non si hanno i permessi necessari per gestire la spedizione con ID XYZ"
}

404

Non ci sono riferimenti associati per la spedizione richiesta. Questo codice si ottine anche nel caso la spedizione richiesta non esiste

{
    "error": "Non sono ancora presenti riferimenti per la spedizione con ID XYZ"
}

ShipmentReferences - POST

POST https://api.gsped.it/[ISTANZA]/ShipmentReferences

Questo endpoint permette di associare uno o più riferimenti alla spedizione.

IMPORTANTE :

Questo endpoint può essere richiamato più volte sulla stessa spedizione per aggiungere i riferimenti man mano che vi è necessità di farlo.

Al momento il limite massimo di riferimenti che possono essere associati a una spedizione è 20.

Headers

Name	Value
x-api-key	String	Apikey fornita da Gsped

Body

Name	Type	Description
idSpedizione	Integer	ID univoco Gsped della spedizione
references	array	Array contenente i riferimenti da associare alla spedizione. Massimo 20 elementi!

Response

200

Rifimento/i inseriti con successo

{
    "status": "Riferimento associato con successo"
}

400

Richiesta mal formata oppure nella richiesta si supera il numero di riferimenti ammessi associati alla spedizione.

{
    "error": "Dati in ingresso non validi : Il campo 'id spedizione' è obbligatorio."
}

403

Non si hanno i permessi necessari per gestire la spedizione richiesta

{
    "error": "Non si hanno i permessi necessari per gestire la spedizione con ID XYZ"
}

404

La spedizione a cui associare i riferimenti non esiste

{
    "error": "La spedizione con ID XYZ non esiste"
}

ShipmentReferences - DELETE

DELETE https://api.gsped.it/[ISTANZA]/ShipmentReferences/[ID_SPEDIZIONE]/[REFERENCE]

Questo endpoint permette di disassociare tutti i riferimenti di una spedizione o togliere un singolo riferimento

URL Parameters

Name	Type	Description
ISTANZA	String	INome dell'istanza di riferimento
ID_SPEDIZIONE	integer	ID univoco Gsped della spedizione
REFERENCE	string	Parametro Opzionale. Se valorizzato, indica il riferimento da disassociare dalla spedizione. NB: Nel caso in cui non venga indicato, verranno disassociati tutti i riferimenti NB2: Eventuali caratteri speciali devono essere urlencoded

Headers

Name	Type	Description
x-api-key	string	Apikey fornita da Gsped

Response

200

Riferimento disassociato con successo

{
    "status": "Riferimento cancellato"
}

400

Richiesta mal formata

{
    "error": "Dati in ingresso non validi : Il campo 'id spedizione' è obbligatorio."
}

403

Non si hanno i permessi necessari per gestire la spedizione richiesta

{
    "error": "Non si hanno i permessi necessari per gestire la spedizione con ID XYZ"
}

404

Non ci sono riferimenti associati da cancellare per la spedizione richiesta. Questo codice si ottine anche nel caso la spedizione richiesta non esiste

{
    "error": "Non sono presenti riferimenti associati alla spedizione"
}