InvoiceItemInterface attributes and implementations

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

Attributes

The InvoiceItemInterface describes a specific invoice.

Attribute Data type Description
discounts [Discount] Contains information about the final discount amount for the base product, including discounts on options
id ID! The unique ID of the invoice item
order_item OrderItemInterface Contains details about an individual order item
product_name String The name of the base product
product_sale_price Money! The sale price for the base product including selected options
product_sku String! The SKU of the base product
quantity_invoiced Float The number of invoiced items

Implementations

BundleInvoiceItem attributes

The BundleInvoiceItem object defines the following attribute:

Attribute Data type Description
bundle_options [ItemSelectedBundleOption] A list of bundle options that are assigned to the bundle product

ItemSelectedBundleOption attributes

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

Attribute Data type Description
id ID! The unique identifier of the option
label String! The label of the option
values [ItemSelectedBundleOptionValue] A list of products that represent the values of the parent option

ItemSelectedBundleOptionValue attributes

Attribute Data type Description
id ID! The unique identifier of the option
price Money! The price of the child bundle product
product_name String! The name of the child bundle product
product_sku String! The SKU of the child bundle product
quantity Float! Indicates how many of this bundle product were ordered

DownloadableInvoiceItem attributes

The DownloadableInvoiceItem object defines the following attribute:

Attribute Data type Description
downloadable_links [DownloadableItemsLinks] A list of downloadable links from the invoiced downloadable product

The DownloadableItemsLinks object defines characteristics of a downloadable product.

Attribute Data type Description
sort_order Int A number indicating the sort order
title String The display name of the link
uid ID! A string that encodes option details

GiftCardInvoiceItem attributes

The GiftCardInvoiceItem object defines the following attribute:

Attribute Data type Description
gift_card GiftCardItem Selected gift card properties for an invoiced item

GiftCardItem attributes

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

Attribute Data type Description
message String A message provided by the sender to the recipient
recipient_email String The email provided for the recipient of a virtual gift card
recipient_name String The name provided for the recipient of a physical or virtual gift card
sender_email String The sender email provided for a virtual gift card
sender_name String The sender name provided for a physical or virtual gift card

InvoiceItem attributes

The InvoiceItem object does not introduce any additional attributes to InvoiceItemInterface.

Example usage

The following query returns invoice details about order ID 000000005. The BundleOrderItem and DownloadableOrderItem fragments return item-specific information.

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
{
  customer {
    firstname
    lastname
    email
    orders(
      filter: {
        number: {
          match: "000000005"
        }
      }) {
      items {
        id
        invoices {
          id
          items {
            id
            product_sku
            product_name
            quantity_invoiced
            ... on BundleInvoiceItem {
              bundle_options {
                id
                values {
                  id
                  product_name
                  product_sku
                  quantity
                  price {
                    value
                    currency
                  }
                }
              }
            }
            ... on DownloadableInvoiceItem {
              id
              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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
{
  "data": {
    "customer": {
      "firstname": "Roni",
      "lastname": "Costello",
      "email": "roni_cost@example.com",
      "orders": {
        "items": [
          {
            "id": "NQ==",
            "invoices": [
              {
                "id": "NA==",
                "items": [
                  {
                    "id": "OQ==",
                    "product_sku": "240-LV06",
                    "product_name": "Yoga Adventure",
                    "quantity_invoiced": 1,
                    "downloadable_links": [
                      {
                        "uid": "ZG93bmxvYWRhYmxlLzM=",
                        "title": "Yoga Adventure"
                      }
                    ]
                  },
                  {
                    "id": "MTA=",
                    "product_sku": "24-WG080-24-WG082-blue-24-WG084-24-WG087-24-WG088",
                    "product_name": "Sprite Yoga Companion Kit",
                    "quantity_invoiced": 1,
                    "bundle_options": [
                      {
                        "id": "Mg==",
                        "values": [
                          {
                            "id": "MTg=",
                            "product_name": "Sprite Foam Yoga Brick",
                            "product_sku": "24-WG084",
                            "quantity": 1,
                            "price": {
                              "value": 5,
                              "currency": "USD"
                            }
                          }
                        ]
                      },
                      {
                        "id": "NA==",
                        "values": [
                          {
                            "id": "MjA=",
                            "product_name": "Sprite Foam Roller",
                            "product_sku": "24-WG088",
                            "quantity": 1,
                            "price": {
                              "value": 19,
                              "currency": "USD"
                            }
                          }
                        ]
                      },
                      {
                        "id": "MQ==",
                        "values": [
                          {
                            "id": "MTc=",
                            "product_name": "Sprite Stasis Ball 65 cm",
                            "product_sku": "24-WG082-blue",
                            "quantity": 1,
                            "price": {
                              "value": 27,
                              "currency": "USD"
                            }
                          }
                        ]
                      },
                      {
                        "id": "Mw==",
                        "values": [
                          {
                            "id": "MTk=",
                            "product_name": "Sprite Yoga Strap 10 foot",
                            "product_sku": "24-WG087",
                            "quantity": 1,
                            "price": {
                              "value": 21,
                              "currency": "USD"
                            }
                          }
                        ]
                      }
                    ]
                  },
                  {
                    "id": "MTU=",
                    "product_sku": "WS12-XS-Orange",
                    "product_name": "Radiant Tee",
                    "quantity_invoiced": 1
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  }
}