Products

Commerce Resources · 5 endpoints

GET/v1/products

List Products

app_install_bearerscope: products: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`	`ProductListResponse`	required
`data.has_more`	`boolean`	required
`data.items`	`ProductObject[]`	required
`data.items[].brand_id`	`string`	optional
`data.items[].brand_name`	`string`	optional
`data.items[].category_id`	`string`	optional
`data.items[].category_name`	`string`	optional
`data.items[].compare_at_price`	`string`	optional
`data.items[].continue_selling_when_out_of_stock`	`boolean`	optional
`data.items[].created_at`	`string`	optional
`data.items[].description`	`string`	optional
`data.items[].description_html`	`string`	optional
`data.items[].google_product_category_id`	`string`	optional
`data.items[].id`	`string`	required
`data.items[].image_alt_text`	`string`	optional
`data.items[].image_url`	`string`	optional
`data.items[].is_active`	`boolean`	optional
`data.items[].low_stock_threshold`	`integer`	optional
`data.items[].name`	`string`	required
`data.items[].object`	`string`	optional	product
`data.items[].price`	`string`	optional
`data.items[].requires_shipping`	`boolean`	optional
`data.items[].short_description`	`string`	optional
`data.items[].sku`	`string`	optional
`data.items[].slug`	`string`	optional
`data.items[].sort_order`	`integer`	optional
`data.items[].standard_category_code`	`string`	optional
`data.items[].standard_category_id`	`string`	optional
`data.items[].standard_category_name`	`string`	optional
`data.items[].status`	`string`	optional
`data.items[].stock_quantity`	`integer`	optional
`data.items[].tax_code`	`string`	optional
`data.items[].taxable`	`boolean`	optional
`data.items[].track_inventory`	`boolean`	optional
`data.items[].type`	`string`	optional
`data.items[].updated_at`	`string`	optional
`data.items[].weight`	`string`	optional
`data.items[].weight_unit`	`string`	optional
`data.next_cursor`	`string`	optional
`data.object`	`string`	optional	list
`data.url`	`string`	optional
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/products \
  -H "Authorization: Bearer $GETME_API_KEY"

POST/v1/products

Create Product

app_install_bearerscope: products: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
`brand_id`	`string`	optional
`category_id`	`string`	optional
`compare_at_price`	`number \| string`	optional
`continue_selling_when_out_of_stock`	`boolean`	optional
`description`	`string`	optional
`description_html`	`string`	optional
`google_product_category_id`	`string`	optional
`image_alt_text`	`string`	optional
`image_url`	`string`	optional
`is_active`	`boolean`	optional
`low_stock_threshold`	`integer`	optional
`name`	`string`	required
`price`	`number \| string`	optional
`requires_shipping`	`boolean`	optional
`short_description`	`string`	optional
`sku`	`string`	required
`slug`	`string`	optional
`sort_order`	`integer`	optional
`standard_category_code`	`string`	optional
`standard_category_id`	`string`	optional
`standard_category_name`	`string`	optional
`status`	`string`	optional	draft, active, published
`stock_quantity`	`integer`	optional
`tax_code`	`string`	optional
`taxable`	`boolean`	optional
`track_inventory`	`boolean`	optional
`type`	`string`	optional
`weight`	`number \| string`	optional
`weight_unit`	`string`	optional

Returns · 200

Field	Type	Required	Description
`data`	`ProductObject`	required
`data.brand_id`	`string`	optional
`data.brand_name`	`string`	optional
`data.category_id`	`string`	optional
`data.category_name`	`string`	optional
`data.compare_at_price`	`string`	optional
`data.continue_selling_when_out_of_stock`	`boolean`	optional
`data.created_at`	`string`	optional
`data.description`	`string`	optional
`data.description_html`	`string`	optional
`data.google_product_category_id`	`string`	optional
`data.id`	`string`	required
`data.image_alt_text`	`string`	optional
`data.image_url`	`string`	optional
`data.is_active`	`boolean`	optional
`data.low_stock_threshold`	`integer`	optional
`data.name`	`string`	required
`data.object`	`string`	optional	product
`data.price`	`string`	optional
`data.requires_shipping`	`boolean`	optional
`data.short_description`	`string`	optional
`data.sku`	`string`	optional
`data.slug`	`string`	optional
`data.sort_order`	`integer`	optional
`data.standard_category_code`	`string`	optional
`data.standard_category_id`	`string`	optional
`data.standard_category_name`	`string`	optional
`data.status`	`string`	optional
`data.stock_quantity`	`integer`	optional
`data.tax_code`	`string`	optional
`data.taxable`	`boolean`	optional
`data.track_inventory`	`boolean`	optional
`data.type`	`string`	optional
`data.updated_at`	`string`	optional
`data.weight`	`string`	optional
`data.weight_unit`	`string`	optional
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

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

GET/v1/products/{product_id}

Get Product

app_install_bearerscope: products:read

Parameters

Field	Type	Required	Description
`product_id`path	`string`	required	Product public identifier in prod_<21 Base62> format.

Returns · 200

Field	Type	Required	Description
`data`	`ProductObject`	required
`data.brand_id`	`string`	optional
`data.brand_name`	`string`	optional
`data.category_id`	`string`	optional
`data.category_name`	`string`	optional
`data.compare_at_price`	`string`	optional
`data.continue_selling_when_out_of_stock`	`boolean`	optional
`data.created_at`	`string`	optional
`data.description`	`string`	optional
`data.description_html`	`string`	optional
`data.google_product_category_id`	`string`	optional
`data.id`	`string`	required
`data.image_alt_text`	`string`	optional
`data.image_url`	`string`	optional
`data.is_active`	`boolean`	optional
`data.low_stock_threshold`	`integer`	optional
`data.name`	`string`	required
`data.object`	`string`	optional	product
`data.price`	`string`	optional
`data.requires_shipping`	`boolean`	optional
`data.short_description`	`string`	optional
`data.sku`	`string`	optional
`data.slug`	`string`	optional
`data.sort_order`	`integer`	optional
`data.standard_category_code`	`string`	optional
`data.standard_category_id`	`string`	optional
`data.standard_category_name`	`string`	optional
`data.status`	`string`	optional
`data.stock_quantity`	`integer`	optional
`data.tax_code`	`string`	optional
`data.taxable`	`boolean`	optional
`data.track_inventory`	`boolean`	optional
`data.type`	`string`	optional
`data.updated_at`	`string`	optional
`data.weight`	`string`	optional
`data.weight_unit`	`string`	optional
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

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

PATCH/v1/products/{product_id}

Update Product

app_install_bearerscope: products:writeidempotent

Parameters

Field	Type	Required	Description
`product_id`path	`string`	required	Product public identifier in prod_<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
`brand_id`	`string`	optional
`category_id`	`string`	optional
`compare_at_price`	`number \| string`	optional
`continue_selling_when_out_of_stock`	`boolean`	optional
`description`	`string`	optional
`description_html`	`string`	optional
`google_product_category_id`	`string`	optional
`image_alt_text`	`string`	optional
`image_url`	`string`	optional
`is_active`	`boolean`	optional
`low_stock_threshold`	`integer`	optional
`name`	`string`	optional
`price`	`number \| string`	optional
`requires_shipping`	`boolean`	optional
`short_description`	`string`	optional
`sku`	`string`	optional
`slug`	`string`	optional
`sort_order`	`integer`	optional
`standard_category_code`	`string`	optional
`standard_category_id`	`string`	optional
`standard_category_name`	`string`	optional
`status`	`string`	optional	draft, active, published
`stock_quantity`	`integer`	optional
`tax_code`	`string`	optional
`taxable`	`boolean`	optional
`track_inventory`	`boolean`	optional
`type`	`string`	optional
`weight`	`number \| string`	optional
`weight_unit`	`string`	optional

Returns · 200

Field	Type	Required	Description
`data`	`ProductObject`	required
`data.brand_id`	`string`	optional
`data.brand_name`	`string`	optional
`data.category_id`	`string`	optional
`data.category_name`	`string`	optional
`data.compare_at_price`	`string`	optional
`data.continue_selling_when_out_of_stock`	`boolean`	optional
`data.created_at`	`string`	optional
`data.description`	`string`	optional
`data.description_html`	`string`	optional
`data.google_product_category_id`	`string`	optional
`data.id`	`string`	required
`data.image_alt_text`	`string`	optional
`data.image_url`	`string`	optional
`data.is_active`	`boolean`	optional
`data.low_stock_threshold`	`integer`	optional
`data.name`	`string`	required
`data.object`	`string`	optional	product
`data.price`	`string`	optional
`data.requires_shipping`	`boolean`	optional
`data.short_description`	`string`	optional
`data.sku`	`string`	optional
`data.slug`	`string`	optional
`data.sort_order`	`integer`	optional
`data.standard_category_code`	`string`	optional
`data.standard_category_id`	`string`	optional
`data.standard_category_name`	`string`	optional
`data.status`	`string`	optional
`data.stock_quantity`	`integer`	optional
`data.tax_code`	`string`	optional
`data.taxable`	`boolean`	optional
`data.track_inventory`	`boolean`	optional
`data.type`	`string`	optional
`data.updated_at`	`string`	optional
`data.weight`	`string`	optional
`data.weight_unit`	`string`	optional
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/products/{product_id} \
  -X PATCH \
  -H "Authorization: Bearer $GETME_API_KEY" \
  -H "Idempotency-Key: idem_1234567890abcdef" \
  -H "Content-Type: application/json" \
  -d '{
    "brand_id": "brand_id",
    "category_id": "category_id",
    "compare_at_price": "compare_at_price",
    "continue_selling_when_out_of_stock": true,
    "description": "description",
    "description_html": "description_html"
  }'

POST/v1/products/{product_id}/archive

Archive Product

app_install_bearerscope: products:writeidempotent

Parameters

Field	Type	Required	Description
`product_id`path	`string`	required	Product public identifier in prod_<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`	`ProductObject`	required
`data.brand_id`	`string`	optional
`data.brand_name`	`string`	optional
`data.category_id`	`string`	optional
`data.category_name`	`string`	optional
`data.compare_at_price`	`string`	optional
`data.continue_selling_when_out_of_stock`	`boolean`	optional
`data.created_at`	`string`	optional
`data.description`	`string`	optional
`data.description_html`	`string`	optional
`data.google_product_category_id`	`string`	optional
`data.id`	`string`	required
`data.image_alt_text`	`string`	optional
`data.image_url`	`string`	optional
`data.is_active`	`boolean`	optional
`data.low_stock_threshold`	`integer`	optional
`data.name`	`string`	required
`data.object`	`string`	optional	product
`data.price`	`string`	optional
`data.requires_shipping`	`boolean`	optional
`data.short_description`	`string`	optional
`data.sku`	`string`	optional
`data.slug`	`string`	optional
`data.sort_order`	`integer`	optional
`data.standard_category_code`	`string`	optional
`data.standard_category_id`	`string`	optional
`data.standard_category_name`	`string`	optional
`data.status`	`string`	optional
`data.stock_quantity`	`integer`	optional
`data.tax_code`	`string`	optional
`data.taxable`	`boolean`	optional
`data.track_inventory`	`boolean`	optional
`data.type`	`string`	optional
`data.updated_at`	`string`	optional
`data.weight`	`string`	optional
`data.weight_unit`	`string`	optional
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

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

Field

Type

Required

Description

limitquery

integer

optional

starting_afterquery

string

optional

ending_beforequery

string

optional

Field

Type

Required

Description

data

ProductListResponse

required

data.has_more

boolean

required

data.items

ProductObject[]

required

data.items[].brand_id

string

optional

data.items[].brand_name

string

optional

data.items[].category_id

string

optional

data.items[].category_name

string

optional

data.items[].compare_at_price

string

optional

data.items[].continue_selling_when_out_of_stock

boolean

optional

data.items[].created_at

string

optional

data.items[].description

string

optional

data.items[].description_html

string

optional

data.items[].google_product_category_id

string

optional

data.items[].id

string

required

data.items[].image_alt_text

string

optional

data.items[].image_url

string

optional

data.items[].is_active

boolean

optional

data.items[].low_stock_threshold

integer

optional

data.items[].name

string

required

data.items[].object

string

optional

product

data.items[].price

string

optional

data.items[].requires_shipping

boolean

optional

data.items[].short_description

string

optional

data.items[].sku

string

optional

data.items[].slug

string

optional

data.items[].sort_order

integer

optional

data.items[].standard_category_code

string

optional

data.items[].standard_category_id

string

optional

data.items[].standard_category_name

string

optional

data.items[].status

string

optional

