Get Products for Consumer Sales Action

Retrieve a list of products for Consumer Sales.

This action is available in API version 68.0 and later.

This is applicable for Consumer Sales for business-to-consumer (B2C).

Note

Special Access Rules

You need the CME B2C permission set to use this invocable action.

Supported REST HTTP Methods

URI: /services/data/v68.0/actions/standard/getProductsConsumerSales

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where, TOKEN is a variable.

Inputs

Input	Type	Description
`categoryId`	string	Optional. The ID of the category from which products are retrieved.
`catalogId`	string	Optional. The ID of the catalog from which products are retrieved.
`priceBookId`	string	Optional. The ID of the price book used to price the returned products.
`currencyCode`	string	Optional. The ISO currency code used to price the returned products.
`productLimit`	int	Optional. The maximum number of products to return in the response.
`paginationCursor`	string	Optional. The pagination cursor returned by a previous product list response.
`correlationId`	string	Optional. The correlation ID for the product list.
`enablePricing`	boolean	Optional. Indicates whether to compute pricing for the returned products.
`enableQualification`	boolean	Optional. Indicates whether to compute qualification for the returned products.
`contextDefinition`	string	Optional. The context definition used to evaluate the product listing.
`contextMapping`	string	Optional. The context mapping used to evaluate the product listing.

Outputs

Output	Type	Description
`productList`	string	The product list in JSON format.
`correlationId`	string	The correlation ID for the product list.
`contextId`	string	The ID of the sales transaction context associated with the product list response.
`paginationCursor`	string	The pagination cursor for the next page of results.

Example

POST

This sample request is for the Get Products for Consumer Sales action.

1{
2  "inputs": [
3    {
4      "catalogId": "0ZSxx0000004CjrGAE",
5      "categoryId": "0ZGxx0000004CjrGAE",
6      "priceBookId": "01sxx0000004CjrAAE",
7      "currencyCode": "USD",
8      "productLimit": 50,
9      "enablePricing": true,
10      "enableQualification": true,
11      "correlationId": "cme-pl-001"
12    }
13  ]
14}

This sample response is for the Get Products for Consumer Sales action.

1[
2  {
3    "actionName": "getProductsConsumerSales",
4    "errors": null,
5    "invocationId": null,
6    "isSuccess": true,
7    "outputValues": {
8      "productList": "[{\"productId\":\"01txx0000004CjrAAE\",\"name\":\"Unlimited Wireless Plan\"}]",
9      "correlationId": "cme-pl-001",
10      "contextId": "e055bb18-d4e8-41c3-881e-0132b9561708",
11      "paginationCursor": "eyJwYWdlIjoyfQ=="
12    },
13    "sortOrder": -1,
14    "version": 1
15  }
16]