Product Administration REST APIs

Overview

Product Administration endpoints expose product definition information for the Configuration All Product Families, Product Families, Product Lines, Models, actions, attributes, menu items, menu item images, and menu item prices. The information for these items is organized in a hierarchical structure. View hierarchical relationships for Configuration Product Administration REST API services.

Deploy a Product Family
Description	Use this endpoint to deploy the specified Product Family. Deployments can be scheduled, and users can set up email notifications. Data tables associated with rules can be deployed along with the product family.
URI Endpoint	/rest/v17/allProductFamilySetups/{allProdFamsVarName}/productFamilies/{prodFamVarName}/actions/deploy
Endpoint Parameters	allProdFamsVarName	The variable name of All Product Families
Endpoint Parameters	prodFamVarName	The variable name of a Product Family
HTTP Method	POST
Request Body Parameters	dataTables	(Optional) An array of selected product family related data table variable names.
	emailTo	(Optional) Email address to send a confirmation email.
	scheduledTime	(Optional) Time to start the deploy
Response Body Parameters	Links to self and the deploy task.

Get List of Related, Undeployed Data Tables
Description	Use this endpoint to retrieve a list of undeployed data tables that are referenced within the Product Family's table based Configuration rules.
URI Endpoint	/rest/v17/allProductFamilySetups/{allProdFamsVarName}/productFamilies/{prodFamVarName}/actions/getRelatedUndeployedDataTables
Endpoint Parameters	allProdFamsVarName	The variable name of All Product Families
Endpoint Parameters	prodFamVarName	The variable name of a Product Family
HTTP Method	POST
Request Body Parameters	None
Response Body Parameters	An array of undeployed data tables that are referenced within the product family's table based configuration rules.

Get an All Product Families Definition
Description	Use this endpoint to retrieve the specified All Product Families definition.
URI Endpoint	/rest/v17/allProductFamilySetups/{allProdFamsVarName}
Endpoint Parameters	allProdFamsVarName	The variable name of All Product Families
Endpoint Parameters	(Optional) This endpoint supports the `expand` query specification, for more information, see Manage Collections.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	JSON data containing the All Products Families company Id, variable name, and label. The response also contains links to All Product Families attributes and child Product Families.

Add a Product Family Action
Description	Use this endpoint to create a Product Family action.
URI Endpoint	/rest/v17/allProductFamilySetups/{allProdFamsVarName}/productFamilies/{prodFamVarName}/_actions
Endpoint Parameters	allProdFamsVarName	The variable name of All Product Families
Endpoint Parameters	prodFamVarName	The variable name of a Product Family
HTTP Method	POST
Request Body Parameters	description	The description for the action
	label	The label for the action
	status	The status for the action
	variableName	The variable name for the action
Response Body Parameters	The Product Family action containing the variable name, reference type, description, date modified, user modified first & last name, date added, user added first & last name, label, id, and status.

Add a Product Family Action Translation
Description	Use this endpoint to create a translation for the specified Product Family action.
URI Endpoint	/rest/v17/allProductFamilySetups/{allProdFamsVarName}/productFamilies/{prodFamVarName}/_actions/{actionVarName}/translations
Endpoint Parameters	allProdFamsVarName	The variable name of All Product Families
	prodFamVarName	The variable name of a Product Family
	actionVarName	The variable name of an Action
HTTP Method	POST
Request Body Parameters	description	The action translation
	id	The unique key identifying the action translation.
	language	The defined language of the rows translated columns.
Response Body Parameters	The Product Family action translation description, date modified, language, ids, label, and date added.

Delete a Product Family Action
Description	Use this endpoint to delete the specified Product Family action.
URI Endpoint	/rest/v17/allProductFamilySetups/{allProdFamsVarName}/productFamilies/{prodFamVarName}/_actions/{actionVarName}
Endpoint Parameters	allProdFamsVarName	The variable name of All Product Families
	prodFamVarName	The variable name of a Product Family
	actionVarName	The variable name of an Action
HTTP Method	DELETE
Request Body Parameters	None
Response Status	204

