Skip to main content
POST
Create a service
Creates a service in the store. The shop is set server-side from the installation and must not be supplied. Services have no category field. Requires the WRITE_INVENTORY scope.

Authorizations

Authorization
string
header
required

Installed-app access token (prefix app_), issued by the OAuth install flow. The store is bound to the token server-side — never send a shop id.

Body

application/json
name
string
required

Service name (max 100 chars).

price
number
required

Price (>= 0).

description
string

Service description.

promoPrice
number | null

Promotional price (>= 0); nullable.

images
string[]

Array of image URLs.

video
string | null

Video URL; nullable.

available
boolean

Whether the service is available to book. Default true.

listed
boolean

Whether the service is listed on the storefront. Default true.

addons
object[]

Optional add-ons. Each: name (string, required), price (number, required), maxQuantity (integer, default 10), image (string), available (boolean, default true), description (string).

Response

Create a service — success.

status
integer
required
Example:

201

success
boolean
required
Example:

true

message
string
required
Example:

"Create a service"

data
object
required

A business service item.

Example: