Shelving by tenant and point of interest

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

Products for the requested Shelving Rule for a specified tenant and a specified point of interest (product, category or tag)

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

pointOfInterest stringrequired

product ID, product tag or category

Query Parameters

tagNameOrCategoryType string
customOutputName string
device string

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...