GET api/magento/credits/{creditmemoId}
Gets a credit memo by id
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| creditmemoId |
credit memo Id |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
credit memo
SuiteBridge.MagentoWebService.salesOrderCreditmemoEntity| Name | Description | Type | Additional information |
|---|---|---|---|
| updated_at | string |
None. |
|
| created_at | string |
None. |
|
| increment_id | string |
None. |
|
| transaction_id | string |
None. |
|
| global_currency_code | string |
None. |
|
| base_currency_code | string |
None. |
|
| order_currency_code | string |
None. |
|
| store_currency_code | string |
None. |
|
| cybersource_token | string |
None. |
|
| invoice_id | string |
None. |
|
| billing_address_id | string |
None. |
|
| shipping_address_id | string |
None. |
|
| state | string |
None. |
|
| creditmemo_status | string |
None. |
|
| email_sent | string |
None. |
|
| order_id | string |
None. |
|
| tax_amount | string |
None. |
|
| shipping_tax_amount | string |
None. |
|
| base_tax_amount | string |
None. |
|
| base_adjustment_positive | string |
None. |
|
| base_grand_total | string |
None. |
|
| adjustment | string |
None. |
|
| subtotal | string |
None. |
|
| discount_amount | string |
None. |
|
| base_subtotal | string |
None. |
|
| base_adjustment | string |
None. |
|
| base_to_global_rate | string |
None. |
|
| store_to_base_rate | string |
None. |
|
| base_shipping_amount | string |
None. |
|
| adjustment_negative | string |
None. |
|
| subtotal_incl_tax | string |
None. |
|
| shipping_amount | string |
None. |
|
| base_subtotal_incl_tax | string |
None. |
|
| base_adjustment_negative | string |
None. |
|
| grand_total | string |
None. |
|
| base_discount_amount | string |
None. |
|
| base_to_order_rate | string |
None. |
|
| store_to_order_rate | string |
None. |
|
| base_shipping_tax_amount | string |
None. |
|
| adjustment_positive | string |
None. |
|
| store_id | string |
None. |
|
| hidden_tax_amount | string |
None. |
|
| base_hidden_tax_amount | string |
None. |
|
| shipping_hidden_tax_amount | string |
None. |
|
| base_shipping_hidden_tax_amnt | string |
None. |
|
| shipping_incl_tax | string |
None. |
|
| base_shipping_incl_tax | string |
None. |
|
| base_customer_balance_amount | string |
None. |
|
| customer_balance_amount | string |
None. |
|
| bs_customer_bal_total_refunded | string |
None. |
|
| customer_bal_total_refunded | string |
None. |
|
| base_gift_cards_amount | string |
None. |
|
| gift_cards_amount | string |
None. |
|
| gw_base_price | string |
None. |
|
| gw_price | string |
None. |
|
| gw_items_base_price | string |
None. |
|
| gw_items_price | string |
None. |
|
| gw_card_base_price | string |
None. |
|
| gw_card_price | string |
None. |
|
| gw_base_tax_amount | string |
None. |
|
| gw_tax_amount | string |
None. |
|
| gw_items_base_tax_amount | string |
None. |
|
| gw_items_tax_amount | string |
None. |
|
| gw_card_base_tax_amount | string |
None. |
|
| gw_card_tax_amount | string |
None. |
|
| base_reward_currency_amount | string |
None. |
|
| reward_currency_amount | string |
None. |
|
| reward_points_balance | string |
None. |
|
| reward_points_balance_refund | string |
None. |
|
| creditmemo_id | string |
None. |
|
| items | Collection of SuiteBridge.MagentoWebService.salesOrderCreditmemoItemEntity |
None. |
|
| comments | Collection of SuiteBridge.MagentoWebService.salesOrderCreditmemoCommentEntity |
None. |
Response Formats
application/json, text/json
Sample:
{
"updated_at": "sample string 1",
"created_at": "sample string 2",
"increment_id": "sample string 3",
"transaction_id": "sample string 4",
"global_currency_code": "sample string 5",
"base_currency_code": "sample string 6",
"order_currency_code": "sample string 7",
"store_currency_code": "sample string 8",
"cybersource_token": "sample string 9",
"invoice_id": "sample string 10",
"billing_address_id": "sample string 11",
"shipping_address_id": "sample string 12",
"state": "sample string 13",
"creditmemo_status": "sample string 14",
"email_sent": "sample string 15",
"order_id": "sample string 16",
"tax_amount": "sample string 17",
"shipping_tax_amount": "sample string 18",
"base_tax_amount": "sample string 19",
"base_adjustment_positive": "sample string 20",
"base_grand_total": "sample string 21",
"adjustment": "sample string 22",
"subtotal": "sample string 23",
"discount_amount": "sample string 24",
"base_subtotal": "sample string 25",
"base_adjustment": "sample string 26",
"base_to_global_rate": "sample string 27",
"store_to_base_rate": "sample string 28",
"base_shipping_amount": "sample string 29",
"adjustment_negative": "sample string 30",
"subtotal_incl_tax": "sample string 31",
"shipping_amount": "sample string 32",
"base_subtotal_incl_tax": "sample string 33",
"base_adjustment_negative": "sample string 34",
"grand_total": "sample string 35",
"base_discount_amount": "sample string 36",
"base_to_order_rate": "sample string 37",
"store_to_order_rate": "sample string 38",
"base_shipping_tax_amount": "sample string 39",
"adjustment_positive": "sample string 40",
"store_id": "sample string 41",
"hidden_tax_amount": "sample string 42",
"base_hidden_tax_amount": "sample string 43",
"shipping_hidden_tax_amount": "sample string 44",
"base_shipping_hidden_tax_amnt": "sample string 45",
"shipping_incl_tax": "sample string 46",
"base_shipping_incl_tax": "sample string 47",
"base_customer_balance_amount": "sample string 48",
"customer_balance_amount": "sample string 49",
"bs_customer_bal_total_refunded": "sample string 50",
"customer_bal_total_refunded": "sample string 51",
"base_gift_cards_amount": "sample string 52",
"gift_cards_amount": "sample string 53",
"gw_base_price": "sample string 54",
"gw_price": "sample string 55",
"gw_items_base_price": "sample string 56",
"gw_items_price": "sample string 57",
"gw_card_base_price": "sample string 58",
"gw_card_price": "sample string 59",
"gw_base_tax_amount": "sample string 60",
"gw_tax_amount": "sample string 61",
"gw_items_base_tax_amount": "sample string 62",
"gw_items_tax_amount": "sample string 63",
"gw_card_base_tax_amount": "sample string 64",
"gw_card_tax_amount": "sample string 65",
"base_reward_currency_amount": "sample string 66",
"reward_currency_amount": "sample string 67",
"reward_points_balance": "sample string 68",
"reward_points_balance_refund": "sample string 69",
"creditmemo_id": "sample string 70",
"items": [
{
"item_id": "sample string 1",
"parent_id": "sample string 2",
"weee_tax_applied_row_amount": "sample string 3",
"base_price": "sample string 4",
"base_weee_tax_row_disposition": "sample string 5",
"tax_amount": "sample string 6",
"base_weee_tax_applied_amount": "sample string 7",
"weee_tax_row_disposition": "sample string 8",
"base_row_total": "sample string 9",
"discount_amount": "sample string 10",
"row_total": "sample string 11",
"weee_tax_applied_amount": "sample string 12",
"base_discount_amount": "sample string 13",
"base_weee_tax_disposition": "sample string 14",
"price_incl_tax": "sample string 15",
"base_tax_amount": "sample string 16",
"weee_tax_disposition": "sample string 17",
"base_price_incl_tax": "sample string 18",
"qty": "sample string 19",
"base_cost": "sample string 20",
"base_weee_tax_applied_row_amount": "sample string 21",
"price": "sample string 22",
"base_row_total_incl_tax": "sample string 23",
"row_total_incl_tax": "sample string 24",
"product_id": "sample string 25",
"order_item_id": "sample string 26",
"additional_data": "sample string 27",
"description": "sample string 28",
"weee_tax_applied": "sample string 29",
"sku": "sample string 30",
"name": "sample string 31",
"hidden_tax_amount": "sample string 32",
"base_hidden_tax_amount": "sample string 33"
},
{
"item_id": "sample string 1",
"parent_id": "sample string 2",
"weee_tax_applied_row_amount": "sample string 3",
"base_price": "sample string 4",
"base_weee_tax_row_disposition": "sample string 5",
"tax_amount": "sample string 6",
"base_weee_tax_applied_amount": "sample string 7",
"weee_tax_row_disposition": "sample string 8",
"base_row_total": "sample string 9",
"discount_amount": "sample string 10",
"row_total": "sample string 11",
"weee_tax_applied_amount": "sample string 12",
"base_discount_amount": "sample string 13",
"base_weee_tax_disposition": "sample string 14",
"price_incl_tax": "sample string 15",
"base_tax_amount": "sample string 16",
"weee_tax_disposition": "sample string 17",
"base_price_incl_tax": "sample string 18",
"qty": "sample string 19",
"base_cost": "sample string 20",
"base_weee_tax_applied_row_amount": "sample string 21",
"price": "sample string 22",
"base_row_total_incl_tax": "sample string 23",
"row_total_incl_tax": "sample string 24",
"product_id": "sample string 25",
"order_item_id": "sample string 26",
"additional_data": "sample string 27",
"description": "sample string 28",
"weee_tax_applied": "sample string 29",
"sku": "sample string 30",
"name": "sample string 31",
"hidden_tax_amount": "sample string 32",
"base_hidden_tax_amount": "sample string 33"
}
],
"comments": [
{
"parent_id": "sample string 1",
"created_at": "sample string 2",
"comment": "sample string 3",
"is_customer_notified": "sample string 4",
"comment_id": "sample string 5",
"is_visible_on_front": "sample string 6"
},
{
"parent_id": "sample string 1",
"created_at": "sample string 2",
"comment": "sample string 3",
"is_customer_notified": "sample string 4",
"comment_id": "sample string 5",
"is_visible_on_front": "sample string 6"
}
]
}
application/xml, text/xml
Sample:
<salesOrderCreditmemoEntity xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<updated_at>sample string 1</updated_at>
<created_at>sample string 2</created_at>
<increment_id>sample string 3</increment_id>
<transaction_id>sample string 4</transaction_id>
<global_currency_code>sample string 5</global_currency_code>
<base_currency_code>sample string 6</base_currency_code>
<order_currency_code>sample string 7</order_currency_code>
<store_currency_code>sample string 8</store_currency_code>
<cybersource_token>sample string 9</cybersource_token>
<invoice_id>sample string 10</invoice_id>
<billing_address_id>sample string 11</billing_address_id>
<shipping_address_id>sample string 12</shipping_address_id>
<state>sample string 13</state>
<creditmemo_status>sample string 14</creditmemo_status>
<email_sent>sample string 15</email_sent>
<order_id>sample string 16</order_id>
<tax_amount>sample string 17</tax_amount>
<shipping_tax_amount>sample string 18</shipping_tax_amount>
<base_tax_amount>sample string 19</base_tax_amount>
<base_adjustment_positive>sample string 20</base_adjustment_positive>
<base_grand_total>sample string 21</base_grand_total>
<adjustment>sample string 22</adjustment>
<subtotal>sample string 23</subtotal>
<discount_amount>sample string 24</discount_amount>
<base_subtotal>sample string 25</base_subtotal>
<base_adjustment>sample string 26</base_adjustment>
<base_to_global_rate>sample string 27</base_to_global_rate>
<store_to_base_rate>sample string 28</store_to_base_rate>
<base_shipping_amount>sample string 29</base_shipping_amount>
<adjustment_negative>sample string 30</adjustment_negative>
<subtotal_incl_tax>sample string 31</subtotal_incl_tax>
<shipping_amount>sample string 32</shipping_amount>
<base_subtotal_incl_tax>sample string 33</base_subtotal_incl_tax>
<base_adjustment_negative>sample string 34</base_adjustment_negative>
<grand_total>sample string 35</grand_total>
<base_discount_amount>sample string 36</base_discount_amount>
<base_to_order_rate>sample string 37</base_to_order_rate>
<store_to_order_rate>sample string 38</store_to_order_rate>
<base_shipping_tax_amount>sample string 39</base_shipping_tax_amount>
<adjustment_positive>sample string 40</adjustment_positive>
<store_id>sample string 41</store_id>
<hidden_tax_amount>sample string 42</hidden_tax_amount>
<base_hidden_tax_amount>sample string 43</base_hidden_tax_amount>
<shipping_hidden_tax_amount>sample string 44</shipping_hidden_tax_amount>
<base_shipping_hidden_tax_amnt>sample string 45</base_shipping_hidden_tax_amnt>
<shipping_incl_tax>sample string 46</shipping_incl_tax>
<base_shipping_incl_tax>sample string 47</base_shipping_incl_tax>
<base_customer_balance_amount>sample string 48</base_customer_balance_amount>
<customer_balance_amount>sample string 49</customer_balance_amount>
<bs_customer_bal_total_refunded>sample string 50</bs_customer_bal_total_refunded>
<customer_bal_total_refunded>sample string 51</customer_bal_total_refunded>
<base_gift_cards_amount>sample string 52</base_gift_cards_amount>
<gift_cards_amount>sample string 53</gift_cards_amount>
<gw_base_price>sample string 54</gw_base_price>
<gw_price>sample string 55</gw_price>
<gw_items_base_price>sample string 56</gw_items_base_price>
<gw_items_price>sample string 57</gw_items_price>
<gw_card_base_price>sample string 58</gw_card_base_price>
<gw_card_price>sample string 59</gw_card_price>
<gw_base_tax_amount>sample string 60</gw_base_tax_amount>
<gw_tax_amount>sample string 61</gw_tax_amount>
<gw_items_base_tax_amount>sample string 62</gw_items_base_tax_amount>
<gw_items_tax_amount>sample string 63</gw_items_tax_amount>
<gw_card_base_tax_amount>sample string 64</gw_card_base_tax_amount>
<gw_card_tax_amount>sample string 65</gw_card_tax_amount>
<base_reward_currency_amount>sample string 66</base_reward_currency_amount>
<reward_currency_amount>sample string 67</reward_currency_amount>
<reward_points_balance>sample string 68</reward_points_balance>
<reward_points_balance_refund>sample string 69</reward_points_balance_refund>
<creditmemo_id>sample string 70</creditmemo_id>
<items>
<complexObjectArray>
<item_id>sample string 1</item_id>
<parent_id>sample string 2</parent_id>
<weee_tax_applied_row_amount>sample string 3</weee_tax_applied_row_amount>
<base_price>sample string 4</base_price>
<base_weee_tax_row_disposition>sample string 5</base_weee_tax_row_disposition>
<tax_amount>sample string 6</tax_amount>
<base_weee_tax_applied_amount>sample string 7</base_weee_tax_applied_amount>
<weee_tax_row_disposition>sample string 8</weee_tax_row_disposition>
<base_row_total>sample string 9</base_row_total>
<discount_amount>sample string 10</discount_amount>
<row_total>sample string 11</row_total>
<weee_tax_applied_amount>sample string 12</weee_tax_applied_amount>
<base_discount_amount>sample string 13</base_discount_amount>
<base_weee_tax_disposition>sample string 14</base_weee_tax_disposition>
<price_incl_tax>sample string 15</price_incl_tax>
<base_tax_amount>sample string 16</base_tax_amount>
<weee_tax_disposition>sample string 17</weee_tax_disposition>
<base_price_incl_tax>sample string 18</base_price_incl_tax>
<qty>sample string 19</qty>
<base_cost>sample string 20</base_cost>
<base_weee_tax_applied_row_amount>sample string 21</base_weee_tax_applied_row_amount>
<price>sample string 22</price>
<base_row_total_incl_tax>sample string 23</base_row_total_incl_tax>
<row_total_incl_tax>sample string 24</row_total_incl_tax>
<product_id>sample string 25</product_id>
<order_item_id>sample string 26</order_item_id>
<additional_data>sample string 27</additional_data>
<description>sample string 28</description>
<weee_tax_applied>sample string 29</weee_tax_applied>
<sku>sample string 30</sku>
<name>sample string 31</name>
<hidden_tax_amount>sample string 32</hidden_tax_amount>
<base_hidden_tax_amount>sample string 33</base_hidden_tax_amount>
</complexObjectArray>
<complexObjectArray>
<item_id>sample string 1</item_id>
<parent_id>sample string 2</parent_id>
<weee_tax_applied_row_amount>sample string 3</weee_tax_applied_row_amount>
<base_price>sample string 4</base_price>
<base_weee_tax_row_disposition>sample string 5</base_weee_tax_row_disposition>
<tax_amount>sample string 6</tax_amount>
<base_weee_tax_applied_amount>sample string 7</base_weee_tax_applied_amount>
<weee_tax_row_disposition>sample string 8</weee_tax_row_disposition>
<base_row_total>sample string 9</base_row_total>
<discount_amount>sample string 10</discount_amount>
<row_total>sample string 11</row_total>
<weee_tax_applied_amount>sample string 12</weee_tax_applied_amount>
<base_discount_amount>sample string 13</base_discount_amount>
<base_weee_tax_disposition>sample string 14</base_weee_tax_disposition>
<price_incl_tax>sample string 15</price_incl_tax>
<base_tax_amount>sample string 16</base_tax_amount>
<weee_tax_disposition>sample string 17</weee_tax_disposition>
<base_price_incl_tax>sample string 18</base_price_incl_tax>
<qty>sample string 19</qty>
<base_cost>sample string 20</base_cost>
<base_weee_tax_applied_row_amount>sample string 21</base_weee_tax_applied_row_amount>
<price>sample string 22</price>
<base_row_total_incl_tax>sample string 23</base_row_total_incl_tax>
<row_total_incl_tax>sample string 24</row_total_incl_tax>
<product_id>sample string 25</product_id>
<order_item_id>sample string 26</order_item_id>
<additional_data>sample string 27</additional_data>
<description>sample string 28</description>
<weee_tax_applied>sample string 29</weee_tax_applied>
<sku>sample string 30</sku>
<name>sample string 31</name>
<hidden_tax_amount>sample string 32</hidden_tax_amount>
<base_hidden_tax_amount>sample string 33</base_hidden_tax_amount>
</complexObjectArray>
</items>
<comments>
<complexObjectArray>
<parent_id>sample string 1</parent_id>
<created_at>sample string 2</created_at>
<comment>sample string 3</comment>
<is_customer_notified>sample string 4</is_customer_notified>
<comment_id>sample string 5</comment_id>
<is_visible_on_front>sample string 6</is_visible_on_front>
</complexObjectArray>
<complexObjectArray>
<parent_id>sample string 1</parent_id>
<created_at>sample string 2</created_at>
<comment>sample string 3</comment>
<is_customer_notified>sample string 4</is_customer_notified>
<comment_id>sample string 5</comment_id>
<is_visible_on_front>sample string 6</is_visible_on_front>
</complexObjectArray>
</comments>
</salesOrderCreditmemoEntity>