Crie etiquetas e gere um manifesto para a Australia Post usando a API
GraphQL.
GraphQL
A Australia Post despacha remessas como uma consolidação (um manifesto). Ao contrário de
transportadoras onde uma etiqueta é uma ação independente, uma remessa da Australia Post deve
pertencer a um grupo de consolidação, e é esse grupo que é despachado junto à 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 é registrada junto à Australia Post
e uma etiqueta é retornada. As remessas ficam na cesta da Australia Post, sem despacho.
Fechar o grupo — isso despacha o pedido junto à Australia Post e produz o
Resumo do pedido (o manifesto em papel) que você apresenta na entrega.
Cobrança: o lojista é cobrado quando o grupo é fechado (despachado), não quando
uma etiqueta é criada. As etiquetas podem ser criadas e anuladas livremente até que o grupo seja fechado.
Crie um grupo com shipmentConsolidationCreate, usando carrierCode: AUSTRALIA_POST.
O id retornado é o grupo ao qual você adiciona etiquetas. Se você já tiver um grupo aberto para
o dia, reutilize-o em vez de criar um novo (veja 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 use o id do que você deseja.
1queryShipmentConsolidations{
2 shipmentConsolidations(filter:{status: OPEN }, first:50){
Crie a remessa e sua etiqueta com shipmentCreateWorkflow, passando o id do grupo
como shipmentConsolidationId. A mutação registra a remessa junto à Australia Post e
retorna uma URL de etiqueta e um número de rastreamento. Ainda não ocorre cobrança — a remessa é mantida
na cesta da Australia Post até que o grupo seja fechado.
Campos específicos da Australia Post:
shipmentConsolidationId — o id do grupo obtido na Etapa 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 do artigo
ultrapassa AUD 2.000.
Os números de telefone devem conter apenas dígitos — a Australia Post rejeita espaços e pontuação.
Quando estiver pronto para enviar, feche o grupo com shipmentConsolidationUpdate e
status: CLOSED. Isso despacha o pedido junto à Australia Post e retorna o manifesto em
customsDocuments (o PDF do Resumo do pedido). Este é o momento em que o lojista é
cobrado. O remetente do manifesto vem do endereço de origem de cada remessa, então nenhum
centro de distribuição é necessário.
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}
Baixe o manifesto a partir de customsDocuments.fileUrl e apresente-o na entrega ou
retirada. Depois que o grupo é fechado, suas remessas são despachadas e não podem mais ser alteradas.
Como a cobrança ocorre no fechamento, você pode retirar uma remessa de um grupo a qualquer momento antes
de ele ser fechado, anulando sua etiqueta. A anulação remove a remessa da cesta da
Australia Post, para que ela nunca seja despachada e nunca seja 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 usando a API GraphQL.
GraphQL
A Australia Post despacha remessas como uma consolidação (um manifesto). Ao contrário de transportadoras onde uma etiqueta é uma ação independente, uma remessa da Australia Post deve pertencer a um grupo de consolidação, e é esse grupo que é despachado junto à Australia Post.
O fluxo tem três partes:
Antes de começar
Etapa 1: Abrir um grupo de consolidação
Crie um grupo com
shipmentConsolidationCreate, usandocarrierCode: AUSTRALIA_POST. Oidretornado é o grupo ao qual você adiciona etiquetas. Se você já tiver um grupo aberto para o dia, reutilize-o em vez de criar um novo (veja 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 use o
iddo que você deseja.query ShipmentConsolidations {shipmentConsolidations(filter: { status: OPEN }, first: 50) {edges {node {idnamecarrierCodestatus}}}}Etapa 2: Criar uma etiqueta no grupo
Crie a remessa e sua etiqueta com
shipmentCreateWorkflow, passando oiddo grupo comoshipmentConsolidationId. A mutação registra a remessa junto à Australia Post e retorna uma URL de etiqueta e um número de rastreamento. Ainda não ocorre cobrança — a remessa é mantida na cesta da Australia Post até que o grupo seja fechado.Campos específicos da Australia Post:
shipmentConsolidationId— oiddo grupo obtido na Etapa 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 do artigo ultrapassa AUD 2.000.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 esta etapa para cada volume que você quiser incluir no mesmo manifesto — passe o mesmo
shipmentConsolidationIda cada vez.Etapa 3: Fechar o grupo para gerar o manifesto
Quando estiver pronto para enviar, feche o grupo com
shipmentConsolidationUpdateestatus: CLOSED. Isso despacha o pedido junto à Australia Post e retorna o manifesto emcustomsDocuments(o PDF do Resumo do pedido). Este é o momento em que o lojista é cobrado. O remetente do manifesto vem do endereço de origem de cada remessa, então nenhum centro de distribuição é necessário.mutation ShipmentConsolidationUpdate($input: ShipmentConsolidationUpdateInput!) {shipmentConsolidationUpdate(input: $input) {idstatuscustomsDocuments {idfileUrlfileNamedocumentTypefileType}}}Baixe o manifesto a partir de
customsDocuments.fileUrle apresente-o na entrega ou retirada. Depois que o grupo é fechado, suas remessas são despachadas e não podem mais ser alteradas.Anulação antes do despacho
Como a cobrança ocorre no fechamento, você pode retirar uma remessa de um grupo a qualquer momento antes de ele ser fechado, anulando sua etiqueta. A anulação remove a remessa da cesta da Australia Post, para que ela nunca seja despachada e nunca seja cobrada.
ShipmentConsolidationCreateInput ShipmentConsolidationUpdateInput ShipmentCreateWorkflowInput
shipmentConsolidationCreate shipmentConsolidationUpdate shipmentCreateWorkflow
Esta página foi útil?