You are viewing a section of Superface that will be deprecated in Q4 2023. Until then, you can continue to use it as you have before but we recommend that you migrate to our latest version soon. For more details visit superface.ai/docs/migrate.
customer-management/get-customer
customer-management/get-customer@0.0.0Retrieves a single customer by their ID.
Input
The ID of the customer to retrieve.
Comma-separated list of field names to show in the response.
Result
The new customer object.
Structure details
Input (object)
customer_id
required
The ID of the customer to retrieve.
string
fields
optional
Comma-separated list of field names to show in the response.
string
Example
Result (object)
customer
optional
The new customer object.
object
id
required
The customer's ID.
number
email
required
The unique email address of the customer. Attempting to assign the same email address to multiple customers returns an error.
string
created_at
required
The date and time (ISO 8601 format) when the customer was created.
string
updated_at
required
The date and time (ISO 8601 format) when the customer information was last updated.
string
first_name
required
string
last_name
required
string
orders_count
required
number
state
required
string
total_spent
required
The total amount of money that the customer has spent across their order history.
string
last_order_id
required
number
note
optional
A note about the customer.
string
verified_email
required
Whether the customer has verified their email address.
boolean
multipass_identifier
optional
A unique identifier for the customer that's used with Multipass login.
string
tax_exempt
required
Whether the customer is exempt from paying taxes on their order. If true, then taxes won't be applied to an order at checkout. If false, then taxes will be applied at checkout.
boolean
tags
required
Tags that the shop owner has attached to the customer, formatted as a string of comma-separated values. A customer can have up to 250 tags. Each tag can have up to 255 characters.
string
last_order_name
required
The name of the customer's last order. This is directly related to the name field on the Order resource.
string
currency
required
The three-letter code (ISO 4217 format) for the currency that the customer used when they paid for their last order. Defaults to the shop currency. Returns the shop currency for test orders.
string
phone
required
The unique phone number (E.164 format) for this customer. Attempting to assign the same phone number to multiple customers returns an error.
string
addresses
required
list
id
required
number
customer_id
required
number
first_name
optional
string
last_name
optional
string
company
optional
string
address1
required
string
address2
optional
string
city
required
string
province
required
string
country
required
string
zip
required
string
phone
required
string
name
required
string
province_code
required
string
country_code
required
string
country_name
required
string
default
required
boolean
tax_exemptions
optional
list
email_marketing_consent
required
The marketing consent information when the customer consented to receiving marketing material by email. The email property is required to create a customer with email consent information and to update a customer for email consent that doesn't have an email recorded. The customer must have a unique email address associated to the record. The email marketing consent has the following properties:
object
state
required
string
opt_in_level
optional
string
consent_updated_at
required
string
sms_marketing_consent
required
The marketing consent information when the customer consented to receiving marketing material by SMS. The phone property is required to create a customer with SMS consent information and to perform an SMS update on a customer that doesn't have a phone number recorded. The customer must have a unique phone number associated to the record. The SMS marketing consent has the following properties:
object
state
required
string
opt_in_level
required
string
consent_updated_at
required
string
consent_collected_from
required
string
admin_graphql_api_id
required
string
default_address
required
The default address for the customer.
object
id
required
number
customer_id
required
number
first_name
optional
string
last_name
optional
string
company
optional
string
address1
required
string
address2
optional
string
city
required
string
province
required
string
country
required
string
zip
required
string
phone
required
string
name
required
string
province_code
required
string
country_code
required
string
country_name
required
string
default
required
boolean