Modifying MAKECHOICE GWP

Description

The following document outlines a sample of how to add "MAKECHOICE" GWP's(Gift with Purchase) to a shopping bag.  There are a variety of GWP's that have a MAKECHOICE attribute associated with them.  It could be that you need to pick a color, a size, of a specific upc specific item.  In the following example we are going to add a item to our bag that has a MAKECHOICE GWP.  It will require you to choose a specific gift (upc specific).

 

1. Add a item to bag that has MAKECHOICE GWP's:

Request URL:

POST

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

Header:

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

Request Body(Payload)

{
    "item": {
        "quantity": "1",
        "upcId": "2224162"
    }
}

Response

{
    "bag": {
        "bagId": 138932712,
        "bagGUID": "325500f0-3d67-4243-afcb-544cb5c5deb5",
        "storeLocationNumber": 0,
        "owner": {
            "userId": 2196913038,
            "userGuid": "465920d0-de8a-4acb-ae7c-e45f8fedf161",
            "bccUser": false,
            "userRegistryId": 0
        },
        "shippingSummary": {
            "discount": 13,
            "method": "G",
            "standardCharges": 0,
            "standardChargesBeforeDicsount": 13,
            "surcharges": 0,
            "total": 0
        },
        "bagSummary": {
            "estimatedTax": 8.4,
            "itemCount": 2,
            "grandTotal": 148.4,
            "merchandiseTotal": 140,
            "totalPersonalizationFee": 0,
            "totalSaved": 2,
            "yaqAmount": 0
        },
        "promotions": [
            {
                "desc": "Free Shipping on Beauty orders of $50 or more",
                "originalPrice": 13,
                "promotionId": 9160,
                "scope": "ORDER",
                "target": "SHIPPING",
                "type": "Free Shipping",
                "amountDiscounted": 13,
                "adjustedCost": 0,
                "operationDesc": "Free Shipping on Beauty orders of $50 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": 140,
                "mergeRequiredFlag": false,
                "originalPrice": 140,
                "personalizationFee": 0,
                "pickupRegistryApplicable": true,
                "pickUpFromStore": false,
                "promotionId": 0,
                "wishListId": 0,
                "quantity": 1,
                "retailPrice": 140,
                "sequenceNumber": 1,
                "siteAvailablilityFlag": true,
                "surcharges": 0,
                "productId": 1203358,
                "upcId": 2224162,
                "upcNumber": "3605970810054",
                "uycTotalDiscountedPrice": 0,
                "uycDiscountedPercentage": 0,
                "uycPercentDiscount": 0
            },
            {
                "autoAddChoice": "MAKECHOICE",
                "discount": 2,
                "giftCardAmount": 0,
                "personalizationFlag": false,
                "gwpItemFlag": true,
                "isItemFromWishList": false,
                "pwpItemFlag": false,
                "specialItemFlag": false,
                "itemTotal": 0,
                "mergeRequiredFlag": false,
                "originalPrice": 2,
                "personalizationFee": 0,
                "pickupRegistryApplicable": true,
                "promotionId": 13165,
                "wishListId": 0,
                "promotions": [
                    {
                        "desc": "Gift with any $100 Lancôme purchase!",
                        "originalPrice": 2,
                        "promotionId": 13165,
                        "scope": "ORDER",
                        "target": "SUBTOTAL",
                        "type": "Bundled GWP",
                        "amountDiscounted": 2,
                        "adjustedCost": 0,
                        "operationDesc": "Gift with any $100 Lancôme purchase!",
                        "expirationDate": "2015-02-19 23.59.59.000",
                        "itemSequenceNumber": 2,
                        "requiredBCCCard": false,
                        "loyaltyAddSavings": false,
                        "loyaltyIncreaseSavings": false,
                        "propCardAddSavings": false,
                        "propCardIncreaseSavings": false
                    }
                ],
                "quantity": 1,
                "retailPrice": 2,
                "sequenceNumber": 2,
                "siteAvailablilityFlag": true,
                "surcharges": 0,
                "productId": 707319,
                "upcId": 1531557,
                "upcNumber": "492016515102",
                "uycTotalDiscountedPrice": 0,
                "uycDiscountedPercentage": 0,
                "uycPercentDiscount": 0
            }
        ],
        "promotionOffers": [],
        "uycApplicable": false
    }
}

2. Retrieve Bag again to see item has been added:

Request URL:

GET

https://api.bloomingdales.com/order/v1/bags?userGuid=465920d0-de8a-4acb-ae7c-e45f8fedf161

Header:

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

Response

