List Customer Baskets

Service URL: GET /baskets

Parameters:

pageSize – Integer – The maximum number of baskets to return in a single page – Optional, default to 10, limited to 100

pageOffset – Integer – The offset, in rows, of the first basket to return – Optional, default to 0

extended – boolean – If the flag is true, then a list of basket responses is returned. Otherwise, a list of basket summaries is returned. Defaults to false

Response Body:

basksetSummaries – A list of basket summaries, excluding the Primary basket, for the given customer. The basket summaries only include details about the basket’s reference, type, and description

When the extended flag is true

basketResponses – A list of basket responses, excluding the Primary basket, for the given customer. The list will include the basketReferences to allow the details to be later retrieved.

Remarks:

List the baskets associated with the given customer, excluding the Primary basket. It is not possible to list baskets associated with an anonymous customer – if the customer loses their reference to an anonymous basket the basket cannot be recalled.

Scenarios

ScenarioOutcomeExpected behaviourStatus CodeResponse
1The list customer baskets is called with a valid list customer baskets requestSuccessLoads a list of summaries for the customer’s baskets, excluding their primary baskets.200IListCustomerBasketsSummariesResponse: basketSummaries
2The list customer baskets is called with a valid list customer baskets request and the extended flag is trueSuccessLoads a list of basket response for the customer, excluding their primary baskets.200IListCustomerBasketsResponse: basketResponses

Example Request:Example List Customer Baskets Request

GET: http://localhost:8080/WebRestApi/rest/baskets

Example Response:Example List Customer Baskets Response Expand source

Example Request with the extended flag set to true:Example List Customer Baskets Request

GET: http://localhost:8080/WebRestApi/rest/baskets

Example Response:

