Exibir origem

Conteúdo:

Visão Geral
Endpoint
Header
Corpo da Requisição

01. VISÃO GERAL

Essa requisição é responsável por realizar pedidos, também conhecida como pedidos online, a API Order/newOrder tem a responsabilidade de suprir todas as necessidades de pedidos online de um pdv, podendo ser lançado, pedidos normais, com adicional, fracionado, com taxa ou sem, realizar o pagamento junto ao pedido entre outros.

02. ENDPOINT

Método	URL	Ambiente
POST	https://api-barramento.meuelevestage.com/order/newOrder	Homologação
POST	https://api-barramento.meueleve.com.br/order/newOrder	Produção

03. HEADER

Chave	Valor
x-mpn-integrations-signature	t=1651674844016,sign=8ebcf9cb577c0f0847969fee25c904a72c1e70aa13c197f44ef489768ec84a71

04. CORPO DA REQUISIÇÃO

Estrutura completa do corpo da requisição:

Corpo da requisição:

Status Code

Corpo da requisição

Dicionário

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.
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.
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.