shoppers

Creates, updates, deletes, gets or lists a shoppers resource.

Overview

Name	shoppers
Type	Resource
Id	godaddy.shoppers.shoppers

Fields

The following fields are returned by SELECT queries:

get

Request was successful

Name	Datatype	Description
email	string (email)
externalId	integer
marketId	string (bcp-47)	(default: en-US)
nameFirst	string
nameLast	string
shopperId	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	shopper_id		Get details for the specified Shopper
create_subaccount	insert	data__email, data__password, data__nameFirst, data__nameLast		Create a Subaccount owned by the authenticated Reseller
update	exec	shopper_id		Update details for the specified Shopper

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
shopper_id	string	The ID of the Shopper to update

SELECT examples

get

Get details for the specified Shopper

SELECT
email,
externalId,
marketId,
nameFirst,
nameLast,
shopperId
FROM godaddy.shoppers.shoppers
WHERE shopper_id = '{{ shopper_id }}' -- required
;

INSERT examples

create_subaccount

Create a Subaccount owned by the authenticated Reseller

INSERT INTO godaddy.shoppers.shoppers (
data__email,
data__externalId,
data__marketId,
data__nameFirst,
data__nameLast,
data__password
)
SELECT 
'{{ email }}' /* required */,
{{ externalId }},
'{{ marketId }}',
'{{ nameFirst }}' /* required */,
'{{ nameLast }}' /* required */,
'{{ password }}' /* required */
RETURNING
customerId,
shopperId
;

Manifest

# Description fields are for documentation purposes
- name: shoppers
  props:
    - name: email
      value: string
    - name: externalId
      value: integer
    - name: marketId
      value: string
      default: en-US
    - name: nameFirst
      value: string
    - name: nameLast
      value: string
    - name: password
      value: string

Lifecycle Methods

update

Update details for the specified Shopper

EXEC godaddy.shoppers.shoppers.update 
@shopper_id='{{ shopper_id }}' --required 
@@json=
'{
"email": "{{ email }}", 
"externalId": {{ externalId }}, 
"marketId": "{{ marketId }}", 
"nameFirst": "{{ nameFirst }}", 
"nameLast": "{{ nameLast }}"
}'
;