Change customer password
Changes the password for the specified Customer.
path Parameters
customerIdChange customer password › Request Body
newPasswordMust be 8-15 characters and contain at least one letter and one digit. Symbols are permitted.
Change customer password › Responses
OK
successWhether the password was changed
Create a customer account
Creates a Customer Account using the details provided.
Create a customer account › Request Body
usernameUsername for the Customer Account. Username should be an email address.
passwordPassword for the Customer Account. Note Password related information
nameName of the Customer
companyName of the Customer's company
addressLine1Address line 1 of the Customer's address
cityCity
stateState. In case the State information is not available, you need to pass the value for this parameter as Not Applicable .
countryCountry Code as per ISO 3166-1 alpha-2
zipcodeZIP code
phoneCountryCodeTelephone number Country Code
phonePhone number
addressLine2Address line 2 of the Customer's address
addressLine3Address line 3 of the Customer's address
otherStateThis parameter needs to be included if the State information is not available. Mention an appropriate value for this parameter.
altPhoneCountryCodeAlternate phone country code
altPhoneAlternate phone number
faxCountryCodeFax number country code
faxFax number
languagePreferenceLanguage Code as per ISO
mobileCountryCodeMobile country code
mobileMobile number
vatIdVAT ID for EU VAT
indianServiceTaxIdIndian Service Tax Id.
indianGstIdIndian Gst Id.
salesTaxExemptionIdSales Tax Exemption Id.
russiaVatIdRussia Vat Id.
australiaGstIdAustralia Gst Id.
newzealandGstIdNewzealand Gst Id.
singaporeGstIdSingapore Gst Id.
paraguayTaxIdParaguay Tax Id.
dontSendSignupEmailBoolean. Dont Send Signup Email. Possible values are true or false.
smsConsentBoolean. In case of a US based customer, consent is required to receive renewal reminder SMSes. Possible values are true or false.
acceptPolicyBoolean. Accept Terms and Conditions and Privacy Policy to create an account. Possible values are true or false.
marketingEmailConsentBoolean. In case of EEA (European Economic Area) countries capture consent to receive marketing emails. Possible values are true or false.
Create a customer account › Responses
OK
customerIdNewly created customer identifier
Delete a customer account
Deletes the specified Customer.
path Parameters
customerIdCustomer Id (required).
Delete a customer account › Responses
OK
actionStatusAction status
actionStatusDescAction status description
actionTypeDescAction type description
entityIdEntity identifier
eaqIdAction queue identifier
actionTypeAction type
valueGet customer by ID
Returns the customer profile for the requested account.
path Parameters
customerIdCustomer Id (required).
Get customer by ID › Responses
OK
Customer profile
passwordExpiredBoolean. Whether the password has expired. Possible values are true or false.
twoFactorAuthEnabledBoolean. Whether two-factor authentication is enabled. Possible values are true or false.
twoFactorGoogleAuthEnabledBoolean. Whether Google two-factor authentication is enabled. Possible values are true or false.
twoFactorSmsAuthEnabledBoolean. Whether SMS two-factor authentication is enabled. Possible values are true or false.
actionStatusAction status
actionStatusDescAction status description
actionTypeDescAction type description
entityIdEntity identifier
eaqIdAction queue identifier
actionTypeAction type
statusOperation status
messageStatus message
Get customer by username
Returns the customer profile for the requested account.
query Parameters
usernameUsername (required).
Get customer by username › Responses
OK
Customer profile
passwordExpiredBoolean. Whether the password has expired. Possible values are true or false.
twoFactorAuthEnabledBoolean. Whether two-factor authentication is enabled. Possible values are true or false.
twoFactorGoogleAuthEnabledBoolean. Whether Google two-factor authentication is enabled. Possible values are true or false.
twoFactorSmsAuthEnabledBoolean. Whether SMS two-factor authentication is enabled. Possible values are true or false.
actionStatusAction status
actionStatusDescAction status description
actionTypeDescAction type description
entityIdEntity identifier
eaqIdAction queue identifier
actionTypeAction type
statusOperation status
messageStatus message
List customer orders
Returns orders for the customer, with pagination.
path Parameters
customerIdCustomer Id (required).
query Parameters
statusStatus.
pagePage.
sizeSize.
onlyRecurringOnly Recurring.
List customer orders › Responses
OK
totalItemsTotal matching records
totalPagesTotal number of pages
itemsOnPageRecords on this page
Customer orders
statusOperation status
messageStatus message
Search customers
Returns customers matching the search criteria, with pagination.
query Parameters
pagePage (required).
sizeSize (required).
customerIdCustomer Id.
resellerIdReseller Id.
usernameUsername.
nameName.
companyCompany.
cityCity.
stateState.
statusStatus.
creationDateStartCreation Date Start.
creationDateEndCreation Date End.
totalReceiptStartTotal Receipt Start.
totalReceiptEndTotal Receipt End.
sortSort.
Search customers › Responses
OK
totalItemsTotal matching records
itemsOnPageRecords on this page
Customer search results
Suspend or unsuspend a customer account
Suspends or unsuspends a customer account.
path Parameters
customerIdSuspend or unsuspend a customer account › Request Body
suspendedWhen true, suspends the customer; when false, unsuspends.
reasonSuspension reason (required when suspended is true).
Suspend or unsuspend a customer account › Responses
OK
successStatus
Update customer details
Modifies the Account details of the specified Customer.
path Parameters
customerIdUpdate customer details › Request Body
usernameUsername for the Customer account. Username should be an email address.
nameName of the Customer
companyCompany name of the Customer
languagePreferenceLanguage Code as per ISO
addressLine1Address line 1 of the Customer's address
cityCity
stateState. In case the State information is not available, you need to pass the value for this parameter as Not Applicable .
countryCountry Code as per ISO 3166-1 alpha-2
zipcodeZIP code
phoneCountryCodePhone number Country Code
phonePhone number
addressLine2Address line 2 of the customer's address
addressLine3Address line 3 of the Customer's address
otherStateThis parameter needs to be included if the State information is not available. Mention an appropriate value for this parameter.
altPhoneCountryCodeAlternate phone Country Code
altPhoneAlternate phone number
faxCountryCodeFax number Country Code
faxFax number
mobileCountryCodeMobile country code
mobileMobile number
vatIdVAT ID for EU VAT
indianServiceTaxIdIndian Service Tax Id.
indianGstIdGST ID for Indian customer
russiaVatIdVAT ID for Russian customer
australiaGstIdGST ID for Australia customer
newzealandGstIdGST ID for New Zealand customer
singaporeGstIdGST ID for Singapore customer
smsConsentBoolean. SMS consent. Possible values are true or false.
Update customer details › Responses
OK
successStatus of the operation