Shelving by tenant (global)

GET 
/product-shelving-by-tenant/:accountId/:ruleId/:tenant

Products for the requested Shelving Rule for a specified tenant (no specific point of interest)

Request

Path Parameters

accountId hyphenLessUuidrequired

Possible values: >= 32 characters and <= 32 characters, Value must match regular expression ^[0-9a-f]{32}$

your account ID

ruleId hyphenLessUuidrequired

Possible values: >= 32 characters and <= 32 characters, Value must match regular expression ^[0-9a-f]{32}$

the rule ID your are requesting

tenant stringrequired

the tenant you are requesting

Query Parameters

customOutputName string
device string
productIdsToFilter string

products to ignore among the products to return (ids separated by a comma)

limit int

maximum number of products to return

Responses

200

application/json

Schema

Schema

any

Example (from schema)

{
  "PointOfInterest": {
    "Id": "Sousrayon=Eau du Soir"
  },
  "AssociatedPoints": [
    {
      "Point": {
        "Id": "995700",
        "Name": "Crème Parfumée Hydratante Eau du Soir",
        "Description": "",
        "Url": "https://www.mysite.com/fr-FR/creme-parfumee-hydratante-eau-du-soir-195700.html",
        "ImagePath": "",
        "Feature1": "91.00",
        "Feature2": "91.00",
        "Categories": [
          "Univers=Parfums",
          "Rayon=Parfum femme",
          "Sousrayon=Eau du Soir"
        ],
        "CustomTags": [],
        "Tags": []
      },
      "Cardinal": 4
    }
  ]
}

Example

{
  "PointOfInterest": {
    "Id": "Sousrayon=Eau du Soir"
  },
  "AssociatedPoints": [
    {
      "Point": {
        "Id": "995700",
        "Name": "Crème Parfumée Hydratante Eau du Soir",
        "Description": "",
        "Url": "https://www.mysite.com/fr-FR/creme-parfumee-hydratante-eau-du-soir-195700.html",
        "ImagePath": "",
        "Feature1": "91.00",
        "Feature2": "91.00",
        "Categories": [
          "Univers=Parfums",
          "Rayon=Parfum femme",
          "Sousrayon=Eau du Soir"
        ],
        "CustomTags": [],
        "Tags": []
      },
      "Cardinal": 4
    }
  ]
}

204

No product collection

401

Check Subscription-Key

404

Not found

Loading...