...
...
Overview
The following operations allow you to work with accounts. Click an operation name to see details on how to use it.
For a sample proxy service that illustrates how to work with accounts, see Sample configuration.
Operation details
This section provides further details on the operations related to accounts.
Anchor |
---|
| createAccount |
---|
| createAccount |
---|
|
Creating a new accountThe createAccount operation creates a new account.
Code Block |
---|
language | xml |
---|
title | createAccount |
---|
|
<salesbinder.createAccount>
<billingAddress1>{$ctx:billingAddress1}</billingAddress1>
<billingAddress2>{$ctx:billingAddress2}</billingAddress2>
<shippingPostalCode>{$ctx:shippingPostalCode}</shippingPostalCode>
<shippingAddress1>{$ctx:shippingAddress1}</shippingAddress1>
<officeFax>{$ctx:officeFax}</officeFax>
<shippingAddress2>{$ctx:shippingAddress2}</shippingAddress2>
<url>{$ctx:url}</url>
<contextId>{$ctx:contextId}</contextId>
<billingRegion>{$ctx:billingRegion}</billingRegion>
<billingPostalCode>{$ctx:billingPostalCode}</billingPostalCode>
<officeEmail>{$ctx:officeEmail}</officeEmail>
<name>{$ctx:name}</name>
<officeNumber>{$ctx:officeNumber}</officeNumber>
<shippingRegion>{$ctx:shippingRegion}</shippingRegion>
<billingCity>{$ctx:billingCity}</billingCity>
<shippingCountry>{$ctx:shippingCountry}</shippingCountry>
<billingCountry>{$ctx:billingCountry}</billingCountry>
<shippingCity>{$ctx:shippingCity}</shippingCity>
<customerLabelId>{$ctx:customerLabelId}</customerLabelId>
</salesbinder.createAccount> |
Properties
billingAddress1:
Billing address Line 1 of the customer.billingAddress2:
Billing address Line 2 of the customer.shippingPostalCode:
Shipping postal code or zip code of the customer.shippingAddress1:
Shipping address Line 1.officeFax:
Office fax of the customer.shippingAddress2:
Shipping address line 2.url:
Company website address of the customer.contextId:
The value to determine what type of account you want to create.billingRegion:
Billing region (Province or State).billingPostalCode:
Billing Postal Code or Zip Code of the customer.officeEmail:
Office email address of the customer.name:
Business name of the customer.officeNumber:
Office phone number of the customer.shippingRegion:
Shipping region (Province or State) of the customer.billingCity:
Billing city of the customer.shippingCountry:
Shipping country of the customer.billingCountry:
Billing country of the customer.shippingCity:
Shipping city for the customer.customerLabelId:
The ID of the customer label.
Sample requestFollowing is a sample REST/JSON request that can be handled by the createAccount
operation.
...
Info |
---|
|
There are more optional parameters available. For more information on the usage of these parameters please check the API document. |
http://www.salesbinder.com/kb/api-functions/create-new-account/
Anchor |
---|
| getAccountById |
---|
| getAccountById |
---|
|
Retrieving account details by IDThe getAccountById
operation retrieves account details by ID.
Code Block |
---|
language | xml |
---|
title | getAccountById |
---|
|
<salesbinder.getAccountById>
<id>{$ctx:id}</id>
</salesbinder.getAccountById> |
Properties
id:
Required - The ID of the account.
Sample request
Following is a sample REST/JSON request that can be handled by the getAccountById
operation.
Code Block |
---|
language | xml |
---|
title | Sample Request for getAccountById |
---|
|
{
"apiUrl":"https://sblsoft.salesbinder.com",
"apiKey":"cb2192d4832db952ac5d0ec9f41770e88c733c0f",
"id":"54e72c32-63e4-47b0-8dfa-3e500ad1a5a6"
} |
http://www.salesbinder.com/kb/api-functions/view-account/
Retrieving all accountsThe listAccounts
operation retrieves all accounts.
Code Block |
---|
language | xml |
---|
title | listAccounts |
---|
|
<salesbinder.listAccounts>
<contextId>{$ctx:contextId}</contextId>
<page>{$ctx:page}</page>
</salesbinder.listAccounts> |
Properties
contextId:
The context ID of the account.page:
The number of pages of the accounts.
Sample request
Following is a sample REST/JSON request that can be handled by the listAccounts
operation.
Code Block |
---|
language | xml |
---|
title | Sample Request for listAccounts |
---|
|
{
"apiUrl":"https://sblsoft.salesbinder.com",
"apiKey":"cb2192d4832db952ac5d0ec9f41770e88c733c0f",
"contextId":"2",
"page":"2"
} |
http://www.salesbinder.com/kb/api-functions/list-accounts/
Anchor |
---|
| sampleconfiguration |
---|
| sampleconfiguration |
---|
|
Sample configurationFollowing is a sample proxy service that illustrates how to connect to SalesBinder with the init
operation and use the createAccount operation. The sample request for this proxy can be found in the createAccount sample request. You can use this sample as a template for using other operations in this category.
...