Creditmemo

sales Creditmemo Repository V1Get Get

get

Loads a specified credit memo.

Path parameters
idstringRequired

(Required) The credit memo ID.

Example: <integer>
Responses
200

OK

application/json
Responseobject
get
GET /V1/creditmemo/{id} HTTP/1.1
Host: {{baseurl}}
Accept: */*

{
  "order_id": "<integer>",
  "items": [
    {
      "base_cost": "<number>",
      "base_price": "<number>",
      "entity_id": "<integer>",
      "order_item_id": "<integer>",
      "qty": "<number>",
      "additional_data": "<string>",
      "base_discount_amount": "<number>",
      "base_discount_tax_compensation_amount": "<number>",
      "base_price_incl_tax": "<number>",
      "base_row_total": "<number>",
      "base_row_total_incl_tax": "<number>",
      "base_tax_amount": "<number>",
      "base_weee_tax_applied_amount": "<number>",
      "base_weee_tax_applied_row_amnt": "<number>",
      "base_weee_tax_disposition": "<number>",
      "base_weee_tax_row_disposition": "<number>",
      "description": "<string>",
      "discount_amount": "<number>",
      "discount_tax_compensation_amount": "<number>",
      "name": "<string>",
      "parent_id": "<integer>",
      "price": "<number>",
      "price_incl_tax": "<number>",
      "product_id": "<integer>",
      "row_total": "<number>",
      "row_total_incl_tax": "<number>",
      "sku": "<string>",
      "tax_amount": "<number>",
      "weee_tax_applied": "<string>",
      "weee_tax_applied_amount": "<number>",
      "weee_tax_applied_row_amount": "<number>",
      "weee_tax_disposition": "<number>",
      "weee_tax_row_disposition": "<number>",
      "extension_attributes": {
        "vertex_tax_codes": [
          "<string>",
          "<string>"
        ],
        "invoice_text_codes": [
          "<string>",
          "<string>"
        ],
        "tax_codes": [
          "<string>",
          "<string>"
        ]
      }
    },
    {
      "base_cost": "<number>",
      "base_price": "<number>",
      "entity_id": "<integer>",
      "order_item_id": "<integer>",
      "qty": "<number>",
      "additional_data": "<string>",
      "base_discount_amount": "<number>",
      "base_discount_tax_compensation_amount": "<number>",
      "base_price_incl_tax": "<number>",
      "base_row_total": "<number>",
      "base_row_total_incl_tax": "<number>",
      "base_tax_amount": "<number>",
      "base_weee_tax_applied_amount": "<number>",
      "base_weee_tax_applied_row_amnt": "<number>",
      "base_weee_tax_disposition": "<number>",
      "base_weee_tax_row_disposition": "<number>",
      "description": "<string>",
      "discount_amount": "<number>",
      "discount_tax_compensation_amount": "<number>",
      "name": "<string>",
      "parent_id": "<integer>",
      "price": "<number>",
      "price_incl_tax": "<number>",
      "product_id": "<integer>",
      "row_total": "<number>",
      "row_total_incl_tax": "<number>",
      "sku": "<string>",
      "tax_amount": "<number>",
      "weee_tax_applied": "<string>",
      "weee_tax_applied_amount": "<number>",
      "weee_tax_applied_row_amount": "<number>",
      "weee_tax_disposition": "<number>",
      "weee_tax_row_disposition": "<number>",
      "extension_attributes": {
        "vertex_tax_codes": [
          "<string>",
          "<string>"
        ],
        "invoice_text_codes": [
          "<string>",
          "<string>"
        ],
        "tax_codes": [
          "<string>",
          "<string>"
        ]
      }
    }
  ],
  "adjustment": "<number>",
  "adjustment_negative": "<number>",
  "adjustment_positive": "<number>",
  "base_adjustment": "<number>",
  "base_adjustment_negative": "<number>",
  "base_adjustment_positive": "<number>",
  "base_currency_code": "<string>",
  "base_discount_amount": "<number>",
  "base_grand_total": "<number>",
  "base_discount_tax_compensation_amount": "<number>",
  "base_shipping_amount": "<number>",
  "base_shipping_discount_tax_compensation_amnt": "<number>",
  "base_shipping_incl_tax": "<number>",
  "base_shipping_tax_amount": "<number>",
  "base_subtotal": "<number>",
  "base_subtotal_incl_tax": "<number>",
  "base_tax_amount": "<number>",
  "base_to_global_rate": "<number>",
  "base_to_order_rate": "<number>",
  "billing_address_id": "<integer>",
  "created_at": "<string>",
  "creditmemo_status": "<integer>",
  "discount_amount": "<number>",
  "discount_description": "<string>",
  "email_sent": "<integer>",
  "entity_id": "<integer>",
  "global_currency_code": "<string>",
  "grand_total": "<number>",
  "discount_tax_compensation_amount": "<number>",
  "increment_id": "<string>",
  "invoice_id": "<integer>",
  "order_currency_code": "<string>",
  "shipping_address_id": "<integer>",
  "shipping_amount": "<number>",
  "shipping_discount_tax_compensation_amount": "<number>",
  "shipping_incl_tax": "<number>",
  "shipping_tax_amount": "<number>",
  "state": "<integer>",
  "store_currency_code": "<string>",
  "store_id": "<integer>",
  "store_to_base_rate": "<number>",
  "store_to_order_rate": "<number>",
  "subtotal": "<number>",
  "subtotal_incl_tax": "<number>",
  "tax_amount": "<number>",
  "transaction_id": "<string>",
  "updated_at": "<string>",
  "comments": [
    {
      "comment": "<string>",
      "is_customer_notified": "<integer>",
      "is_visible_on_front": "<integer>",
      "parent_id": "<integer>",
      "created_at": "<string>",
      "entity_id": "<integer>",
      "extension_attributes": "<object>"
    },
    {
      "comment": "<string>",
      "is_customer_notified": "<integer>",
      "is_visible_on_front": "<integer>",
      "parent_id": "<integer>",
      "created_at": "<string>",
      "entity_id": "<integer>",
      "extension_attributes": "<object>"
    }
  ],
  "extension_attributes": {
    "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>"
  }
}

sales Creditmemo Management V1Cancel Put

put

Cancels a specified credit memo.

Path parameters
idstringRequired

(Required) The credit memo ID.

Example: <integer>
Body
Responses
200

OK

application/json
Responseobject
put
PUT /V1/creditmemo/{id} HTTP/1.1
Host: {{baseurl}}
Accept: */*

