POST api/ListProductModifiers
Returns a list of all the Product Modifier Names and Types, along with their internal identifiers.
Product Modifiers are assigned to provide more detailed information about a product to facilitate
selection of the most appropriate product.
Includes a ‘MaxResults’ option that allows you to limit the number of results returned.
Request Information
URI Parameters
None.
Body Parameters
ListProductModifiersRequestName | Description | Type | Additional information |
---|---|---|---|
MaxResults | Limits the number of results returned. A null value means no limit, and everthing will be returned. | integer |
None. |
AccessToken |
Temporary access token from the GSDD Auth API.
Used to validate your license.
Note: Access tokens are temporary and may be invalidated early for various reasons, including—but not limited to—site maintenance and security updates. If a token is invalidated prematurely, simply request new tokens via the AccessToken method in the GSDD Auth API. This is a rather rare occurrence, but should be planned for and handled by the consuming application. |
string |
Required |
Request Formats
application/json, text/json
Sample:
{ "MaxResults": 10, "AccessToken": "T25lX0hhcHB5X0FuZF9TYXRpc2ZpZWRfR1NERF9DdXN0b21lcl9TYW1wbGVfQWNjZXNzVG9rZW4=" }
Response Information
Resource Description
ListProductModifiersResponseName | Description | Type | Additional information |
---|---|---|---|
ProductModifiers | Returns the Product Modifiers. | Collection of ProductModifierName |
None. |
Response Formats
application/json, text/json
Sample:
{ "ProductModifiers": [ { "ProductModifierId": 1, "ProductModiferName": "Sample ProductModiferName text.", "ProductModifierTypeId": 2, "ProductModiferTypeName": "Sample ProductModiferTypeName text." }, { "ProductModifierId": 3, "ProductModiferName": "Sample ProductModiferName text.", "ProductModifierTypeId": 4, "ProductModiferTypeName": "Sample ProductModiferTypeName text." } ] }