Get Pages

Get Page Designer pages.

GET/organizations/{organizationId}/pages

Use it in a workflow

Add a step and choose the Salesforce Commerce Cloud connector.
Pick the Get Pages action (under Shopper Experience).
Fill in the fields below, then reference the result from later steps as {{getPages.response.data}}.

Request

Path parameters

organizationIdstringrequired

An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).

Query parameters

categoryIdstring

Category identifier that is used for searching the page assignment. Must be provided if no `productId` is provided.

productIdstring

Product identifier that is used for searching the page assignment. Must be provided if no `categoryId` is provided.

aspectTypeIdstringrequired

Aspect type identifier that is used for searching the page assignment in conjunction with either the `productId` or `categoryId`.

aspectAttributesstring

A JSON representation of aspect attributes. Each aspect attribute is a key/value pair. Aspect attributes serve as a runtime parameter contract between caller (for example, this API or the DWScript API) and callee (the page). This parameter must not contain more than 256 characters after URL decoding.

parametersstring

A free-form definition of parameters that influences the page rendering according to its implementation. This parameter must not contain more than 256 characters after URL decoding.

siteIdstringrequired

The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.

localeoneOf

A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.

Response

Returns 200 with an object. Read it in later steps with {{getPages.response.data.<field>}}.

dataarray<object>

List of pages.

idstringrequired

Page identifier.

typeIdstringrequired

Page type identifier.

aspectTypeIdstring

The aspect type assigned to the page.

namestring

Display name of the page.

descriptionstring

Description of the page.

pageTitlestring

The SEO title of the page.

pageDescriptionstring

The SEO description of the page.

pageKeywordsstring

The SEO keywords of the page.

dataobject

The configuration data assigned to the page.

customobject

Any custom data added by the custom code for the page type.

visibleboolean

Whether the page is visible based on the current visiblity rules and context.

localizedboolean

Whether the page has been localized with content in the current locale. If false, the page content will fallback to the default locale.

designMetadataobject

Design metadata of the page. This includes information about the page type definition needed by the page designer for design-time functionality.

regionsarray<object>2 fields

The regions (and their assigned components) for the page.

json

{
  "data": [
    {
      "id": "homepage",
      "typeId": "storePage",
      "aspectTypeId": "pdpAspect",
      "name": "Homepage",
      "description": "Home page of the storefront.",
      "pageTitle": "Homepage - My Shop",
      "pageDescription": "Get started shopping",
      "pageKeywords": "fashion, my shop",
      "data": {
        "thumbnail": "myshop.jpg"
      },
      "custom": {
        "thumbnail_full": "http://static.myshop.com/myshop.jpg"
      },
      "visible": true,
      "localized": true
    }
  ]
}

Need more? See the Salesforce Commerce Cloud guide for connection setup and behaviour shared by every action.

Was this page helpful?