data.items[].stock_quantity

integer

optional

data.items[].tax_code

string

optional

data.items[].taxable

boolean

optional

data.items[].track_inventory

boolean

optional

data.items[].type

string

optional

data.items[].updated_at

string

optional

data.items[].weight

string

optional

data.items[].weight_unit

string

optional

data.next_cursor

string

optional

data.object

string

optional

list

data.url

string

optional

success

boolean

required

true

Field

Type

Required

Description

Idempotency-Keyheader

string

required

Unique key used to make this mutation retry-safe for the replay window.

Field

Type

Required

Description

brand_id

string

optional

category_id

string

optional

compare_at_price

number | string

optional

continue_selling_when_out_of_stock

boolean

optional

description

string

optional

description_html

string

optional

google_product_category_id

string

optional

image_alt_text

string

optional

image_url

string

optional

is_active

boolean

optional

low_stock_threshold

integer

optional

name

string

required

price

number | string

optional

requires_shipping

boolean

optional

short_description

string

optional

sku

string

required

slug

string

optional

sort_order

integer

optional

standard_category_code

string

optional

standard_category_id

string

optional

standard_category_name

string

optional

status

string

optional

draft, active, published

stock_quantity

integer

optional

tax_code

string

optional

taxable

boolean

optional

track_inventory

