Initiate Checkout

Description

This service enables authenticated users to submit their shopping bag into the checkout process by using either the bagId or userId.

Note: You must use your Protected Services Key to get a Bearer token before making this call.  Please click on the following link for more details: OAuth Flows.

back to top

HTTP Method and Request URL

POST

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

back to top

HTTP, Path and Query Parameters

HTTP Header Parameters

Parameter Description Mandatory Sample Value
Authorization Bearer token provided by OAuth call, please see description note above. Yes Bearer w8umyzewv6574ak7k8y9wrt3
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

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 registered userId
 Yes, if bagId left blank 2158067016
storeLocationNumber This identifier is required for BOPS calls  Yes, for BOPS calls 5041

back to top

Sample Requests and Responses

Request URL:

POST

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

Sample Header:

Authorization: Bearer w8umyzewv6574ak7k8y9wrt3
x-macys-clientId: client_id
Accept: application/json
Content-Type: application/json

 

Request Body(Payload)

{
  "order": { "userId": "2158067016" }
}

 

Sample Response

{
    "order": {
        "bagId": 103470151,
        "baseShippingFee": 0,
        "guid": "1092dab2-ff5e-4a16-87b6-6a40709cea5f",
        "merchandiseTotal": 116,
        "number": "6066988899999",
        "promotions": [
            {
                "adjustedCost": 0,
                "amountDiscounted": 2,
                "description": "Free gift with your $65 fragrance purchase",
                "id": 19828648,
                "operationDescription": "Free gift with your $65 fragrance purchase",
                "originalCost": 2,
                "scope": "ORDER",
                "target": "SUBTOTAL",
                "type": "Threshold GWP"
            },
            {
                "adjustedCost": 0,
                "amountDiscounted": 2,
                "description": "Free gift with your qualifying $65 fragrance purchase",
                "id": 19828649,
                "operationDescription": "Free gift with your qualifying $65 fragrance purchase",
                "originalCost": 2,
                "scope": "ORDER",
                "target": "SUBTOTAL",
                "type": "Threshold GWP"
            },
            {
                "adjustedCost": 0,
                "amountDiscounted": 2,
                "description": "Free gift with your qualifying $65 fragrance purchase",
                "id": 19829520,
                "operationDescription": "Free gift with your qualifying $65 fragrance purchase",
                "originalCost": 2,
                "scope": "ORDER",
                "target": "SUBTOTAL",
                "type": "Threshold GWP"
            },
            {
                "adjustedCost": 0,
                "amountDiscounted": 2,
                "description": "Free gift with your $74 Calvin Klein Eternity fragrance purchase",
                "id": 19834928,
                "operationDescription": "Free gift with your $74 Calvin Klein Eternity fragrance purchase",
                "originalCost": 2,
                "scope": "ORDER",
                "target": "SUBTOTAL",
                "type": "Threshold GWP"
            },
            {
                "adjustedCost": 0,
                "amountDiscounted": 2,
                "description": "Free gift with your $75 Beauty purchase",
                "id": 19835993,
                "operationDescription": "Free gift with your $75 Beauty purchase",
                "originalCost": 2,
                "scope": "ORDER",
                "target": "SUBTOTAL",
                "type": "Threshold GWP"
            }
        ],
        "reservationNumber": 0,
        "shipments": [
            {
                "deliveryOptions": [
                    {
                        "availableFlag": true,
                        "description": "Standard Delivery",
                        "minEstimatedDeliveryDay": 3,
                        "maxEstimatedDeliveryDay": 6,
                        "minEstimatedDeliveryDate": "2014-08-12T04:00:00.000+0000",
                        "maxEstimatedDeliveryDate": "2014-08-15T04:00:00.000+0000",
                        "price": 0,
                        "sequenceNumber": 1,
                        "type": "G",
                        "upChargeFee": 0,
                        "estimatedDelivery": "3-6 business days"
                    },
                    {
                        "availableFlag": true,
                        "description": "Premium 2 Day Delivery",
                        "minEstimatedDeliveryDay": 2,
                        "maxEstimatedDeliveryDay": 3,
                        "minEstimatedDeliveryDate": "2014-08-11T04:00:00.000+0000",
                        "maxEstimatedDeliveryDate": "2014-08-12T04:00:00.000+0000",
                        "price": 10,
                        "sequenceNumber": 2,
                        "type": "2",
                        "upChargeFee": 10,
                        "estimatedDelivery": "2-3 business days"
                    },
                    {
                        "availableFlag": true,
                        "description": "Express Overnight Delivery",
                        "minEstimatedDeliveryDay": 1,
                        "maxEstimatedDeliveryDay": 2,
                        "minEstimatedDeliveryDate": "2014-08-08T04:00:00.000+0000",
                        "maxEstimatedDeliveryDate": "2014-08-11T04:00:00.000+0000",
                        "price": 20,
                        "sequenceNumber": 3,
                        "type": "O",
                        "upChargeFee": 20,
                        "estimatedDelivery": "1-2 business days"
                    }
                ],
                "id": 1,
                "items": [
                    {
                        "adjustedQuantity": 0,
                        "giftCardAmount": 0,
                        "giftMessageFlag": true,
                        "giftWrapFlag": true,
                        "gwpFlag": false,
                        "itemTotal": 20,
                        "originalPrice": 20,
                        "personalizationFee": 0,
                        "productId": 527222,
                        "promotionId": 0,
                        "pwpFlag": false,
                        "requestedQuantity": 1,
                        "sequenceNumber": 1,
                        "surchargeFee": 0,
                        "upcId": 29369451,
                        "upcNumber": 3607342184633,
                        "wishListId": 0
                    },
                    {
                        "adjustedQuantity": 0,
                        "giftCardAmount": 0,
                        "giftMessageFlag": true,
                        "giftWrapFlag": true,
                        "gwpFlag": false,
                        "itemTotal": 96,
                        "originalPrice": 96,
                        "personalizationFee": 0,
                        "productId": 679646,
                        "promotionId": 0,
                        "pwpFlag": false,
                        "requestedQuantity": 1,
                        "sequenceNumber": 2,
                        "surchargeFee": 0,
                        "upcId": 30367102,
                        "upcNumber": 3607342378353,
                        "wishListId": 0
                    },
                    {
                        "adjustedQuantity": 0,
                        "giftCardAmount": 0,
                        "giftMessageFlag": true,
                        "giftWrapFlag": true,
                        "gwpFlag": true,
                        "itemTotal": 0,
                        "originalPrice": 2,
                        "personalizationFee": 0,
                        "productId": 980907,
                        "promotionId": 19828648,
                        "pwpFlag": false,
                        "requestedQuantity": 1,
                        "sequenceNumber": 3,
                        "surchargeFee": 0,
                        "upcId": 31647343,
                        "upcNumber": 737052412672,
                        "wishListId": 0
                    },
                    {
                        "adjustedQuantity": 0,
                        "giftCardAmount": 0,
                        "giftMessageFlag": true,
                        "giftWrapFlag": true,
                        "gwpFlag": true,
                        "itemTotal": 0,
                        "originalPrice": 2,
                        "personalizationFee": 0,
                        "productId": 980898,
                        "promotionId": 19828649,
                        "pwpFlag": false,
                        "requestedQuantity": 1,
                        "sequenceNumber": 4,
                        "surchargeFee": 0,
                        "upcId": 32155756,
                        "upcNumber": 3607342221529,
                        "wishListId": 0
                    },
                    {
                        "adjustedQuantity": 0,
                        "giftCardAmount": 0,
                        "giftMessageFlag": true,
                        "giftWrapFlag": true,
                        "gwpFlag": true,
                        "itemTotal": 0,
                        "originalPrice": 2,
                        "personalizationFee": 0,
                        "productId": 980892,
                        "promotionId": 19829520,
                        "pwpFlag": false,
                        "requestedQuantity": 1,
                        "sequenceNumber": 5,
                        "surchargeFee": 0,
                        "upcId": 10273533,
                        "upcNumber": 31655509488,
                        "wishListId": 0
                    },
                    {
                        "adjustedQuantity": 0,
                        "giftCardAmount": 0,
                        "giftMessageFlag": true,
                        "giftWrapFlag": true,
                        "gwpFlag": true,
                        "itemTotal": 0,
                        "originalPrice": 2,
                        "personalizationFee": 0,
                        "productId": 1494827,
                        "promotionId": 19834928,
                        "pwpFlag": false,
                        "requestedQuantity": 1,
                        "sequenceNumber": 6,
                        "surchargeFee": 0,
                        "upcId": 32847046,
                        "upcNumber": 3614220084558,
                        "wishListId": 0
                    },
                    {
                        "adjustedQuantity": 0,
                        "giftCardAmount": 0,
                        "giftMessageFlag": true,
                        "giftWrapFlag": true,
                        "gwpFlag": true,
                        "itemTotal": 0,
                        "originalPrice": 2,
                        "personalizationFee": 0,
                        "productId": 1509158,
                        "promotionId": 19835993,
                        "pwpFlag": false,
                        "requestedQuantity": 1,
                        "sequenceNumber": 7,
                        "surchargeFee": 0,
                        "upcId": 33054540,
                        "upcNumber": 814881015998,
                        "wishListId": 0
                    }
                ],
                "shipmentTaxDetail": {
                    "giftWrapTax": 0
                },
                "shippingFee": 0,
                "shipToRegistry": false,
                "storeLocationNumber": 0,
                "surchargeFee": 0,
                "totalItemCount": 7
            }
        ],
        "shipingDiscount": 0,
        "total": 122.96,
        "totalPersonalizationFee": 0,
        "totalQuantity": 7,
        "totalShippingCharge": 0,
        "totalShippingSurchargeFee": 0,
        "totalTax": 6.96,
        "userId": 2157622991,
        "yaqfAmount": 0,
        "youSavedTotal": 10,
        "isOesEpisilonDown": false
    }
}

 

back to top

Error Codes

Call Specific Error Codes:

None

General Error Handling Documentation:

Click Here

back to top

Docs Navigation