{
    "bag": {
        "bagId": 138932712,
        "bagGUID": "325500f0-3d67-4243-afcb-544cb5c5deb5",
        "storeLocationNumber": 0,
        "owner": {
            "userId": 2196913038,
            "bccUser": false,
            "userRegistryId": 0
        },
        "shippingSummary": {
            "discount": 13,
            "method": "G",
            "standardCharges": 0,
            "standardChargesBeforeDicsount": 13,
            "surcharges": 0,
            "total": 0
        },
        "bagSummary": {
            "estimatedTax": 8.4,
            "itemCount": 2,
            "grandTotal": 148.4,
            "merchandiseTotal": 140,
            "totalPersonalizationFee": 0,
            "totalSaved": 2,
            "yaqAmount": 0
        },
        "promotions": [
            {
                "desc": "Free Shipping on Beauty orders of $50 or more",
                "originalPrice": 13,
                "promotionId": 9160,
                "scope": "ORDER",
                "target": "SHIPPING",
                "type": "Free Shipping",
                "amountDiscounted": 13,
                "adjustedCost": 0,
                "operationDesc": "Free Shipping on Beauty orders of $50 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": 140,
                "mergeRequiredFlag": false,
                "originalPrice": 140,
                "personalizationFee": 0,
                "pickupRegistryApplicable": true,
                "pickUpFromStore": false,
                "promotionId": 0,
                "wishListId": 0,
                "quantity": 1,
                "retailPrice": 140,
                "sequenceNumber": 1,
                "siteAvailablilityFlag": true,
                "surcharges": 0,
                "productId": 1203358,
                "upcId": 2224162,
                "upcNumber": "3605970810054",
                "uycTotalDiscountedPrice": 0,
                "uycDiscountedPercentage": 0,
                "uycPercentDiscount": 0
            },
            {
                "autoAddChoice": "MAKECHOICE",
                "discount": 2,
                "giftCardAmount": 0,
                "giftId": 0,
                "personalizationFlag": false,
                "gwpItemFlag": true,
                "isItemFromWishList": false,
                "pwpItemFlag": false,
                "specialItemFlag": false,
                "itemTotal": 0,
                "mergeRequiredFlag": false,
                "originalPrice": 2,
                "personalizationFee": 0,
                "pickupRegistryApplicable": true,
                "pickUpFromStore": false,
                "promotionId": 13165,
                "wishListId": 0,
                "promotions": [
                    {
                        "desc": "Gift with any $100 Lancôme purchase!",
                        "originalPrice": 2,
                        "promotionId": 13165,
                        "scope": "ORDER",
                        "target": "SUBTOTAL",
                        "type": "Bundled GWP",
                        "amountDiscounted": 2,
                        "adjustedCost": 0,
                        "operationDesc": "Gift with any $100 Lancôme purchase!",
                        "expirationDate": "2015-02-19 23.59.59.000",
                        "itemSequenceNumber": 2,
                        "requiredBCCCard": false,
                        "loyaltyAddSavings": false,
                        "loyaltyIncreaseSavings": false,
                        "propCardAddSavings": false,
                        "propCardIncreaseSavings": false
                    }
                ],
                "quantity": 1,
                "retailPrice": 2,
                "sequenceNumber": 2,
                "siteAvailablilityFlag": true,
                "surcharges": 0,
                "productId": 707319,
                "upcId": 1531557,
                "upcNumber": "492016515102",
                "uycTotalDiscountedPrice": 0,
                "uycDiscountedPercentage": 0,
                "uycPercentDiscount": 0
            }
        ],
        "promotionOffers": [],
        "uycApplicable": false
    }
}

3. Get details about MAKECHOICE GWP:

If the "state" of the item is set to "MAKECHOICE" you must make a product detail call using the product ID of the MAKECHOICE item.  From the response you must select a UPC ID (SKUID). 

NOTE: The "skuid" is also known as the "upcid".

Request URL:

GET

http://api.bloomingdales.com/v3/catalog/product/707319

Header:

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

Response

