The distributor is usually a company that supplies the product to you.
DeleteDistributor
This service is used to delete a Distributor object.
Request Parameters
| Node |
Required |
Data Type |
Description |
| distributorID |
Yes |
Integer |
The object identifier. |
Return Data
None
GetDistributor
This service is used to query the Distributor object.
Request Parameters
| Node |
Required |
Data Type |
Description |
| distributorID |
Yes |
Integer |
The object identifier. |
Return Data
| Node |
Data Type |
Description |
| distributor |
XML |
Container node. |
| createDate |
DateTime |
Creation date. |
| description |
XML Locale |
Localized description. |
| displayOrder |
Integer |
Sort order for display. |
| displayTemplate |
String |
The associated display template. |
| distributorID |
Integer |
The object identifier. |
| distributorKey |
String |
A unique key that can be used to uniquely identify this object. This could be a short meaningful text or simply a GUID. |
| email |
String |
|
| extension |
XML |
Additional data. |
| metaDescription |
XML Locale |
Localized meta description. |
| metaKeywords |
XML Locale |
Localized meta keywords. |
| name |
XML Locale |
Localized name. |
| pageTitle |
XML Locale |
Localized page title. |
| phone |
String |
|
| portalID |
Integer |
|
| published |
Boolean |
If distributor should be published and visible by end users. |
| updateDate |
DateTime |
Update date. |
| urlName |
XML Locale |
Localized URL name for SEO. |
GetDistributors
This service is used to get all the Distributor objects belonging to the portal.
Request Parameters
| Node |
Required |
Data Type |
Description |
| count |
No |
Boolean |
Specify if return data should include total number of records found. |
| skip |
No |
Integer |
The number of records to skip over for paging purposes. |
| take |
No |
Integer |
The number of records to return for paging purposes. |
Return Data
| Node |
Data Type |
Description |
| totalCount |
Integer |
Number of records found. |
| distributors |
XML |
Container node |
| distributor |
XML |
Zero or more distributor nodes with same data structure as GetDistributor service return data. |
InsertDistributor
This service is used to create a new Distributor object.
Request Parameters
| Node |
Required |
Data Type |
Description |
| description |
No |
XML Locale |
Localized description. |
| displayOrder |
Yes |
Integer |
Sort order for display. |
| displayTemplate |
No |
String |
The associated display template. |
| distributorKey |
Yes |
String |
A unique key that can be used to uniquely identify this object. This could be a short meaningful text or simply a GUID. |
| email |
No |
String |
|
| extension |
No |
XML |
Additional data. |
| metaDescription |
No |
XML Locale |
Localized meta description. |
| metaKeywords |
No |
XML Locale |
Localized meta keywords. |
| name |
Yes |
XML Locale |
Localized name. |
| pageTitle |
No |
XML Locale |
Localized page title. |
| phone |
No |
String |
|
| published |
Yes |
Boolean |
If distributor should be published and visible by end users. |
| urlName |
No |
XML Locale |
Localized URL name for SEO. |
Return Data
Same as GetDistributor service return data.
UpdateDistributor
This service is used to update a Distributor object.
Request Parameters
| Node |
Required |
Data Type |
Description |
| description |
No |
XML Locale |
Localized description. |
| displayOrder |
Yes |
Integer |
Sort order for display. |
| displayTemplate |
No |
String |
The associated display template. |
| distributorID |
Yes |
Integer |
The object identifier. |
| distributorKey |
Yes |
String |
A unique key that can be used to uniquely identify this object. This could be a short meaningful text or simply a GUID. |
| email |
No |
String |
|
| extension |
No |
XML |
Additional data. |
| metaDescription |
No |
XML Locale |
Localized meta description. |
| metaKeywords |
No |
XML Locale |
Localized meta keywords. |
| name |
Yes |
XML Locale |
Localized name. |
| pageTitle |
No |
XML Locale |
Localized page title. |
| phone |
No |
String |
|
| published |
Yes |
Boolean |
If distributor should be published and visible by end users. |
| urlName |
No |
XML Locale |
Localized URL name for SEO. |
Return Data
Same as GetDistributor service return data.