Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.

Mercemur home page

Dashboard
Status
Create a key
Create a key

Products

GET
List products
POST
Create a draft product
GET
Retrieve a product
DEL
Delete a product
PATCH
Update a product
PUT
Replace a product's merchant attributes
GET
Retrieve product form
DEL
Deactivate a product's form
POST
Append images to a product
POST
Publish a product, now or at a scheduled time
GET
Retrieve product rating
deprecated
POST
Restore a deleted product
GET
List a product's reviews
GET
List a product's sales channels
PUT
Replace a product's sales-channel membership
POST
Unpublish a product
POST
Add a variant to a product
GET
List a product's revisions
DEL
Remove an image from a product
GET
Retrieve review summary
DEL
Delete a product variant
PATCH
Update a variant
GET
Retrieve a form revision
POST
Restore a deleted product variant

Variants

GET
List a variant's price tiers
POST
Add or replace a quantity price break on a variant
GET
List a variant's prices
PUT
Set a variant's price in one currency
DEL
Remove a variant's price in one currency

Variant price tiers

DEL
Remove a quantity price break

Product types

GET
List product types
GET
Retrieve a product type

Product questions

GET
List product questions
GET
Retrieve a product question
POST
Answer a product question
POST
Publish a product question
POST
Reject a product question

Sales channels

GET
List sales channels
POST
Create a sales channel

Collections

GET
List collections
POST
Create a collection
GET
Retrieve a collection
DEL
Delete a collection
PATCH
Update a collection
POST
Remove a collection from the storefront without deleting it
PUT
Replace a collection's metadata document
GET
List a collection's products
POST
Add or remove products in a collection
POST
Restore an archived collection to the storefront

Bundles

GET
List bundles
POST
Create a bundle
GET
Retrieve a bundle
PATCH
Update a bundle's title, price, currency or status
POST
Add a component variant to a bundle
DEL
Remove a component from a bundle
PATCH
Change how many of a variant a bundle contains

Tag assignments

POST
Attach tags to products
POST
Detach tags from products

Price lists

GET
List price lists
POST
Create a price list
GET
Retrieve a price list
PATCH
Update a price list
GET
List a price list's customer groups
POST
Target a price list at one customer group
GET
List a price list's prices
POST
Upsert prices onto a price list
DEL
Stop a price list applying to one customer group
DEL
Remove one price from a price list

Price preferences

GET
List price preferences
POST
Set the tax-inclusive display convention for a currency or region
DEL
Remove a tax-inclusive display preference

Digital products

GET
List digital products
POST
Make a variant a digital product
GET
List digital product entitlements
GET
Retrieve a digital product
DEL
Delete a digital product's fulfilment rule
PATCH
Update a digital product's fulfilment terms
GET
Retrieve a digital product entitlement
GET
List a config's files
POST
Register a deliverable file
GET
List a config's license key pools
POST
Create a license key pool
POST
Restore a buyer's download allowance
POST
Revoke a buyer's entitlement
DEL
Remove a deliverable file
POST
Bulk import license keys into a pool

Gift card products

GET
List gift card products
GET
Retrieve a gift card product

Gift card denominations

GET
List gift card denominations
GET
Retrieve a gift card denomination

Metafields

GET
List metafields
PUT
Set a custom field's value on a resource
GET
Retrieve a metafield
DEL
Clear a custom field's value on a resource

Metafield definitions

GET
List metafield definitions
POST
Define a custom field
GET
Retrieve a metafield definition
DEL
Delete a custom field definition
PATCH
Update a custom field definition

Media files

GET
List media files
POST
Upload a file to the store's media library
GET
Retrieve a media file

Translations

GET
List translations
PUT
Set a translation for one field in one locale
DEL
Remove a translation

API Reference

HOOK
An event delivered to your endpoint

openapi: /specs/platform.yaml webhook merchantEvent

API Reference

An event delivered to your endpoint

openapi: /specs/platform.yaml webhook merchantEvent

Remove a translation

website

Products

Variants

Variant price tiers

Product types

Product questions

Sales channels

Categories

Collections

Bundles

Tags

Tag assignments

Price lists

Price preferences

Digital products

Gift card products

Gift card denominations

Metafields

Metafield definitions

Media files

Translations

API Reference

An event delivered to your endpoint

openapi: /specs/platform.yaml webhook merchantEvent

​openapi: /specs/platform.yaml webhook merchantEvent

openapi: /specs/platform.yaml webhook merchantEvent