Crie etiquetas e gere um manifesto para a Australia Post utilizando a API
GraphQL.
GraphQL
A Australia Post submete as remessas como uma consolidação (um manifesto). Ao contrário
de outras transportadoras, em que uma etiqueta é uma ação independente, uma remessa da Australia
Post tem de pertencer a um grupo de consolidação, e é esse grupo que é submetido à Australia Post.
O fluxo tem três partes:
Abrir um grupo de consolidação — o manifesto ao qual as remessas são adicionadas.
Criar etiquetas no grupo — cada remessa é registada na Australia Post
e é devolvida uma etiqueta. As remessas ficam no cesto da Australia Post, por submeter.
Fechar o grupo — submete a encomenda à Australia Post e gera o
Resumo da encomenda (o manifesto em papel) que apresenta no momento da entrega.
Faturação: o comerciante é cobrado quando o grupo é fechado (submetido), e não quando
é criada uma etiqueta. As etiquetas podem ser criadas e anuladas livremente até o grupo ser fechado.
Crie um grupo com shipmentConsolidationCreate, utilizando carrierCode: AUSTRALIA_POST.
O id devolvido é o grupo ao qual adiciona as etiquetas. Se já tiver um grupo aberto para
o dia, reutilize-o em vez de criar um novo (consulte Reutilizar um grupo aberto abaixo).
1mutationShipmentConsolidationCreate(
2$input: ShipmentConsolidationCreateInput!
3){
4 shipmentConsolidationCreate(input:$input) {
5 id
6 name
7 carrierCode
8 status
9}
10}
Reutilizar um grupo aberto
Para adicionar etiquetas a um grupo existente em vez de criar um novo, consulte os grupos abertos
e utilize o id do grupo pretendido.
1queryShipmentConsolidations{
2 shipmentConsolidations(filter:{status: OPEN }, first:50){
Crie a remessa e a respetiva etiqueta com shipmentCreateWorkflow, passando o id do grupo
como shipmentConsolidationId. A mutação regista a remessa na Australia Post e
devolve um URL da etiqueta e um número de rastreio. Ainda não é efetuada qualquer cobrança — a remessa fica
no cesto da Australia Post até o grupo ser fechado.
Campos específicos da Australia Post:
shipmentConsolidationId — o id do grupo do Passo 1. Obrigatório para adicionar a remessa
ao manifesto.
serviceLevel — o nível de serviço da Australia Post para a remessa (por exemplo, um
nível de serviço International Standard ou International Express).
itnNumber — o número da declaração de exportação (EDN). Obrigatório quando o valor total
dos artigos excede 2000 AUD.
Os números de telefone devem conter apenas dígitos — a Australia Post rejeita espaços e sinais de pontuação.
Quando estiver pronto para enviar, feche o grupo com shipmentConsolidationUpdate e
status: CLOSED. Esta ação submete a encomenda à Australia Post e devolve o manifesto em
customsDocuments (o PDF do Resumo da encomenda). É neste momento que o comerciante é
cobrado. O remetente do manifesto é obtido a partir do endereço de origem de cada remessa, pelo que não
é necessário nenhum centro de processamento de encomendas.
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}
Transfira o manifesto a partir de customsDocuments.fileUrl e apresente-o no momento da entrega ou
da recolha. Depois de o grupo ser fechado, as respetivas remessas ficam submetidas e já não podem ser alteradas.
Uma vez que a cobrança ocorre no fecho, pode retirar uma remessa de um grupo a qualquer momento antes
de este ser fechado, anulando a respetiva etiqueta. A anulação remove a remessa do cesto da
Australia Post, pelo que esta nunca é submetida nem cobrada.
GraphQL API ReferenceTypes, inputs, and operations used in this guide
Criar etiquetas e manifestos - GraphQL
Criar etiquetas e manifestos da Australia Post
Crie etiquetas e gere um manifesto para a Australia Post utilizando a API GraphQL.
GraphQL
A Australia Post submete as remessas como uma consolidação (um manifesto). Ao contrário de outras transportadoras, em que uma etiqueta é uma ação independente, uma remessa da Australia Post tem de pertencer a um grupo de consolidação, e é esse grupo que é submetido à Australia Post.
O fluxo tem três partes:
Antes de começar
Passo 1: Abrir um grupo de consolidação
Crie um grupo com
shipmentConsolidationCreate, utilizandocarrierCode: AUSTRALIA_POST. Oiddevolvido é o grupo ao qual adiciona as etiquetas. Se já tiver um grupo aberto para o dia, reutilize-o em vez de criar um novo (consulte Reutilizar um grupo aberto abaixo).mutation ShipmentConsolidationCreate($input: ShipmentConsolidationCreateInput!) {shipmentConsolidationCreate(input: $input) {idnamecarrierCodestatus}}Reutilizar um grupo aberto
Para adicionar etiquetas a um grupo existente em vez de criar um novo, consulte os grupos abertos e utilize o
iddo grupo pretendido.query ShipmentConsolidations {shipmentConsolidations(filter: { status: OPEN }, first: 50) {edges {node {idnamecarrierCodestatus}}}}Passo 2: Criar uma etiqueta no grupo
Crie a remessa e a respetiva etiqueta com
shipmentCreateWorkflow, passando oiddo grupo comoshipmentConsolidationId. A mutação regista a remessa na Australia Post e devolve um URL da etiqueta e um número de rastreio. Ainda não é efetuada qualquer cobrança — a remessa fica no cesto da Australia Post até o grupo ser fechado.Campos específicos da Australia Post:
shipmentConsolidationId— oiddo grupo do Passo 1. Obrigatório para adicionar a remessa ao manifesto.serviceLevel— o nível de serviço da Australia Post para a remessa (por exemplo, um nível de serviço International Standard ou International Express).itnNumber— o número da declaração de exportação (EDN). Obrigatório quando o valor total dos artigos excede 2000 AUD.Consulte
ShipmentCreateWorkflowInputpara a lista completa de campos e Criar uma remessa para a mutação de remessa geral (não específica da Australia Post).mutation ShipmentCreateWorkflow($input: ShipmentCreateWorkflowInput!) {shipmentCreateWorkflow(input: $input) {idstatustracking {number}shipmentCartons {label {urltrackingNumber}}}}Repita este passo para cada volume que pretenda incluir no mesmo manifesto — passe o mesmo
shipmentConsolidationIdde cada vez.Passo 3: Fechar o grupo para gerar o manifesto
Quando estiver pronto para enviar, feche o grupo com
shipmentConsolidationUpdateestatus: CLOSED. Esta ação submete a encomenda à Australia Post e devolve o manifesto emcustomsDocuments(o PDF do Resumo da encomenda). É neste momento que o comerciante é cobrado. O remetente do manifesto é obtido a partir do endereço de origem de cada remessa, pelo que não é necessário nenhum centro de processamento de encomendas.mutation ShipmentConsolidationUpdate($input: ShipmentConsolidationUpdateInput!) {shipmentConsolidationUpdate(input: $input) {idstatuscustomsDocuments {idfileUrlfileNamedocumentTypefileType}}}Transfira o manifesto a partir de
customsDocuments.fileUrle apresente-o no momento da entrega ou da recolha. Depois de o grupo ser fechado, as respetivas remessas ficam submetidas e já não podem ser alteradas.Anular antes da submissão
Uma vez que a cobrança ocorre no fecho, pode retirar uma remessa de um grupo a qualquer momento antes de este ser fechado, anulando a respetiva etiqueta. A anulação remove a remessa do cesto da Australia Post, pelo que esta nunca é submetida nem cobrada.
ShipmentConsolidationCreateInput ShipmentConsolidationUpdateInput ShipmentCreateWorkflowInput
shipmentConsolidationCreate shipmentConsolidationUpdate shipmentCreateWorkflow
Esta página foi útil?