Skip to main content
GET
/
2023-11
/
admin
/
productVariants
{
  "data": [
    {
      "barcode": "456340560",
      "base_title": "Default Title",
      "buffer_minutes": 0,
      "compare_at_price": null,
      "composite_stocks": [],
      "created_at": "2025-10-09T13:03:54.000000Z",
      "deleted_at": null,
      "deposit": null,
      "duration_minutes": 0,
      "estimated_quantity": null,
      "estimated_quantity_by_warehouse": [],
      "follow_stock": 0,
      "id": "01k74h4addkn48aptf2xyp5cyw",
      "image_id": null,
      "metadata": null,
      "min_order_quantity": 1,
      "options": [
        0
      ],
      "position": 1,
      "price": 6500,
      "product": {
        "collections": [],
        "company_id": "01k7464hqksr4f99rp3ff7x2jz",
        "content": "Une description ici",
        "created_at": "2025-10-09T13:03:54.000000Z",
        "deleted_at": null,
        "handle": "arachide-blanc-du-ndolet",
        "id": "01k74h4acesr6y7vp6krqt5dqf",
        "is_shippable": 1,
        "is_taxable": 1,
        "medias": [],
        "menus": [],
        "metadata": {
          "image_ready": false
        },
        "options": [
          {
            "created_at": "2025-10-09T13:03:54.000000Z",
            "deleted_at": null,
            "id": "01k74h4afrgjy1st477j1esybm",
            "metadata": {
              "image_ready": false
            },
            "position": 1,
            "product_id": "01k74h4acesr6y7vp6krqt5dqf",
            "title": "Title",
            "updated_at": "2025-10-09T13:07:29.000000Z",
            "values": [
              "Default Title"
            ]
          }
        ],
        "published": 1,
        "shops": [
          {
            "address": null,
            "company_id": "01k7464hqksr4f99rp3ff7x2jz",
            "created_at": "2025-10-09T09:51:50.000000Z",
            "currency_code": "XAF",
            "currency_name": null,
            "deleted_at": null,
            "description": "This is the first shop",
            "domains": [],
            "id": "01k7464m19emgj0q6v0v95wp88",
            "logo": null,
            "logoUrl": "",
            "metadata": null,
            "name": "Pet Clinic Shop",
            "pivot": {
              "product_id": "01k74h4acesr6y7vp6krqt5dqf",
              "shop_id": "01k7464m19emgj0q6v0v95wp88"
            },
            "slug": "pet-clinic-shop",
            "updated_at": "2025-10-09T09:51:50.000000Z",
            "warehouses": [
              {
                "company_id": "01k7464hqksr4f99rp3ff7x2jz",
                "created_at": "2025-10-09T09:51:50.000000Z",
                "deleted_at": null,
                "description": "This is the first warehouse",
                "id": "01k7464m1pykz767t3rv9d4q76",
                "metadata": null,
                "name": "Pet Clinic Warehouse",
                "pivot": {
                  "metadata": null,
                  "shop_id": "01k7464m19emgj0q6v0v95wp88",
                  "warehouse_id": "01k7464m1pykz767t3rv9d4q76"
                },
                "updated_at": "2025-10-09T09:51:50.000000Z"
              }
            ]
          }
        ],
        "supplier_id": null,
        "title": "Arachide blanc du ndolet",
        "type": "physical_goods",
        "updated_at": "2025-10-09T13:07:29.000000Z",
        "variants": [
          {
            "barcode": "456340560",
            "compare_at_price": null,
            "created_at": "2025-10-09T13:03:54.000000Z",
            "deleted_at": null,
            "follow_stock": 0,
            "id": "01k74h4addkn48aptf2xyp5cyw",
            "image_id": null,
            "metadata": null,
            "min_order_quantity": 1,
            "options": [
              0
            ],
            "position": 1,
            "price": 6500,
            "product_id": "01k74h4acesr6y7vp6krqt5dqf",
            "sku": "le paquet",
            "taxable": 1,
            "title": "Default Title",
            "updated_at": "2025-10-09T13:03:54.000000Z",
            "whatsapp_product_id": null
          }
        ],
        "vendor": null
      },
      "product_id": "01k74h4acesr6y7vp6krqt5dqf",
      "professionals": [],
      "service": {
        "buffer_minutes": 0,
        "created_at": "2025-10-09T13:03:54.000000Z",
        "deleted_at": null,
        "deposit": null,
        "duration_minutes": 0,
        "id": "01k74h4aeabwm6pkc1m5m9kjfp",
        "metadata": null,
        "product_variant_id": "01k74h4addkn48aptf2xyp5cyw",
        "professionals": [],
        "updated_at": "2025-10-09T13:03:54.000000Z"
      },
      "service_id": "01k74h4aeabwm6pkc1m5m9kjfp",
      "sku": "le paquet",
      "supplierproduct": null,
      "taxable": 1,
      "title": "Arachide blanc du ndolet",
      "updated_at": "2025-10-09T13:03:54.000000Z",
      "whatsapp_product_id": null
    }
  ],
  "links": {
    "first": "http://genuka-api.test/2023-11/admin/productVariants?page=1",
    "last": "http://genuka-api.test/2023-11/admin/productVariants?page=1",
    "next": null,
    "prev": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "active": false,
        "label": "« Previous",
        "page": null,
        "url": null
      },
      {
        "active": true,
        "label": "1",
        "page": 1,
        "url": "http://genuka-api.test/2023-11/admin/productVariants?page=1"
      },
      {
        "active": false,
        "label": "Next »",
        "page": null,
        "url": null
      }
    ],
    "path": "http://genuka-api.test/2023-11/admin/productVariants",
    "per_page": 15,
    "to": 1,
    "total": 1
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-company
string
Example:

