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
    • 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
  • Perguntas e Respostas Americanas
    • > Integração Q&A
    • Perguntas e Respostas (Q&A)
  • SAC
    • > Integração SAC
    • Listar SAC
    • Chats
    • Consulta de Itens
    • Instâncias geradas de SAC
    • Actions
    • Refunds
Powered by GitBook
On this page
  • POST - Criando um pedido
  • Criando um pedido teste (status NEW)
  • POST - Aprovando um pedido teste (status APPROVED)
  • POST - Criando pedido para o Fulfillment
  • Pedido Fulfillment
  1. Pedidos

Criação e Aprovação de Pedido Teste

Para contas de desenvolvimento/homologação é possível criar e aprovar pedidos. Esta seção traz orientações para a criação e aprovação de pedidos

Previous> Integração PedidoNextAtualização de Pedidos

Last updated 1 year ago

As operações descritas abaixo não estão disponíveis para contas em produção.

Caso ainda não possua um ambiente de teste para a homologação de seu sistema, consulte a guia .

POST - Criando um pedido

Como descrito em , durante o processo de homologação de um sistema são solicitados os passos de criação, consumo e notificação de pedidos.

Criando um pedido teste (status NEW)

Para realizar a criação de um pedido via API deverá ser utilizado o método POST para o seguinte endpoint:

https://api.skyhub.com.br/orders

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

application/json

Request body:

{
    "order": {
        "channel": "Marketplace",
        "items": [
            {
                "id": "{SKU da Venda}",
                "qty": 1,
                "original_price": 8.45,
                "special_price": 8.45
            }
        ],
        "customer": {
            "name": "Nome do Comprador",
            "email": "comprador@exemplo.com.br",
            "date_of_birth": "1995-01-01",
            "gender": "male",
            "vat_number": "12312312309",
            "phones": [
                "8899999999"
            ]
        },
        "billing_address": {
            "street": "Rua de Teste",
            "number": "1234",
            "detail": "Ponto de Referência",
            "neighborhood": "Bairro",
            "city": "Cidade",
            "region": "UF",
            "country": "BR",
            "postcode": "90000000"
        },
        "shipping_address": {
            "street": "Rua de teste",
            "number": "1234",
            "detail": "Ponto de referência teste",
            "neighborhood": "Bairro teste",
            "city": "Cidade de teste",
            "region": "UF",
            "country": "BR",
            "postcode": "90000000"
        },
        "payments": [
        {
            "method": "skyhub_payment",
            "description": "Skyhub",
            "parcels": 1,
            "value": 8.45
         }
        ],
        "shipping_method": "Transportadora",
        "estimated_delivery": "AAAA-MM-DD",
        "shipping_calculation_type": "Método do Cálculo",
        "shipping_cost": 0.0,
        "interest": 0.0,
        "discount": 0.0
    }
}

No objeto items é necessário informar o SKU adquirido na compra. Isto é, caso deseje simular um pedido realizado para um produto que contém variações, a criação requer que seja informado o SKU da variação e não do produto pai/agrupador.

Example request:

curl --location --request POST 'https://api.skyhub.com.br/orders' \
--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: application/json' \
--data-raw '{
    "order": {
        "channel": "Lojas Americanas",
        "items": [
            {
                "id": "2023001",
                "qty": 1,
                "original_price": 39.90,
                "special_price": 39.90
            }
        ],
        "customer": {
            "name": "João dos Santos",
            "email": "comprador@exemplo.com.br",
            "date_of_birth": "1989-01-01",
            "gender": "male",
            "vat_number": "23455567899",
            "phones": [
                "11 99999-9999"
            ]
        },
        "billing_address": {
            "street": "Avenida Paulista",
            "number": "1234",
            "detail": "Próximo ao museu",
            "neighborhood": "Bela Vista",
            "city": "São Paulo",
            "region": "SP",
            "country": "BR",
            "postcode": "90000000"
        },
        "shipping_address": {
            "street": "Avenida Paulista",
            "number": "1000",
            "detail": "Ao lado da cafeteria",
            "neighborhood": "Bela Vista",
            "city": "São Paulo",
            "region": "SP",
            "country": "BR",
            "postcode": "90000000"
        },
        "payments": [
            {
                "method": "CREDIT_CARD",
                "description": "SkyHub",
                "parcels": 1,
                "value": 39.90
            }
        ],
        "shipping_method": "Courier",
        "estimated_delivery": "2023-03-30",
        "shipping_calculation_type": "b2wentregadirect",
        "shipping_cost": 0,
        "interest": 0,
        "discount": 0
    }
}'

