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

# Criar pedido pré-preenchido

> Cria um pedido pré-preenchido e retorna um link para que o cliente possa finalizar o pedido através do site.

O link do pedido pré-preenchido tem validade de 24 horas. Após esse período ele não estará mais disponível.

Caso um produto ou algum dos complementos dele não esteja mais disponível quando o cliente acessar o link, o produto não será adicionado ao carrinho.



## OpenAPI

````yaml /reference/api-pedidos.json post /api/partner/v1/orders/prefilled_order
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/prefilled_order:
    post:
      summary: Criar pedido pré-preenchido
      description: >-
        Cria um pedido pré-preenchido e retorna um link para que o cliente possa
        finalizar o pedido através do site.


        O link do pedido pré-preenchido tem validade de 24 horas. Após esse
        período ele não estará mais disponível.


        Caso um produto ou algum dos complementos dele não esteja mais
        disponível quando o cliente acessar o link, o produto não será
        adicionado ao carrinho.
      operationId: 10-prefilled-order
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PrefilledOrder'
        description: Informações para a criação de um pedido pré-preenchido.
      responses:
        '200':
          description: Pedido pré-preenchido criado com sucesso!
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    x-stoplight:
                      id: rvpk7g69lwriu
                    description: Identificador único do pedido pré-preenchido.
                  order_url:
                    type: string
                    x-stoplight:
                      id: l8t49mktxo1jw
                    format: uri
                    description: >-
                      Link do cardápio digital para acessar o pedido
                      pré-preenchido.
                  checkout_url:
                    type: string
                    x-stoplight:
                      id: g45byc3p73xy7
                    format: uri
                    description: >-
                      Link direto para o checkout do cardápio digital com o
                      pedido pré-preenchido.
                required:
                  - id
                  - order_url
                  - checkout_url
              examples:
                Example 1:
                  value:
                    id: 9f31556d
                    order_url: >-
                      https://app.sandbox.cardapioweb.com/teste_integracao?poid=9f31556d
                    checkout_url: >-
                      https://app.sandbox.cardapioweb.com/teste_integracao/checkout?poid=9f31556d
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  schemas:
    PrefilledOrder:
      type: object
      x-internal: false
      title: PrefilledOrder
      examples:
        - order_type: takeout
          customer:
            name: João da Silva
            phone: '11998765431'
          cart:
            - item_id: 2988
              observation: Com muito molho!
              quantity: 2
              kind: regular_item
              option_groups:
                - option_group_id: 1039
                  options:
                    - option_id: 2883
                      quantity: 1
                - option_group_id: 1040
                  options:
                    - option_id: 2886
                      quantity: 1
            - item_id: 2998
              observation: Capricha por favor!
              quantity: 1
              kind: regular_item
              option_groups:
                - option_group_id: 1039
                  options:
                    - option_id: 2884
                      quantity: 1
            - item_id: 3005
              observation: null
              quantity: 2
              kind: regular_item
              option_groups:
                - option_group_id: 1042
                  options:
                    - option_id: 2893
                      quantity: 1
        - order_type: delivery
          customer:
            name: Guilherme dos Santos
            phone: '11998765432'
          cart:
            - item_id: 208907
              observation: Com muito molho!
              quantity: 2
              kind: regular_item
              option_groups:
                - option_group_id: 18845
                  options:
                    - option_id: 130101
                      quantity: 1
                - option_group_id: 44476
                  options:
                    - option_id: 16298
                      quantity: 1
                - option_group_id: 54310
                  options:
                    - option_id: 147
                      quantity: 2
                    - option_id: 149
                      quantity: 1
                - option_group_id: 76113
                  options:
                    - option_id: 130101
                      quantity: 1
            - item_id: 208978
              observation: null
              quantity: 1
              kind: regular_item
              option_groups:
                - option_group_id: 76132
                  options:
                    - option_id: 421057
                      quantity: 1
            - item_id: 208909
              quantity: 1
              kind: combo
              combo_steps:
                - combo_step_id: 2693
                  item:
                    item_id: 208907
                    observation: null
                    option_groups:
                      - option_group_id: 18845
                        options:
                          - option_id: 130101
                            quantity: 1
                      - option_group_id: 44476
                        options:
                          - option_id: 16298
                            quantity: 1
                      - option_group_id: 54310
                        options:
                          - option_id: 147
                            quantity: 1
                      - option_group_id: 76113
                        options:
                          - option_id: 130102
                            quantity: 1
                - combo_step_id: 2694
                  item:
                    item_id: 208908
                    observation: null
                    option_groups:
                      - option_group_id: 56843
                        options:
                          - option_id: 226432
                            quantity: 1
                          - option_id: 336125
                            quantity: 1
          delivery_address:
            street: Rua Guaraciaba do Norte
            number: '100'
            address_block: null
            address_lot: null
            neighborhood: Montese
            complement: null
            reference: null
            postal_code: '60420500'
            city: Fortaleza
            state: CE
            latitude: null
            longitude: null
      properties:
        order_type:
          enum:
            - delivery
            - takeout
          description: Tipo de pedido.
        customer:
          type:
            - object
            - 'null'
          description: Informações do cliente.
          properties:
            name:
              type: string
              description: Nome do cliente.
            phone:
              type: string
              description: Telefone do cliente.
              example: '11998765432'
          required:
            - name
            - phone
        cart:
          type:
            - array
            - 'null'
          description: Itens do carrinho.
          items:
            x-stoplight:
              id: ptfcmimg1ypxp
            type: object
            properties:
              item_id:
                type: integer
                description: Identificador único do item.
              observation:
                type:
                  - string
                  - 'null'
                description: >-
                  Observações do item. Disponível apenas se `kind` for
                  `regular_item`.
              quantity:
                type: number
                description: Quantidade do item.
                exclusiveMinimum: 0
              kind:
                description: Tipo de item.
                enum:
                  - regular_item
                  - combo
              option_groups:
                type:
                  - array
                  - 'null'
                description: >-
                  Grupos de complementos do item com opções escolhidas.
                  Disponível apenas se `kind` for `regular_item`.
                items:
                  type: object
                  properties:
                    option_group_id:
                      type: integer
                      description: Identificador único do grupo de complementos.
                    options:
                      type: array
                      description: Opções escolhidas.
                      minItems: 1
                      items:
                        type: object
                        properties:
                          option_id:
                            type: integer
                            description: Identificador único da opção.
                          quantity:
                            type: number
                            description: Quantidade da opção.
                            exclusiveMinimum: 0
                        required:
                          - option_id
                          - quantity
                  required:
                    - option_group_id
                    - options
              combo_steps:
                type:
                  - array
                  - 'null'
                description: Etapas do combo. Disponível apenas se `kind` for `combo`.
                items:
                  type: object
                  properties:
                    combo_step_id:
                      type: integer
                      description: Identificador único da etapa do combo.
                    item:
                      type: object
                      required:
                        - item_id
                      description: Item da etapa escolhido.
                      properties:
                        item_id:
                          type: integer
                          description: Identificador único do item.
                        observation:
                          type:
                            - string
                            - 'null'
                          description: Observações do item.
                        option_groups:
                          type:
                            - array
                            - 'null'
                          minItems: 1
                          description: >-
                            Grupos de complementos do item com opções
                            escolhidas.
                          items:
                            type: object
                            properties:
                              option_group_id:
                                type: integer
                                description: Identificador único do grupo de complementos.
                              options:
                                type: array
                                description: Opções escolhidas.
                                items:
                                  type: object
                                  properties:
                                    option_id:
                                      type: integer
                                      description: Identificador único da opção.
                                    quantity:
                                      type: number
                                      description: Quantidade da opção.
                                  required:
                                    - option_id
                                    - quantity
                            required:
                              - option_group_id
                              - options
                  required:
                    - combo_step_id
                    - item
            required:
              - item_id
              - quantity
              - kind
        delivery_address:
          type:
            - object
            - 'null'
          description: >-
            Endereço de entrega do pedido. Disponível apenas se `order_type` for
            `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'
          required:
            - street
            - neighborhood
            - city
            - state
      required:
        - order_type
    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
  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'
    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.

````