{
    "basketResponses": [
        {
            "basket": {
                "items": [
                    {
                        "@type": "orderDetailsItem",
                        "description": "###.###",
                        "deviceId": "pos2@0001.enactor",
                        "effectiveNetValue": 0,
                        "lineNumber": 1,
                        "netValue": 0,
                        "value": 0,
                        "dateTimeCreated": "2019-02-11T13:23:18.000+00:00",
                        "userId": "CUST_USER",
                        "type": "VALUE",
                        "orderReference": "0002190211132318",
                        "performedOffline": true,
                        "customerOrderTypeId": "CUSTOMER_ORDER"
                    },
                    {
                        "@type": "orderDetailsItem",
                        "description": "###.###",
                        "deviceId": "pos2@0001.enactor",
                        "effectiveNetValue": 0,
                        "lineNumber": 2,
                        "netValue": 0,
                        "value": 0,
                        "dateTimeCreated": "2019-01-22T14:39:26.000+00:00",
                        "userId": "CUST_USER",
                        "type": "VALUE",
                        "orderReference": "120",
                        "customerOrderTypeId": "CUSTOMER_ORDER"
                    },
                    {
                        "@type": "styleColourSizeItem",
                        "colourId": {
                            "id": "RED",
                            "colourRangeId": "MENS_SHOES"
                        },
                        "description": "Vans Canvas Shoes",
                        "deviceId": "pos2@0001.enactor",
                        "effectiveNetValue": 5590,
                        "lineNumber": 3,
                        "netValue": 5995,
                        "value": 5995,
                        "dateTimeCreated": "2019-01-22T14:39:28.000+00:00",
                        "userId": "CUST_USER",
                        "modifiersNetValue": 0,
                        "modifiersEffectiveNetValue": -405,
                        "modifiersVoidQuantity": 0,
                        "modifiersQuantity": 0,
                        "notDiscountable": false,
                        "maxDiscount": 0,
                        "handKeyed": true,
                        "productID": "VV639JS-12",
                        "quantity": 1,
                        "netQuantity": 1,
                        "isReturn": false,
                        "unitPrice": 5995,
                        "sourceInventoryType": "AVA",
                        "orderable": true,
                        "priceTypeId": "R",
                        "productTypeId": "skuProduct",
                        "productImageURL": "image://PRODUCT/VV639JS-1.jpg",
                        "type": "VALUE",
                        "mmGroupId": "MENS_SHOES",
                        "mmGroupHierarchyId": "FASHION",
                        "mmGroupVariantGroupId": "All",
                        "mmGroupVariantHierarchyId": "All",
                        "mmGroupDescription": "Mens Shoes",
                        "brandGroupId": "VANS",
                        "brandGroupHierarchyId": "FASHION",
                        "modifiers": [
                            {
                                "@type": "distributedPromotionSavingItem",
                                "lineNumber": 3,
                                "distributedSaving": 405,
                                "promotionKey": {
                                    "promotionId": "3",
                                    "groupKey": {
                                        "id": "All",
                                        "groupTypeId": "region",
                                        "groupHierarchyId": "All"
                                    }
                                },
                                "modifierType": "PROMOTION",
                                "effectiveValue": -405
                            }
                        ],
                        "sizeId": {
                            "id": "12",
                            "sizeRangeId": "MENS_SHOES"
                        }
                    },
                    {
                        "@type": "styleColourSizeItem",
                        "colourId": {
                            "id": "RED",
                            "colourRangeId": "MENS_SHOES"
                        },
                        "description": "Vans Canvas Shoes",
                        "deviceId": "pos2@0001.enactor",
                        "effectiveNetValue": 5589,
                        "lineNumber": 4,
                        "netValue": 5995,
                        "value": 5995,
                        "dateTimeCreated": "2019-01-22T14:39:30.000+00:00",
                        "userId": "CUST_USER",
                        "modifiersNetValue": 0,
                        "modifiersEffectiveNetValue": -406,
                        "modifiersVoidQuantity": 0,
                        "modifiersQuantity": 0,
                        "notDiscountable": false,
                        "maxDiscount": 0,
                        "handKeyed": true,
                        "productID": "VV639JS-12",
                        "quantity": 1,
                        "netQuantity": 1,
                        "isReturn": false,
                        "unitPrice": 5995,
                        "sourceInventoryType": "AVA",
                        "orderable": true,
                        "priceTypeId": "R",
                        "productTypeId": "skuProduct",
                        "productImageURL": "image://PRODUCT/VV639JS-1.jpg",
                        "type": "VALUE",
                        "mmGroupId": "MENS_SHOES",
                        "mmGroupHierarchyId": "FASHION",
                        "mmGroupVariantGroupId": "All",
                        "mmGroupVariantHierarchyId": "All",
                        "mmGroupDescription": "Mens Shoes",
                        "brandGroupId": "VANS",
                        "brandGroupHierarchyId": "FASHION",
                        "modifiers": [
                            {
                                "@type": "distributedPromotionSavingItem",
                                "lineNumber": 4,
                                "distributedSaving": 406,
                                "promotionKey": {
                                    "promotionId": "3",
                                    "groupKey": {
                                        "id": "All",
                                        "groupTypeId": "region",
                                        "groupHierarchyId": "All"
                                    }
                                },
                                "modifierType": "PROMOTION",
                                "effectiveValue": -406
                            }
                        ],
                        "sizeId": {
                            "id": "12",
                            "sizeRangeId": "MENS_SHOES"
                        }
                    },
                    {
                        "@type": "styleColourSizeItem",
                        "colourId": {
                            "id": "BLUE",
                            "colourRangeId": "WOMENS_DRESSES"
                        },
                        "description": "Crinkle Day Dress",
                        "deviceId": "pos2@0001.enactor",
                        "effectiveNetValue": 2609,
                        "lineNumber": 5,
                        "netValue": 2798,
                        "value": 2798,
                        "dateTimeCreated": "2019-01-28T11:41:35.000+00:00",
                        "userId": "CUST_USER",
                        "modifiersNetValue": 0,
                        "modifiersEffectiveNetValue": -189,
                        "modifiersVoidQuantity": 0,
                        "modifiersQuantity": 0,
                        "notDiscountable": false,
                        "maxDiscount": 0,
                        "handKeyed": true,
                        "productID": "MB229XML-4",
                        "quantity": 1,
                        "netQuantity": 1,
                        "isReturn": false,
                        "unitPrice": 2798,
                        "sourceInventoryType": "AVA",
                        "orderable": true,
                        "priceTypeId": "R",
                        "productTypeId": "skuProduct",
                        "productImageURL": "image://PRODUCT/MB229XM-3.jpg",
                        "type": "VALUE",
                        "mmGroupId": "WOMENS_DRESSES",
                        "mmGroupHierarchyId": "FASHION",
                        "mmGroupVariantGroupId": "All",
                        "mmGroupVariantHierarchyId": "All",
                        "mmGroupDescription": "Women's Dresses",
                        "brandGroupId": "INTERNAL",
                        "brandGroupHierarchyId": "FASHION",
                        "modifiers": [
                            {
                                "@type": "distributedPromotionSavingItem",
                                "lineNumber": 5,
                                "distributedSaving": 189,
                                "promotionKey": {
                                    "promotionId": "3",
                                    "groupKey": {
                                        "id": "All",
                                        "groupTypeId": "region",
                                        "groupHierarchyId": "All"
                                    }
                                },
                                "modifierType": "PROMOTION",
                                "effectiveValue": -189
                            }
                        ],
                        "sizeId": {
                            "id": "16",
                            "sizeRangeId": "WOMENS_DRESSES"
                        }
                    },
                    {
                        "@type": "voucherRedemptionItem",
                        "voucherDetails": {
                            "voucherTypeId": {
                                "regionId": {
                                    "id": "All",
                                    "groupTypeId": "region",
                                    "groupHierarchyId": "All"
                                },
                                "voucherTypeId": "10_POUND"
                            }
                        },
                        "track": false,
                        "markItemsUsed": false,
                        "currencyId": "GBP",
                        "description": "£10 Pound off",
                        "deviceId": "pos2@0001.enactor",
                        "lineNumber": 6,
                        "dateTimeCreated": "2019-02-07T11:47:15.000+00:00",
                        "userId": "CUST_USER",
                        "type": "VALUE"
                    }
                ],
                "balance": 13788,
                "currencyId": "GBP",
                "currencyDescription": "Pounds Sterling",
                "taxInclusive": true,
                "taxSchemeId": "UK",
                "itemCount": 6,
                "saleItemQuantity": 3,
                "returnItemQuantity": 0,
                "saleItemNetValue": 13788,
                "returnItemNetValue": 0,
                "merchandiseItemQuantity": 3,
                "merchandiseItemValue": 14788,
                "total": 13788,
                "grossTotal": 14788,
                "taxTotal": 0,
                "promotionCalculation": {
                    "totalSaving": 1000,
                    "totalPoints": 0,
                    "itemsArray": [
                        {
                            "promotionSavingItem": {
                                "saving": 1000,
                                "savingAdjustment": 0,
                                "distributedSavings": [
                                    {
                                        "distributedPromotionSavingItem": {
                                            "lineNumber": 3,
                                            "distributedSaving": 405,
                                            "promotionKey": {
                                                "promotionId": "3",
                                                "groupKey": {
                                                    "id": "All",
                                                    "groupTypeId": "region",
                                                    "groupHierarchyId": "All"
                                                }
                                            },
                                            "modifierType": "PROMOTION",
                                            "effectiveValue": -405
                                        }
                                    },
                                    {
                                        "distributedPromotionSavingItem": {
                                            "lineNumber": 4,
                                            "distributedSaving": 406,
                                            "promotionKey": {
                                                "promotionId": "3",
                                                "groupKey": {
                                                    "id": "All",
                                                    "groupTypeId": "region",
                                                    "groupHierarchyId": "All"
                                                }
                                            },
                                            "modifierType": "PROMOTION",
                                            "effectiveValue": -406
                                        }
                                    },
                                    {
                                        "distributedPromotionSavingItem": {
                                            "lineNumber": 5,
                                            "distributedSaving": 189,
                                            "promotionKey": {
                                                "promotionId": "3",
                                                "groupKey": {
                                                    "id": "All",
                                                    "groupTypeId": "region",
                                                    "groupHierarchyId": "All"
                                                }
                                            },
                                            "modifierType": "PROMOTION",
                                            "effectiveValue": -189
                                        }
                                    }
                                ],
                                "adjustEmployeeBalance": false,
                                "promotionDescription": "£10 off when you spend £100",
                                "promotionQuantity": 1,
                                "operationWithDiscounts": "APPLIES_AFTER_ON_GROSS",
                                "promotionKey": {
                                    "promotionId": "3",
                                    "groupKey": {
                                        "id": "All",
                                        "groupTypeId": "region",
                                        "groupHierarchyId": "All"
                                    }
                                },
                                "triggers": [
                                    {
                                        "rewardValue": 1000,
                                        "lineRewardValue": 405,
                                        "distributeSaving": true,
                                        "lineNumber": 3,
                                        "quantity": 1,
                                        "unitValue": 5995,
                                        "triggerCount": 1
                                    },
                                    {
                                        "rewardValue": 1000,
                                        "lineRewardValue": 406,
                                        "distributeSaving": true,
                                        "lineNumber": 4,
                                        "quantity": 1,
                                        "unitValue": 5995,
                                        "triggerCount": 1
                                    },
                                    {
                                        "rewardValue": 1000,
                                        "lineRewardValue": 189,
                                        "distributeSaving": true,
                                        "lineNumber": 5,
                                        "quantity": 1,
                                        "unitValue": 2798,
                                        "triggerCount": 1
                                    }
                                ]
                            }
                        }
                    ]
                },
                "totalTaxAdjustment": 0,
                "preAuthBalance": 0,
                "effectiveSaleValue": 13788
            },
            "basketReference": "4PYQCL2LQ5EQXM2TYE3PBTGO4A",
            "basketType": "WISHLIST",
            "basketDescription": "Monday",
            "basketStatus": "NEW"
        },
        ...
    ]
}
Go to Top