LIliftforward
Products

Index Product Locations

Returns the per-location availability and inventory messaging configured for the Product.

Supply a location_id (LiftForward id) or merchant_location_id (your own id) to fetch a single Location. Use the page and per_page parameters to paginate the results.

get/products/{product_id}/locations

Request

  • Base URL
    https://api.liftforward.com
  • Auth
    API key in header Api-Key

Path parameters

product_idstring required

Query parameters

pageinteger

Indicates which page of results to return.

per_pageinteger

Indicates the number of results to include in each page.

location_idstring

Filter to a single Location by its LiftForward id.

merchant_location_idstring

Filter to a single Location by the merchant's own id.

Response

Index Product Locations

Example response

{
  "product_locations": [
    {
      "location_id": "d334fp3xa7z43qs7dxqa4xbj4nz",
      "merchant_location_id": "62CR",
      "available": true,
      "inventory_message": "Available at this store",
      "inventory_help_message": "Ready for pickup today"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 25,
    "total_pages": 10,
    "total_records": 250
  }
}

Changes

No recorded changes to this operation across all 8 revisions of this API.