Atualizações dos pedidos no Marketplace

Toda solução integrada à nossa API, seja própria ou um ERP/Plataforma, deverá se adequar a essa alteração.

Pedidos

O padrão de código para pedidos será alterado. Durante a migração, os padrões antigo e novo coexistirão. Veja alguns exemplos:

Padrão novo (Lojas Americanas-9999999999999-99)

Lojas Americanas-1517940500554-01

Padrão antigo

Lojas Americanas-201036063223000

Status de pedido

O status de pedido agora terá uma lista pré definida, sendo eles:

Código
Descrição
Interação

book_product

Pagamento Pendente

-

has_incident

Com Incidente (OMNIK)

-

payment_received

Aprovado

POST /orders/{CODIGO}/approval

confirm_stock

Aguardando confirmação de Estoque (OMNIK)

-

waiting_payment

Pagamento Pendente (waiting_payment) (OMNIK)

-

processing_store

Aguardando Retirada na Loja (OMNIK)

-

confirmed_stock

Estoque Confirmado (OMNIK)

-

payment_overdue

Boleto Vencido (OMNIK)

-

order_shipped

Pedido Enviado (OMNIK)

POST /orders/{CODIGO}/shipments

order_invoiced

Faturado

POST /orders/{CODIGO}/invoice

shipment_exception

Exceção de Entrega (OMNIK)

POST /orders/{CODIGO}/shipment_exception

order_canceled

Cancelado (OMNIK)

POST /orders/{CODIGO}/cancel

returned

Pedido com itens retornados (OMNIK)

-

complete

Completo (entregue) (OMNIK)

POST /orders/{CODIGO}/delivery

Exemplos de interação

curl --location 'https://api.skyhub.com.br/orders/Lojas Americanas-1518430501155-01/invoice' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Accountmanager-Key: Api' \
--header 'X-Api-Key: {TOKEN DO SELLER}' \
--header 'X-User-Email: {EMAIL DO SELLER}' \
--data '{
    "status": "order_invoiced",
    "invoice": {
        "key": "99999999999999999999999999999999999999999999",
        "volume_qty": 1,
        "issue_date": "2025-03-20T15:50:33.782Z"
    }
}'

curl --location 'https://api.skyhub.com.br/orders/Lojas Americanas-1518430501155-01/delivery' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Accountmanager-Key: Api' \
--header 'X-Api-Key: {TOKEN DO SELLER}' \
--header 'X-User-Email: {EMAIL DO SELLER}' \
--data '{
    "status": "complete",
    "delivered_date": "13/03/2025"
}'

curl --location 'https://api.skyhub.com.br/orders/Lojas Americanas-1518430501155-01/shipments' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Accountmanager-Key: Api' \
--header 'X-Api-Key: {TOKEN DO SELLER}' \
--header 'X-User-Email: {EMAIL DO SELLER}' \
--data '{
    "status": "order_shipped",
    "shipment": {
        "code": "{code}",
        "delivered_carrier_date": "2025-03-20T15:50:33.782Z",
        "items": [
            {
                "sku": "4295312",
                "qty": 5
            }
        ],
        "track": {
            "code": "{Código de rastreio}",
            "carrier": "Correios",
            "method": "SEDEX",
            "url": "www.correios.com.br"
        }
    }

Status INVOICED

Como era antes?

Campo volume_qty:

Era possível informar um volume_qty para cada faturamento.

{
    "status": "order_invoiced",
    "invoice": {
        "key": "99999999999999999999999999999999999999999999",
        "volume_qty": 1,
        "issue_date": "AAAA-MM-DDTHH:MM:SS-03:00"
    }
}

Como será agora?

Campo volume_qty:

O campo volume_qty, será descontinuado, sendo sempre considerado como 1 por faturamento.

curl --location --request POST 'https://api.skyhub.com.br/orders/Lojas Americanas-1000000000000/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: application/json' \
--data '{
    "status": "order_invoiced",
    "invoice": {
        "key": "99999999999999999999999999999999999999999999",
        "issue_date": "2023-03-10T12:30:00-03:00"
    }
}'

Em caso de dúvidas, estamos à disposição através do nosso canal de atendimento.

Last updated