Carts in dealer wt.inf.library.WTLibrary-33096
$filter=dealerReference eq 'wt.inf.library.WTLibrary-33096'
Retrieves all carts that are unaffiliated. For example:
$filter=dealerReference eq 'unaffiliated'
Retrieves all carts in a set of dealerships, including unaffiliated carts. For example:
Carts in dealer wt.inf.library.WTLibrary-33096 and unaffiliated carts
$filter=dealerReference eq 'wt.inf.library.WTLibrary-33096' or
dealerReference eq 'unaffiliated'
If the activeCart is not specified no metadata for the active cart will be
returned. If the activeCart is specified, the $expand must specify
'activeCart'. For example:
$expand=activeCart
activeCart=com.ptc.sce.cart.SCEShoppingCart-12345
This service takes an SCList that has one SCItem containing all of the form input parameters from the Feedback UI as attributes. It uses these input parameters to send the feedback mail.
The default FeedbackDelegate supports the following
fields.
| comments | The feedback comments. |
| The user's email address. | |
| mobile_phone | The user's mobile phone number. |
| priority | The priority of the feedback.
This value is an integer with the following meanings. 1 = High2 = Medium 3 = Low Priority value can be customized. |
| contextId | A string representing the SCId of the serial number filter or product. |
| itemId | A string representing the SCId of the item where feedback was created. |
| itemParentId | A string representing the SCId of the item's parent. |
| breadcrumbPath | A string representing breadcrumb path of the context where feedback was created. |
This service takes an MultipartFormDataInput that has one SCItem containing all of the form input parameters from the Feedback UI as attributes and the attachments which the user want's to attach for the feedback. It uses these input parameters to send the feedback mail.
The default FeedbackDelegate supports the following
fields.
| comments | The feedback comments. |
| The user's email address. | |
| mobile_phone | The user's mobile phone number. |
| priority | The priority of the feedback.
This value is an integer with the following meanings. 1 = High2 = Medium 3 = Low Priority value can be customized. |
| contextId | A string representing the SCId of the serial number filter or product. |
| itemId | A string representing the SCId of the item where feedback was created. |
| itemParentId | A string representing the SCId of the item's parent. |
| breadcrumbPath | A string representing breadcrumb path of the context where feedback was created. |
items collection when
requesting the feedback use: $expand=items]]>Orders in dealer wt.inf.library.WTLibrary-33096
$filter=dealerReference eq 'wt.inf.library.WTLibrary-33096'
Retrieves all orders that are unaffiliated. For example:
$filter=dealerReference eq 'unaffiliated'
Retrieves all orders in a set of dealerships, including unaffiliated orders. For example:
Orders in dealer wt.inf.library.WTLibrary-33096 and unaffiliated orders
$filter=dealerReference eq 'wt.inf.library.WTLibrary-33096' or
dealerReference eq 'unaffiliated'
The client URL is sent as part of the metadata of the product SCItem.]]>
items collection when
requesting the profile use: $expand=items]]>$expand=preferences. The preferences will be available
at scItem.objects.preferences.metadata.
To expand the properties collection when requesting the user
use: $expand=properties. The properties will be available
at scItem.objects.properties.metadata.
To expand bookmarks collection when requesting the user
use: $expand=bookmarks. Bookmarks will be available
at scItem.collections.bookmarks.
To expand user privileges collection when requesting the user
use: $expand=userPrivileges. User privileges will be available
at scItem.collections.userPrivileges.
User privileges includes a list of privileges the current session user is granted from the following privileges list:
The following privileges are not included in the list as they are handled through a delegate: ORDER_SUBMITTER and ACCESS_PRICING_AVAILABILITY
The following named attributes are available on the user.
Carts in dealer wt.inf.library.WTLibrary-33096
$filter=dealerReference eq 'wt.inf.library.WTLibrary-33096'
Retrieves all carts that are unaffiliated. For example:
$filter=dealerReference eq 'unaffiliated'
Retrieves all carts in a set of dealerships, including unaffiliated carts. For example:
Carts in dealer wt.inf.library.WTLibrary-33096 and unaffiliated carts
$filter=dealerReference eq 'wt.inf.library.WTLibrary-33096' or
dealerReference eq 'unaffiliated'
If the activeCart is not specified no metadata for the active cart will be
returned. If the activeCart is specified, the $expand must specify
'activeCart'. For example:
$expand=activeCart
activeCart=com.ptc.sce.cart.SCEShoppingCart-12345
SCList of one SCItem containing all of
the form input parameters from the Send Email UI. It uses
these input parameters to send the email. The cart is send as an
attachment with chosen export type.
The UI has the following fields.
| Name | Description |
|---|---|
| exportType | list of available export types |
| subject | the email subject |
| recipients | comma separated email addresses for recipients |
| message | the message for email body |
SCItem containing all of
the form input parameters from the Send Email UI]]>items collection when
requesting the shopping cart use: $expand=items]]>items collection when
requesting the note use: $expand=items]]>items collection when
requesting the order use: $expand=items]]>The client URL is sent as part of the metadata of the product SCItem.]]>
The client URL is sent as part of the metadata of the product SCItem.]]>
$expand=children
To expand the primary topic root object when requesting the product
node use: $expand=primaryTopicRoot
To expand the product instances collection when requesting the product node
use: $expand=instances
To expand the effectivity filter collection when requesting the product node
use: $expand=effectivityFilters
$expand=children
To expand the infoElements collection when requesting the product node
use: $expand=elements
The following parameters are used by the getSearchResults endpoint:
]]>The following search types are supported when partSearch=true:
The following search types are supported when partSearch=false or default
The following parameters are used by the getSearchResultsURL endpoint:
]]>The following search types are supported when partSearch=true:
The following search types are supported when partSearch=false or default
The following parameters are used by the WebUrl endpoint:
]]>| name | description |
|---|---|
| keyword | Keyword that holds the search text. For example: $filter=keyword eq 'VALVE' -- Search for the text VALVE |
| infoType | Optional parameter indicating the search should be only for the information types listed.
The following information types are supported:
$filter=keyword eq 'VALVE' and infoType eq 'information' $filter=keyword eq 'VALVE' and infoType eq 'partsList,information' |
| searchType | Optional parameter indicating the search should be only for the types specified.
The following search types are supported:
$filter=keyword eq 'engine' and searchType eq 'Part Name' |
| searchcontext | Optional parameter indicating the search should be performed within a specific Product context.
The Product context should be in the format of an SCId.
For example: $filter=keyword eq 'pin' and searchcontext eq '3C-Product:NPF0000000004:PHToc:NSM00006943' |
$expand=children
To expand the elements collection when requesting the product node
use: $expand=elements
items collection when
requesting the wish list use: $expand=items]]>SCList of one SCItem containing all of
the form input parameters from the Send Email UI. It uses
these input parameters to send the email. The cart is send as an
attachment with chosen export type.
The UI has the following fields.
| Name | Description |
|---|---|
| exportType | list of available export types |
| subject | the email subject |
| recipients | comma separated email addresses for recipients |
| message | the message for email body |
SCItem containing all of
the form input parameters from the Send Email UI]]>items collection when
requesting the wish list use: $expand=items]]>
{
"items": [
{
"attributes": {
"description": "",
"partNumber": "",
"quantity": ""
}
}]}
For internal items "e3cNavLink.itemId" attribute needs to be included in addition to quantity and description attribute. Internal items can also include a context that can be found as part of the NavLink information on the part.
Example of an internal item without context JSON structure
{
"items": [
{
"attributes": {
"description": "",
"e3cNavLink.itemId": "",
"quantity": ""
}
}]}
Example of an internal item with context
{
"items": [
{
"attributes": {
"description": "",
"e3cNavLink.contextId": "",
"e3cNavLink.itemId": "",
"e3cNavLink.itemParentId": "",
"quantity": ""
}
}]}
]]>$expand=children
To expand the primary topic root object when requesting the product
node use: $expand=primaryTopicRoot
To expand the product instances collection when requesting the product node
use: $expand=instances
To expand the effectivity filter collection when requesting the product node
use: $expand=effectivityFilters
items collection when
requesting the user use: $expand=items]]>$expand=children.]]>$expand=children]]>
{
"items": [
{
"attributes": {
"description": "",
"partNumber": "",
"quantity": ""
}
}]}
For internal items "e3cNavLink.itemId" attribute needs to be included in addition to quantity and description attribute. Internal items can also include a context that can be found as part of the NavLink information on the part.
Example of an internal item without context JSON structure
{
"items": [
{
"attributes": {
"description": "",
"e3cNavLink.itemId": "",
"quantity": ""
}
}]}
Example of an internal item with context
{
"items": [
{
"attributes": {
"description": "",
"e3cNavLink.contextId": "",
"e3cNavLink.itemId": "",
"e3cNavLink.itemParentId": "",
"quantity": ""
}
}]}
]]>$expand=children
To expand the primary topic root object when requesting the product
node use: $expand=primaryTopicRoot
To expand the product instances collection when requesting the product node
use: $expand=instances
To expand the effectivity filter collection when requesting the product node
use: $expand=effectivityFilters