new shoppers(domainOrOptionsopt)
Parameters:
| Name |
Type |
Attributes |
Description |
domainOrOptions |
string
|
object
|
<optional>
|
The project domain or options object. If object, see the object's optional properties.
Properties
| Name |
Type |
Attributes |
Description |
domain |
string
|
<optional>
|
The project domain |
token |
object
|
<optional>
|
auth token - object with value property and optional headerOrQueryName and isQuery properties |
|
- Source:
Methods
createSubaccount(subaccount)
Create a Subaccount owned by the authenticated Reseller
Parameters:
| Name |
Type |
Description |
subaccount |
SubaccountCreate
|
The subaccount to create |
- Source:
get(shopperId)
Get details for the specified Shopper
Parameters:
| Name |
Type |
Description |
shopperId |
string
|
Shopper whose details are to be retrieved |
- Source:
setToken(value, headerOrQueryName, isQuery)
Set Token
Parameters:
| Name |
Type |
Description |
value |
string
|
token's value |
headerOrQueryName |
string
|
the header or query name to send the token at |
isQuery |
boolean
|
true if send the token as query param, otherwise, send as header param |
- Source:
update(shopperId, shopper)
Update details for the specified Shopper
Parameters:
| Name |
Type |
Description |
shopperId |
string
|
The ID of the Shopper to update |
shopper |
ShopperUpdate
|
The Shopper details to update |
- Source: