Admin api products

List product variants

GET
/api/admin/v2/products/variants

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

minCreatedAt?string
Formatdate-time
maxCreatedAt?string
Formatdate-time
minUpdatedAt?string
Formatdate-time
maxUpdatedAt?string
Formatdate-time
offset?integer

Pagination offset

Range0 <= value
count?integer

Number of results

Default50
Range1 <= value <= 200
productId?array<>

Filter by productId(s)

name?array<>

Filter by name(s)

barcode?array<>

Filter by barcode(s)

externalId?array<>

Filter by externalId(s)

invalidThumbnail?boolean

Filter by invalidThumbnail

isDefault?boolean

Filter by isDefault flag

Response Body

application/json

application/json

curl -X GET "https://oasis-api.public.sandbox.oasis.aifi.com/api/admin/v2/products/variants?minCreatedAt=2024-09-22T00%3A00%3A00.000Z&maxCreatedAt=2024-09-29T00%3A00%3A00.000Z&minUpdatedAt=2024-09-23T00%3A00%3A00.000Z&maxUpdatedAt=2024-09-30T00%3A00%3A00.000Z"
{
  "variants": [
    {
      "id": 0,
      "name": "string",
      "thumbnail": "string",
      "invalidThumbnail": true,
      "externalId": "string",
      "weight": "string",
      "barcodes": [
        {
          "isDefault": true,
          "barcode": "string"
        }
      ],
      "isDefault": true,
      "productId": 0
    }
  ],
  "pagination": {
    "previous": {
      "count": 0,
      "before": "string",
      "direction": "asc"
    },
    "next": {
      "count": 0,
      "after": "string",
      "direction": "asc"
    }
  }
}
Empty
{
  "message": "Invalid request body",
  "type": "E_INVALID_BODY",
  "errors": [
    {
      "error": "\"email\" is required",
      "rule": "any.required",
      "field": "\"email\""
    }
  ]
}

How is this guide?

AiFI AI Chat

Beta

Powered by AiFi

Ask docs or API questions to get grounded answers.