POST API/Promotion/PromoCode?onlineOrderId={onlineOrderId}&orderId={orderId}

This API will provide the ability to apply a list of promotion codes. The API will replace (not append) the promotion codes applied to the order Note that means that an empty list will remove all promotion codes applied.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
onlineOrderId

If this is for an online order, pass in the online order #. You would never need both the online order and the order id.

 integer

None.
orderId

If this is for a regular order, pass in the order id. You would never need both the online order and the order id.

 integer

None.

Body Parameters

This is the list of promotion codes to apply to an order

Collection of string

Request Formats

application/xml, text/xml

Sample: 
<ListOfString>
  <String>sample string 1</String>
  <String>sample string 2</String>
</ListOfString>

application/json, text/json

Sample: 
[
  "sample string 1",
  "sample string 2"
]

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'FormUrlEncodedFormatter' to write type 'List`1'.

Response Information

Resource Description

ApiResult
NameDescriptionTypeAdditional information
IsSuccessful

Whether the action was successful

 boolean

None.
MessageTranslationKey

A translation key for any message that is returned. It will be the first of the messages if more than one exists.

 string

None.
Message

Any message that needs to be conveyed related to the request. It will be the first of the messages if more than one exists.

 string

None.
Messages

Any message that needs to be conveyed related to the request.

 Collection of ApiResultMessage

None.

Response Formats

application/xml, text/xml, application/json, text/json

Sample:

Sample not available.