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

# Retorna pedido

> Retorna pedido específico



## OpenAPI

````yaml /api-bitrix/openapi.yaml get /pedidos
openapi: 3.1.0
info:
  title: Agulhão API - Bitrix24
  description: API do sistema Agulhão para integração com Bitrix24.
  contact:
    email: contato@softros.com.br
    url: https://agulhao.com.br
  version: 1.0.1
servers:
  - url: https://api-integracoes.agulhao.com.br
    description: Produção
security: []
tags:
  - name: filiais-bt
  - name: pessoas-bt
  - name: produtos-bt
  - name: pedidos-bt
  - name: tipos-lancamento
externalDocs:
  description: Mais sobre a API
  url: https://docs.agulhao.com.br/api
paths:
  /pedidos:
    get:
      tags:
        - pedidos-bt
      summary: Retorna pedido
      description: Retorna pedido específico
      operationId: getPedidos
      parameters:
        - name: id
          in: query
          description: Identificador único do pedido
          schema:
            type: string
            example: '1'
        - name: idExterno
          in: query
          description: Identificador único do pedido na integração (seu id)
          schema:
            type: string
            example: 4560a17a-ea59-4c4b-a2a4-78610dd04d4a
      responses:
        '200':
          description: Sucesso
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: Identificador único do pedido no Agulhão
                    example: '1'
                  idExterno:
                    type: string
                    description: Identificador único do pedido na integração (seu id)
                    example: 4560a17a-ea59-4c4b-a2a4-78610dd04d4a
                  descontoDinheiro:
                    type: number
                    format: float
                    description: Desconto em dinheiro aplicado ao pedido
                    example: 10
                  valorFrete:
                    type: number
                    format: float
                    description: Valor do frete
                    example: 15
                  valorOutros:
                    type: number
                    format: float
                    description: Valor de outros custos adicionais do pedido
                    example: 5
                  valorBruto:
                    type: number
                    format: float
                    description: Valor bruto do pedido (sem descontos)
                    example: 100
                  valorLiquido:
                    type: number
                    format: float
                    description: Valor líquido do pedido (com descontos)
                    example: 90
                  observacoes:
                    type: string
                    description: Observações do pedido
                    example: Observações do pedido
                  status:
                    type: string
                    description: Status do pedido
                    examples:
                      - pendente
                      - aguardandoDataEnvio
                      - aprovando
                      - produzindo
                      - separando
                      - faturando
                      - finalizado
                      - cancelado
                      - conferindo
                  cliente:
                    type: object
                    properties:
                      documento:
                        type: string
                        description: CNPJ ou CPF do cliente
                        example: '00000000000000'
                      nome:
                        type: string
                        description: Nome do cliente
                        example: Nome do Cliente
                  entrega:
                    type: object
                    properties:
                      logradouro:
                        type: string
                        description: Logradouro do endereço de entrega
                        example: Avenida Paulista
                      complemento:
                        type: string
                        description: Complemento do endereço de entrega
                        example: Apto 101
                      numero:
                        type: string
                        description: Número do endereço de entrega
                        example: '1000'
                      bairro:
                        type: string
                        description: Bairro do endereço de entrega
                        example: Bela Vista
                      cidade:
                        type: string
                        description: Nome da cidade do endereço de entrega
                        example: São Paulo
                      uf:
                        type: string
                        description: Sigla da unidade federativa do endereço de entrega
                        example: SP
                      ibgeCidade:
                        type: string
                        description: Código IBGE da cidade do endereço de entrega
                        example: '3550308'
                  danfeUrl:
                    type: string
                    description: >-
                      URL do DANFE (Documento Auxiliar da Nota Fiscal
                      Eletrônica)
                    example: https://api.agulhao.com.br/danfe/1234567890.pdf
                  xmlNfeUrl:
                    type: string
                    description: URL do XML da Nota Fiscal Eletrônica
                    example: https://api.agulhao.com.br/xml/1234567890.xml
                  previsaoEntrega:
                    type: string
                    format: date-time
                    description: Data prevista para entrega do pedido
                    example: '2025-01-01T00:00:00'
                  ultimaAtualizacao:
                    type: string
                    format: date-time
                    description: Data da última atualização do pedido
                    example: '2025-01-01T00:00:00'
                  fechamento:
                    type: string
                    format: date-time
                    description: Data de fechamento do pedido
                    example: '2025-01-02T00:00:00'
                  pagamentos:
                    type: array
                    items:
                      type: object
                      properties:
                        descricao:
                          type: string
                          description: Descrição do pagamento
                          example: Dinheiro
                        valor:
                          type: number
                          format: float
                          description: Valor do pagamento
                          example: 100
                  produtos:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: number
                          description: Identificador único do produto
                          example: 1
                          format: integer
                        idGrade:
                          type: number
                          description: Identificador único da grade do produto
                          example: 1
                          format: integer
                        quantidade:
                          type: number
                          format: integer
                          description: Quantidade do produto no pedido
                          example: 1
                        valorUnitario:
                          type: number
                          format: float
                          description: Valor unitário do produto no pedido
                          example: 100
        '400':
          description: >-
            Parâmetros inválidos ou faltando informações necessárias para
            recuperar o pedido.
          content:
            application/json:
              schema:
                type: object
                properties:
                  mensagem:
                    type: string
                    example: Parâmetros inválidos. Verifique os dados enviados.
                  tecnico:
                    type: string
                    example: Erro ao validar os dados do pedido.
        '404':
          description: Pedido não encontrado
          content:
            application/json:
              schema:
                type: object
                properties:
                  mensagem:
                    type: string
                    example: Pedido não encontrado.
                  tecnico:
                    type: string
                    example: Erro ao buscar o pedido no banco de dados.
        '500':
          description: Erro interno do servidor ao tentar recuperar o pedido.
          content:
            application/json:
              schema:
                type: object
                properties:
                  mensagem:
                    type: string
                    example: Erro ao recuperar o pedido.
                  tecnico:
                    type: string
                    example: Erro ao buscar o pedido no banco de dados.
      security:
        - chaveApi: []
components:
  securitySchemes:
    chaveApi:
      description: Chave da API gerada no agulhão
      type: apiKey
      name: x-api-key
      in: header

````