Services

Commerce Resources · 5 endpoints

GET/v1/services

List Services

app_install_bearerscope: services:read

Parameters

Field	Type	Required
`limit`query	`integer`	optional
`starting_after`query	`string`	optional
`ending_before`query	`string`	optional

Returns · 200

Field	Type	Required	Description
`data`	`ServiceListResponse`	required
`data.has_more`	`boolean`

Loading documentation...

POST/v1/services

Create Service

app_install_bearerscope: services:writeidempotent

Parameters

Field	Type	Required	Description
`Idempotency-Key`header	`string`	required	Unique key used to make this mutation retry-safe for the replay window.

Request body · application/json

Field	Type	Required	Description
`billing_period`	`string`	optional
`category_id`	`string`	optional
`compare_at_price`	`number \| string`	optional
`description`	`string`	optional
`description_html`	`string`	optional
`image_alt_text`	`string`	optional
`image_url`	`string`	optional
`is_active`	`boolean`	optional
`is_popular`	`boolean`	optional
`media_id`	`string`	optional
`name`	`string`	required
`price`	`number \| string`	optional
`service_code`	`string`	optional
`short_description`	`string`	optional
`slug`	`string`	optional
`sort_order`	`integer`	optional
`status`	`string`	optional	draft, active, published
`tax_code`	`string`	optional
`taxable`	`boolean`	optional

Returns · 200

Field	Type	Required
`data`	`ServiceObject`	required
`data.billing_period`	`string`	optional
`data.category_id`	`string`	optional
`data.category_name`	`string`	optional
`data.compare_at_price`	`string`	optional
`data.created_at`	`string`	optional
`data.description`	`string`	optional
`data.description_html`	`string`	optional
`data.id`	`string`	required

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/services \
  -X POST \
  -H "Authorization: Bearer $GETME_API_KEY" \
  -H "Idempotency-Key: idem_1234567890abcdef" \
  -H "Content-Type: application/json" \
  -d '{
    "billing_period": "billing_period",
    "category_id": "category_id",
    "compare_at_price": "compare_at_price",
    "description": "description",
    "description_html": "description_html",
    "image_alt_text": "image_alt_text"
  }'

GET/v1/services/{service_id}

Get Service

app_install_bearerscope: services:read

Parameters

Field	Type	Required	Description
`service_id`path	`string`	required	Service public identifier in serv_<21 Base62> format.

Returns · 200

Field	Type	Required	Description
`data`	`ServiceObject`	required
`data.billing_period`	`string`	optional
`data.category_id`	`string`	optional
`data.category_name`	`string`	optional
`data.compare_at_price`	`string`	optional
`data.created_at`	`string`	optional
`data.description`	`string`	optional
`data.description_html`	`string`	optional
`data.id`	`string`	required
`data.image_alt_text`	`string`	optional
`data.image_url`	`string`	optional
`data.is_active`	`boolean`	optional
`data.is_popular`	`boolean`	optional
`data.media_id`	`string`	optional
`data.name`	`string`	required
`data.object`	`string`	optional	service
`data.price`	`string`	optional
`data.service_code`	`string`	optional
`data.short_description`	`string`	optional
`data.slug`	`string`	optional
`data.sort_order`	`integer`	optional
`data.status`	`string`	optional
`data.tax_code`	`string`	optional
`data.taxable`	`boolean`	optional
`data.updated_at`	`string`	optional
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/services/{service_id} \
  -H "Authorization: Bearer $GETME_API_KEY"

PATCH/v1/services/{service_id}

Update Service

app_install_bearerscope: services:writeidempotent

Parameters

Field	Type	Required	Description
`service_id`path	`string`	required	Service public identifier in serv_<21 Base62> format.
`Idempotency-Key`header	`string`	required	Unique key used to make this mutation retry-safe for the replay window.

Request body · application/json

Field	Type	Required	Description
`billing_period`	`string`	optional
`category_id`	`string`	optional
`compare_at_price`	`number \| string`	optional
`description`	`string`	optional
`description_html`	`string`	optional
`image_alt_text`	`string`	optional
`image_url`	`string`	optional
`is_active`	`boolean`	optional
`is_popular`	`boolean`	optional
`media_id`	`string`	optional
`name`	`string`	optional
`price`	`number \| string`	optional
`service_code`	`string`	optional
`short_description`	`string`	optional
`slug`	`string`	optional
`sort_order`	`integer`	optional
`status`	`string`	optional	draft, active, published
`tax_code`	`string`	optional
`taxable`	`boolean`	optional

Returns · 200

Field	Type	Required
`data`	`ServiceObject`	required
`data.billing_period`	`string`	optional
`data.category_id`	`string`	optional
`data.category_name`	`string`	optional
`data.compare_at_price`	`string`	optional
`data.created_at`	`string`	optional
`data.description`	`string`	optional
`data.description_html`	`string`	optional
`data.id`	`string`	required

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/services/{service_id} \
  -X PATCH \
  -H "Authorization: Bearer $GETME_API_KEY" \
  -H "Idempotency-Key: idem_1234567890abcdef" \
  -H "Content-Type: application/json" \
  -d '{
    "billing_period": "billing_period",
    "category_id": "category_id",
    "compare_at_price": "compare_at_price",
    "description": "description",
    "description_html": "description_html",
    "image_alt_text": "image_alt_text"
  }'

POST/v1/services/{service_id}/archive

Archive Service

app_install_bearerscope: services:writeidempotent

Parameters

Field	Type	Required	Description
`service_id`path	`string`	required	Service public identifier in serv_<21 Base62> format.
`Idempotency-Key`header	`string`	required	Unique key used to make this mutation retry-safe for the replay window.

Returns · 200

Field	Type	Required	Description
`data`	`ServiceObject`	required
`data.billing_period`	`string`	optional
`data.category_id`	`string`	optional
`data.category_name`	`string`	optional
`data.compare_at_price`	`string`	optional
`data.created_at`	`string`	optional
`data.description`	`string`	optional
`data.description_html`	`string`	optional
`data.id`	`string`	required
`data.image_alt_text`	`string`	optional
`data.image_url`	`string`	optional
`data.is_active`	`boolean`	optional
`data.is_popular`	`boolean`	optional
`data.media_id`	`string`	optional
`data.name`	`string`	required
`data.object`	`string`	optional	service
`data.price`	`string`	optional
`data.service_code`	`string`	optional
`data.short_description`	`string`	optional
`data.slug`	`string`	optional
`data.sort_order`	`integer`	optional
`data.status`	`string`	optional
`data.tax_code`	`string`	optional
`data.taxable`	`boolean`	optional
`data.updated_at`	`string`	optional
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/services/{service_id}/archive \
  -X POST \
  -H "Authorization: Bearer $GETME_API_KEY" \
  -H "Idempotency-Key: idem_1234567890abcdef"