Create Customer Product List Item

Add an item to the customer's product list.

POST/organizations/{organizationId}/customers/{customerId}/product-lists/{listId}/items

Use it in a workflow

Add a step and choose the Salesforce Commerce Cloud connector.
Pick the Create Customer Product List Item action (under Shopper Customers).
Fill in the fields below, then reference the result from later steps as {{createCustomerProductListItem.response.data}}.

Request

Path parameters

listIdstringrequired

The ID of the list.

customerIdstringrequired

The customer ID.

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

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.

Request body

Enter the body as JSON in the step's Body field.

idstring

The ID of this product list item.

priorityinteger (int32)required

The priority of the item.

productany

The product item.

productIdany

The ID of the product.

publicbooleanrequired

Is this product list item available for access by other customers?

purchasedQuantitynumber (double)

The quantity of products already purchased.

quantitynumber (double)required

The quantity of this product list item.

typestring

The type of the item.

One ofproductgift_certificate

json

{
  "priority": 1,
  "public": true,
  "quantity": 2,
  "id": "Main Product",
  "product": null,
  "productId": "Toaster",
  "purchasedQuantity": 1,
  "type": "product"
}

Response

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