Initiate Checkout
Description
This service enables users to submit their shopping bag into the checkout process as a guest user, by using either the bagId or userId.
HTTP Method and Request URL
POST
https://api.bloomingdales.com/order/v1/checkout/initiate
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 |
x-macys-clientId: | This value is unique to checkout services and can be obtained by contacting macys.com_api_support@macys.com. | Yes | client_id |
Accept | Specifies the output format. Can be application/json or application/xml. | Yes | application/json |
Content-Type | Specifies the format of body sent. Can be application/json or application/xml. | Yes |
application/json application/xml |
Request Body Parameters
Parameter | Description | Mandatory | Sample Value |
bagId | This ID is unique to the shopping cart | No | 137456342 |
userId | This userId must be a guest userId, not a registered userId |
Yes |
2180156589
|
storeLocationNumber | This identifier is required for BOPS calls | Yes, for BOPS calls | 5041 |
Sample Requests and Responses
Request URL:
POST
https://api.bloomingdales.com/order/v1/checkout/initiate
Sample Header:
Request Body(Payload)
{ "order": { "userId": "2180156589" } }
Sample Response
{ "order": { "bagId": 137456342, "baseShippingFee": 11, "context": { "subClientId": "Unknown", "type": 0 }, "guid": "bc32c219-4bfe-44c1-9b51-e9c8d4c6f108", "merchandiseTotal": 98, "number": "451687694", "reservationNumber": 0, "shipments": [ { "deliveryOptions": [ { "availableFlag": true, "description": "Standard", "minEstimatedDeliveryDay": 3, "maxEstimatedDeliveryDay": 6, "minEstimatedDeliveryDate": "2015-01-12T05:00:00.000+0000", "maxEstimatedDeliveryDate": "2015-01-15T05:00:00.000+0000", "price": 11, "sequenceNumber": 1, "type": "G", "upChargeFee": 0, "estimatedDelivery": "3-6 business days" }, { "availableFlag": false, "description": "Premium", "minEstimatedDeliveryDay": 2, "maxEstimatedDeliveryDay": 3, "minEstimatedDeliveryDate": "2015-01-09T05:00:00.000+0000", "maxEstimatedDeliveryDate": "2015-01-12T05:00:00.000+0000", "price": 18, "sequenceNumber": 2, "type": "2", "upChargeFee": 7, "estimatedDelivery": "2-3 business days" }, { "availableFlag": false, "description": "Express", "minEstimatedDeliveryDay": 1, "maxEstimatedDeliveryDay": 2, "minEstimatedDeliveryDate": "2015-01-08T05:00:00.000+0000", "maxEstimatedDeliveryDate": "2015-01-09T05:00:00.000+0000", "price": 24, "sequenceNumber": 3, "type": "O", "upChargeFee": 13, "estimatedDelivery": "1-2 business days" }, { "availableFlag": false, "description": "Same Day Delivery", "minEstimatedDeliveryDay": 1, "maxEstimatedDeliveryDay": 1, "minEstimatedDeliveryDate": "2015-01-08T05:00:00.000+0000", "maxEstimatedDeliveryDate": "2015-01-08T05:00:00.000+0000", "price": 16, "sequenceNumber": 6, "type": "S", "upChargeFee": 5, "estimatedDelivery": "0-1 business days" } ], "id": 1, "items": [ { "adjustedQuantity": 0, "giftCardAmount": 0, "giftMessageFlag": true, "giftWrapFlag": true, "gwpFlag": false, "itemTotal": 98, "originalPrice": 98, "personalizationFee": 0, "productId": 659632, "promotionId": 0, "pwpFlag": false, "requestedQuantity": 1, "sequenceNumber": 1, "surchargeFee": 0, "upcId": 1365995, "upcNumber": 796481357909, "wishListId": 0, "uycTotalDiscountedPrice": 0, "uycDiscountedPercentage": 0 } ], "shipmentTaxDetail": { "giftWrapTax": 0 }, "shippingFee": 0, "shipToRegistry": false, "storeLocationNumber": 0, "surchargeFee": 0, "totalItemCount": 1 } ], "shipingDiscount": 0, "total": 114.88, "totalPersonalizationFee": 0, "totalQuantity": 1, "totalShippingCharge": 11, "totalShippingSurchargeFee": 0, "totalTax": 5.88, "userId": 2180156589, "yaqfAmount": 0, "youSavedTotal": 0, "isOesEpisilonDown": false } }
Error Codes
Call Specific Error Codes:
None
General Error Handling Documentation:
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