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.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": "31705412"
}
}
Response
{
"bag": {
"bagId": 431149999,
"bagGUID": "6b2ebfdd-28cd-42c8-9873-6b7855cb06d5",
"storeLocationNumber": 0,
"owner": {
"userId": 9518084697,
"userGuid": "c4820831-2654-4fd6-8bc7-b9d95f799265",
"bccUser": false,
"userRegistryId": 0
},
"shippingSummary": {
"discount": 9.95,
"method": "G",
"standardCharges": 0,
"standardChargesBeforeDicsount": 9.95,
"surcharges": 0,
"total": 0
},
"bagSummary": {
"estimatedTax": 5.22,
"itemCount": 4,
"grandTotal": 92.22,
"merchandiseTotal": 87,
"totalPersonalizationFee": 0,
"totalSaved": 6,
"yaqAmount": 0
},
"promotions": [
{
"desc": "Free Shipping with any $50 Beauty purchase! ",
"originalPrice": 9.95,
"promotionId": 19848072,
"scope": "ORDER",
"target": "SHIPPING",
"type": "Free Shipping",
"amountDiscounted": 9.95,
"adjustedCost": 0,
"operationDesc": "Free Shipping with any $50 Beauty purchase! ",
"expirationDate": "2020-01-01 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": 87,
"mergeRequiredFlag": false,
"originalPrice": 87,
"personalizationFee": 0,
"pickupRegistryApplicable": true,
"pickUpFromStore": false,
"promotionId": 0,
"wishListId": 0,
"quantity": 1,
"retailPrice": 87,
"sequenceNumber": 1,
"siteAvailablilityFlag": true,
"surcharges": 0,
"productId": 207399,
"upcId": 31705412,
"upcNumber": "3380811086101",
"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": 19845962,
"wishListId": 0,
"promotions": [
{
"desc": "Free Clarins products with your $70 Clarins purchase",
"originalPrice": 2,
"promotionId": 19845962,
"scope": "ORDER",
"target": "SUBTOTAL",
"type": "Threshold GWP",
"amountDiscounted": 2,
"adjustedCost": 0,
"operationDesc": "Free Clarins products with your $70 Clarins purchase",
"expirationDate": "2015-03-01 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": 1887893,
"upcId": 17726432,
"upcNumber": "3380810051629",
"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": 19845963,
"wishListId": 0,
"promotions": [
{
"desc": "Free Clarins products with your $70 Clarins purchase",
"originalPrice": 2,
"promotionId": 19845963,
"scope": "ORDER",
"target": "SUBTOTAL",
"type": "Threshold GWP",
"amountDiscounted": 2,
"adjustedCost": 0,
"operationDesc": "Free Clarins products with your $70 Clarins purchase",
"expirationDate": "2015-03-01 23.59.59.000",
"itemSequenceNumber": 3,
"requiredBCCCard": false,
"loyaltyAddSavings": false,
"loyaltyIncreaseSavings": false,
"propCardAddSavings": false,
"propCardIncreaseSavings": false
}
],
"quantity": 1,
"retailPrice": 2,
"sequenceNumber": 3,
"siteAvailablilityFlag": true,
"surcharges": 0,
"productId": 1981890,
"upcId": 33900207,
"upcNumber": "492018101044",
"uycTotalDiscountedPrice": 0,
"uycDiscountedPercentage": 0,
"uycPercentDiscount": 0
},
{
"autoAddChoice": "ADD",
"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": 19847321,
"wishListId": 0,
"promotions": [
{
"desc": "Free Cosmetics Bag with $75 online Beauty purchase",
"originalPrice": 2,
"promotionId": 19847321,
"scope": "ORDER",
"target": "SUBTOTAL",
"type": "Bundled GWP",
"amountDiscounted": 2,
"adjustedCost": 0,
"operationDesc": "Free Cosmetics Bag with $75 online Beauty purchase",
"expirationDate": "2015-03-01 23.59.59.000",
"itemSequenceNumber": 4,
"requiredBCCCard": false,
"loyaltyAddSavings": false,
"loyaltyIncreaseSavings": false,
"propCardAddSavings": false,
"propCardIncreaseSavings": false
}
],
"quantity": 1,
"retailPrice": 2,
"sequenceNumber": 4,
"siteAvailablilityFlag": true,
"surcharges": 0,
"productId": 1859357,
"upcId": 33925687,
"upcNumber": "853532005865",
"uycTotalDiscountedPrice": 0,
"uycDiscountedPercentage": 0,
"uycPercentDiscount": 0
}
],
"promotionOffers": [],
"uycApplicable": false
}
}
2. Retrieve Bag again to see item has been added:
Request URL:
GET
https://api.macys.com/order/v1/bags?userGuid=c4820831-2654-4fd6-8bc7-b9d95f799265
Header:
X-Macys-Webservice-Client-Id: xmj9js4jkdpe1983fmwu98gh
Accept: application/json
Response
{
"bag": {
"bagId": 431149999,
"bagGUID": "6b2ebfdd-28cd-42c8-9873-6b7855cb06d5",
"storeLocationNumber": 0,
"owner": {
"userId": 9518084697,
"bccUser": false,
"userRegistryId": 0
},
"shippingSummary": {
"discount": 9.95,
"method": "G",
"standardCharges": 0,
"standardChargesBeforeDicsount": 9.95,
"surcharges": 0,
"total": 0
},
"bagSummary": {
"estimatedTax": 5.22,
"itemCount": 4,
"grandTotal": 92.22,
"merchandiseTotal": 87,
"totalPersonalizationFee": 0,
"totalSaved": 6,
"yaqAmount": 0
},
"promotions": [
{
"desc": "Free Shipping with any $50 Beauty purchase! ",
"originalPrice": 9.95,
"promotionId": 19848072,
"scope": "ORDER",
"target": "SHIPPING",
"type": "Free Shipping",
"amountDiscounted": 9.95,
"adjustedCost": 0,
"operationDesc": "Free Shipping with any $50 Beauty purchase! ",
"expirationDate": "2020-01-01 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": 87,
"mergeRequiredFlag": false,
"originalPrice": 87,
"personalizationFee": 0,
"pickupRegistryApplicable": true,
"pickUpFromStore": false,
"promotionId": 0,
"wishListId": 0,
"quantity": 1,
"retailPrice": 87,
"sequenceNumber": 1,
"siteAvailablilityFlag": true,
"surcharges": 0,
"productId": 207399,
"upcId": 31705412,
"upcNumber": "3380811086101",
"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": 19845962,
"wishListId": 0,
"promotions": [
{
"desc": "Free Clarins products with your $70 Clarins purchase",
"originalPrice": 2,
"promotionId": 19845962,
"scope": "ORDER",
"target": "SUBTOTAL",
"type": "Threshold GWP",
"amountDiscounted": 2,
"adjustedCost": 0,
"operationDesc": "Free Clarins products with your $70 Clarins purchase",
"expirationDate": "2015-03-01 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": 1887893,
"upcId": 17726432,
"upcNumber": "3380810051629",
"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": 19845963,
"wishListId": 0,
"promotions": [
{
"desc": "Free Clarins products with your $70 Clarins purchase",
"originalPrice": 2,
"promotionId": 19845963,
"scope": "ORDER",
"target": "SUBTOTAL",
"type": "Threshold GWP",
"amountDiscounted": 2,
"adjustedCost": 0,
"operationDesc": "Free Clarins products with your $70 Clarins purchase",
"expirationDate": "2015-03-01 23.59.59.000",
"itemSequenceNumber": 3,
"requiredBCCCard": false,
"loyaltyAddSavings": false,
"loyaltyIncreaseSavings": false,
"propCardAddSavings": false,
"propCardIncreaseSavings": false
}
],
"quantity": 1,
"retailPrice": 2,
"sequenceNumber": 3,
"siteAvailablilityFlag": true,
"surcharges": 0,
"productId": 1981890,
"upcId": 33900207,
"upcNumber": "492018101044",
"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": 19847321,
"wishListId": 0,
"promotions": [
{
"desc": "Free Cosmetics Bag with $75 online Beauty purchase",
"originalPrice": 2,
"promotionId": 19847321,
"scope": "ORDER",
"target": "SUBTOTAL",
"type": "Bundled GWP",
"amountDiscounted": 2,
"adjustedCost": 0,
"operationDesc": "Free Cosmetics Bag with $75 online Beauty purchase",
"expirationDate": "2015-03-01 23.59.59.000",
"itemSequenceNumber": 4,
"requiredBCCCard": false,
"loyaltyAddSavings": false,
"loyaltyIncreaseSavings": false,
"propCardAddSavings": false,
"propCardIncreaseSavings": false
}
],
"quantity": 1,
"retailPrice": 2,
"sequenceNumber": 4,
"siteAvailablilityFlag": true,
"surcharges": 0,
"productId": 1859357,
"upcId": 33925687,
"upcNumber": "853532005865",
"uycTotalDiscountedPrice": 0,
"uycDiscountedPercentage": 0,
"uycPercentDiscount": 0
}
],
"promotionOffers": [],
"uycApplicable": false
}
}
3. Get details about MAKECHOICE GWP:
If the "AutoAddChoice" 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".
See below:
Request URL:
GET
http://api.macys.com/v3/catalog/product/1887893
Header:
X-Macys-Webservice-Client-Id: xmj9js4jkdpe1983fmwu98gh
Accept: application/json
Content-type: application/json
Response
{
"product": [
{
"id": 1887893,
"summary": {
"name": "Choose two FREE Deluxe Samples with $70 Clarins purchase",
"description": "Choose two FREE Deluxe Samples with $70 Clarins purchase. Choose any two:",
"pdpflag": "SIMPLE",
"taxwarecode": 0,
"producttype": "MAKEUP",
"brand": "Clarins",
"onsale": false,
"producturl": "http://www1.macys.com/shop/product/choose-two-free-deluxe-samples-with-70-clarins-purchase?ID=1887893",
"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"
],
"registrable": "Wedding"
},
"image": [
{
"imagetype": "PRIMARY_IMAGE",
"imageurl": "http://slimages.macys.com/is/image/MCY/products/1/optimized/2621571_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/2621571_fpx",
"colorized": true,
"hasMoreColors": false,
"numberColors": 1,
"isPrimaryImage": true
}
],
"price": {
"regular": {
"value": 2
},
"shippingfee": 0,
"pricetype": "Ticket",
"pricetypeid": 0
},
"availability": {
"availableonline": true,
"onlineinventory": 7032,
"onorderqty": 300,
"maxorderqty": 6,
"instoreeligible": true
},
"category": [
{
"id": 58476,
"name": "Gifts with Purchase",
"type": "homecategory"
},
{
"id": 669,
"name": "Beauty",
"type": "rootcategory"
}
],
"attribute": [
{
"name": "AGE_CATEGORY",
"values": [
{
"value": "Adult"
}
]
},
{
"name": "BEAUTY_GIFTING",
"values": [
{
"value": "Gifts with Purchase"
}
]
},
{
"name": "BRAND",
"values": [
{
"value": "Clarins"
}
]
},
{
"name": "BULLET_TEXT",
"values": [
{
"value": "Toning Lotion with Camomile Normal or Dry Skin, 3.4 oz",
"seqnum": 1
},
{
"value": "Super Restorative Night, 1.06 oz",
"seqnum": 2
},
{
"value": "One-Step Cleanser, 3.4 oz",
"seqnum": 3
},
{
"value": "Extra-Firming Night Cream All Skin Types, 1.06 oz",
"seqnum": 4
},
{
"value": "Gentle Foaming Cleanser with Cottonseed",
"seqnum": 5
},
{
"value": "Multi-Active Night Cream All Skin Types, 1 oz",
"seqnum": 6
},
{
"value": "Gentle Eye Make-Up Remover, 1.7 oz",
"seqnum": 7
},
{
"value": "HydraQuench Cream-Mask",
"seqnum": 8
},
{
"value": "Your gift will be added automatically at checkout. Minimum purchase amount does not include the purchase of gift card(s), tax, shipping or gift wrap charges. One gift per customer. Available while supplies last. Online only.",
"seqnum": 9
}
]
},
{
"name": "BUSINESS_CATEGORY",
"values": [
{
"value": "Beauty"
}
]
},
{
"name": "EXCLUDE_ADSENSE",
"values": [
{
"value": "Y"
}
]
},
{
"name": "FORCED_NEW_END_DATE",
"values": [
{
"value": "07/15/2015 12:07:00 AM"
}
]
},
{
"name": "FORCED_NEW_START_DATE",
"values": [
{
"value": "01/16/2015 05:01:24 PM"
}
]
},
{
"name": "GLOBAL_PROMOTION",
"values": [
{
"value": "Y"
}
]
},
{
"name": "INTL_SUPPRESS_PRODUCT",
"values": [
{
"value": "Y"
}
]
},
{
"name": "NON_SELLABLE",
"values": [
{
"value": "Y"
}
]
},
{
"name": "OLAPIC_ENABLED",
"values": [
{
"value": "Y"
}
]
},
{
"name": "PDF_EMAIL_DESCRIPTION",
"values": [
{
"value": "Choose two FREE Deluxe Samples with $70 Clarins purchase"
}
]
},
{
"name": "PRODUCT_DATA_SOURCE",
"values": [
{
"value": "2"
}
]
},
{
"name": "PRODUCT_DEPARTMENT",
"values": [
{
"value": "Makeup"
}
]
},
{
"name": "PRODUCT_LONG_DESCRIPTION",
"values": [
{
"value": "Choose two FREE Deluxe Samples with $70 Clarins purchase. Choose any two:"
}
]
},
{
"name": "PRODUCT_PORTRAIT_IMAGE",
"values": [
{
"value": "2621571.fpx"
}
]
},
{
"name": "PROMOTION_ID",
"values": [
{
"value": "19832816",
"seqnum": 1
},
{
"value": "19839242",
"seqnum": 2
},
{
"value": "19840845",
"seqnum": 3
},
{
"value": "19842925",
"seqnum": 4
},
{
"value": "19845962",
"seqnum": 5
},
{
"value": "19845963",
"seqnum": 6
},
{
"value": "19848070",
"seqnum": 7
},
{
"value": "19848072",
"seqnum": 8
}
]
},
{
"name": "REGISTRABLE",
"values": [
{
"value": "Wedding"
}
]
},
{
"name": "SPECIAL_OFFERS",
"values": [
{
"value": "Free Shipping",
"seqnum": 1
},
{
"value": "Percent Off Order",
"seqnum": 2
},
{
"value": "PWP",
"seqnum": 3
},
{
"value": "Threshold GWP",
"seqnum": 4
}
]
},
{
"name": "WARRANTY",
"values": [
{
"value": "N"
}
]
}
],
"upc": [
{
"upcnumber": 3380810051629,
"skuid": 17726432,
"availableonline": true,
"onlineinventory": 1019,
"ordermethod": "POOL",
"maxorderqty": 0,
"colorway_id": 1,
"image": [
{
"imagetype": "COLORWAY",
"id": 1,
"colornormal": "None",
"color": "None"
}
],
"attribute": [
{
"name": "TYPE",
"values": [
{
"value": "Toning Lotion with Camomile / Normal-to-Dry Skin "
}
]
},
{
"name": "COLOR",
"values": [
{
"value": "None"
}
]
},
{
"name": "DISCOUNTABLE",
"values": [
{
"value": "Y"
}
]
},
{
"name": "TYPE",
"values": [
{
"value": "Toning Lotion with Camomile / Normal-to-Dry Skin "
}
]
}
],
"upcavailabilitymessage": "In Stock: Usually ships within 2 business days.",
"surchargeFee": 0,
"backorderable": false
},
{
"upcnumber": 3380811182612,
"skuid": 32502716,
"availableonline": true,
"onlineinventory": 1082,
"ordermethod": "POOL",
"maxorderqty": 0,
"colorway_id": 1,
"image": [
{
"imagetype": "COLORWAY",
"id": 1,
"colornormal": "None",
"color": "None"
}
],
"attribute": [
{
"name": "TYPE",
"values": [
{
"value": "Gentle Eye Make-Up Remover"
}
]
},
{
"name": "COLOR",
"values": [
{
"value": "None"
}
]
},
{
"name": "DISCOUNTABLE",
"values": [
{
"value": "Y"
}
]
},
{
"name": "TYPE",
"values": [
{
"value": "Gentle Eye Make-Up Remover"
}
]
}
],
"upcavailabilitymessage": "In Stock: Usually ships within 2 business days.",
"surchargeFee": 0,
"backorderable": false
},
{
"upcnumber": 3380811097602,
"skuid": 33900201,
"availableonline": true,
"onlineinventory": 563,
"ordermethod": "POOL",
"maxorderqty": 0,
"colorway_id": 1,
"image": [
{
"imagetype": "COLORWAY",
"id": 1,
"colornormal": "None",
"color": "None"
}
],
"attribute": [
{
"name": "TYPE",
"values": [
{
"value": "Super Restorative Night "
}
]
},
{
"name": "COLOR",
"values": [
{
"value": "None"
}
]
},
{
"name": "DISCOUNTABLE",
"values": [
{
"value": "Y"
}
]
},
{
"name": "TYPE",
"values": [
{
"value": "Super Restorative Night "
}
]
}
],
"upcavailabilitymessage": "In Stock: Usually ships within 2 business days.",
"surchargeFee": 0,
"backorderable": false
},
{
"upcnumber": 3380810055627,
"skuid": 33900202,
"availableonline": true,
"onlineinventory": 1180,
"ordermethod": "POOL",
"maxorderqty": 0,
"colorway_id": 1,
"image": [
{
"imagetype": "COLORWAY",
"id": 1,
"colornormal": "None",
"color": "None"
}
],
"attribute": [
{
"name": "TYPE",
"values": [
{
"value": "One-Step Cleanser (3.4 fl oz)"
}
]
},
{
"name": "COLOR",
"values": [
{
"value": "None"
}
]
},
{
"name": "DISCOUNTABLE",
"values": [
{
"value": "Y"
}
]
},
{
"name": "TYPE",
"values": [
{
"value": "One-Step Cleanser (3.4 fl oz)"
}
]
}
],
"upcavailabilitymessage": "In Stock: Usually ships within 2 business days.",
"surchargeFee": 0,
"backorderable": false
},
{
"upcnumber": 3380811066615,
"skuid": 33900203,
"availableonline": true,
"onlineinventory": 983,
"ordermethod": "POOL",
"maxorderqty": 0,
"colorway_id": 1,
"image": [
{
"imagetype": "COLORWAY",
"id": 1,
"colornormal": "None",
"color": "None"
}
],
"attribute": [
{
"name": "TYPE",
"values": [
{
"value": "Extra-Firming Night Cream All Skin Types"
}
]
},
{
"name": "COLOR",
"values": [
{
"value": "None"
}
]
},
{
"name": "DISCOUNTABLE",
"values": [
{
"value": "Y"
}
]
},
{
"name": "TYPE",
"values": [
{
"value": "Extra-Firming Night Cream All Skin Types"
}
]
}
],
"upcavailabilitymessage": "In Stock: Usually ships within 2 business days.",
"surchargeFee": 0,
"backorderable": false
},
{
"upcnumber": 3380811240619,
"skuid": 33900204,
"availableonline": true,
"onlineinventory": 885,
"ordermethod": "POOL",
"maxorderqty": 0,
"colorway_id": 1,
"image": [
{
"imagetype": "COLORWAY",
"id": 1,
"colornormal": "None",
"color": "None"
}
],
"attribute": [
{
"name": "TYPE",
"values": [
{
"value": "Gentle Foaming Cleanser with Cottonseed"
}
]
},
{
"name": "COLOR",
"values": [
{
"value": "None"
}
]
},
{
"name": "DISCOUNTABLE",
"values": [
{
"value": "Y"
}
]
},
{
"name": "TYPE",
"values": [
{
"value": "Gentle Foaming Cleanser with Cottonseed"
}
]
}
],
"upcavailabilitymessage": "In Stock: Usually ships within 2 business days.",
"surchargeFee": 0,
"backorderable": false
},
{
"upcnumber": 3380811105604,
"skuid": 33900205,
"availableonline": true,
"onlineinventory": 728,
"ordermethod": "POOL",
"maxorderqty": 0,
"colorway_id": 1,
"image": [
{
"imagetype": "COLORWAY",
"id": 1,
"colornormal": "None",
"color": "None"
}
],
"attribute": [
{
"name": "TYPE",
"values": [
{
"value": "Multi-Active Night Cream All Skin Types"
}
]
},
{
"name": "COLOR",
"values": [
{
"value": "None"
}
]
},
{
"name": "DISCOUNTABLE",
"values": [
{
"value": "Y"
}
]
},
{
"name": "TYPE",
"values": [
{
"value": "Multi-Active Night Cream All Skin Types"
}
]
}
],
"upcavailabilitymessage": "In Stock: Usually ships within 2 business days.",
"surchargeFee": 0,
"backorderable": false
},
{
"upcnumber": 3380811136615,
"skuid": 33900206,
"availableonline": true,
"onlineinventory": 592,
"ordermethod": "POOL",
"maxorderqty": 300,
"colorway_id": 1,
"image": [
{
"imagetype": "COLORWAY",
"id": 1,
"colornormal": "None",
"color": "None"
}
],
"attribute": [
{
"name": "TYPE",
"values": [
{
"value": "HydraQuench Cream-Mask"
}
]
},
{
"name": "COLOR",
"values": [
{
"value": "None"
}
]
},
{
"name": "DISCOUNTABLE",
"values": [
{
"value": "Y"
}
]
},
{
"name": "TYPE",
"values": [
{
"value": "HydraQuench Cream-Mask"
}
]
}
],
"upcavailabilitymessage": "In Stock: Usually ships within 2 business days.",
"surchargeFee": 0,
"backorderable": false
}
],
"colorMap": [
{
"imagetype": "COLORWAY",
"id": 1,
"colornormal": "None",
"color": "None"
}
]
}
]
}
4. Update the Shopping Bag with the UPC ID you have chosen:
NOTE: The "skuid" is also known as the "upcid".
In this example below we are going to select from two FREE Deluxe samples from upcid: 17726432.
Request URL:
PATCH
http://api.macys.com/v3/shoppingbag/6b2ebfdd-28cd-42c8-9873-6b7855cb06d5/items?gwpIndicator=true
Header:
X-Macys-Webservice-Client-Id: xmj9js4jkdpe1983fmwu98gh
Accept: application/json
Content-type: application/json
Request Body
{
"item": {
"promotionId": 19845962,
"quantity": "1",
"sequenceNumber": 2,
"upcId": "17726432"
}
}
Response
{
"bag": {
"bagId": 431149999,
"bagGUID": "6b2ebfdd-28cd-42c8-9873-6b7855cb06d5",
"storeLocationNumber": 0,
"owner": {
"userId": 9518084697,
"bccUser": false,
"userRegistryId": 0
},
"shippingSummary": {
"discount": 9.95,
"method": "G",
"standardCharges": 0,
"standardChargesBeforeDicsount": 9.95,
"surcharges": 0,
"total": 0
},
"bagSummary": {
"estimatedTax": 5.22,
"itemCount": 4,
"grandTotal": 92.22,
"merchandiseTotal": 87,
"totalPersonalizationFee": 0,
"totalSaved": 6,
"yaqAmount": 0
},
"promotions": [
{
"desc": "Free Shipping with any $50 Beauty purchase! ",
"originalPrice": 9.95,
"promotionId": 19848072,
"scope": "ORDER",
"target": "SHIPPING",
"type": "Free Shipping",
"amountDiscounted": 9.95,
"adjustedCost": 0,
"operationDesc": "Free Shipping with any $50 Beauty purchase! ",
"expirationDate": "2020-01-01 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": 87,
"mergeRequiredFlag": false,
"originalPrice": 87,
"personalizationFee": 0,
"pickupRegistryApplicable": true,
"pickUpFromStore": false,
"promotionId": 0,
"wishListId": 0,
"quantity": 1,
"retailPrice": 87,
"sequenceNumber": 1,
"siteAvailablilityFlag": true,
"surcharges": 0,
"productId": 207399,
"upcId": 31705412,
"upcNumber": "3380811086101",
"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": 19845962,
"wishListId": 0,
"promotions": [
{
"desc": "Free Clarins products with your $70 Clarins purchase",
"originalPrice": 2,
"promotionId": 19845962,
"scope": "ORDER",
"target": "SUBTOTAL",
"type": "Threshold GWP",
"amountDiscounted": 2,
"adjustedCost": 0,
"operationDesc": "Free Clarins products with your $70 Clarins purchase",
"expirationDate": "2015-03-01 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": 1887893,
"upcId": 17726432,
"upcNumber": "3380810051629",
"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": 19845963,
"wishListId": 0,
"promotions": [
{
"desc": "Free Clarins products with your $70 Clarins purchase",
"originalPrice": 2,
"promotionId": 19845963,
"scope": "ORDER",
"target": "SUBTOTAL",
"type": "Threshold GWP",
"amountDiscounted": 2,
"adjustedCost": 0,
"operationDesc": "Free Clarins products with your $70 Clarins purchase",
"expirationDate": "2015-03-01 23.59.59.000",
"itemSequenceNumber": 3,
"requiredBCCCard": false,
"loyaltyAddSavings": false,
"loyaltyIncreaseSavings": false,
"propCardAddSavings": false,
"propCardIncreaseSavings": false
}
],
"quantity": 1,
"retailPrice": 2,
"sequenceNumber": 3,
"siteAvailablilityFlag": true,
"surcharges": 0,
"productId": 1981890,
"upcId": 33900207,
"upcNumber": "492018101044",
"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": 19847321,
"wishListId": 0,
"promotions": [
{
"desc": "Free Cosmetics Bag with $75 online Beauty purchase",
"originalPrice": 2,
"promotionId": 19847321,
"scope": "ORDER",
"target": "SUBTOTAL",
"type": "Bundled GWP",
"amountDiscounted": 2,
"adjustedCost": 0,
"operationDesc": "Free Cosmetics Bag with $75 online Beauty purchase",
"expirationDate": "2015-03-01 23.59.59.000",
"itemSequenceNumber": 4,
"requiredBCCCard": false,
"loyaltyAddSavings": false,
"loyaltyIncreaseSavings": false,
"propCardAddSavings": false,
"propCardIncreaseSavings": false
}
],
"quantity": 1,
"retailPrice": 2,
"sequenceNumber": 4,
"siteAvailablilityFlag": true,
"surcharges": 0,
"productId": 1859357,
"upcId": 33925687,
"upcNumber": "853532005865",
"uycTotalDiscountedPrice": 0,
"uycDiscountedPercentage": 0,
"uycPercentDiscount": 0
}
],
"promotionOffers": [],
"uycApplicable": false
}
}
5. Retrieve Bag to ensure the choice has been updated:
Request URL:
GET
https://api.macys.com/order/v1/bags?userGuid=c4820831-2654-4fd6-8bc7-b9d95f799265
Header:
X-Macys-Webservice-Client-Id: xmj9js4jkdpe1983fmwu98gh
Accept: application/json
Response
{
"bag": {
"bagId": 431149999,
"bagGUID": "6b2ebfdd-28cd-42c8-9873-6b7855cb06d5",
"storeLocationNumber": 0,
"owner": {
"userId": 9518084697,
"bccUser": false,
"userRegistryId": 0
},
"shippingSummary": {
"discount": 9.95,
"method": "G",
"standardCharges": 0,
"standardChargesBeforeDicsount": 9.95,
"surcharges": 0,
"total": 0
},
"bagSummary": {
"estimatedTax": 5.22,
"itemCount": 4,
"grandTotal": 92.22,
"merchandiseTotal": 87,
"totalPersonalizationFee": 0,
"totalSaved": 6,
"yaqAmount": 0
},
"promotions": [
{
"desc": "Free Shipping with any $50 Beauty purchase! ",
"originalPrice": 9.95,
"promotionId": 19848072,
"scope": "ORDER",
"target": "SHIPPING",
"type": "Free Shipping",
"amountDiscounted": 9.95,
"adjustedCost": 0,
"operationDesc": "Free Shipping with any $50 Beauty purchase! ",
"expirationDate": "2020-01-01 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": 87,
"mergeRequiredFlag": false,
"originalPrice": 87,
"personalizationFee": 0,
"pickupRegistryApplicable": true,
"pickUpFromStore": false,
"promotionId": 0,
"wishListId": 0,
"quantity": 1,
"retailPrice": 87,
"sequenceNumber": 1,
"siteAvailablilityFlag": true,
"surcharges": 0,
"productId": 207399,
"upcId": 31705412,
"upcNumber": "3380811086101",
"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": 19845962,
"wishListId": 0,
"promotions": [
{
"desc": "Free Clarins products with your $70 Clarins purchase",
"originalPrice": 2,
"promotionId": 19845962,
"scope": "ORDER",
"target": "SUBTOTAL",
"type": "Threshold GWP",
"amountDiscounted": 2,
"adjustedCost": 0,
"operationDesc": "Free Clarins products with your $70 Clarins purchase",
"expirationDate": "2015-03-01 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": 1887893,
"upcId": 17726432,
"upcNumber": "3380810051629",
"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": 19845963,
"wishListId": 0,
"promotions": [
{
"desc": "Free Clarins products with your $70 Clarins purchase",
"originalPrice": 2,
"promotionId": 19845963,
"scope": "ORDER",
"target": "SUBTOTAL",
"type": "Threshold GWP",
"amountDiscounted": 2,
"adjustedCost": 0,
"operationDesc": "Free Clarins products with your $70 Clarins purchase",
"expirationDate": "2015-03-01 23.59.59.000",
"itemSequenceNumber": 3,
"requiredBCCCard": false,
"loyaltyAddSavings": false,
"loyaltyIncreaseSavings": false,
"propCardAddSavings": false,
"propCardIncreaseSavings": false
}
],
"quantity": 1,
"retailPrice": 2,
"sequenceNumber": 3,
"siteAvailablilityFlag": true,
"surcharges": 0,
"productId": 1981890,
"upcId": 33900207,
"upcNumber": "492018101044",
"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": 19847321,
"wishListId": 0,
"promotions": [
{
"desc": "Free Cosmetics Bag with $75 online Beauty purchase",
"originalPrice": 2,
"promotionId": 19847321,
"scope": "ORDER",
"target": "SUBTOTAL",
"type": "Bundled GWP",
"amountDiscounted": 2,
"adjustedCost": 0,
"operationDesc": "Free Cosmetics Bag with $75 online Beauty purchase",
"expirationDate": "2015-03-01 23.59.59.000",
"itemSequenceNumber": 4,
"requiredBCCCard": false,
"loyaltyAddSavings": false,
"loyaltyIncreaseSavings": false,
"propCardAddSavings": false,
"propCardIncreaseSavings": false
}
],
"quantity": 1,
"retailPrice": 2,
"sequenceNumber": 4,
"siteAvailablilityFlag": true,
"surcharges": 0,
"productId": 1859357,
"upcId": 33925687,
"upcNumber": "853532005865",
"uycTotalDiscountedPrice": 0,
"uycDiscountedPercentage": 0,
"uycPercentDiscount": 0
}
],
"promotionOffers": [],
"uycApplicable": false
}
}
Docs Navigation
- Overview
- Customer Services
- Common API Characteristics
- Ad Media
- Catalog Services
- Order Services
- Mobile Utilities
- Promotion and Coupon Services
- Registry Services
- Review Services
- Store Services
- User Services
- Error Handling
- Deprecated Services
- Macy's API FAQ
- BOPS Stores
- What's New