É possível determinar numerações específicas para os pedidos criados. Para tal, basta incluir o campo "remote_code" no array ORDER.

Durante a criação de pedido é possível enviar o método de cálculo do frete, feito através do campo "shipping_calculation_type". O retorno dessa informação no consumo do endpoint /queues/orders será no campo "calculation_type".

Response esperado:

201 [Success] - Created

POST - Aprovando um pedido teste (status APPROVED)

O ciclo de vida de um pedido comum é iniciado com a sua criação (status NEW) e o próximo passo é a sua aprovação (status APPROVED). No ambiente de produção estes dois status (NEW e APPROVED) são gerados no marketplace, porém em homologação/ambiente de teste, além da criação, é possível realizar também a aprovação do pedido.

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

Request body:

{
    "status": "payment_received"
}

Example request:

curl --location --request POST 'https://api.skyhub.com.br/orders/Lojas Americanas-1000000000000/approval' \
--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: application/json' \
--data '{
    "status": "payment_received"
}'

Response esperado:

204 [Success] - No content

POST - Criando pedido para o Fulfillment

Existem recursos disponíveis para homologação que requerem a criação de pedidos contendo campos específicos, como é o caso da homologação para o serviço Fulfillment.

Pedido Fulfillment

Criando um pedido teste para o serviço Fulfillment

Para homologação do recurso Fulfillment é imprescindível a identificação de pedidos que se enquadrem neste serviço.

curl --location --request POST 'https://api.skyhub.com.br/orders' \
--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: application/json' \
--data-raw '{
    "order": {
        "channel": "Lojas Americanas",
        "items": [
            {
                "id": "2023001",
                "qty": 1,
                "original_price": 39.90,
                "special_price": 39.90
            }
        ],
        "customer": {
            "name": "João dos Santos",
            "email": "comprador@exemplo.com.br",
            "date_of_birth": "1989-01-01",
            "gender": "male",
            "vat_number": "23455567899",
            "phones": [
                "11 99999-9999"
            ]
        },
        "billing_address": {
            "street": "Avenida Paulista",
            "number": "1234",
            "detail": "Próximo ao museu",
            "neighborhood": "Bela Vista",
            "city": "São Paulo",
            "region": "SP",
            "country": "BR",
            "postcode": "90000000"
        },
        "shipping_address": {
            "street": "Avenida Paulista",
            "number": "1000",
            "detail": "Ao lado da cafeteria",
            "neighborhood": "Bela Vista",
            "city": "São Paulo",
            "region": "SP",
            "country": "BR",
            "postcode": "90000000"
        },
        "payments": [
            {
                "method": "CREDIT_CARD",
                "description": "SkyHub",
                "parcels": 1,
                "value": 39.90
            }
        ],
        "shipping_method": "B2W Fulfillment",
        "estimated_delivery": "2023-03-15",
        "shipping_calculation_type": "b2wentregadirect",
        "shipping_cost": 0,
        "interest": 0,
        "discount": 0
    }
}'

Para informações sobre a homologação do recurso Fulfillment, consulte a guia a seguir:

A aprovação em ambiente de teste requer os e se dá através de um POST no endpoint:

O code deve ser substituído pelo código do pedido, visualizado após o .

No ambiente de teste é possível simular um pedido Fulfillment e para isto será necessário seguir o padrão disponibilizado na seção com atenção para o campo shipping_method:

Processo de Homologação
Integração Pedido
consumo
> Integração Fulfillment
headers apresentados acima
Criação de Pedido