Envios e etiquetas

Uma etiqueta é comprada em etapas: você cria um envio, escolhe uma das tarifas dele e compra. Até comprar, nada é cobrado e o envio ainda pode mudar.

Cote antes de criar#

Para mostrar preços antes de salvar qualquer coisa, envie o envio que você criaria para o endpoint de tarifas. Ele responde com cada serviço disponível e seu preço.

Crie o envio#

accountId aceita o uid da conta, seu número de conta (CU…) ou seu número de conta externo. Coloque em externalReferenceCode o seu próprio número de pedido para relacionar o envio ao pedido.

A resposta é o objeto Envio. Seu parcel_rates lista os serviços com os quais ele pode ser enviado; cada tarifa tem um uid.

Atualize#

PATCH altera apenas os campos que você envia. Envie o sender, o recipient ou os parcels completos quando alterar um deles. As tarifas são calculadas de novo, então leia as novas parcel_rates da resposta: um uid de tarifa antigo pode não valer mais.

Compre a etiqueta#

Para cada envio, mande o uid dele como shipmentId e o uid da tarifa escolhida como rateId, agrupados pela forma como os pacotes chegam à transportadora:

• dropoff: você leva a um ponto de entrega.
• pickup: a transportadora coleta; envie pickupDate e pickupTime.

Como é pago#

A compra é registrada na sua carteira WeShipYou. Seu saldo é usado primeiro; só o restante é cobrado em paymentMethod, que é "credit_line" (contas com linha de crédito) ou um cartão salvo como { "paymentMethodId": "pm_…" }. Você pode omitir paymentMethod quando o saldo cobre tudo.

Como ler a resposta#

A resposta tem uma entrada por lote: fulfilled quando todas as etiquetas do lote foram compradas, rejected com um reason caso contrário. Leia cada envio (GET /shipments/{shipmentId}) para obter o número de rastreamento em label.trackingNumber.

Cancelar uma etiqueta#

Uma etiqueta que a transportadora ainda não coletou pode ser cancelada com o número de rastreamento. O que você pagou por ela volta como crédito na sua carteira WeShipYou. Um 409 significa que o envio mudou de estado durante o cancelamento: leia de novo e tente outra vez se ainda puder ser cancelado.

Excluir um envio#

Um envio que ainda não tem etiqueta (estado created) pode ser excluído. Para cancelar um cuja etiqueta já foi comprada, cancele a etiqueta.