Documentation for POST api/order/Payment/GiftCertificate/Save

POST api/order/Payment/GiftCertificate/Save

Applies a gift certificate to a party order.

Request Information

URI Parameters

None.

Body Parameters

The gift certificate details to apply

Name	Type	Additional information
OrderID	integer	Required
PartyID	integer	None.
GiftCertificateDID	string	Required
Amount	decimal number	Required

Request Formats

application/xml, text/xml

Sample:

<GiftCertificatePaymentViewModel>
  <OrderID>1</OrderID>
  <PartyID>1</PartyID>
  <GiftCertificateDID>sample string 2</GiftCertificateDID>
  <Amount>3</Amount>
</GiftCertificatePaymentViewModel>

application/json, text/json

Sample:

{
  "OrderID": 1,
  "PartyID": 1,
  "GiftCertificateDID": "sample string 2",
  "Amount": 3.0
}

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 'GiftCertificatePaymentViewModel'.

Response Information

Resource Description

ApiResultOfPaymentViewModel

Name	Type	Additional information
Result	PaymentViewModel	None.
IsSuccessful	boolean	None.
MessageTranslationKey	string	None.
Message	string	None.
Messages	Collection of ApiResultMessage	None.

Response Formats

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

Sample:

Sample not available.