{
    "product": [
        {
            "id": 707319,
            "summary": {
                "name": "Gift with any $100 Lancôme purchase!",
                "description": "Receive a Juicy Tubes deluxe sample in Magic Spell or Spring Fling with any $100 Lancôme purchase. 

  Please note: Excludes gift sets.

  Shop the Lancôme Boutique",
                "pdpflag": "SIMPLE",
                "taxwarecode": 0,
                "fob": {
                    "id": 9,
                    "name": "COSMETICS"
                },
                "division": {
                    "id": 37,
                    "name": "COMBINED COSMETICS"
                },
                "department": {
                    "id": 358,
                    "name": "LANCOME"
                },
                "vendor": {
                    "id": 504
                },
                "producttype": "GWP",
                "brand": "Lancôme",
                "onsale": false,
                "producturl": "http://www1.bloomingdales.com/shop/product/gift-with-any-100-lancome-purchase?ID=707319",
                "instoreeligible": false,
                "iscollection": false,
                "incollection": false,
                "onclearance": false,
                "newarrival": false,
                "shippingreturntext": [
                    "This item may only be shipped using Express,Premium,Standard"
                ],
                "poboxrestriction": false,
                "shippingmethodcode": [
                    "O",
                    "2",
                    "G"
                ]
            },
            "image": [
                {
                    "imagetype": "PRIMARY_IMAGE",
                    "imageurl": "http://images.bloomingdales.com/is/image/BLM/products/1/optimized/8679021_fpx.tif?bgc=255,255,255&wid=100&qlt=90&layer=comp&op_sharpen=0&resMode=bicub&op_usm=0.7,1.0,0.5,0&fmt=jpeg",
                    "imagename": "1/optimized/8679021_fpx",
                    "colorized": true,
                    "sequenceNumber": 0,
                    "hasMoreColors": true,
                    "numberColors": 2,
                    "isPrimaryImage": true
                }
            ],
            "price": {
                "regular": {
                    "value": 2
                },
                "shippingfee": 0,
                "pricetype": "Ticket",
                "pricetypeid": 0
            },
            "availability": {
                "availableonline": true,
                "onlineinventory": 280,
                "onorderqty": 0,
                "maxorderqty": 6,
                "instoreeligible": false
            },
            "category": [
                {
                    "id": 2921,
                    "name": "Beauty",
                    "type": "homecategory"
                },
                {
                    "id": 2921,
                    "name": "Beauty",
                    "type": "rootcategory"
                }
            ],
            "attribute": [
                {
                    "name": "BEAUTY_GENDER",
                    "values": [
                        {
                            "value": "Female"
                        }
                    ]
                },
                {
                    "name": "BRAND",
                    "values": [
                        {
                            "value": "Lancôme"
                        }
                    ]
                },
                {
                    "name": "BULLET_TEXT",
                    "values": [
                        {
                            "value": "One per customer. While supplies last.",
                            "seqnum": 1
                        },
                        {
                            "value": "Your gift will be added automatically at checkout with any $100 Lancôme purchase. ",
                            "seqnum": 2
                        }
                    ]
                },
                {
                    "name": "DELIVERYMONTH",
                    "values": [
                        {
                            "value": "March 13"
                        }
                    ]
                },
                {
                    "name": "FORCED_NEW_END_DATE",
                    "values": [
                        {
                            "value": "05/04/2013 12:05:00 AM"
                        }
                    ]
                },
                {
                    "name": "FORCED_NEW_START_DATE",
                    "values": [
                        {
                            "value": "04/04/2013 12:04:00 AM"
                        }
                    ]
                },
                {
                    "name": "INSTORE_ELIGIBILITY",
                    "values": [
                        {
                            "value": "Y"
                        }
                    ]
                },
                {
                    "name": "INTL_SUPPRESS_PRODUCT",
                    "values": [
                        {
                            "value": "Y"
                        }
                    ]
                },
                {
                    "name": "MERCH_TURN_IN",
                    "values": [
                        {
                            "value": "JPEG"
                        }
                    ]
                },
                {
                    "name": "MORE_COLORS",
                    "values": [
                        {
                            "value": "Y"
                        }
                    ]
                },
                {
                    "name": "NON_SELLABLE",
                    "values": [
                        {
                            "value": "Y"
                        }
                    ]
                },
                {
                    "name": "PDF_EMAIL_DESCRIPTION",
                    "values": [
                        {
                            "value": "Gift with any $100 Lancôme purchase!"
                        }
                    ]
                },
                {
                    "name": "PRODUCT_DATA_SOURCE",
                    "values": [
                        {
                            "value": "2"
                        }
                    ]
                },
                {
                    "name": "PRODUCT_DEPARTMENT",
                    "values": [
                        {
                            "value": "Gift with Purchase"
                        }
                    ]
                },
                {
                    "name": "PRODUCT_LONG_DESCRIPTION",
                    "values": [
                        {
                            "value": "Receive a Juicy Tubes deluxe sample in Magic Spell or Spring Fling with any $100 Lancôme purchase. 

  Please note: Excludes gift sets.

  Shop the Lancôme Boutique"
                        }
                    ]
                },
                {
                    "name": "PRODUCT_PORTRAIT_IMAGE",
                    "values": [
                        {
                            "value": "8679021.fpx"
                        }
                    ]
                },
                {
                    "name": "PROMOTION_ID",
                    "values": [
                        {
                            "value": "13165",
                            "seqnum": 1
                        },
                        {
                            "value": "9160",
                            "seqnum": 2
                        }
                    ]
                },
                {
                    "name": "PROMO_TRIGGER_MULTI",
                    "values": [
                        {
                            "value": "24483_1",
                            "seqnum": 1
                        },
                        {
                            "value": "28744230_0",
                            "seqnum": 2
                        },
                        {
                            "value": "28746540_1",
                            "seqnum": 3
                        },
                        {
                            "value": "28749908_1",
                            "seqnum": 4
                        },
                        {
                            "value": "28749912_1",
                            "seqnum": 5
                        },
                        {
                            "value": "28749916_1",
                            "seqnum": 6
                        },
                        {
                            "value": "28749920_1",
                            "seqnum": 7
                        },
                        {
                            "value": "28749924_1",
                            "seqnum": 8
                        },
                        {
                            "value": "28749928_1",
                            "seqnum": 9
                        },
                        {
                            "value": "28749932_1",
                            "seqnum": 10
                        },
                        {
                            "value": "28749936_1",
                            "seqnum": 11
                        },
                        {
                            "value": "28749972_1",
                            "seqnum": 12
                        },
                        {
                            "value": "28749977_1",
                            "seqnum": 13
                        },
                        {
                            "value": "28749981_1",
                            "seqnum": 14
                        },
                        {
                            "value": "28749986_1",
                            "seqnum": 15
                        },
                        {
                            "value": "28749988_1",
                            "seqnum": 16
                        },
                        {
                            "value": "28749993_1",
                            "seqnum": 17
                        },
                        {
                            "value": "28749998_1",
                            "seqnum": 18
                        },
                        {
                            "value": "28750004_1",
                            "seqnum": 19
                        },
                        {
                            "value": "28750010_1",
                            "seqnum": 20
                        },
                        {
                            "value": "28750015_1",
                            "seqnum": 21
                        },
                        {
                            "value": "28750019_0",
                            "seqnum": 22
                        },
                        {
                            "value": "28750102_1",
                            "seqnum": 23
                        },
                        {
                            "value": "28750583_1",
                            "seqnum": 24
                        },
                        {
                            "value": "28750586_1",
                            "seqnum": 25
                        },
                        {
                            "value": "28750591_1",
                            "seqnum": 26
                        },
                        {
                            "value": "28750598_1",
                            "seqnum": 27
                        },
                        {
                            "value": "28752508_1",
                            "seqnum": 28
                        },
                        {
                            "value": "28752517_1",
                            "seqnum": 29
                        },
                        {
                            "value": "28752526_1",
                            "seqnum": 30
                        },
                        {
                            "value": "28752535_1",
                            "seqnum": 31
                        },
                        {
                            "value": "28752544_1",
                            "seqnum": 32
                        },
                        {
                            "value": "28752553_1",
                            "seqnum": 33
                        },
                        {
                            "value": "28754137_1",
                            "seqnum": 34
                        },
                        {
                            "value": "28754146_1",
                            "seqnum": 35
                        },
                        {
                            "value": "28754157_1",
                            "seqnum": 36
                        },
                        {
                            "value": "28754166_1",
                            "seqnum": 37
                        },
                        {
                            "value": "28754175_1",
                            "seqnum": 38
                        },
                        {
                            "value": "28754184_1",
                            "seqnum": 39
                        },
                        {
                            "value": "28754193_1",
                            "seqnum": 40
                        },
                        {
                            "value": "28754203_1",
                            "seqnum": 41
                        },
                        {
                            "value": "28755023_0",
                            "seqnum": 42
                        },
                        {
                            "value": "28759742_1",
                            "seqnum": 43
                        },
                        {
                            "value": "28759744_1",
                            "seqnum": 44
                        },
                        {
                            "value": "28759746_1",
                            "seqnum": 45
                        },
                        {
                            "value": "28759748_1",
                            "seqnum": 46
                        },
                        {
                            "value": "28760195_1",
                            "seqnum": 47
                        },
                        {
                            "value": "28760215_1",
                            "seqnum": 48
                        },
                        {
                            "value": "28760999_1",
                            "seqnum": 49
                        },
                        {
                            "value": "28761008_1",
                            "seqnum": 50
                        },
                        {
                            "value": "28761017_1",
                            "seqnum": 51
                        },
                        {
                            "value": "28761026_1",
                            "seqnum": 52
                        },
                        {
                            "value": "28761035_1",
                            "seqnum": 53
                        },
                        {
                            "value": "28761044_1",
                            "seqnum": 54
                        },
                        {
                            "value": "28761293_0",
                            "seqnum": 55
                        },
                        {
                            "value": "28762872_1",
                            "seqnum": 56
                        },
                        {
                            "value": "28763720_1",
                            "seqnum": 57
                        },
                        {
                            "value": "28763765_1",
                            "seqnum": 58
                        },
                        {
                            "value": "28763768_1",
                            "seqnum": 59
                        },
                        {
                            "value": "28763775_1",
                            "seqnum": 60
                        },
                        {
                            "value": "28763778_1",
                            "seqnum": 61
                        },
                        {
                            "value": "28763822_1",
                            "seqnum": 62
                        },
                        {
                            "value": "28763829_1",
                            "seqnum": 63
                        },
                        {
                            "value": "28764146_1",
                            "seqnum": 64
                        },
                        {
                            "value": "28764149_1",
                            "seqnum": 65
                        },
                        {
                            "value": "28764154_1",
                            "seqnum": 66
                        },
                        {
                            "value": "28764165_1",
                            "seqnum": 67
                        },
                        {
                            "value": "28764275_1",
                            "seqnum": 68
                        },
                        {
                            "value": "28764372_1",
                            "seqnum": 69
                        },
                        {
                            "value": "28764454_1",
                            "seqnum": 70
                        },
                        {
                            "value": "28766618_1",
                            "seqnum": 71
                        },
                        {
                            "value": "28766722_1",
                            "seqnum": 72
                        },
                        {
                            "value": "28766731_1",
                            "seqnum": 73
                        },
                        {
                            "value": "28766735_1",
                            "seqnum": 74
                        },
                        {
                            "value": "28766740_1",
                            "seqnum": 75
                        },
                        {
                            "value": "28766748_1",
                            "seqnum": 76
                        },
                        {
                            "value": "28766753_1",
                            "seqnum": 77
                        },
                        {
                            "value": "28766758_1",
                            "seqnum": 78
                        },
                        {
                            "value": "28766763_1",
                            "seqnum": 79
                        },
                        {
                            "value": "28766768_1",
                            "seqnum": 80
                        },
                        {
                            "value": "28767116_1",
                            "seqnum": 81
                        },
                        {
                            "value": "28767124_1",
                            "seqnum": 82
                        },
                        {
                            "value": "28767190_1",
                            "seqnum": 83
                        },
                        {
                            "value": "28767193_1",
                            "seqnum": 84
                        },
                        {
                            "value": "28767209_0",
                            "seqnum": 85
                        },
                        {
                            "value": "28767255_1",
                            "seqnum": 86
                        },
                        {
                            "value": "28767335_1",
                            "seqnum": 87
                        },
                        {
                            "value": "28767412_1",
                            "seqnum": 88
                        },
                        {
                            "value": "28767482_1",
                            "seqnum": 89
                        },
                        {
                            "value": "28767525_1",
                            "seqnum": 90
                        },
                        {
                            "value": "28767529_1",
                            "seqnum": 91
                        },
                        {
                            "value": "28767533_1",
                            "seqnum": 92
                        },
                        {
                            "value": "28767580_1",
                            "seqnum": 93
                        },
                        {
                            "value": "28767584_1",
                            "seqnum": 94
                        },
                        {
                            "value": "28767589_1",
                            "seqnum": 95
                        },
                        {
                            "value": "28767597_1",
                            "seqnum": 96
                        },
                        {
                            "value": "28767647_1",
                            "seqnum": 97
                        },
                        {
                            "value": "28767651_1",
                            "seqnum": 98
                        },
                        {
                            "value": "28767655_1",
                            "seqnum": 99
                        },
                        {
                            "value": "28767681_1",
                            "seqnum": 100
                        },
                        {
                            "value": "28767684_1",
                            "seqnum": 101
                        },
                        {
                            "value": "28767686_1",
                            "seqnum": 102
                        },
                        {
                            "value": "28767694_1",
                            "seqnum": 103
                        },
                        {
                            "value": "28767697_1",
                            "seqnum": 104
                        },
                        {
                            "value": "28767702_1",
                            "seqnum": 105
                        },
                        {
                            "value": "28767710_1",
                            "seqnum": 106
                        },
                        {
                            "value": "28767715_1",
                            "seqnum": 107
                        },
                        {
                            "value": "28767716_1",
                            "seqnum": 108
                        },
                        {
                            "value": "28767717_1",
                            "seqnum": 109
                        },
                        {
                            "value": "28767718_1",
                            "seqnum": 110
                        },
                        {
                            "value": "28767733_1",
                            "seqnum": 111
                        },
                        {
                            "value": "28767734_1",
                            "seqnum": 112
                        },
                        {
                            "value": "28767761_1",
                            "seqnum": 113
                        },
                        {
                            "value": "28767764_1",
                            "seqnum": 114
                        },
                        {
                            "value": "28767795_1",
                            "seqnum": 115
                        },
                        {
                            "value": "28767799_1",
                            "seqnum": 116
                        }
                    ]
                },
                {
                    "name": "SORT_BY_FOB",
                    "values": [
                        {
                            "value": "Beauty"
                        }
                    ]
                },
                {
                    "name": "SPECIAL_OFFERS",
                    "values": [
                        {
                            "value": "Bundled GWP",
                            "seqnum": 1
                        },
                        {
                            "value": "Free Shipping",
                            "seqnum": 2
                        }
                    ]
                },
                {
                    "name": "WARRANTY",
                    "values": [
                        {
                            "value": "N"
                        }
                    ]
                }
            ],
            "upc": [
                {
                    "upcnumber": 492016515102,
                    "modelnumber": "JUICYMAGIC",
                    "skuid": 1531557,
                    "availableonline": true,
                    "onlineinventory": 62,
                    "ordermethod": "POOL",
                    "maxorderqty": 0,
                    "colorway_id": 378813,
                    "image": [
                        {
                            "imagetype": "COLORWAY",
                            "id": 378813,
                            "color": "Juicy Tube in Magic Spell",
                            "upcprimaryimage": {
                                "imagetype": "UPC_PRIMARY_IMAGE",
                                "imageurl": "http://images.bloomingdales.com/is/image/BLM/products/1/optimized/8679021_fpx.tif?bgc=255,255,255&wid=100&qlt=90&layer=comp&op_sharpen=0&resMode=bicub&op_usm=0.7,1.0,0.5,0&fmt=jpeg",
                                "imagename": "1/optimized/8679021_fpx",
                                "sequenceNumber": 0
                            },
                            "swatchsequencenumber": 0,
                            "swapoutsequencenumber": 0
                        }
                    ],
                    "attribute": [
                        {
                            "name": "COLOR",
                            "values": [
                                {
                                    "value": "Juicy Tube in Magic Spell"
                                }
                            ]
                        },
                        {
                            "name": "DISCOUNTABLE",
                            "values": [
                                {
                                    "value": "Y"
                                }
                            ]
                        }
                    ],
                    "upcavailabilitymessage": "In Stock: Usually leaves our facility within 2 business days.",
                    "surchargeFee": 0,
                    "backorderable": true
                },
                {
                    "upcnumber": 492016515119,
                    "modelnumber": "JUICYSPRING",
                    "skuid": 1531558,
                    "availableonline": true,
                    "onlineinventory": 218,
                    "ordermethod": "POOL",
                    "maxorderqty": 0,
                    "colorway_id": 378814,
                    "image": [
                        {
                            "imagetype": "COLORWAY",
                            "id": 378814,
                            "color": "Juicy Tube in Spring Fling",
                            "upcprimaryimage": {
                                "imagetype": "UPC_PRIMARY_IMAGE",
                                "imageurl": "http://images.bloomingdales.com/is/image/BLM/products/1/optimized/8679021_fpx.tif?bgc=255,255,255&wid=100&qlt=90&layer=comp&op_sharpen=0&resMode=bicub&op_usm=0.7,1.0,0.5,0&fmt=jpeg",
                                "imagename": "1/optimized/8679021_fpx",
                                "sequenceNumber": 0
                            },
                            "swatchsequencenumber": 0,
                            "swapoutsequencenumber": 1
                        }
                    ],
                    "attribute": [
                        {
                            "name": "COLOR",
                            "values": [
                                {
                                    "value": "Juicy Tube in Spring Fling"
                                }
                            ]
                        },
                        {
                            "name": "DISCOUNTABLE",
                            "values": [
                                {
                                    "value": "Y"
                                }
                            ]
                        }
                    ],
                    "upcavailabilitymessage": "In Stock: Usually leaves our facility within 2 business days.",
                    "surchargeFee": 0,
                    "backorderable": true
                }
            ],
            "colorMap": [
                {
                    "imagetype": "COLORWAY",
                    "id": 378814,
                    "color": "Juicy Tube in Spring Fling",
                    "upcprimaryimage": {
                        "imagetype": "UPC_PRIMARY_IMAGE",
                        "imageurl": "http://images.bloomingdales.com/is/image/BLM/products/1/optimized/8679021_fpx.tif?bgc=255,255,255&wid=100&qlt=90&layer=comp&op_sharpen=0&resMode=bicub&op_usm=0.7,1.0,0.5,0&fmt=jpeg",
                        "imagename": "1/optimized/8679021_fpx",
                        "sequenceNumber": 0
                    },
                    "swatchsequencenumber": 0,
                    "swapoutsequencenumber": 1
                },
                {
                    "imagetype": "COLORWAY",
                    "id": 378813,
                    "color": "Juicy Tube in Magic Spell",
                    "upcprimaryimage": {
                        "imagetype": "UPC_PRIMARY_IMAGE",
                        "imageurl": "http://images.bloomingdales.com/is/image/BLM/products/1/optimized/8679021_fpx.tif?bgc=255,255,255&wid=100&qlt=90&layer=comp&op_sharpen=0&resMode=bicub&op_usm=0.7,1.0,0.5,0&fmt=jpeg",
                        "imagename": "1/optimized/8679021_fpx",
                        "sequenceNumber": 0
                    },
                    "swatchsequencenumber": 0,
                    "swapoutsequencenumber": 0
                }
            ]
        }
    ]
}

