class Shopify::Customer

• Shopify::Customer
• Shopify::Resource
• Reference
• Object

Overview

https://shopify.dev/api/admin-rest/2022-01/resources/customer

Extended Modules

• Shopify::Resource::ClassMethods

Defined in:

Constructors

• .new(pull : JSON::PullParser)

Class Method Summary

• .all(domain : String, depth : Int32 = 20, headers : HTTP::Headers = headers) : Array(Shopify::Customer)

  Used to return an array of customers.

• .all(domain : String, next_page_uri : String? = nil, depth : Int32 = 20, headers : HTTP::Headers = headers, &block : self -> )

  Used to iterate over all customers.

• .count(domain : String, headers : HTTP::Headers = headers) : Int64

  Used to get a count of all customers.

• .create(body : String, domain : String, headers : HTTP::Headers = headers) : Shopify::Customer

  Used to create one customer.

• .find(id : Int64, domain : String, headers : HTTP::Headers = headers) : Shopify::Customer

  Used to fetch one customer.

• .search(query : String, domain : String, headers : HTTP::Headers = headers)

  Under the covers, this just runs: plaintext GET /admin/api/2022-01/customers/search.json?query=

• .uri(domain : String, path : String = "") : URI
• .with(store : Store)

Instance Method Summary

• #accepts_marketing : Bool
• #accepts_marketing=(accepts_marketing : Bool)
• #accepts_marketing_updated_at : Time
• #accepts_marketing_updated_at=(accepts_marketing_updated_at : Time)
• #addresses : Array(Shopify::Address)
• #addresses=(addresses : Array(Shopify::Address))
• #admin_graphql_api_id : String
• #admin_graphql_api_id=(admin_graphql_api_id : String)
• #create_account_activation_url : URI

  Under the covers, this just runs: plaintext POST /admin/api/2022-01/customers/{id}/account_activation_url.json

• #created_at : Time
• #created_at=(created_at : Time)
• #currency : String
• #currency=(currency : String)
• #default_address : Shopify::Address
• #default_address=(default_address : Shopify::Address)
• #delete

  Used to delete one customer.

• #email : String
• #email=(email : String)
• #first_name : String
• #first_name=(first_name : String)
• #id : Int64
• #id=(id : Int64)
• #last_name : String
• #last_name=(last_name : String)
• #last_order_id : Int64?
• #last_order_id=(last_order_id : Int64?)
• #last_order_name : String?
• #last_order_name=(last_order_name : String?)
• #marketing_opt_in_level : String?
• #marketing_opt_in_level=(marketing_opt_in_level : String?)
• #multipass_identifier : String?
• #multipass_identifier=(multipass_identifier : String?)
• #note : String?
• #note=(note : String?)
• #orders : Array(Shopify::Order)

  Under the covers, this just runs: plaintext GET /admin/api/2022-01/customers/{id}/orders.json

• #orders_count : Int32
• #orders_count=(orders_count : Int32)
• #phone : String?
• #phone=(phone : String?)
• #send_invite : Shopify::CustomerInvite

  Under the covers, this just runs: plaintext POST /admin/api/2022-01/customers/{id}/send_invite.json

• #sms_marketing_consent : JSON::Any?
• #sms_marketing_consent=(sms_marketing_consent : JSON::Any?)
• #state : String
• #state=(state : String)
• #tags : String
• #tags=(tags : String)
• #tax_exempt : Bool
• #tax_exempt=(tax_exempt : Bool)
• #tax_exemptions : Array(JSON::Any)
• #tax_exemptions=(tax_exemptions : Array(JSON::Any))
• #total_spent : String
• #total_spent=(total_spent : String)
• #update(body : String) : self

  Sample Body from Shopify Docs: plaintext {"id":207119551,"email":"changed@example.com","note":"Customer is great"}}

• #updated_at : Time
• #updated_at=(updated_at : Time)
• #verified_email : Bool
• #verified_email=(verified_email : Bool)

Constructor Detail

Class Method Detail

Shopify::Customer.with(store).all #=> Array(Shopify::Customer)

Shopify::Customer.all(domain, headers: headers) #=> Array(Shopify::Customer)

Shopify::Customer.with(store).all do |customer|
  # do something with customer
end

Shopify::Customer.all(domain, headers: headers) do |customer|
  # do something with customer
end

GET
/admin/api/2022-01/customers.json

Shopify::Customer.with(store).count #=> Int64

Shopify::Customer.count(domain, headers: headers) #=> Int64

GET
/admin/api/2022-01/customers/count.json

Shopify::Customer.with(store).create(body) #=> Shopify::Customer

Shopify::Customer.create(body, domain, headers: headers) #=> Shopify::Customer

{"customer":{"first_name":"Steve","last_name":"Lastnameson","email":"steve.lastnameson@example.com","phone":"+15142546011","verified_email":true,"addresses":[{"address1":"123 Oak St","city":"Ottawa","province":"ON","phone":"555-1212","zip":"123 ABC","last_name":"Lastnameson","first_name":"Mother","country":"CA"}]}}

POST
/admin/api/2022-01/customers.json

Shopify::Customer.with(store).find(id) #=> Shopify::Customer

Shopify::Customer.find(id, domain, headers: headers) #=> Shopify::Customer

GET
/admin/api/2022-01/customers/{id}.json

GET
/admin/api/2022-01/customers/search.json?query=

Instance Method Detail

POST
/admin/api/2022-01/customers/{id}/account_activation_url.json

DELETE
/admin/api/2022-01/customers/{id}.json

GET
/admin/api/2022-01/customers/{id}/orders.json

POST
/admin/api/2022-01/customers/{id}/send_invite.json

{"id":207119551,"email":"changed@example.com","note":"Customer is great"}}

PUT
/admin/api/2022-01/customers/{id}.json