Etiqueta de Frete - Correios

Este Guia Técnico consiste em normatizar e estabelecer o padrão da etiqueta do serviço de frete Americanas Entrega Correios emitida no ambiente via API.

Fluxo de Operação
No caso em que os pedidos foram calculados utilizando o Serviço Próprio da Americanas, será disponibilizada uma etiqueta de envio que deverá ser impressa e colada na caixa do produto, para que esse pedido seja enviado de acordo. 
São duas modalidades, pedidos AMERICANAS ENTREGA CORREIO e DIRECT onde cada um dos serviços tem suas peculiaridades, tanto no processo de envio quanto no momento em que a etiqueta será disponibilizada e neste tópico explicaremos como funciona o processo para AMERICANAS ENTREGA CORREIO.
DISPONIBILIDADE - A partir do momento que o pedido é APROVADO será disponibilizada uma etiqueta para impressão. 
PROCESSO – Agrupar e Imprimir a etiqueta anexando ao pacote que será levado até os Correios que fará toda a validação (etiquetas já tem registro de dimensões, peso, etc) e qualquer problema implicará em sua recusa.
IMPORTANTE – Só porque a etiqueta é disponibilizada antes, NÃO SE DEVE pular o fluxo do pedido, sendo necessário FATURAR o mesmo antes de enviar
Etiqueta/PLP na conta de Teste
É importante pontuar que nas contas de TESTE, não conseguimos simular os processos com etiquetas relacionadas ao serviço Americanas Entrega CORREIO. Todo o fluxo dessa operação (Agrupar, Desagrupar e Imprimir), com os EndPoints e etc, será validado pelos processos relacionados a Americanas Entrega DIRECT conforme a documentação específica sobre ela. Então é importante saber o fluxo de operação de cada um desses ambientes que disponibilizam a etiqueta em momentos distintos.
Porém, no ambiente em produção, todo o fluxo opera conforme as informações que disponibilizaremos a seguir.
Modelos de Etiqueta
Os tópicos presentes neste Guia Técnico possibilitam o correto desenvolvimento e garantem a padronização de todas as etiquetas emitidas para os sellers que utilizam o serviço de frete Americanas Entrega via API. Com isso, o fluxo operacional de entrega e identificação visual por parte da operação dos transportadores responsáveis pela entrega das encomendas é assertivo e segue o padrão pré-estabelecido pelos mesmos.
Cada transportador terá as suas peculiaridades e informações explicitadas neste documento, e baseado na escolha dos sellers por determinado transportador, assim como nos momentos de mudança entre eles por sua livre escolha, estas normas e procedimentos referentes à etiqueta do serviço, devem ser atualizadas e adequadas às necessidades de cada seller.
Americanas Entrega - Correios
A etiqueta do Americanas Entrega tendo como seu transportador os Correios tem informações vitais e específicas para todo o processo de entrega e todos os campos que serão referenciados abaixo devem ser parte integrante da etiqueta desta modalidade:
1.Logo da Marca (Americanas Entrega)
2.QR Code
3.Símbolo de Encaminhamento
4.Informação de Volumes
5.Contrato
6.Nota Fiscal
7.Número do Pedido
8.Número da PLP
9.Código de Rastreamento
10.Código de Barras (AWB) 
11.Dados de Recebedor (Recebedor, Assinatura, Documento)
12.Dados de Destinatário (Nome, Endereço, Bairro, Complemento, CEP, Cidade e UF)
13.Código de Barras do CEP
14.Dados do Remetente (Vendedor, Endereço, CEP, Cidade e UF) 
Medidas e Posição dos Campos
As medidas de toda a etiqueta, assim como o devido posicionamento de todos os seus campos e elementos, devem seguir exatamente as cotas abaixo:
Fontes e Logos
Para o desenvolvimento da etiqueta do Americanas Entrega - Correios, disponibilizamos abaixo os tamanhos e padrões de fontes a serem utilizadas, assim como os logos do serviço e símbolos de encaminhamento permitidos nesta etiqueta:
Fontes:
Todas as fontes, tamanhos e suas aplicações presentes em todos os campos que são parte integrante da etiqueta do Americanas Entrega seguem um padrão referenciado pelos transportadores do serviço e sua aplicação deve ser exatamente conforme descrito na tabela abaixo:
Logos Americanas Entrega:
O serviço Americanas Entrega é identificado por 3 variações de logos conforme ilustração abaixo. Esta identificação visual tem como objetivo principal o selo de garantia da qualidade e reputação do serviço de entrega oferecido ao cliente final, assim como sua fácil identificação dentro da operação dos transportadores com as quais o serviço de entrega é prestado, sendo assim de suma importância a presença destes elementos na etiqueta do serviço:
Este logo é aplicado quando o site utilizado para a compra do cliente for a Submarino.com
Este logo é aplicado quando o site utilizado para compra do cliente for a Shoptime.com
​
Atenção: Para cada entrega este logo varia conforme regras acima e não é desejável aplicar apenas um deles como padrão fixo.
Símbolos de Encaminhamento
Os símbolos de encaminhamento são ícones que representam o conjunto de serviços de envio de encomendas dos Correios. Tais símbolos tem o objetivo de identificar visualmente a linha da encomenda e são usados para os serviços conforme abaixo:
Este símbolo é aplicado quando a linha da encomenda é via Sedex.
Este símbolo é aplicado quando a linha da encomenda é via PAC.
Atenção: É expressamente proibido a inserção de qualquer logo nesta etiqueta que não seja o das marcas oficiais da Americanas reproduzidas através da marca do seu produto Americanas Entrega, contidas neste Guia.
Como obter a minha etiqueta de frete na API SkyHub?
Lista de Pedidos Aptos ao Agrupamento
1
GET /shipments/b2w/to_group
Copied!
Atualmente são disponibilizados 20 pedidos por página via API, mas nós disponibilizamos o recurso de paginação para este Endpoint.
Segue abaixo um exemplo de como realizar a paginação de pedidos aptos para agrupamento:
1
GET https://api.skyhub.com.br/shipments/b2w/to_group?offset=1
Copied!
O limite de pedidos para incluir no agrupamento atualmente é de 25.
​
Example Request:
1
curl --request GET \
2
  --url https://api.skyhub.com.br/shipments/b2w/to_group \
