MageSmith
OBJECT Magento 2.4.9

CustomerOrder

Contains details about each of the customer's orders.

Declared or extended by: GiftMessage, Sales

Fields

gift_message GiftMessage

The entered gift message for the order

id ID! Required

The unique ID for a `CustomerOrder` object.

order_date String! Required

The date the order was placed.

status String! Required

The current status of the order.

number String! Required

The order number.

An array containing the items purchased in this order.

total OrderTotal

Details about the calculated totals for this order.

invoices [Invoice]! Required

A list of invoices for the order.

shipments [OrderShipment]

A list of shipments for the order.

credit_memos [CreditMemo]

A list of credit memos.

payment_methods [OrderPaymentMethod]

Payment details for the order.

shipping_address OrderAddress

The shipping address for the order.

billing_address OrderAddress

The billing address for the order.

carrier String

The shipping carrier for the order delivery.

shipping_method String

The delivery method for the order.

comments [SalesCommentItem]

Comments about the order.

increment_id String Deprecated
order_number String! Required Deprecated
created_at String Deprecated
grand_total Float Deprecated
token String! Required

The token that can be used to retrieve the order using order query.

applied_coupons [AppliedCoupon!]! Required

Coupons applied to the order.

email String

Order customer email.

is_virtual Boolean! Required

`TRUE` if the order is virtual

available_actions [OrderActionType!]! Required

List of available order actions.

customer_info OrderCustomerInfo! Required

Returns customer information from order.

order_status_change_date String! Required

The date the order status was last updated.

Operations returning CustomerOrder

Every Magento dev tool, in one hosted workspace.

Free to sign up. Nothing to install. Drafts, audits, and projects saved across every tool.