setCustomAttributesOnCreditMemo mutation

The setCustomAttributesOnCreditMemo mutation sets custom attributes on a credit memo. The mutation accepts a credit memo ID and an array of custom attribute key/value pairs. It returns the updated credit memo. All ID values are treated as strings.

To remove a custom attribute, rerun the mutation without the previously applied custom attribute.

Syntax

Copy
mutation {
  setCustomAttributesOnCreditMemo(
    input: CreditMemoCustomAttributesInput
  ){    
    CreditMemoOutput
  }
}
Copied to your clipboard
mutation {
  setCustomAttributesOnCreditMemo(
    input: CreditMemoCustomAttributesInput
  ){    
    CreditMemoOutput
  }
}

Reference

The setCustomAttributesOnCreditMemo reference provides detailed information about the types and fields defined in this mutation.

Example usage

The following example sets two custom attributes on a credit memo with the ID MzQ=.

Request:

Copy
mutation {
  setCustomAttributesOnCreditMemo(
     input: {
       credit_memo_id: "MzQ=",
       custom_attributes: [
        {
          attribute_code: "attribute_one",
          value: "value_one"
        },
        {
          attribute_code: "attribute_two",
          value: "value_two"
        },
      ]
     }
    
  ), {
     credit_memo {
       id
       custom_attributes {
         attribute_code
         value
       }
   }
  }
}
Copied to your clipboard
mutation {
  setCustomAttributesOnCreditMemo(
     input: {
       credit_memo_id: "MzQ=",
       custom_attributes: [
        {
          attribute_code: "attribute_one",
          value: "value_one"
        },
        {
          attribute_code: "attribute_two",
          value: "value_two"
        },
      ]
     }
    
  ), {
     credit_memo {
       id
       custom_attributes {
         attribute_code
         value
       }
   }
  }
}

Response:

Copy
{
  "data": {
    "setCustomAttributesOnCreditMemo": {
      "credit_memo": {
        "id": "MzQ=",
        "custom_attributes": [
          {
            "attribute_code": "attribute_one",
            "value": "value_one"
          },
          {
            "attribute_code": "attribute_two",
            "value": "value_two"
          }
        ]
      }
    }
  }
}
Copied to your clipboard
{
  "data": {
    "setCustomAttributesOnCreditMemo": {
      "credit_memo": {
        "id": "MzQ=",
        "custom_attributes": [
          {
            "attribute_code": "attribute_one",
            "value": "value_one"
          },
          {
            "attribute_code": "attribute_two",
            "value": "value_two"
          }
        ]
      }
    }
  }
}

Last updated 6/10/2025

Was this helpful?

Yes

No