4. Update the Shopping Bag with the UPC ID you have choosen:

NOTE: The "skuid" is also known as the "upcid".

In this example below we are going to select a Lancome Gift with Purchase: upcid: 1531557.

 

Request URL:

PATCH

http://api.bloomingdales.com/v3/shoppingbag/325500f0-3d67-4243-afcb-544cb5c5deb5/items?gwpIndicator=true

Header:

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

Request Body

{
    "item": {
        "promotionId": 13165,
        "quantity": "1",
        "sequenceNumber": 2,
        "upcId": "1531557"
    }
}

Response

{
    "bag": {
        "bagId": 138932712,
        "bagGUID": "325500f0-3d67-4243-afcb-544cb5c5deb5",
        "storeLocationNumber": 0,
        "owner": {
            "userId": 2196913038,
            "bccUser": false,
            "userRegistryId": 0
        },
        "shippingSummary": {
            "discount": 13,
            "method": "G",
            "standardCharges": 0,
            "standardChargesBeforeDicsount": 13,
            "surcharges": 0,
            "total": 0
        },
        "bagSummary": {
            "estimatedTax": 8.4,
            "itemCount": 2,
            "grandTotal": 148.4,
            "merchandiseTotal": 140,
            "totalPersonalizationFee": 0,
            "totalSaved": 2,
            "yaqAmount": 0
        },
        "promotions": [
            {
                "desc": "Free Shipping on Beauty orders of $50 or more",
                "originalPrice": 13,
                "promotionId": 9160,
                "scope": "ORDER",
                "target": "SHIPPING",
                "type": "Free Shipping",
                "amountDiscounted": 13,
                "adjustedCost": 0,
                "operationDesc": "Free Shipping on Beauty orders of $50 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": 140,
                "mergeRequiredFlag": false,
                "originalPrice": 140,
                "personalizationFee": 0,
                "pickupRegistryApplicable": true,
                "pickUpFromStore": false,
                "promotionId": 0,
                "wishListId": 0,
                "quantity": 1,
                "retailPrice": 140,
                "sequenceNumber": 1,
                "siteAvailablilityFlag": true,
                "surcharges": 0,
                "productId": 1203358,
                "upcId": 2224162,
                "upcNumber": "3605970810054",
                "uycTotalDiscountedPrice": 0,
                "uycDiscountedPercentage": 0,
                "uycPercentDiscount": 0
            },
            {
                "autoAddChoice": "ADD",
                "discount": 2,
                "giftCardAmount": 0,
                "giftId": 0,
                "personalizationFlag": false,
                "gwpItemFlag": true,
                "isItemFromWishList": false,
                "pwpItemFlag": false,
                "specialItemFlag": false,
                "itemTotal": 0,
                "mergeRequiredFlag": false,
                "originalPrice": 2,
                "personalizationFee": 0,
                "pickupRegistryApplicable": true,
                "pickUpFromStore": false,
                "promotionId": 13165,
                "wishListId": 0,
                "promotions": [
                    {
                        "desc": "Gift with any $100 Lancôme purchase!",
                        "originalPrice": 2,
                        "promotionId": 13165,
                        "scope": "ORDER",
                        "target": "SUBTOTAL",
                        "type": "Bundled GWP",
                        "amountDiscounted": 2,
                        "adjustedCost": 0,
                        "operationDesc": "Gift with any $100 Lancôme purchase!",
                        "expirationDate": "2015-02-19 23.59.59.000",
                        "itemSequenceNumber": 2,
                        "requiredBCCCard": false,
                        "loyaltyAddSavings": false,
                        "loyaltyIncreaseSavings": false,
                        "propCardAddSavings": false,
                        "propCardIncreaseSavings": false
                    }
                ],
                "quantity": 1,
                "retailPrice": 2,
                "sequenceNumber": 2,
                "siteAvailablilityFlag": true,
                "surcharges": 0,
                "productId": 707319,
                "upcId": 1531557,
                "upcNumber": "492016515102",
                "uycTotalDiscountedPrice": 0,
                "uycDiscountedPercentage": 0,
                "uycPercentDiscount": 0
            }
        ],
        "promotionOffers": [],
        "uycApplicable": false
    }
}

 

