> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cardapioweb.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Consultar detalhes do pedido

> Retorna todas as informações sobre um determinado pedido a partir do seu ID.



## OpenAPI

````yaml /reference/api-pedidos.json get /api/partner/v1/orders/{order_id}
openapi: 3.1.0
info:
  title: API Pedidos
  version: '1.0'
  contact:
    email: integracao@cardapioweb.com
    name: Cardápio Web
    url: https://cardapioweb.com
  description: >-
    A API de pedidos é responsável pelo acompanhamento dos pedidos de um
    estabelecimento e pelas mudanças de status deles.
servers:
  - url: https://integracao.sandbox.cardapioweb.com
    description: Sandbox
  - url: https://integracao.cardapioweb.com
    description: Produção
security:
  - apiKey: []
paths:
  /api/partner/v1/orders/{order_id}:
    parameters:
      - $ref: '#/components/parameters/order_id'
    get:
      summary: Consultar detalhes do pedido
      description: >-
        Retorna todas as informações sobre um determinado pedido a partir do seu
        ID.
      operationId: 3-order-details
      parameters: []
      requestBody:
        content: {}
      responses:
        '200':
          description: >-
            Retorna o pedido desejado.


            Para obter mais detalhes sobre a estrutura de um pedido, consulte
            nossa seção exclusiva sobre o assunto.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/OrderNotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  parameters:
    order_id:
      name: order_id
      in: path
      required: true
      schema:
        type: string
      description: ID do pedido
  schemas:
    Order:
      type: object
      x-internal: false
      examples:
        - id: 7637462
          display_id: 48
          merchant_id: 1
          status: confirmed
          order_type: takeout
          order_timing: immediate
          sales_channel: portal
          customer_origin: null
          table_number: null
          estimated_time: null
          cancellation_reason: null
          fiscal_document: null
          observation: null
          delivery_fee: 0
          service_fee: 0
          additional_fee: 0
          total: 103.8
          created_at: '2023-06-25T10:40:33.744-03:00'
          updated_at: '2023-06-25T10:40:34.207-03:00'
          schedule: null
          customer: null
          delivery_address: null
          items:
            - item_id: 208907
              external_code: null
              name: Hamburguer
              quantity: 2
              unit_price: 12.9
              total_price: 103.8
              kind: regular_item
              status: waiting
              observation: null
              options:
                - option_id: 130101
                  external_code: null
                  name: Brioche
                  quantity: 1
                  unit_price: 10
                  option_group_id: 18845
                  option_group_name: Tipo de pão
                - option_id: 142
                  external_code: null
                  name: Bacon
                  quantity: 1
                  unit_price: 4
                  option_group_id: 44476
                  option_group_name: Adicionais Pagos
                - option_id: 147
                  external_code: null
                  name: Latinha de Coca Cola
                  quantity: 1
                  unit_price: 5
                  option_group_id: 54310
                  option_group_name: Selecione o Refri
                - option_id: 149
                  external_code: null
                  name: Guaraná Antarctica Zero
                  quantity: 2
                  unit_price: 10
                  option_group_id: 54310
                  option_group_name: Selecione o Refri
              items: []
          discounts: []
          payments:
            - total: 103.8
              payment_type: offline
              change_for: null
              status: pending
              payment_method: pix
              card_number: null
              card_brand: null
              observation: null
              payment_fee: 0
        - id: 7637461
          display_id: 47
          merchant_id: 1
          status: scheduled_confirmed
          order_type: delivery
          order_timing: scheduled
          sales_channel: portal
          customer_origin: null
          delivered_by: merchant
          table_number: null
          estimated_time: null
          cancellation_reason: null
          fiscal_document: null
          observation: null
          delivery_fee: 5
          service_fee: 0
          additional_fee: 8
          total: 181.3
          created_at: '2023-06-24T02:01:06.102-03:00'
          updated_at: '2023-06-24T02:01:07.414-03:00'
          schedule:
            scheduled_date_time_start: '2023-06-27T07:40:00-03:00'
            scheduled_date_time_end: '2023-06-27T07:50:00-03:00'
          customer:
            id: 1574794
            phone: '85994197929'
            name: Matheus Lessa
          delivery_address:
            street: Av. Jovita Feitosa
            number: '2992'
            address_block: null
            address_lot: null
            neighborhood: Parquelândia
            complement: ''
            reference: Teste
            postal_code: null
            city: Fortaleza
            state: CE
            latitude: '-3.7413208'
            longitude: '-38.5645481'
          items:
            - item_id: 208907
              external_code: null
              name: Hamburguer
              quantity: 1
              unit_price: 12.9
              total_price: 28.9
              kind: regular_item
              status: waiting
              observation: null
              options:
                - option_id: 130101
                  external_code: null
                  name: Brioche
                  quantity: 1
                  total_price: 10
                  option_group_id: 18845
                  option_group_name: Tipo de pão
                - option_id: 16298
                  external_code: '10'
                  name: Cebola
                  quantity: 1
                  total_price: 1
                  option_group_id: 44476
                  option_group_name: Adicionais Pagos
                - option_id: 147
                  external_code: null
                  name: Latinha de Coca Cola
                  quantity: 1
                  total_price: 5
                  option_group_id: 54310
                  option_group_name: Selecione o Refri
              items: []
            - item_id: 208909
              external_code: null
              name: Hamburguer + Pizza
              quantity: 1
              unit_price: 0
              total_price: 137.9
              kind: combo
              status: waiting
              observation: null
              options: []
              items:
                - item_id: 208907
                  external_code: null
                  name: Hamburguer
                  quantity: 1
                  unit_price: 12.9
                  total_price: 41
                  kind: regular_item
                  status: waiting
                  observation: null
                  options:
                    - option_id: 130102
                      external_code: null
                      name: Pão Gergelim
                      quantity: 1
                      total_price: 10
                      option_group_id: 18845
                      option_group_name: Tipo de pão
                    - option_id: 16298
                      external_code: '10'
                      name: Cebola
                      quantity: 1
                      total_price: 1
                      option_group_id: 44476
                      option_group_name: Adicionais Pagos
                    - option_id: 147
                      external_code: null
                      name: Latinha de Coca Cola
                      quantity: 1
                      total_price: 5
                      option_group_id: 54310
                      option_group_name: Selecione o Refri
                    - option_id: 149
                      external_code: null
                      name: Guaraná Antarctica Zero
                      quantity: 1
                      total_price: 10
                      option_group_id: 54310
                      option_group_name: Selecione o Refri
                  items: []
                - item_id: 208908
                  external_code: null
                  name: Pizza
                  quantity: 1
                  unit_price: 10
                  total_price: 96.9
                  kind: regular_item
                  status: waiting
                  observation: null
                  options:
                    - option_id: 336125
                      external_code: null
                      name: Mussarela
                      quantity: 1
                      total_price: 40.95
                      option_group_id: 56843
                      option_group_name: ESCOLHA O SABOR DA SUA PIZZA
                    - option_id: 336126
                      external_code: null
                      name: Portuguesa
                      quantity: 1
                      total_price: 40.95
                      option_group_id: 56843
                      option_group_name: ESCOLHA O SABOR DA SUA PIZZA
                  items: []
          discounts:
            - kind: discount
              category: other
              total: 3
              total_points: 0
              coupon_id: null
              coupon_name: null
              item_id: null
              item_name: null
          payments:
            - total: 50
              payment_fee: 0
              payment_type: offline
              change_of: null
              status: pending
              payment_method: pix
              card_number: null
              card_brand: null
              observation: null
            - total: 31.5
              payment_fee: 1.5
              payment_type: offline
              change_of: null
              status: pending
              payment_method: credit_card
              card_number: null
              card_brand: null
              observation: null
            - total: 99.8
              payment_fee: 3
              payment_type: offline
              change_of: null
              status: pending
              payment_method: debit_card
              card_number: null
              card_brand: null
              observation: null
      title: Pedido
      description: Estrutura de um pedido
      properties:
        id:
          type: integer
          description: Identificador exclusivo do pedido.
        display_id:
          type: integer
          description: >-
            Número mais amigável para identificação do pedido. Ele não é
            exclusivo.
        external_display_id:
          type:
            - string
            - 'null'
          description: >-
            Número mais amigável para identificação de pedidos de marketplaces.
            Ele não é exclusivo.
        external_order_id:
          type:
            - string
            - 'null'
          description: Identificador exclusivo do pedido no marketplace.
          x-stoplight:
            id: rew8pp6w0yhci
        external_merchant_id:
          type:
            - string
            - 'null'
          x-stoplight:
            id: z40mf8y99rgxv
          description: Identificador exclusivo da loja no marketplace.
        external_merchant_name:
          type:
            - string
            - 'null'
          x-stoplight:
            id: vf1ppwdy0tmc4
          description: Nome da loja no marketplace.
        merchant_id:
          type: integer
          description: >-
            Identificador exclusivo do estabelecimento ao qual o pedido
            pertence.
        status:
          type: string
          description: >-
            Status do pedido.

            - `waiting_confirmation`: pedido pendente.

            - `pending_payment`: pedido de balcão com pagamento pendente.
            Disponível apenas se `sales_channel` for `store_front_catalog`.

            - `pending_online_payment`: pedido aguardando confirmação de um
            pagamento online. Usado no caso de pedidos com pagamento por pix
            automático.

            - `scheduled_confirmed`: pedido agendado confirmado. Disponível
            apenas se `order_timing` for `scheduled`.

            - `confirmed`: pedido confirmado e em preparação.

            - `ready`: pedido pronto, mas ainda não está disponível para
            retirada e nem saiu para entrega.

            - `released`: pedido saiu para entrega. Disponível apenas se
            `order_type` for `delivery`.

            - `waiting_to_catch`: pedido pronto e esperando retirada. Disponível
            apenas se `order_type` for `takeout` ou `onsite`.

            - `delivered`: pedido entregue. Disponível apenas se `order_type`
            for `delivery`.

            - `canceling`: pedido em processo de cancelamento. Uma vez nesse
            status o pedido irá para o status `canceled` ou então voltará para o
            status anterior. Usado no caso de pedidos com pagamento por cartão
            de crédito online.

            - `canceled`: pedido cancelado.

            - `closed`: pedido finalizado.
          enum:
            - waiting_confirmation
            - pending_payment
            - pending_online_payment
            - scheduled_confirmed
            - confirmed
            - ready
            - released
            - waiting_to_catch
            - delivered
            - canceling
            - canceled
            - closed
        order_type:
          type: string
          enum:
            - delivery
            - takeout
            - onsite
            - closed_table
          description: |-
            Tipo de pedido.
            - `delivery`: pedido de delivery.
            - `takeout`: pedido de retirada.
            - `onsite`: pedido de consumo no local.
            - `closed_table`: pedido de mesa ou comanda.
        order_timing:
          type: string
          enum:
            - immediate
            - scheduled
          description: >-
            Momento de entrega do pedido.

            - `immediate`: pedido deve ser preparado o mais breve possível.

            - `scheduled`: pedido deve ficar pronto apenas na data agendada, que
            é enviada no campo `schedule`.
        sales_channel:
          type: string
          enum:
            - catalog
            - store_front_catalog
            - portal
            - whatsapp_extension
            - ifood
          description: >-
            Indica por qual canal o pedido foi feito.

            - `catalog`: cardápio digital padrão (delivery e retirada).

            - `store_front_catalog`: cardápio digital de balcão (apenas
            retirada).

            - `portal`: portal de gestão.

            - `whatsapp_extension`: extensão do Google Chrome para WhatsApp.

            - `ifood`: pedidos recebidos através da integração com o iFood.
        customer_origin:
          type:
            - string
            - 'null'
          description: >-
            Campo livre que permite identificar de forma personalizada a origem
            do pedido por meio de diferentes versões do link do cardápio
            digital. Essa funcionalidade possibilita, por exemplo, identificar
            pedidos feitos através do link divulgado no Instagram, no Facebook,
            no WhatsApp, em uma propagando paga, através de algum influencer,
            etc.
          example: insta
        delivered_by:
          x-stoplight:
            id: su4f3rfeuxavg
          enum:
            - merchant
            - ifood
            - ifood_shipping
            - foody_delivery
            - food99
            - keeta
            - aiqfome
          description: |-
            Indica o responsável pela entrega dos pedidos iFood:
            - `merchant`: Estabelecimento.
            - `ifood`: iFood.
            - `ifood_shipping`: iFood Sob Demanda.
            - `foody_delivery`: Foody Delivery.
            - `food99`: 99Food.
            - `keeta`: Keeta.
            - `aiqfome`: Aiqfome.

            Será null se o `order_type` não for `delivery`.
        table_number:
          type:
            - string
            - 'null'
          description: >-
            Número da mesa ou comanda associada ao pedido. Disponível apenas
            para pedidos de mesa ou comanda (`order_type` deve ser
            `closed_table`).
        estimated_time:
          type:
            - integer
            - 'null'
          description: >-
            Previsão de entrega do pedido em minutos a partir da data de
            criação.
        cancellation_reason:
          type:
            - string
            - 'null'
          description: >-
            Motivo do cancelamento. Preenchido apenas para pedidos cancelados,
            podendo ser nulo se nenhum motivo for informado.
        fiscal_document:
          type:
            - string
            - 'null'
          description: >-
            CPF ou CNPJ para ser utilizado na emissão de cupom fiscal, sem
            formatação.
          example: '70887267009'
        observation:
          type:
            - string
            - 'null'
          x-stoplight:
            id: 3ell2ygzqeeqt
          description: Observações gerais sobre o pedido.
        delivery_fee:
          type: number
          description: Taxa de entrega. Disponível apenas se `order_type` for `delivery`.
          default: 0
          minimum: 0
        service_fee:
          type: number
          description: >-
            Taxa de serviço (R$). Disponível apenas se `order_type` for
            `closed_table`.
          default: 0
          minimum: 0
        additional_fee:
          type: number
          description: >-
            Taxa adicional (R$). Campo livre para o estabelecimento cobrar um
            valor adicional.
          default: 0
          minimum: 0
        total:
          type: number
          description: >-
            Valor total do pedido. É possível ter pedidos com o valor total
            zerado.

            ```sql

            total = sum(items.total_price)
             + delivery_fee 
             + service_fee 
             + additional_fee 
             + sum(payments.payment_fee) 
             - sum(discounts.total)
            ```
          minimum: 0
        created_at:
          type: string
          format: date-time
          description: Data e hora em que o pedido foi criado.
        updated_at:
          type: string
          format: date-time
          description: Data e hora da última vez que o pedido foi modificado.
        schedule:
          type:
            - object
            - 'null'
          description: >-
            Informações sobre a data de agendamento do pedido. Disponível apenas
            para pedidos agendados (`order_timing` deve ser `scheduled`).
          properties:
            scheduled_date_time_start:
              type: string
              format: date-time
              description: >-
                Data e hora de início do período para o qual o pedido foi
                agendado.
              example: '2023-06-27T07:40:00-04:00'
            scheduled_date_time_end:
              type: string
              format: date-time
              description: Data e hora de fim do período para o qual o pedido foi agendado.
              example: '2023-06-27T07:50:00-04:00'
        user:
          type:
            - object
            - 'null'
          x-stoplight:
            id: 3knc0x6r1dt6e
          description: >-
            Informações do usuário responsável pelo pedido. Por enquanto,
            disponível apenas para pedidos de mesas/comandas.
          properties:
            id:
              type: number
              x-stoplight:
                id: 66y0q04eryaku
              description: Identificador exclusivo do usuário.
            name:
              type: string
              x-stoplight:
                id: pzv3vja6vj8xb
              description: Nome do usuário.
        customer:
          type:
            - object
            - 'null'
          description: >-
            Informações sobre o cliente que fez o pedido. Pedidos feitos pelo
            Portal (`sales_channel` igual a `portal`) ou pela Extensão para
            WhatsApp (`sales_channel` igual a `whatsapp_extension`) podem não
            ter um cliente.
          properties:
            id:
              type: integer
              description: Identificador exclusivo do cliente.
            name:
              type: string
              description: Nome do cliente.
            phone:
              type: string
              description: Telefone do cliente.
              example: '11998765432'
            ddi:
              type: string
              x-stoplight:
                id: yrlfqvpp43yfh
              description: DDI do telefone do cliente
              example: '55'
        delivery_address:
          type:
            - object
            - 'null'
          description: >-
            Endereço onde o pedido deve ser entregue. Disponível apenas para
            pedidos de delivery (`order_type` deve ser `delivery`).
          properties:
            street:
              type: string
              description: Logradouro.
            number:
              type:
                - string
                - 'null'
              description: Número do endereço.
            address_block:
              type:
                - string
                - 'null'
              description: >-
                Quadra do endereço. Para cidades em que é mais comum utilizar a
                referência de Quadra e Lote para identificar a localização de um
                endereço, em vez de utilizar um número.
            address_lot:
              type:
                - string
                - 'null'
              description: >-
                Lote do endereço. Para cidades em que é mais comum utilizar a
                referência de Quadra e Lote para identificar a localização de um
                endereço, em vez de utilizar um número.
            neighborhood:
              type: string
              description: Bairro.
            complement:
              type:
                - string
                - 'null'
              description: Complemento do endereço.
              example: Bloco K, Apto 100
            reference:
              type:
                - string
                - 'null'
              description: Ponto de referência do endereço.
              example: Ao lado do posto de saúde.
            postal_code:
              type:
                - string
                - 'null'
              description: CEP do endereço, sem formatação.
              example: '49042143'
            city:
              type: string
              description: Nome da cidade.
            state:
              type: string
              description: Sigla do estado.
              example: RJ
            latitude:
              type:
                - string
                - 'null'
              description: Latitude do endereço.
              example: '-10.2627'
            longitude:
              type:
                - string
                - 'null'
              description: Longitude do endereço.
              example: '-48.3997'
        items:
          type: array
          description: Itens do pedido.
          items:
            type: object
            properties:
              item_id:
                type: integer
                description: Identificador único do item no catálogo.
              order_item_id:
                type: integer
                x-stoplight:
                  id: h9s5euip7x1ft
                description: >-
                  Identificador único do item no pedido  (um mesmo item pode
                  aparecer várias vezes no pedido).
              external_code:
                type:
                  - string
                  - 'null'
                description: Código externo do item.
              name:
                type: string
                description: Nome do item.
              quantity:
                type: number
                description: Quantidade do item.
                minimum: 0
              unit_price:
                type:
                  - number
                description: Preço unitário do item sem as opções.
                minimum: 0
              total_price:
                type: number
                description: >-
                  Preço total do produto. 

                  - `total_price = quantity x (unit_price + unit_options_price)`

                  - `unit_options_price = sum(options.quantity x
                  options.unit_price)`
                minimum: 0
              kind:
                type: string
                enum:
                  - regular_item
                  - combo
                description: Tipo do produto.
              status:
                type: string
                description: >-
                  Status de produção do item. O estabelecimento pode optar por
                  não fazer o controle desse status.

                  - `pending`: aguardando aprovação. Usado nos pedidos de mesas
                  e comandas.

                  - `waiting`: produto aguardando produção.

                  - `production`: produto em produção.

                  - `ready`: produto pronto.

                  - `ok`: fluxo do produto finalizado.

                  - `canceled`: produto cancelado (deve ser desconsiderado,
                  retornados apenas para controle dos itens cancelados).
              observation:
                type:
                  - string
                  - 'null'
                description: Observações do produto.
                example: Retirar cebola.
              options:
                type: array
                description: >-
                  Lista das opções pedidas junto com o item. Disponível apenas
                  se `kind` for `regular_item`.

                  - Se o `kind` for `regular_item`, será retornado um array
                  vazio ou com pelo menos uma opção.

                  - Se o `kind` for `combo`, será retornado um array vazio.
                items:
                  type: object
                  properties:
                    option_id:
                      type: integer
                      description: Identificador único da opção.
                    external_code:
                      type:
                        - string
                        - 'null'
                      description: Código externo da opção.
                    name:
                      type: string
                      description: Nome da opção.
                    quantity:
                      type: number
                      description: Quantidade da opção.
                      minimum: 0
                    unit_price:
                      type: number
                      x-stoplight:
                        id: xcx9sv08mszxc
                      description: Preço unitário da opção.
                      minimum: 0
                    option_group_id:
                      type: integer
                      description: >-
                        ID do grupo de complementos do qual a opção faz parte. É
                        importante ressaltar que uma opção pode pertencer a mais
                        de um grupo de complemento.
                    option_group_name:
                      type: string
                      description: >-
                        Nom do grupo de complementos do qual a opção faz parte.
                        É importante ressaltar que uma opção pode pertencer a
                        mais de um grupo de complemento.
                    option_group_total_selected_options:
                      type:
                        - integer
                        - 'null'
                      x-stoplight:
                        id: r4buuoogifnur
                      description: >-
                        Número de opções selecionadas no grupo de complementos.
                        Esta informação é exibida apenas para grupos de
                        complementos em que o cálculo do preço é baseado na
                        opção mais barata, mais cara, ou na média das opções
                        escolhidas. Para grupos em que o valor é calculado pela
                        soma das opções selecionadas, este campo será `null`.
              user:
                type:
                  - object
                  - 'null'
                x-stoplight:
                  id: 8us6tr8ilzxe2
                description: >-
                  Informações do usuário que lançou o item. Não disponível para
                  pedidos lançados pelo cardápio digital ou via integrações.
                properties:
                  id:
                    type: string
                    x-stoplight:
                      id: 6vxx5pnbn0wvq
                    description: Identificador exclusivo do usuário.
                  name:
                    type: string
                    x-stoplight:
                      id: pelvys6t6y00c
                    description: Nome do usuário.
        discounts:
          type: array
          description: Descontos aplicados ao pedido.
          items:
            type: object
            properties:
              kind:
                type: string
                enum:
                  - discount
                  - free_delivery
                  - item
                description: |-
                  Tipo de desconto.
                  - `discount`: desconto no valor total do pedido.
                  - `free_delivery`: desconto na taxa de entrega.
                  - `item`: desconto no valor de um produto específico.
              category:
                type: string
                enum:
                  - coupon
                  - loyalty
                  - other
                description: >-
                  Categoria do desconto.

                  - `coupon`: desconto aplicado através de um cupom.

                  - `loyalty`: desconto obtido através do resgate de recompensas
                  do programa de fidelidade.

                  - `other`: desconto avulso aplicado diretamente ao pedido.
              sponsorship:
                x-stoplight:
                  id: f16olo2rp13wy
                enum:
                  - merchant
                  - ifood
                description: |-
                  Patrocinaor do desconto.
                  - `merchant`: desconto patrocinado pelo estabelecimento.
                  - `ifood`: desconto patrocinado pelo iFood.
              total:
                type: number
                description: Valor do desconto.
                minimum: 0
              total_points:
                type: integer
                description: >-
                  Quantidade de pontos do programa de fidelidade utilizada para
                  obter o desconto. Disponível apenas se `category` for
                  `loyalty`.
                default: 0
                minimum: 0
              coupon_id:
                type:
                  - integer
                  - 'null'
                description: >-
                  ID do cupom de desconto utilizado. Disponível apenas se
                  `category` for `coupon`.
              coupon_name:
                type:
                  - string
                  - 'null'
                description: >-
                  Nome  do cupom de desconto utilizado. Disponível apenas se
                  `category` for `coupon`.
              coupon_code:
                type:
                  - string
                  - 'null'
                x-stoplight:
                  id: 85rls5vefieun
                description: >-
                  Código  do cupom de desconto utilizado. Pode ser `null` se o
                  cupom não possuir um código. Disponível apenas se `category`
                  for `coupon`.
              item_id:
                type:
                  - integer
                  - 'null'
                description: >-
                  ID do produto resgatado como recompensa do programa de
                  fidelidade. Disponível apenas se `kind` for `item` e
                  `category` for `loyalty`.
              item_name:
                type:
                  - string
                  - 'null'
                description: >-
                  Nome do produto resgatado como recompensa do programa de
                  fidelidade. Disponível apenas se `kind` for `item` e
                  `category` for `loyalty`.
        payments:
          type: array
          description: Informações de pagamento do pedido.
          items:
            type: object
            properties:
              total:
                type:
                  - number
                description: Valor do pagamento.
                minimum: 0
              payment_method:
                type: string
                enum:
                  - money
                  - credit_card
                  - debit_card
                  - pix
                  - pix_auto
                  - meal_voucher
                  - food_voucher
                  - bank_transfer
                  - bank_slip
                  - picpay
                  - debt_book
                  - online_credit_card
                  - ifood
                  - ifood_voucher
                  - food99
                  - food99_voucher
                description: |-
                  Método de pagamento utilizado.
                  - `money`: dinheiro.
                  - `credit_card`: cartão de crédito.
                  - `debit_card`: cartão de débito.
                  - `pix`: pix manual.
                  - `pix_auto`: pix automático.
                  - `meal_voucher`: vale refeição.
                  - `food_voucher`: vale alimentação.
                  - `bank_transfer`: transferência bancária.
                  - `bank_slip`: boleto.
                  - `picpay`: picPay.
                  - `debt_book`: crediário próprio (fiado).
                  - `online_credit_card`: cartão de crédito online.
                  - `ifood`: pago online via iFood.
                  - `ifood_voucher`: pago online via desconto iFood.
                  - `food99`: pago online via 99Food.
                  - `food99_voucher`: pago online via desconto 99Food.
              payment_type:
                type: string
                enum:
                  - online
                  - offline
                description: >-
                  Tipo de pagamento.

                  - `online`: pagamento foi feito online e não deve ser cobrado
                  na entrega.

                  - `offline`: pagamento deve ser feito no ato da entrega do
                  pedido.
              payment_fee:
                type:
                  - number
                description: >-
                  Taxa adicional que o estabelecimento pode cobrar e que está
                  diretamente atrelada ao método de pagamento.
                default: 0
                minimum: 0
              change_for:
                type:
                  - number
                  - 'null'
                x-stoplight:
                  id: tsfhdtpxl7k4f
                description: >-
                  Indica o valor que será pago para cálculo do troco. Disponível
                  apenas se `payment_method` for `money`. Se esse campo for
                  nulo, mesmo quando o pagamento for feito em dinheiro, isso
                  indica que não será necessário troco.
                minimum: 0
              status:
                type: string
                enum:
                  - pending
                  - paid
                  - authorized
                  - refunded
                  - cancelled
                  - abandoned
                description: >-
                  Status do pagamento. Para pagamentos online, em que o
                  `payment_type` é `online`, esse status será controlado
                  automaticamente pelo nosso sistema. No caso de pagamentos
                  `offline`, ele pode ser usado para controle interno do
                  estabelecimento e pode ser alterado através do nosso Portal,
                  possibilitando a alternância entre os status de `pending` e
                  `paid`.

                  - `pending`: pagamento pendente.

                  - `paid`: pagamento confirmado.

                  - `authorized`: pagamento autorizado, mas não capturado (usado
                  se `payment_method` for `online_credit_card`).

                  - `refunded`: pagamento reembolsado (usado se `payment_method`
                  for `pix_auto`).

                  - `cancelled`: pagamento cancelado (usado se `payment_method`
                  for `online_credit_card`).

                  - `abandoned`: pagamento não foi feito no prazo estabelecido
                  (usado se `payment_method` for `pix_auto`).
                default: pending
              card_brand:
                type:
                  - string
                  - 'null'
                description: >-
                  Nome da bandeira do cartão usado no pagamento. Disponível
                  apenas se `payment_method` for `online_credit_card`.
              card_number:
                type:
                  - string
                  - 'null'
                description: >-
                  4 últimos dígitos do cartão usado no pagamento. Disponível
                  apenas se `payment_method` for `online_credit_card`.
              observation:
                type:
                  - string
                  - 'null'
                description: >-
                  Observações livres que podem ser usadas para controle interno
                  do estabelecimento.
    Unauthorized:
      type: object
      x-stoplight:
        id: 5cdf37ldhxqd8
      examples:
        - code: 4010
          message: Token inválido
      title: Unauthorized
      x-internal: false
      properties:
        code:
          type: integer
          description: Código interno de identificação do erro
        message:
          type: string
          description: Mensagem de resumo do erro
      required:
        - code
        - message
    NotFound:
      type: object
      x-stoplight:
        id: 8bgbn7m3rrved
      examples:
        - code: 4041
          message: Recurso não encontrado
          details: >-
            Couldn't find Order with 'id'=1523 [WHERE "orders"."company_id" =
            $1]
      properties:
        code:
          type: integer
          description: Código interno de identificação do erro
        message:
          type: string
          description: Mensagem de resumo do erro
        details:
          type: string
          description: Informações adicionais sobre o erro
      required:
        - code
        - message
      title: NotFound
      x-internal: false
  responses:
    Unauthorized:
      description: >-
        Não autorizado. Não foi enviado o token no header "X-API-KEY" ou ele é
        inválido.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Unauthorized'
    OrderNotFound:
      description: Pedido não encontrado.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/NotFound'
    TooManyRequests:
      description: >-
        Muitas requisições foram feitas em um curto período. Verifique nossas
        regras de rate limit.
      content: {}
  securitySchemes:
    apiKey:
      name: X-API-KEY
      type: apiKey
      in: header
      description: >-
        Token específico do estabelecimento integrado. Disponível na seção de
        integrações do Portal do estabelecimento.

````