GET /api/shopify/inventory_batches
List of inventory batches based on pagination, search, and filter (by variant ID or location ID or both).

Errors

Code	Description
401	The provided token is invalid

Examples

// invalid token
GET /api/shopify/inventory_batches?location_id=1000&variant_id=2000&page=1&search=Inventory+Batch
401
HTTP Token: Access denied.

// valid token
GET /api/shopify/inventory_batches?location_id=1000&variant_id=2000&page=1&search=Inventory+Batch
200
[
  {
    "id": 4037,
    "quantity": 55,
    "expired_at": null,
    "expiry_date": "2023-07-13 05:48:06 UTC",
    "received_date": "2023-07-03 05:48:06 UTC",
    "metadata": {
      "batch_name": "Inventory Batch"
    },
    "created_at": "2023-07-03 05:48:06 UTC",
    "updated_at": "2023-07-03 05:48:06 UTC",
    "notified_at": null,
    "discounted": false,
    "location_id": 1000,
    "variant_id": 2000
  }
]

Params

Param name	Description
location_id optional	Shopify location ID Validations: Must be a Integer
variant_id optional	Shopify variant ID Validations: Must be a Integer
page optional	Page number Validations: Must be a Integer
search optional	Search by inventory batch batch_name, batch_number, barcode, invoice_number description or product title or variant title or barcode Validations: Must be a String

Headers

Header name	Description
Authorization required	Bearer token