Get Customer Product List

GET/organizations/{organizationId}/customers/{customerId}/product-lists/{listId}

Use it in a workflow

Add a step and choose the Salesforce Commerce Cloud connector.
Pick the Get Customer Product List action (under Shopper Customers).
Fill in the fields below, then reference the result from later steps as {{getCustomerProductList.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.

Response

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

coRegistrantany

The coregistrant of this product list.

creationDatestring (date-time)

Returns the value of attribute 'creationDate'.

currentShippingAddressInfoany

The resource link to the current shipping address of this customer product list.

customerProductListItemsarray<object>

The list of customer product list items.

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

descriptionstring

The description of this product list.

eventany

The event of this product list.

idstring

The ID of this product list.

lastModifiedstring (date-time)

Returns the value of attribute 'lastModified'.

namestring

The name of this product list.

postEventShippingAddressInfoany

The resource link to the post event shipping address of this customer product list.

productListShippingAddressany

The abbreviated shipping address of this product list representing what an anonymous user can see.

publicboolean

Indicates whether the owner made this product list available for access by other customers.

registrantany

The registrant of this product list.

shippingAddressInfoany

The resource link to the shipping address of this customer product list.

typestring

The type of the product list.

One ofwish_listgift_registryshopping_listcustom_1custom_2custom_3

json

{
  "coRegistrant": null,
  "creationDate": "9999-12-31T00:00:00.0Z",
  "currentShippingAddressInfo": null,
  "customerProductListItems": [
    {
      "priority": 1,
      "public": true,
      "quantity": 2,
      "id": "Main Product",
      "product": null,
      "productId": "Toaster",
      "purchasedQuantity": 1,
      "type": "product"
    }
  ],
  "description": "My Product List",
  "event": null,
  "id": "MyList",
  "lastModified": "9999-12-31T00:00:00.0Z",
  "name": "Danny's Product List",
  "postEventShippingAddressInfo": null,
  "productListShippingAddress": null,
  "public": true
}

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

Was this page helpful?