"{{companyId}}"

Query Parameters

include
string
Example:

"product"

sort
string
Example:

"updated_at"

Response

200 - application/json

200 OK

data
object[]
Example:
[
{
"barcode": "456340560",
"base_title": "Default Title",
"buffer_minutes": 0,
"compare_at_price": null,
"composite_stocks": [],
"created_at": "2025-10-09T13:03:54.000000Z",
"deleted_at": null,
"deposit": null,
"duration_minutes": 0,
"estimated_quantity": null,
"estimated_quantity_by_warehouse": [],
"follow_stock": 0,
"id": "01k74h4addkn48aptf2xyp5cyw",
"image_id": null,
"metadata": null,
"min_order_quantity": 1,
"options": [0],
"position": 1,
"price": 6500,
"product": {
"collections": [],
"company_id": "01k7464hqksr4f99rp3ff7x2jz",
"content": "Une description ici",
"created_at": "2025-10-09T13:03:54.000000Z",
"deleted_at": null,
"handle": "arachide-blanc-du-ndolet",
"id": "01k74h4acesr6y7vp6krqt5dqf",
"is_shippable": 1,
"is_taxable": 1,
"medias": [],
"menus": [],
"metadata": { "image_ready": false },
"options": [
{
"created_at": "2025-10-09T13:03:54.000000Z",
"deleted_at": null,
"id": "01k74h4afrgjy1st477j1esybm",
"metadata": { "image_ready": false },
"position": 1,
"product_id": "01k74h4acesr6y7vp6krqt5dqf",
"title": "Title",
"updated_at": "2025-10-09T13:07:29.000000Z",
"values": ["Default Title"]
}
],
"published": 1,
"shops": [
{
"address": null,
"company_id": "01k7464hqksr4f99rp3ff7x2jz",
"created_at": "2025-10-09T09:51:50.000000Z",
"currency_code": "XAF",
"currency_name": null,
"deleted_at": null,
"description": "This is the first shop",
"domains": [],
"id": "01k7464m19emgj0q6v0v95wp88",
"logo": null,
"logoUrl": "",
"metadata": null,
"name": "Pet Clinic Shop",
"pivot": {
"product_id": "01k74h4acesr6y7vp6krqt5dqf",
"shop_id": "01k7464m19emgj0q6v0v95wp88"
},
"slug": "pet-clinic-shop",
"updated_at": "2025-10-09T09:51:50.000000Z",
"warehouses": [
{
"company_id": "01k7464hqksr4f99rp3ff7x2jz",
"created_at": "2025-10-09T09:51:50.000000Z",
"deleted_at": null,
"description": "This is the first warehouse",
"id": "01k7464m1pykz767t3rv9d4q76",
"metadata": null,
"name": "Pet Clinic Warehouse",
"pivot": {
"metadata": null,
"shop_id": "01k7464m19emgj0q6v0v95wp88",
"warehouse_id": "01k7464m1pykz767t3rv9d4q76"
},
"updated_at": "2025-10-09T09:51:50.000000Z"
}
]
}
],
"supplier_id": null,
"title": "Arachide blanc du ndolet",
"type": "physical_goods",
"updated_at": "2025-10-09T13:07:29.000000Z",
"variants": [
{
"barcode": "456340560",
"compare_at_price": null,
"created_at": "2025-10-09T13:03:54.000000Z",
"deleted_at": null,
"follow_stock": 0,
"id": "01k74h4addkn48aptf2xyp5cyw",
"image_id": null,
"metadata": null,
"min_order_quantity": 1,
"options": [0],
"position": 1,
"price": 6500,
"product_id": "01k74h4acesr6y7vp6krqt5dqf",
"sku": "le paquet",
"taxable": 1,
"title": "Default Title",
"updated_at": "2025-10-09T13:03:54.000000Z",
"whatsapp_product_id": null
}
],
"vendor": null
},
"product_id": "01k74h4acesr6y7vp6krqt5dqf",
"professionals": [],
"service": {
"buffer_minutes": 0,
"created_at": "2025-10-09T13:03:54.000000Z",
"deleted_at": null,
"deposit": null,
"duration_minutes": 0,
"id": "01k74h4aeabwm6pkc1m5m9kjfp",
"metadata": null,
"product_variant_id": "01k74h4addkn48aptf2xyp5cyw",
"professionals": [],
"updated_at": "2025-10-09T13:03:54.000000Z"
},
"service_id": "01k74h4aeabwm6pkc1m5m9kjfp",
"sku": "le paquet",
"supplierproduct": null,
"taxable": 1,
"title": "Arachide blanc du ndolet",
"updated_at": "2025-10-09T13:03:54.000000Z",
"whatsapp_product_id": null
}
]
meta
object