true

sales Creditmemo Repository V1Save Post

post

Performs persist operations for a specified credit memo.

Header parameters
Content-TypestringOptionalExample: application/json
Body
objectOptionalExample: {"entity":{"order_id":"<integer>","items":[{"base_cost":"<number>","base_price":"<number>","entity_id":"<integer>","order_item_id":"<integer>","qty":"<number>","additional_data":"<string>","base_discount_amount":"<number>","base_discount_tax_compensation_amount":"<number>","base_price_incl_tax":"<number>","base_row_total":"<number>","base_row_total_incl_tax":"<number>","base_tax_amount":"<number>","base_weee_tax_applied_amount":"<number>","base_weee_tax_applied_row_amnt":"<number>","base_weee_tax_disposition":"<number>","base_weee_tax_row_disposition":"<number>","description":"<string>","discount_amount":"<number>","discount_tax_compensation_amount":"<number>","name":"<string>","parent_id":"<integer>","price":"<number>","price_incl_tax":"<number>","product_id":"<integer>","row_total":"<number>","row_total_incl_tax":"<number>","sku":"<string>","tax_amount":"<number>","weee_tax_applied":"<string>","weee_tax_applied_amount":"<number>","weee_tax_applied_row_amount":"<number>","weee_tax_disposition":"<number>","weee_tax_row_disposition":"<number>","extension_attributes":{"vertex_tax_codes":["<string>","<string>"],"invoice_text_codes":["<string>","<string>"],"tax_codes":["<string>","<string>"]}},{"base_cost":"<number>","base_price":"<number>","entity_id":"<integer>","order_item_id":"<integer>","qty":"<number>","additional_data":"<string>","base_discount_amount":"<number>","base_discount_tax_compensation_amount":"<number>","base_price_incl_tax":"<number>","base_row_total":"<number>","base_row_total_incl_tax":"<number>","base_tax_amount":"<number>","base_weee_tax_applied_amount":"<number>","base_weee_tax_applied_row_amnt":"<number>","base_weee_tax_disposition":"<number>","base_weee_tax_row_disposition":"<number>","description":"<string>","discount_amount":"<number>","discount_tax_compensation_amount":"<number>","name":"<string>","parent_id":"<integer>","price":"<number>","price_incl_tax":"<number>","product_id":"<integer>","row_total":"<number>","row_total_incl_tax":"<number>","sku":"<string>","tax_amount":"<number>","weee_tax_applied":"<string>","weee_tax_applied_amount":"<number>","weee_tax_applied_row_amount":"<number>","weee_tax_disposition":"<number>","weee_tax_row_disposition":"<number>","extension_attributes":{"vertex_tax_codes":["<string>","<string>"],"invoice_text_codes":["<string>","<string>"],"tax_codes":["<string>","<string>"]}}],"adjustment":"<number>","adjustment_negative":"<number>","adjustment_positive":"<number>","base_adjustment":"<number>","base_adjustment_negative":"<number>","base_adjustment_positive":"<number>","base_currency_code":"<string>","base_discount_amount":"<number>","base_grand_total":"<number>","base_discount_tax_compensation_amount":"<number>","base_shipping_amount":"<number>","base_shipping_discount_tax_compensation_amnt":"<number>","base_shipping_incl_tax":"<number>","base_shipping_tax_amount":"<number>","base_subtotal":"<number>","base_subtotal_incl_tax":"<number>","base_tax_amount":"<number>","base_to_global_rate":"<number>","base_to_order_rate":"<number>","billing_address_id":"<integer>","created_at":"<string>","creditmemo_status":"<integer>","discount_amount":"<number>","discount_description":"<string>","email_sent":"<integer>","entity_id":"<integer>","global_currency_code":"<string>","grand_total":"<number>","discount_tax_compensation_amount":"<number>","increment_id":"<string>","invoice_id":"<integer>","order_currency_code":"<string>","shipping_address_id":"<integer>","shipping_amount":"<number>","shipping_discount_tax_compensation_amount":"<number>","shipping_incl_tax":"<number>","shipping_tax_amount":"<number>","state":"<integer>","store_currency_code":"<string>","store_id":"<integer>","store_to_base_rate":"<number>","store_to_order_rate":"<number>","subtotal":"<number>","subtotal_incl_tax":"<number>","tax_amount":"<number>","transaction_id":"<string>","updated_at":"<string>","comments":[{"comment":"<string>","is_customer_notified":"<integer>","is_visible_on_front":"<integer>","parent_id":"<integer>","created_at":"<string>","entity_id":"<integer>","extension_attributes":"<object>"},{"comment":"<string>","is_customer_notified":"<integer>","is_visible_on_front":"<integer>","parent_id":"<integer>","created_at":"<string>","entity_id":"<integer>","extension_attributes":"<object>"}],"extension_attributes":{"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>"}}}
Responses
200

