Expire SUPC Code V3

Description

This service enables users expire a SUPC (Single Use Promotion Code) after a order is completed and confirmed.

PUT

 http://api.macys.com/v3/order/supc

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

Request Body Parameters

Parameter	Description	Mandatory	Sample Value
promoCode	The promoCode you want to expire	Yes, if Cookie is not provided	2150911673
orderNumber	The orderNumber given during checkout	Yes	3174
reservationId	The reservationID given at checkout	Yes	2141
Status		No	EXPIRE

Response Fields

Output Parameter	Description
sucess	Denotes sucess of call. true or false.
errorMessage	Error processing request:SUPC_USED
errorCode	Denotes type of error returned: Ex.400

PUT

http://api.macys.com/v3/order/supc

Sample Header:

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

Request Body (Payload)

{
   "promoCode": "X18GSN0HLAT2",
   "orderNumber": "21365465",
   "reservationId": "2141",
   "status": "EXPIRE"
}

Sample Response

1{
2success: true
3} 

Sample Errored Response

1{
2success: false
3errorMessage: "Error processing request:SUPC_USED"
4errorCode: 400
5}

Call Specific Error Codes:

{
success:&nbsp;false
errorMessage:&nbsp;"Error processing request:SUPC_USED"
errorCode:&nbsp;400
}

General Error Handling Documentation:

Click Here

version 2 as of 10 years ago by David Moyer