> ## 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. # Histórico de pedidos > Retorna os pedidos concluídos e cancelados do estabelecimento que foram criados dentro de um período especificado. O início desse período não pode retroceder mais de um ano, e a duração do período não pode exceder seis meses. Esse endpoint possui paginação, onde os parâmetros 'page' e 'per page' controlam a paginação, com um limite máximo de 100 pedidos por página. Esse endpoint fornece informações básicas sobre os pedidos, para obter informações mais detalhadas sobre cada pedido individualmente, utilize o endpoint designado para isso. Lembre-se de considerar o limite de requições (rate limit) ao consultar os detalhes dos pedidos. O limite de requições desse endpoint de histórico de pedidos é diferente dos demais, sendo limitado a 5 requisições por minuto. Pedido recebidos através de integrações como o iFood também são retornados nesse endpoint. ## OpenAPI ````yaml /reference/api-pedidos.json get /api/partner/v1/orders/history 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/history: parameters: [] get: summary: Histórico de pedidos description: >- Retorna os pedidos concluídos e cancelados do estabelecimento que foram criados dentro de um período especificado. O início desse período não pode retroceder mais de um ano, e a duração do período não pode exceder seis meses. Esse endpoint possui paginação, onde os parâmetros 'page' e 'per page' controlam a paginação, com um limite máximo de 100 pedidos por página. Esse endpoint fornece informações básicas sobre os pedidos, para obter informações mais detalhadas sobre cada pedido individualmente, utilize o endpoint designado para isso. Lembre-se de considerar o limite de requições (rate limit) ao consultar os detalhes dos pedidos. O limite de requições desse endpoint de histórico de pedidos é diferente dos demais, sendo limitado a 5 requisições por minuto. Pedido recebidos através de integrações como o iFood também são retornados nesse endpoint. operationId: 2-order-history parameters: - schema: type: string format: date-time example: '2023-01-01T00:00:00-03:00' in: query name: start_date description: >- Data de início do período para filtrar os pedidos com base na data de criação, com a possibilidade de retroceder no máximo 3 anos a partir da data atual. required: true - schema: type: string example: '2023-06-30T23:59:59-03:00' in: query name: end_date description: >- Data de término do período para filtrar os pedidos com base na data de criação, assegurando que o intervalo não ultrapasse 6 meses. required: true - schema: type: string enum: - closed - canceled in: query description: >- Retorna apenas os pedidos com os status específicados. Para filtrar mais de um status na mesma requisição faça: status[]=closed&status[]=canceled. name: status[] - schema: type: number default: 1 minimum: 1 in: query name: page - schema: type: number default: 100 minimum: 1 maximum: 100 in: query name: per_page requestBody: content: {} responses: '200': description: >- Retorna um array com os pedidos encontrados. Para obter mais detalhes sobre a estrutura de um pedido, consulte nossa seção exclusiva sobre o assunto. content: application/json: schema: type: object properties: orders: x-stoplight: id: 70aqm1nlhp1mu type: array items: $ref: '#/components/schemas/LiteOrder' x-stoplight: id: ffuxgoz96oem8 pagination: type: object x-stoplight: id: w4pyiwp1q9hr7 required: - current_page - total_pages - total_orders description: Informações sobre a paginação properties: current_page: type: number x-stoplight: id: gut1nayi481o5 description: Página atual. total_pages: type: number x-stoplight: id: 4bgn3i8a1ri4z description: Total de páginas para os filtros aplicados. total_orders: type: number x-stoplight: id: vkj9nlsz4bz4f description: Total de pedidos para os filtros aplicados. required: - orders - pagination headers: {} '400': description: Algum parâmetro enviado é inválido. content: application/json: schema: $ref: '#/components/schemas/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '429': $ref: '#/components/responses/TooManyRequests' components: schemas: LiteOrder: type: object examples: - id: 7637457 status: closed order_type: takeout order_timing: immediate sales_channel: portal created_at: '2023-06-23T15:23:19.813-03:00' updated_at: '2023-06-23T15:43:16.539-03:00' title: Pedido resumido x-internal: false properties: id: type: integer description: Identificador exclusivo do pedido. 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. 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. BadRequest: type: object examples: - code: 4000 message: Parâmetros inválidos details: updated_since não é uma data válida - code: 4000 message: Parâmetros inválidos details: status contém valores inválidos 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: BadRequest 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 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. ````