Shipment Lines
Subcategories: Attachments, Notes
The shipment line resource is used to create, view, update, or delete shipment line requests.
|
Resource Plural Label |
Shipment Lines |
|
Resource Name |
__ORACO__ShipmentLineDSD_c |
Get All Shipment Lines
Request: GET
URI: /crmRestApi/resources/11.13.18.05/__ORACO__ShipmentLineDSD_c
Request Path Parameters
There are no request path parameters for this task.
Request Query Parameters
Use these finder parameters to query the resource:
| Finder Name | Description |
|---|---|
|
Primary Key |
Finds a shipment line 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 |
Get a Shipment Line
Request: GET
URI: /crmRestApi/resources/11.13.18.05/__ORACO__ShipmentLineDSD_c
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the shipment line. |
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 Shipment Line
Request: POST
URI: /crmRestApi/resources/11.13.18.05/__ORACO__ShipmentLineDSD_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 |
Update a Shipment Line
Request: PATCH
URI: /crmRestApi/resources/11.13.18.05/__ORACO__ShipmentLineDSD_c/{Id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the shipment line. |
Request Body
This table summarizes the 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 Shipment Line
Request: PUT
URI: /crmRestApi/resources/11.13.18.05/__ORACO__ShipmentLineDSD_c/{Id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the shipment line. |
Request Body
This table summarizes the 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 Shipment Line
Request: DELETE
URI: /crmRestApi/resources/11.13.18.05/__ORACO__ShipmentLineDSD_c/{Id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the shipment line. |
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 |
|
FK_LOVVA_For___ORACO__Account_c |
OrganizationProfileId |
__ORACO__Account_Id_c |
|
LOVVA_For___ORACO__Account_c |
OrganizationName |
__ORACO__Account_c |
|
FK_LOVVA_For___ORACO__Product_c |
InventoryItemId |
__ORACO__Product_Id_c |
|
LOVVA_For___ORACO__Product_c |
Name |
__ORACO__Product_c |
|
FK_LOVVA_For___ORACO__Shipment_c |
Id |
__ORACO__Shipment_Id_c |
|
LOVVA_For___ORACO__Shipment_c |
RecordName |
__ORACO__Shipment_c |
|
FK_LOVVA_For___ORACO__Promotion_c |
Id |
__ORACO__Promotion_Id_c |
|
LOVVA_For___ORACO__Promotion_c |
RecordName |
__ORACO__Promotion_c |
|
FK_LOVVA_For___ORACO__ComboGroup_c |
Id |
__ORACO__ComboGroup_Id_c |
|
LOVVA_For___ORACO__ComboGroup_c |
__ORACO__Name_c |
__ORACO__ComboGroup_c |
Resource Attributes
This table lists all the attributes of the resource.
| Attribute Name | Attribute Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the shipment line. UI Label: Record ID |
|
RowType |
string |
This is the type field for categorization of records. The value will always be __ORACO__PaymentLine DSD_c. Properties: The maximum length is 80. |
|
RecordName |
string |
The name of the shipment line. Properties: The maximum length is 80. UI Label: Shipment Line Number |
|
CreatedBy |
string |
The user who created the record. Properties: The maximum length is 32. UI Label: Created By |
|
CreationDate |
datetime |
The date when the record was created. UI Label: Creation Date |
|
LastUpdatedBy |
string |
The user who last updated the record. Properties: The maximum length is 32. UI Label: Last Updated By |
|
LastUpdateDate |
datetime |
The date when the record was last updated. UI Label: Last Update Date |
|
LastUpdateLogin |
string |
The login of the user who last updated the record. Properties: The maximum length is 32. |
|
UserLastUpdateDate |
datetime |
The date and time of the last update from mobile. |
|
CurrencyCode |
string |
The currency code associated with the record. 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 record. 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 |
A system-generated read-only attribute used by the application framework. Properties: The maximum length is 0. |
|
__ORACO__Account_Id_c |
integer |
The unique identifier of account associated with shipment line. UI Label: Account |
|
__ORACO__Account_c |
string |
The name of the account associated with shipment line. Properties: The maximum length is 1500. UI Label: Account |
|
__ORACO__ShipmentLineLN_c |
integer |
The line number for a shipment line within a shipment. UI Label: Line Number |
|
__ORACO__OrderLineLN_c |
integer |
The line number of the order line for which the shipment line is generated. UI Label: Order Line - Line Number |
|
__ORACO__OrderLineRN_c |
integer |
The revision number of the order line for which the shipment line is generated. UI Label: Order Line - Revision Number |
|
__ORACO__OrderLineSS_c |
string |
The external application where the order line originated from. Properties: The maximum length is 80. UI Label: Order Line - Source System |
|
__ORACO__OrderLineSSN_c |
integer |
The unique identifier in the source application of the order line for which the shipment line is generated. UI Label: Order Line - Source System Number |
|
__ORACO__OrderLineNumber_c |
string |
The unique identifier of the order line for which a shipment line is generated. Properties: The maximum length is 80. UI Label: Order Line Number |
|
__ORACO__Product_Id_c |
integer |
The unique identifier of the product which is being shipped. UI Label: Product |
|
__ORACO__Product_c |
string |
The name of the product which is being shipped. Properties: The maximum length is 1500. UI Label: Product |
|
__ORACO__Quantity_c |
integer |
The count of the product that is being shipped. UI Label: Quantity |
|
__ORACO__RequestedDate_c |
date |
The date when the delivery of the shipment line was requested. UI Label: Requested Date |
|
__ORACO__ScheduledDate_c |
date |
The date when the shipment is scheduled line for delivery. UI Label: Scheduled Date |
|
__ORACO__Shipment_Id_c |
integer |
The unique identifier of the shipment to which the shipment line belongs. UI Label: Shipment |
|
__ORACO__Shipment_c |
string |
The name of the shipment to which the shipment line belongs. Properties: The maximum length is 1500. UI Label: Shipment |
|
__ORACO__ShipmentNumber_c |
string |
The number of the shipment to which the shipment line belongs. Properties: The maximum length is 80. UI Label: Shipment Number |
|
__ORACO__ShipmentLineSS_c |
string |
The external application where the shipment line originated from. Properties: The maximum length is 80. UI Label: Source System |
|
__ORACO__ShipmentLineSSN_c |
integer |
The unique identifier of the shipment line in the source application. UI Label: Source System Number |
|
__ORACO__UOM_c |
string |
The standard for measuring the quantity of the products. Properties: The maximum length is 80. UI Label: UOM |
|
__ORACO__UOMCode_c |
string |
The code indicating the standard for measuring the quantity of products in the shipment line. Properties: The maximum length is 80. UI Label: UOM Code |
|
__ORACO__ShipmentLineDate_c |
date |
The date when the shipment line is expected to be delivered. UI Label: Shipment Line Date |
|
__ORACO__CreatedOn_c |
integer |
The date when the shipment line was created. UI Label: Created On |
|
__ORACO__Promotion_Id_c |
integer |
The unique identifier of the promotion which was applied when creating the order. UI Label: Promotion |
|
__ORACO__Promotion_c |
string |
The name of the promotion which was applied when creating the order. Properties: The maximum length is 1500. UI Label: Promotion |
|
__ORACO__ComboGroup_Id_c |
integer |
The unique identifier of the combo group which was applied when creating the order. This value indicates if the promotion type is a fixed combo or a dynamic combo. UI Label: Combo Group |
|
__ORACO__ComboGroup_c |
string |
The name of the combo group which was applied when creating the order. This value indicates if the promotion type is a fixed combo or a dynamic combo. Properties: The maximum length is 1500. UI Label: Combo Group |
|
__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 |