JSON de RequestOrderNewOrder Este JSON é utilizado para enviar informações de um novo pedido, incluindo detalhes do pedido, itens, cliente, pagamentos e outras taxas associadas. Ele serve como um formato padronizado para criar pedidos através de um sistema de integração.

Campos:

integrationHubServiceId (string, obrigatório)

• Descrição: Chave de identificação da integração. Este campo é essencial para identificar de forma única a integração em questão.
• Exemplo: "string"

data (objeto, obrigatório)

• Descrição: Objeto contendo informações detalhadas sobre o pedido.

  Campos do data:

  • id (string, obrigatório)

    • Descrição: Identificador único do pedido. Este ID é gerado pelo aplicativo de pedidos.
    • Exemplo: "string"

  • type (string, obrigatório)

    • Descrição: Tipo do pedido, indicando a modalidade de entrega ou consumo.
    • Valores possíveis: "DELIVERY", "TAKEOUT", "INDOOR", "TABLE", "CARD", "COUNTER"
    • Exemplo: "DELIVERY"

  • displayId (string, obrigatório)

    • Descrição: ID do pedido exibido na interface do aplicativo de pedidos para o cliente.
    • Exemplo: "string"

  • sourceAppId (string)

    • Descrição: ID do aplicativo de pedidos que originou o pedido. Ajuda a identificar o aplicativo dentro de um Hub de integração.
    • Exemplo: "string"

  • salesChannel (string)

    • Descrição: Canal de vendas pelo qual o pedido foi originado.
    • Exemplo: "string"

  • createdAt (string, obrigatório)

    • Descrição: Data e hora de criação do pedido no formato ISO timestamp.
    • Exemplo: "2024-08-09T14:52:00Z"

  • lastEvent (string)

    • Descrição: Último evento válido do pedido, seja ele confirmado ou não.
    • Valores possíveis: "CREATED", "CONFIRMED", "DISPATCHED", "READY_FOR_PICKUP", "PICKUP_AREA_ASSIGNED", "DELIVERED", "CONCLUDED", "CANCELLATION_REQUESTED", "CANCELLATION_REQUEST_DENIED", "CANCELLED", "ORDER_CANCELLATION_REQUEST", "CANCELLED_DENIED"
    • Exemplo: "CREATED"

  • orderTiming (string, obrigatório)

    • Descrição: Indica se o pedido será entregue imediatamente ou em horário agendado.
    • Valores possíveis: "INSTANT", "SCHEDULED"
    • Exemplo: "INSTANT"

  • preparationStartDateTime (string, obrigatório)

    • Descrição: Sugestão de horário de início da preparação após a criação do pedido. Pode ser usado para informar ao estabelecimento sobre um atraso na preparação.
    • Exemplo: "2024-08-09T15:00:00Z"

merchant (objeto, obrigatório)

• Descrição: Objeto contendo informações sobre o estabelecimento.

  Campos do merchant:

  • id (string, obrigatório)

    • Descrição: Identificador único do estabelecimento. Deve ser gerado pelo sistema de software do estabelecimento.
    • Exemplo: "string"

  • name (string, obrigatório)

    • Descrição: Nome público do estabelecimento.
    • Exemplo: "string"

items (array de objetos, obrigatório)

