OrderUser

interface OrderUser { accepts_marketing?: boolean; email?: string; first_name: string; ip?: string; language: string; last_name: string; phone_number?: string; user_agent?: string; }

Source: api.ts:417

The customer a placed Order belongs to, as the orders API returns it.

Same fields as the customer on a cart; it is a separate name because the two come from different endpoints and may diverge.


Properties

accepts_marketing: boolean

Whether the customer opted in to marketing email at checkout.

email: string

Email the receipt was sent to. Absent on orders placed without one.

first_name: string

Customer's first name.

ip: string

IP address the order was placed from, when the API returns it.

language: string

Language code the customer checked out in, e.g. "en".

last_name: string

Customer's last name.

phone_number: string

Phone number given at checkout, when one was collected.

user_agent: string

Browser user-agent string recorded with the order, when the API returns it.