Webhook de Orders


Informe a {{CUSTOMER_API_BASE_URL}} e o {{x-api-key}} de desenvolvimento e produção para cadastramento na OPABOX.
Este api base deve ser HTTPS

Dúvidas? contato@opabox.com.br

Webhook Orders

Webhook Orders | Retorna o objeto de order realizada no sistema OPABOX

Campos opcionais serão enviados como Null caso não possuírem valor na base.

post 
{{CUSTOMER_API_BASE_URL}}/orders

Header

Field Type Description
x-api-key String

Token fornecido pelo cliente para a webhook de orders

Body tipo Json

Field Type Description
id String

Identificador da transação.
product_list Object[]

Lista de produtos comprados
  id string

Id do produto
  purchased_quantity number

Quantidade deste produto comprada
  ean string

Código de barras do produto
  sku string

Código interno do produto
  price number

Preço da unidade do produto
  name string

nome do produto
  options_chosen optional Object[]

escolhas food
    id string

id do grupo de opcoes
    label string

nome do grupo de opcoes
    choices optional Object[]

escolhas no grupo
      id string

id da escolha
      label string

nome da escolha
      quantity number

quantidade da escolha
      price Object[]

preco da unicade de escolha
  presentations optional Object[]

apresentacoes do produto
  shopper_price number

preço aplicado pelo shopper
purchased_products_value number

Valor dos produtos comprados
delivery_fee optional number

Valor da taxa de entrega
service_fee optional number

Valor do seriço cobrado do cliente
total_interest optional number

Juros aplicados
voucher_discount optional number

Valor do cupom de desconto
total_price number

Preço total
customer Object

Consumidor
  cpf string

CPF
  id string

Id do cliente
  name string

Nome do cliente
  phone string

Telefone do cliente
transaction_date integer

Data da transação em Epoch Timestamp
company_external_id string

Id da loja filha que realizou a venda
payment_type string

Cartão de Crédito ou Outros
other_payment_type Object

Detalhe de outro tipo de pagamento
  input Object

entrada de dado
    name string

nome
    default_value string

valor digitado pelo consumidor
  name string

nome do tipo de pagamento
installments integer

Parcelas
card_flag optional string

Bandeira do Cartão utilizado
type_shipping string

Tipo de entrega. Agendada ou Express
schedule_date optional integer

Data de agendamento em epoch Timestamp
schedule_info optional integer

Data de agendamento descritiva
delivery_address Object

Endereço de entrega
  id string

Id do endereço
  cep string

Cep
  city string

Cidade
  country string

País
  street string

Rua
  state string

Estado
  street_number string

Número
  vicinity string

Bairro
  more string

Complemento
status integer

1 - Novo Pedido
2 - Pagamento confirmado
3 - Pagamento Rejeitado
4 - Em Preparo
5 - Em Transporte
6 - Entregue
7 - Cancelado pelo Lojista
8 - Cancelado pelo Consumidor
9 - Aguardando Retirada pelo Consumidor
10 - Rejeitado pelo Consumidor
11 - Aguardando Transportador
22 - Pagamento na Entrega
will_delivery boolean

Pedido para entrega

 
{
    "id": "46ad3bd0-185f-11eb-8e95-fb0cf7bfccb9",
    "product_list": [
        {
            "id": "e0399e00-b1ff-11e9-84e9-dbe518c2b47c",
            "purchased_quantity": 1,
            "ean": null,
            "sku": "65874564",
            "price": 20.9,
            "name": "Açai Pequeno 300 ml",
            "options_chosen": [
                {
                    "id": "e0399e05-b1ff-11e9-84e9-dbe518c2b47c",
                    "label": "Complementos",
                    "choices": [
                        {
                            "quantity": 1,
                            "price": 2,
                            "id": "e0399e06-b1ff-11e9-84e9-dbe518c2b47c",
                            "label": "Granola"
                        }
                    ]
                },
                {
                    "id": "15245ad0-c9d2-11e9-a8e2-81b473364abc",
                    "label": "Coberturas",
                    "choices": [
                        {
                            "quantity": 1,
                            "price": 0,
                            "id": "15245ad1-c9d2-11e9-a8e2-81b473364abc",
                            "label": "Morango"
                        }
                    ]
                },
                {
                    "id": "e0399e02-b1ff-11e9-84e9-dbe518c2b47c",
                    "label": "Xaropes",
                    "choices": [
                        {
                            "quantity": 1,
                            "price": 1.35,
                            "id": "e0399e03-b1ff-11e9-84e9-dbe518c2b47c",
                            "label": "Xarope de Guaraná"
                        }
                    ]
                }
            ],
            "presentations": [],
            "shopper_price": 24.25
        }
    ],
    "purchased_products_value": 24.25,
    "delivery_fee": null,
    "service_fee": 5.78,
    "total_interest": 0,
    "voucher_discount": 0,
    "total_price": 30.03,
    "customer": {
        "cpf": "28552233851",
        "id": "ca3288c0-7e59-11ea-bf68-b17077bae641",
        "name": "Leandro Zanardi",
        "phone": "+5511994215695"
    },
    "transaction_date": 1603808305165,
    "company_external_id": "Sucao_Dev",
    "payment_type": "OTHER",
    "installments": 1,
    "card_flag": null,
    "type_shipping": "SCHEDULED",
    "schedule_date": 1603792800000,
    "delivery_address": {
        "id": "2225ead0-f205-11ea-8872-0dc41336f3ce",
        "cep": "13025-230",
        "city": "Campinas",
        "country": "",
        "street": "Rua Américo Brasiliense",
        "state": "SP",
        "street_number": "50",
        "vicinity": "bairro",
        "more": null
    },
    "status": 22,
    "will_delivery": true
}

Generated with apidoc 0.50.3 - Wed Jan 05 2022 13:22:33 GMT-0300 (Brasilia Standard Time)