Place Order

Description

This service enables users to complete their order using the /v1/guestcheckout/process reservationNumber. This will move reservation status from pending to approved. When approved status is reached your checkout is complete.

back to top

HTTP Method and Request URL

POST

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

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
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 userId must be a guest userId, not a registered userId
 Yes, if bagId left blank  2158067016
number This is the order number provided in the responce body from your /v1/guestcheckout/initiate call  Yes  6634040323988
reservationNumber This number is provided in the response body from your /v1/guestcheckout/process call Yes 121246617

 

back to top

Sample Requests and Responses

Request URL:

POST

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

Sample Header:

x-macys-webservice-client-id: xmj9js4jkdpe1983fmwu98gh
x-macys-clientId: client_id
Accept: application/json
Content-Type: application/json

 

Request Body(Payload)

 {
    "order": {
        "bagId": 103842222,
        "baseShippingFee": 9.95,
      "context": {
    "channel": "xxxx",
    "clientId": "xxxx",
    "deviceInfo": "xx",
    "ipAddress": "xxx",
    "itemOrigin": "xx",
    "storeAssociatedId": "xx",
    "storeLocationNumber": "xxx",
    "subClientId": "xxx"
  },
        "date": "2014-08-20T22:48:44.801+0000",
        "guid": "31acb75e-b05f-48ef-a7b7-abe9f680dcbf",
        "merchandiseTotal": 34.99,
        "number": "660070552",
        "reservationNumber": 121246617,
        "shipments": [
            {
                "deliveryOptions": [
                    {
                        "availableFlag": true,
                        "description": "Standard Delivery",
                        "minEstimatedDeliveryDay": 3,
                        "maxEstimatedDeliveryDay": 6,
                        "minEstimatedDeliveryDate": "2014-08-25T04:00:00.000+0000",
                        "maxEstimatedDeliveryDate": "2014-08-28T04:00:00.000+0000",
                        "price": 9.95,
                        "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-22T04:00:00.000+0000",
                        "maxEstimatedDeliveryDate": "2014-08-25T04:00:00.000+0000",
                        "price": 19.95,
                        "sequenceNumber": 2,
                        "type": "2",
                        "upChargeFee": 10,
                        "estimatedDelivery": "2-3 business days"
                    },
                    {
                        "availableFlag": true,
                        "description": "Express Overnight Delivery",
                        "minEstimatedDeliveryDay": 1,
                        "maxEstimatedDeliveryDay": 2,
                        "minEstimatedDeliveryDate": "2014-08-21T04:00:00.000+0000",
                        "maxEstimatedDeliveryDate": "2014-08-22T04:00:00.000+0000",
                        "price": 29.95,
                        "sequenceNumber": 3,
                        "type": "O",
                        "upChargeFee": 20,
                        "estimatedDelivery": "1-2 business days"
                    }
                ],
                "deliveryTaxRate": 0,
                "id": 1,
                "items": [
                    {
                        "adjustedQuantity": 1,
                        "giftCardAmount": 0,
                        "giftMessageFlag": true,
                        "giftWrapFlag": true,
                        "gwpFlag": false,
                        "itemTotal": 34.99,
                        "originalPrice": 57,
                        "personalizationFee": 0,
                        "productId": 1483,
                        "promotionId": 0,
                        "pwpFlag": false,
                        "requestedQuantity": 1,
                        "sequenceNumber": 1,
                        "surchargeFee": 0,
                        "taxRate": 8,
                        "upcId": 30418023,
                        "upcNumber": 4003666129395,
                        "wishListId": 0
                    }
                ],
                "shipmentTaxDetail": {
                    "giftWrapTax": 0
                },
                "shippingContact": {
                    "address": {
                        "addressLine1": "500 S.Karaemer Boulevard",
                        "city": "Brea",
                        "country": "USA",
                        "postalCode": "92821",
                        "state": "CA",
                        "validatedFlag": true
                    },
                    "dayPhone": "912-345-7655",
                    "firstName": "Chandra",
                    "id": -1,
                    "lastName": "shekar"
                },
                "shippingFee": 0,
                "shippingMethod": "G",
                "shipToRegistry": false,
                "storeLocationNumber": 0,
                "surchargeFee": 0,
                "totalItemCount": 1
            }
        ],
        "payment": {
            "tenders": [
                {
                    "alreadyValidate": "true",
                    "cardNumber": "371449635311004",
                    "cvv": "1004",
                    "expirationMonth": "3",
                    "expirationYear": "2099",
                    "type": "A"
                }
            ],
            "contact": {
                "address": {
                    "addressLine1": "500 S.Karaemer Boulevard",
                    "city": "Brea",
                    "state": "CA",
                    "country": "USA",
                    "postalCode": "88888",
                    "validatedFlag": "true"
                },
                "firstName": "Firstpayment",
                "lastName": "Lastpayment",
                "dayPhone": "4326365428",
                "emailAddress": "sudhakarpay@macys.com"
            }
        },
        "shipingDiscount": 0,
        "statusCode": "RPEND",
        "total": 47.74,
        "totalGiftWrapFee": 0,
        "totalPersonalizationFee": 0,
        "totalQuantity": 1,
        "totalShippingCharge": 9.95,
        "totalShippingSurchargeFee": 0,
        "totalTax": 2.8,
        "userId": 2158268284,
        "yaqfAmount": 0,
        "youSavedTotal": 22.01,
        "orderGuid": "31acb75e-b05f-48ef-a7b7-abe9f680dcbf",
        "isOesEpisilonDown": false
    }
}

