SkyHub API

orders

Pedidos

orders Overview

{
  "code": "Marketplace-000000001",
String

Código de identificação do pedido. Esse código é gerado pela SkyHub e consiste de duas partes separadas por um "-". A primeira parte contém o nome do site que o pedido foi realizado (ex: "Submarino"), a segunda parte contém o código do pedido gerado pelo marketplace. Caso você precise, entre em contato com o suporte da SkyHub para ter acesso a lista de nomes de todos os sites que podem aparecer na primeira parte do código.

IMPORTANTE: O nome do site que o pedido foi realizado pode conter espaço. Exemplo: "Lojas Americanas-00001".

  "channel": "Marketplace",
String

Canal de vendas onde o pedido foi 'originado' (marketplace). Ex: 'Lojas Americanas', 'Submarino', 'Extra', 'Walmart', 'Mercadolivre'

  "placed_at": "2016-06-10T09:46:04-03:00",
String (Date-time)

Data e hora de criação do pedido

  "updated_at": "2016-06-15T09:46:04-03:00",
String (Date-time)

Data e hora de atualização do pedido

  "total_ordered": 107.68,
Number (Float)

Valor total do pedido

  "interest": 2.69,
Number (Float)

Valor de juros do pedido

  "shipping_cost": 15.0,
Number (Float)

Valor do frete

  "shipping_method": "Econômico",
String

Método de envio do pedido. Alguns marketplaces só liberam o endereço de entrega do pedido depois da confirmação de pagamento. Então para pedidos aguardando confirmação de pagamento o campo método de envio pode não aparecer.

  "estimated_delivery": "2016-06-20T09:46:04-03:00",
String (Date-time)

Data estimada de entrega

  "shipping_address": {
  "shipping_address": { ... }
Object

Endereço de entrega. Alguns marketplaces só liberam o endereço de entrega do pedido depois da confirmação de pagamento. Então para pedidos aguardando confirmação de pagamento o campo endereço de entrega pode não aparecer.

    "street": "Rua Sacadura Cabral",
String

Rua/Avenida

    "number": "130",
String

Número

    "detail": "foo",
String

Complemento

    "neighborhood": "Centro",
String

Bairro

    "city": "Rio de Janeiro",
String

Cidade

    "region": "RJ",
String

Estado (sigla da UF)

    "country": "BR",
String

País (código no formato ISO3166)

    "postcode": "20081262",
String

CEP

    "reference": "próximo hospital municipal",
String

Referência

    "complement": "Bloco A - Apto 53",
String

Complemento do Endereço

    "phone": "11 00000000",
String

numero de telefone

    "secondary_phone": "11 000000000"
String

Número de telefone

  },
  "billing_address": {
  "billing_address": { ... }
Object

Endereço de cobrança

    "street": "Rua Sacadura Cabral",
String

Rua/Avenida

    "number": "130",
String

Número

    "detail": "Sala 404",
String

Complemento + Referência

    "neighborhood": "Centro",
String

Bairro

    "city": "Rio de Janeiro",
String

Cidade

    "region": "RJ",
String

Estado (sigla da UF)

    "country": "BR",
String

País (código no formato ISO3166)

    "postcode": "20081262",
String

CEP

    "reference": "próximo hospital municipal",
String

Referência

    "complement": "Bloco A - apto 53",
String

Complemento do Endereço

    "full_name": "foo",
String

Nome do pagador

    "secondary_phone": "11 000000000",
String

Numero de Tefefone

    "phone": "11 00000000"
String

Numero de Telefone

  },
  "customer": {
  "customer": { ... }
Object

Dados do cliente

    "name": "Comprador Exemplo",
String

Nome

    "email": "comprador@exemplo.com.br",
String

Email

    "date_of_birth": "1993-03-03",
String (Date)

Data de nascimento

    "gender": "male",
String

Sexo (male ou female)

    "vat_number": "76860543817",
String

CPF ou CNPJ

    "phones": [
    "2137223902",
    "2137223902",
    "2137223902"
  ],
Array

Lista de telefones

    "state_registration": "100000000001"
String

Inscrição estadual, presente em pedidos realizados por PJ

  },
  items: [
Array

Itens do pedido

    {
    { ... }
Object

Item

      "id": "sku001-01",
String

Identificador do item. Se o produto possuir variação, será o sku da variação. Se o item não possuir variação, será o sku do produto.

      "product_id": "SEU SKU",
String

Identificador (sku) do produto.

      "name": "Produto exemplo",
String

Nome do produto

      "qty": 1,
Integer

Quantidade

      "original_price": 99.99,
Number (Float)

Preço original

      "special_price": 89.99,
Number (Float)

Preço de venda

      "shipping_cost": "2.0"
String

Valor do frete por produto

    }
  ]
  "status": {
  "status": { ... }
Object

Status do pedido

    "code": "shipped",
String

Código de identificação do status

    "label": "Pedido enviado",
String

Descrição do status

    "type": "SHIPPED"
String

Tipo do status (StatusType)

  },
  invoices: [
Array

Informações de faturas

    {
    { ... }
Object

Invoice

      "key": "44444444444444444444444444444444444444444444",
String

Chave da NFe

      "number": "444444444",
String

Número

      "line": "444",
String

Número de série

      "issue_date": "2016-06-13T16:43:07-03:00"
String (Date-time)

Data da nota

    }
  ]
  shipments: [
Array

Informações de envios

    {
    { ... }
Object

Shipment

      "code": "ENVIO-54321",
String

Código de identificação do envio

      items: [
Array

Itens do envio

        {
        { ... }
Object

ShipmentItem

          "sku": "SEU SKU",
String

Identificador do item enviado

          "qty": 1
Integer

Quantidade do item enviado

        }
      ]
      tracks: [
Array

Informações de rastreamento

        {
        { ... }
Object

ShipmentTrack

          "code": "SS123456789BR",
String

Código de rastreamento da transportadora

          "carrier": "Direct Express logistica Integrada S/A",
String

Transportadora

          "method": "Direct E-Direct"
String

Método de envio

        }
      ]
    }
  ]
  "sync_status": "SYNCED",
String

Status de sincronização do pedido. Valores possíveis: "SYNCED", "NOT_SYNCED" e "ERROR"

  "calculation_type": "b2wentregacorreios",
String

Tipo de Calculo do Frete , Exemplo B2WENTREGA

  "shipping_carrier ": "Direct E-Direct",
String

Transportadora de envio do pedido. Alguns marketplaces só liberam o endereço de entrega do pedido depois da confirmação de pagamento. Então para pedidos aguardando confirmação de pagamento o campo método de envio pode não aparecer.

  tags: [
Array

Campo informa se pedido pode conter fraude

    {
    { ... }
Object

New Definition

      "tags": [
    "fraud_risk_detected",
    "fraud_risk_detected",
    "fraud_risk_detected"
  ]
Array

Campo informa se pedido pode conter fraude

    }
  ]
  "payments": {
  "payments": { ... }
Object
    "value": 29.9,
Number
    "transaction_date": "foo",
String

Data da Transação

    "status": "foo",
String
    "sefaz": {
    "sefaz": { ... }
Object

retorno dos pedidos os dados da SEFAZ quando é realizado uma compra utilizando cartão de crédito e os sellers precisam desses dados no momento de faturar o pedido

      "type_integration": "1",
String
      "payment_indicator": "1",
String
      "name_payment": "Cartão de Crédito",
String
      "name_card_issuer": "Visa",
String
      "id_payment": "3",
String
      "id_card_issuer": "01"
String
    },
    "parcels": "2",
String

Parcelas

    "method": "credit_card",
String
    "description": "Cartao",
String

Emissor do Cartão

    "card_issuer": "foo",
String

Emissor do Cartão

    "autorization_id": "foo"
String

Identificador da autorização

  },
  "estimated_delivery_shift": "2016-06-20T09:46:04-03:00"
String (Date-time)
}

orders Endpoints