| hateoasLinks |
Get the HATEOAS links for the record |
array
|
| editUrl |
Get the url for editing the record. |
string
|
| id |
|
int
|
| expiryDate |
Gets the expiry date |
DateTime
|
| itemTotalAsMoney |
Gets the item total as a Money object. Represents the sum of all items' Amount values. |
Money
|
| shippingTotalAsMoney |
Gets the shipping total as a Money object. Represents the net shipping total. Tax and discount on shipping are tracked in Tax Total and Discount Total. |
Money
|
| handlingTotalAsMoney |
Gets the handling total as a Money object. Represents the net handling total. Tax and discount on handling are tracked in Tax Total and Discount Total. |
Money
|
| insuranceTotalAsMoney |
Gets the insurance total as a Money object. Represents the net insurance total. Tax and discount on insurance are tracked in Tax Total and Discount Total. |
Money
|
| discountTotalAsMoney |
Gets the discount total as a Money object. Represents the sum of discount values across all line items, including shipping, handling, etc. |
Money
|
| taxTotalAsMoney |
Gets the tax total as a Money object. Represents the sum of tax values across all line items, including shipping, handling, etc. |
Money
|
| surchargeTotalAsMoney |
Gets the surcharge total as a Money object. Represents the surcharge total. |
Money
|
| totalAsMoney |
Gets the grand total as a Money object. Represents the final value calculated as `Item Total + Shipping Total + Handling Total + Insurance Total - Discount Total + Tax Total + Surcharge Total`. |
Money
|
| invoices |
Get all invoices linked to this order (Order, Checkout) |
Collection
|
| currencyCode |
Get currency code |
string
|
| uuid |
|
string
|
| externalId |
|
string
|
| comments |
|
string
|
| appliedDiscounts |
Metadata of the applied discounts. |
array
|
| discountCodes |
List of the applied discount codes. |
array
|
| shippingTotal |
Represents the net shipping total. Tax and discount on shipping are tracked in Tax Total and Discount Total. |
string
|
| handlingTotal |
Represents the net handling total. Tax and discount on handling are tracked in Tax Total and Discount Total. |
string
|
| insuranceTotal |
Represents the net insurance total. Tax and discount on insurance are tracked in Tax Total and Discount Total. |
string
|
| discountTotal |
Represents the sum of discount values across all line items, including shipping, handling, etc. |
string
|
| taxTotal |
Represents the sum of tax values across all line items, including shipping, handling, etc. |
string
|
| surchargeTotal |
Represents the surcharge total. |
string
|
| total |
Represents the final value calculated as `Item Total + Shipping Total + Handling Total + Insurance Total - Discount Total + Tax Total + Surcharge Total`. |
string
|
| created |
Date the record was created. |
DateTime
|
| modified |
Last modification date for the record. |
DateTime
|
| billingAddress |
|
Address
|
| deliveryAddress |
|
Address
|
| currency |
|
Currency
|
| person |
|
Person
|
| site |
|
Site
|
| items |
|
Collection (Item)
|
| fulfillments |
|
Collection (Fulfillment)
|
| metadataFieldValues |
|
Collection (MetadataFieldValue)
|
| sourceEntity |
Get the source record entity |
string
|
| sourceUuid |
Get the source record uuid |
string
|
| discountLogs |
|
Collection (Log)
|