Obtener - Riqra

Obtener

curl --request GET \
  --url https://sandbox.api.riqra.com/orders/{orderId} \
  --header 'api-key: <api-key>'

{
  "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",
  "locker": {
    "name": "string",
    "erpCode": "string"
  },
  "lockedAt": "string"
}

GET

orders

{orderId}

Obtener

curl --request GET \
  --url https://sandbox.api.riqra.com/orders/{orderId} \
  --header 'api-key: <api-key>'

{
  "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",
  "locker": {
    "name": "string",
    "erpCode": "string"
  },
  "lockedAt": "string"
}

Authorizations

api-key

string

header

required

Todas las llamadas al API tienen que contener este header junto a la clave para poder autenticar y autorizar al cliente.

Path Parameters

orderId

string

required

ID del pedido.

Response

integer

El ID del pedido.

code

string

El código del pedido.

erpCode

string

El código ERP de integración.

status

string

El estado del pedido.

vendor

string

El vendor donde esta órden fue generada.

createdAt

string<date-time>

La fecha de creación del pedido.

total

string

El total del pedido.

finalTotal

string

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

object

dedicationMessage

string

La dedicatoria añadida por el cliente.

giftMessage

string

El mensaje de regalo en caso que se trate de un regalo.

creationDate

string

Fecha en el formato AAAAMMDD (20200409).

creationTime

string

Hora en el formato HH:mm:ss (17:04:00).

updatedAt

string<date-time>

La fecha de la última actualización del pedido.

userAgent

string

Parámetro que recibe toda la data desde el sistema operativo hasta el modelo del dispositivo con el que se realizó la compra.

customer

object

Mostrar atributos secundarios

customer.id

integer

customer.firstName

string

El primer nombre del cliente.

customer.lastName

string

El apellido del cliente.

customer.email

string

El email del cliente.

customer.phone

string

El celular del cliente.

customer.erpCode

string

El código interno del cliente.

contactPerson

object

Mostrar atributos secundarios

contactPerson.documentNumber

string

Número de documento de la persona de contacto.

contactPerson.firstName

string

El primer nombre de la persona de contacto.

contactPerson.lastName

string

El apellido de la persona de contacto.

contactPerson.phone

string

El celular de la persona de contacto.

lineItems

object[]

Los elementos que peretenecen a una orden.

Mostrar atributos secundarios

lineItems.id

integer

lineItems.name

string

El nombre del producto.

lineItems.presentation

string

El nombre de presentación del producto.

lineItems.sku

string

El SKU del producto.

lineItems.erpCode

string

El código ERP del producto.

lineItems.quantity

integer

La cantidad comprada para ese producto.

lineItems.price

string

El precio del producto en formato de 2 decimales.

lineItems.adjustmentsTotal

string

El total de descuento aplicado al elemento.

allAdjustments

object[]

Mostrar atributos secundarios

allAdjustments.promotionName

string

Nombre de la promoción aplicada al pedido.

allAdjustments.couponCode

string

Código de promoción aplicada al pedido.

allAdjustments.amount

string

Monto total del descuento de promoción que se aplicó al pedido.

allAdjustments.type

enum<string>

Tipo de ajuste.

Opciones disponibles:

delivery-discount,

product-discount,

order-discount,

create-line-item

allAdjustments.configuration

object

Mostrar atributos secundarios

allAdjustments.configuration.type

string

Tipo de descuento que se aplica al pedido. Puede ser fixed o percent.

allAdjustments.configuration.value

number

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

object

Mostrar atributos secundarios

pricing.adjustmentsTotal

string

Suma de todos los descuentos aplicados al pedido.

pricing.subTotal

string

Suma total de los artículos del pedido.

pricing.tax

string

Impuestos.

pricing.deliveryCost

string

Costo de envío.

pricing.total

string

Costo total del pedido.

pricing.perception

string

Porcentage adicional sobre el total de la orden. Este campo es relacionado al régimen de percepción.

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.

pricing.finalTotal