Sample Response

{
  "order": {
    "bagId": 103842222,
    "baseShippingFee": 9.95,
    "context": {
      "clientId": "MCOM",
      "subClientId": "Unknown",
      "type": 0
    },
    "creditCardAmountCharged": 47.74,
    "date": "2014-08-21T22:10:36.168+0000",
    "giftCardAmountCharged": 0,
    "guid": "31acb75e-b05f-48ef-a7b7-abe9f680dcbf",
    "merchandiseTotal": 34.99,
    "number": "660070552",
    "reservationNumber": 119871863,
    "reservationStatus": "APPROVED",
    "shipments": [
      {
        "deliveryOptions": [
          {
            "availableFlag": true,
            "description": "Standard Delivery",
            "minEstimatedDeliveryDay": 3,
            "maxEstimatedDeliveryDay": 6,
            "minEstimatedDeliveryDate": "2014-08-26T04:00:00.000+0000",
            "maxEstimatedDeliveryDate": "2014-08-29T04:00:00.000+0000",
            "price": 9.95,
            "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-25T04:00:00.000+0000",
            "maxEstimatedDeliveryDate": "2014-08-26T04:00:00.000+0000",
            "price": 19.95,
            "sequenceNumber": 2,
            "type": "2",
            "upChargeFee": 10,
            "estimatedDelivery": "2-3 business days"
          },
          {
            "availableFlag": true,
            "description": "Express Overnight Delivery",
            "minEstimatedDeliveryDay": 1,
            "maxEstimatedDeliveryDay": 2,
            "minEstimatedDeliveryDate": "2014-08-22T04:00:00.000+0000",
            "maxEstimatedDeliveryDate": "2014-08-25T04:00:00.000+0000",
            "price": 29.95,
            "sequenceNumber": 3,
            "type": "O",
            "upChargeFee": 20,
            "estimatedDelivery": "1-2 business days"
          },
          {
            "availableFlag": false,
            "description": "Same-Day Delivery",
            "minEstimatedDeliveryDay": 1,
            "maxEstimatedDeliveryDay": 1,
            "minEstimatedDeliveryDate": "2014-08-22T04:00:00.000+0000",
            "maxEstimatedDeliveryDate": "2014-08-22T04:00:00.000+0000",
            "price": 14.95,
            "sequenceNumber": 6,
            "type": "S",
            "upChargeFee": 5,
            "estimatedDelivery": "0-1 business days"
          }
        ],
        "deliveryTaxRate": 0,
        "id": 7549019,
        "items": [
          {
            "adjustedQuantity": 1,
            "giftCardAmount": 0,
            "giftMessageFlag": true,
            "giftWrapFlag": true,
            "gwpFlag": false,
            "itemTotal": 34.99,
            "originalPrice": 57,
            "personalizationFee": 0,
            "productId": 1483,
            "promotionId": 0,
            "pwpFlag": false,
            "requestedQuantity": 1,
            "sequenceNumber": 1,
            "surchargeFee": 0,
            "taxRate": 8,
            "upcId": 30418023,
            "upcNumber": 4003666129395,
            "wishListId": 0
          }
        ],
        "shipmentTaxDetail": {
          "giftWrapTax": 0
        },
        "shippingContact": {
          "address": {
            "addressLine1": "500 S.Karaemer Boulevard",
            "city": "Brea",
            "country": "USA",
            "postalCode": "92821",
            "state": "CA",
            "validatedFlag": true
          },
          "dayPhone": "912-345-7655",
          "firstName": "Chandra",
          "id": 10644543,
          "lastName": "shekar"
        },
        "shippingFee": 0,
        "shippingMethod": "G",
        "shipToRegistry": false,
        "storeLocationNumber": 0,
        "surchargeFee": 0,
        "totalItemCount": 1
      }
    ],
    "shipingDiscount": 0,
    "statusCode": "RCMPL",
    "total": 47.74,
    "totalGiftWrapFee": 0,
    "totalPersonalizationFee": 0,
    "totalQuantity": 1,
    "totalShippingCharge": 9.95,
    "totalShippingSurchargeFee": 0,
    "totalTax": 2.8,
    "userId": 2158268284,
    "yaqfAmount": 0,
    "youSavedTotal": 22.01,
    "payment": {
      "tenders": [
        {
          "amountCharged": 47.74,
          "alreadyValidate": true,
          "cardId": 9855407,
          "cardNumber": "371449635311004",
          "cvv": "1004",
          "expirationMonth": 3,
          "expirationYear": 2099,
          "sequenceNumber": 0,
          "status": "ACCEPTED",
          "type": "A"
        }
      ],
      "contact": {
        "address": {
          "addressLine1": "500 S.Karaemer Boulevard",
          "city": "Brea",
          "country": "USA",
          "postalCode": "88888",
          "state": "CA",
          "validatedFlag": true
        },
        "dayPhone": "4326365428",
        "emailAddress": "sudhakarpay@macys.com",
        "firstName": "Firstpayment",
        "id": 10644542,
        "lastName": "Lastpayment"
      }
    },
    "orderGuid": "31acb75e-b05f-48ef-a7b7-abe9f680dcbf",
    "isOesEpisilonDown": false
  }
}

back to top

Error Codes

Call Specific Error Codes:

None

General Error Handling Documentation:

Click Here

back to top

Docs Navigation