Magento2

Performs persist operations for a specified credit memo

POST /V1/creditmemo

Performs persist operations for a specified credit memo.

Body

  • entity object Required

    Credit memo interface. After a customer places and pays for an order and an invoice has been issued, the merchant can create a credit memo to refund all or part of the amount paid for any returned or undelivered items. The memo restores funds to the customer account so that the customer can make future purchases.

    Hide entity attributes Show entity attributes object
    • adjustment number

      Credit memo adjustment.

    • adjustment_negative number

      Credit memo negative adjustment.

    • adjustment_positive number

      Credit memo positive adjustment.

    • base_adjustment number

      Credit memo base adjustment.

    • base_adjustment_negative number

      Credit memo negative base adjustment.

    • base_adjustment_positive number

      Credit memo positive base adjustment.

    • base_currency_code string

      Credit memo base currency code.

    • base_discount_amount number

      Credit memo base discount amount.

    • base_grand_total number

      Credit memo base grand total.

    • base_discount_tax_compensation_amount number

      Credit memo base discount tax compensation amount.

    • base_shipping_amount number

      Credit memo base shipping amount.

    • base_shipping_discount_tax_compensation_amnt number

      Credit memo base shipping discount tax compensation amount.

    • base_shipping_incl_tax number

      Credit memo base shipping including tax.

    • base_shipping_tax_amount number

      Credit memo base shipping tax amount.

    • base_subtotal number

      Credit memo base subtotal.

    • base_subtotal_incl_tax number

      Credit memo base subtotal including tax.

    • base_tax_amount number

      Credit memo base tax amount.

    • base_to_global_rate number

      Credit memo base-to-global rate.

    • base_to_order_rate number

      Credit memo base-to-order rate.

    • billing_address_id integer

      Credit memo billing address ID.

    • created_at string

      Credit memo created-at timestamp.

    • creditmemo_status integer

      Credit memo status.

    • discount_amount number

      Credit memo discount amount.

    • discount_description string

      Credit memo discount description.

    • email_sent integer

      Credit memo email sent flag value.

    • entity_id integer

      Credit memo ID.

    • global_currency_code string

      Credit memo global currency code.

    • grand_total number

      Credit memo grand total.

    • discount_tax_compensation_amount number

      Credit memo discount tax compensation amount.

    • increment_id string

      Credit memo increment ID.

    • invoice_id integer

      Credit memo invoice ID.

    • order_currency_code string

      Credit memo order currency code.

    • order_id integer Required

      Credit memo order ID.

    • shipping_address_id integer

      Credit memo shipping address ID.

    • shipping_amount number

      Credit memo shipping amount.

    • shipping_discount_tax_compensation_amount number

      Credit memo shipping discount tax compensation amount.

    • shipping_incl_tax number

      Credit memo shipping including tax.

    • shipping_tax_amount number

      Credit memo shipping tax amount.

    • state integer

      Credit memo state.

    • store_currency_code string

      Credit memo store currency code.

    • store_id integer

      Credit memo store ID.

    • store_to_base_rate number

      Credit memo store-to-base rate.

    • store_to_order_rate number

      Credit memo store-to-order rate.

    • subtotal number

      Credit memo subtotal.

    • subtotal_incl_tax number

      Credit memo subtotal including tax.

    • tax_amount number

      Credit memo tax amount.

    • transaction_id string

      Credit memo transaction ID.

    • updated_at string

      Credit memo updated-at timestamp.

    • items array[object] Required

      Array of credit memo items.

      Hide items attributes Show items attributes object

      Credit memo item interface. After a customer places and pays for an order and an invoice has been issued, the merchant can create a credit memo to refund all or part of the amount paid for any returned or undelivered items. The memo restores funds to the customer account so that the customer can make future purchases. A credit memo item is an invoiced item for which a merchant creates a credit memo.

      • additional_data string

        Additional data.

      • base_cost number Required

        The base cost for a credit memo item.

      • base_discount_amount number

        The base discount amount for a credit memo item.

      • base_discount_tax_compensation_amount number

        The base discount tax compensation amount for a credit memo item.

      • base_price number Required

        The base price for a credit memo item.

      • base_price_incl_tax number

        Base price including tax.

      • base_row_total number

        Base row total.

      • base_row_total_incl_tax number

        Base row total including tax.

      • base_tax_amount number

        Base tax amount.

      • base_weee_tax_applied_amount number

        Base WEEE tax applied amount.

      • base_weee_tax_applied_row_amnt number

        Base WEEE tax applied row amount.

      • base_weee_tax_disposition number

        Base WEEE tax disposition.

      • base_weee_tax_row_disposition number

        Base WEEE tax row disposition.

      • description string

        Description.

      • discount_amount number

        Discount amount.

      • entity_id integer Required

        Credit memo item ID.

      • discount_tax_compensation_amount number

        Discount tax compensation amount.

      • name string

        Name.

      • order_item_id integer Required

        Order item ID.

      • parent_id integer

        Parent ID.

      • price number

        Price.

      • price_incl_tax number

        Price including tax.

      • product_id integer

        Product ID.

      • qty number Required

        Quantity.

      • row_total number

        Row total.

      • row_total_incl_tax number

        Row total including tax.

      • sku string

        SKU.

      • tax_amount number

        Tax amount.

      • weee_tax_applied string

        WEEE tax applied.

      • weee_tax_applied_amount number

        WEEE tax applied amount.

      • weee_tax_applied_row_amount number

        WEEE tax applied row amount.

      • weee_tax_disposition number

        WEEE tax disposition.

      • weee_tax_row_disposition number

        WEEE tax row disposition.

      • extension_attributes object

        ExtensionInterface class for @see \Magento\Sales\Api\Data\CreditmemoItemInterface

        Hide extension_attributes attributes Show extension_attributes attributes object
        • status string
        • list_price number
        • size string
        • color string
        • merchant_product_reference string
        • category_code string
        • image string
        • mpn string
        • msrp number
        • manufacturer_code string
        • manufacturer_name string
        • merchant_code string
        • merchant_name string
        • merchant_city string
        • merchant_commission_percentage number
        • merchant_deficiency_percentage number
        • merchant_handling_fee number
        • is_sale boolean
        • return_item_fee number
        • base_return_item_fee number
        • is_outlet boolean
    • comments array[object]

      Array of any credit memo comments. Otherwise, null.

      Hide comments attributes Show comments attributes object

      Credit memo comment interface. After a customer places and pays for an order and an invoice has been issued, the merchant can create a credit memo to refund all or part of the amount paid for any returned or undelivered items. The memo restores funds to the customer account so that the customer can make future purchases. A credit memo usually includes comments that detail why the credit memo amount was credited to the customer.

      • comment string Required

        Comment.

      • created_at string

        Created-at timestamp.

      • entity_id integer

        Credit memo ID.

      • is_customer_notified integer Required

        Is-customer-notified flag value.

      • is_visible_on_front integer Required

        Is-visible-on-storefront flag value.

      • parent_id integer Required

        Parent ID.

      • extension_attributes object

        ExtensionInterface class for @see \Magento\Sales\Api\Data\CreditmemoCommentInterface

    • extension_attributes object

      ExtensionInterface class for @see \Magento\Sales\Api\Data\CreditmemoInterface

      Hide extension_attributes attributes Show extension_attributes attributes object
      • base_customer_balance_amount number
      • customer_balance_amount number
      • base_gift_cards_amount number
      • gift_cards_amount number
      • gw_base_price string
      • gw_price string
      • gw_items_base_price string
      • gw_items_price string
      • gw_card_base_price string
      • gw_card_price string
      • gw_base_tax_amount string
      • gw_tax_amount string
      • gw_items_base_tax_amount string
      • gw_items_tax_amount string
      • gw_card_base_tax_amount string
      • gw_card_tax_amount string
      • return_fee number
      • base_return_fee number
      • psp_reference string
      • company_id integer

