Obtener

Obtener

curl --request GET \
  --url https://sandbox.api.riqra.com/products/{productId}/variants/{variantId} \
  --header 'api-key: <api-key>'

{
  "data": {
    "id": 123,
    "sku": "<string>",
    "erpCode": "<string>",
    "price": 123,
    "stock": 123,
    "images": [
      {
        "url": "<string>",
        "order": 123
      }
    ],
    "order": 123,
    "priceIsTaxExempt": true,
    "salesUnitFactor": 1,
    "jumpFactor": 1,
    "attributes": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ],
    "extraFields": {},
    "weight": 123,
    "length": 123,
    "width": 123,
    "height": 123
  }
}

GET

products

{productId}

variants

{variantId}

Obtener

curl --request GET \
  --url https://sandbox.api.riqra.com/products/{productId}/variants/{variantId} \
  --header 'api-key: <api-key>'

{
  "data": {
    "id": 123,
    "sku": "<string>",
    "erpCode": "<string>",
    "price": 123,
    "stock": 123,
    "images": [
      {
        "url": "<string>",
        "order": 123
      }
    ],
    "order": 123,
    "priceIsTaxExempt": true,
    "salesUnitFactor": 1,
    "jumpFactor": 1,
    "attributes": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ],
    "extraFields": {},
    "weight": 123,
    "length": 123,
    "width": 123,
    "height": 123
  }
}

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

productId

integer

required

variantId

integer

required

Response

200 - application/json

data

ProductVariant · object

Mostrar atributos secundarios

data.id

integer

required

ID del recurso.

data.sku

string

required

SKU(Stock Keeping Unit) de la variante del producto.

data.erpCode

string

required

data.price

number<float>

required

Precio de la lista de precios por defecto.

data.stock

integer<int64>

required

Stock del almacén por defecto.

data.images

ProductImages · object[]

required

Maximum array length: 5

Mostrar atributos secundarios

data.images.url

string<uri>

required

URL válida de la imagen.

data.images.order

integer

Orden de la imagen respecto a las otras imágenes.

data.order

integer

required

Orden de variantes entre todas las demás variantes, si existe más de una.

data.priceIsTaxExempt

boolean

Indica si el precio de la variante está o no exento del cálculo de impuestos.

data.salesUnitFactor

number<float>

default:1

La cantidad de ventas de este producto es un múltiplo de este valor.

El valor debe tener como máximo 2 valores decimales.

data.jumpFactor

integer<int64>

default:1

JumpFactor de un producto: es un múltiplo en el que saltará el contador. Ejemplo: si jumpFactor es 4, la cantidad mínima a comprar será 4, entonces el contador pasará de 4 a 8, de 8 a 12 y así sucesivamente.

El valor debe ser un número entero positivo.

Rango requerido: x >= 1

data.attributes

object[]

Atributos con sus valores que siguen los nombres dictados por el producto padre (principal).

Mostrar atributos secundarios

data.attributes.name

string

data.attributes.value

string

data.extraFields

ProductExtraFields · object

Objeto JSON válido de campos adicionales.

data.weight

number

Peso de la variante.

data.length

number

Largura de la variante.

data.width

number

Anchura de la variante.

data.height

number

Altura de la variante.

Crear Eliminar

⌘I

Documentación

Referencia

Authorizations

Path Parameters

Response