Adding a PWP to your Bag
Description
The following document outlines a sample of how to identify PWP's (Purchase with a Purchase) and add to bag. PWP's are sometimes regular products that are heavily discounted and offered to you when you add a item to your bag. They also can be items that are not available for sale on Macys.com but can be purchased when adding a certain item or hitting a monetary threshold. In the sample below you have the option to buy a Lancome Beauty Box for $59.50 with any Lancome purchase.
1. Add a item to bag that has a eligible PWP offer:
Request URL:
POST
https://api.macys.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": "2206322"
}
}
Response
{
"bag": {
"bagId": 138935298,
"bagGUID": "fba9ac8e-d300-4a1a-8b96-5b5dd57c2dd3",
"storeLocationNumber": 0,
"owner": {
"userId": 2196952581,
"userGuid": "1001384b-0773-4551-96dd-794f1e4a2053",
"bccUser": false,
"userRegistryId": 0
},
"shippingSummary": {
"discount": 0,
"method": "G",
"standardCharges": 8,
"standardChargesBeforeDicsount": 8,
"surcharges": 0,
"total": 8
},
"bagSummary": {
"estimatedTax": 2.1,
"itemCount": 1,
"grandTotal": 45.1,
"merchandiseTotal": 35,
"totalPersonalizationFee": 0,
"totalSaved": 0,
"yaqAmount": 0
},
"promotions": [],
"items": [
{
"autoAddChoice": "ADD",
"discount": 0,
"giftCardAmount": 0,
"giftId": 0,
"personalizationFlag": false,
"gwpItemFlag": false,
"isItemFromWishList": false,
"pwpItemFlag": false,
"specialItemFlag": false,
"itemTotal": 35,
"mergeRequiredFlag": false,
"originalPrice": 35,
"personalizationFee": 0,
"pickupRegistryApplicable": true,
"pickUpFromStore": false,
"promotionId": 0,
"wishListId": 0,
"quantity": 1,
"retailPrice": 35,
"sequenceNumber": 1,
"siteAvailablilityFlag": true,
"surcharges": 0,
"productId": 1186247,
"upcId": 2206322,
"upcNumber": "5700302279740",
"uycTotalDiscountedPrice": 0,
"uycDiscountedPercentage": 0,
"uycPercentDiscount": 0
}
],
"promotionOffers": [
{
"promotionId": 6374,
"bonusOffer": false,
"yourPrice": 105,
"giftProductId": 638865,
"quantity": 1
},
{
"promotionId": 10681,
"bonusOffer": false,
"yourPrice": 400,
"giftProductId": 1046444,
"quantity": 1
}
],
"uycApplicable": false
}
}
2. Retrieve Bag again to see if Item added has a PWP offer:
If the item you added to the bag has PWP offer you will see it "productpromotionoffers" array. You will see that there is a "giftproductid" populated and the "yourprice" attribute will give you the offer price.
Request URL:
GET
https://api.bloomingdales.com/order/v1/bags?userGuid=1001384b-0773-4551-96dd-794f1e4a2053
Header:
X-Macys-Webservice-Client-Id: xmj9js4jkdpe1983fmwu98gh
Accept: application/json
Response
{
"bag": {
"bagId": 138935298,
"bagGUID": "fba9ac8e-d300-4a1a-8b96-5b5dd57c2dd3",
"storeLocationNumber": 0,
"owner": {
"userId": 2196952581,
"bccUser": false,
"userRegistryId": 0
},
"shippingSummary": {
"discount": 0,
"method": "G",
"standardCharges": 8,
"standardChargesBeforeDicsount": 8,
"surcharges": 0,
"total": 8
},
"bagSummary": {
"estimatedTax": 2.1,
"itemCount": 1,
"grandTotal": 45.1,
"merchandiseTotal": 35,
"totalPersonalizationFee": 0,
"totalSaved": 0,
"yaqAmount": 0
},
"promotions": [],
"items": [
{
"autoAddChoice": "ADD",
"discount": 0,
"giftCardAmount": 0,
"giftId": 0,
"personalizationFlag": false,
"gwpItemFlag": false,
"isItemFromWishList": false,
"pwpItemFlag": false,
"specialItemFlag": false,
"itemTotal": 35,
"mergeRequiredFlag": false,
"originalPrice": 35,
"personalizationFee": 0,
"pickupRegistryApplicable": true,
"pickUpFromStore": false,
"promotionId": 0,
"wishListId": 0,
"quantity": 1,
"retailPrice": 35,
"sequenceNumber": 1,
"siteAvailablilityFlag": true,
"surcharges": 0,
"productId": 1186247,
"upcId": 2206322,
"upcNumber": "5700302279740",
"uycTotalDiscountedPrice": 0,
"uycDiscountedPercentage": 0,
"uycPercentDiscount": 0
}
],
"promotionOffers": [
{
"promotionId": 6374,
"bonusOffer": false,
"yourPrice": 105,
"giftProductId": 638865,
"quantity": 1
},
{
"promotionId": 10681,
"bonusOffer": false,
"yourPrice": 400,
"giftProductId": 1046444,
"quantity": 1
}
],
"uycApplicable": false
}
}
3. Get details about MAKECHOICE GWP:
Use the value found in the "giftproductid" field to pull up more details about the offer using a product detail call. For this example, we are going to look at productid: 638865.
NOTE: The "skuid" is also known as the "upcid".
See below:
Request URL:
GET
http://api.bloomingdales.com/v3/catalog/product/638865
Header:
X-Macys-Webservice-Client-Id: xmj9js4jkdpe1983fmwu98gh
Accept: application/json
Content-type: application/json
Response
{
"product": [
{
"id": 638865,
"summary": {
"name": "PANDORA The Iconic Gift Set, available for $105 (a $125 value) with any PANDORA charm purchase.",
"description": "The PANDORA Iconic gift set, consisting of one signature sterling silver bracelet and two sparkling s-clip beads, available for $105 (a $125 value) with any PANDORA charm purchase.",
"pdpflag": "SIMPLE",
"taxwarecode": 0,
"fob": {
"id": 2,
"name": "F. KLEIN"
},
"division": {
"id": 10,
"name": "FASHION ACCESSORIES"
},
"department": {
"id": 747,
"name": "BRIDGE PRECIOUS GEMS"
},
"vendor": {
"id": 432
},
"producttype": "BRACELETS",
"brand": "PANDORA",
"onsale": false,
"producturl": "http://www1.bloomingdales.com/shop/product/pandora-the-iconic-gift-set-available-for-105-a-125-value-with-any-pandora-charm-purchase?ID=638865",
"instoreeligible": true,
"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": "ADDITIONAL_IMAGE",
"imageurl": "http://images.bloomingdales.com/is/image/BLM/products/2/optimized/8092592_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": "2/optimized/8092592_fpx"
},
{
"imagetype": "PRIMARY_IMAGE",
"imageurl": "http://images.bloomingdales.com/is/image/BLM/products/1/optimized/8092591_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/8092591_fpx",
"colorized": true,
"hasMoreColors": false,
"numberColors": 1,
"isPrimaryImage": true
}
],
"price": {
"regular": {
"value": 125
},
"shippingfee": 0,
"pricetype": "Ticket",
"pricetypeid": 0
},
"availability": {
"availableonline": true,
"onlineinventory": 423,
"onorderqty": 0,
"maxorderqty": 12,
"instoreeligible": true
},
"category": [
{
"id": 3376,
"name": "Jewelry & Accessories",
"type": "homecategory"
},
{
"id": 3376,
"name": "Jewelry & Accessories",
"type": "rootcategory"
}
],
"attribute": [
{
"name": "AGE_CATEGORY",
"values": [
{
"value": "Adult"
}
]
},
{
"name": "BRACELETS_TYPE",
"values": [
{
"value": "Charm"
}
]
},
{
"name": "BRAND",
"values": [
{
"value": "PANDORA"
}
]
},
{
"name": "BULLET_TEXT",
"values": [
{
"value": "Gift set includes: 1 signature clasp bracelet and 2 s-clips ",
"seqnum": 1
},
{
"value": "Available for $105 ($125 value) with your purchase of a Pandora charm",
"seqnum": 2
},
{
"value": "Bracelet: style #590702HV; S-clip: style #790338",
"seqnum": 3
},
{
"value": "Photo may have been enlarged and/or enhanced ",
"seqnum": 4
},
{
"value": "Shop the Charms",
"seqnum": 5
},
{
"value": "Photo may have been enlarged and/or enhanced.",
"seqnum": 6
}
]
},
{
"name": "COUNTRY_OF_ORIGIN",
"values": [
{
"value": "Imported"
}
]
},
{
"name": "DELIVERYMONTH",
"values": [
{
"value": "July 12"
}
]
},
{
"name": "FABRIC_CONTENT",
"values": [
{
"value": "Sterling silver"
}
]
},
{
"name": "FORCED_NEW_END_DATE",
"values": [
{
"value": "09/08/2012 12:09:00 AM"
}
]
},
{
"name": "FORCED_NEW_START_DATE",
"values": [
{
"value": "08/09/2012 12:08:00 AM"
}
]
},
{
"name": "GENDER",
"values": [
{
"value": "Female"
}
]
},
{
"name": "GENDER_AGE",
"values": [
{
"value": "Women"
}
]
},
{
"name": "INSTORE_ELIGIBILITY",
"values": [
{
"value": "Y"
}
]
},
{
"name": "INTL_SUPPRESS_PRODUCT",
"values": [
{
"value": "Y"
}
]
},
{
"name": "JEWELRY_ACCESSORY_SALE_TYPE",
"values": [
{
"value": "Bracelets"
}
]
},
{
"name": "JEWELRY_AND_ACCESSORIES_TYPE",
"values": [
{
"value": "Bracelet"
}
]
},
{
"name": "JEWELRY_MATERIAL",
"values": [
{
"value": "Sterling Silver"
}
]
},
{
"name": "JEWELRY_TYPE",
"values": [
{
"value": "Fashion"
}
]
},
{
"name": "MORE_COLORS",
"values": [
{
"value": "Y"
}
]
},
{
"name": "NEW_ARRIVALS",
"values": [
{
"value": "N"
}
]
},
{
"name": "NON_SELLABLE",
"values": [
{
"value": "Y"
}
]
},
{
"name": "PDF_EMAIL_DESCRIPTION",
"values": [
{
"value": "The Iconic Gift Set"
}
]
},
{
"name": "PRODUCT_ADDITIONAL_IMAGES",
"values": [
{
"value": "8092592.fpx"
}
]
},
{
"name": "PRODUCT_DATA_SOURCE",
"values": [
{
"value": "2"
}
]
},
{
"name": "PRODUCT_DEPARTMENT",
"values": [
{
"value": "Bracelets"
}
]
},
{
"name": "PRODUCT_LONG_DESCRIPTION",
"values": [
{
"value": "The PANDORA Iconic gift set, consisting of one signature sterling silver bracelet and two sparkling s-clip beads, available for $105 (a $125 value) with any PANDORA charm purchase."
}
]
},
{
"name": "PRODUCT_NOUN",
"values": [
{
"value": "jewelry"
}
]
},
{
"name": "PRODUCT_PORTRAIT_IMAGE",
"values": [
{
"value": "8092591.fpx"
}
]
},
{
"name": "PROMO_TRIGGER_MULTI",
"values": [
{
"value": "28752502_1",
"seqnum": 1
},
{
"value": "28752511_1",
"seqnum": 2
},
{
"value": "28752520_1",
"seqnum": 3
},
{
"value": "28752529_1",
"seqnum": 4
},
{
"value": "28752538_1",
"seqnum": 5
},
{
"value": "28752547_1",
"seqnum": 6
},
{
"value": "28754131_1",
"seqnum": 7
},
{
"value": "28754140_1",
"seqnum": 8
},
{
"value": "28754151_1",
"seqnum": 9
},
{
"value": "28754160_1",
"seqnum": 10
},
{
"value": "28754169_1",
"seqnum": 11
},
{
"value": "28754178_1",
"seqnum": 12
},
{
"value": "28754187_1",
"seqnum": 13
},
{
"value": "28754197_1",
"seqnum": 14
},
{
"value": "28760182_1",
"seqnum": 15
},
{
"value": "28760202_1",
"seqnum": 16
},
{
"value": "28760993_1",
"seqnum": 17
},
{
"value": "28761002_1",
"seqnum": 18
},
{
"value": "28761011_1",
"seqnum": 19
},
{
"value": "28761020_1",
"seqnum": 20
},
{
"value": "28761029_1",
"seqnum": 21
},
{
"value": "28761038_1",
"seqnum": 22
},
{
"value": "28762428_1",
"seqnum": 23
},
{
"value": "28766605_1",
"seqnum": 24
},
{
"value": "28766724_1",
"seqnum": 25
},
{
"value": "28766734_1",
"seqnum": 26
},
{
"value": "28766739_1",
"seqnum": 27
},
{
"value": "28766744_1",
"seqnum": 28
},
{
"value": "28766747_1",
"seqnum": 29
},
{
"value": "28766752_1",
"seqnum": 30
},
{
"value": "28766757_1",
"seqnum": 31
},
{
"value": "28766762_1",
"seqnum": 32
},
{
"value": "28766767_1",
"seqnum": 33
},
{
"value": "28767413_1",
"seqnum": 34
},
{
"value": "28767481_1",
"seqnum": 35
},
{
"value": "28767526_1",
"seqnum": 36
},
{
"value": "28767530_1",
"seqnum": 37
},
{
"value": "28767583_1",
"seqnum": 38
},
{
"value": "28767588_1",
"seqnum": 39
},
{
"value": "28767593_1",
"seqnum": 40
},
{
"value": "28767596_1",
"seqnum": 41
},
{
"value": "28767648_1",
"seqnum": 42
},
{
"value": "28767652_1",
"seqnum": 43
},
{
"value": "28767656_1",
"seqnum": 44
},
{
"value": "28767673_0",
"seqnum": 45
}
]
},
{
"name": "SORT_BY_FOB",
"values": [
{
"value": "Jewelry & Accessories"
}
]
},
{
"name": "TEMPREINDEX",
"values": [
{
"value": "Y"
}
]
},
{
"name": "WARRANTY",
"values": [
{
"value": "N"
}
]
}
],
"upc": [
{
"upcnumber": 5700302127126,
"modelnumber": "USB790119",
"skuid": 1298050,
"availableonline": true,
"onlineinventory": 423,
"ordermethod": "POOL",
"maxorderqty": 0,
"colorway_id": 280689,
"image": [
{
"imagetype": "COLORWAY",
"id": 280689,
"colornormal": "Silver",
"color": "Silver",
"upcadditionalimage": [
{
"imagetype": "UPC_ADDITIONAL_IMAGE",
"imageurl": "http://images.bloomingdales.com/is/image/BLM/products/2/optimized/8092592_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": "2/optimized/8092592_fpx",
"sequenceNumber": 1
}
],
"upcprimaryimage": {
"imagetype": "UPC_PRIMARY_IMAGE",
"imageurl": "http://images.bloomingdales.com/is/image/BLM/products/1/optimized/8092591_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/8092591_fpx",
"sequenceNumber": 1
},
"swatchsequencenumber": 0,
"swapoutsequencenumber": 0
}
],
"attribute": [
{
"name": "COLOR",
"values": [
{
"value": "Silver"
}
]
},
{
"name": "COLOR_NORMAL",
"values": [
{
"value": "Silver"
}
]
},
{
"name": "DISCOUNTABLE",
"values": [
{
"value": "Y"
}
]
}
],
"upcavailabilitymessage": "In Stock: Usually leaves our facility within 2 business days.",
"surchargeFee": 0,
"backorderable": false
}
],
"colorMap": [
{
"imagetype": "COLORWAY",
"id": 280689,
"colornormal": "Silver",
"color": "Silver",
"upcadditionalimage": [
{
"imagetype": "UPC_ADDITIONAL_IMAGE",
"imageurl": "http://images.bloomingdales.com/is/image/BLM/products/2/optimized/8092592_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": "2/optimized/8092592_fpx",
"sequenceNumber": 1
}
],
"upcprimaryimage": {
"imagetype": "UPC_PRIMARY_IMAGE",
"imageurl": "http://images.bloomingdales.com/is/image/BLM/products/1/optimized/8092591_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/8092591_fpx",
"sequenceNumber": 1
},
"swatchsequencenumber": 0,
"swapoutsequencenumber": 0
}
]
}
]
}
4. Update the Shopping Bag with the UPC ID from the product detail call:
NOTE: The "skuid" is also known as the "upcid".
In this example below we are going to use the "upcid" retrieved from the product detail call.
Request URL:
PATCH
http://api.bloomingdales.com/order/v1/bags/fba9ac8e-d300-4a1a-8b96-5b5dd57c2dd3/items
Header:
X-Macys-Webservice-Client-Id: xmj9js4jkdpe1983fmwu98gh
Accept: application/json
Content-type: application/json
Request Body
{
"item": {
"quantity": "1",
"upcId": "1298050"
}
}
Response
{
"bag": {
"bagId": 138935298,
"bagGUID": "fba9ac8e-d300-4a1a-8b96-5b5dd57c2dd3",
"storeLocationNumber": 0,
"owner": {
"userId": 2196952581,
"bccUser": false,
"userRegistryId": 0
},
"shippingSummary": {
"discount": 0,
"method": "G",
"standardCharges": 8,
"standardChargesBeforeDicsount": 8,
"surcharges": 0,
"total": 8
},
"bagSummary": {
"estimatedTax": 2.1,
"itemCount": 1,
"grandTotal": 45.1,
"merchandiseTotal": 35,
"totalPersonalizationFee": 0,
"totalSaved": 0,
"yaqAmount": 0
},
"promotions": [],
"items": [
{
"autoAddChoice": "ADD",
"discount": 0,
"giftCardAmount": 0,
"giftId": 0,
"personalizationFlag": false,
"gwpItemFlag": false,
"isItemFromWishList": false,
"pwpItemFlag": false,
"specialItemFlag": false,
"itemTotal": 35,
"mergeRequiredFlag": false,
"originalPrice": 35,
"personalizationFee": 0,
"pickupRegistryApplicable": true,
"pickUpFromStore": false,
"promotionId": 0,
"wishListId": 0,
"quantity": 1,
"retailPrice": 35,
"sequenceNumber": 1,
"siteAvailablilityFlag": true,
"surcharges": 0,
"productId": 1186247,
"upcId": 2206322,
"upcNumber": "5700302279740",
"uycTotalDiscountedPrice": 0,
"uycDiscountedPercentage": 0,
"uycPercentDiscount": 0
},
{
"discount": 0,
"errors": [
{
"code": 0,
"message": "ERROR_135_BAGSERVICE_PRODUCTNOTSELLABLE_ERRORCODE"
}
],
"giftCardAmount": 0,
"giftId": 0,
"personalizationFlag": false,
"gwpItemFlag": false,
"isItemFromWishList": false,
"pwpItemFlag": false,
"specialItemFlag": false,
"itemTotal": 125,
"mergeRequiredFlag": false,
"originalPrice": 125,
"personalizationFee": 0,
"pickupRegistryApplicable": true,
"promotionId": 0,
"wishListId": 0,
"quantity": 1,
"registry": {
"id": 0
},
"retailPrice": 125,
"sequenceNumber": 0,
"siteAvailablilityFlag": true,
"surcharges": 0,
"productId": 638865,
"upcId": 1298050,
"upcNumber": "5700302127126",
"uycTotalDiscountedPrice": 0,
"uycDiscountedPercentage": 0,
"uycPercentDiscount": 0
}
],
"promotionOffers": [
{
"promotionId": 6374,
"bonusOffer": false,
"yourPrice": 105,
"giftProductId": 638865,
"quantity": 1
},
{
"promotionId": 10681,
"bonusOffer": false,
"yourPrice": 400,
"giftProductId": 1046444,
"quantity": 1
}
],
"uycApplicable": false
}
}
5. Retrieve Bag to ensure the choice has been updated:
Request URL:
GET
https://api.bloomingdales.com/order/v1/bags?bagGuid=fba9ac8e-d300-4a1a-8b96-5b5dd57c2dd3
Header:
X-Macys-Webservice-Client-Id: xmj9js4jkdpe1983fmwu98gh
Accept: application/json
Response
{
"bag": {
"bagId": 138935298,
"bagGUID": "fba9ac8e-d300-4a1a-8b96-5b5dd57c2dd3",
"storeLocationNumber": 0,
"owner": {
"userId": 2196952581,
"bccUser": false,
"userRegistryId": 0
},
"shippingSummary": {
"discount": 0,
"method": "G",
"standardCharges": 8,
"standardChargesBeforeDicsount": 8,
"surcharges": 0,
"total": 8
},
"bagSummary": {
"estimatedTax": 2.1,
"itemCount": 1,
"grandTotal": 45.1,
"merchandiseTotal": 35,
"totalPersonalizationFee": 0,
"totalSaved": 0,
"yaqAmount": 0
},
"promotions": [],
"items": [
{
"autoAddChoice": "ADD",
"discount": 0,
"giftCardAmount": 0,
"giftId": 0,
"personalizationFlag": false,
"gwpItemFlag": false,
"isItemFromWishList": false,
"pwpItemFlag": false,
"specialItemFlag": false,
"itemTotal": 35,
"mergeRequiredFlag": false,
"originalPrice": 35,
"personalizationFee": 0,
"pickupRegistryApplicable": true,
"pickUpFromStore": false,
"promotionId": 0,
"wishListId": 0,
"quantity": 1,
"retailPrice": 35,
"sequenceNumber": 1,
"siteAvailablilityFlag": true,
"surcharges": 0,
"productId": 1186247,
"upcId": 2206322,
"upcNumber": "5700302279740",
"uycTotalDiscountedPrice": 0,
"uycDiscountedPercentage": 0,
"uycPercentDiscount": 0
}
],
"promotionOffers": [
{
"promotionId": 6374,
"bonusOffer": false,
"yourPrice": 105,
"giftProductId": 638865,
"quantity": 1
},
{
"promotionId": 10681,
"bonusOffer": false,
"yourPrice": 400,
"giftProductId": 1046444,
"quantity": 1
}
],
"uycApplicable": false
}
}
Docs Navigation
- Overview
- Customer Services
- Loyalty Services
- customer v1 user profile services
- Common API Characteristics
- Ad Media
- Catalog and Store Services
- Order Services
- Mobile Utilities
- Promotion and Coupon Services
- Registry Services
- Store Services
- Error Handling
- Deprecated Services
- What's New
- Bloomingdale's API FAQ
- Quick Start Guide
- BOPS Stores
- user