The manufacturer is typically a company that fabricates the product.
DeleteManufacturer
This service is used to delete a Manufacturer object.
Request Parameters
| Node |
Required |
Data Type |
Description |
| manufacturerID |
Yes |
Integer |
The object identifier. |
Return Data
None
GetManufacturer
This service is used to query the Manufacturer object.
Request Parameters
| Node |
Required |
Data Type |
Description |
| manufacturerID |
Yes |
Integer |
The object identifier. |
Return Data
| Node |
Data Type |
Description |
| manufacturer |
XML |
Container node. |
| createDate |
DateTime |
Creation date. |
| description |
XML Locale |
Localized description. |
| displayOrder |
Integer |
Sort order for display. |
| displayTemplate |
String |
The associated display template. |
| email |
String |
|
| extension |
XML |
Additional data. |
| manufacturerID |
Integer |
The object identifier. |
| manufacturerKey |
String |
A unique key that can be used to uniquely identify this object. This could be a short meaningful text or simply a GUID. |
| 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 manufacturer should be published and visible by end users. |
| updateDate |
DateTime |
Update date. |
| urlName |
XML Locale |
Localized URL name for SEO. |
GetManufacturers
This service is used to get all the Manufacturer 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. |
| manufacturers |
XML |
Container node |
| manufacturer |
XML |
Zero or more manufacturer nodes with same data structure as GetManufacturer service return data. |
InsertManufacturer
This service is used to create a new Manufacturer 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. |
| email |
No |
String |
|
| extension |
No |
XML |
Additional data. |
| manufacturerKey |
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. |
| 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 manufacturer should be published and visible by end users. |
| urlName |
No |
XML Locale |
Localized URL name for SEO. |
Return Data
Same as GetManufacturer service return data.
UpdateManufacturer
This service is used to update a Manufacturer 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. |
| manufacturerID |
Yes |
Integer |
The object identifier. |
| email |
No |
String |
|
| extension |
No |
XML |
Additional data. |
| manufacturerKey |
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. |
| 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 manufacturer should be published and visible by end users. |
| urlName |
No |
XML Locale |
Localized URL name for SEO. |
Return Data
Same as GetManufacturer service return data.