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

# Obtener

> Obtiene un pedido por su ID.



## OpenAPI

````yaml /api/openapi.json get /orders/{orderId}
openapi: 3.1.0
info:
  title: Riqra API
  version: '1.0'
  contact:
    email: soporte@riqra.com
    url: https://www.riqra.com/
    name: Riqra Support
  description: >-
    Usando nuestra API puedes integrar tu ERP o tu sistema actual de
    administración con [Riqra](https://www.riqra.com/).
servers:
  - url: https://sandbox.api.riqra.com
    description: Sandbox
  - description: Producción
    url: https://api.riqra.com
security:
  - API Key: []
tags:
  - name: Almacenes
  - name: Banners
  - name: Categorías
  - name: Clientes
  - name: Clientes - Direcciones
  - name: Cobertura
  - name: Comercio
  - name: Cupones
  - name: Inventario
  - name: Líneas de Crédito
  - name: Lista de Precios
  - name: Lista de Precios - Precios
  - name: Marcas
  - name: Pedidos
  - name: Productos
  - name: Productos Sugeridos
  - name: Promociones
  - name: Stock
  - name: Subcategorías
  - name: Variantes
paths:
  /orders/{orderId}:
    parameters:
      - schema:
          type: string
        name: orderId
        in: path
        required: true
        description: ID del pedido.
    get:
      tags:
        - Pedidos
      summary: Obtener
      description: Obtiene un pedido por su ID.
      operationId: readOrder
      parameters:
        - name: orderId
          in: path
          description: El ID del pedido a retornar.
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - oneOf:
                      - $ref: '#/components/schemas/Order'
                  - type: object
                    properties:
                      purchaseOrderUrl:
                        type: string
                        description: URL del documento que contiene la orden de compra.
                      purchaseOrderNumber:
                        type: string
                        description: El número de la orden de compra.
              examples:
                example-1:
                  value:
                    id: 0
                    code: string
                    erpCode: string
                    status: string
                    vendor: string
                    createdAt: '2019-08-24 14:15:22'
                    total: 0
                    extraFields: {}
                    dedicationMessage: string
                    giftMessage: string
                    purchaseOrderUrl: string
                    purchaseOrderNumber: string
                    creationDate: string
                    creationTime: string
                    updatedAt: '2019-08-25 14:15:22'
                    userAgent: string
                    customer:
                      id: 0
                      firstName: string
                      lastName: string
                      email: string
                      phone: string
                      erpCode: string
                    lineItems:
                      - id: 1
                        name: string
                        presentation: string
                        sku: string
                        erpCode: string
                        quantity: 0
                        price: string
                        adjustmentsTotal: string
                    allAdjusments:
                      - promotionName: string
                        couponCode: string
                        amount: string
                        type: string
                        configuration:
                          type: string
                          value: 0
                    pricing:
                      adjustmentsTotal: string
                      subTotal: string
                      tax: string
                      deliveryCost: string
                      total: string
                    shipping:
                      name: string
                      deliveryAddress:
                        id: 0
                        address: string
                        apartment: string
                        reference: string
                        coordinates: string
                        contactPerson: string
                        contactPhone: string
                        code: string
                        erpCode: string
                      territory:
                        name: string
                        metadata: {}
                      deliveryDate: '2019-08-24'
                      deliveryTimeRange: string
                      pickupInStore:
                        name: string
                        address: string
                        coordinates: string
                      pickupDate: '2019-08-24'
                      pickupTimeRange: string
                    payment:
                      name: string
                      erpCode: string
                      transactionId: string
                      type: string
                      provider: string
                    invoicing:
                      name: string
                      erpCode: string
                      documentNumber: string
                      fiscalName: string
                      fiscalAddress: string
                    creator:
                      name: string
                      erpCode: string
                    channel: string
                    comments: string
                    note: string
                    inventory:
                      name: string
                      erpCode: string
                    locker:
                      name: string
                      erpCode: string
                    lockedAt: string
        '404':
          description: Not Found
components:
  schemas:
    Order:
      type: object
      properties:
        id:
          type: integer
          description: El ID del pedido.
        code:
          type: string
          description: El código del pedido.
        erpCode:
          type: string
          description: El código ERP de integración.
        status:
          type: string
          description: El estado del pedido.
        vendor:
          type: string
          description: El vendor donde esta órden fue generada.
        createdAt:
          type: string
          format: date-time
          description: La fecha de creación del pedido.
        total:
          type: string
          description: El total del pedido.
        finalTotal:
          type: string
          description: >-
            Total del pedido incluyendo la percepción.

            * Sólo aplica a Perú, si eres un agente de percepción y tienes la
            funcionalidad activada, sino esta propiedad siempre será igual que
            `total` y es seguro continuar usándola.
        extraFields:
          type: object
        dedicationMessage:
          type: string
          description: La dedicatoria añadida por el cliente.
        giftMessage:
          type: string
          description: El mensaje de regalo en caso que se trate de un regalo.
        creationDate:
          type: string
          description: Fecha en el formato `AAAAMMDD` (20200409).
        creationTime:
          type: string
          description: Hora en el formato `HH:mm:ss` (17:04:00).
        updatedAt:
          type: string
          format: date-time
          description: La fecha de la última actualización del pedido.
        userAgent:
          type: string
          description: >-
            Parámetro que recibe toda la data desde el sistema operativo hasta
            el modelo del dispositivo con el que se realizó la compra.
        customer:
          type: object
          properties:
            id:
              type: integer
            firstName:
              type: string
              description: El primer nombre del cliente.
            lastName:
              type: string
              description: El apellido del cliente.
            email:
              type: string
              description: El email del cliente.
            phone:
              type: string
              description: El celular del cliente.
            erpCode:
              type: string
              description: El código interno del cliente.
        contactPerson:
          type: object
          properties:
            documentNumber:
              type: string
              description: Número de documento de la persona de contacto.
            firstName:
              type: string
              description: El primer nombre de la persona de contacto.
            lastName:
              type: string
              description: El apellido de la persona de contacto.
            phone:
              type: string
              description: El celular de la persona de contacto.
        lineItems:
          type: array
          description: Los elementos que peretenecen a una orden.
          items:
            type: object
            properties:
              id:
                type: integer
              name:
                type: string
                description: El nombre del producto.
              presentation:
                type: string
                description: El nombre de presentación del producto.
              sku:
                type: string
                description: El SKU del producto.
              erpCode:
                type: string
                description: El código ERP del producto.
              quantity:
                type: integer
                description: La cantidad comprada para ese producto.
              price:
                type: string
                description: El precio del producto en formato de 2 decimales.
              adjustmentsTotal:
                type: string
                description: El total de descuento aplicado al elemento.
        allAdjustments:
          type: array
          items:
            type: object
            properties:
              promotionName:
                type: string
                description: Nombre de la promoción aplicada al pedido.
              couponCode:
                type: string
                description: Código de promoción aplicada al pedido.
              amount:
                type: string
                description: >-
                  Monto total del descuento de promoción que se aplicó al
                  pedido.
              type:
                type: string
                enum:
                  - delivery-discount
                  - product-discount
                  - order-discount
                  - create-line-item
                description: Tipo de ajuste.
              configuration:
                type: object
                properties:
                  type:
                    type: string
                    description: >-
                      Tipo de descuento que se aplica al pedido. Puede ser
                      `fixed` o `percent`.
                  value:
                    type: number
                    description: >-
                      Importe del descuento que se aplicó al pedido. Este valor
                      puede ser un valor porcentual o una cantidad fija.
                      Dependerá del tipo de propiedad.
        pricing:
          type: object
          properties:
            adjustmentsTotal:
              type: string
              description: Suma de todos los descuentos aplicados al pedido.
            subTotal:
              type: string
              description: Suma total de los artículos del pedido.
            tax:
              type: string
              description: Impuestos.
            deliveryCost:
              type: string
              description: Costo de envío.
            total:
              type: string
              description: Costo total del pedido.
            perception:
              type: string
              description: >-
                Porcentage adicional sobre el total de la orden. Este campo es
                relacionado al [régimen de
                percepción](https://emprender.sunat.gob.pe/principales-impuestos/impuesto-general-las-ventas-igv/regimen-percepciones-igv).

                * Sólo aplica a Perú, si eres un agente de percepción y tienes
                la funcionalidad activada, sino esta propiedad siempre será
                "0.00" es seguro ignorarla.
            finalTotal:
              type: string
              description: >-
                Total del pedido incluyendo la percepción.

                * Sólo aplica a Perú, si eres un agente de percepción y tienes
                la funcionalidad activada, sino esta propiedad siempre será
                igual que `total` y es seguro continuar usándola.
        shipping:
          type: object
          properties:
            name:
              type: string
              description: Método de entrega.
            deliveryAddress:
              type: object
              description: Dirección de entrega para el envío.
              properties:
                id:
                  type: number
                address:
                  type: string
                  description: Dirección de entrega.
                apartment:
                  type: string
                  description: Número del departamento del cliente.
                reference:
                  type: string
                  description: Referencia de la dirección.
                coordinates:
                  type: string
                  description: Coordenadas con un formato de 'latitude,longitude'.
                divisionLevel1:
                  type: string
                  description: Primer nivel de división administrativa de tu país.
                divisionLevel2:
                  type: string
                  description: Segundo nivel de división administrativa de tu país.
                divisionLevel3:
                  type: string
                  description: Tercer nivel de división administrativa de tu país.
                divisionLevel4:
                  type: string
                  description: Cuarto nivel de división administrativa de tu país.
                contactPerson:
                  type: string
                  description: Persona que recibirá el pedido.
                contactPhone:
                  type: string
                  description: El número de teléfono de la persona de contacto.
                code:
                  type: string
                  description: Sistema de codificación para ubicaciones geográficas.
                erpCode:
                  type: string
                  description: Código interno de la dirección del cliente.
            territory:
              type: object
              properties:
                name:
                  type: string
                  description: Nombre del territorio.
                metadata:
                  type: object
                  description: >-
                    Este valor contiene toda la metadata relacionada con el
                    territorio.
            deliveryDate:
              type: string
              format: date
              description: Fecha de entrega.
            deliveryTimeRange:
              type: string
              description: Rango de tiempo en la que se hará la entrega.
            pickupInStore:
              type: object
              description: Información de la tienda de recojo.
              properties:
                name:
                  type: string
                  description: Nombre de la tienda.
                address:
                  type: string
                  description: Dirección de la tienda.
                coordinates:
                  type: string
                  description: Coordenadas en un formato de 'latitude,longitude'.
            pickupDate:
              type: string
              format: date
              description: Fecha de recojo en tienda.
            pickupTimeRange:
              type: string
              description: Rango de tiempo en la que se puede recoger en tienda.
            shipment:
              type: object
              description: Los datos de la entrega.
              properties:
                id:
                  type: string
                  description: >-
                    ID del envío creado por el proveedor de entrega de última
                    milla.
        payment:
          type: object
          properties:
            name:
              type: string
              description: Nombre del método de pago.
            erpCode:
              type: string
              description: El código ERP del método de pago.
            transactionId:
              type: string
              description: >-
                ID de la transacción, incluida cuando el método de pago es
                tarjeta de débito o crédito.
            type:
              type: string
              description: >-
                Tipo del método de pago. Puede ser `deposit`, `line-of-credit`,
                `custom` or `integration`.
            provider:
              type: string
              description: >-
                Si el tipo es `integration` entonces este campo contendrá el
                proveedor de la integración.
        invoicing:
          type: object
          properties:
            name:
              type: string
              description: Nombre del tipo de documento para el comprobante.
            erpCode:
              type: string
              description: El código ERP del documento del pedido.
            documentNumber:
              type: string
              description: Número de documento del pedido.
            fiscalName:
              type: string
              description: Nombre fiscal del cliente.
            fiscalAddress:
              type: string
              description: Dirección fiscal del cliente.
        creator:
          type: object
          properties:
            name:
              type: string
              description: Nombre del creador del pedido.
            erpCode:
              type: string
              description: Código ERP del creador.
        channel:
          type: string
          description: Canal desde el que se realizó el pedido.
        comments:
          type: string
          description: Comentarios del pedido.
        note:
          type: string
          description: Nota del pedido.
        locker:
          type: object
          properties:
            name:
              type: string
              description: Nombre de quien aprobó el pedido.
            erpCode:
              type: string
              description: Código ERP de quien aprobó el pedido.
        lockedAt:
          type: string
          description: La fecha de aprobación del pedido.
        inventory:
          type:
            - object
            - 'null'
          description: El almacén asociado al pedido.
          properties:
            name:
              type: string
              description: El nombre del almacén.
            erpCode:
              type:
                - string
                - 'null'
              description: El código ERP del almacén.
  securitySchemes:
    API Key:
      name: api-key
      type: apiKey
      in: header
      description: >-
        Todas las llamadas al API tienen que contener este header junto a la
        clave para poder autenticar y autorizar al cliente.

````