API docs by Redocly

merchandising-api (1.0.0)

Download OpenAPI specification:Download

API to manage collection merchandising configurations for collections

Visual Merchandising

Configure merchandising for a collection

Allows clients to set merchandising rules for their collections, including promoting, pinning, burying, or hiding products.

Authorizations:
api_key
path Parameters
collection_id
required
string

Unique identifier for the collection

header Parameters
X-Site-UUID
required
string

Unique identifier for the site, can be found on our Dashboard->Settings

X-Store-ID
required
string

Unique identifier for the store, can be found on our Dashboard->Settings

Request Body schema: application/json
required

Merchandising configuration details

object (CollectionRule)
object (DateRange)

Responses

Request samples

Content type
application/json
{
  • "rules": {
    },
  • "dates": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Success message"
}

Get merchandising settings for a collection

Retrieve the current merchandising settings for a specified collection.

Authorizations:
api_key
path Parameters
collection_id
required
string

Unique identifier for the collection

header Parameters
X-Site-UUID
required
string

Unique identifier for the site, can be found on our Dashboard->Settings

X-Store-ID
required
string

Unique identifier for the store, can be found on our Dashboard->Settings

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete a merchandising rule from a collection

Allows clients to delete a specific merchandising rule from their collections by specifying the rule ID.

Authorizations:
api_key
path Parameters
collection_id
required
string

Unique identifier for the collection

query Parameters
rule_id
required
string

Unique identifier for the rule to be deleted

header Parameters
X-Site-UUID
required
string

Unique identifier for the site, can be found on our Dashboard->Settings

X-Store-ID
required
string

Unique identifier for the store, can be found on our Dashboard->Settings

Responses

Response samples

Content type
application/json
{
  • "message": "Success message"
}