• Register

Expire SUPC Code V3

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

    •  

    Description

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

    back to top

    HTTP Method and Request URL

    PUT

     http://api.bloomingdales.fds.com/v3/order/supc

    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
    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

     

    back to top

    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

    back to top

    Sample Requests and Responses

    Sample Request

    PUT

    http://api.bloomingdales.fds.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

    {
success: true
}

    Sample Errored Response

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

    back to top

    Error Codes

    Call Specific Error Codes:

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

    General Error Handling Documentation:

    Click Here

    back to top

    version 4 as of 9 years ago by Unknown

    Docs Navigation