ShipmentItemInterface attributes and implementations

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

Attributes

The ShipmentItemInterface describes a specific shipmemt.

Attribute Data type Description
id ID! The unique ID of the shipment item
order_item OrderItemInterface The shipped order item
product_name String The name of the base product
product_sale_price Money! The sale price for the base product
product_sku String! The SKU of the base product
quantity_shipped Float! The number of shipped items

Implementations

BundleShipmentItem attributes

The BundleShipmentItem 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

GiftCardShipmentItem attributes

The GiftCardShipmentItem object defines the following attribute:

Attribute Data type Description
gift_card GiftCardItem Selected properties for a shipped gift card

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

ShipmentItem attributes

The ShipmentItem object does not introduce any additional attributes to ShipmentItemInterface.

Example usage

The following query returns shipping details about order ID 000000005. The BundleOrderItem fragment returns item-specific information. The order also included a downloadable product, but downloadable products are not shipped.

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
{
  customer {
    firstname
    lastname
    email
    orders(
      filter: {
        number: {
          match: "000000005"
        }
      }) {
      items {
        id
        shipments {
          id
          items {
            id
            product_sku
            product_name
            ... on BundleShipmentItem {
              bundle_options {
                id
                values {
                  id
                  product_name
                  product_sku
                  quantity
                  price {
                    value
                    currency
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

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
{
  "data": {
    "customer": {
      "firstname": "Roni",
      "lastname": "Costello",
      "email": "roni_cost@example.com",
      "orders": {
        "items": [
          {
            "id": "NQ==",
            "shipments": [
              {
                "id": "MDAwMDAwMDA0",
                "items": [
                  {
                    "id": "Ng==",
                    "product_sku": "24-WG080-24-WG082-blue-24-WG084-24-WG087-24-WG088",
                    "product_name": "Sprite Yoga Companion Kit",
                    "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": "Nw==",
                    "product_sku": "WS12-XS-Orange",
                    "product_name": "Radiant Tee"
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  }
}