boolean

optional

type

string

optional

weight

number | string

optional

weight_unit

string

optional

Field

Type

Required

Description

data

ProductObject

required

data.brand_id

string

optional

data.brand_name

string

optional

data.category_id

string

optional

data.category_name

string

optional

data.compare_at_price

string

optional

data.continue_selling_when_out_of_stock

boolean

optional

data.created_at

string

optional

data.description

string

optional

data.description_html

string

optional

data.google_product_category_id

string

optional

data.id

string

required

data.image_alt_text

string

optional

data.image_url

string

optional

data.is_active

boolean

optional

data.low_stock_threshold

integer

optional

data.name

string

required

data.object

string

optional

product

data.price

string

optional

data.requires_shipping

boolean

optional

data.short_description

string

optional

data.sku

string

optional

data.slug

string

optional

data.sort_order

integer

optional

data.standard_category_code

string

optional

data.standard_category_id

string

optional

data.standard_category_name

string

optional

data.status

string

optional

data.stock_quantity

integer

optional

data.tax_code

string

optional

data.taxable

boolean

optional

data.track_inventory

boolean

optional

data.type

string

optional

data.updated_at

string

optional

data.weight

string

optional

data.weight_unit

string

optional

success

boolean

required

true

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

Field

Type

Required

Description

product_idpath

string

required

Product public identifier in prod_<21 Base62> format.

Field

Type

Required

Description

data

ProductObject

required

data.brand_id

string

optional

data.brand_name

string

optional

data.category_id

string

optional

data.category_name

string

optional

data.compare_at_price

string

optional

data.continue_selling_when_out_of_stock

boolean

optional

data.created_at

string

optional

data.description

string

optional

data.description_html

string

optional

data.google_product_category_id

string

optional

data.id

string

required

data.image_alt_text

string

optional

data.image_url

string

optional

data.is_active

boolean

optional

data.low_stock_threshold

integer

optional

data.name

string

required

data.object

string

optional

product

data.price

string

optional

data.requires_shipping

boolean

optional

data.short_description

string

optional

data.sku

string

optional

data.slug

string

optional

data.sort_order

integer

optional

data.standard_category_code

string

optional

data.standard_category_id

string

optional

data.standard_category_name

string

optional

data.status

string

optional

data.stock_quantity

integer

optional

data.tax_code

string

optional

data.taxable

boolean

optional

data.track_inventory

boolean

optional

data.type

string

optional

