• Register

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.

back to top

HTTP Method and Request URL

DELETE

https://api.bloomingdales.com/order/v1/bags/{bagGuid}/items/{sequenceNumber}

back to top

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


back to top

Sample Requests and Responses

Sample Request

Request URL:

DELETE

http://api.bloomingdales.com/order/v1/bags/29da7001-d14e-42e2-bb97-8f9b1ad6bfad/items/1

Sample Header:

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

Request Body (Payload)

 

 

{
    "item": {
        "sequenceNumber": 1,
        "upcId": "2188573",
        "pickUpFromStore": "true"
    }
}

 

Sample Response

{
    "bag": {
        "bagId": 137490753,
        "storeLocationNumber": 0,
        "owner": {
            "userId": 2179662918,
            "bccUser": false,
            "userRegistryId": 0
        },
        "shippingSummary": {
            "discount": 0,
            "standardCharges": 0,
            "standardChargesBeforeDicsount": 0,
            "surcharges": 0,
            "total": 0
        },
        "bagSummary": {
            "estimatedTax": 0,
            "itemCount": 0,
            "grandTotal": 0,
            "merchandiseTotal": 0,
            "totalPersonalizationFee": 0,
            "totalSaved": 0,
            "yaqAmount": 0
        },
        "items": [],
        "uycApplicable": false
    }
}

 

back to top

Error Codes

Call Specific Error Codes:

NONE

General Error Handling Documentation:

Click Here

back to top

version 18 as of 9 years ago by Gaku Kelliher

Docs Navigation