GET api/giftVoucher?code={code}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| code | string |
Required |
Body Parameters
None.
Response Information
Resource Description
GiftVoucher| Name | Description | Type | Additional information |
|---|---|---|---|
| ID | integer |
None. |
|
| Code | string |
Required Max length: 16 |
|
| FormattedCode | string |
None. |
|
| Active | boolean |
None. |
|
| CreatedDate | date |
None. |
|
| ProductID | integer |
None. |
|
| Product | Product |
None. |
|
| OriginalValue | decimal number |
None. |
|
| RemainingValue | decimal number |
None. |
|
| ExpiryDate | date |
None. |
|
| PurchasedByCustomerID | integer |
None. |
|
| PurchasedBy | Customer |
None. |
|
| CustomerID | integer |
None. |
|
| Customer | Customer |
None. |
|
| DespatchDate | date |
None. |
|
| Notes | string |
Max length: 512 |
|
| Live | boolean |
None. |
|
| IsDespatched | boolean |
None. |
|
| OrderLineVoucherID | integer |
None. |
|
| OrderLineVoucher | CustomerOrderLineVoucher |
None. |
Response Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.