SkyHub API
SkyHub PortalApi Explorer
  • Sobre a API SkyHub
  • Comunicados
    • Comunicados 2025
      • Criação e atualização de produtos e variações no Marketplace
      • Atualizações dos pedidos no Marketplace
      • Etiquetas Americanas Entrega
      • Alteração na atualização de pedidos para 'SHIPPED'
      • Campos descontinuados no JSON de pedidos
    • Comunicados 2024
      • Novo canal de atendimento
      • Remoção do array "categories" na busca de produtos
      • Novos campos no JSON de Pedidos
    • Comunicados 2023
      • Personalização de Preço Por Marca
      • Obrigatoriedade de body em métodos POST/PUT/PATCH
    • Comunicados 2022
      • Inativação do endpoint /categories
      • MultiCD: Substituição do store_status pelo statuses
      • Bloqueio de requisições com x-account inválido - Prazo não definido
      • Mudança na atualização da chave da nota fiscal
    • Comunicados 2021
      • Código de homologação da Anatel
      • Atributo Garantia
      • Envio de Imagens para o Mktp B2W
      • Mudança response HTTP /delivery
      • Mudança Faturamento Pedidos B2W Entrega Direct
      • Limite de Categorias na SkyHub
      • Limite de Imagens na SkyHub
      • Mudança response HTTP /invoice e /shipments
      • Mudança Infraestrutura SkyHub
      • Protocolo HTTP/HTTPS
      • Consumo de Pedidos | Preço
      • X-Accountmanager-Key
    • Comunicados 2020
      • Requisição Duplicada
      • Requisição Contas Inativas
      • Entrega Agendada by Direct
      • Headers para Requisições
      • Consumo de Pedidos
      • Atributo Data Faturamento
      • Atributo Data Enviado
  • Guias API SkyHub
    • Autenticação e formato dos dados
    • Códigos de retorno (HTTP status)
    • Limite de requisições
    • Melhores práticas
  • Recursos
    • Produtos
    • Rehub
    • Pedidos
    • Erros
    • Etiquetas
    • Fulfillment
    • Multi Origem
    • Perguntas e Respostas
    • SAC
    • Credenciamento
  • Processo de Homologação
    • Perfil para Homologação
    • Pré-Requisitos
    • Validações
      • Produtos
      • Conexão via API (Rehub)
      • Pedidos
      • Etiqueta (PLP)
    • Melhores Práticas
      • Produtos
      • Pedidos
      • Etiqueta PLP
  • Perguntas Frequentes
  • Produtos
    • > Integração Produto
    • Categorização
      • Consultar lista de Categorias
      • Consultar atributos por categoria
    • Consultar Marcas
    • Criação de Produto
      • Produto Simples
      • Produto Variável
    • Atualização de Produto
      • Produto Simples
      • Produto Variável
    • Consulta de Produto
      • Produto Simples e Variável
      • Variação de Produto
    • Exclusão de Produto
      • Produto Simples e Variável
      • Variação de Produto
    • Outros Recursos de Produtos
      • Filtros de Consultas
      • Endpoint Atributos
      • Consulta URL
        • URL Variações
  • Rehub
    • > Integração Rehub
    • Rehub - Ações de Produto
    • Resultado das Ações de Produto
  • Pedidos
    • > Integração Pedido
    • Criação e Aprovação de Pedido Teste
    • Atualização de Pedidos
    • Faturamento Pedido - Americanas Entrega Direct
    • Consumo de Pedidos - Queues
    • Notificação de Pedidos
    • Consulta de Pedidos
  • Erros
    • Consulta de Erros de Sincronização e Produção
  • Etiquetas Americanas Entrega
    • > Integração Etiqueta
    • Etiqueta de Frete - Direct
      • Padrão da Etiqueta Direct
      • Direct - Processos via API
      • Etiqueta Clique e Retire - Direct
    • Etiqueta de Frete - Correios
      • Padrão da Etiqueta Correios
      • Correios - Processos via API
      • Etiqueta Clique e Retire - Correios
  • Frete
    • > Integração Frete
    • Como Homologar
    • Melhores Práticas
  • Fulfillment
    • > Integração Fulfillment
    • Consulta de Estoque
    • Identificando Pedido
    • Faturamento
    • Consulta de Notas
    • Faturador
      • Regra Fiscal
      • Regras Tributárias
      • Relacionamento entre Produto e Regra
        • Produto Simples
        • Produto Variável
  • Multi Origem
    • > Integração Multi Origem
    • Solicitar Credenciais
    • Criar e Consultar CD
    • Criação e Atualização de Estoque
    • Pedido Multi Origem
    • Etiqueta Multi Origem
