BBAPI: Client Commands
The Nigma system will automatically store information pertaining to client records. This information includes but is not limited to contact and shipping information as well as billing information such as billing accounts. This makes future checkout processes much quicker and helps maintain good record-keeping.
On This Page:
Available Commands
GetClients
Returns data pertaining to client records.
SetClients
Saves and updates client information.
Example 1: Input
Here is an example of what would be sent to the API to add a client to the system. If you wish to update a client record, simply define the clientID.
Example 1: Response
The API will return the results of your request in a similar way such as the one below. If the client record is a new one, a welcome email will be generated if this email is active.
To get client information, call GetClients. You can pass in a number of nodes to act as filters such as clientEmail will find all clients with the given value for that email address.
Summary of Nodes
Here is a summary of the nodes that may be passed back and their meaning.
Node |
Type | Description |
|---|---|---|
clientID |
Integer | Unique ID for client. |
| clientUsername | String | Unique username for client. If username is taken, random numbers and/or letters will be appended to the username as needed. |
| clientPassword | String | A password for the client record. This information is encrypted on not passed back. |
| clientFirstName | String | First name of client. |
| clientLastName | String | Last name of client. |
| clientEmail | String | Email address of client. |
| clientHomePhone | String | Home phone number of client. |
| clientWorkPhone | String | Work phone number of client. |
| clientMobilePhone | String | Mobile phone number of client. |
| clientAddress | String | Clients street address. |
| clientAddress2 | String | Line 2 of clients street address. |
| clientCity | String | Clients city. |
| clientState | String | Clients state. |
| clientZip | String | Clients zip code. |
| clientCountryID | Integer | Unique ID of clients country. |
| clientCountryName | String | Name of clients country. |
| clientShippingAddress | String | Clients preferred shipping address. |
| clientShippingAddress2 | String | Line 2 of clients preferred shipping address. |
| clientShippingCity | String | City of clients preferred shipping address. |
| clientShippingState | String | State of clients preferred shipping address. |
| clientShippingZip | String | Zip code of clients preferred shipping address. |
| clientShippingCountryID | Integer | Unique ID of clients shipping country. |
| clientShippingCountryName | String | Name of clients shipping country. |
| clientBillingAccounts | XML | All billing account nodes on record for client. |
| clientBillingAccountID | Integer | Unique ID of clients billing record. |
| clientBillingAccountCardTypeID | Integer | Unique ID of the card type. |
| clientBillingAccountCardTypeName | String | Textual representation of card type (ie. Visa, Mastercard, etc) |
| clientBillingAccountCardNumber | String | Credit card number. |
| clientBillingAccountCardExpirationMonth | Integer | Expiration month of credit card. |
| clientBillingAccountCardExpirationYear | Integer | Expiration year of credit card. |
| clientBillingAccountGatewayInfoID | Integer | ID of payment gateway to be used. |
| clientBillingAccountGatewayInfoName | String | Textual representation of payment gateway. |
| clientBillingAccountCardName | String | Name on credit card. |
| clientBillingAccountDefault | Char | If billing is default. Possible values are y (yes) or n (no). |