3
  --header 'accept: application/pdf' \
4
  --header 'x-accountmanager-key: SUAXACCOUNT' \
5
  --header 'x-api-key: SuaApiKey' \
6
  --header 'x-user-email: [email protected]'
Copied!
Request Headers:
Name
Type
Required
Description
Example
accept
String
Required
O formato que você deseja receber o retorno da requisição
application/pdf
x-user-email
String
Required
E-mail da loja
[email protected]
x-api-key
String
Required
Token da loja
SuaApiKey
x-accountmanager-key
String
Required
Código identificador da sua Integração
SUAXACCOUNT
Você também pode utilizar o Header accept como application/json para receber a etiqueta em formato Json.
Responses:
200 Success -  Postagem (PLP) Get - retorno 200 lista de pedidos aptos ao agrupamento  
Listar/Consultar PLP's
1
GET /shipments/b2w/
Copied!
Função que permite verificar na API todas as PLP's agrupadas. No retorno será possível verificar o ID da PLP e os pedidos inseridos em cada agrupamento.
Example Request:
1
curl --request GET \
2
  --url https://api.skyhub.com.br/shipments/b2w/ \
3
  --header 'accept: application/json' \
4
  --header 'content-type: application/json' \
5
  --header 'x-accountmanager-key: SUAXACCOUNT' \
6
  --header 'x-api-key: SuaAPIKey' \
7
  --header 'x-user-email: [email protected]'
