Retrieve Bag

Description

This service retrieves the shopping bag of a user for displaying its contents. It provides the total amount on the bag with details on each individual item. Each service call handles only one request.

HTTP Method and Request URL

GET

https://api.bloomingdales.com/order/v1/bags

HTTP, Path and Query Parameters

HTTP Header Parameters

Parameter	Description	Mandatory	Sample Value
x-macys-webservice-client-id	Pass the apikey as a header value which is called x-macys-webservice-client-id. The api key is the 24 character alphanumeric string assigned to your application when you registered it. Click here for a list of your API keys.	Yes	xmj9js4jkdpe1983fmwu98gh
Accept	Specifies the output format. Can be application/json or application/xml.	Yes	application/json application/xml
Cookie	The cookie macys_online_uid needs to be set with the user id of the macys.com customer.	No, either this or guest user id as Param is mandatory	macys_online_uid=user_id (macys.com)

Request Body Parameters

Parameter	Description	Mandatory	Sample Value
userId	User ID from user auth response or from add to bag response which is stored in the cookie/cache	Yes, if bagGuid/bagId	2179034031
userGuid	GUID currently does not work on the API	No	795be3de-4905-439b-aff3-439e84f28f81
bagId	When present in the cookie or stored in cache from add to bag	No	137437090
bagGuid	When present in the cookie or stored in cache from add to bag	No	8be6c0db-579f-4e58-b1c7-d6bc658f609b
promocode	Promotion code to be applied on the item/bag should be cached in the app when entered & used when GET shoppingbag is invoked	No	SHADES
bagOptions	A list of bag options strings to get more data about bag example: "bagOptions=INCLUDE_SAVED_BAG"	No	INCLUDE_SAVED_BAG INCLUDE_PRODUCTINFO

Sample Requests and Responses

Sample Request

Request URL:

GET

https://api.bloomingdales.com/order/v1/bags?userId=2179034031

Sample Header:

X-Macys-Webservice-Client-Id: xmj9js4jkdpe1983fmwu98gh
Accept: application/json

Sample Response

{
    "bag": {
        "bagId": 137437090,
        "bagGUID": "8be6c0db-579f-4e58-b1c7-d6bc658f609b",
        "storeLocationNumber": 0,
        "owner": {
            "userId": 2179034031,
            "bccUser": false,
            "userRegistryId": 0
        },
        "shippingSummary": {
            "discount": 18,
            "method": "G",
            "standardCharges": 0,
            "standardChargesBeforeDicsount": 18,
            "surcharges": 0,
            "total": 0
        },
        "bagSummary": {
            "estimatedTax": 17.25,
            "itemCount": 2,
            "grandTotal": 304.75,
            "merchandiseTotal": 287.5,
            "totalPersonalizationFee": 0,
            "totalSaved": 0,
            "yaqAmount": 0
        },
        "promotions": [
            {
                "desc": "Free Shipping on orders of $150 or more",
                "originalPrice": 18,
                "promotionId": 8712,
                "scope": "ORDER",
                "target": "SHIPPING",
                "type": "Free Shipping",
                "amountDiscounted": 18,
                "adjustedCost": 0,
                "operationDesc": "Free Shipping on orders of $150 or more",
                "expirationDate": "2037-12-31 23.59.59.000",
                "itemSequenceNumber": 0,
                "requiredBCCCard": false,
                "loyaltyAddSavings": false,
                "loyaltyIncreaseSavings": false,
                "propCardAddSavings": false,
                "propCardIncreaseSavings": false
            }
        ],
        "items": [
            {
                "autoAddChoice": "ADD",
                "discount": 0,
                "giftCardAmount": 0,
                "giftId": 0,
                "personalizationFlag": false,
                "gwpItemFlag": false,
                "isItemFromWishList": false,
                "pwpItemFlag": false,
                "specialItemFlag": false,
                "itemTotal": 89.5,
                "itemTrackInfo": "cmexplore=-_--_--_--_--_--_--_--_--_-2-_--_--_--_-71-_--_-BOPS: Store Unknown-_--_-SINGLE ITEM-_--_-2-_--_--_--_-1-_--_-Tue, 30 Dec 2014 21:16:20 GMT-_--_--_--_--_--_--_--_--_--_--_--_--_--_--_--_--_--_--_--_--_--_--_-N-_-FITPREDICT|OUT",
                "mergeRequiredFlag": false,
                "originalPrice": 89.5,
                "personalizationFee": 0,
                "pickupRegistryApplicable": true,
                "pickUpFromStore": false,
                "promotionId": 0,
                "wishListId": 0,
                "quantity": 1,
                "retailPrice": 89.5,
                "sequenceNumber": 1,
                "siteAvailablilityFlag": true,
                "surcharges": 0,
                "productId": 1157195,
                "trackingCategory": "11576",
                "upcId": 2177428,
                "upcNumber": "888602772699",
                "uycTotalDiscountedPrice": 0,
                "uycDiscountedPercentage": 0
            },
            {
                "autoAddChoice": "ADD",
                "discount": 0,
                "giftCardAmount": 0,
                "giftId": 0,
                "personalizationFlag": false,
                "gwpItemFlag": false,
                "isItemFromWishList": false,
                "pwpItemFlag": false,
                "specialItemFlag": false,
                "itemTotal": 198,
                "itemTrackInfo": "cmexplore=-_--_--_--_--_--_--_--_--_-2-_--_--_--_-315-_--_-BOPS: Store Unknown-_--_-MASTER | 1171290-_--_-2-_--_--_--_-1-_--_-Mon, 05 Jan 2015 18:45:28 GMT-_--_--_--_--_--_--_--_--_--_--_--_--_--_--_--_--_--_--_--_--_--_--_-N-_-FITPREDICT|OUT",
                "mergeRequiredFlag": false,
                "originalPrice": 198,
                "personalizationFee": 0,
                "pickupRegistryApplicable": true,
                "pickUpFromStore": false,
                "promotionId": 0,
                "wishListId": 0,
                "quantity": 1,
                "retailPrice": 198,
                "sequenceNumber": 2,
                "siteAvailablilityFlag": true,
                "surcharges": 0,
                "productId": 1171243,
                "trackingCategory": "10172",
                "upcId": 2034545,
                "upcNumber": "886992538239",
                "uycTotalDiscountedPrice": 0,
                "uycDiscountedPercentage": 0
            }
        ],
        "promotionOffers": [],
        "uycApplicable": false
    }
}

Error Codes

General Error Handling Documentation:

Click Here