POST GiftCard/Withdraw
Request Information
URI Parameters
None.
Body Parameters
VoucherCartRedemption| Name | Description | Type | Additional information |
|---|---|---|---|
| id | string |
None. |
|
| _object | string |
None. |
|
| name | string |
None. |
|
| created_at | string |
None. |
|
| sales_page_id | integer |
None. |
|
| data | Data |
None. |
Request Formats
application/json, text/json
Sample:
{
"id": "sample string 1",
"_object": "sample string 2",
"name": "sample string 3",
"created_at": "sample string 4",
"sales_page_id": 5,
"data": {
"id": 1,
"name": "sample string 2",
"_object": "sample string 3",
"voucher_id": 4,
"voucher_version": 5,
"option_id": 6,
"layout_id": 7,
"format": "sample string 8",
"message": "sample string 9",
"hide_price": true,
"delivery_method": "sample string 11",
"price_paid_calculator": "sample string 12",
"internal_note": {},
"regular_price": {
"amount": 1,
"currency": "sample string 2"
},
"price_paid": {
"amount": 1,
"currency": "sample string 2"
},
"voucher_from": "sample string 14",
"voucher_to": "sample string 15",
"is_multiuse": true,
"is_monetary": true,
"redeemable_from": "2025-12-08T13:37:24.5216599+00:00",
"redeemable_to": "2025-12-08T13:37:24.5216599+00:00",
"redeem_stock": 20,
"redeem_used": 21,
"redeem_remaining": 22,
"price_on_voucher": "sample string 23",
"redeemable_everywhere": true,
"redeemable_on_redeem_locations": [
1,
2
],
"delivery_date": "2025-12-08T13:37:24.5216599+00:00",
"hand_delivery": true,
"voucher_type": "sample string 27",
"order_voucher_id": 28,
"status": "sample string 29",
"representation_type": "sample string 30",
"description": "sample string 31",
"terms": "sample string 32",
"isMessageOff": true,
"reference": "sample string 34",
"stock_card_id": 35,
"delivery_status": "sample string 36",
"recipient": {
"name": "sample string 1",
"email": "sample string 2"
},
"redemption": {
"id": 1,
"_object": "sample string 2",
"redeem_location": 3,
"order_product": 4,
"reductor": {},
"created_at": "2025-12-08T13:37:24.5216599+00:00"
}
}
}
application/xml, text/xml
Sample:
<VoucherCartRedemption xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VoucherCartWebhook.Models">
<_object>sample string 2</_object>
<created_at>sample string 4</created_at>
<data>
<_object>sample string 3</_object>
<delivery_date>2025-12-08T13:37:24.5216599+00:00</delivery_date>
<delivery_method>sample string 11</delivery_method>
<delivery_status>sample string 36</delivery_status>
<description>sample string 31</description>
<format>sample string 8</format>
<hand_delivery>true</hand_delivery>
<hide_price>true</hide_price>
<id>1</id>
<internal_note />
<isMessageOff>true</isMessageOff>
<is_monetary>true</is_monetary>
<is_multiuse>true</is_multiuse>
<layout_id>7</layout_id>
<message>sample string 9</message>
<name>sample string 2</name>
<option_id>6</option_id>
<order_voucher_id>28</order_voucher_id>
<price_on_voucher>sample string 23</price_on_voucher>
<price_paid>
<amount>1</amount>
<currency>sample string 2</currency>
</price_paid>
<price_paid_calculator>sample string 12</price_paid_calculator>
<recipient>
<email>sample string 2</email>
<name>sample string 1</name>
</recipient>
<redeem_remaining>22</redeem_remaining>
<redeem_stock>20</redeem_stock>
<redeem_used>21</redeem_used>
<redeemable_everywhere>true</redeemable_everywhere>
<redeemable_from>2025-12-08T13:37:24.5216599+00:00</redeemable_from>
<redeemable_on_redeem_locations xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:int>1</d3p1:int>
<d3p1:int>2</d3p1:int>
</redeemable_on_redeem_locations>
<redeemable_to>2025-12-08T13:37:24.5216599+00:00</redeemable_to>
<redemption>
<_object>sample string 2</_object>
<created_at>2025-12-08T13:37:24.5216599+00:00</created_at>
<id>1</id>
<order_product>4</order_product>
<redeem_location>3</redeem_location>
<reductor />
</redemption>
<reference>sample string 34</reference>
<regular_price>
<amount>1</amount>
<currency>sample string 2</currency>
</regular_price>
<representation_type>sample string 30</representation_type>
<status>sample string 29</status>
<stock_card_id>35</stock_card_id>
<terms>sample string 32</terms>
<voucher_from>sample string 14</voucher_from>
<voucher_id>4</voucher_id>
<voucher_to>sample string 15</voucher_to>
<voucher_type>sample string 27</voucher_type>
<voucher_version>5</voucher_version>
</data>
<id>sample string 1</id>
<name>sample string 3</name>
<sales_page_id>5</sales_page_id>
</VoucherCartRedemption>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.