@@ -43,23 +43,23 @@ Attribute | Data type | Description
43
43
--- | --- | ---
44
44
` billing_address ` | [ OrderAddress] ( #OrderAddress ) | The billing address for the order
45
45
` carrier ` | String | The shipping carrier for the order delivery
46
- ` comments ` | [[ SalesCommentItem] ( #SalesCommentItem )] | Comments on the order
46
+ ` comments ` | [[ SalesCommentItem]] ( #SalesCommentItem ) | Comments on the order
47
47
` created_at ` | String | Deprecated. Use the ` order_date ` attribute instead
48
- ` credit_memos ` | [[ CreditMemo] ( #CreditMemo )] | Contains a list of credit memos for the order
48
+ ` credit_memos ` | [[ CreditMemo]] ( #CreditMemo ) | Contains a list of credit memos for the order
49
49
` grand_total ` | Float | Deprecated. Use the ` totals.grand_total ` attribute instead
50
50
` gift_message ` | [ GiftMessage] ( #GiftMessage ) | The entered gift message for the order
51
51
` gift_receipt_included ` | Boolean! | Indicates if the customer requested a gift receipt for the order
52
52
` gift_wrapping ` | [ GiftWrapping] ( #GiftWrapping ) | The selected gift wrapping for the order
53
53
` id ` | ID! | Unique identifier for the order
54
54
` increment_id ` | String | Deprecated. Use the ` id ` attribute instead
55
- ` invoices ` | [[ Invoice] ( #Invoice )] ! | Contains a list of invoices for the order
56
- ` items ` | [[ OrderItemInterface] ( #OrderItemInterface )] | An array containing the items purchased in this order
55
+ ` invoices ` | [[ Invoice]] ( #Invoice ) ! | Contains a list of invoices for the order
56
+ ` items ` | [[ OrderItemInterface]] ( #OrderItemInterface ) | An array containing the items purchased in this order
57
57
` number ` | String! | The order number
58
58
` order_date ` | String! | The date the order was placed
59
59
` order_number ` | String! | Deprecated. Use the ` number ` attribute instead
60
- ` payment_methods ` | [[ PaymentMethod] ( #PaymentMethod )] | Payment details for the order
60
+ ` payment_methods ` | [[ PaymentMethod]] ( #PaymentMethod ) | Payment details for the order
61
61
` printed_card_included ` | Boolean! | Indicates if the customer requested a printed card for the order
62
- ` shipments ` | [[ OrderShipment] ( #OrderShipment )] | Shipment list for the order
62
+ ` shipments ` | [[ OrderShipment]] ( #OrderShipment ) | Shipment list for the order
63
63
` shipping_address ` | [ OrderAddress] ( #OrderAddress ) | Shipping address for the order
64
64
` shipping_method ` | String | Shipping method for the order
65
65
` status ` | String! | The current status of the order
@@ -73,9 +73,9 @@ The `CreditMemo` object contains details about credit memos applied to an order.
73
73
74
74
Attribute | Data type | Description
75
75
--- | --- | ---
76
- ` comments ` | [[ SalesCommentItem] ( #SalesCommentItem )] | Comments on the credit memo
76
+ ` comments ` | [[ SalesCommentItem]] ( #SalesCommentItem ) | Comments on the credit memo
77
77
` id ` | ID! | The unique ID of the credit memo
78
- ` items ` | [[ CreditMemoItemInterface] ( #CreditMemoItemInterface )] | An array containing details about refunded items
78
+ ` items ` | [[ CreditMemoItemInterface]] ( #CreditMemoItemInterface ) | An array containing details about refunded items
79
79
` number ` | String! | The sequential credit memo number
80
80
` total ` | [ CreditMemoTotal] ( #CreditMemoTotal ) | Contains details about the total refunded amount
81
81
@@ -95,11 +95,11 @@ Attribute | Data type | Description
95
95
--- | --- | ---
96
96
` adjustment ` | Money! | An adjustment manually applied to the order
97
97
` base_grand_total ` | Money! | The final base grand total amount in the base currency
98
- ` discounts ` | [ Discount] | The applied discounts to the order
98
+ ` discounts ` | [[ Discount]] ( #Discount ) | The applied discounts to the order
99
99
` grand_total ` | Money! | The final total amount, including shipping, discounts, and taxes
100
100
` shipping_handling ` | [ ShippingHandling] ( #ShippingHandling ) | Contains details about the shipping and handling costs for the credit memo
101
101
` subtotal ` | Money! | The subtotal of the order, excluding shipping, discounts, and taxes
102
- ` taxes ` | [[ TaxItem] ( #TaxItem )] ! | An array containing information about taxes on individual orders
102
+ ` taxes ` | [[ TaxItem]] ( #TaxItem ) ! | An array containing information about taxes on individual orders
103
103
` total_shipping ` | Money! | The shipping amount for the credit memo
104
104
` total_tax ` | Money! | The amount of tax applied to all orders
105
105
@@ -126,9 +126,9 @@ The `Invoice` object provides details about a customer invoice.
126
126
127
127
Attribute | Data type | Description
128
128
--- | --- | ---
129
- ` comments ` | [[ SalesCommentItem] ( #SalesCommentItem )] | Comments on the invoice
129
+ ` comments ` | [[ SalesCommentItem]] ( #SalesCommentItem ) | Comments on the invoice
130
130
` id ` | ID! | The internal ID of the invoice
131
- ` items ` | [[ InvoiceItemInterface] ( #InvoiceItemInterface )] ! | Contains details about invoiced products
131
+ ` items ` | [[ InvoiceItemInterface]] ( #InvoiceItemInterface ) ! | Contains details about invoiced products
132
132
` number ` | String! | The sequential number of the invoice
133
133
` total ` | [ InvoiceTotal] ( #InvoiceTotal ) ! | Invoice total amount details
134
134
@@ -149,11 +149,11 @@ The InvoiceTotal object contains details about the totals of an invoice.
149
149
Attribute | Data type | Description
150
150
--- | --- | ---
151
151
` base_grand_total ` | Money! | The final base grand total amount in the base currency
152
- ` discounts ` | [ Discount] | The applied discounts to the invoice
152
+ ` discounts ` | [[ Discount]] ( #Discount ) | The applied discounts to the invoice
153
153
` grand_total ` | Money! | The final total amount, including shipping, discounts, and taxes
154
154
` shipping_handling ` | [ ShippingHandling] ( #ShippingHandling ) | Contains details about the shipping and handling costs for the invoice
155
155
` subtotal ` | Money! | The subtotal of the invoice, excluding shipping, discounts, and taxes
156
- ` taxes ` | [[ TaxItem] ( #TaxItem )] | An array containing information about taxes on individual invoices
156
+ ` taxes ` | [[ TaxItem]] ( #TaxItem ) | An array containing information about taxes on individual invoices
157
157
` total_shipping ` | Money! | The shipping amount for the invoice
158
158
` total_tax ` | Money! | The amount of tax applied to all invoices
159
159
@@ -227,11 +227,11 @@ Attribute | Data type | Description
227
227
228
228
Attribute | Data type | Description
229
229
--- | --- | ---
230
- ` comments ` | [[ SalesCommentItem] ( #SalesCommentItem )] | Comments added to the shipment
230
+ ` comments ` | [[ SalesCommentItem]] ( #SalesCommentItem ) | Comments added to the shipment
231
231
` id ` | ID! | The unique ID of the shipment
232
- ` items ` | [[ ShipmentItemInterface] ( #ShipmentItemInterface )] | Contains items included in the shipment
232
+ ` items ` | [[ ShipmentItemInterface]] ( #ShipmentItemInterface ) | Contains items included in the shipment
233
233
` number ` | String! | The sequential credit shipment number
234
- ` tracking ` | [[ ShipmentTracking] ( #ShipmentTracking )] | Contains shipment tracking detail
234
+ ` tracking ` | [[ ShipmentTracking]] ( #ShipmentTracking ) | Contains shipment tracking detail
235
235
236
236
#### OrderTotal attributes {#OrderTotal}
237
237
@@ -240,11 +240,11 @@ The `OrderTotal` object contains details about the sales total amounts used to c
240
240
Attribute | Data type | Description
241
241
--- | --- | ---
242
242
` base_grand_total ` | Money! | The final base grand total amount in the base currency
243
- ` discounts ` | [ Discount] | The applied discounts to the order
243
+ ` discounts ` | [[ Discount]] ( #Discount ) | The applied discounts to the order
244
244
` grand_total ` | Money! | The final total amount, including shipping, discounts, and taxes
245
245
` shipping_handling ` | [ ShippingHandling] ( #ShippingHandling ) | The shipping and handling costs for the order
246
246
` subtotal ` | Money! | The subtotal of the order, excluding shipping, discounts, and taxes
247
- ` taxes ` | [[ TaxItem] ( #TaxItem )] ! | An array containing information about taxes on individual orders
247
+ ` taxes ` | [[ TaxItem]] ( #TaxItem ) ! | An array containing information about taxes on individual orders
248
248
` total_shipping ` | Money! | The shipping costs for the order
249
249
` total_tax ` | Money! | The amount of tax applied to the order
250
250
@@ -254,7 +254,7 @@ The PaymentMethod data type contains details about the payment method used to pa
254
254
255
255
Attribute | Data type | Description
256
256
--- | --- | ---
257
- ` additional_data ` | [[ KeyValue] ( #KeyValue )] | Additional data per payment method type
257
+ ` additional_data ` | [[ KeyValue]] ( #KeyValue ) | Additional data per payment method type
258
258
` name ` | String! | The label that describes the payment method
259
259
` type ` | String! | The payment method code that indicates how the order was paid for
260
260
@@ -378,8 +378,8 @@ Attribute | Data type | Description
378
378
--- | --- | ---
379
379
` amount_excluding_tax ` | Money | The shipping amount, excluding tax
380
380
` amount_including_tax ` | Money | The shipping amount, including tax
381
- ` discounts ` | [ ShippingDiscount] | The applied discounts to the shipping
382
- ` taxes ` | [[ TaxItem] ( #TaxItem )] | Contains details about taxes applied for shipping
381
+ ` discounts ` | [[ ShippingDiscount]] ( #ShippingDiscount ) | The applied discounts to the shipping
382
+ ` taxes ` | [[ TaxItem]] ( #TaxItem ) | Contains details about taxes applied for shipping
383
383
` total_amount ` | Money! | The total amount for shipping
384
384
385
385
#### TaxItem attributes {#TaxItem}
0 commit comments