curl -X POST "https://dash.lockii.app/api/v1/product" \ -H "x-api-key: $LOCKII_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "id": "string", "name": "string", "description": "string", "imageID": "string", "pricePerHourCents": -9007199254740991, "basePriceCents": -9007199254740991, "companyID": "string", "updatedAt": 0, "archived": true }'

API referenceProduct

Create Product

Create a new product. App connections need the inventory:write scope.

POST

/api/v1/product

POST

/product

curl -X POST "https://dash.lockii.app/api/v1/product" \
  -H "x-api-key: $LOCKII_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "id": "string",
  "name": "string",
  "description": "string",
  "imageID": "string",
  "pricePerHourCents": -9007199254740991,
  "basePriceCents": -9007199254740991,
  "companyID": "string",
  "updatedAt": 0,
  "archived": true
}'

Authorization

x-api-key
string
header
API key from Settings → Integrations → API.
Authorization
string
header
The same API key, or an OAuth access token, sent as Authorization: Bearer.
api_key
string
query
API key query parameter.

Body

application/json

id
string
required
name
string
required
Product name
description
string
required
Renter-facing description
imageID
string
required
Primary image ID
additionalImageIDs
string[] | null
Extra gallery image IDs
pricePerHourCents
integer
required
Hourly price in cents
basePriceCents
integer
required
Base/daily price in cents
pricingTemplateID
string | null
Pricing template ID for tiers. Omit on updates unless changing pricing.
categoryID
string | null
Category ID. Omit on updates unless changing category.
companyID
string
required
updatedAt
number
required
archived
boolean
required
hiddenFromBrowse
boolean
Default:
false
slug
string | null
sortOrder
number | null
siteTemplatePageID
string | null
Website product template page. Null uses the default.

Response

application/json

JSON result for this operation.

object

{}