Powered by GitBook
On this page
  • Fluxo do andamento do pedido
  • GET - Identificando um pedido Americanas Entrega Direct
  • POST - Atualizando para faturado (INVOICED) um pedido Americanas Entrega Direct
  1. Pedidos

Faturamento Pedido - Americanas Entrega Direct

Nesta seção mostraremos como deve ser feito o faturamento de pedidos pertencentes ao serviço Americanas Entrega Direct

PreviousAtualização de PedidosNextConsumo de Pedidos - Queues

Last updated 2 years ago

Pedidos Americanas Entrega Direct exigem o envio do arquivo XML da nota fiscal.

Nesse guia vamos abordar como identificar pedidos que pertencem a este serviço (Direct), sobre o fluxo a ser seguido e como a requisição de faturamento deve ser realizada no endpoint /invoice.

Fluxo do andamento do pedido

O fluxo de uma entrega Direct seguirá após o recebimento do status de aprovado (APPROVED), encaminhado para a API através do marketplace.

Para o serviço Americanas Entrega Direct apenas o status de faturado (INVOICED) será de responsabilidade do lojista, enquanto que os demais (status) - enviado (SHIPPED) e entregue (DELIVERED) - serão atualizados na API de forma automática pelo próprio marketplace e caberá a plataforma/ERP o consumo destas informações, ação realizada pelo endpoint /queues/orders.

GET - Identificando um pedido Americanas Entrega Direct

O consumo de pedidos traz informações importantes para o correto ciclo de vida que uma entrega deve seguir.

Para identificação de um pedido pertencente ao serviço Americanas Entrega Direct deverá ser observado o valor b2wentregadirect para o campo calculation_type. Abaixo temos um exemplo para visualização deste campo:

Atenção: O marketplace possui o Americanas Fulfillment e os pedidos gerados para este serviço também contarão com o valor b2wentregadirectpara o campo calculation_type, porém quando se tratar de um pedido Fulfillment será validado o campo shipping_method.

Para maiores informações sobre a identificação de um pedido Americanas Fulfillment consulte o guia Americanas Fulfillment - Identificando Pedido.

POST - Atualizando para faturado (INVOICED) um pedido Americanas Entrega Direct

O faturamento do pedido gerado para o serviço Americanas Entrega Direct deve ser realizado através de um POST para o endpoint padrão para envio do invoice:

https://api.skyhub.com.br/orders/{code}/invoice

Request headers:

Key
Value

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

multipart/form-data

Para o faturamento de pedidos Direct é obrigatório o envio do arquivo XML da nota fiscal e por este motivo é imprescindível a utilização do valor multipart/form-data para o header Content-Type, pois este será o responsável por mostrar para a API que um arquivo foi indexado à requisição.

Request body:

--form 'status="order_invoiced"' \
--form 'file=@"/path/to/file"' \
--form 'issue_date="AAAA-MM-DDTHH:MM:SS-03:00"' \
--form 'volume_qty="1"'

Os campos issue_date e volume_qty são opcionais na requisição apresentada.

Caso opte por não enviá-los, é importante estar ciente de que a API assumirá para estes campos os seguintes valores:

  • issue_date: Serão assumidos data e hora do momento em que a API enviar a requisição de faturamento ao marketplace;

  • volume_qty: Por padrão, se a API não receber este campo será assumido para o mesmo o valor igual a 1 (um).

Não devem ser solicitadas mais etiquetas do que as necessárias para a entrega.

Caso um pedido contenha 1 (uma) unidade, por exemplo, obrigatoriamente deverá ser informado o valor 1 para o campo volume_qty.

Example request:

curl --location --request POST 'https://api.skyhub.com.br/orders/Lojas Americanas-1000000000004/invoice' \
--header 'X-User-Email: email_de_usuario' \
--header 'X-Api-Key: token_de_integracao de sua conta SkyHub' \
--header 'X-Accountmanager-Key: token_account único de cada Plataforma/ERP' \
--header 'Accept: application/json' \
--header 'Content-Type: multipart/form-data' \
--form 'status="order_invoiced"' \
--form 'file=@"/C:/Path/Documents/NFAmericanas1000000000004.xml"' \
--form 'issue_date="2023-03-27T12:30:00-03:00"' \
--form 'volume_qty="1"'

Response esperado:

204 [Success] - No content

Ressaltando que para pedidos Americanas Entrega Direct a continuidade do fluxo do pedido após o faturamento será executada pelo marketplace Americanas, não sendo necessário que o lojista envie as atualizações dos status de enviado e entregue.