Routes
Subcategories: Attachments, Notes
The route resource is used to view, create, and update routes. A route is a retail execution unit that includes ordered store visits.
|
Resource Plural Label |
Routes |
|
Resource Name |
__ORACO__Route_c |
Get All Routes
Request: GET
URI: crmRestApi/resources/11.13.18.05/__ORACO__Route_c
Request Path Parameters
There are no request path parameters for this task.
Request Query Parameters
Use the listed finder parameters to query the resource:
| Finder Name | Description |
|---|---|
|
PrimaryKey |
Finds a Route with the specified primary key. Finder Variables:
|
Request Body
There are no elements in the request body for this task.
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Create a Route
Request: POST
URI: crmRestApi/resources/11.13.18.05/__ORACO__Route_c
Request Path Parameters
There are no request path parameters for this task.
Request Body
This table summarizes the supported request body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Get a Route
Request: GET
URI: crmRestApi/resources/11.13.18.05/__ORACO__Route_c/{Id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
Integer |
The unique identifier of the Route. |
Request Body
There are no elements in the request body for this task.
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Update a Route
Request: PATCH
URI: crmRestApi/resources/11.13.18.05/__ORACO__Route_c/{Id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
Integer |
The unique identifier of the Route. |
Request Body
This table summarizes the supported request body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Replace a Route
Request: PUT
URI: crmRestApi/resources/11.13.18.05/__ORACO__Route_c/{Id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
Integer |
The unique identifier of the Route. |
Request Body
This table summarizes the supported request body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Delete a Route
Request: DELETE
URI: crmRestApi/resources/11.13.18.05/__ORACO__Route_c/{Id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
Integer |
The unique identifier of the Route. |
Request Body
There are no elements in the request body for this task.
Response Body
There are no elements in the response body for this task.
List of Values
This table lists all the list of values of the resource.
| LOV Name | Source Attribute in LOV | Target Attribute in Resource |
|---|---|---|
|
ViewAccessor_CurrencyCode |
CurrencyCode |
CurrencyCode |
|
LOVVA_For___ORACO__ProcessingGroup_c |
LookupCode |
__ORACO__ProcessingGroup_c |
|
LOVVA_For___ORACO__RestockingFrequency_c |
LookupCode |
__ORACO__RestockingFrequency_c |
|
FK_LOVVA_For___ORACO__TerritoryManager_c |
ResourceProfileId |
__ORACO__TerritoryManager_Id_c |
|
LOVVA_For___ORACO__TerritoryManager_c |
PartyName |
__ORACO__TerritoryManager_c |
|
LOVVA_For___ORACO__TerritoryManager_c |
ResourceProfileId |
__ORACO__TerritoryManager_Id_c |
|
FK_LOVVA_For___ORACO__DistributionCentre_c |
Id |
__ORACO__DistributionCentre_Id_c |
|
LOVVA_For___ORACO__DistributionCentre_c |
RecordName |
__ORACO__DistributionCentre_c |
|
LOVVA_For___ORACO__DistributionCentre_c |
Id |
__ORACO__DistributionCentre_Id_c |
|
FK_LOVVA_For___ORACO__PriceBook_c |
PricebookId |
__ORACO__PriceBook_Id_c |
|
LOVVA_For___ORACO__PriceBook_c |
Name |
__ORACO__PriceBook_c |
|
LOVVA_For___ORACO__PriceBook_c |
PricebookId |
__ORACO__PriceBook_Id_c |
Resource Attributes
This table lists all the attributes of the resource.
| Attribute Name | Attribute Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the Route. UI Label: Record ID |
|
RowType |
string |
The type field for the categorization of the records. Properties: The maximum length is 80. |
|
RecordName |
string |
The name of the Route. Properties: The maximum length is 80. UI Label: Route Number |
|
CreatedBy |
string |
The user who created the Route. Properties: The maximum length is 32. UI Label: Created By |
|
CreationDate |
datetime |
The date when the Route was created. UI Label: Creation Date |
|
LastUpdatedBy |
string |
The user who last updated the Route. Properties: The maximum length is 32. UI Label: Last Updated By |
|
LastUpdateDate |
datetime |
The date when the Route was last updated. UI Label: Last Update Date |
|
LastUpdateLogin |
string |
The login of the user who last updated the Route. Properties: The maximum length is 32. |
|
UserLastUpdateDate |
datetime |
The date and time of the last user update made from a personal device. This value is different from LAST_UPDATE_DATE if the record was originally updated in a different database (That is, a different mobile database or the server). |
|
CurrencyCode |
string |
The currency code. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. Properties: The maximum length is 15. UI Label: Currency Code |
|
CurcyConvRateType |
string |
The currency conversion rate type. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. Properties: The maximum length is 15. |
|
CorpCurrencyCode |
string |
The corporate currency code associated with the assortment. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. Properties: The maximum length is 15. |
|
SourceType |
string |
The type of the source object as defined in the object metadata. "> |
|
__ORACO__ProcessingGroup_c |
string |
The name of the processing group to which the route belongs. This is used for route upload processing in Sales and Fusion Service. The lookup type is ORA_ACO_ROUTE_PROC_GROUP. Properties: The maximum length is 1500. UI Label: Processing Group |
|
__ORACO__RestockingFrequency_c |
string |
The frequency at which the route inventory will be restocked. Properties: The maximum length is 1500. UI Label: Restocking Frequency |
|
__ORACO__TerritoryManager_Id_c |
integer |
The internal unique identifier of the Territory Manager who manages the route. UI Label: Territory Manager |
|
__ORACO__TerritoryManager_c |
string |
The name of the Territory Manager who manages the route. Properties: The maximum length is 1500. UI Label: Territory Manager |
|
__ORACO__CurrentMileage_c |
integer |
The current mileage of the vehicle assigned to the route. UI Label: Vehicle Current Mileage |
|
__ORACO__LastServiceDate_c |
date |
The date when the vehicle assigned to the route was last serviced. UI Label: Vehicle Last Service Date |
|
__ORACO__Make_c |
string |
The type of the vehicle assigned to the route. Properties: The maximum length is 80. UI Label: Vehicle Make |
|
__ORACO__Model_c |
string |
The model of the vehicle assigned to the route. Properties: The maximum length is 80. UI Label: Vehicle Model |
|
__ORACO__NextServiceDate_c |
date |
The date when the vehicle assigned to the route is to be next serviced. UI Label: Vehicle Next Service Date |
|
__ORACO__Plate_c |
string |
The license plate number of the vehicle assigned to the route. Properties: The maximum length is 80. UI Label: Vehicle Plate |
|
__ORACO__StartingMileage_c |
integer |
The initial mileage of the vehicle assigned to the route. UI Label: Vehicle Starting Mileage |
|
__ORACO__Year_c |
integer |
The manufacturing year of the vehicle assigned to the route. UI Label: Vehicle Year |
|
__ORACO__DistributionCentre_Id_c |
integer |
The internal unique identifier of the Distribution Center associated with the route. UI Label: Distribution Center |
|
__ORACO__DistributionCentre_c |
string |
The name of the Distribution Center associated with the route. Properties: The maximum length is 1500. UI Label: Distribution Center |
|
__ORACO__PriceBook_Id_c |
integer |
The internal unique identifier of the price book associated with the route. UI Label: Price Book |
|
__ORACO__PriceBook_c |
string |
The name of the price book associated with the route. Properties: The maximum length is 1500. UI Label: Price Book |
|
__ORACO__AuxiliaryAttribute01_c |
string |
Additional internal fields for development usage. Properties: The maximum length is 80. UI Label: Auxiliary Attribute 01 |
|
__ORACO__AuxiliaryAttribute02_c |
string |
Additional internal fields for development usage. Properties: The maximum length is 80. UI Label: Auxiliary Attribute 02 |
|
__ORACO__AuxiliaryAttribute03_c |
string |
Additional internal fields for development usage. Properties: The maximum length is 80. UI Label: Auxiliary Attribute 03 |
|
__ORACO__AuxiliaryAttribute04_c |
string |
Additional internal fields for development usage. Properties: The maximum length is 80. UI Label: Auxiliary Attribute 04 |
|
__ORACO__AuxiliaryAttribute05_c |
string |
Additional internal fields for development usage. Properties: The maximum length is 80. UI Label: Auxiliary Attribute 05 |
|
__ORACO__AuxiliaryAttribute06_c |
integer |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 06 |
|
__ORACO__AuxiliaryAttribute07_c |
integer |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 07 |
|
__ORACO__AuxiliaryAttribute08_c |
integer |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 08 |
|
__ORACO__AuxiliaryAttribute09_c |
integer |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 09 |
|
__ORACO__AuxiliaryAttribute10_c |
integer |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 10 |
|
__ORACO__AuxiliaryAttribute11_c |
date |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 11 |
|
__ORACO__AuxiliaryAttribute12_c |
date |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 12 |
|
__ORACO__AuxiliaryAttribute13_c |
datetime |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 13 |
|
__ORACO__AuxiliaryAttribute14_c |
datetime |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 14 |