Create a product

Create a new product within a location. Prices are in the smallest currency unit (cents for USD). Product images and options can be added via the dashboard.

Required scope

The access token must carry this scope. A token missing it gets 403 Forbidden. Grant them to an API client under Settings → Company → API, and to a teammate under Employee → Permissions.

products:write

Request Body

Property	Type	Required	Description
`locationId`	string	Required	Location that owns the product.
`name`	string	Required	Product name.
`description`	string	Required	Product description (may be empty).
`price`	number	Required	Price in cents.
`stock`	number	Optional	Current stock count (default 0).
`stockUnit`	string	Optional	Unit label (e.g. "unit", "lb").
`stockEnabled`	boolean	Optional	Whether stock tracking is on.
`recurring`	boolean	Optional	Whether the product is a subscription.
`recurringInterval`	string	Optional	Billing interval for subscriptions.
`recurringIntervalCount`	number	Optional	Number of intervals between billings.

POSTExample request

curl

curl -X POST "https://www.pxb.app/api/public/v1/products" \
  -H "Authorization: Bearer your_access_token" \
  -H "Content-Type: application/json" \
  -d '{
    "locationId": "loc_abc",
    "name": "Annual Subscription",
    "description": "Yearly access to the platform.",
    "price": 12000,
    "recurring": true,
    "recurringInterval": "year",
    "recurringIntervalCount": 1
  }'

200Example response

json

{
  "message": "Product created successfully!",
  "content": {
    "product": {
      "id": "prod_1"
    }
  }
}

In the console

The same thing done by hand, for anyone comparing the API against the screen they already use.

Inventory → Products

/inventory/products

Add a product.