Schema Documentation
Customer
Description
A customer object
Fields
Field Name | Description |
---|---|
availablePaymentMethods - [PaymentToken] | Customer's stored payment tokens. |
availablePaymentMethodsCC - [PaymentTokenCC] | Customer's stored payment tokens. |
availablePaymentMethodsEC - [PaymentTokenECheck] | Customer's stored payment tokens. |
billing - CustomerAddress | Return the date customer billing address properties |
calculatedShipping - Boolean | Has customer calculated shipping? |
databaseId - Int | The ID of the customer in the database |
date - String | Return the date customer was created |
displayName - String | Return the customer's display name. |
downloadableItems - CustomerToDownloadableItemConnection | Connection between the Customer type and the DownloadableItem type |
Arguments
| |
email - String | Return the customer's email. |
firstName - String | Return the customer's first name. |
hasCalculatedShipping - Boolean | Has calculated shipping? |
id - ID! | The globally unique identifier for the customer |
isPayingCustomer - Boolean | Return the date customer was last updated |
isVatExempt - Boolean | Is customer VAT exempt? |
lastName - String | Return the customer's last name. |
lastOrder - Order | Gets the customers last order. |
metaData - [MetaData] | Object meta data |
modified - String | Return the date customer was last updated |
orderCount - Int | Return the number of orders this customer has. |
orders - CustomerToOrderConnection | Connection between the Customer type and the Order type |
Arguments
| |
refunds - CustomerToRefundConnection | Connection between the Customer type and the Refund type |
Arguments
| |
role - String | Return the customer's user role. |
session - [MetaData] | Session data for the viewing customer |
sessionToken - String | A JWT token that can be used in future requests to for WooCommerce session identification |
shipping - CustomerAddress | Return the date customer shipping address properties |
subscriptions - [Subscription] | Subscriptions on the order. |
totalSpent - Float | Return how much money this customer has spent. |
username - String | Return the customer's username. |
Example
{"availablePaymentMethods":[PaymentToken],"availablePaymentMethodsCC":[PaymentTokenCC],"availablePaymentMethodsEC":[PaymentTokenECheck],"billing":CustomerAddress,"calculatedShipping":true,"databaseId":123,"date":"xyz789","displayName":"xyz789","downloadableItems":CustomerToDownloadableItemConnection,"email":"xyz789","firstName":"abc123","hasCalculatedShipping":false,"id":4,"isPayingCustomer":false,"isVatExempt":true,"lastName":"abc123","lastOrder":Order,"metaData":[MetaData],"modified":"xyz789","orderCount":123,"orders":CustomerToOrderConnection,"refunds":CustomerToRefundConnection,"role":"xyz789","session":[MetaData],"sessionToken":"xyz789","shipping":CustomerAddress,"subscriptions":[Subscription],"totalSpent":123.45,"username":"xyz789"}