Add a collection

Before you call

Credential

Authorization: Bearer $KEY

Scope

shop:admin

Mcp

rivier_shop_collection_create

Sdk

shop.collection.create

Cli

shop collection create

Request bodyapplication/json, required

• namestringrequired
  At most 120 characters.
• slugstringrequired
  Pattern: ^[a-z0-9][a-z0-9-]{0,62}$.
• kindstring
  One of: manual, rule. Default: manual.
• ruleobject
  • matchstring
    One of: all, any. Default: all.
  • conditionslist of objectrequired
    • fieldstringrequired
      Pattern: ^(price|stock|on_sale|in_stock|name|slug|tag|attribute:[a-z][a-z0-9_]{0,39})$.
    • opstringrequired
      One of: eq, neq, gte, lte, gt, lt, contains, in.
    • valuestring or number or boolean or list of string or number or booleanrequired

Responses

• 201application/json
  Success
• 400application/json
  The request was malformed
  • errorstringrequired
  • messagestring
• 401application/json
  No valid credential
  • errorstringrequired
  • messagestring
• 403application/json
  The credential lacks the scope, origin or address
  • errorstringrequired
  • messagestring
• 429application/json
  Over the key's rate limit; see Retry-After
  • errorstringrequired
  • messagestring