Os tópicos presentes neste Guia Técnico possibilitam o correto desenvolvimento e garante a padronização de todas as etiquetas emitidas para os sellers que utilizam o serviço de frete B2W 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.
A etiqueta do B2W 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:
Logo da Marca (B2W Entrega)
QR Code
Símbolo de Encaminhamento
Informação de Volumes
Contrato
Nota Fiscal
Número do Pedido
Número da PLP
Código de Rastreamento
Código de Barras (AWB)
Dados de Recebedor (Recebedor, Assinatura, Documento)
Dados de Destinatário (Nome, Endereço, Bairro, Complemento, CEP, Cidade e UF)
Código de Barras do CEP
Dados do Remetente (Vendedor, Endereço, CEP, Cidade e UF)
As medidas de toda a etiqueta, assim como o devido posicionamento de todos os seus campos e elementos, devem seguir exatamente as cotas abaixo:
Para o desenvolvimento da etiqueta do B2W 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:
Todas as fontes, tamanhos e suas aplicações presentes em todos os campos que são parte integrante da etiqueta do B2W Entrega seguem um padrão referenciado pelos transportadores do serviço e sua aplicação deve ser exatamente conforme descrito na tabela abaixo:
O serviço B2W 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:
Atenção: Para cada entrega este logo varia conforme regras acima, e não é desejável aplicar apenas um deles como padrão fixo.
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:
Atenção: É expressamente proibido a inserção de qualquer logo nesta etiqueta que não seja o das marcas oficiais da B2W reproduzidas através da marca do seu produto B2W Entrega, contidas neste Guia.
GET /shipments/b2w/to_group
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:
GET https://api.skyhub.com.br/shipments/b2w/to_group?offset=1
O limite de pedidos para incluir no agrupamento atualmente é de 25.
curl --request GET \--url https://api.skyhub.com.br/shipments/b2w/to_group \--header 'accept: application/pdf' \--header 'x-accountmanager-key: SUAXACCOUNT' \--header 'x-api-key: SuaApiKey' \--header 'x-user-email: seu@email.com'
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 | seu@email.com |
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.
200 Success - Postagem (PLP) Get - retorno 200 lista de pedidos aptos ao agrupamento
GET /shipments/b2w/
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.
curl --request GET \--url https://api.skyhub.com.br/shipments/b2w/ \--header 'accept: application/json' \--header 'content-type: application/json' \--header 'x-accountmanager-key: SUAXACCOUNT' \--header 'x-api-key: SuaAPIKey' \--header 'x-user-email: seu@email.com'
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 | seu@email.com |
x-api-key | String | Required | Token da loja | SuaApiKey |
x-accountmanager-key | String | Required | Código identificador da sua Integração | SUAXACCOUNT |
200 Success: Postagem (PLP) Get - listar PLP's
POST /shipments/b2w/
Ao efetuar o POST para agrupar a PLP retornará a ID da PLP. Com a ID da PLP será necessário recuperar a PLP.
Example Request:
curl --request POST \--url https://api.skyhub.com.br/shipments/b2w/ \--header 'accept: application/json' \--header 'content-type: application/json' \--header 'x-accountmanager-key: SUAXACCOUNT' \--header 'x-api-key: SuaApiKey' \--header 'x-user-email: seu@email.com' \--data '{"order_remote_codes":["265358194401","265358194401","265358194401"]}'
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 | seu@email.com |
x-api-key | String | Required | Token da loja | SuaApiKey |
x-accountmanager-key | String | Required | Código identificador da sua Integração | SUAXACCOUNT |
Request Body:
{"order_remote_codes": ["265358194401","265358194401","265358194401"]}
Responses:
200 Success: "message": "Plp 14 agrupada com sucesso."
DELETE /shipments/b2w/
Example Request:
curl --request DELETE \--url https://api.skyhub.com.br/shipments/b2w/ \--header 'accept: application/json' \--header 'content-type: application/json' \--header 'x-accountmanager-key: SUAXACCOUNT' \--header 'x-api-key: SuaApiKey' \--header 'x-user-email: seu@email.com'
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 | seu@email.com |
x-api-key | String | Required | Token da loja | SuaApiKey |
x-accountmanager-key | String | Required | Código identificador da sua Integração | SUAXACCOUNT |
Request Body:
{"plp_id": "14"}
200 - Success: "message": "Plp 14 desagrupada com sucesso."
GET /shipments/b2w/view?plp_id={CODE}
Para recuperar a PLP é necessário primeiro efetuar o agrupamento da PLP para receber o ID e passar no Endpoint.
Example Request:
curl --request GET \--url 'https://api.skyhub.com.br/shipments/b2w/view?plp_id={CODE}' \--header 'accept: application/pdf' \--header 'content-type: application/json' \--header 'x-accountmanager-key: SUAXACCOUNT' \--header 'x-api-key: SuaApiKey' \--header 'x-user-email: seu@email.com'
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 | seu@email.com |
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