Body

  • entity object Required

    Credit memo interface. After a customer places and pays for an order and an invoice has been issued, the merchant can create a credit memo to refund all or part of the amount paid for any returned or undelivered items. The memo restores funds to the customer account so that the customer can make future purchases.

    Hide entity attributes Show entity attributes object
    • adjustment number

      Credit memo adjustment.

    • adjustment_negative number

      Credit memo negative adjustment.

    • adjustment_positive number

      Credit memo positive adjustment.

    • base_adjustment number

      Credit memo base adjustment.

    • base_adjustment_negative number

      Credit memo negative base adjustment.

    • base_adjustment_positive number

      Credit memo positive base adjustment.

    • base_currency_code string

      Credit memo base currency code.

    • base_discount_amount number

      Credit memo base discount amount.

    • base_grand_total number

      Credit memo base grand total.

    • base_discount_tax_compensation_amount number

      Credit memo base discount tax compensation amount.

    • base_shipping_amount number

      Credit memo base shipping amount.

    • base_shipping_discount_tax_compensation_amnt number

      Credit memo base shipping discount tax compensation amount.

    • base_shipping_incl_tax number

      Credit memo base shipping including tax.

    • base_shipping_tax_amount number

      Credit memo base shipping tax amount.

    • base_subtotal number

      Credit memo base subtotal.

    • base_subtotal_incl_tax number

      Credit memo base subtotal including tax.

    • base_tax_amount number

      Credit memo base tax amount.

    • base_to_global_rate number

      Credit memo base-to-global rate.

    • base_to_order_rate number

      Credit memo base-to-order rate.

    • billing_address_id integer

      Credit memo billing address ID.

    • created_at string

      Credit memo created-at timestamp.

    • creditmemo_status integer

      Credit memo status.

    • discount_amount number

      Credit memo discount amount.

    • discount_description string

      Credit memo discount description.

    • email_sent integer

      Credit memo email sent flag value.

    • entity_id integer

      Credit memo ID.

    • global_currency_code string

      Credit memo global currency code.

    • grand_total number

      Credit memo grand total.

    • discount_tax_compensation_amount number

      Credit memo discount tax compensation amount.

    • increment_id string

      Credit memo increment ID.

    • invoice_id integer

      Credit memo invoice ID.

    • order_currency_code string

      Credit memo order currency code.

    • order_id integer Required

      Credit memo order ID.

    • shipping_address_id integer

      Credit memo shipping address ID.

    • shipping_amount number

      Credit memo shipping amount.

    • shipping_discount_tax_compensation_amount number

      Credit memo shipping discount tax compensation amount.

    • shipping_incl_tax number

      Credit memo shipping including tax.

    • shipping_tax_amount number

      Credit memo shipping tax amount.

    • state integer

      Credit memo state.

    • store_currency_code string

      Credit memo store currency code.

    • store_id integer

      Credit memo store ID.

    • store_to_base_rate number

      Credit memo store-to-base rate.

    • store_to_order_rate number

      Credit memo store-to-order rate.

    • subtotal number

      Credit memo subtotal.

    • subtotal_incl_tax number

      Credit memo subtotal including tax.

    • tax_amount number

      Credit memo tax amount.

    • transaction_id string

      Credit memo transaction ID.

    • updated_at string

      Credit memo updated-at timestamp.

    • items array[object] Required

      Array of credit memo items.

      Hide items attributes Show items attributes object

      Credit memo item interface. After a customer places and pays for an order and an invoice has been issued, the merchant can create a credit memo to refund all or part of the amount paid for any returned or undelivered items. The memo restores funds to the customer account so that the customer can make future purchases. A credit memo item is an invoiced item for which a merchant creates a credit memo.

      • additional_data string

        Additional data.

      • base_cost number Required

        The base cost for a credit memo item.

      • base_discount_amount number

        The base discount amount for a credit memo item.

      • base_discount_tax_compensation_amount number

        The base discount tax compensation amount for a credit memo item.

      • base_price number Required

        The base price for a credit memo item.

      • base_price_incl_tax number

        Base price including tax.

      • base_row_total number

        Base row total.

      • base_row_total_incl_tax number

        Base row total including tax.

      • base_tax_amount number

        Base tax amount.

      • base_weee_tax_applied_amount number

        Base WEEE tax applied amount.

      • base_weee_tax_applied_row_amnt number

        Base WEEE tax applied row amount.

      • base_weee_tax_disposition number

        Base WEEE tax disposition.

      • base_weee_tax_row_disposition number

        Base WEEE tax row disposition.

      • description string

        Description.

      • discount_amount number

        Discount amount.

      • entity_id integer Required

        Credit memo item ID.

      • discount_tax_compensation_amount number

        Discount tax compensation amount.

      • name string

        Name.

      • order_item_id integer Required

        Order item ID.

      • parent_id integer

        Parent ID.

      • price number

        Price.

      • price_incl_tax number

        Price including tax.

      • product_id integer

        Product ID.

      • qty number Required

        Quantity.

      • row_total number

        Row total.

      • row_total_incl_tax number

        Row total including tax.

      • sku string

        SKU.

      • tax_amount number

        Tax amount.

      • weee_tax_applied string

        WEEE tax applied.

      • weee_tax_applied_amount number

        WEEE tax applied amount.

      • weee_tax_applied_row_amount number

        WEEE tax applied row amount.

      • weee_tax_disposition number

        WEEE tax disposition.

      • weee_tax_row_disposition number

        WEEE tax row disposition.

      • extension_attributes object

        ExtensionInterface class for @see \Magento\Sales\Api\Data\CreditmemoItemInterface

        Hide extension_attributes attributes Show extension_attributes attributes object
        • status string
        • list_price number
        • size string
        • color string
        • merchant_product_reference string
        • category_code string
        • image string
        • mpn string
        • msrp number
        • manufacturer_code string
        • manufacturer_name string
        • merchant_code string
        • merchant_name string
        • merchant_city string
        • merchant_commission_percentage number
        • merchant_deficiency_percentage number
        • merchant_handling_fee number
        • is_sale boolean
        • return_item_fee number
        • base_return_item_fee number
        • is_outlet boolean
    • comments array[object]

      Array of any credit memo comments. Otherwise, null.

      Hide comments attributes Show comments attributes object

      Credit memo comment interface. After a customer places and pays for an order and an invoice has been issued, the merchant can create a credit memo to refund all or part of the amount paid for any returned or undelivered items. The memo restores funds to the customer account so that the customer can make future purchases. A credit memo usually includes comments that detail why the credit memo amount was credited to the customer.

      • comment string Required

        Comment.

      • created_at string

        Created-at timestamp.

      • entity_id integer

        Credit memo ID.

      • is_customer_notified integer Required

        Is-customer-notified flag value.

      • is_visible_on_front integer Required

        Is-visible-on-storefront flag value.

      • parent_id integer Required

        Parent ID.

      • extension_attributes object

        ExtensionInterface class for @see \Magento\Sales\Api\Data\CreditmemoCommentInterface

    • extension_attributes object

      ExtensionInterface class for @see \Magento\Sales\Api\Data\CreditmemoInterface

      Hide extension_attributes attributes Show extension_attributes attributes object
      • base_customer_balance_amount number
      • customer_balance_amount number
      • base_gift_cards_amount number
      • gift_cards_amount number
      • gw_base_price string
      • gw_price string
      • gw_items_base_price string
      • gw_items_price string
      • gw_card_base_price string
      • gw_card_price string
      • gw_base_tax_amount string
      • gw_tax_amount string
      • gw_items_base_tax_amount string
      • gw_items_tax_amount string
      • gw_card_base_tax_amount string
      • gw_card_tax_amount string
      • return_fee number
      • base_return_fee number
      • psp_reference string
      • company_id integer