5. Retrieve Bag to ensure the choice has been updated:

Request URL:

GET

https://api.bloomingdales.com/order/v1/bags?userGuid=465920d0-de8a-4acb-ae7c-e45f8fedf161

Header:

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

Response 

{
    "bag": {
        "bagId": 138932712,
        "bagGUID": "325500f0-3d67-4243-afcb-544cb5c5deb5",
        "storeLocationNumber": 0,
        "owner": {
            "userId": 2196913038,
            "bccUser": false,
            "userRegistryId": 0
        },
        "shippingSummary": {
            "discount": 13,
            "method": "G",
            "standardCharges": 0,
            "standardChargesBeforeDicsount": 13,
            "surcharges": 0,
            "total": 0
        },
        "bagSummary": {
            "estimatedTax": 8.4,
            "itemCount": 2,
            "grandTotal": 148.4,
            "merchandiseTotal": 140,
            "totalPersonalizationFee": 0,
            "totalSaved": 2,
            "yaqAmount": 0
        },
        "promotions": [
            {
                "desc": "Free Shipping on Beauty orders of $50 or more",
                "originalPrice": 13,
                "promotionId": 9160,
                "scope": "ORDER",
                "target": "SHIPPING",
                "type": "Free Shipping",
                "amountDiscounted": 13,
                "adjustedCost": 0,
                "operationDesc": "Free Shipping on Beauty orders of $50 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": 140,
                "mergeRequiredFlag": false,
                "originalPrice": 140,
                "personalizationFee": 0,
                "pickupRegistryApplicable": true,
                "pickUpFromStore": false,
                "promotionId": 0,
                "wishListId": 0,
                "quantity": 1,
                "retailPrice": 140,
                "sequenceNumber": 1,
                "siteAvailablilityFlag": true,
                "surcharges": 0,
                "productId": 1203358,
                "upcId": 2224162,
                "upcNumber": "3605970810054",
                "uycTotalDiscountedPrice": 0,
                "uycDiscountedPercentage": 0,
                "uycPercentDiscount": 0
            },
            {
                "autoAddChoice": "ADD",
                "discount": 2,
                "giftCardAmount": 0,
                "giftId": 0,
                "personalizationFlag": false,
                "gwpItemFlag": true,
                "isItemFromWishList": false,
                "pwpItemFlag": false,
                "specialItemFlag": false,
                "itemTotal": 0,
                "mergeRequiredFlag": false,
                "originalPrice": 2,
                "personalizationFee": 0,
                "pickupRegistryApplicable": true,
                "pickUpFromStore": false,
                "promotionId": 13165,
                "wishListId": 0,
                "promotions": [
                    {
                        "desc": "Gift with any $100 Lancôme purchase!",
                        "originalPrice": 2,
                        "promotionId": 13165,
                        "scope": "ORDER",
                        "target": "SUBTOTAL",
                        "type": "Bundled GWP",
                        "amountDiscounted": 2,
                        "adjustedCost": 0,
                        "operationDesc": "Gift with any $100 Lancôme purchase!",
                        "expirationDate": "2015-02-19 23.59.59.000",
                        "itemSequenceNumber": 2,
                        "requiredBCCCard": false,
                        "loyaltyAddSavings": false,
                        "loyaltyIncreaseSavings": false,
                        "propCardAddSavings": false,
                        "propCardIncreaseSavings": false
                    }
                ],
                "quantity": 1,
                "retailPrice": 2,
                "sequenceNumber": 2,
                "siteAvailablilityFlag": true,
                "surcharges": 0,
                "productId": 707319,
                "upcId": 1531557,
                "upcNumber": "492016515102",
                "uycTotalDiscountedPrice": 0,
                "uycDiscountedPercentage": 0,
                "uycPercentDiscount": 0
            }
        ],
        "promotionOffers": [],
        "uycApplicable": false
    }
}

 


Docs Navigation