Skip to navigation

customerShoppingList

Get a the shopping list by ID. Requires a BC Token.

Arguments

idIntegerRequired
Shopping list id. This field is required.

Returns

an optional CustomerShoppingListType
idString
createdAtIntegerOptional
The created timestamp of the shopping list
updatedAtIntegerOptional
The updated timestamp of the shopping list
nameStringOptional
Shopping list name
descriptionStringOptional
Shopping list description
reasonStringOptional
Shopping list reason
grandTotalStringOptional
grand total amount of shopping list
totalDiscountStringOptional
Total discount of shopping list
totalTaxStringOptional
Total tax of shopping list
isShowGrandTotalBooleanOptional
If show grand total amount of shopping list

products of shopping list (only active catalog products are returned)

channelIdIntegerOptional
The channel id of the shopping list
channelNameStringOptional
The channel name of the shopping list