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

# Despachar pedido

> Despacha o pedido especificado pelo order_id.

Pedidos de retirada e de consumo no local irão para o status "waiting_to_catch" e os pedidos de delivery irão para o status "released".



## OpenAPI

````yaml /reference/api-pedidos.json post /api/partner/v1/orders/{order_id}/dispatch
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 acompanha pedidos de um estabelecimento, permite alterações
    de status e consulta resumos e rankings de vendas.


    ## Autenticação


    Apps da CW App Store usam `Authorization: Bearer <access_token>` (OAuth 2.0)
    com escopo `orders`. A associação e a remoção de entregadores também exigem
    o escopo `drivers`.


    Integrações legadas usam `X-API-KEY`. A criação de pedidos (`POST /orders`)
    também exige `X-PARTNER-KEY`. Os endpoints de resumo, rankings de vendas e
    gestão do entregador exigem OAuth 2.0 e não aceitam API Key.


    Consulte a documentação em /autenticacao/modelos-de-autenticacao.


    ## Rate Limits


    Histórico de pedidos (`GET /orders/history`), resumos e rankings de vendas
    (`GET /orders/summary`, `GET /orders/summary/*`): **5 requisições por minuto
    por endpoint**. Demais endpoints: **300 requisições a cada 3 minutos**.
    Consulte /sobre-a-api#rate-limits.
servers:
  - url: https://integracao.sandbox.cardapioweb.com
    description: Sandbox
  - url: https://integracao.cardapioweb.com
    description: Produção
security:
  - bearerAuth: []
  - apiKey: []
paths:
  /api/partner/v1/orders/{order_id}/dispatch:
    parameters:
      - $ref: '#/components/parameters/order_id'
    post:
      summary: Despachar pedido
      description: >-
        Despacha o pedido especificado pelo order_id.


        Pedidos de retirada e de consumo no local irão para o status
        "waiting_to_catch" e os pedidos de delivery irão para o status
        "released".
      operationId: 6-order-dispatch
      responses:
        '204':
          $ref: '#/components/responses/StatusUpdatedSuccessfully'
        '400':
          $ref: '#/components/responses/StatusUpdateError'
        '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.
  responses:
    StatusUpdatedSuccessfully:
      description: Alteração de status feita com sucesso!
      content: {}
    StatusUpdateError:
      description: >-
        Não foi possível alterar o status. Veja os detalhes do erro retornado
        para mais informações.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/StatusUpdateError'
    Unauthorized:
      description: >-
        Não autorizado. Token OAuth inválido ou ausente, ou X-API-KEY
        inválido/ausente no modelo legado.
      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: {}
  schemas:
    StatusUpdateError:
      type: object
      x-stoplight:
        id: xjq8zt69xjhzj
      examples:
        - code: 4002
          message: Não foi possível alterar o status do pedido
          details: Pedido finalizado, não é possível alterar o status.
        - code: 4003
          message: Essa transição de status não é permitida para esse pedido.
          details: O status desejado não é compatível com o pedido.
      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: StatusUpdateError
      x-internal: false
    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
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: OAuth2
      description: >-
        Access token OAuth 2.0 de app instalado na CW App Store. Escopo
        principal: orders. A gestão do entregador também exige drivers.
    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.

````