Products

Upsert Product Locations

Creates or updates the availability and inventory messaging for the Product at one or more Locations.

Send an array of product_locations. Each entry identifies its Location by either location_id (LiftForward id) or merchant_location_id (your own id). The whole array is applied in a single transaction — if any entry is invalid, nothing is saved.

post/products/{product_id}/locations

Request

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

Path parameters

product_idstring required

Request body

Example request

{
  "product_locations": [
    {
      "location_id": "hq293ftftzy8g5jr5c2g97wtzrf",
      "merchant_location_id": "62CR",
      "available": true,
      "inventory_message": "Available at this store",
      "inventory_help_message": "Ready for pickup today"
    }
  ]
}

Response

Upsert 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.