Initiate Checkout

Description
Request URL
Path and Query Parameters
Sample Requests and Responses
Error Codes

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.macys.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	Yes, if userId left blank	103470151
userId	This userId must be a guest userId, not a registered userId	Yes, if bagId left blank	2158067016
storeLocationNumber	This identifier is required for BOPS calls	Yes, for BOPS calls	5041

Sample Requests and Responses

Request URL:

POST

 https://api.macys.com/order/v1/checkout/initiate

Sample Header:

x-macys-webservice-client-id: xmj9js4jkdpe1983fmwu98gh

x-macys-clientId: client_id

Accept: application/json

Content-Type: application/json

Request Body(Payload)

{
  "order": { "userId": "9523624313" }
}

Sample Response

{
    "order": {
        "bagId": 431219099,
        "baseShippingFee": 0,
        "context": {
            "type": 0
        },
        "guid": "6cecaf61-5df5-45d2-bb8d-c0d4586ea3d6",
        "merchandiseTotal": 339.98,
        "number": "1101690547",
        "reservationNumber": 0,
        "shipments": [
            {
                "deliveryOptions": [
                    {
                        "availableFlag": true,
                        "description": "Standard",
                        "minEstimatedDeliveryDay": 3,
                        "maxEstimatedDeliveryDay": 6,
                        "minEstimatedDeliveryDate": "2015-03-04T05:00:00.000+0000",
                        "maxEstimatedDeliveryDate": "2015-03-09T04:00:00.000+0000",
                        "price": 0,
                        "sequenceNumber": 1,
                        "type": "G",
                        "upChargeFee": 0,
                        "estimatedDelivery": "3-6 business days"
                    },
                    {
                        "availableFlag": true,
                        "description": "Premium",
                        "minEstimatedDeliveryDay": 2,
                        "maxEstimatedDeliveryDay": 3,
                        "minEstimatedDeliveryDate": "2015-03-03T05:00:00.000+0000",
                        "maxEstimatedDeliveryDate": "2015-03-04T05:00:00.000+0000",
                        "price": 10,
                        "sequenceNumber": 2,
                        "type": "2",
                        "upChargeFee": 10,
                        "estimatedDelivery": "2-3 business days"
                    },
                    {
                        "availableFlag": true,
                        "description": "Express",
                        "minEstimatedDeliveryDay": 1,
                        "maxEstimatedDeliveryDay": 2,
                        "minEstimatedDeliveryDate": "2015-03-02T05:00:00.000+0000",
                        "maxEstimatedDeliveryDate": "2015-03-03T05:00:00.000+0000",
                        "price": 20,
                        "sequenceNumber": 3,
                        "type": "O",
                        "upChargeFee": 20,
                        "estimatedDelivery": "1-2 business days"
                    },
                    {
                        "availableFlag": false,
                        "description": "Same-Day Delivery",
                        "minEstimatedDeliveryDay": 1,
                        "maxEstimatedDeliveryDay": 1,
                        "minEstimatedDeliveryDate": "2015-03-02T05:00:00.000+0000",
                        "maxEstimatedDeliveryDate": "2015-03-02T05:00:00.000+0000",
                        "price": 5,
                        "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": 189.99,
                        "originalPrice": 189.99,
                        "personalizationFee": 0,
                        "productId": 439074,
                        "promotionId": 0,
                        "pwpFlag": false,
                        "requestedQuantity": 1,
                        "sequenceNumber": 1,
                        "surchargeFee": 0,
                        "upcId": 20097324,
                        "upcNumber": 86279024190,
                        "wishListId": 0,
                        "uycTotalDiscountedPrice": 0,
                        "uycDiscountedPercentage": 0,
                        "uycPercentDiscount": 0
                    },
                    {
                        "adjustedQuantity": 0,
                        "giftCardAmount": 0,
                        "giftMessageFlag": true,
                        "giftWrapFlag": true,
                        "gwpFlag": false,
                        "itemTotal": 149.99,
                        "originalPrice": 149.99,
                        "personalizationFee": 0,
                        "productId": 294790,
                        "promotionId": 0,
                        "pwpFlag": false,
                        "requestedQuantity": 1,
                        "sequenceNumber": 2,
                        "surchargeFee": 0,
                        "upcId": 1205976,
                        "upcNumber": 86279021915,
                        "wishListId": 0,
                        "uycTotalDiscountedPrice": 0,
                        "uycDiscountedPercentage": 0,
                        "uycPercentDiscount": 0
                    }
                ],
                "shipmentTaxDetail": {
                    "giftWrapTax": 0
                },
                "shippingFee": 0,
                "shipToRegistry": false,
                "storeLocationNumber": 0,
                "surchargeFee": 0,
                "totalItemCount": 2,
                "total": 0
            }
        ],
        "shipingDiscount": 0,
        "total": 360.38,
        "totalPersonalizationFee": 0,
        "totalQuantity": 2,
        "totalShippingCharge": 0,
        "totalShippingSurchargeFee": 0,
        "totalTax": 20.4,
        "userId": 9523624313,
        "yaqfAmount": 0,
        "youSavedTotal": 0,
        "isOesEpisilonDown": false,
        "orderHasError": false
    }
}

Error Codes

Call Specific Error Codes:

None

General Error Handling Documentation:

Click Here