Class: MWS::CustomerInformation::Client

Inherits:
Peddler::Client show all
Defined in:
lib/mws/customer_information/client.rb

Overview

Note:

The Customer Information API section only returns customer information for Webstores with Seller-Branded Checkout. No customer information is returned for Webstores with Amazon.com checkout. If your Webstore offers both checkout options, customer information is returned only for Seller-Branded Checkout accounts.

Note:

In addition to registering for Amazon MWS, you must request authorization to use the Customer Information API.

With the Customer Information API, you can retrieve information from the customer accounts of your Amazon Webstore customers. This customer information includes customer name, contact information, customer account type, and associated Amazon Webstore marketplaces. The Customer Information API enables you to programmatically integrate Amazon Webstore customer account information with your CRM systems, marketing applications, and other systems that require customer data.

Instance Attribute Summary

Attributes inherited from Peddler::Client

#auth_token, #body, #marketplace_id, #merchant_id, #path

Instance Method Summary collapse

Methods inherited from Peddler::Client

#aws_endpoint, #defaults, #headers, inherited, #initialize, #marketplace, #on_error, #operation, parser, parser=, path, #run

Constructor Details

This class inherits a constructor from Peddler::Client

Instance Method Details

#get_customers_for_customer_id(*customer_id_list, opts = {}) ⇒ Peddler::XMLParser

Returns customer accounts based on the CustomerId values that you specify

Parameters:

  • customer_id_list (Array<String>)
  • opts (Hash) (defaults to: {})

Options Hash (opts):

  • :marketplace_id (String)

Returns:

See Also:



60
61
62
63
64
65
66
67
 
# File 'lib/mws/customer_information/client.rb', line 60

def get_customers_for_customer_id(*customer_id_list)
  opts = extract_options(customer_id_list)
  operation('GetCustomersForCustomerId')
    .add(opts.update('CustomerIdList' => customer_id_list))
    .structure!('CustomerIdList', 'CustomerId')

  run
end

#get_service_status ⇒ Peddler::XMLParser

Gets the service status of the API

Returns:

See Also:



73
74
75
76
 
# File 'lib/mws/customer_information/client.rb', line 73

def get_service_status
  operation('GetServiceStatus')
  run
end

#list_customers(opts = {}) ⇒ Peddler::XMLParser

Lists customer accounts based on search criteria that you specify

Parameters:

  • opts (Hash) (defaults to: {})

Options Hash (opts):

  • :marketplace_id (String)
  • :date_range_start (String, #iso8601)
  • :date_range_end (String, #iso8601)
  • :date_range_type (String)

Returns:

See Also:



32
33
34
35
36
37
 
# File 'lib/mws/customer_information/client.rb', line 32

def list_customers(opts = {})
  operation('ListCustomers')
    .add(opts)

  run
end

#list_customers_by_next_token(next_token) ⇒ Peddler::XMLParser

Lists the next page of customer accounts

Parameters:

  • next_token (String)

Returns:

See Also:



44
45
46
47
48
49
 
# File 'lib/mws/customer_information/client.rb', line 44

def list_customers_by_next_token(next_token)
  operation('ListCustomersByNextToken')
    .add('NextToken' => next_token)

  run
end