Table of Contents | ||||
---|---|---|---|---|
|
...
Operation | Description |
---|---|
Creates a customer. | |
updateCustomer | Updates customer details. |
listCustomers | Retrieves all customers. |
Operation details
...
Code Block | ||||
---|---|---|---|---|
| ||||
<vend.createCustomer> <customerCode>{$ctx:customerCode}</customerCode> <companyName>{$ctx:companyName}</companyName> <firstName>{$ctx:firstName}</firstName> <lastName>{$ctx:lastName}</lastName> <phone>{$ctx:phone}</phone> <mobile>{$ctx:mobile}</mobile> <fax>{$ctx:fax}</fax> <email>{$ctx:email}</email> <website>{$ctx:website}</website> <physicalAddress1>{$ctx:physicalAddress1}</physicalAddress1> <physicalAddress2>{$ctx:physicalAddress2}</physicalAddress2> <physicalSuburb>{$ctx:physicalSuburb}</physicalSuburb> <physicalCity>{$ctx:physicalCity}</physicalCity> <physicalPostcode>{$ctx:physicalPostcode}</physicalPostcode> <physicalState>{$ctx:physicalState}</physicalState> <physicalCountryId>{$ctx:physicalCountryId}</physicalCountryId> <postalAddress1>{$ctx:postalAddress1}</postalAddress1> <postalAddress2>{$ctx:postalAddress2}</postalAddress2> <postalSuburb>{$ctx:postalSuburb}</postalSuburb> <postalCity>{$ctx:postalCity}</postalCity> <postalPostcode>{$ctx:postalPostcode}</postalPostcode> <postalState>{$ctx:postalState}</postalState> <postalCountryId>{$ctx:postalCountryId}</postalCountryId> <customerGroupId>{$ctx:customerGroupId}</customerGroupId> <customerGroupName>{$ctx:customerGroupName}</customerGroupName> <twitter>{$ctx:twitter}</twitter> <enableLoyalty>{$ctx:enableLoyalty}</enableLoyalty> <dateOfBirth>{$ctx:dateOfBirth}</dateOfBirth> <sex>{$ctx:sex}</sex> <customField1>{$ctx:customField1}</customField1> <customField2>{$ctx:customField2}</customField2> <customField3>{$ctx:customField3}</customField3> <customField4>{$ctx:customField4}</customField4> <note>{$ctx:note}</note> </vend.createCustomer> |
Properties
The unique identifier for the customer.customerCode:
Name of the company the customer belongs to.companyName:
First name of the customer.firstName:
Last name of the customer.lastName:
Fixed number of the customer.phone:
Mobile number of the customer.mobile:
Fax of the customerfax:
E-mail of the customer.email:
Website of the customer.website:
Address line 1 of the customer.physicalAddress1:
Address line 2 of the customer.physicalAddress2:
Suburb of the customer.physicalSuburb:
City of the customer.physicalCity:
Post code of the customer.physicalPostcode:
State of the customer.physicalState:
The ID of the country of the customer.physicalCountryId:
Postal Address line 1 of the customer.postalAddress1:
Postal Address line 2 of the customer.postalAddress2:
Postal suburb of the customer.postalSuburb:
Postal city of the customer.postalCity:
Postal post code of the customer.postalPostcode:
Postal state of the customer.postalState:
Postal country ID of the customer.postalCountryId:
The ID of the group to which the customer will be put.customerGroupId:
Name of the group to which the customer will be put.customerGroupName:
Twitter ID of the customer.twitter:
Indicates whether or not to enable loyalty for the customer.enableLoyalty:
Date of birth of the customer.dateOfBirth:
Gender of the customer.sex:
Custom Field 1 of the customer.customField1:
Custom Field 2 of the customer.customField2:
Custom Field 3 of the customer.customField3:
Custom Field 4 of the customer.customField4:
Note of the customer.note:
Anchor | ||||
---|---|---|---|---|
|
...
Code Block | ||||
---|---|---|---|---|
| ||||
<vend.updateCustomer> <customerCode>{$ctx:customerCode}</customerCode> <companyName>{$ctx:companyName}</companyName> <firstName>{$ctx:firstName}</firstName> <lastName>{$ctx:lastName}</lastName> <phone>{$ctx:phone}</phone> <mobile>{$ctx:mobile}</mobile> <fax>{$ctx:fax}</fax> <email>{$ctx:email}</email> <website>{$ctx:website}</website> <physicalAddress1>{$ctx:physicalAddress1}</physicalAddress1> <physicalAddress2>{$ctx:physicalAddress2}</physicalAddress2> <physicalSuburb>{$ctx:physicalSuburb}</physicalSuburb> <physicalCity>{$ctx:physicalCity}</physicalCity> <physicalPostcode>{$ctx:physicalPostcode}</physicalPostcode> <physicalState>{$ctx:physicalState}</physicalState> <physicalCountryId>{$ctx:physicalCountryId}</physicalCountryId> <postalAddress1>{$ctx:postalAddress1}</postalAddress1> <postalAddress2>{$ctx:postalAddress2}</postalAddress2> <postalSuburb>{$ctx:postalSuburb}</postalSuburb> <postalCity>{$ctx:postalCity}</postalCity> <postalPostcode>{$ctx:postalPostcode}</postalPostcode> <postalState>{$ctx:postalState}</postalState> <postalCountryId>{$ctx:postalCountryId}</postalCountryId> <customerGroupId>{$ctx:customerGroupId}</customerGroupId> <customerGroupName>{$ctx:customerGroupName}</customerGroupName> <twitter>{$ctx:twitter}</twitter> <enableLoyalty>{$ctx:enableLoyalty}</enableLoyalty> <dateOfBirth>{$ctx:dateOfBirth}</dateOfBirth> <sex>{$ctx:sex}</sex> <customField1>{$ctx:customField1}</customField1> <customField2>{$ctx:customField2}</customField2> <customField3>{$ctx:customField3}</customField3> <customField4>{$ctx:customField4}</customField4> <note>{$ctx:note}</note> <customerId>{$ctx:customerId}</customerId> </vend.updateCustomer> |
Properties
The unique identifier for the customer.customerCode:
Name of the company the customer belongs to.companyName:
First name of the customer.firstName:
Last name of the customer.lastName:
Fixed number of the customer.phone:
Mobile number of the customer.mobile:
Fax of the customerfax:
E-mail of the customer.email:
Website of the customer.website:
Address line 1 of the customer.physicalAddress1:
Address line 2 of the customer.physicalAddress2:
Suburb of the customer.physicalSuburb:
City of the customer.physicalCity:
Post code of the customer.physicalPostcode:
State of the customer.physicalState:
The ID of the country of the customer.physicalCountryId:
Postal Address line 1 of the customer.postalAddress1:
Postal Address line 2 of the customer.postalAddress2:
Postal suburb of the customer.postalSuburb:
Postal city of the customer.postalCity:
Postal post code of the customer.postalPostcode:
Postal state of the customer.postalState:
Postal country ID of the customer.postalCountryId:
The ID of the group to which the customer will be put.customerGroupId:
Name of the group to which the customer will be put.customerGroupName:
Twitter ID of the customer.twitter:
Indicates whether or not to enable loyalty for the customer.enableLoyalty:
Date of birth of the customer.dateOfBirth:
Gender of the customer.sex:
Custom Field 1 of the customer.customField1:
Custom Field 2 of the customer.customField2:
Custom Field 3 of the customer.customField3:
Custom Field 4 of the customer.customField4:
Note of the customer.note:
The ID of the customer to update.customerId:
Anchor | ||||
---|---|---|---|---|
|
...
Code Block | ||||
---|---|---|---|---|
| ||||
<vend.listCustomers> <id>{$ctx:id}</id> <code>{$ctx:code}</code> <email>{$ctx:email}</email> <since>{$ctx:since}</since> </vend.listCustomers> |
Properties
If included, searches for customers with the given unique ID. The ID option cannot be used with the code or e-mail options.id:
If included, searches for customers with the given customer code. The code option cannot be used with ID or e-mail options.code:
If included, searches for customers with the given e-mail address. This is an exact match search. The e-mail option cannot be used with the ID or code options.email:
If included, searches for customers modified since the given time. The provided date and time should be in UTC and formatted according to ISO 8601.since:
Anchor | ||||
---|---|---|---|---|
|
...