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`

Loading documentation...

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	Deprecated compatibility input. Use status instead.
`low_stock_threshold`	`integer`	optional
`media_id`	`string`	optional
`name`	`string`	required
`price`	`number \| string`	optional
`publishing_channels`	`ProductPublishingChannels`	optional	Per-channel visibility. Active does not publish a channel automatically.
`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`	`ProductWriteStatus`	optional	Product lifecycle status. 'published' is a deprecated input alias for active plus published channels.
`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
`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

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`	required	Derived compatibility field. True exactly when status is active.
`data.low_stock_threshold`	`integer`	optional
`data.media_id`	`string`	optional
`data.name`	`string`	required
`data.object`	`string`	optional	product
`data.price`	`string`	optional
`data.publishing_channels`	`ProductPublishingChannels`	required
`data.publishing_channels.getme`	`ProductPublishingChannelState`	optional
`data.publishing_channels.web`	`ProductPublishingChannelState`	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`	`ProductLifecycleStatus`	required	Canonical product lifecycle status. Responses never emit the deprecated published alias.
`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	Deprecated compatibility input. Use status instead.
`low_stock_threshold`	`integer`	optional
`media_id`	`string`	optional
`name`	`string`	optional
`price`	`number \| string`	optional
`publishing_channels`	`ProductPublishingChannels`	optional	Per-channel visibility. Send null to clear publication on all channels.
`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`	`ProductWriteStatus`	optional	Product lifecycle status. 'published' is a deprecated input alias for active plus published channels.
`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
`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

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`	required	Derived compatibility field. True exactly when status is active.
`data.low_stock_threshold`	`integer`	optional
`data.media_id`	`string`	optional
`data.name`	`string`	required
`data.object`	`string`	optional	product
`data.price`	`string`	optional
`data.publishing_channels`	`ProductPublishingChannels`	required
`data.publishing_channels.getme`	`ProductPublishingChannelState`	optional
`data.publishing_channels.web`	`ProductPublishingChannelState`	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`	`ProductLifecycleStatus`	required	Canonical product lifecycle status. Responses never emit the deprecated published alias.
`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"