Crea etichette e genera un manifesto per Australia Post utilizzando l'API
GraphQL.
GraphQL
Australia Post registra le spedizioni come consolidamento (un manifesto). A differenza di altri
corrieri per cui un'etichetta è un'azione autonoma, una spedizione Australia Post deve appartenere a un
gruppo di consolidamento, ed è il gruppo a essere registrato presso Australia Post.
Il flusso è composto da tre parti:
Apri un gruppo di consolidamento — il manifesto a cui vengono aggiunte le spedizioni.
Crea le etichette all'interno del gruppo — ogni spedizione viene registrata presso Australia Post
e viene restituita un'etichetta. Le spedizioni restano nel carrello di Australia Post, non ancora registrate.
Chiudi il gruppo — questo registra l'ordine presso Australia Post e genera il
riepilogo dell'ordine (il manifesto cartaceo) da presentare al momento della consegna.
Fatturazione: al commerciante viene addebitato l'importo quando il gruppo viene chiuso (registrato), non quando
viene creata un'etichetta. Le etichette possono essere create e annullate liberamente finché il gruppo non viene chiuso.
Crea un gruppo con shipmentConsolidationCreate, utilizzando carrierCode: AUSTRALIA_POST.
L'id restituito è il gruppo a cui aggiungere le etichette. Se hai già un gruppo aperto per
la giornata, riutilizzalo invece di crearne uno nuovo (vedi Riutilizza un gruppo aperto di seguito).
1mutationShipmentConsolidationCreate(
2$input: ShipmentConsolidationCreateInput!
3){
4 shipmentConsolidationCreate(input:$input) {
5 id
6 name
7 carrierCode
8 status
9}
10}
Riutilizza un gruppo aperto
Per aggiungere etichette a un gruppo esistente invece di crearne uno nuovo, esegui una query per i gruppi aperti
e utilizza l'id di quello desiderato.
1queryShipmentConsolidations{
2 shipmentConsolidations(filter:{status: OPEN }, first:50){
Crea la spedizione e la relativa etichetta con shipmentCreateWorkflow, passando l'id del gruppo
come shipmentConsolidationId. La mutazione registra la spedizione presso Australia Post e
restituisce un URL dell'etichetta e un numero di tracciamento. Non viene ancora addebitato alcun costo — la spedizione resta
nel carrello di Australia Post finché il gruppo non viene chiuso.
Campi specifici di Australia Post:
shipmentConsolidationId — l'id del gruppo ottenuto nel Passaggio 1. Obbligatorio per aggiungere la spedizione
al manifesto.
serviceLevel — il livello di servizio Australia Post per la spedizione (ad esempio, un
livello di servizio International Standard o International Express).
itnNumber — il numero di dichiarazione di esportazione (EDN). Obbligatorio quando il valore totale degli articoli
supera 2.000 AUD.
I numeri di telefono devono contenere solo cifre — Australia Post rifiuta spazi e punteggiatura.
Quando sei pronto per spedire, chiudi il gruppo con shipmentConsolidationUpdate e
status: CLOSED. Questo registra l'ordine presso Australia Post e restituisce il manifesto in
customsDocuments (il PDF del riepilogo dell'ordine). Questo è il momento in cui al commerciante viene
addebitato l'importo. Il mittente del manifesto proviene dall'indirizzo di origine di ciascuna spedizione, quindi non è necessario
alcun centro di distribuzione.
1mutationShipmentConsolidationUpdate(
2$input: ShipmentConsolidationUpdateInput!
3){
4 shipmentConsolidationUpdate(input:$input) {
5 id
6 status
7 customsDocuments {
8 id
9 fileUrl
10 fileName
11 documentType
12 fileType
13}
14}
15}
Scarica il manifesto da customsDocuments.fileUrl e presentalo al momento della consegna o
del ritiro. Una volta chiuso il gruppo, le sue spedizioni sono registrate e non possono più essere modificate.
Poiché l'addebito avviene alla chiusura, puoi rimuovere una spedizione da un gruppo in qualsiasi momento prima
che venga chiuso annullando la relativa etichetta. L'annullamento rimuove la spedizione dal carrello di Australia Post,
quindi non viene mai registrata né addebitata.
GraphQL API ReferenceTypes, inputs, and operations used in this guide
Crea etichette e manifesti - GraphQL
Crea etichette e manifesti Australia Post
Crea etichette e genera un manifesto per Australia Post utilizzando l'API GraphQL.
GraphQL
Australia Post registra le spedizioni come consolidamento (un manifesto). A differenza di altri corrieri per cui un'etichetta è un'azione autonoma, una spedizione Australia Post deve appartenere a un gruppo di consolidamento, ed è il gruppo a essere registrato presso Australia Post.
Il flusso è composto da tre parti:
Prima di iniziare
Passaggio 1: apri un gruppo di consolidamento
Crea un gruppo con
shipmentConsolidationCreate, utilizzandocarrierCode: AUSTRALIA_POST. L'idrestituito è il gruppo a cui aggiungere le etichette. Se hai già un gruppo aperto per la giornata, riutilizzalo invece di crearne uno nuovo (vedi Riutilizza un gruppo aperto di seguito).mutation ShipmentConsolidationCreate($input: ShipmentConsolidationCreateInput!) {shipmentConsolidationCreate(input: $input) {idnamecarrierCodestatus}}Riutilizza un gruppo aperto
Per aggiungere etichette a un gruppo esistente invece di crearne uno nuovo, esegui una query per i gruppi aperti e utilizza l'
iddi quello desiderato.query ShipmentConsolidations {shipmentConsolidations(filter: { status: OPEN }, first: 50) {edges {node {idnamecarrierCodestatus}}}}Passaggio 2: crea un'etichetta all'interno del gruppo
Crea la spedizione e la relativa etichetta con
shipmentCreateWorkflow, passando l'iddel gruppo comeshipmentConsolidationId. La mutazione registra la spedizione presso Australia Post e restituisce un URL dell'etichetta e un numero di tracciamento. Non viene ancora addebitato alcun costo — la spedizione resta nel carrello di Australia Post finché il gruppo non viene chiuso.Campi specifici di Australia Post:
shipmentConsolidationId— l'iddel gruppo ottenuto nel Passaggio 1. Obbligatorio per aggiungere la spedizione al manifesto.serviceLevel— il livello di servizio Australia Post per la spedizione (ad esempio, un livello di servizio International Standard o International Express).itnNumber— il numero di dichiarazione di esportazione (EDN). Obbligatorio quando il valore totale degli articoli supera 2.000 AUD.Consulta
ShipmentCreateWorkflowInputper l'elenco completo dei campi, e Crea una spedizione per la mutazione generica di spedizione (non specifica di Australia Post).mutation ShipmentCreateWorkflow($input: ShipmentCreateWorkflowInput!) {shipmentCreateWorkflow(input: $input) {idstatustracking {number}shipmentCartons {label {urltrackingNumber}}}}Ripeti questo passaggio per ogni collo che desideri includere nello stesso manifesto — passando lo stesso
shipmentConsolidationIdogni volta.Passaggio 3: chiudi il gruppo per generare il manifesto
Quando sei pronto per spedire, chiudi il gruppo con
shipmentConsolidationUpdateestatus: CLOSED. Questo registra l'ordine presso Australia Post e restituisce il manifesto incustomsDocuments(il PDF del riepilogo dell'ordine). Questo è il momento in cui al commerciante viene addebitato l'importo. Il mittente del manifesto proviene dall'indirizzo di origine di ciascuna spedizione, quindi non è necessario alcun centro di distribuzione.mutation ShipmentConsolidationUpdate($input: ShipmentConsolidationUpdateInput!) {shipmentConsolidationUpdate(input: $input) {idstatuscustomsDocuments {idfileUrlfileNamedocumentTypefileType}}}Scarica il manifesto da
customsDocuments.fileUrle presentalo al momento della consegna o del ritiro. Una volta chiuso il gruppo, le sue spedizioni sono registrate e non possono più essere modificate.Annullamento prima della registrazione
Poiché l'addebito avviene alla chiusura, puoi rimuovere una spedizione da un gruppo in qualsiasi momento prima che venga chiuso annullando la relativa etichetta. L'annullamento rimuove la spedizione dal carrello di Australia Post, quindi non viene mai registrata né addebitata.
ShipmentConsolidationCreateInput ShipmentConsolidationUpdateInput ShipmentCreateWorkflowInput
shipmentConsolidationCreate shipmentConsolidationUpdate shipmentCreateWorkflow
Questa pagina è stata utile?