Copied!
Request Headers:
Name
Type
Required
Description
Example
accept
String
Required
O formato que você deseja receber o retorno da requisição
application/json
Content-type
String
Required
​
application/json
x-user-email
String
Required
E-mail da loja
[email protected]
x-api-key
String
Required
Token da loja
SuaApiKey
x-accountmanager-key
String
Required
Código identificador da sua Integração
SUAXACCOUNT
Responses:
200 Success:   Postagem (PLP) Get - listar PLP's
Agrupar Pedidos em uma PLP
1
POST /shipments/b2w/
Copied!
 Ao efetuar o POST para agrupar a PLP retornará a ID da PLP. Com a ID da PLP será necessário imprimir a PLP.
Example Request:
1
curl --request POST \
2
  --url https://api.skyhub.com.br/shipments/b2w/ \
3
  --header 'accept: application/json' \
4
  --header 'content-type: application/json' \
5
  --header 'x-accountmanager-key: SUAXACCOUNT' \
6
  --header 'x-api-key: SuaApiKey' \
7
  --header 'x-user-email: [email protected]' \
8
  --data '{"order_remote_codes":["265358194401","265358194401","265358194401"]}'
Copied!
Request Headers:
Name
Type
Required
Description
Example
accept
String
Required
O formato que você deseja receber o retorno da requisição
application/json
Content-type
String
Required
​
application/json
x-user-email
String
Required
E-mail da loja
[email protected]
x-api-key
String
Required
Token da loja
SuaApiKey
x-accountmanager-key
String
Required
Código identificador da sua Integração
SUAXACCOUNT
Request Body:
1
{
2
  "order_remote_codes": [
3
    "265358194401",
4
    "265358194401",
5
    "265358194401"
6
  ]
7
}
Copied!
Responses:
200 Success:  "message": "Plp 14 agrupada com sucesso."
​
Desagrupar PLP:
1
DELETE /shipments/b2w/
Copied!
Example Request:
1
curl --request DELETE \
2
  --url https://api.skyhub.com.br/shipments/b2w/ \
3
  --header 'accept: application/json' \
4
  --header 'content-type: application/json' \
5
  --header 'x-accountmanager-key: SUAXACCOUNT' \
6
  --header 'x-api-key: SuaApiKey' \
7
  --header 'x-user-email: [email protected]'
Copied!
Request Headers:
Name
Type
Required
Description
Example
accept
String
Required
O formato que você deseja receber o retorno da requisição
application/json
Content-type
String
Required
​
application/json
x-user-email
String
Required
E-mail da loja
[email protected]
x-api-key
String
Required
Token da loja
SuaApiKey
x-accountmanager-key
String
Required
Código identificador da sua Integração
SUAXACCOUNT
Request Body:
1
{
2
  "plp_id": "14"
3
}
Copied!
200 - Success:  "message": "Plp 14 desagrupada com sucesso."
​
Imprimir PLP - PDF
1
GET /shipments/b2w/view?plp_id={CODE}
Copied!
Para imprimir a PLP (visualizar ela diretamente para impressão seja por PDF ou JSON) é necessário primeiro efetuar o agrupamento da PLP para receber o ID e passar no Endpoint.
Example Request:
1
curl --request GET \
2
  --url 'https://api.skyhub.com.br/shipments/b2w/view?plp_id={CODE}' \
3
  --header 'accept: application/pdf' \
4
  --header 'content-type: application/json' \
5
  --header 'x-accountmanager-key: SUAXACCOUNT' \
6
  --header 'x-api-key: SuaApiKey' \
7
  --header 'x-user-email: [email protected]'
Copied!
Request Headers:
Name
Type
Required
Description
Example
accept
String
Required
O formato que você deseja receber o retorno da requisição
application/json
Content-type
String
Required
​
application/json
x-user-email
String
Required
E-mail da loja
[email protected]
x-api-key
String
Required
Token da loja
SuaApiKey
x-accountmanager-key
String
Required
Código identificador da sua Integração
XACCOUNT
Responses:
200 - Success:  "Response": PDF ou Json da PLP
Para imprimir a etiqueta na impressora térmica, será necessário baixar o arquivo Json da etiqueta utilizando o parâmetro: Accept: application/json. Através dele você receberá o Json da etiqueta de deverá montar o layout para a impressão