| 200 | {
"integrationHubServiceId": "string",
"data": {
"id": "string",
"type": "DELIVERY",
"displayId": "string",
"sourceAppId": "string",
"salesChannel": "string",
"virtualBrand": "string",
"createdAt": "string",
"lastEvent": "CREATED",
"orderTiming": "INSTANT",
"preparationStartDateTime": "string",
"merchant": {
"id": "string",
"name": "string"
},
"items": [
{
"id": "string",
"index": "string",
"name": "string",
"externalCode": "string",
"unit": "UN",
"ean": "string",
"quantity": 0,
"specialInstructions": "string",
"unitPrice": {
"value": 0,
"currency": "string"
},
"originalPrice": {
"value": 0,
"currency": "string"
},
"optionsPrice": {
"value": 0,
"currency": "string"
},
"subtotalPrice": {
"value": 0,
"currency": "string"
},
"totalPrice": {
"value": 0,
"currency": "string"
},
"indoor": {
"productionPoint": "string"
},
"options": [
{
"index": "string",
"id": "string",
"name": "string",
"externalCode": "string",
"unit": "UN",
"ean": "string",
"quantity": 0,
"unitPrice": {
"value": 0,
"currency": "string"
},
"originalPrice": {
"value": 0,
"currency": "string"
},
"totalPrice": {
"value": 0,
"currency": "string"
},
"specialInstructions": "string"
}
]
}
],
"otherFees": [
{
"name": "string",
"type": "DELIVERY_FEE",
"receivedBy": "MARKETPLACE",
"receiverDocument": "string",
"price": {
"value": 0,
"currency": "string"
},
"observation": "string"
}
],
"discounts": [
{
"name": "string",
"value": 0
}
],
"total": {
"itemsPrice": {
"value": 0,
"currency": "string"
},
"otherFees": {
"value": 0,
"currency": "string"
},
"discount": {
"value": 0,
"currency": "string"
},
"orderAmount": {
"value": 0,
"currency": "string"
}
},
"payments": {
"prepaid": 0,
"pending": 0,
"methods": [
{
"value": 0,
"currency": "string",
"type": "PREPAID",
"method": "CREDIT",
"brand": "VISA",
"methodInfo": "string",
"transaction": {
"authorizationCode": "string",
"acquirerDocument": "string"
},
"changeFor": 0
}
]
},
"taxInvoice": {
"issued": true,
"taxInvoiceURL": "string"
},
"customer": {
"id": "string",
"name": "string",
"documentNumber": "string",
"phone": {
"number": "string",
"extension": "string"
},
"email": "string",
"ordersCountOnMerchant": "string"
},
"schedule": {
"scheduledDateTimeStart": "string",
"scheduledDateTimeEnd": "string"
},
"orderPriority": "PRIORITY1",
"delivery": {
"deliveredBy": "MARKETPLACE",
"deliveryAddress": {
"country": "string",
"state": "string",
"city": "string",
"district": "string",
"street": "string",
"number": "string",
"complement": "string",
"reference": "string",
"formattedAddress": "string",
"postalCode": "string",
"coordinates": {
"latitude": 0,
"longitude": 0
}
},
"estimatedDeliveryDateTime": "string",
"deliveryDateTime": "string",
"pickupCode": "string"
},
"takeout": {
"mode": "DEFAULT",
"takeoutDateTime": "string"
},
"indoor": {
"mode": "DEFAULT",
"indoorDateTime": "string",
"place": "string",
"seat": "string",
"tab": "string",
"waiterCode": 0
},
"sendDelivered": true,
"sendPickedUp": true,
"sendTracking": true,
"extraInfo": "string"
}
} |
| | Campo | Tipo | Legenda |
|---|
| { IntegrationHubServiceId | String | O identificador exclusivo do pedido. O ID do pedido é gerado pelo Aplicativo de Pedidos. | | data: { | Objeto | Serve como cabeçalho do pedido. | | id | String | O identificador exclusivo do pedido. O ID do pedido é gerado pelo Aplicativo de Pedidos. | | type | String | DELIVERY, TAKEOUT ou INDOOR. | | displayId | String | ID do pedido mostrado na interface do aplicativo de pedidos do cliente. | | sourceAppId | String | Id da aplicação que envia o pedido. | | salesChannel | String | Indica canal de vendas que foi original do pedido | | virtualBrand | String | Identificador alternativo para caso o merchant tenha multiplas brands(Bandeiras). | | createdAt | String | Data, formato = AAAA-MM-DDThh:mm:ss | | lastEvent | String | Útimo evento capturato por Pooling ou Webhook, Enum de valores: [ CREATED, CONFIRMED, DISPATCHED, READY_FOR_PICKUP, PICKUP_AREA_ASSIGNED, DELIVERED, CONCLUDED, CANCELLATION_REQUESTED, CANCELLATION_REQUEST_DENIED, CANCELLED, ORDER_CANCELLATION_REQUEST, CANCELLED_DENIED ] | | orderTiming | String | Último evento válido capturado pelo pooling ou webhook, Enum de valores: [ INSTANT, SCHEDULED, ONDEMAND ] | | preparationStartDateTime | String | Data de inicio de preparação do pedido. O padrão é o mesmo tempo do order creation time(created at). | | merchant { | Objeto | Objeto que tem dados do merchant. | | id | String | Identificador da loja. | | name }, | String | Nome da loja. | | Items [ { | Lista de objetos | Lista os dados relacionados a items. | | id | String | Identificador único de pedidos. | | index | String | Posição do item. | | name | String | Nome do produto. | | external code | String | código do produto no PDV. | | unit | String | Unidade de medida, Enum: UN - Unit
KG - Kilogram
L - Liter
OZ - Ounce
LB - Pound
GAL - Gallon
Em caso de pedido fracionado deveria passar um float example: 500 gramas = 0.5kg.
| | ean | String | Código EAN. | | quantity | Number | Quantidade do item, em caso de pedido fracionado deveria passar um float example: 500 gramas = 0.5kg. | | specialInstructions | String | Instruções extras. | | unitPrice { | Objeto | Objeto de preço unitário | | value | Number | Valor unitário do produto, aceita até 4 casas decimais. | | currency }, | String | Código da moeda, com base na ISO 4217. | | originalPrice { | Objeto | Objeto do preço original | | value | Number | Valor original do produto, aceita até 4 casas decimais. | | currency }, | String | Código da moeda, com base na ISO 4217. | | optionsPrice { | Objeto | Objeto de preço do adicional | | value | Number | Valor de preço adicional do produto, aceita até 4 casas decimais. | | currency }, | String | Código da moeda, com base na ISO 4217. | | subtotalPrice { | Objeto | Objeto do preço do subtotal | | value | Number | Valor do preço do subtotal do produto, aceita até 4 casas decimais. | | currency }, | String | Código da moeda, com base na ISO 4217. | | totalPrice { | Objeto | Objeto do preço total. | | value | Number | Valor original do produto, aceita até 4 casas decimais. | | currency }, | String | Código da moeda, com base na ISO 4217. | | indoor { | Objeto | Indoor = Pedido pra o local. | | productionPoint }, | String | Ponto de produção. | | options [ { | Objeto | Objeto que contém os adicionais. | | index | String | Posição do adicionar. | | id | String | Identificador único do item. | | name | String | Nome do adicional. | | externalCode | String | Código do produto. | | unit | String | Unidade de medida, Enum: UN - Unit
KG - Kilogram
L - Liter
OZ - Ounce
LB - Pound
GAL - Gallon
Em caso de pedido fracionado deveria passar um float example: 500 gramas = 0.5kg. | | ean | String | Código EAN. | | quantity | Number | Quantidade do item, em caso de pedido fracionado deveria passar um float example: 500 gramas = 0.5kg. | | unitPrice { | Objeto | Objeto de preço unitário | | value | Number | Valor unitário do produto, aceita até 4 casas decimais. | | currency }, | String | Código da moeda, com base na ISO 4217. | | originalPrice { | Objeto | Objeto do preço original | | value | Number | Valor original do produto, aceita até 4 casas decimais. | | currency }, | String | Código da moeda, com base na ISO 4217. | | totalPrice { | Objeto | Objeto do preço total. | | value | Number | Valor original do produto, aceita até 4 casas decimais. | | currency }, | String | Código da moeda, com base na ISO 4217. | | specialInstructions } ] } ], | String | Instruções extras. | | OtherFees [ { | Lista de Objetos | Esse objeto contém dados sobre as taxas. | | name | String | nome da taxa. | | type | String | Tipo de Taxa. Enum : [ DELIVERY_FEE, SERVICE_FEE, TIP ] | | receivedBy | String | recebido por. Enum: [ MARKETPLACE, MERCHANT, LOGISTIC_SERVICES ] | | receivedDocument | String | Obeigatório se o receivedBy for marketPlace. | | price { | Objeto | Objeto do preço original | | value | Number | Valor original do produto, aceita até 4 casas decimais. | | currency }, | String | Código da moeda, com base na ISO 4217. | | observation } ], | String | Observação. | | discounts [ { | Lista de Objeto | Contém os dados de disconto. | | name | String | nome do desconto dado. | | value } ] | Number | valor do desconto. | total { | Objeto | Objeto que contém todos os totais. | | unitPrice { | Objeto | Objeto de preço unitário | | value | Number | Valor unitário do produto, aceita até 4 casas decimais. | | currency }, | String | Código da moeda, com base na ISO 4217. | | otherFees { | Objeto | Objeto do preço original | | value | Number | Valor original do produto, aceita até 4 casas decimais. | | currency }, | String | Código da moeda, com base na ISO 4217. | | discount { | Objeto | Objeto de preço do adicional | | value | Number | Valor de preço adicional do produto, aceita até 4 casas decimais. | | currency }, | String | Código da moeda, com base na ISO 4217. | | orderAmount { | Objeto | Objeto do preço do subtotal | | value | Number | Valor do preço do subtotal do produto, aceita até 4 casas decimais. | | currency } }, | String | Código da moeda, com base na ISO 4217. | | payments { | Objeto | Objeto que contém os dados de pagamento. | | prepaid | Number | Valor pago antecipadamente. | | pending | Number | Valor pendente de pagamento. | | methods [ { | Lista de Objetos | lista de objetos com dados de pagamento. | | value | Number | valor do pagamento. | | currency | String | Código da moeda, com base na ISO 4217. | | type | String | Enum: Prepaid e Pending. O Prepaind é quando algum pagamento já foi feito em outra plataforma. O Pending é quando algum pagamento vai ser pago na entrega ou no dinheiro. | | method | String | Métodos de pagamento: "CREDIT" "DEBIT" "MEAL_VOUCHER" "FOOD_VOUCHER" "DIGITAL_WALLET" "PIX" "CASH" "CREDIT_DEBIT" "COUPON" "REDEEM" "PREPAID_REDEEM" "OTHER"* | | brand | String | Indica a bandeira do cartão selecionado no método acima.
esse campo deve ser preechido se o método acima for CREDIT, DEBIT, CREDIT_DEBIT, MEAL_VOUCHER or FOOD_VOUCHER.
Se OTHER foi escolhido, é recomendado informar a bandeira no campo methodInfo. Enum: [ VISA, MASTERCARD, DINERS, AMEX, HIPERCARD, ELO, AURA, DISCOVER, VR_BENEFICIOS, SODEXO, TICKET, GOOD_CARD, BANESCARD, SOROCARD, POLICARD, VALECARD, AGICARD, JCB, CREDSYSTEM, CABAL, GREEN_CARD, VEROCHEQUE, AVISTA, OTHER ] | | methodInfo | String | Informação extra sobre o método. | | transaction { | Objeto | Objeto com dados da transação. | | authorizationCode | String | Cartão de crédito e/ou subsidiária número da autorização da transação. | | acquirerDocument }, | String | Documento da intermediária da transação( agência, plataforma de delivery, marketplace e outros) do serviço. | | changeFor } ] }, | Number | Indica o total que será pago em dinheiro pelo consumidor e será considerado para o calculo de troco.
(ex. o consumidor vai pagar um pedido de $43 com uma nota de $50. Então deve inserir $50.).
Obrigatório quando o método é CASH. | | taxInvoice { | Objeto | Objeto com dados da nota. | | issues | Bool | Informa se a nota fiscal já foi emitida para esse pedido. | | taxInvoiceURL }, | String | URL da nota para ser baixada. | | customer { | Objeto | Dados do consumidor. Obrigatório se o tipo do pedido for delivery | | id | String | Identificador único do consumidor. | | name | String | Nome do consumidor | | documentNumber | String | Documento do consumidor. Documento poderá ser enviado para tratar de questões tributárias. | | phone { | Object | Objeto com dados do telefone | | number | String | Número de telefone. | | extension }, | String | Extensão do número. | | email | String | E-mail do consumidor. E-mail poderá ser enviado para tratar de questões tributárias. | | orderCountOnMerchant }, | String | Total de pedidos feito pelo consumidor na loja. | | Schedule { | Objeto | Objeto de agendamento. | | scheduledDateTimeStart | String | Data, formato = AAAA-MM-DDThh:mm:ss. O padrão é o mesmo tempo do order creation time(created at). | | scheduledDateTimeEnd }, | String | Data, formato = AAAA-MM-DDThh:mm:ss. O padrão é o mesmo tempo do order creation time(created at). | | orderPriority | String | Define a prioridade do pedido em relação a outros pedidos com base na aplicação do pedido.
Quanto menor a prioridade, mas rápido deve ser atendido.
Note: Esse campo depende se a aplicação de pedidos e o pdv suportam a funcionalidade. Enum: [ PRIORITY1, PRIORITY2, PRIORITY3, PRIORITY4 ] | | delivery { | Objeto | Objeto que contém os dados de delivery. | | deliveredBy | String | Enum: [ MARKETPLACE, MERCHANT ] | | deliveredAddress { | Objeto | Objeto do endereço. | | country | String | Código do país de duas letras ISO 3166-1 alpha-2. | | state | String | Estado baseado na ISO 3166-2, Não é obrigatório mas sim recomendado. | | city | String | Nome da cidade. | | district | String | Distrito ou município. | | street | String | Nome da rua. | | number | String | Número. | | complement | String | Complemento do endereço. | | reference | String | Ponto de referência. | | formattedAddress | String | Endereço completo. | | postalCode | String | Código Postal. | | coordinates { | Objeto | Objeto de coordenadas | | latitude | Number | Latitude em graus. Limitado pelos valores [[-90, 90]]. | | longitude } }, | Number | Longitude em graus. Limitado pelos valores [[-180, 180]]. | | estimatedDeliveryDateTime | String | Data e hora estimada da entrega. Mesma data e hora apresentada na aplicação de pedido. | | deliveryDateTime | String | Data e hora em que a entrega aconteceu. | | pickupCode }, | String | Código para o entregador pegar o pacote. Não confundir com o código do consumidor pra receber. | | takeout { | Objeto | Objeto que contém os dados de takeout. | | mode | String | Enum: [ DEFAULT, PICKUP_AREA ] | | takeoutDateTime } | String | Data e tempo em que o pedido está pronto. Pode ser calculado pelo aplicativo de entrega pelo tempo médio de preparo. Padrão é o mesmo horário do Creation Time | | indoor { | Objeto | Objeto para pedidos feitos para consumir no local. | | mode | String | Identificador Indoor Mode:
DEFAULT: Consumir dentro do estabelecimento.
PLACE: Consumir dentro do estabelecimento em lugar específico, como uma mesa.
TAB: Usado pra controlar pedidos via Tab ou cartão consumo. Enum:[ DEFAULT, PLACE, TAB, TERMINAL ] | | indoorDateTime | String | Data e hora que o pedido ficou pronto. Pode ser calculado pelo aplicativo de entrega pelo tempo médio de preparo. Padrão é o mesmo horário do Creation Time. | | place | String | Identificador do Place. Obrigatório quando o mode recebe o valor do Place. | | seat | String | Identificador do Seat. Obrigatório quando o mode recebe o valor do Seat. | | tab | String | Identificador do Tab. Obrigatório quando o mode recebe o valor do Tab. | | waiterCode }, | String | Código do garçom. | | sendDelivered | Bool | Este campo indica se é necessário que o Serviço de Software faça uma solicitação ao terminal para indicar ao Aplicativo de Pedido que o pedido foi entregue ao cliente. true: Indica que o Aplicativo de Pedido está aguardando uma solicitação. falso ou não informado: Não é obrigatório fazer solicitação. | | sendPickedUp | Bool | Este campo indica se é necessário que o Serviço de Software faça uma solicitação ao endpoint para indicar ao Aplicativo de Pedido que o pedido foi retirado pelo cliente. true: Indica que o Aplicativo de Pedido está aguardando uma solicitação. falso ou não informado: Não é obrigatório fazer solicitação. | | sendTracking | Bool | Este campo indica se é necessário que o Serviço de Software faça uma solicitação ao terminal para informar o Aplicativo de Pedido sobre atualizações de entrega. true: Indica que o Aplicativo de Pedido está aguardando uma solicitação. falso ou não informado: Não é obrigatório fazer solicitação. | | extraInfo | String | Informação extra caso seja necessário. |
|