Get a Product Family Action Translation
Description	Use this endpoint to retrieve a Product Family action translation.
URI Endpoint	/rest/v17/allProductFamilySetups/{allProdFamsVarName}/productFamilies/{prodFamVarName}/_actions/{actionVarName}/translations/{translation_Id}
Endpoint Parameters	allProdFamsVarName	The variable name of All Product Families
	prodFamVarName	The variable name of a Product Family
	actionVarName	The variable name of an Action
	translation_Id	Identifier for the translation
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	The Product Family action translation description, date modified, language, ids, label, and date added.

Get List of Product Family Action Translations
Description	Use this endpoint to retrieve all translations for the specified Product Family action.
URI Endpoint	/rest/v17/allProductFamilySetups/{allProdFamsVarName}/productFamilies/{prodFamVarName}/_actions/{actionVarName}/translations
Endpoint Parameters	allProdFamsVarName	The variable name of All Product Families
	prodFamVarName	The variable name of a Product Family
	actionVarName	The variable name of an Action
	(Optional) This endpoint supports the following query specifications.`q`, `fields`, `limit`, `offset`, `orderby`, and `totalResults`, for more information, see Manage Collections.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	A list of Product Family action translations containing the description, date modified, language, ids, label, and date added.

Update a Product Family Action
Description	Use this endpoint to update the specified Product Family action.
URI Endpoint	/rest/v17/allProductFamilySetups/{allProdFamsVarName}/productFamilies/{prodFamVarName}/_actions/{actionVarName}
Endpoint Parameters	allProdFamsVarName	The variable name of All Product Families
	prodFamVarName	The variable name of a Product Family
	actionVarName	The variable name of an Action
HTTP Method	PUT
Request Body Parameters	description	The description for the action
	label	The label for the action
	status	The status for the action
	variableName	The variable name for the action
Response Status	204