• Descrição: Lista dos itens do pedido.

  Campos do items:

  • id (string, obrigatório)

    • Descrição: Identificador único do item.
    • Exemplo: "string"

  • index (string)

    • Descrição: Posição do item no pedido.
    • Exemplo: "1"

  • name (string, obrigatório)

    • Descrição: Nome do produto.
    • Exemplo: "Pizza Margherita"

  • externalCode (string, obrigatório)

    • Descrição: Código externo do produto.
    • Exemplo: "123456"

  • unit (string, obrigatório)

    • Descrição: Unidade de medida do item.
    • Valores possíveis: "UN", "KG", "L", "OZ", "LB", "GAL"
    • Exemplo: "UN"

  • ean (string)

    • Descrição: Código de barras padrão do item (EAN).
    • Exemplo: "7891234567890"

  • quantity (number, obrigatório)

    • Descrição: Quantidade de itens.
    • Exemplo: 2

  • specialInstructions (string)

    • Descrição: Instruções especiais sobre os itens.
    • Exemplo: "Sem cebola"

  • unitPrice (objeto, obrigatório)

    • Descrição: Preço por unidade do item.

    Campos do unitPrice:

    • value (number, obrigatório)

      • Descrição: Valor do preço. Aceita até 4 casas decimais.
      • Exemplo: 20.00

    • currency (string, obrigatório)

      • Descrição: Código da moeda no formato ISO 4217.
      • Exemplo: "BRL"

  • originalPrice (objeto)

    • Descrição: Preço original do produto antes de qualquer desconto. Apenas para fins informativos.

    Campos do originalPrice:

    • value (number, obrigatório)

      • Descrição: Valor do preço original.
      • Exemplo: 25.00

    • currency (string, obrigatório)

      • Descrição: Código da moeda no formato ISO 4217.
      • Exemplo: "BRL"

  • optionsPrice (objeto)

    • Descrição: Soma dos preços de todas as opções escolhidas para o item.

    Campos do optionsPrice:

    • value (number, obrigatório)

      • Descrição: Valor do preço das opções.
      • Exemplo: 5.00

    • currency (string, obrigatório)

      • Descrição: Código da moeda no formato ISO 4217.
      • Exemplo: "BRL"

  • totalPrice (objeto, obrigatório)

    • Descrição: Preço total do item, calculado como a quantidade multiplicada pelo preço unitário somado ao preço das opções.

    Campos do totalPrice:

    • value (number, obrigatório)

      • Descrição: Valor do preço total.
      • Exemplo: 45.00

    • currency (string, obrigatório)

      • Descrição: Código da moeda no formato ISO 4217.
      • Exemplo: "BRL"

  • options (array de objetos)

    • Descrição: Extras opcionais escolhidos pelo consumidor, relacionados a este item.

    Campos do options:

    • index (string)

      • Descrição: Posição da opção no pedido.
      • Exemplo: "1"

    • id (string, obrigatório)

      • Descrição: Identificador único da opção.
      • Exemplo: "string"

    • name (string, obrigatório)

      • Descrição: Nome da opção.
      • Exemplo: "Queijo Extra"

    • externalCode (string, obrigatório)

      • Descrição: Código externo do produto da opção.
      • Exemplo: "789456123"

    • unit (string, obrigatório)

      • Descrição: Unidade de medida da opção.
      • Valores possíveis: "UN", "KG", "L", "OZ", "LB", "GAL"
      • Exemplo: "UN"

    • ean (string)

      • Descrição: Código de barras padrão da opção (EAN).
      • Exemplo: "7891236547890"

    • quantity (number, obrigatório)

      • Descrição: Quantidade de opções.
      • Exemplo: 1

    • unitPrice (objeto, obrigatório)

      • Descrição: Preço por unidade da opção.

      Campos do unitPrice:

      • value (number, obrigatório)

        • Descrição: Valor do preço. Aceita até 4 casas decimais.
        • Exemplo: 2.00

      • currency (string, obrigatório)

        • Descrição: Código da moeda no formato ISO 4217.
        • Exemplo: "BRL"

    • originalPrice (objeto)

      • Descrição: Preço original da opção antes de qualquer desconto. Apenas para fins informativos.

      Campos do originalPrice:

      • value (number, obrigatório)

        • Descrição: Valor do preço original.
        • Exemplo: 2.50

      • currency (string, obrigatório)

        • Descrição: Código da moeda no formato ISO 4217.
        • Exemplo: "BRL"

    • totalPrice (objeto, obrigatório)

      • Descrição: Preço total da opção, calculado como a quantidade multiplicada pelo preço unitário.
      • Exemplo: 2.00

integrationHubServiceId: é um código da integração da loja com o Integration Hub

orderKey: é o código do pedido

Para obter detalhes técnicos sobre como realizar uma requisição à API Order  no endpoint de payment para enviar um item com valor integral, clique aqui.