Responses

  • 200

    200 Success.

    Hide response attributes Show response attributes object
    • adjustment number

      Credit memo adjustment.

    • adjustment_negative number

      Credit memo negative adjustment.

    • adjustment_positive number

      Credit memo positive adjustment.

    • base_adjustment number

      Credit memo base adjustment.

    • base_adjustment_negative number

      Credit memo negative base adjustment.

    • base_adjustment_positive number

      Credit memo positive base adjustment.

    • base_currency_code string

      Credit memo base currency code.

    • base_discount_amount number

      Credit memo base discount amount.

    • base_grand_total number

      Credit memo base grand total.

    • base_discount_tax_compensation_amount number

      Credit memo base discount tax compensation amount.

    • base_shipping_amount number

      Credit memo base shipping amount.

    • base_shipping_discount_tax_compensation_amnt number

      Credit memo base shipping discount tax compensation amount.

    • base_shipping_incl_tax number

      Credit memo base shipping including tax.

    • base_shipping_tax_amount number

      Credit memo base shipping tax amount.

    • base_subtotal number

      Credit memo base subtotal.

    • base_subtotal_incl_tax number

      Credit memo base subtotal including tax.

    • base_tax_amount number

      Credit memo base tax amount.

    • base_to_global_rate number

      Credit memo base-to-global rate.

    • base_to_order_rate number

      Credit memo base-to-order rate.

    • billing_address_id integer

      Credit memo billing address ID.

    • created_at string

      Credit memo created-at timestamp.

    • creditmemo_status integer

      Credit memo status.

    • discount_amount number

      Credit memo discount amount.

    • discount_description string

      Credit memo discount description.

    • email_sent integer

      Credit memo email sent flag value.

    • entity_id integer

      Credit memo ID.

    • global_currency_code string

      Credit memo global currency code.

    • grand_total number

      Credit memo grand total.

    • discount_tax_compensation_amount number

      Credit memo discount tax compensation amount.

    • increment_id string

      Credit memo increment ID.

    • invoice_id integer

      Credit memo invoice ID.

    • order_currency_code string

      Credit memo order currency code.

    • order_id integer Required

      Credit memo order ID.

    • shipping_address_id integer

      Credit memo shipping address ID.

    • shipping_amount number

      Credit memo shipping amount.

    • shipping_discount_tax_compensation_amount number

      Credit memo shipping discount tax compensation amount.

    • shipping_incl_tax number

      Credit memo shipping including tax.

    • shipping_tax_amount number

      Credit memo shipping tax amount.

    • state integer

      Credit memo state.

    • store_currency_code string

      Credit memo store currency code.

    • store_id integer

      Credit memo store ID.

    • store_to_base_rate number

      Credit memo store-to-base rate.

    • store_to_order_rate number

      Credit memo store-to-order rate.

    • subtotal number

      Credit memo subtotal.

    • subtotal_incl_tax number

      Credit memo subtotal including tax.

    • tax_amount number

      Credit memo tax amount.

    • transaction_id string

      Credit memo transaction ID.

    • updated_at string

      Credit memo updated-at timestamp.

    • items array[object] Required

      Array of credit memo items.

      Hide items attributes Show items attributes object

      Credit memo item interface. After a customer places and pays for an order and an invoice has been issued, the merchant can create a credit memo to refund all or part of the amount paid for any returned or undelivered items. The memo restores funds to the customer account so that the customer can make future purchases. A credit memo item is an invoiced item for which a merchant creates a credit memo.

      • additional_data string

        Additional data.

      • base_cost number Required

        The base cost for a credit memo item.

      • base_discount_amount number

        The base discount amount for a credit memo item.

      • base_discount_tax_compensation_amount number

        The base discount tax compensation amount for a credit memo item.

      • base_price number Required

        The base price for a credit memo item.

      • base_price_incl_tax number

        Base price including tax.

      • base_row_total number

        Base row total.

      • base_row_total_incl_tax number

        Base row total including tax.

      • base_tax_amount number

        Base tax amount.

      • base_weee_tax_applied_amount number

        Base WEEE tax applied amount.

      • base_weee_tax_applied_row_amnt number

        Base WEEE tax applied row amount.

      • base_weee_tax_disposition number

        Base WEEE tax disposition.

      • base_weee_tax_row_disposition number

        Base WEEE tax row disposition.

      • description string

        Description.

      • discount_amount number

        Discount amount.

      • entity_id integer Required

        Credit memo item ID.

      • discount_tax_compensation_amount number

        Discount tax compensation amount.

      • name string

        Name.

      • order_item_id integer Required

        Order item ID.

      • parent_id integer

        Parent ID.

      • price number

        Price.

      • price_incl_tax number

        Price including tax.

      • product_id integer

        Product ID.

      • qty number Required

        Quantity.

      • row_total number

        Row total.

      • row_total_incl_tax number

        Row total including tax.

      • sku string

        SKU.

      • tax_amount number

        Tax amount.

      • weee_tax_applied string

        WEEE tax applied.

      • weee_tax_applied_amount number

        WEEE tax applied amount.

      • weee_tax_applied_row_amount number

        WEEE tax applied row amount.

      • weee_tax_disposition number

        WEEE tax disposition.

      • weee_tax_row_disposition number

        WEEE tax row disposition.

      • extension_attributes object

        ExtensionInterface class for @see \Magento\Sales\Api\Data\CreditmemoItemInterface

        Hide extension_attributes attributes Show extension_attributes attributes object
        • status string
        • list_price number
        • size string
        • color string
        • merchant_product_reference string
        • category_code string
        • image string
        • mpn string
        • msrp number
        • manufacturer_code string
        • manufacturer_name string
        • merchant_code string
        • merchant_name string
        • merchant_city string
        • merchant_commission_percentage number
        • merchant_deficiency_percentage number
        • merchant_handling_fee number
        • is_sale boolean
        • return_item_fee number
        • base_return_item_fee number
        • is_outlet boolean
    • comments array[object]

      Array of any credit memo comments. Otherwise, null.

      Hide comments attributes Show comments attributes object

      Credit memo comment interface. After a customer places and pays for an order and an invoice has been issued, the merchant can create a credit memo to refund all or part of the amount paid for any returned or undelivered items. The memo restores funds to the customer account so that the customer can make future purchases. A credit memo usually includes comments that detail why the credit memo amount was credited to the customer.

      • comment string Required

        Comment.

      • created_at string

        Created-at timestamp.

      • entity_id integer

        Credit memo ID.

      • is_customer_notified integer Required

        Is-customer-notified flag value.

      • is_visible_on_front integer Required

        Is-visible-on-storefront flag value.

      • parent_id integer Required

        Parent ID.

      • extension_attributes object

        ExtensionInterface class for @see \Magento\Sales\Api\Data\CreditmemoCommentInterface

    • extension_attributes object

      ExtensionInterface class for @see \Magento\Sales\Api\Data\CreditmemoInterface

      Hide extension_attributes attributes Show extension_attributes attributes object
      • base_customer_balance_amount number
      • customer_balance_amount number
      • base_gift_cards_amount number
      • gift_cards_amount number
      • gw_base_price string
      • gw_price string
      • gw_items_base_price string
      • gw_items_price string
      • gw_card_base_price string
      • gw_card_price string
      • gw_base_tax_amount string
      • gw_tax_amount string
      • gw_items_base_tax_amount string
      • gw_items_tax_amount string
      • gw_card_base_tax_amount string
      • gw_card_tax_amount string
      • return_fee number
      • base_return_fee number
      • psp_reference string
      • company_id integer
    Hide response attributes Show response attributes object
    • adjustment number

      Credit memo adjustment.

    • adjustment_negative number

      Credit memo negative adjustment.

    • adjustment_positive number

      Credit memo positive adjustment.

    • base_adjustment number

      Credit memo base adjustment.

    • base_adjustment_negative number

      Credit memo negative base adjustment.

    • base_adjustment_positive number

      Credit memo positive base adjustment.

    • base_currency_code string

      Credit memo base currency code.

    • base_discount_amount number

      Credit memo base discount amount.

    • base_grand_total number

      Credit memo base grand total.

    • base_discount_tax_compensation_amount number

      Credit memo base discount tax compensation amount.

    • base_shipping_amount number

      Credit memo base shipping amount.

    • base_shipping_discount_tax_compensation_amnt number

      Credit memo base shipping discount tax compensation amount.

    • base_shipping_incl_tax number

      Credit memo base shipping including tax.

    • base_shipping_tax_amount number

      Credit memo base shipping tax amount.

    • base_subtotal number

      Credit memo base subtotal.

    • base_subtotal_incl_tax number

      Credit memo base subtotal including tax.

    • base_tax_amount number

      Credit memo base tax amount.

    • base_to_global_rate number

      Credit memo base-to-global rate.

    • base_to_order_rate number

      Credit memo base-to-order rate.

    • billing_address_id integer

      Credit memo billing address ID.

    • created_at string

      Credit memo created-at timestamp.

    • creditmemo_status integer

      Credit memo status.

    • discount_amount number

      Credit memo discount amount.

    • discount_description string

      Credit memo discount description.

    • email_sent integer

      Credit memo email sent flag value.

    • entity_id integer

      Credit memo ID.

    • global_currency_code string

      Credit memo global currency code.

    • grand_total number

      Credit memo grand total.

    • discount_tax_compensation_amount number

      Credit memo discount tax compensation amount.

    • increment_id string

      Credit memo increment ID.

    • invoice_id integer

      Credit memo invoice ID.

    • order_currency_code string

      Credit memo order currency code.

    • order_id integer Required

      Credit memo order ID.

    • shipping_address_id integer

      Credit memo shipping address ID.

    • shipping_amount number

      Credit memo shipping amount.

    • shipping_discount_tax_compensation_amount number

      Credit memo shipping discount tax compensation amount.

    • shipping_incl_tax number

      Credit memo shipping including tax.

    • shipping_tax_amount number

      Credit memo shipping tax amount.

    • state integer

      Credit memo state.

    • store_currency_code string

      Credit memo store currency code.

    • store_id integer

      Credit memo store ID.

    • store_to_base_rate number

      Credit memo store-to-base rate.

    • store_to_order_rate number

      Credit memo store-to-order rate.

    • subtotal number

      Credit memo subtotal.

    • subtotal_incl_tax number

      Credit memo subtotal including tax.

    • tax_amount number

      Credit memo tax amount.

    • transaction_id string

      Credit memo transaction ID.

    • updated_at string

      Credit memo updated-at timestamp.

    • items array[object] Required

      Array of credit memo items.

      Hide items attributes Show items attributes object

      Credit memo item interface. After a customer places and pays for an order and an invoice has been issued, the merchant can create a credit memo to refund all or part of the amount paid for any returned or undelivered items. The memo restores funds to the customer account so that the customer can make future purchases. A credit memo item is an invoiced item for which a merchant creates a credit memo.

      • additional_data string

        Additional data.

      • base_cost number Required

        The base cost for a credit memo item.

      • base_discount_amount number

        The base discount amount for a credit memo item.

      • base_discount_tax_compensation_amount number

        The base discount tax compensation amount for a credit memo item.

      • base_price number Required

        The base price for a credit memo item.

      • base_price_incl_tax number

        Base price including tax.

      • base_row_total number

        Base row total.

      • base_row_total_incl_tax number

        Base row total including tax.

      • base_tax_amount number

        Base tax amount.

      • base_weee_tax_applied_amount number

        Base WEEE tax applied amount.

      • base_weee_tax_applied_row_amnt number

        Base WEEE tax applied row amount.

      • base_weee_tax_disposition number

        Base WEEE tax disposition.

      • base_weee_tax_row_disposition number

        Base WEEE tax row disposition.

      • description string

        Description.

      • discount_amount number

        Discount amount.

      • entity_id integer Required

        Credit memo item ID.

      • discount_tax_compensation_amount number

        Discount tax compensation amount.

      • name string

        Name.

      • order_item_id integer Required

        Order item ID.

      • parent_id integer

        Parent ID.

      • price number

        Price.

      • price_incl_tax number

        Price including tax.

      • product_id integer

        Product ID.

      • qty number Required

        Quantity.

      • row_total number

        Row total.

      • row_total_incl_tax number

        Row total including tax.

      • sku string

        SKU.

      • tax_amount number

        Tax amount.

      • weee_tax_applied string

        WEEE tax applied.

      • weee_tax_applied_amount number

        WEEE tax applied amount.

      • weee_tax_applied_row_amount number

        WEEE tax applied row amount.

      • weee_tax_disposition number

        WEEE tax disposition.

      • weee_tax_row_disposition number

        WEEE tax row disposition.

      • extension_attributes object

        ExtensionInterface class for @see \Magento\Sales\Api\Data\CreditmemoItemInterface

        Hide extension_attributes attributes Show extension_attributes attributes object
        • status string
        • list_price number
        • size string
        • color string
        • merchant_product_reference string
        • category_code string
        • image string
        • mpn string
        • msrp number
        • manufacturer_code string
        • manufacturer_name string
        • merchant_code string
        • merchant_name string
        • merchant_city string
        • merchant_commission_percentage number
        • merchant_deficiency_percentage number
        • merchant_handling_fee number
        • is_sale boolean
        • return_item_fee number
        • base_return_item_fee number
        • is_outlet boolean
    • comments array[object]

      Array of any credit memo comments. Otherwise, null.

      Hide comments attributes Show comments attributes object

      Credit memo comment interface. After a customer places and pays for an order and an invoice has been issued, the merchant can create a credit memo to refund all or part of the amount paid for any returned or undelivered items. The memo restores funds to the customer account so that the customer can make future purchases. A credit memo usually includes comments that detail why the credit memo amount was credited to the customer.

      • comment string Required

        Comment.

      • created_at string

        Created-at timestamp.

      • entity_id integer

        Credit memo ID.

      • is_customer_notified integer Required

        Is-customer-notified flag value.

      • is_visible_on_front integer Required

        Is-visible-on-storefront flag value.

      • parent_id integer Required

        Parent ID.

      • extension_attributes object

        ExtensionInterface class for @see \Magento\Sales\Api\Data\CreditmemoCommentInterface

    • extension_attributes object

      ExtensionInterface class for @see \Magento\Sales\Api\Data\CreditmemoInterface

      Hide extension_attributes attributes Show extension_attributes attributes object
      • base_customer_balance_amount number
      • customer_balance_amount number
      • base_gift_cards_amount number
      • gift_cards_amount number
      • gw_base_price string
      • gw_price string
      • gw_items_base_price string
      • gw_items_price string
      • gw_card_base_price string
      • gw_card_price string
      • gw_base_tax_amount string
      • gw_tax_amount string
      • gw_items_base_tax_amount string
      • gw_items_tax_amount string
      • gw_card_base_tax_amount string
      • gw_card_tax_amount string
      • return_fee number
      • base_return_fee number
      • psp_reference string
      • company_id integer
  • 401

    401 Unauthorized

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace
  • default

    Unexpected error

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace
POST /V1/creditmemo 
curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/creditmemo' \
 --header "Content-Type: application/json" \
 --data '{"entity":{"adjustment":42.0,"adjustment_negative":42.0,"adjustment_positive":42.0,"base_adjustment":42.0,"base_adjustment_negative":42.0,"base_adjustment_positive":42.0,"base_currency_code":"string","base_discount_amount":42.0,"base_grand_total":42.0,"base_discount_tax_compensation_amount":42.0,"base_shipping_amount":42.0,"base_shipping_discount_tax_compensation_amnt":42.0,"base_shipping_incl_tax":42.0,"base_shipping_tax_amount":42.0,"base_subtotal":42.0,"base_subtotal_incl_tax":42.0,"base_tax_amount":42.0,"base_to_global_rate":42.0,"base_to_order_rate":42.0,"billing_address_id":42,"created_at":"string","creditmemo_status":42,"discount_amount":42.0,"discount_description":"string","email_sent":42,"entity_id":42,"global_currency_code":"string","grand_total":42.0,"discount_tax_compensation_amount":42.0,"increment_id":"string","invoice_id":42,"order_currency_code":"string","order_id":42,"shipping_address_id":42,"shipping_amount":42.0,"shipping_discount_tax_compensation_amount":42.0,"shipping_incl_tax":42.0,"shipping_tax_amount":42.0,"state":42,"store_currency_code":"string","store_id":42,"store_to_base_rate":42.0,"store_to_order_rate":42.0,"subtotal":42.0,"subtotal_incl_tax":42.0,"tax_amount":42.0,"transaction_id":"string","updated_at":"string","items":[{"additional_data":"string","base_cost":42.0,"base_discount_amount":42.0,"base_discount_tax_compensation_amount":42.0,"base_price":42.0,"base_price_incl_tax":42.0,"base_row_total":42.0,"base_row_total_incl_tax":42.0,"base_tax_amount":42.0,"base_weee_tax_applied_amount":42.0,"base_weee_tax_applied_row_amnt":42.0,"base_weee_tax_disposition":42.0,"base_weee_tax_row_disposition":42.0,"description":"string","discount_amount":42.0,"entity_id":42,"discount_tax_compensation_amount":42.0,"name":"string","order_item_id":42,"parent_id":42,"price":42.0,"price_incl_tax":42.0,"product_id":42,"qty":42.0,"row_total":42.0,"row_total_incl_tax":42.0,"sku":"string","tax_amount":42.0,"weee_tax_applied":"string","weee_tax_applied_amount":42.0,"weee_tax_applied_row_amount":42.0,"weee_tax_disposition":42.0,"weee_tax_row_disposition":42.0,"extension_attributes":{"status":"string","list_price":42.0,"size":"string","color":"string","merchant_product_reference":"string","category_code":"string","image":"string","mpn":"string","msrp":42.0,"manufacturer_code":"string","manufacturer_name":"string","merchant_code":"string","merchant_name":"string","merchant_city":"string","merchant_commission_percentage":42.0,"merchant_deficiency_percentage":42.0,"merchant_handling_fee":42.0,"is_sale":true,"return_item_fee":42.0,"base_return_item_fee":42.0,"is_outlet":true}}],"comments":[{"comment":"string","created_at":"string","entity_id":42,"is_customer_notified":42,"is_visible_on_front":42,"parent_id":42,"extension_attributes":{}}],"extension_attributes":{"base_customer_balance_amount":42.0,"customer_balance_amount":42.0,"base_gift_cards_amount":42.0,"gift_cards_amount":42.0,"gw_base_price":"string","gw_price":"string","gw_items_base_price":"string","gw_items_price":"string","gw_card_base_price":"string","gw_card_price":"string","gw_base_tax_amount":"string","gw_tax_amount":"string","gw_items_base_tax_amount":"string","gw_items_tax_amount":"string","gw_card_base_tax_amount":"string","gw_card_tax_amount":"string","return_fee":42.0,"base_return_fee":42.0,"psp_reference":"string","company_id":42}}}'
curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/creditmemo' \
 --header "Content-Type: application/xml"
Request examples 
{
  "entity": {
    "adjustment": 42.0,
    "adjustment_negative": 42.0,
    "adjustment_positive": 42.0,
    "base_adjustment": 42.0,
    "base_adjustment_negative": 42.0,
    "base_adjustment_positive": 42.0,
    "base_currency_code": "string",
    "base_discount_amount": 42.0,
    "base_grand_total": 42.0,
    "base_discount_tax_compensation_amount": 42.0,
    "base_shipping_amount": 42.0,
    "base_shipping_discount_tax_compensation_amnt": 42.0,
    "base_shipping_incl_tax": 42.0,
    "base_shipping_tax_amount": 42.0,
    "base_subtotal": 42.0,
    "base_subtotal_incl_tax": 42.0,
    "base_tax_amount": 42.0,
    "base_to_global_rate": 42.0,
    "base_to_order_rate": 42.0,
    "billing_address_id": 42,
    "created_at": "string",
    "creditmemo_status": 42,
    "discount_amount": 42.0,
    "discount_description": "string",
    "email_sent": 42,
    "entity_id": 42,
    "global_currency_code": "string",
    "grand_total": 42.0,
    "discount_tax_compensation_amount": 42.0,
    "increment_id": "string",
    "invoice_id": 42,
    "order_currency_code": "string",
    "order_id": 42,
    "shipping_address_id": 42,
    "shipping_amount": 42.0,
    "shipping_discount_tax_compensation_amount": 42.0,
    "shipping_incl_tax": 42.0,
    "shipping_tax_amount": 42.0,
    "state": 42,
    "store_currency_code": "string",
    "store_id": 42,
    "store_to_base_rate": 42.0,
    "store_to_order_rate": 42.0,
    "subtotal": 42.0,
    "subtotal_incl_tax": 42.0,
    "tax_amount": 42.0,
    "transaction_id": "string",
    "updated_at": "string",
    "items": [
      {
        "additional_data": "string",
        "base_cost": 42.0,
        "base_discount_amount": 42.0,
        "base_discount_tax_compensation_amount": 42.0,
        "base_price": 42.0,
        "base_price_incl_tax": 42.0,
        "base_row_total": 42.0,
        "base_row_total_incl_tax": 42.0,
        "base_tax_amount": 42.0,
        "base_weee_tax_applied_amount": 42.0,
        "base_weee_tax_applied_row_amnt": 42.0,
        "base_weee_tax_disposition": 42.0,
        "base_weee_tax_row_disposition": 42.0,
        "description": "string",
        "discount_amount": 42.0,
        "entity_id": 42,
        "discount_tax_compensation_amount": 42.0,
        "name": "string",
        "order_item_id": 42,
        "parent_id": 42,
        "price": 42.0,
        "price_incl_tax": 42.0,
        "product_id": 42,
        "qty": 42.0,
        "row_total": 42.0,
        "row_total_incl_tax": 42.0,
        "sku": "string",
        "tax_amount": 42.0,
        "weee_tax_applied": "string",
        "weee_tax_applied_amount": 42.0,
        "weee_tax_applied_row_amount": 42.0,
        "weee_tax_disposition": 42.0,
        "weee_tax_row_disposition": 42.0,
        "extension_attributes": {
          "status": "string",
          "list_price": 42.0,
          "size": "string",
          "color": "string",
          "merchant_product_reference": "string",
          "category_code": "string",
          "image": "string",
          "mpn": "string",
          "msrp": 42.0,
          "manufacturer_code": "string",
          "manufacturer_name": "string",
          "merchant_code": "string",
          "merchant_name": "string",
          "merchant_city": "string",
          "merchant_commission_percentage": 42.0,
          "merchant_deficiency_percentage": 42.0,
          "merchant_handling_fee": 42.0,
          "is_sale": true,
          "return_item_fee": 42.0,
          "base_return_item_fee": 42.0,
          "is_outlet": true
        }
      }
    ],
    "comments": [
      {
        "comment": "string",
        "created_at": "string",
        "entity_id": 42,
        "is_customer_notified": 42,
        "is_visible_on_front": 42,
        "parent_id": 42,
        "extension_attributes": {}
      }
    ],
    "extension_attributes": {
      "base_customer_balance_amount": 42.0,
      "customer_balance_amount": 42.0,
      "base_gift_cards_amount": 42.0,
      "gift_cards_amount": 42.0,
      "gw_base_price": "string",
      "gw_price": "string",
      "gw_items_base_price": "string",
      "gw_items_price": "string",
      "gw_card_base_price": "string",
      "gw_card_price": "string",
      "gw_base_tax_amount": "string",
      "gw_tax_amount": "string",
      "gw_items_base_tax_amount": "string",
      "gw_items_tax_amount": "string",
      "gw_card_base_tax_amount": "string",
      "gw_card_tax_amount": "string",
      "return_fee": 42.0,
      "base_return_fee": 42.0,
      "psp_reference": "string",
      "company_id": 42
    }
  }
}
Request examples 
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <entity>
    <adjustment type="float">42.0</adjustment>
    <adjustment-negative type="float">42.0</adjustment-negative>
    <adjustment-positive type="float">42.0</adjustment-positive>
    <base-adjustment type="float">42.0</base-adjustment>
    <base-adjustment-negative type="float">42.0</base-adjustment-negative>
    <base-adjustment-positive type="float">42.0</base-adjustment-positive>
    <base-currency-code>string</base-currency-code>
    <base-discount-amount type="float">42.0</base-discount-amount>
    <base-grand-total type="float">42.0</base-grand-total>
    <base-discount-tax-compensation-amount type="float">42.0</base-discount-tax-compensation-amount>
    <base-shipping-amount type="float">42.0</base-shipping-amount>
    <base-shipping-discount-tax-compensation-amnt type="float">42.0</base-shipping-discount-tax-compensation-amnt>
    <base-shipping-incl-tax type="float">42.0</base-shipping-incl-tax>
    <base-shipping-tax-amount type="float">42.0</base-shipping-tax-amount>
    <base-subtotal type="float">42.0</base-subtotal>
    <base-subtotal-incl-tax type="float">42.0</base-subtotal-incl-tax>
    <base-tax-amount type="float">42.0</base-tax-amount>
    <base-to-global-rate type="float">42.0</base-to-global-rate>
    <base-to-order-rate type="float">42.0</base-to-order-rate>
    <billing-address-id type="integer">42</billing-address-id>
    <created-at>string</created-at>
    <creditmemo-status type="integer">42</creditmemo-status>
    <discount-amount type="float">42.0</discount-amount>
    <discount-description>string</discount-description>
    <email-sent type="integer">42</email-sent>
    <entity-id type="integer">42</entity-id>
    <global-currency-code>string</global-currency-code>
    <grand-total type="float">42.0</grand-total>
    <discount-tax-compensation-amount type="float">42.0</discount-tax-compensation-amount>
    <increment-id>string</increment-id>
    <invoice-id type="integer">42</invoice-id>
    <order-currency-code>string</order-currency-code>
    <order-id type="integer">42</order-id>
    <shipping-address-id type="integer">42</shipping-address-id>
    <shipping-amount type="float">42.0</shipping-amount>
    <shipping-discount-tax-compensation-amount type="float">42.0</shipping-discount-tax-compensation-amount>
    <shipping-incl-tax type="float">42.0</shipping-incl-tax>
    <shipping-tax-amount type="float">42.0</shipping-tax-amount>
    <state type="integer">42</state>
    <store-currency-code>string</store-currency-code>
    <store-id type="integer">42</store-id>
    <store-to-base-rate type="float">42.0</store-to-base-rate>
    <store-to-order-rate type="float">42.0</store-to-order-rate>
    <subtotal type="float">42.0</subtotal>
    <subtotal-incl-tax type="float">42.0</subtotal-incl-tax>
    <tax-amount type="float">42.0</tax-amount>
    <transaction-id>string</transaction-id>
    <updated-at>string</updated-at>
    <items type="array">
      <item>
        <additional-data>string</additional-data>
        <base-cost type="float">42.0</base-cost>
        <base-discount-amount type="float">42.0</base-discount-amount>
        <base-discount-tax-compensation-amount type="float">42.0</base-discount-tax-compensation-amount>
        <base-price type="float">42.0</base-price>
        <base-price-incl-tax type="float">42.0</base-price-incl-tax>
        <base-row-total type="float">42.0</base-row-total>
        <base-row-total-incl-tax type="float">42.0</base-row-total-incl-tax>
        <base-tax-amount type="float">42.0</base-tax-amount>
        <base-weee-tax-applied-amount type="float">42.0</base-weee-tax-applied-amount>
        <base-weee-tax-applied-row-amnt type="float">42.0</base-weee-tax-applied-row-amnt>
        <base-weee-tax-disposition type="float">42.0</base-weee-tax-disposition>
        <base-weee-tax-row-disposition type="float">42.0</base-weee-tax-row-disposition>
        <description>string</description>
        <discount-amount type="float">42.0</discount-amount>
        <entity-id type="integer">42</entity-id>
        <discount-tax-compensation-amount type="float">42.0</discount-tax-compensation-amount>
        <name>string</name>
        <order-item-id type="integer">42</order-item-id>
        <parent-id type="integer">42</parent-id>
        <price type="float">42.0</price>
        <price-incl-tax type="float">42.0</price-incl-tax>
        <product-id type="integer">42</product-id>
        <qty type="float">42.0</qty>
        <row-total type="float">42.0</row-total>
        <row-total-incl-tax type="float">42.0</row-total-incl-tax>
        <sku>string</sku>
        <tax-amount type="float">42.0</tax-amount>
        <weee-tax-applied>string</weee-tax-applied>
        <weee-tax-applied-amount type="float">42.0</weee-tax-applied-amount>
        <weee-tax-applied-row-amount type="float">42.0</weee-tax-applied-row-amount>
        <weee-tax-disposition type="float">42.0</weee-tax-disposition>
        <weee-tax-row-disposition type="float">42.0</weee-tax-row-disposition>
        <extension-attributes>
          <status>string</status>
          <list-price type="float">42.0</list-price>
          <size>string</size>
          <color>string</color>
          <merchant-product-reference>string</merchant-product-reference>
          <category-code>string</category-code>
          <image>string</image>
          <mpn>string</mpn>
          <msrp type="float">42.0</msrp>
          <manufacturer-code>string</manufacturer-code>
          <manufacturer-name>string</manufacturer-name>
          <merchant-code>string</merchant-code>
          <merchant-name>string</merchant-name>
          <merchant-city>string</merchant-city>
          <merchant-commission-percentage type="float">42.0</merchant-commission-percentage>
          <merchant-deficiency-percentage type="float">42.0</merchant-deficiency-percentage>
          <merchant-handling-fee type="float">42.0</merchant-handling-fee>
          <is-sale type="boolean">true</is-sale>
          <return-item-fee type="float">42.0</return-item-fee>
          <base-return-item-fee type="float">42.0</base-return-item-fee>
          <is-outlet type="boolean">true</is-outlet>
        </extension-attributes>
      </item>
    </items>
    <comments type="array">
      <comment>
        <comment>string</comment>
        <created-at>string</created-at>
        <entity-id type="integer">42</entity-id>
        <is-customer-notified type="integer">42</is-customer-notified>
        <is-visible-on-front type="integer">42</is-visible-on-front>
        <parent-id type="integer">42</parent-id>
        <extension-attributes>
        </extension-attributes>
      </comment>
    </comments>
    <extension-attributes>
      <base-customer-balance-amount type="float">42.0</base-customer-balance-amount>
      <customer-balance-amount type="float">42.0</customer-balance-amount>
      <base-gift-cards-amount type="float">42.0</base-gift-cards-amount>
      <gift-cards-amount type="float">42.0</gift-cards-amount>
      <gw-base-price>string</gw-base-price>
      <gw-price>string</gw-price>
      <gw-items-base-price>string</gw-items-base-price>
      <gw-items-price>string</gw-items-price>
      <gw-card-base-price>string</gw-card-base-price>
      <gw-card-price>string</gw-card-price>
      <gw-base-tax-amount>string</gw-base-tax-amount>
      <gw-tax-amount>string</gw-tax-amount>
      <gw-items-base-tax-amount>string</gw-items-base-tax-amount>
      <gw-items-tax-amount>string</gw-items-tax-amount>
      <gw-card-base-tax-amount>string</gw-card-base-tax-amount>
      <gw-card-tax-amount>string</gw-card-tax-amount>
      <return-fee type="float">42.0</return-fee>
      <base-return-fee type="float">42.0</base-return-fee>
      <psp-reference>string</psp-reference>
      <company-id type="integer">42</company-id>
    </extension-attributes>
  </entity>