Add a Product Line Action
Description	Use this endpoint to create a Product Line action.
URI Endpoint	/rest/v17/allProductFamilySetups/{allProdFamsVarName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/_actions
Endpoint Parameters	allProdFamsVarName	The variable name of All Product Families
	prodFamVarName	The variable name of a Product Family
	prodLineVarName	The variable name of a Product Line
HTTP Method	POST
Request Body Parameters	description	The description for the action
	label	The label for the action
	status	The status for the action
	variableName	The variable name for the action
Response Body Parameters	The Product Line action containing the variable name, reference type, description, date modified, user modified first & last name, date added, user added first & last name, label, id, and status.

Add a Model Action
Description	Use this endpoint to create a Model action.
URI Endpoint	/rest/v17/allProductFamilySetups/{allProdFamsVarName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}_actions
Endpoint Parameters	allProdFamsVarName	The variable name of All Product Families
	prodFamVarName	The variable name of a Product Family
	prodLineVarName	The variable name of a Product Line
	modelVarName	The variable name of a Model
HTTP Method	POST
Request Body Parameters	description	The description for the action
	label	The label for the action
	status	The status for the action
	variableName	The variable name for the action
Response Body Parameters	The Model action containing the variable name, reference type, description, date modified, user modified first & last name, date added, user added first & last name, label, id, and status.

Get a Product Family Attribute
Description	Use this endpoint to retrieve for the specified Product Family attribute.
URI Endpoint	/rest/v17/allProductFamilySetups/{allProdFamsVarName}/productFamilies/{prodFamVarName}/attributes/{attributeVarName}
Endpoint Parameters	allProdFamsVarName	The variable name of All Product Families
	prodFamVarName	The variable name of a Product Family
	attributeVarName	The variable name of an attribute
	(Optional) This endpoint supports the `expand` query specification, for more information, see Manage Collections.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	JSON data containing a Product Family attribute order number, variable name, display value, description, Id, attribute type, and lookup codes. The response also contains links to lookup values and menu items (if applicable).

Add an All Product Families Menu Item
Description	Use this endpoint to create an All Product Families menu item.
URI Endpoint	/rest/v17/allProductFamilySetups/{allProdFamsVarName}/attributes/{attributeVarName}/menuItems
Endpoint Parameters	allProdFamsVarName	The variable name of All Product Families
Endpoint Parameters	attributeVarName	The variable name of an attribute
HTTP Method	POST
Request Body Parameters	itemText	The menu item text
	itemValue	The menu item value
	orderNumber	The order of the menu item
Response Body Parameters	The response for the new menu item contains the following information: order number, item value, id, item text, date added, and date modified. The response also contains links to menu images, menu prices, and the parent attribute.

Add an All Product Families Menu Item Image
Description	Use this endpoint to associate an image to the applicable All Product Families menu item.
URI Endpoint	/rest/v17/allProductFamilySetups/{allProdFamsVarName}/attributes/{attributeVarName}/menuItems/{menuItem_Id}/images
Endpoint Parameters	allProdFamsVarName	The variable name of All Product Families
	attributeVarName	The variable name of an attribute
	menuItem_Id	The Id of a menu item
HTTP Method	POST
Request Body Parameters	relativePath	The relative path to an image that has already been uploaded to the File Manager.
Response Body Parameters	The response for the new menu item image contains the following information: relative path, id, date added, and date modified. The response also contains links to menu image item and the parent menu item.

Add an All Product Families Menu Item Price
Description	Use this endpoint to add a price to the applicable All Product Families menu item.
URI Endpoint	/rest/v17/allProductFamilySetups/{allProdFamsVarName}/attributes/{attributeVarName}/menuItems/{menuItem_Id}/prices
Endpoint Parameters	allProdFamsVarName	The variable name of All Product Families
	attributeVarName	The variable name of an attribute
	menuItem_Id	The Id of a menu item
HTTP Method	POST
Request Body Parameters	price	The price object containing the value and currency.
Response Body Parameters	The response for the new menu item price contains the following information: price value and currency, id, date added, and date modified. The response also contains links to menu price item and the parent menu item.

Add an All Product Families Menu Item Translation
Description	Use this endpoint to add a translation to the applicable All Product Families menu item.
URI Endpoint	/rest/v17/allProductFamilySetups/{allProdFamsVarName}/attributes/{attributeVarName}/menuItems/{menuItem_Id}/translations
Endpoint Parameters	allProdFamsVarName	The variable name of All Product Families
	attributeVarName	The variable name of an attribute
	menuItem_Id	The Id of a menu item
HTTP Method	POST
Request Body Parameters	language	The language object containing the language code.
Request Body Parameters	itemText	The translated value for the menu item
Response Body Parameters	The response for the new menu item translation contains the following information: language number, language code, the translation language id, the menu item translation id, the translated value, date added, and date modified. The response also contains links to translations, menu image item translation, and the parent menu item.

Remove an All Product Families Menu Item Override
Description	Use this endpoint to remove an override for the specified All Product Families menu item.
URI Endpoint	/rest/v17/allProductFamilySetups/{allProdFamsVarName}/attributes/{attributeVarName}/menuItems/actions/removeOverride
Endpoint Parameters	allProdFamsVarName	The variable name of All Product Families
Endpoint Parameters	attributeVarName	The variable name of an attribute
HTTP Method	POST
Request Body Parameters	None
Success Response	200 OK

Add a Model Menu Item
Description	Use this endpoint to create a Model menu item.
URI Endpoint	/rest/v17/allProductFamilySetups/{allProdFamsVarName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/attributes/{attributeVarName}/menuItems
Endpoint Parameters	allProdFamsVarName	The variable name of All Product Families
	prodFamVarName	The variable name of a Product Family
	prodLineVarName	The variable name of a Product Line
	modelVarName	The variable name of a Model
	attributeVarName	The variable name of an attribute
HTTP Method	POST
Request Body Parameters	itemText	The menu item text
	itemValue	The menu item value
	orderNumber	The order of the menu item
Response Body Parameters	The response for the new menu item contains the following information: order number, item value, id, item text, date added, and date modified. The response also contains links to menu images, menu prices, and the parent attribute.

Product Administration REST APIs

Overview

Administration

Product Definitions

All Product Families

Product Family

Product Line

Model

Actions

Product Family

Product Line

Model

Attributes

All Product Families

Product Family

Product Line

Model

Menu Items

All Product Families

Product Family

Product Line

Model

Get a Model Menu Item Image

Get a Model Menu Item Price

Related Topics