string

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

object

Mostrar atributos secundarios

shipping.name

string

Método de entrega.

shipping.deliveryAddress

object

Dirección de entrega para el envío.

Mostrar atributos secundarios

shipping.deliveryAddress.id

number

shipping.deliveryAddress.address

string

Dirección de entrega.

shipping.deliveryAddress.apartment

string

Número del departamento del cliente.

shipping.deliveryAddress.reference

string

Referencia de la dirección.

shipping.deliveryAddress.coordinates

string

Coordenadas con un formato de 'latitude,longitude'.

shipping.deliveryAddress.divisionLevel1

string

Primer nivel de división administrativa de tu país.

shipping.deliveryAddress.divisionLevel2

string

Segundo nivel de división administrativa de tu país.

shipping.deliveryAddress.divisionLevel3

string

Tercer nivel de división administrativa de tu país.

shipping.deliveryAddress.divisionLevel4

string

Cuarto nivel de división administrativa de tu país.

shipping.deliveryAddress.contactPerson

string

Persona que recibirá el pedido.

shipping.deliveryAddress.contactPhone

string

El número de teléfono de la persona de contacto.

shipping.deliveryAddress.code

string

Sistema de codificación para ubicaciones geográficas.

shipping.deliveryAddress.erpCode

string

Código interno de la dirección del cliente.

shipping.territory

object

Mostrar atributos secundarios

shipping.territory.name

string

Nombre del territorio.

shipping.territory.metadata

object

Este valor contiene toda la metadata relacionada con el territorio.

shipping.deliveryDate

string<date>

Fecha de entrega.

shipping.deliveryTimeRange

string

Rango de tiempo en la que se hará la entrega.

shipping.pickupInStore

object

Información de la tienda de recojo.

Mostrar atributos secundarios

shipping.pickupInStore.name

string

Nombre de la tienda.

shipping.pickupInStore.address

string

Dirección de la tienda.

shipping.pickupInStore.coordinates

string

Coordenadas en un formato de 'latitude,longitude'.

shipping.pickupDate

string<date>

Fecha de recojo en tienda.

shipping.pickupTimeRange

string

Rango de tiempo en la que se puede recoger en tienda.

shipping.shipment

object

Los datos de la entrega.

Mostrar atributos secundarios

shipping.shipment.id

string

ID del envío creado por el proveedor de entrega de última milla.

payment

object

Mostrar atributos secundarios

payment.name

string

Nombre del método de pago.

payment.erpCode

string

El código ERP del método de pago.

payment.transactionId

string

ID de la transacción, incluida cuando el método de pago es tarjeta de débito o crédito.

payment.type

string

Tipo del método de pago. Puede ser deposit, line-of-credit, custom or integration.

payment.provider

string

Si el tipo es integration entonces este campo contendrá el proveedor de la integración.

invoicing

object

Mostrar atributos secundarios

invoicing.name

string

Nombre del tipo de documento para el comprobante.

invoicing.erpCode

string

El código ERP del documento del pedido.

invoicing.documentNumber

string

Número de documento del pedido.

invoicing.fiscalName

string

Nombre fiscal del cliente.

invoicing.fiscalAddress

string

Dirección fiscal del cliente.

creator

object

Mostrar atributos secundarios

creator.name

string

Nombre del creador del pedido.

creator.erpCode

string

Código ERP del creador.

channel

string

Canal desde el que se realizó el pedido.

comments

string

Comentarios del pedido.

note

string

Nota del pedido.

locker

object

Mostrar atributos secundarios

locker.name

string

Nombre de quien aprobó el pedido.

locker.erpCode

string

Código ERP de quien aprobó el pedido.

lockedAt

string

La fecha de aprobación del pedido.

purchaseOrderUrl

string

URL del documento que contiene la orden de compra.

purchaseOrderNumber

string

El número de la orden de compra.

Actualizar estados Actualizar

⌘I

Documentación

Referencia

Authorizations

Path Parameters

Response