CreditMemoItemInterface attributes and implementations

CreditMemoItemInterface provides details about items in a customer’s order history that were refunded. It has the following implementations:

• BundleCreditMemoItem
• CreditMemoItem
• DownloadableCreditMemoItem
• GiftCardCreditMemoItem

Attributes

The CreditMemoItemInterface describes a specific credit memo.

Implementations

BundleCreditMemoItem attributes

The BundleCreditMemoItem object defines the following attribute:

ItemSelectedBundleOption attributes

The ItemSelectedBundleOption object contains a list of bundle options that are assigned to the bundle product.

ItemSelectedBundleOptionValue attributes

CreditMemoItem attributes

The CreditMemoItem object does not introduce any additional attributes to CreditMemoItemInterface.

DownloadableCreditMemoItem attributes

The DownloadableCreditMemoItem object defines the following attribute:

DownloadableItemsLinks attributes

The DownloadableItemsLinks object defines characteristics of a downloadable product.

GiftCardCreditMemoItem attributes

The GiftCardCreditMemoItem object defines the following attribute:

GiftCardItem attributes

The GiftCardItem object contains selected buyer-entered gift card properties for an order item.

Example usage

The following query returns items that were refunded in order ID 000000005. The BundleOrderItem and DownloadableOrderItem fragments can contain item-specific information, but the only refunded item is a configurable product.

Request:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
  customer {
    firstname
    lastname
    email
    orders(
      filter: {
        number: {
          match: "000000005"
        }
      }) {
      items {
        id
        credit_memos {
          id
          items {
            id
            product_sku
            product_name
            order_item {
              product_type
            }
            quantity_refunded
            ... on BundleCreditMemoItem {
              bundle_options {
                id
                values {
                  id
                  product_name
                  product_sku
                  quantity
                  price {
                    value
                    currency
                  }
                }
              }
            }
            ... on DownloadableCreditMemoItem {
              downloadable_links {
                uid
                title
              }
            }
          }
        }
      }
    }
  }
}

Response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{
  "data": {
    "customer": {
      "firstname": "Roni",
      "lastname": "Costello",
      "email": "roni_cost@example.com",
      "orders": {
        "items": [
          {
            "id": "NQ==",
            "credit_memos": [
              {
                "id": "Mg==",
                "items": [
                  {
                    "id": "Mg==",
                    "product_sku": "WS12-XS-Orange",
                    "product_name": "Radiant Tee",
                    "order_item": {
                      "product_type": "configurable"
                    },
                    "quantity_refunded": 1
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  }
}