data.updated_at

string

optional

data.weight

string

optional

data.weight_unit

string

optional

success

boolean

required

true

Field

Type

Required

Description

product_idpath

string

required

Product public identifier in prod_<21 Base62> format.

Idempotency-Keyheader

string

required

Unique key used to make this mutation retry-safe for the replay window.

Field

Type

Required

Description

brand_id

string

optional

category_id

string

optional

compare_at_price

number | string

optional

continue_selling_when_out_of_stock

boolean

optional

description

string

optional

description_html

string

optional

google_product_category_id

string

optional

image_alt_text

string

optional

image_url

string

optional

is_active

boolean

optional

low_stock_threshold

integer

optional

name

string

optional

price

number | string

optional

requires_shipping

boolean

optional

short_description

string

optional

sku

string

optional

slug

string

optional

sort_order

integer

optional

standard_category_code

string

optional

standard_category_id

string

optional

standard_category_name

string

optional

status

string

optional

draft, active, published

stock_quantity

integer

optional

tax_code

string

optional

taxable

boolean

optional

track_inventory

boolean

optional

type

string

optional

weight

number | string

optional

weight_unit

string

optional

Field

Type

Required

Description

data

ProductObject

required

data.brand_id

string

optional

data.brand_name

string

optional

data.category_id

string

optional

data.category_name

string

optional

data.compare_at_price

string

optional

data.continue_selling_when_out_of_stock

boolean

optional

data.created_at

string

optional

data.description

string

optional

data.description_html

string

optional

data.google_product_category_id

string

optional

data.id

string

required

data.image_alt_text

string

optional

data.image_url

string

optional

data.is_active

boolean

optional

data.low_stock_threshold

integer

optional

data.name

string

required

data.object

string

optional

product

data.price

string

optional

data.requires_shipping

boolean

optional

data.short_description

string

optional

data.sku

string

optional

data.slug

string

optional

data.sort_order

integer

optional

data.standard_category_code

string

optional

data.standard_category_id

string

optional

data.standard_category_name

string

optional

data.status

string

optional

data.stock_quantity

integer

optional

data.tax_code

string

optional

data.taxable

boolean

optional

data.track_inventory

boolean

optional

data.type

string

optional

data.updated_at

string

optional

data.weight

string

optional

data.weight_unit

string

optional

success

boolean

required

true

curl https://api.getmeonline.io/v1/products/{product_id} \ -X PATCH \ -H "Authorization: Bearer $GETME_API_KEY" \ -H "Idempotency-Key: idem_1234567890abcdef" \ -H "Content-Type: application/json" \ -d '{ "brand_id": "brand_id", "category_id": "category_id", "compare_at_price": "compare_at_price", "continue_selling_when_out_of_stock": true, "description": "description", "description_html": "description_html" }'

Field

Type

Required

Description

product_idpath

string

required

Product public identifier in prod_<21 Base62> format.

Idempotency-Keyheader

string

required

Unique key used to make this mutation retry-safe for the replay window.

Field

Type

Required

Description

data

ProductObject

required

data.brand_id

string

optional

data.brand_name

string

optional

data.category_id

string

optional

data.category_name

string

optional

data.compare_at_price

string

optional

data.continue_selling_when_out_of_stock

boolean

optional

data.created_at

string

optional

data.description

string

optional

data.description_html

string

optional

data.google_product_category_id

string

optional

data.id

string

required

data.image_alt_text

string

optional

data.image_url

string

optional

data.is_active

boolean

optional

data.low_stock_threshold

integer

optional

data.name

string

required

data.object

string

optional

product

data.price

string

optional

data.requires_shipping

boolean

optional

data.short_description

string

optional

data.sku

string

optional

data.slug

string

optional

data.sort_order

integer

optional

data.standard_category_code

string

optional

data.standard_category_id

string

optional

data.standard_category_name

string

optional

data.status

string

optional

data.stock_quantity

integer

optional

data.tax_code

string

optional

data.taxable

boolean

optional

data.track_inventory

boolean

optional

data.type

string

optional

data.updated_at

string

optional

data.weight

string

optional

data.weight_unit

string

optional

success

boolean

required

true