</root>
Response examples (200) 
{
  "adjustment": 42.0,
  "adjustment_negative": 42.0,
  "adjustment_positive": 42.0,
  "base_adjustment": 42.0,
  "base_adjustment_negative": 42.0,
  "base_adjustment_positive": 42.0,
  "base_currency_code": "string",
  "base_discount_amount": 42.0,
  "base_grand_total": 42.0,
  "base_discount_tax_compensation_amount": 42.0,
  "base_shipping_amount": 42.0,
  "base_shipping_discount_tax_compensation_amnt": 42.0,
  "base_shipping_incl_tax": 42.0,
  "base_shipping_tax_amount": 42.0,
  "base_subtotal": 42.0,
  "base_subtotal_incl_tax": 42.0,
  "base_tax_amount": 42.0,
  "base_to_global_rate": 42.0,
  "base_to_order_rate": 42.0,
  "billing_address_id": 42,
  "created_at": "string",
  "creditmemo_status": 42,
  "discount_amount": 42.0,
  "discount_description": "string",
  "email_sent": 42,
  "entity_id": 42,
  "global_currency_code": "string",
  "grand_total": 42.0,
  "discount_tax_compensation_amount": 42.0,
  "increment_id": "string",
  "invoice_id": 42,
  "order_currency_code": "string",
  "order_id": 42,
  "shipping_address_id": 42,
  "shipping_amount": 42.0,
  "shipping_discount_tax_compensation_amount": 42.0,
  "shipping_incl_tax": 42.0,
  "shipping_tax_amount": 42.0,
  "state": 42,
  "store_currency_code": "string",
  "store_id": 42,
  "store_to_base_rate": 42.0,
  "store_to_order_rate": 42.0,
  "subtotal": 42.0,
  "subtotal_incl_tax": 42.0,
  "tax_amount": 42.0,
  "transaction_id": "string",
  "updated_at": "string",
  "items": [
    {
      "additional_data": "string",
      "base_cost": 42.0,
      "base_discount_amount": 42.0,
      "base_discount_tax_compensation_amount": 42.0,
      "base_price": 42.0,
      "base_price_incl_tax": 42.0,
      "base_row_total": 42.0,
      "base_row_total_incl_tax": 42.0,
      "base_tax_amount": 42.0,
      "base_weee_tax_applied_amount": 42.0,
      "base_weee_tax_applied_row_amnt": 42.0,
      "base_weee_tax_disposition": 42.0,
      "base_weee_tax_row_disposition": 42.0,
      "description": "string",
      "discount_amount": 42.0,
      "entity_id": 42,
      "discount_tax_compensation_amount": 42.0,
      "name": "string",
      "order_item_id": 42,
      "parent_id": 42,
      "price": 42.0,
      "price_incl_tax": 42.0,
      "product_id": 42,
      "qty": 42.0,
      "row_total": 42.0,
      "row_total_incl_tax": 42.0,
      "sku": "string",
      "tax_amount": 42.0,
      "weee_tax_applied": "string",
      "weee_tax_applied_amount": 42.0,
      "weee_tax_applied_row_amount": 42.0,
      "weee_tax_disposition": 42.0,
      "weee_tax_row_disposition": 42.0,
      "extension_attributes": {
        "status": "string",
        "list_price": 42.0,
        "size": "string",
        "color": "string",
        "merchant_product_reference": "string",
        "category_code": "string",
        "image": "string",
        "mpn": "string",
        "msrp": 42.0,
        "manufacturer_code": "string",
        "manufacturer_name": "string",
        "merchant_code": "string",
        "merchant_name": "string",
        "merchant_city": "string",
        "merchant_commission_percentage": 42.0,
        "merchant_deficiency_percentage": 42.0,
        "merchant_handling_fee": 42.0,
        "is_sale": true,
        "return_item_fee": 42.0,
        "base_return_item_fee": 42.0,
        "is_outlet": true
      }
    }
  ],
  "comments": [
    {
      "comment": "string",
      "created_at": "string",
      "entity_id": 42,
      "is_customer_notified": 42,
      "is_visible_on_front": 42,
      "parent_id": 42,
      "extension_attributes": {}
    }
  ],
  "extension_attributes": {
    "base_customer_balance_amount": 42.0,
    "customer_balance_amount": 42.0,
    "base_gift_cards_amount": 42.0,
    "gift_cards_amount": 42.0,
    "gw_base_price": "string",
    "gw_price": "string",
    "gw_items_base_price": "string",
    "gw_items_price": "string",
    "gw_card_base_price": "string",
    "gw_card_price": "string",
    "gw_base_tax_amount": "string",
    "gw_tax_amount": "string",
    "gw_items_base_tax_amount": "string",
    "gw_items_tax_amount": "string",
    "gw_card_base_tax_amount": "string",
    "gw_card_tax_amount": "string",
    "return_fee": 42.0,
    "base_return_fee": 42.0,
    "psp_reference": "string",
    "company_id": 42
  }
}
Response examples (200) 
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <adjustment type="float">42.0</adjustment>
  <adjustment-negative type="float">42.0</adjustment-negative>
  <adjustment-positive type="float">42.0</adjustment-positive>
  <base-adjustment type="float">42.0</base-adjustment>
  <base-adjustment-negative type="float">42.0</base-adjustment-negative>
  <base-adjustment-positive type="float">42.0</base-adjustment-positive>
  <base-currency-code>string</base-currency-code>
  <base-discount-amount type="float">42.0</base-discount-amount>
  <base-grand-total type="float">42.0</base-grand-total>
  <base-discount-tax-compensation-amount type="float">42.0</base-discount-tax-compensation-amount>
  <base-shipping-amount type="float">42.0</base-shipping-amount>
  <base-shipping-discount-tax-compensation-amnt type="float">42.0</base-shipping-discount-tax-compensation-amnt>
  <base-shipping-incl-tax type="float">42.0</base-shipping-incl-tax>
  <base-shipping-tax-amount type="float">42.0</base-shipping-tax-amount>
  <base-subtotal type="float">42.0</base-subtotal>
  <base-subtotal-incl-tax type="float">42.0</base-subtotal-incl-tax>
  <base-tax-amount type="float">42.0</base-tax-amount>
  <base-to-global-rate type="float">42.0</base-to-global-rate>
  <base-to-order-rate type="float">42.0</base-to-order-rate>
  <billing-address-id type="integer">42</billing-address-id>
  <created-at>string</created-at>
  <creditmemo-status type="integer">42</creditmemo-status>
  <discount-amount type="float">42.0</discount-amount>
  <discount-description>string</discount-description>
  <email-sent type="integer">42</email-sent>
  <entity-id type="integer">42</entity-id>
  <global-currency-code>string</global-currency-code>
  <grand-total type="float">42.0</grand-total>
  <discount-tax-compensation-amount type="float">42.0</discount-tax-compensation-amount>
  <increment-id>string</increment-id>
  <invoice-id type="integer">42</invoice-id>
  <order-currency-code>string</order-currency-code>
  <order-id type="integer">42</order-id>
  <shipping-address-id type="integer">42</shipping-address-id>
  <shipping-amount type="float">42.0</shipping-amount>
  <shipping-discount-tax-compensation-amount type="float">42.0</shipping-discount-tax-compensation-amount>
  <shipping-incl-tax type="float">42.0</shipping-incl-tax>
  <shipping-tax-amount type="float">42.0</shipping-tax-amount>
  <state type="integer">42</state>
  <store-currency-code>string</store-currency-code>
  <store-id type="integer">42</store-id>
  <store-to-base-rate type="float">42.0</store-to-base-rate>
  <store-to-order-rate type="float">42.0</store-to-order-rate>
  <subtotal type="float">42.0</subtotal>
  <subtotal-incl-tax type="float">42.0</subtotal-incl-tax>
  <tax-amount type="float">42.0</tax-amount>
  <transaction-id>string</transaction-id>
  <updated-at>string</updated-at>
  <items type="array">
    <item>
      <additional-data>string</additional-data>
      <base-cost type="float">42.0</base-cost>
      <base-discount-amount type="float">42.0</base-discount-amount>
      <base-discount-tax-compensation-amount type="float">42.0</base-discount-tax-compensation-amount>
      <base-price type="float">42.0</base-price>
      <base-price-incl-tax type="float">42.0</base-price-incl-tax>
      <base-row-total type="float">42.0</base-row-total>
      <base-row-total-incl-tax type="float">42.0</base-row-total-incl-tax>
      <base-tax-amount type="float">42.0</base-tax-amount>
      <base-weee-tax-applied-amount type="float">42.0</base-weee-tax-applied-amount>
      <base-weee-tax-applied-row-amnt type="float">42.0</base-weee-tax-applied-row-amnt>
      <base-weee-tax-disposition type="float">42.0</base-weee-tax-disposition>
      <base-weee-tax-row-disposition type="float">42.0</base-weee-tax-row-disposition>
      <description>string</description>
      <discount-amount type="float">42.0</discount-amount>
      <entity-id type="integer">42</entity-id>
      <discount-tax-compensation-amount type="float">42.0</discount-tax-compensation-amount>
      <name>string</name>
      <order-item-id type="integer">42</order-item-id>
      <parent-id type="integer">42</parent-id>
      <price type="float">42.0</price>
      <price-incl-tax type="float">42.0</price-incl-tax>
      <product-id type="integer">42</product-id>
      <qty type="float">42.0</qty>
      <row-total type="float">42.0</row-total>
      <row-total-incl-tax type="float">42.0</row-total-incl-tax>
      <sku>string</sku>
      <tax-amount type="float">42.0</tax-amount>
      <weee-tax-applied>string</weee-tax-applied>
      <weee-tax-applied-amount type="float">42.0</weee-tax-applied-amount>
      <weee-tax-applied-row-amount type="float">42.0</weee-tax-applied-row-amount>
      <weee-tax-disposition type="float">42.0</weee-tax-disposition>
      <weee-tax-row-disposition type="float">42.0</weee-tax-row-disposition>
      <extension-attributes>
        <status>string</status>
        <list-price type="float">42.0</list-price>
        <size>string</size>
        <color>string</color>
        <merchant-product-reference>string</merchant-product-reference>
        <category-code>string</category-code>
        <image>string</image>
        <mpn>string</mpn>
        <msrp type="float">42.0</msrp>
        <manufacturer-code>string</manufacturer-code>
        <manufacturer-name>string</manufacturer-name>
        <merchant-code>string</merchant-code>
        <merchant-name>string</merchant-name>
        <merchant-city>string</merchant-city>
        <merchant-commission-percentage type="float">42.0</merchant-commission-percentage>
        <merchant-deficiency-percentage type="float">42.0</merchant-deficiency-percentage>
        <merchant-handling-fee type="float">42.0</merchant-handling-fee>
        <is-sale type="boolean">true</is-sale>
        <return-item-fee type="float">42.0</return-item-fee>
        <base-return-item-fee type="float">42.0</base-return-item-fee>
        <is-outlet type="boolean">true</is-outlet>
      </extension-attributes>
    </item>
  </items>
  <comments type="array">
    <comment>
      <comment>string</comment>
      <created-at>string</created-at>
      <entity-id type="integer">42</entity-id>
      <is-customer-notified type="integer">42</is-customer-notified>
      <is-visible-on-front type="integer">42</is-visible-on-front>
      <parent-id type="integer">42</parent-id>
      <extension-attributes>
      </extension-attributes>
    </comment>
  </comments>
  <extension-attributes>
    <base-customer-balance-amount type="float">42.0</base-customer-balance-amount>
    <customer-balance-amount type="float">42.0</customer-balance-amount>
    <base-gift-cards-amount type="float">42.0</base-gift-cards-amount>
    <gift-cards-amount type="float">42.0</gift-cards-amount>
    <gw-base-price>string</gw-base-price>
    <gw-price>string</gw-price>
    <gw-items-base-price>string</gw-items-base-price>
    <gw-items-price>string</gw-items-price>
    <gw-card-base-price>string</gw-card-base-price>
    <gw-card-price>string</gw-card-price>
    <gw-base-tax-amount>string</gw-base-tax-amount>
    <gw-tax-amount>string</gw-tax-amount>
    <gw-items-base-tax-amount>string</gw-items-base-tax-amount>
    <gw-items-tax-amount>string</gw-items-tax-amount>
    <gw-card-base-tax-amount>string</gw-card-base-tax-amount>
    <gw-card-tax-amount>string</gw-card-tax-amount>
    <return-fee type="float">42.0</return-fee>
    <base-return-fee type="float">42.0</base-return-fee>
    <psp-reference>string</psp-reference>
    <company-id type="integer">42</company-id>
  </extension-attributes>
</root>
Response examples (401) 
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}
Response examples (401) 
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>
Response examples (default) 
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}
Response examples (default) 
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>