Delete Item
Description
This service enables users remove items that are already added to a shopping bag. It enables users remove one item with each request.
HTTP Method and Request URL
DELETE
https://api.macys.com/order/v1/bags/{bagGuid}/items/{sequenceNumber}
HTTP, Path and Query Parameters
HTTP Header Parameters
| Parameter | Description | Mandatory | Sample Value |
| x-macys-webservice-client-id | Pass the apikey as a header value which is called x-macys-webservice-client-id. The api key is the 24 character alphanumeric string assigned to your application when you registered it. Click here for a list of your API keys. | Yes | xmj9js4jkdpe1983fmwu98gh |
| Accept | Specifies the output format. Can be application/json or application/xml. | Yes |
application/json application/xml |
| Content-type | Specifies the format of body sent. Can be application/json or application/xml. | Yes |
application/json application/xml |
| Cookie | The cookie macys_online_uid needs to be set with the user id of the macys.com customer. | Yes, if guest userid parameter not specified |
macys_online_uid=user_id (macys.com) |
Path Parameters
| Parameter | Description | Mandatory | Sample Value |
| bagGuid | When present in the cookie or stored in cache from add to bag | Yes | cdfb23bc-8afe-4210-aaf2-69b55f1540da |
| sequenceNumber | Bag Item sequence number – from retrieve bag | Yes | 22 |
Query Parameters
| Parameter | Description | Mandatory | Sample Value |
| promocode | Promotion code to be applied on the item/bag should be cached in the app when entered & used when GET shoppingbag is invoked | No | SHADES |
| bagOptions | A list of bag options strings to get more data about bag example: "bagOptions=INCLUDE_SAVED_BAG" |
No | INCLUDE_SAVED_BAG INCLUDE_PRODUCTINFO |
| storeLocNumber | The location number of the store you would like to see product availability for. | No | 73 |
| cardType | Certain promotions or offers are returned depending on the Credit Card type that will be used. Click here to get the full list. | No | Y |
| registryId | This is used if you are adding an item to your bag that belongs to a registry. Registry options will be provided if this ID is provided. | No | 2055190 |
| gwpIndicator | Indicator that defines whether or not the item is a GWP (Gift with Purchase) or not | No | true |
| channelType | This is the channel of the application calling the service. Currently Mobile is the only valid channel. | No | Mobile |
Request Body Parameters
| Parameter | Description | Mandatory | Sample Value |
| userid | guest user id | Yes, if no Cookie provided |
2150911673 |
| upcid | UPC ID that identifies the item | Yes |
3174 |
| storeLocationNumber | stores unique location number (for BOPS orders) | Yes (for BOPS orders only) | 2530 |
| showBag |
Show contents of bag | Yes (for BOPS orders only) | True |
Response Fields
|
Output Parameter |
Description |
|
Registered |
Flag to denote if user is registered |
|
userid |
user id number |
|
success |
Flag to denote operation status |
Sample Requests and Responses
Sample Request
Request URL:
DELETE
http://api.macys.com/order/v1/bags/8709998e-a5ca-445f-af57-5c2c102ddbef/items/1
Sample Header:
X-Macys-Webservice-Client-Id: xmj9js4jkdpe1983fmwu98gh
Accept: application/json
Content-type: application/json
Request Body (Payload)
{
"item": {
"upcId": "32525889",
}
}
Sample Response
01 | { |
02 | "bag": { |
03 | "bagId": 431351478, |
04 | "storeLocationNumber": 0, |
05 | "owner": { |
06 | "userId": 9518755051, |
07 | "bccUser": false, |
08 | "userRegistryId": 0 |
09 | }, |
10 | "shippingSummary": { |
11 | "discount": 0, |
12 | "standardCharges": 0, |
13 | "standardChargesBeforeDicsount": 0, |
14 | "surcharges": 0, |
15 | "total": 0 |
16 | }, |
17 | "bagSummary": { |
18 | "estimatedTax": 0, |
19 | "itemCount": 0, |
20 | "grandTotal": 0, |
21 | "merchandiseTotal": 0, |
22 | "totalPersonalizationFee": 0, |
23 | "totalSaved": 0, |
24 | "yaqAmount": 0 |
25 | }, |
26 | "items": [], |
27 | "uycApplicable": false |
28 | } |
29 | } |
Error Codes
Call Specific Error Codes:
NONE
General Error Handling Documentation: