Poq.SDK.Node

Home > @poq/sdk-sfcc > ICustomersClient > postCustomersByIDProductListsByIDItems

ICustomersClient.postCustomersByIDProductListsByIDItems() method

Adds an item to the customers product list. Considered values from the request body are: type: a valid type, mandatory. This is the type of the item to be added to the customers product list. priority: This is the priority of the item to be added to the customers product list. public: This is the flag whether the item to be added to the customers product list is public. product_id: a valid product id, used for product item type only. This is the id (sku) of the product related to the item to be added to the customers product list. It is mandatory for product item type and it must be a valid product id, otherwise ProductListProductIdMissingException or ProductListProductNotFoundException will be thrown. quantity: used for product item type only. This is the quantity of the item to be added to the customers product list. custom properties in the form c_<CUSTOM_NAME>: the custom property must correspond to a custom attribute (<CUSTOM_NAME>) defined for ProductListItem. The value of this property must be valid for the type of custom attribute defined for ProductListItem.

Signature:

postCustomersByIDProductListsByIDItems(customerId: string, listId: string, body: CustomerProductListItem, options?: RequestOptions): Promise<PoqResponse<CustomerProductListItem>>;

Parameters

Parameter Type Description
customerId string The id of the customer - owner of the product list.
listId string The id of the product list
body CustomerProductListItem  
options RequestOptions (Optional) Override http request option.

Returns:

Promise<PoqResponse<CustomerProductListItem>>