Direct - Processos via API
Esta seção consiste em fornecer orientações para as ações a serem realizadas via API para a tratativa de etiquetas emitidas para pedidos Americanas Entrega Direct
Fluxo de operação
DISPONIBILIDADE
A disponibilização da etiqueta para uma entrega Direct depende diretamente do faturamento do pedido: A partir do momento em que o pedido é faturado, o marketplace receberá os dados da nota fiscal, processará as informações e só então disponibilizará a etiqueta para impressão, ou seja, não é possível emitir uma etiqueta Direct antes do pedido ser faturado e o marketplace processar as informações do faturamento.
PROCESSO
Uma vez processado o faturamento do pedido, é necessário agrupar e imprimir a etiqueta disponibilizada, anexá-la ao pacote e solicitar a coleta pelo serviço Direct, que irá até ao local de retirada e fará uma validação (as etiquetas contam com registro de dimensões, peso, dentre outras informações importantes para a identificação), onde qualquer não conformidade resultará em recusa.
Etiqueta/PLP na conta de teste
É importante reforçar as orientações fornecidas na seção Integração Etiqueta: Para o ambiente de teste, todo o fluxo de operações (agrupar/desagrupar, imprimir e solicitar a coleta) será realizado em pedidos Americanas Entrega Direct com base nas etiquetas previamente disponibilizadas, ou seja, os pedidos criados na conta de teste não terão etiquetas.
Todo o fluxo, seja para conta de teste ou na de produção, opera conforme as informações disponibilizadas a seguir:
Etiqueta de frete via API
Todo o recurso de etiquetas será tratado através da URI base vista a seguir:
https://api.skyhub.com.br/shipments/b2w/Os headers utilizados são aqueles padronizados na API, com diferenciação apenas para a emissão de etiquetas em PDF (cuja requisição sofrerá uma alteração no accept). Os headers padronizados podem ser consultados logo abaixo:
Request headers:
X-User-Email
email_de_usuario
X-Api-Key
token_de_integracao de sua conta SkyHub
X-Accountmanager-Key
token_account único de cada Plataforma/ERP
Accept
application/json
Content-Type
application/json
GET - Lista de pedidos aptos ao agrupamento
As etiquetas disponíveis podem ser listadas, utilizando os headers padronizados na API, através de um GET para o endpoint a seguir:
Example request:
Response esperado:
200 [Success] - OK: Como resposta haverá um body contendo todos os pedidos com etiquetas aptas ao agrupamento:
POST - Agrupando pedidos em uma PLP
Em posse dos pedidos aptos ao agrupamento, é possível seguir efetivamente para a ação de agrupar as etiquetas. O agrupamento é realizado através da execução de um POST, utilizando os headers padronizados na API, para o endpoint:
Request body:
Há um limite de 25 pedidos que podem ser agrupados em uma PLP.
Example request:
Response esperado:
201 [Success] - Created: A requisição trará como resposta o ID da PLP gerada:
Consultar PLPs agrupadas
Um ID é gerado ao realizar o agrupamento de etiquetas em uma PLP (packing list); este código será utilizado para as demais tratativas do /shipments/b2w, como a emissão da etiqueta a ser indexada ao pedido e cancelamento da solicitação de coleta. É possível realizar a consulta de todas as PLPs disponíveis ao executar um GET contendo os headers padronizados na API para o endpoint:
Example request:
Response esperado:
200 [Success] - OK: Como resposta haverá um body contendo todas as PLPs agrupadas:
Consultar o ID da PLP através do número do pedido
Para seguir com a impressão da etiqueta também é possível buscar o ID da PLP através do número do pedido agrupado. Para tal consulta serão aplicados os headers padronizados na API e o método GET para o endpoint /shipments/b2w, que deverá receber o parâmetro delivery_id:
Example request:
Response esperado:
200 [Success] - OK: Como resposta haverá um body contendo as informações da PLP na qual o pedido consultado foi agrupado:
GET - Imprimindo PLP
Apenas após realizar o agrupamento de uma PLP será possível seguir para a impressão da etiqueta.
A impressão da etiqueta (também chamada de "recuperação" ou emissão) é realizada ao executar um GET, utilizando os headers padronizados na API (com especificações distintas no accept), para o endpoint /shipments/b2w/view, indicando como parâmetro a key plp_id, que deverá receber o ID da PLP a ser impressa:
Imprimir PLP - PDF
Atenção: Esta impressão sofreu alterações recentemente. Agora, o retorno mostra a etiqueta impressa codificada em Base64, devendo a plataforma desenvolver uma solução para decodificá-la.
A impressão em PDF está desabilitada exclusivamente para o ambiente de teste.
Em produção é possível seguir com a impressão em ambos os formatos (PDF e JSON).
Example request:
Response esperado:
200 [Success] - OK: Como resposta haverá um código Base64 com a etiqueta.
409 [Error] - As etiquetas desta PLP ainda não estão disponíveis para impressão. Neste caso, é necessário trabalhar com o Retry para obter a etiqueta quando ela estiver disponível.
Imprimir PLP - JSON
Para imprimir a etiqueta na impressora térmica, será necessário baixar o arquivo JSON utilizando o parâmetro: Accept: application/json. Através dele será retornado o JSON da etiqueta e deverá ser montado o layout para a impressão.
Example request:
Response esperado:
200 [Success] - OK: Como resposta haverá o JSON da PLP cujo ID foi selecionado, conforme visualizado a seguir:
409 [Error] - As etiquetas desta PLP ainda não estão disponíveis para impressão. Neste caso, é necessário trabalhar com o Retry para obter a etiqueta quando ela estiver disponível.
Importante atentar-se que os campos disponibilizados no json seguem o padrão dos Correios e não devem ser realizadas alterações nos valores preenchidos pelo marketplace.
Por exemplo, no campo CEP, para geração do código de barras não devem ser adicionados espaços ou pontuações; assim como é preciso validar a quantidade de caracteres, que não deve exceder 8 dígitos numéricos (sem contar o hífen).
Caso necessário, sugerimos que seja validado o Guia de Endereçamento dos Correios para a correta montagem das etiquetas.
Solicitação de coleta
Para um pedido emitido via Direct é obrigatória a solicitação de coleta após a emissão da etiqueta.
Caso não haja a solicitação, a Direct não irá efetuar a coleta do pedido.
GET - Aptos à coleta
É possível consultar quais pedidos estão aptos para a coleta, isto é, através da API é possível listar os pedidos que tiveram suas etiquetas agrupadas e impressas.
Esta ação é realizada através de um GET - utilizando os headers padronizados na API e visualizados no início deste guia - para o endpoint abaixo, onde o parâmetro requested é obrigatório:
Example request:
Response esperado:
200 [Success] - OK: Como resposta haverá um body contendo todos os pedidos aptos à solicitação de coleta:
POST - Solicitando a coleta
Atenção: Endpoint descontinuado.
Após verificar quais pedidos estão aptos a serem coletados, o próximo passo é efetivamente seguir para a solicitação da coleta, ação executada ao aplicar os headers padronizados na API e o método POST para o endpoint:
Request body:
Example request:
Embora não haja limitação de pedidos para o array order_codes, o marketplace Americanas estabeleceu um limite de 500 entregas para esta ação.
Response esperado:
201 [Success] - Created: O retorno trará a mensagem de confirmação da coleta:
Cancelar o processo de coleta
Para cancelar a solicitação de uma coleta basta enviar a requisição responsável por desagrupar a PLP. Uma vez que a PLP é desagrupada, os pedidos voltam para a relação de aptos ao agrupamento, ficando disponíveis novamente para a execução de todas as ações relacionadas às etiquetas.
DELETE - Desagrupando PLP
Atenção: Endpoint descontinuado.
A ação de desagrupar pode ser realizada tanto para toda a PLP quanto para um pedido em específico. Em ambos os cenários, serão utilizados os headers padronizados na API para executar um DELETE no endpoint base:
Desagrupar toda a PLP
Para desagrupar toda a PLP basta executar um DELETE para o endpoint referenciado acima e reforçado logo a seguir, acrescentando como parâmetro o "plp_id":
Example request:
Response esperado:
200 [Success] - OK: O retorno trará a mensagem de confirmação de que a PLP foi desagrupada:
Desagrupar um pedido da PLP
Atenção: Endpoint descontinuado.
Quando se opta por agrupar mais de um pedido em uma mesma PLP e há a necessidade de desagrupar apenas uma entrega deve ser realizado o DELETE para o endpoint base /shipments/b2w/, incluindo o código numérico do pedido:
Example request:
Response esperado:
200 [Success] - OK: O retorno trará a mensagem de confirmação de que o pedido selecionado foi desagrupado da PLP:
Last updated