OK

application/json
Responseobject
post
POST /V1/creditmemo HTTP/1.1
Host: {{baseurl}}
Content-Type: application/json
Accept: */*
Content-Length: 4686

{
  "entity": {
    "order_id": "<integer>",
    "items": [
      {
        "base_cost": "<number>",
        "base_price": "<number>",
        "entity_id": "<integer>",
        "order_item_id": "<integer>",
        "qty": "<number>",
        "additional_data": "<string>",
        "base_discount_amount": "<number>",
        "base_discount_tax_compensation_amount": "<number>",
        "base_price_incl_tax": "<number>",
        "base_row_total": "<number>",
        "base_row_total_incl_tax": "<number>",
        "base_tax_amount": "<number>",
        "base_weee_tax_applied_amount": "<number>",
        "base_weee_tax_applied_row_amnt": "<number>",
        "base_weee_tax_disposition": "<number>",
        "base_weee_tax_row_disposition": "<number>",
        "description": "<string>",
        "discount_amount": "<number>",
        "discount_tax_compensation_amount": "<number>",
        "name": "<string>",
        "parent_id": "<integer>",
        "price": "<number>",
        "price_incl_tax": "<number>",
        "product_id": "<integer>",
        "row_total": "<number>",
        "row_total_incl_tax": "<number>",
        "sku": "<string>",
        "tax_amount": "<number>",
        "weee_tax_applied": "<string>",
        "weee_tax_applied_amount": "<number>",
        "weee_tax_applied_row_amount": "<number>",
        "weee_tax_disposition": "<number>",
        "weee_tax_row_disposition": "<number>",
        "extension_attributes": {
          "vertex_tax_codes": [
            "<string>",
            "<string>"
          ],
          "invoice_text_codes": [
            "<string>",
            "<string>"
          ],
          "tax_codes": [
            "<string>",
            "<string>"
          ]
        }
      },
      {
        "base_cost": "<number>",
        "base_price": "<number>",
        "entity_id": "<integer>",
        "order_item_id": "<integer>",
        "qty": "<number>",
        "additional_data": "<string>",
        "base_discount_amount": "<number>",
        "base_discount_tax_compensation_amount": "<number>",
        "base_price_incl_tax": "<number>",
        "base_row_total": "<number>",
        "base_row_total_incl_tax": "<number>",
        "base_tax_amount": "<number>",
        "base_weee_tax_applied_amount": "<number>",
        "base_weee_tax_applied_row_amnt": "<number>",
        "base_weee_tax_disposition": "<number>",
        "base_weee_tax_row_disposition": "<number>",
        "description": "<string>",
        "discount_amount": "<number>",
        "discount_tax_compensation_amount": "<number>",
        "name": "<string>",
        "parent_id": "<integer>",
        "price": "<number>",
        "price_incl_tax": "<number>",
        "product_id": "<integer>",
        "row_total": "<number>",
        "row_total_incl_tax": "<number>",
        "sku": "<string>",
        "tax_amount": "<number>",
        "weee_tax_applied": "<string>",
        "weee_tax_applied_amount": "<number>",
        "weee_tax_applied_row_amount": "<number>",
        "weee_tax_disposition": "<number>",
        "weee_tax_row_disposition": "<number>",
        "extension_attributes": {
          "vertex_tax_codes": [
            "<string>",
            "<string>"
          ],
          "invoice_text_codes": [
            "<string>",
            "<string>"
          ],
          "tax_codes": [
            "<string>",
            "<string>"
          ]
        }
      }
    ],
    "adjustment": "<number>",
    "adjustment_negative": "<number>",
    "adjustment_positive": "<number>",
    "base_adjustment": "<number>",
    "base_adjustment_negative": "<number>",
    "base_adjustment_positive": "<number>",
    "base_currency_code": "<string>",
    "base_discount_amount": "<number>",
    "base_grand_total": "<number>",
    "base_discount_tax_compensation_amount": "<number>",
    "base_shipping_amount": "<number>",
    "base_shipping_discount_tax_compensation_amnt": "<number>",
    "base_shipping_incl_tax": "<number>",
    "base_shipping_tax_amount": "<number>",
    "base_subtotal": "<number>",
    "base_subtotal_incl_tax": "<number>",
    "base_tax_amount": "<number>",
    "base_to_global_rate": "<number>",
    "base_to_order_rate": "<number>",
    "billing_address_id": "<integer>",
    "created_at": "<string>",
    "creditmemo_status": "<integer>",
    "discount_amount": "<number>",
    "discount_description": "<string>",
    "email_sent": "<integer>",
    "entity_id": "<integer>",
    "global_currency_code": "<string>",
    "grand_total": "<number>",
    "discount_tax_compensation_amount": "<number>",
    "increment_id": "<string>",
    "invoice_id": "<integer>",
    "order_currency_code": "<string>",
    "shipping_address_id": "<integer>",
    "shipping_amount": "<number>",
    "shipping_discount_tax_compensation_amount": "<number>",
    "shipping_incl_tax": "<number>",
    "shipping_tax_amount": "<number>",
    "state": "<integer>",
    "store_currency_code": "<string>",
    "store_id": "<integer>",
    "store_to_base_rate": "<number>",
    "store_to_order_rate": "<number>",
    "subtotal": "<number>",
    "subtotal_incl_tax": "<number>",
    "tax_amount": "<number>",
    "transaction_id": "<string>",
    "updated_at": "<string>",
    "comments": [
      {
        "comment": "<string>",
        "is_customer_notified": "<integer>",
        "is_visible_on_front": "<integer>",
        "parent_id": "<integer>",
        "created_at": "<string>",
        "entity_id": "<integer>",
        "extension_attributes": "<object>"
      },
      {
        "comment": "<string>",
        "is_customer_notified": "<integer>",
        "is_visible_on_front": "<integer>",
        "parent_id": "<integer>",
        "created_at": "<string>",
        "entity_id": "<integer>",
        "extension_attributes": "<object>"
      }
    ],
    "extension_attributes": {
      "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>"
    }
  }
}
{
  "order_id": "<integer>",
  "items": [
    {
      "base_cost": "<number>",
      "base_price": "<number>",
      "entity_id": "<integer>",
      "order_item_id": "<integer>",
      "qty": "<number>",
      "additional_data": "<string>",
      "base_discount_amount": "<number>",
      "base_discount_tax_compensation_amount": "<number>",
      "base_price_incl_tax": "<number>",
      "base_row_total": "<number>",
      "base_row_total_incl_tax": "<number>",
      "base_tax_amount": "<number>",
      "base_weee_tax_applied_amount": "<number>",
      "base_weee_tax_applied_row_amnt": "<number>",
      "base_weee_tax_disposition": "<number>",
      "base_weee_tax_row_disposition": "<number>",
      "description": "<string>",
      "discount_amount": "<number>",
      "discount_tax_compensation_amount": "<number>",
      "name": "<string>",
      "parent_id": "<integer>",
      "price": "<number>",
      "price_incl_tax": "<number>",
      "product_id": "<integer>",
      "row_total": "<number>",
      "row_total_incl_tax": "<number>",
      "sku": "<string>",
      "tax_amount": "<number>",
      "weee_tax_applied": "<string>",
      "weee_tax_applied_amount": "<number>",
      "weee_tax_applied_row_amount": "<number>",
      "weee_tax_disposition": "<number>",
      "weee_tax_row_disposition": "<number>",
      "extension_attributes": {
        "vertex_tax_codes": [
          "<string>",
          "<string>"
        ],
        "invoice_text_codes": [
          "<string>",
          "<string>"
        ],
        "tax_codes": [
          "<string>",
          "<string>"
        ]
      }
    },
    {
      "base_cost": "<number>",
      "base_price": "<number>",
      "entity_id": "<integer>",
      "order_item_id": "<integer>",
      "qty": "<number>",
      "additional_data": "<string>",
      "base_discount_amount": "<number>",
      "base_discount_tax_compensation_amount": "<number>",
      "base_price_incl_tax": "<number>",
      "base_row_total": "<number>",
      "base_row_total_incl_tax": "<number>",
      "base_tax_amount": "<number>",
      "base_weee_tax_applied_amount": "<number>",
      "base_weee_tax_applied_row_amnt": "<number>",
      "base_weee_tax_disposition": "<number>",
      "base_weee_tax_row_disposition": "<number>",
      "description": "<string>",
      "discount_amount": "<number>",
      "discount_tax_compensation_amount": "<number>",
      "name": "<string>",
      "parent_id": "<integer>",
      "price": "<number>",
      "price_incl_tax": "<number>",
      "product_id": "<integer>",
      "row_total": "<number>",
      "row_total_incl_tax": "<number>",
      "sku": "<string>",
      "tax_amount": "<number>",
      "weee_tax_applied": "<string>",
      "weee_tax_applied_amount": "<number>",
      "weee_tax_applied_row_amount": "<number>",
      "weee_tax_disposition": "<number>",
      "weee_tax_row_disposition": "<number>",
      "extension_attributes": {
        "vertex_tax_codes": [
          "<string>",
          "<string>"
        ],
        "invoice_text_codes": [
          "<string>",
          "<string>"
        ],
        "tax_codes": [
          "<string>",
          "<string>"
        ]
      }
    }
  ],
  "adjustment": "<number>",
  "adjustment_negative": "<number>",
  "adjustment_positive": "<number>",
  "base_adjustment": "<number>",
  "base_adjustment_negative": "<number>",
  "base_adjustment_positive": "<number>",
  "base_currency_code": "<string>",
  "base_discount_amount": "<number>",
  "base_grand_total": "<number>",
  "base_discount_tax_compensation_amount": "<number>",
  "base_shipping_amount": "<number>",
  "base_shipping_discount_tax_compensation_amnt": "<number>",
  "base_shipping_incl_tax": "<number>",
  "base_shipping_tax_amount": "<number>",
  "base_subtotal": "<number>",
  "base_subtotal_incl_tax": "<number>",
  "base_tax_amount": "<number>",
  "base_to_global_rate": "<number>",
  "base_to_order_rate": "<number>",
  "billing_address_id": "<integer>",
  "created_at": "<string>",
  "creditmemo_status": "<integer>",
  "discount_amount": "<number>",
  "discount_description": "<string>",
  "email_sent": "<integer>",
  "entity_id": "<integer>",
  "global_currency_code": "<string>",
  "grand_total": "<number>",
  "discount_tax_compensation_amount": "<number>",
  "increment_id": "<string>",
  "invoice_id": "<integer>",
  "order_currency_code": "<string>",
  "shipping_address_id": "<integer>",
  "shipping_amount": "<number>",
  "shipping_discount_tax_compensation_amount": "<number>",
  "shipping_incl_tax": "<number>",
  "shipping_tax_amount": "<number>",
  "state": "<integer>",
  "store_currency_code": "<string>",
  "store_id": "<integer>",
  "store_to_base_rate": "<number>",
  "store_to_order_rate": "<number>",
  "subtotal": "<number>",
  "subtotal_incl_tax": "<number>",
  "tax_amount": "<number>",
  "transaction_id": "<string>",
  "updated_at": "<string>",
  "comments": [
    {
      "comment": "<string>",
      "is_customer_notified": "<integer>",
      "is_visible_on_front": "<integer>",
      "parent_id": "<integer>",
      "created_at": "<string>",
      "entity_id": "<integer>",
      "extension_attributes": "<object>"
    },
    {
      "comment": "<string>",
      "is_customer_notified": "<integer>",
      "is_visible_on_front": "<integer>",
      "parent_id": "<integer>",
      "created_at": "<string>",
      "entity_id": "<integer>",
      "extension_attributes": "<object>"
    }
  ],
  "extension_attributes": {
    "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>"
  }
}
Previous/NextComments