Recommendation pages

Update recommendation page

🔐 This endpoint requires HTTP authentication (either Basic or Bearer). For authenticating with Bearer token, required scopes are: recommendations(w).

Beta: This endpoint is in beta and may change. It is currently available to a small group of users. To request access, contact your Customer Success Manager.

Update the supplied fields of a page, leaving the rest as they are. pods, when supplied, replaces the complete ordered list: it cannot be patched in part, [] empties the page and keeps its other settings, and null is rejected. metadata_json is merged recursively into the page's current settings, and a null leaf restores that setting's default.

Answers 404 if the page, or a pod in pods, is not configured for this key and section, and 400 if pods repeats a pod or lists more pods than the page limit.

patch/v1/recommendation_pages/{page_id}

Request

Base URL
https://ac.cnstrc.com
URL
https://ac.cnstrc.com/v1/recommendation_pages/{page_id}
Auth
- HTTP basic
- or HTTP bearer

Path parameters

page_idstring required

Query parameters

keystring required

The key of the index to use.

Example:key_K2pX7vBnU0bgA5xp

sectionstring

The section of the index to use. Defaults to Products.

Example:Products

cstring

The ID of the client and version that the request is coming from, such as cio-js-2.90.

Example:cio-js-2.90

Request body

display_namestring

The name of the page displayed to merchandisers, between 2 and 100 characters. Surrounding whitespace is stripped.

Example request

{
  "display_name": "PDP - B2C",
  "pods": [
    {
      "pod_id": "similar_items"
    }
  ]
}

Response

page_idstring required

The unique identifier of the page within the key and section: a lowercase slug of letters, digits, underscores and hyphens, starting with a letter or digit, at most 255 characters. Surrounding whitespace is stripped.

display_namestring required

The name of the page displayed to merchandisers, between 2 and 100 characters. Surrounding whitespace is stripped.

created_atstring date-time required

The date and time the page was created.

updated_atstring date-time required

The date and time the page was last updated.

Example response

{
  "page_id": "pdp_b2c",
  "display_name": "PDP - B2C",
  "pods": [
    {
      "pod_id": "similar_items"
    }
  ],
  "created_at": "2021-01-01T00:00:00",
  "updated_at": "2021-02-01T00:00:00"
}