Get one order line
/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHub/{OrderKey}/child/lines/{linesUniqID}
Request
-
OrderKey(required): string
Value that uniquely identifies the sales order. It can have the following formats.
- Concatenation of SourceOrderSystem, a colon, and the value of SourceTransactionId. For orders created through the Oracle Fusion Cloud Order Management work area, the SourceTransactionId is same as the HeaderId. For example, if SourceOrderSystem is LEG and SourceTransactionId is R13_Sample_Order, the value of this attribute is LEG:R13_Sample_Order. This format of the OrderKey in the URL always returns the latest version of the sales order. When a draft exists, that becomes the latest version of the sales order. When invoking GET sales order using this OrderKey format, the URLs in the "links" section point to the latest version of the sales order and the corresponding child objects.
Example: /salesOrdersForOrderHub/LEG:R13_Sample_Order points to the latest version of the order with SourceTransactionId "R13_Sample_Order" in the SourceOrderSystem "LEG".
- Primary key of the sales order, which is HeaderId. This format of the OrderKey is useful when the order has multiple revisions because it helps in accessing either the older version or the latest version of the order. When there's a draft revision then HeaderId can be used to access the processing order. When invoking GET sales order using this OrderKey format, the URLs in the "links" section also point to that specific version of the sales order and the corresponding child objects. Only the Get operation is supported on older revisions of the order.
Example: /salesOrdersForOrderHub/12345 points to an order with HeaderId 12345.
When a q parameter or query finder is used to GET an order that has multiple versions then the latest version has the OrderKey in the format <sourceOrderSystem>:<SourceTransactionId> whereas reference orders have OrderKey in the format of HeaderId. -
linesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Order Lines resource and used to uniquely identify an instance of Order Lines. The client should not generate the hash key value. Instead, the client should query on the Order Lines collection resource in order to navigate to a specific instance of Order Lines to get the hash key.
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
- application/json
Default Response
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
object-
AccountingRule: string
Maximum Length:
255Accounting rule that determines the accounting timeframe or timeframes to use when distributing revenue for an invoice line. -
AccountingRuleCode: string
Maximum Length:
255Abbreviation that identifies the accounting rule. -
ActionType: string
Maximum Length:
255Value that identifies the type of the action with respect to the coverage or the subscription product on fulfillment line. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features. -
ActionTypeCode: string
Maximum Length:
30Abbreviation that identifies the type of action with respect to the coverage or the subscription product on fulfillment line. Say Add, Update, Renew in case of coverage. Resume, Suspend, terminate in case of subscriptions. A list of accepted values is defined in the lookup type ORA_QP_ACTION_TYPES. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features. -
ActualCompletionDate: string
(date-time)
Title:
Actual Completion DateRead Only:trueDate when the application fulfilled the fulfillment line. -
ActualShipDate: string
(date-time)
Title:
Actual Ship DateRead Only:trueDate when the application sent the shipment. -
additionalInformation: array
Details
Title:
DetailsThe Additional Details resource manages details that flexfields store for the sales order. -
AgreementHeaderId: integer
(int64)
Value that uniquely identifies the sales agreement on the order line.
-
AgreementLineId: integer
(int64)
Read Only:
trueValue that uniquely identifies the sales agreement line on the order line. -
AgreementLineNumber: string
Read Only:
trueMaximum Length:255Number of the sales agreement line on the order line. -
AgreementNumber: string
Maximum Length:
255Number that identifies the sales agreement on the order line. -
AgreementVersionNumber: integer
(int64)
Read Only:
trueVersion number of the sales agreement on the order line. -
amendSubscriptionReferences: array
Amend Subscription References
Title:
Amend Subscription ReferencesThe Amend Subscription References resource manages details about unique references to the subscription product in Oracle Subscription Management Cloud. When ActionTypeCode is ORA_AMEND, this information is used for ending the old subscription lines in Subscription Management that are replaced by the new subscription being created in Subscription Management. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features. -
AppliedPriceListId: integer
(int64)
Read Only:
trueValue that identifies the price list that pricing applied. -
AppliedPriceListName: string
Read Only:
trueMaximum Length:255Name of the price list that pricing applied. -
AssessableValue: number
Price that a tax authority uses to value, and then tax the item.
-
AssetGroupNumber: string
Maximum Length:
30Value that groups customer assets into different categories. -
AssetTrackedFlag: boolean
Maximum Length:
1Abbreviation that identifies whether the fulfill line is eligible to be interfaced to asset management for tracking customer assets that are created from order processing. This attribute is not currently used. -
AssetTracking: string
Read Only:
trueMaximum Length:255Value that identifies whether the fulfillment line is eligible to be interfaced to asset management for tracking customer assets that are created from order processing. -
AssetTrackingCode: string
Maximum Length:
1Abbreviation that identifies whether the fulfill line is eligible to be interfaced to asset management for tracking customer assets that are created from order processing. A list of accepted values is defined in the lookup type ORA_EGP_ASSET_TRACKING. -
assetTransactionDetails: array
Asset Transaction Details
Title:
Asset Transaction DetailsThe Asset Transaction Details resource manages the asset transaction details to support license migration orders. This resource is not currently used. -
associatedProductReferences: array
Associated Product Items
Title:
Associated Product ItemsThe Associated Product Items resource manages details about the product item that is associated with the subscription item on an order line. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features. -
attachments: array
Attachments
Title:
AttachmentsThe Attachments resource manages attachments for the order header and order line. -
billingPlans: array
Billing Plans
Title:
Billing PlansThe Billing Plans resource manages the billing plan for the sales order. -
BillingTransactionTypeId: integer
(int64)
Value that identifies the billing type.
-
BillingTransactionTypeName: string
Maximum Length:
255Name of the billing type. -
billToCustomer: array
Bill-to Customers
Title:
Bill-to CustomersThe Bill-to Customers resource manages the bill-to customer that the sales order header references. -
BusinessUnitId: integer
(int64)
Read Only:
trueValue that identifies the business unit for the fulfillment line. -
BusinessUnitName: string
Read Only:
trueMaximum Length:255Name of the business unit for the fulfillment line. -
BuyerFirstName: string
Read Only:
trueMaximum Length:255First name of the buyer for the item on the purchase order. -
BuyerId: integer
(int64)
Buyer details for a schedule. This attribute references the Buyer Public View that the application publishes for the item on the purchase order.
-
BuyerLastName: string
Read Only:
trueMaximum Length:255Last name of the buyer for the item on the purchase order. -
BuyerMiddleName: string
Read Only:
trueMaximum Length:255Middle name of the buyer for the item on the purchase order. -
BuyerName: string
Read Only:
trueMaximum Length:255Full name of the buyer for the item on the purchase order. -
CancelBackordersFlag: boolean
Maximum Length:
1Default Value:falseContains one of the following values: true or false. If true, then order lines backordered during picking or shipping are canceled. If false, then backorders aren't canceled. The default value is false. -
CanceledFlag: boolean
Title:
CanceledMaximum Length:1Default Value:falseContains one of the following values: true or false. If true, then the application canceled the sales order line. If false, then not canceled. The default value is false. -
CanceledQuantity: number
Title:
Canceled QuantityRead Only:trueCanceled quantity. -
CancelReason: string
Maximum Length:
255Reason to cancel the sales order. A list of accepted values is defined in the lookup type DOO_RETURN_REASON. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Order Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source. -
CancelReasonCode: string
Maximum Length:
255Abbreviation that identifies the reason to cancel the sales order. A list of accepted values is defined in the lookup type DOO_RETURN_REASON. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Order Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source. -
channelPrograms: array
Channel Programs
Title:
Channel ProgramsThe Channel Programs resource retrieves the channel programs of a sales order line. -
charges: array
Charges
Title:
ChargesThe Charges resource manages price details for the sales order. -
Comments: string
Title:
CommentsMaximum Length:2000Comments for the order line. -
ComponentIdPath: string
Maximum Length:
2000Value that identifies the path from the inventory item to the parent of this configured item on the order line. -
ConfigCreationDate: string
(date-time)
Date when the user created the configured item.
-
ConfigHeaderId: integer
(int64)
Value that identifies the order header of the sales order that contains the configured item.
-
ConfigInventoryItemDescription: string
Read Only:
trueMaximum Length:255Item description of the shippable assemble-to-order (ATO) configuration. -
ConfigInventoryItemId: integer
(int64)
Inventory item for an assemble-to-order, configured item that the application can ship. A contract or a sales agreement is an example of an item that the application cannot ship.
-
ConfigInventoryItemNumber: string
Read Only:
trueMaximum Length:255Item number of the shippable assemble-to-order (ATO) configuration. -
ConfigItemReference: string
Maximum Length:
1200Reference to the finished configured item. -
ConfigItemVersion: integer
(int32)
Read Only:
trueNumber that identifies the version of a one-time configured item. -
ConfigRevisionNumber: integer
(int64)
Revision number of the configured item. The configurator sets the value of this attribute to the configured item. It does not set it to a configure option.
-
ConfigTradeComplianceResult: string
Read Only:
trueMaximum Length:255Value that identifies the result of trade compliance screening for the configured item. -
ConfigTradeComplianceResultCode: string
Read Only:
trueMaximum Length:30Abbreviation that identifies the result of trade compliance screening for the configured item. -
ConfiguratorPath: string
Maximum Length:
2000Path that identifies the inventory item for the configure option. Path format is ".", separated by inventory item identifier. The format uses [] to specify configure options that occur in more than one instance. -
ContractEndDate: string
(date)
End date of the contract, according to the start date and duration. You can use Manage Time Units Mappings to map time units to the units of measure that the application uses.
-
ContractEndDateTime: string
(date-time)
Date and time when the contract will end, according to the contract start date and time and duration. Review and update the value to map time units to the units of measure that the application uses using the Setup and Maintenance work area, and the Manage Time Units Mappings task.
-
ContractStartDate: string
(date)
Start date of the contract.
-
ContractStartDateTime: string
(date-time)
Date and time when the contract is effective.
-
coverageReferences: array
Coverage Items
Title:
Coverage ItemsThe Coverage Items resource retrieves details about each coverage item that covers a covered item on an order line. -
coveredAssetReference: array
Covered Assets
Title:
Covered AssetsThe Covered Assets resource manages details about Asset that a coverage item covers. This is available for use with the Integrate Order Management with Subscription Management to Process Coverages feature. -
CoveredCustomerProductDescription: string
Maximum Length:
240Description of the customer item that the coverage item covers. -
CoveredCustomerProductId: integer
(int64)
Value that uniquely identifies the customer item that the coverage item covers.
-
CoveredCustomerProductNumber: string
Maximum Length:
150Number that identifies the customer item that the coverage item covers. -
CoveredProductDescription: string
Maximum Length:
240Description of the inventory item that the coverage item covers. -
CoveredProductId: integer
(int64)
Value that uniquely identifies the inventory item that the coverage item covers.
-
CoveredProductNumber: string
Maximum Length:
300Number that identifies the inventory item that the coverage item covers. -
coveredProductReferences: array
Covered Items
Title:
Covered ItemsThe Covered Items resource manages details about each covered item that a coverage item covers on an order line. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64User who created the order line. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate and time when the user created the order line. -
CreditCheckAuthExpiryDate: string
(date-time)
Date when the approved credit authorization expires.
-
CreditCheckAuthorizationNumber: string
Maximum Length:
240Value that uniquely identifies the approved credit authorization that the credit management system created on the authorized amount for the customer account. This attribute applies on credit checks only for authorization or reauthorization. -
CustomerPOLineNumber: string
Title:
Customer PO LineMaximum Length:50Value that uniquely identifies the purchase order line. The purchase order line describes the item or service, and it includes the price and quantity ordered. -
CustomerPONumber: string
Title:
Customer POMaximum Length:50Number that identifies the purchase order that the application uses to request that the seller supply the item or service in return for payment. -
CustomerPOScheduleNumber: string
Maximum Length:
50Number that identifies the schedule for the shipment that ships the purchase order. This is an optional attribute that the user can specify when submitting the sales order. -
CustomerProductDescription: string
Maximum Length:
255Description of the customer item. -
CustomerProductId: integer
(int64)
Value that uniquely identifies the customer item.
-
CustomerProductNumber: string
Maximum Length:
255Number of the customer item. -
DefaultTaxationCountry: string
Maximum Length:
2Country that the tax authority uses to calculate tax. -
DefaultTaxationCountryShortName: string
Maximum Length:
255Short name of the country that the tax authority uses to calculate tax. -
DemandClass: string
Maximum Length:
255Demand class that represents a group of customers, such as government, commercial, sales channel, or region. Demand class can represent different sources of demand, such as retail, mail order, or wholesale. A list of accepted values is defined in the lookup type ORA_DOO_DEMAND_CLASS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Order Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source. -
DemandClassCode: string
Maximum Length:
255Abbreviation that identifies the demand class. A list of accepted values is defined in the lookup type ORA_DOO_DEMAND_CLASS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Order Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source. -
DemandSourceLineReference: string
Maximum Length:
400Value that uniquely identifies demand, such as the order line in a shopping cart on a web store or in an ecommerce application. For example, you create a sales order in a web store. Then the web store sends a request to Oracle Fusion Cloud Global Order Promising to schedule it. Oracle Global Order Promising schedules the demand and sends a reply to the web store. The web store then sends the sales order to Oracle Fusion Cloud Order Management. Finally, Oracle Order Management manages the order through fulfilment. -
DemandSourceScheduledFlag: boolean
Read Only:
trueMaximum Length:1Default Value:falseThis attribute applies to a transaction that starts in a web store or ecommerce store. It contains the values Y or N. If Y, Oracle Fusion Cloud Order Management creates a sales order and sends DEMAND_SOURCE_LINE_REFERENCE to Oracle Fusion Cloud Global Order Promising. When Oracle Global Order Promising successfully schedules the demand, Oracle Order Management receives a response from Oracle Global Order Promising and then sets DEMAND_SOURCE_SCHEDULED_FLAG to Y. It does this during the first scheduling interaction that it has with Oracle Global Order Promising. You can???t modify the value for DEMAND_SOURCE_SCHEDULED_FLAG after it contains Y. If N, Oracle Global Order Promising doesn???t successfully schedule the demand, or the line doesn???t contain DEMAND_SOURCE_LINE_REFERENCE. -
DestinationLocationId: integer
(int64)
Value that identifies the destination location where the application ships the item.
-
DestinationShippingOrganizationCode: string
Abbreviation that identifies the destination organization where the application ships the item.
-
DestinationShippingOrganizationId: integer
(int64)
Value that identifies the destination organization where the application ships the item.
-
DestinationShippingOrganizationName: string
Name of the destination organization where the application ships the item.
-
DisplayLineNumber: string
Read Only:
trueNumber that the order management work area displays to identify the order line. -
DocumentSubtype: string
Maximum Length:
240Tax classification for tax reporting. This attribute depends on the requirements for each country. -
DocumentSubtypeName: string
Maximum Length:
255Name of the tax classification for tax reporting. This attribute depends on the requirements for each country. -
dropShipPurchaseOrderReference: array
Drop Ships
Title:
Drop ShipsThe Drop Ships resource retrieves the purchase order when order management uses drop ship to ship the sales order. -
dropShipRequisitionReference: array
Drop Ship Requisitions
Title:
Drop Ship RequisitionsThe Drop Ship Requisitions resource retrieves the requisition when order management uses drop ship to ship the sales order. -
EarliestAcceptableShipDate: string
(date-time)
Title:
Earliest Acceptable Ship DateEarliest date when the customer is willing to receive shipment. -
EndCreditMethod: string
Maximum Length:
255Value that identifies the credit method used for ending or closing the subscription. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features. -
EndCreditMethodCode: string
Maximum Length:
30Abbreviation that identifies the credit method used for ending or closing the subscription. A list of accepted values is defined in the lookup type ORA_OSS_CLOSE_CREDIT_METHOD. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features. -
EndDate: string
(date-time)
Date when the subscription ends. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
-
EndReason: string
Maximum Length:
255Value that identifies the reason for ending or closing the subscription. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features. -
EndReasonCode: string
Maximum Length:
30Abbreviation that identifies the reason for ending or closing the subscription. A list of accepted values is defined in the lookup type ORA_OSS_CLOSE_REASONS. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features. -
EnforceSingleShipmentFlag: boolean
Maximum Length:
1Default Value:falseContains one of the following values: true or false. If true, during ship confirm the order line quantity that can't be shipped in one shipment is canceled. If false, then backorders with multiple shipments aren't canceled. This attribute can be set to true only if CancelBackordersFlag is also set to true. The default value is false. -
EstimateFulfillmentCost: number
Estimated cost to deliver the fulfillment line to the customer. This value includes item cost and shipping cost.
-
EstimateMargin: number
Estimated margin expected when shipping the fulfillment line.
-
ExemptionCertificateNumber: string
Maximum Length:
80Certification number that the taxing authority provides for tax exemption for each customer who is eligible for tax exemption. -
ExtendedAmount: number
Title:
Extended AmountMonetary amount of the order line. -
externalAssetReference: array
External Asset References
Title:
External Asset ReferencesThe External Asset References resource manages details about asset keys from an external application that are associated with subscription items on an order line when ActionTypeCode is null or ORA_ADD. The External Asset References resource also manages details about unique references to the subscription product in Oracle Subscription Management Cloud when ActionTypeCode is ORA_END. When ActionTypeCode is ORA_END, this information is used for ending the subscription in Subscription Management. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features. -
externalFulfillmentSalesOrderReference: array
Fulfillment Orders
Title:
Fulfillment OrdersThe Fulfillment Orders resource retrieves the fulfillment order in the fulfillment system that fulfills the sales order that order management submitted to the fulfillment system. -
ExternalPriceBookName: string
Maximum Length:
80Name of the price book or price list in the external pricing application. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features. -
FinalDischargeLocationAddressCity: string
City of the final destination location for the purchase.
-
FinalDischargeLocationAddressCountry: string
Country of the final destination location for the purchase.
-
FinalDischargeLocationAddressCounty: string
County of the final destination location for the purchase.
-
FinalDischargeLocationAddressLine1: string
First line of the final destination location for the purchase.
-
FinalDischargeLocationAddressLine2: string
Second line of the final destination location for the purchase.
-
FinalDischargeLocationAddressLine3: string
Third line of the final destination location for the purchase.
-
FinalDischargeLocationAddressLine4: string
Fourth line of the final destination location for the purchase.
-
FinalDischargeLocationAddressPostalCode: string
Postal code of the final destination location for the purchase.
-
FinalDischargeLocationAddressProvince: string
Province of the final destination location for the purchase.
-
FinalDischargeLocationAddressState: string
State of the final destination location for the purchase.
-
FinalDischargeLocationId: integer
(int64)
Value that identifies the final destination location for the purchase.
-
FirstPartyTaxRegistration: integer
(int64)
Registration number that the application provides to the supplier. The supplier uses this number to tax the transaction.
-
FirstPartyTaxRegistrationNumber: string
Maximum Length:
255Value that identifies registration number. -
FOBPoint: string
Maximum Length:
255Freight on board. Identifies ownership of the item while it is in transit. A list of accepted values is defined in the lookup type ORA_FOB. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source. -
FOBPointCode: string
Maximum Length:
255Abbreviation that identifies the freight on board. A list of accepted values is defined in the lookup type ORA_FOB. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source. -
FreightTerms: string
Maximum Length:
255Terms for paying freight charges. For example, paid by shipper, collect, or prepaid. A list of accepted values is defined in the lookup type ORA_FREIGHT_TERMS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source. -
FreightTermsCode: string
Maximum Length:
255Abbreviation that identifies the terms for paying freight charges. For example, paid by shipper, collect, or prepaid. A list of accepted values is defined in the lookup type ORA_FREIGHT_TERMS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source. -
FulfilledQuantity: number
Title:
Fulfilled QuantityRead Only:trueQuantity the application uses to fulfill the order line. -
FulfillInstanceId: integer
(int64)
Read Only:
trueValue that uniquely identifies the fulfillment instance that fulfills this fulfillment line. -
FulfillLineId: integer
(int64)
Read Only:
trueValue that uniquely identifies the fulfillment line. -
FulfillLineNumber: string
Title:
Fulfillment LineRead Only:trueMaximum Length:9Default Value:1Numerical value for the fulfillment line. The default value is 1. It increments in integers when the fulfillment line splits. -
FulfillmentDate: string
(date-time)
Title:
Actual Fulfillment DateRead Only:trueDate when the application fulfills the order line. Fulfillment includes item shipped, hardware installed, and so on. -
FulfillmentMode: string
Read Only:
trueMaximum Length:30Fulfillment mode, such as regular, dropship, or back-to-back. -
FulfillmentSplitReferenceId: integer
(int64)
Read Only:
trueValue that uniquely identifies the source fulfillment line when the fulfillment line splits. -
GopReferenceId: string
Read Only:
trueMaximum Length:300Value that identifies the cross-reference to the recommendation that global order promising creates for the split fulfillment line. -
GopRequestRegion: string
Read Only:
trueMaximum Length:255Region details for the promising request that global order promising provides. -
HeaderId: integer
(int64)
Read Only:
trueValue that uniquely identifies the header of the sales order that contains the order line. -
holds: array
Holds
Title:
HoldsThe Holds resource retrieves active and released holds on the order line. -
IntegrateSubscriptionFlag: boolean
Read Only:
trueMaximum Length:1Default Value:falseContains one of the following values: true or false. If true then Oracle Fusion Cloud Order Management sends the fulfillment line to Oracle Fusion Cloud Subscription Management. If false then it doesn't. The default value is false. -
IntendedUseClassificationId: integer
(int64)
Value that uniquely identifies intended use of the item. For tax calculation.
-
IntendedUseClassificationName: string
Maximum Length:
255Classification name for the intended use of the item. For tax calculation. -
internalOrderReference: array
Internal Sales Orders
Title:
Internal Sales OrdersThe Internal Sales Orders resource retrieves sales orders that are internal to order management. -
InventoryInterfacedFlag: boolean
Read Only:
trueMaximum Length:1Default Value:falseContains one of the following values: true or false. If true, then Oracle Order Management Cloud successfully interfaced the fulfillment line to Oracle Inventory Management Cloud. If false, then Order Management didn???t interface the fulfillment line. The default value is false. -
InventoryOrganizationCode: string
Read Only:
trueMaximum Length:255Abbreviation that identifies the inventory organization where the application assigns the item. The application also uses this value for the item validation organization when the customer places the sales order. -
InventoryOrganizationId: integer
(int64)
Read Only:
trueValue that uniquely identifies the inventory organization where the application assigns the item. The application also uses this value for the item validation organization when the customer places the sales order. -
InventoryOrganizationName: string
Read Only:
trueMaximum Length:255Name of the inventory organization. -
InventoryTransactionFlag: boolean
Maximum Length:
1Default Value:falseContains one of the following values: true or false. If true, then Oracle Order Management Cloud sends a request to Oracle Inventory Management Cloud to perform an inventory transaction when fulfilling the order line instead of using the pick wave, pick, pack, and ship flow. If false, then Order Management uses the pick wave, pick, pack, and ship flow to fulfill the order line. The default value is false. -
InvoiceableItemFlag: boolean
Title:
BillableRead Only:trueMaximum Length:1Default Value:falseContains one of the following values: true or false. If true, then the fulfillment line includes the item that the application enabled for billing or invoicing. If false, then the fulfillment line does not include this item. The default value is set based on the item setup. This attribute is read-only. -
InvoiceEnabledFlag: boolean
Read Only:
trueMaximum Length:1Default Value:falseContains one of the following values: true or false. If true, then the order line qualifies for billing. If false, then the order line does not qualify for billing. The default value is set based on the item setup. This attribute is read-only. -
InvoiceInterfacedFlag: boolean
Read Only:
trueMaximum Length:1Default Value:falseContains one of the following values: true or false. If true, then the application sent the order line to the billing system. If false, then the application did not send the order line to the billing application. The default value is false. This attribute is read-only. -
InvoicingRule: string
Maximum Length:
255Invoicing rule that determines when to recognize a receivable for invoice. -
InvoicingRuleCode: string
Maximum Length:
255Abbreviation that identifies invoicing rules that determine when to recognize a receivable for invoice. -
ItemSubType: string
Read Only:
trueMaximum Length:255Name of the item sub type. -
ItemSubTypeCode: string
Read Only:
trueMaximum Length:30Subgroup for ITEM_TYPE_CODE. It provides details for each configured item or service, such as assemble-to-order. -
ItemTypeCode: string
Title:
Item TypeRead Only:trueMaximum Length:30Group items according attributes. -
JeopardyPriority: string
Read Only:
trueMaximum Length:255Name of the priority for the jeopardy score of order line. -
JeopardyPriorityCode: string
Read Only:
trueMaximum Length:255Abbreviation that identifies the priority for the jeopardy score of order line. A list of possible values is defined in the lookup type DOO_JEOPARDY_PRIORITY_CODE. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueDate and time when the user most recently updated the order line. -
LastUpdatedBy: string
Title:
Updated ByRead Only:trueMaximum Length:64User who performed the most recent update on the order line. -
LastUpdateLogin: string
Title:
Last Updated LoginRead Only:trueMaximum Length:32Login that user who most recently updated the order line used. -
LatestAcceptableArrivalDate: string
(date-time)
Title:
Latest Acceptable Arrival DateLatest date when the customer is willing to receive the item. -
LatestAcceptableShipDate: string
(date-time)
Title:
Latest Acceptable Ship DateLatest date when the customer is willing to allow the warehouse to ship the item. -
lineDetails: array
Line Details
Title:
Line DetailsThe Line Details resource retrieves shipping and billing details for the order line. -
LineId: integer
(int64)
Read Only:
trueValue that uniquely identifies the order line. -
LineNumber: integer
(int32)
Title:
Orchestration Order LineRead Only:trueDefault Value:1Number that identifies the order line. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
lotSerials: array
Lot Serials
Title:
Lot SerialsThe Lot Serials resource manages the lot serial details for returns and inventory transaction order lines. -
manualPriceAdjustments: array
Manual Price Adjustments
Title:
Manual Price AdjustmentsThe Manual Price Adjustments resource manages manual price adjustments that the Order Entry Specialist applies for each order line. -
OneTimeConfigFlag: boolean
Read Only:
trueMaximum Length:1Contains one of the following values: Y or N. If Y, then fulfill the item as a one-time configuration. If N, then don't fulfill it as a one-time configuration. A one-time configuration is an assembled-to-order, configured item that's unique on the order line. Order management keeps that item's number even if you reconfigure the item and modify its structure. -
OnHoldFlag: boolean
Title:
On HoldRead Only:trueMaximum Length:1Default Value:falseContains one of the following values: true or false. If true, then fulfillment lines will accept more processing. If false, then fulfillment lines will not accept more processing. The default value is false. This attribute is read-only. -
OpenFlag: boolean
Title:
OpenRead Only:trueMaximum Length:1Default Value:trueContains one of the following values: true or false. If true, then status of the fulfillment line is not closed. If false, then status of the fulfillment line is closed. The default value is true. This attribute is read-only. -
OrchestrationProcessName: string
Maximum Length:
80Name of the orchestration process to assign to the line. -
OrderedQuantity: number
Title:
Ordered QuantityQuantity of the item or service on the fulfillment line. -
OrderedUOM: string
Maximum Length:
255Unit of measure for the ordered quantity. For example, length, time, heat, value, and so on. -
OrderedUOMCode: string
Title:
UOMMaximum Length:3Abbreviation that identifies the unit of measure for the ordered quantity. -
originalOrderReference: array
Original Orders
Title:
Original OrdersThe Original Orders resource retrieves the original order for a return sales order. -
OriginalProductDescription: string
Maximum Length:
255Description of the inventory item that the fulfillment line contained before the application substituted the item. -
OriginalProductId: integer
(int64)
Value that uniquely identifies the inventory item that the fulfillment line contained before the application substituted the item.
-
OriginalProductNumber: string
Maximum Length:
255Number of the inventory item that the fulfillment line contained before the application substituted the item. -
OrigSystemDocumentLineReference: string
Maximum Length:
50Original document reference of the order line in the source application. -
OrigSystemDocumentReference: string
Maximum Length:
50Original document reference of the source order in the source application. -
OverFulfillmentTolerance: number
Read Only:
truePercent of quantity that can be fulfilled above the ordered quantity. -
OverrideScheduleDateFlag: boolean
Title:
Override ScheduleMaximum Length:1Default Value:falseContains one of the following values: true or false. If true, then the user can manually override the schedule date. If false, then user cannot override. The default value is false. -
OwnerId: integer
(int64)
User who is responsible for the order line.
-
PackingInstructions: string
Title:
Packing InstructionsMaximum Length:1000Document that contains packing details for the item. -
ParentFulfillLineId: integer
(int64)
Read Only:
trueValue that uniquely identifies the parent fulfillment line. This value describes the fulfillment line hierarchy for a configured item. -
ParentSourceTransactionLineId: string
Maximum Length:
255Value that uniquely identifies the parent transaction line from the source application. This value describes the transaction line hierarchy for a configured item. -
PartialShipAllowedFlag: boolean
Title:
Allow Split ShipmentsMaximum Length:1Default Value:falseContains one of the following values: true or false. If true, then ship items in the sales order in more than one shipment. If false, then ship items in the sales order in one shipment. The default value is false. -
payments: array
Payments
Title:
PaymentsThe Payments resource manages payment details of the order. -
PaymentTerms: string
Maximum Length:
255Payment terms to use to collect payment. -
PaymentTermsCode: integer
(int64)
Abbreviation that identifies payment terms.
-
POStatusCode: string
Maximum Length:
30Status of the purchase order. -
priceAdjustments: array
Price Adjustments
Title:
Price AdjustmentsThe Price Adjustments resource retrieves price adjustments, such as discounts. -
PricedOn: string
(date-time)
Date when pricing priced the order line. The application sets this date to the system date when pricing begins pricing the order line.
-
PriceUsingSecondaryUOMFlag: boolean
Read Only:
trueMaximum Length:1Contains one of the following values: true or false. If true, then Oracle Order Management Cloud uses the secondary ordered quantity and the secondary unit of measure to price the order line. If false or empty, then Order Management uses the ordered quantity and the ordered unit of measure to price the order line. This attribute does not have a default value. This attribute is read-only. If the item is dual-UOM controlled, then the value of this attribute will be either true or false depending upon the pricing measure setup for the item in Oracle Product Lifecycle Management Cloud. If the item is not dual-UOM controlled, then the value of this attribute will be NULL. -
priceValidations: array
Price Validations
Title:
Price ValidationsThe Price Validations resource retrieves price validations and price violations that occur when pricing prices a sales order. -
ProcessNumber: string
Read Only:
trueMaximum Length:50Number that identifies the orchestration process. -
ProductCategory: string
Maximum Length:
240Item classification that the tax authority uses to tax the item. -
ProductCategoryName: string
Maximum Length:
255Classifies the item for tax. Order management uses this attribute when you do not install Oracle Fusion Inventory in your deployment, or when you installed it but you do not use it to classify items for tax. -
ProductDescription: string
Maximum Length:
255Description of the item that the application fulfills. -
ProductFiscalCategory: string
Maximum Length:
255Tax classification of the item that the tax authority uses to tax the item. -
ProductFiscalCategoryId: integer
(int64)
Value that uniquely identifies the tax classification.
-
ProductId: integer
(int64)
Value that uniquely identifies the inventory item.
-
ProductNumber: string
Maximum Length:
255Stock keeping unit for the item that the application fulfills. -
ProductType: string
Maximum Length:
240Type of item classification in Oracle Fusion Tax. The value of the item type specifies whether the transaction line is for an item or service, or whether it is a memo line. -
ProductTypeName: string
Maximum Length:
255Name of the item classification in Oracle Fusion Tax. The value of the item type specifies whether the transaction line is for an item or service, or whether it is a memo line. -
project: array
Projects
Title:
ProjectsThe Projects resource manages the project details of a sales order line. -
PromiseArrivalDate: string
(date-time)
Title:
Promised Arrival DateDate when global order promising promised to the customer that the item will arrive. -
PromiseShipDate: string
(date-time)
Title:
Promised Ship DateDate when global order promising promised to the customer that the item will ship. -
PurchasingEnabledFlag: boolean
Maximum Length:
1Contains one of the following values: true or false. If true, then the purchase order can include the item on the fulfillment line. If false, then the purchase order cannot include the item on the fulfillment line. The default value is set based on the item setup. This attribute is read-only. -
PurchasingUOM: string
Maximum Length:
255Unit of measure that procurement set on the purchase order for the supplier. -
PurchasingUOMCode: string
Maximum Length:
3Abbreviation that identifies the unit of measure that procurement set on the purchase order for the supplier. -
QuantityForEachModel: number
Quantity for a configure option on a single configured item.
-
RatePlanDocument: string
(byte)
Rate plan document in JSON format encoded using Base64. The rate plan document will be desupported from release 23C.
-
RatePlanDocumentId: integer
(int64)
Read Only:
trueValue that uniquely identifies the JSON document for a rate plan in Oracle Fusion Pricing Cloud. -
RatePlanId: integer
(int64)
Read Only:
trueValue that uniquely identifies a rate plan in Oracle Fusion Pricing Cloud. -
RatePlanName: string
Read Only:
trueName of the rate plan in Oracle Fusion Pricing Cloud. -
RatePlanNumber: string
Read Only:
trueNumber that identifies a rate plan in Oracle Fusion Pricing Cloud. -
ReceivablesOrgId: integer
(int64)
Receivables business unit.
-
ReceivablesOrgName: string
Read Only:
trueMaximum Length:255Name of the receivables business unit. -
RemnantFlag: boolean
Read Only:
trueMaximum Length:1Default Value:falseContains one of the following values: true or false. If true, then the application partially fulfilled a configured item. If false, then the application did not partially fulfill a configured item. The default value is false. This attribute is read-only. -
renewSubscriptionReference: array
Renew Subscription References
Title:
Renew Subscription ReferencesThe Renew Subscription References resource manages details about unique reference to the subscription product in Oracle Subscription Management Cloud. When ActionTypeCode is ORA_RENEW, this information is used for associating the old subscription line in Subscription Management that is replaced by the renewed subscription being created in Subscription Management. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features. -
RequestedArrivalDate: string
(date-time)
Title:
Requested Arrival DateOriginal date when the customer requested for the item to arrive. -
RequestedCancelDate: string
(date-time)
Date when the customer canceled the order line.
-
RequestedFulfillmentOrganizationAddress1: string
Read Only:
trueMaximum Length:255First address line of the fulfillment organization from where the product was shipped. -
RequestedFulfillmentOrganizationAddress2: string
Read Only:
trueMaximum Length:255Second address line of the fulfillment organization from where the product was shipped. -
RequestedFulfillmentOrganizationAddress3: string
Read Only:
trueMaximum Length:255Third address line of the fulfillment organization from where the product was shipped. -
RequestedFulfillmentOrganizationAddress4: string
Read Only:
trueMaximum Length:255Fourth address line of the fulfillment organization from where the product was shipped. -
RequestedFulfillmentOrganizationCity: string
Read Only:
trueMaximum Length:255City of the fulfillment organization from where the product was shipped. -
RequestedFulfillmentOrganizationCode: string
Maximum Length:
255Abbreviation that identifies the organization that fulfills the item. If the item is shippable, then this value references the warehouse that ships the item. A contract or an agreement is an example of an item that is not shippable. -
RequestedFulfillmentOrganizationCountry: string
Read Only:
trueMaximum Length:255Country of the fulfillment organization from where the product was shipped. -
RequestedFulfillmentOrganizationCounty: string
Read Only:
trueMaximum Length:255County of the fulfillment organization from where the product was shipped. -
RequestedFulfillmentOrganizationId: integer
(int64)
Value that uniquely identifies the organization that fulfills the item. If the item is shippable, then this value references the warehouse that ships the item. A contract or an agreement is an example of an item that is not shippable.
-
RequestedFulfillmentOrganizationName: string
Maximum Length:
255Name of the organization that fulfills the item. If the item is shippable, then this value references the warehouse that ships the item. A contract or an agreement is an example of an item that is not shippable. -
RequestedFulfillmentOrganizationPostalCode: string
Read Only:
trueMaximum Length:255Postal code of the fulfillment organization from where the product was shipped. -
RequestedFulfillmentOrganizationProvince: string
Read Only:
trueMaximum Length:255Province of the fulfillment organization from where the product was shipped. -
RequestedFulfillmentOrganizationState: string
Read Only:
trueMaximum Length:255State of the fulfillment organization from where the product was shipped. -
RequestedRatePlanId: integer
(int64)
Value that uniquely identifies the rate plan requested by the user. The rate plan is maintained in Oracle Fusion Cloud Pricing. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions and Rate Usage With Events features.
-
RequestedRatePlanName: string
Read Only:
trueName of the rate plan requested by the user. The rate plan is maintained in Oracle Fusion Cloud Pricing. -
RequestedRatePlanNumber: string
Number that identifies the rate plan requested by the user. The rate plan is maintained in Oracle Fusion Cloud Pricing. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions and Rate Usage With Events features.
-
RequestedShipDate: string
(date-time)
Title:
Requested Ship DateOriginal date when the customer requested for the item to ship. -
RequestingBusinessUnitId: integer
(int64)
Read Only:
trueValue that uniquely identifies the business unit who requested the sales order. Assign a business unit for each role to each user to provide access to data in the business unit. -
RequestingBusinessUnitName: string
Read Only:
trueMaximum Length:255Name of the business unit who requested the sales order. Assign a business unit for each role to each user to provide access to data in the business unit. -
RequiredFulfillmentDate: string
(date-time)
Date when the customer requires fulfillment.
-
RequisitionBusinessUnitId: integer
(int64)
Read Only:
trueValue that identifies the requisition business unit. -
RequisitionBusinessUnitName: string
Read Only:
trueMaximum Length:255Name of the requisition business unit. -
RequisitionInventoryOrganizationCode: string
Read Only:
trueMaximum Length:255Name of the requisition organization. -
RequisitionInventoryOrganizationId: integer
(int64)
Read Only:
trueValue that identifies the requisition organization. -
RequisitionInventoryOrganizationName: string
Read Only:
trueMaximum Length:255Abbreviation that identifies the requisition organization. -
ReservableFlag: boolean
Title:
ReservableRead Only:trueMaximum Length:1Default Value:falseContains one of the following values: true or false. If true, then the application can reserve the item on the fulfillment line. If false, then the application cannot reserve. The default value is set based on the item setup. This attribute is read-only. -
ReservationId: integer
(int64)
Read Only:
trueValue that uniquely identifies the reservation. -
ReservedQuantity: number
Title:
Reserved QuantityRead Only:trueQuantity of the item that the application reserved in the warehouse to fulfill the fulfillment line. -
ReturnableFlag: boolean
Title:
Return AllowedRead Only:trueMaximum Length:1Default Value:falseContains one of the following values: true or false. If true, then the application can return the item to the supplier. If false, then the application cannot return the item to the supplier. The default value is set based on the item setup. This attribute is read-only. -
ReturnReason: string
Maximum Length:
255Reason that the customer provided to return the item. -
ReturnReasonCode: string
Maximum Length:
255Abbreviation that identifies the reason to return an item. -
RMADeliveredQuantity: number
Title:
Delivered QuantityRead Only:trueQuantity delivered for the receipt line. -
RootParentFulfillLineId: integer
(int64)
Read Only:
trueDescription of the fulfillment line hierarchy for a configured item. It identifies the highest fulfillment line in the hierarchy. -
salesCredits: array
Sales Credits
Title:
Sales CreditsThe Sales Credits resource manages sales credits for each salesperson on the sales order. -
Salesperson: string
Maximum Length:
255Person who is responsible for the sale of the sales order. -
SalespersonId: integer
(int64)
Value that identifies the primary salesperson.
-
SalesProductType: string
Read Only:
trueMaximum Length:255Name of the sales type of the item on the fulfillment line. -
SalesProductTypeCode: string
Read Only:
trueMaximum Length:30Sales type of the item on the fulfillment line. -
ScheduleArrivalDate: string
(date-time)
Title:
Scheduled Arrival DateDate when the application scheduled the shipment to arrive. -
ScheduleShipDate: string
(date-time)
Title:
Scheduled Ship DateDate when the application scheduled the shipment to ship. -
SchedulingReason: string
Value of the scheduling reason.
-
SchedulingReasonCode: string
Maximum Length:
30Abbreviation that identifies the scheduling reason. -
SecondaryFulfilledQuantity: number
Read Only:
trueQuantity on the fulfillment line for the item or service in the secondary unit of measure that the application uses to fulfill the sales order line. This attribute is applicable when more than one unit of measure is used to measure and track the item. -
SecondaryOrderedQuantity: number
Read Only:
trueOrdered quantity on the fulfillment line for the item or service in the secondary unit of measure. This attribute is applicable when more than one unit of measure is used to measure and track the item. -
SecondaryRMADeliveredQuantity: number
Read Only:
trueDelivered quantity on the fulfillment line for the returned item or service in the secondary unit of measure. This attribute is applicable when more than one unit of measure is used to measure and track the item. -
SecondaryShippedQuantity: number
Read Only:
trueShipped quantity on the fulfillment line for the item or service in the secondary unit of measure. This attribute is applicable when more than one unit of measure is used to measure and track the item. -
SecondaryUOM: string
Maximum Length:
255Secondary unit of measure for the ordered quantity on the fulfillment line. This attribute is applicable when more than one unit of measure is used to measure and track the item. -
SecondaryUOMCode: string
Read Only:
trueMaximum Length:3Abbreviation that identifies the secondary unit of measure for the ordered quantity on the fulfillment line. This attribute is applicable when more than one unit of measure is used to measure and track the item. -
SellingProfitCenterBusinessUnitId: integer
(int64)
Value that uniquely identifies the selling profit center business unit.
-
SellingProfitCenterBusinessUnitName: string
Maximum Length:
255Name of the selling profit center business unit. -
ServiceCancelDate: string
(date-time)
Date when the customer canceled the coverage item or subscription item on the fulfillment line.
-
ServiceDuration: number
Duration for the coverage item or subscription item on the fulfillment line.
-
ServiceDurationPeriodCode: string
Maximum Length:
10Abbreviation that identifies the unit of measure for the coverage item or subscription item on the fulfillment line. -
ServiceDurationPeriodName: string
Maximum Length:
255Name of the unit of measure for the coverage item or subscription item on the fulfillment line. -
ShipmentPriority: string
Maximum Length:
255Priority of shipment that allows you to group shipments into different categories depending on the urgency. A list of accepted values is defined in the lookup type WSH_SHIPPING_PRIORITY. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source. -
ShipmentPriorityCode: string
Maximum Length:
255Abbreviation that identifies the priority of the shipment. A list of accepted values is defined in the lookup type WSH_SHIPPING_PRIORITY. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source. -
ShippableFlag: boolean
Title:
ShippableRead Only:trueMaximum Length:1Default Value:falseContains one of the following values: true or false. If true, then the application can ship the order line to the customer. For example, the application can typically ship a computer, but cannot typically ship a service. If false, then the application cannot ship the order line. The default value is set based on the item setup. This attribute is read-only. -
ShippedQuantity: number
Title:
Shipment QuantityRead Only:trueQuantity of the item on the order line that shipped. -
ShippedUOM: string
Read Only:
trueMaximum Length:255Unit of measure for the quantity shipped. -
ShippedUOMCode: string
Read Only:
trueMaximum Length:3Abbreviation that identifies the unit of measure for the quantity shipped. -
ShippingCarrier: string
Maximum Length:
255Carrier who delivers the item. -
ShippingCarrierId: integer
(int64)
Abbreviation that identifies the carrier who delivers the item.
-
ShippingInstructions: string
Title:
Shipping InstructionsMaximum Length:1000Detailed instructions about cargo and other requirements for shipping. -
ShippingMode: string
Maximum Length:
255Mode of shipping that delivers the item. A list of accepted values is defined in the lookup type WSH_MODE_OF_TRANSPORT. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source. -
ShippingModeCode: string
Maximum Length:
255Abbreviation that identifies the mode of shipping that delivers the shipment. A list of accepted values is defined in the lookup type WSH_MODE_OF_TRANSPORT. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source. -
ShippingServiceLevel: string
Maximum Length:
255Level of service for the shipping that delivers the shipment. A list of accepted values is defined in the lookup type WSH_SERVICE_LEVELS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source. -
ShippingServiceLevelCode: string
Maximum Length:
255Abbreviation that identifies the shipping level of service to use to deliver the shipment. A list of accepted values is defined in the lookup type WSH_SERVICE_LEVELS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source. -
ShipSetName: string
Title:
Shipment SetMaximum Length:50Group of order lines in the sales order that must ship together from one location to one destination, and that use the same scheduled ship date. -
shipToCustomer: array
Ship-to Customers
Title:
Ship-to CustomersThe Ship-to Customers resource manages the ship-to customer that the sales order header references. -
ShowInSales: integer
(int32)
Specifies how to display a configured item on the Sales Summary page and on the Configurator summary page. You can set this attribute to one of the following values. Yes: display the configured item, but do not display the configure options. This is the default value. Hide Self: display the configure options, but do not display the configured item. Hide Self and Descendants: do not display the configured item or the configure options. You define this attribute for the configure options in Oracle Product Lifecycle Management Cloud. This attribute controls only the display. It does not filter items from the configurator.
-
SourceScheduleNumber: string
Title:
Source Schedule NumberMaximum Length:50Number that the source application assigns for the schedule, shipment, or subline. -
SourceTransactionId: string
Read Only:
trueMaximum Length:50Value that uniquely identifies the transaction in the source application. -
SourceTransactionLineId: string
Maximum Length:
50Value that uniquely identifies the transaction line from the source application. -
SourceTransactionLineNumber: string
Title:
Source Order LineMaximum Length:100Number of the transaction line from the source application. -
SourceTransactionNumber: string
Title:
Source OrderRead Only:trueMaximum Length:50Number that identifies the transaction in the source application. -
SourceTransactionRevisionNumber: integer
(int64)
Default Value:
0Revision number of the transaction in the source application. -
SourceTransactionScheduleId: string
Maximum Length:
50Value that uniquely identifies the schedule, shipment, or subline. The source application assigns this value. -
SourceTransactionSystem: string
Title:
Source SystemRead Only:trueMaximum Length:30Source application that placed the request. -
SplitFromFlineId: integer
(int64)
Read Only:
trueReference to the fulfillment line that exists before the fulfillment line split. -
Status: string
Read Only:
trueMaximum Length:255Status of the fulfillment line. -
StatusCode: string
Read Only:
trueMaximum Length:30Default Value:CREATEDAbbreviation that identifies the status of the fulfillment line. -
Subinventory: string
Maximum Length:
255Physical or logical location of the item. -
SubinventoryCode: string
Maximum Length:
10Abbreviation that identifies the physical or logical location of the item. -
SubscriptionInterfacedFlag: boolean
Read Only:
trueMaximum Length:1Contains one of the following values: true or false. If true, then the fulfillment line is interfaced to Oracle Subscription Management Cloud. If false, then the fulfillment line isn't interfaced to Subscription Management. The default value is false. This attribute is read-only. -
SubscriptionProfileId: integer
(int64)
Value that uniquely identifies the subscription profile. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
-
SubscriptionProfileName: string
Maximum Length:
300Name of the subscription profile. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features. -
subscriptionReferences: array
Subscription Items
Title:
Subscription ItemsThe Subscription Items resource retrieves details about subscription items that are associated with product items on an order line. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features. -
subscriptionTerm: array
Subscription Terms
Title:
Subscription TermsThe Subscription Terms resource manages details about pricing term definitions for subscriptions. When the pricing term is enabled, subscription generates the billing schedule for the duration of the pricing term, for both evergreen and termed lines based of the pricing method. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features. -
SubstitutionAllowedFlag: boolean
Title:
Allow Item SubstitutionMaximum Length:1Default Value:falseContains one of the following values: true or false. If true, then allow the application to substitute an item on the fulfillment line for some reason, such as shortage of material or goodwill gesture to the customer. If false, then do not allow the application to substitute. This attribute does not have a default value. -
SubstitutionReason: string
Maximum Length:
255Describes why the application substituted the item on the fulfillment line. -
SubstitutionReasonCode: string
Title:
Substitution ReasonMaximum Length:30Abbreviation that describes why the application substituted the item on the fulfillment line. -
SupplierAddress1: string
Read Only:
trueMaximum Length:255First address line of the supplier who supplies the item. -
SupplierAddress2: string
Read Only:
trueMaximum Length:255Second address line of the supplier who supplies the item. -
SupplierAddress3: string
Read Only:
trueMaximum Length:255Third address line of the supplier who supplies the item. -
SupplierAddress4: string
Read Only:
trueMaximum Length:255Fourth address line of the supplier who supplies the item. -
SupplierCity: string
Read Only:
trueMaximum Length:255City of the supplier who supplies the item. -
SupplierCountry: string
Read Only:
trueMaximum Length:255Country of the supplier who supplies the item. -
SupplierCounty: string
Read Only:
trueMaximum Length:255County of the supplier who supplies the item. -
SupplierId: integer
Supplier for the purchase order.
-
SupplierName: string
Maximum Length:
255Name of the supplier that the application requested. -
SupplierPostalCode: string
Read Only:
trueMaximum Length:255Postal code of the supplier who supplies the item. -
SupplierProvince: string
Read Only:
trueMaximum Length:255Province of the supplier who supplies the item. -
SupplierSiteId: integer
Supplier site for the purchase order.
-
SupplierSiteName: string
Maximum Length:
255Name of the supplier site for the purchase order. Interface tables don't currently support this column. So, this attribute can't be used when the REST service is used for file-based data import (FBDI). It can be used only when the REST service is directly invoked. -
SupplierState: string
Read Only:
trueMaximum Length:255State of the supplier who supplies the item. -
supplyOrderReference: array
Supply Orders
Title:
Supply OrdersThe Supply Orders resource retrieves the supply that order management uses to supply the item. -
SupplyStatusCode: string
Maximum Length:
30Status of the supply for the fulfillment line. -
TaxClassification: string
Maximum Length:
255Group of taxes for reporting and processing. -
TaxClassificationCode: string
Maximum Length:
255Abbreviation that identifies a group of taxes. -
TaxExempt: string
Read Only:
trueMaximum Length:255Value that identifies whether the fulfillment line is exempt from tax. -
TaxExemptCode: string
Maximum Length:
1Default Value:SAbbreviation that identifies whether the fulfillment line is exempt from tax. Valid values include S and E. If S, then calculate standard tax. If E, then exempt from tax. A list of accepted values is defined in the lookup type ZX_EXEMPTION_CONTROL. -
TaxExemptFlag: boolean
Maximum Length:
1Default Value:falseAbbreviation that identifies the tax exemption. This attribute is not currently used. -
TaxExemptReason: string
Maximum Length:
255Reason for the tax exemption. -
TaxExemptReasonCode: string
Maximum Length:
255Abbreviation that identifies the reason for the tax exemption. -
TaxInvoiceDate: string
(date)
Tax invoice date that tax reporting uses depending on the requirements of different countries.
-
TaxInvoiceNumber: string
Maximum Length:
150Invoice number that tax reporting uses depending on the requirements of different countries. -
ThirdPartyTaxRegistration: integer
(int64)
Registration number that the customer specifies in the purchase order.
-
ThirdPartyTaxRegistrationNumber: string
Maximum Length:
255Customer registration number that the customer specifies in the purchase order. -
TotalContractAmount: number
Total amount for the contract duration according to the total contract quantity.
-
TotalContractQuantity: number
Total quantity for the contract duration including the number of timeframes for recurring billing.
-
TradeComplianceDate: string
(date-time)
Read Only:
trueMost recent date when the application screened the order line for trade compliance. -
TradeComplianceResult: string
Read Only:
trueMaximum Length:255Result of the trade compliance screening for the order lines. -
TradeComplianceResultCode: string
Read Only:
trueMaximum Length:30Abbreviation that identifies the result of trade compliance screening. -
TransactionBusinessCategory: string
Maximum Length:
240Tax classification that the tax authority requires. -
TransactionBusinessCategoryName: string
Maximum Length:
255Name of the tax classification that the tax authority requires. -
TransactionCategoryCode: string
Title:
CategoryMaximum Length:30Default Value:ORDERAbbreviation that identifies whether the line is a return. Values include RETURN or ORDER. -
transactionItemAttributes: array
Transaction Item Attributes
Title:
Transaction Item AttributesThe Transaction Item Attributes resource manages transaction item attributes for each item on each order line. -
TransactionLineType: string
Maximum Length:
255Defines behavior for the fulfillment line. For example, required values, default values, display values, and so on. -
TransactionLineTypeCode: string
Maximum Length:
30Type of action in the channel system. For example, buy, replace with, return for credit, upgrade, and so on. -
TransformFromLineId: integer
(int64)
Read Only:
trueValue that identifies order line received from order capture application from which this particular line id is derived. -
TransportationPlannedFlag: boolean
Maximum Length:
1Contains one of the following values: true or false. If true, then the transportation planning system plans the fulfillment line. If false, then the transportation planning system does not plan the fulfillment line. The default value is false. -
TransportationPlannedStatusCode: string
Maximum Length:
1Abbreviation that indicates that a transportation planning application plans the fulfillment line. A list of accepted values is defined in the lookup type ORA_DOO_TP_STATUS. -
TransportationPlanningOrder: string
Read Only:
trueMaximum Length:255Transportation order number from transportation planning application that processed the fulfillment line. -
UnderFulfillmentTolerance: number
Read Only:
truePercent of quantity that can be fulfilled below the ordered quantity. -
UnitListPrice: number
Title:
Unit List PriceSelling price for each unit of the item before applying discounts. -
UnitQuantity: number
Number of units for the item.
-
UnitSellingPrice: number
Title:
Unit Selling PricePrice that the buyer pays for one unit of the item. -
UnreferencedReturnFlag: boolean
Read Only:
trueMaximum Length:1Default Value:falseContains one of the following values: true or false. If true, then the returned order line does not include a reference order. If false, then the returned order line includes a reference order. The default value is set by the application. This attribute is read-only. -
UserDefinedFiscalClass: string
Maximum Length:
30Tax classification that the user defines. -
UserDefinedFiscalClassName: string
Maximum Length:
255Name of the tax classification that the user defines. -
ValidConfigurationFlag: boolean
Maximum Length:
1Contains one of the following values: true or false. If true, then the configured item is valid. If false, then the configured item is not valid. The default value is set only for root lines based on configuration validation. This attribute is read-only.
arrayDetails-
Array of:
object Discriminator: Category
Discriminator:
{ "propertyName":"Category", "mapping":{ "DOO_FULFILL_LINES_ADD_INFO":"#/components/schemas/oracle_apps_scm_doo_processOrder_flex_fulfillLineCategories_view_j__FulfillLineEffDooFulfillLinesAddInfoprivateVO-item-response" } }
arrayAmend Subscription ReferencesarrayAsset Transaction DetailsarrayAssociated Product ItemsarrayAttachmentsarrayBilling PlansarrayBill-to CustomersarrayChannel ProgramsarrayChargesarrayCoverage ItemsarrayCovered AssetsarrayCovered ItemsarrayDrop ShipsarrayDrop Ship RequisitionsarrayExternal Asset ReferencesarrayFulfillment OrdersarrayHoldsarrayInternal Sales OrdersarrayLine DetailsarrayLinksarrayLot SerialsarrayManual Price AdjustmentsarrayOriginal OrdersarrayPaymentsarrayPrice AdjustmentsarrayPrice ValidationsarrayProjectsarrayRenew Subscription ReferencesarraySales CreditsarrayShip-to CustomersarraySubscription ItemsarraySubscription TermsarraySupply OrdersarrayTransaction Item AttributesobjectDiscriminator Values
object-
Category: string
Maximum Length:
240Default Value:DOO_FULFILL_LINES_ADD_INFOCategory of the flexfield. -
FulfillLineId: integer
(int64)
Value that uniquely identifies the order line that contains the additional information.
-
HeaderId: integer
(int64)
Value that uniquely identifies the sales order that contains the additional information.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SourceTransactionLineIdentifier: string
Maximum Length:
255Value that uniquely identifies the transaction in the source application. -
SourceTransactionScheduleIdentifier: string
Maximum Length:
255Value that uniquely identifies the schedule, shipment, or subline. The source application assigns this value. -
SourceTransactionSystem: string
Maximum Length:
255Source application that placed the request.
arrayLinksobject-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
object-
ExternalAssetKey: string
Maximum Length:
150Value that identifies the asset key for the subscription or coverage item in an external application. -
ExternalParentAssetKey: string
Maximum Length:
150Value that identifies the parent asset key for the subscription or coverage item in an external application. -
ExternalRootParentAssetKey: string
Maximum Length:
150Value that identifies the root parent asset key for the subscription or coverage item in an external application. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SubscriptionProductPuid: string
Maximum Length:
150Value that uniquely identifies the subscription product in Oracle Subscription Management Cloud.
arrayLinksobject-
AssetId: integer
(int64)
Value that uniquely identifies the asset.
-
AssetNumber: string
Maximum Length:
80Number that identifies the asset. -
AssetTransactionAction: string
Maximum Length:
80Name of the transaction that installed base does on the asset. -
AssetTransactionActionCode: string
Maximum Length:
30Abbreviation that identifies the transaction that installed base does on the asset. -
AssetTransactionDetailId: integer
(int64)
Value that uniquely identifies the asset transaction detail for an order line.
-
AssetUOM: string
Maximum Length:
25Unit of measure for the asset quantity. -
AssetUOMCode: string
Maximum Length:
3Abbreviation that identifies the unit of measure for the asset quantity. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the asset transaction detail. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the user created the asset transaction detail. -
CustomerAssetEndDate: string
(date-time)
Date and time when the customer asset ends in installed base.
-
FulfillLineId: integer
(int64)
Value that uniquely identifies the order line that contains the asset transaction details.
-
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the user most recently updated the asset transaction detail. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the asset transaction detail. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32Login that user used when updating the asset transaction detail. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Quantity: number
Quantity of the asset transacted by installed base assets.
-
SourceAssetTransactionDetailId: string
Maximum Length:
50Value that uniquely identifies the asset transaction detail for an order line. The source application assigns this value. -
Status: string
Maximum Length:
120Status of the asset after installed base does the transaction on the asset. -
StatusCode: string
Maximum Length:
30Abbreviation that identifies the status of the asset after installed base does the transaction on the asset. -
StatusId: integer
(int64)
Value that uniquely identifies the status of the asset after installed base does the transaction on the asset.
arrayLinksobject-
AssociatedProductFulfillLineId: integer
Value that uniquely identifies the fulfillment line of the product item with which the subscription is associated.
-
AssociatedProductHeaderId: integer
Read Only:
trueValue that uniquely identifies the sales order header that contains the product item with which the subscription is associated. -
AssociatedProductItemNumber: string
Read Only:
trueMaximum Length:255Number that identifies the product item with which the subscription is associated. -
DisplayLineNumber: string
Read Only:
trueMaximum Length:255Number that the order management work area displays to identify the order line that contains the product item with which the subscription is associated. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OrderNumber: string
Read Only:
trueMaximum Length:150Number that identifies the sales order that contains the associated product item with which the subscription is associated. -
SourceLineId: string
Maximum Length:
255Value that uniquely identifies the source order line from order capture with which the subscription is associated. -
SourceLineNumber: string
Read Only:
trueMaximum Length:255Number that identifies the order line in the source application that contains the associated product item with which the subscription is associated. -
SourceOrderId: string
Maximum Length:
255Value that uniquely identifies the source order from order capture with which the subscription is associated. -
SourceOrderNumber: string
Read Only:
trueMaximum Length:255Number that identifies the source order in the source application that contains the associated product item with which the subscription is associated. -
SourceOrderSystem: string
Maximum Length:
255Value that references the order capture application that the source order came from with which the subscription is associated.
arrayLinksobject-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAn identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdValue that uniquely identifies the attachment. -
CategoryName: string
Title:
CategoryMaximum Length:30Name of the attachment category. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255User who created the attachment. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueLogin that the user used when creating the attachment. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate and time when the user created the attachment. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEAbbreviation that identifies the data type of the attachment. -
Description: string
Title:
DescriptionMaximum Length:255Description of the attachment. -
DmDocumentId: string
Maximum Length:
255Value that uniquely identifies the attached document. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Path to the folder that contains the attachment. -
DmVersionNumber: string
Maximum Length:
255Number that identifies the version of the attached document. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeAbbreviation that identifies the status of the attachment upload. -
ErrorStatusMessage: string
Title:
Error Status MessageError message encountered while uploading attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateDate when the attachment expires. -
FileContents: string
(byte)
Title:
File ContentsContents of the attachment file. -
FileName: string
Title:
File NameMaximum Length:2048File name of the attachment. -
FileUrl: string
Title:
File UrlURL (Uniform Resource Locator) that locates the attachment file. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueDate and time when the user most recently updated the attachment. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255User who most recently updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueLogin that the user used when updating the attachment. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleTitle of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeType of the attachment file. -
UploadedFileLength: integer
Title:
File SizeLength of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameName of the attachment file. -
UploadedText: string
Title:
Uploaded TextText that the attachment contains. -
Uri: string
Title:
UriMaximum Length:4000URI (Uniform Resource Identifier) that identifies the attachment file. -
Url: string
Title:
UrlMaximum Length:4000URL (Uniform Resource Locator) that locates the attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255User who created the attachment.
arrayLinksobject-
BillingNumberOfPeriods: integer
(int32)
Number of timeframes in a recurring invoice.
-
BillingPeriodEndDate: string
(date)
End date of the billing timeframe. The application sets this date to the contract end date of the first billing timeframe. If the invoice does not cover the full billing timeframe, then the application sets the end date to the billing end date of the subsequent billing timeframe.
-
BillingPeriodNumber: integer
(int32)
Timeframe number for the billing start date, end date, or transaction date.
-
BillingPeriodStartDate: string
(date)
Start date of the billing timeframe. The application sets this date to the contract start date of the first billing timeframe. If the invoice does not cover the full billing timeframe, then the application sets the start date to the billing start date of the subsequent billing timeframe.
-
BillingPlanId: integer
(int64)
Value that uniquely identifies the billing plan.
-
BillingPlanType: string
Maximum Length:
80Name of the billing plan type. -
BillingPlanTypeCode: string
Maximum Length:
30Abbreviation that identifies the type of billing plan, such as periodic or milestone. -
BillingTransactionDate: string
(date)
Date when the first invoice occurs when the sales order uses a recurring invoice. If the invoice covers only part of an invoice timeframe, then this attribute stores the date of the subsequent invoice.
-
CancellationEffectiveDate: string
(date)
Date when recurring billing stops and no future billing occurs.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NetBillingAmountForEachPeriod: number
Net amount that the application bills for each billing timeframe.
-
OverridePeriod: integer
(int32)
Timeframe that includes an override amount. For example, the first invoice is for timeframe 1, the second invoice is for timeframe 2, and so on.
-
OverridePeriodAmount: number
Override amount to apply on the timeframe.
-
OverridePeriodQuantity: number
Quantity to use when calculating recurring billing or credit for the override timeframe.
-
Periodicity: string
Maximum Length:
80Name of the timeframe of the recurring invoice. -
PeriodicityCode: string
Maximum Length:
30Timeframe of the recurring invoice. Values include Day, Week, Month, Quarter, or Year. -
SourceBillingPlanId: string
Maximum Length:
50Value that identifies the billing plan. The source application assigns this value.
arrayLinksobject-
AccountDescription: string
Maximum Length:
255Description of the account who is legally responsible for payment. This account exists when a selling relationship exists between the deploying company and the party. -
AccountNumber: string
Maximum Length:
255Number of the customer account who is legally responsible for payment. This account exists when a selling relationship exists between the deploying company and the party. -
Address1: string
Maximum Length:
255First line of the bill-to customer address. -
Address2: string
Maximum Length:
255Second line of the bill-to customer address. -
Address3: string
Maximum Length:
255Third line of the bill-to customer address. -
Address4: string
Maximum Length:
255Fourth line of the bill-to customer address. -
AddressId: integer
(int64)
Value that uniquely identifies the bill-to customer address.
-
City: string
Maximum Length:
255City of the bill-to customer address. -
ContactFirstName: string
Maximum Length:
255First name of the person to contact at the bill-to customer site. -
ContactId: integer
(int64)
Value that uniquely identifies the contact for the billing account.
-
ContactLastName: string
Maximum Length:
255Last name of the person to contact at the bill-to customer site. -
ContactMiddleName: string
Maximum Length:
255Middle name of the person to contact at the bill-to customer site. -
ContactName: string
Maximum Length:
255Person to contact at the bill-to customer site. -
ContactNameSuffix: string
Maximum Length:
255Name suffix of the person to contact at the bill-to customer site. -
ContactNumber: string
Maximum Length:
255Telephone number of the person to contact at the bill-to customer site. -
ContactTitle: string
Maximum Length:
255Title of the person to contact at the bill-to customer site. -
Country: string
Maximum Length:
255Country of the bill-to customer address. -
County: string
Maximum Length:
255County of the bill-to customer address. -
CustomerAccountId: integer
(int64)
Value that uniquely identifies the account that is legally responsible for payment. This account exists when a selling relationship exists between the deploying company and the party.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PartyName: string
Maximum Length:
255Name of the party who is legally responsible for payment. -
PersonFirstName: string
Maximum Length:
255If a person is legally responsible for payment, then this attribute contains the first name of the person. -
PersonLastName: string
Maximum Length:
255If a person is legally responsible for payment, then this attribute contains the last name of the person. -
PersonMiddleName: string
Maximum Length:
255If a person is legally responsible for payment, then this attribute contains the middle name of the person. -
PersonNameSuffix: string
Maximum Length:
255If a person is legally responsible for payment, then this attribute contains the name suffix of the person. -
PersonTitle: string
Maximum Length:
255If a person is legally responsible for payment, then this attribute contains the title of the person. -
PostalCode: string
Maximum Length:
255Postal code of the bill-to customer address. -
PreferredContactPointId: integer
(int64)
Value that uniquely identifies the email for the preferred contact point for the contact at the account who is responsible for payment.
-
Province: string
Maximum Length:
255Province of the bill-to customer address. -
SiteUseId: integer
(int64)
Value that uniquely identifies the account site that is legally responsible for payment.
-
SourceAddressId: string
Maximum Length:
255Value that uniquely identifies the bill-to customer address. Value is 1. -
State: string
Maximum Length:
255State of the bill-to customer address.
arrayLinksobject-
ApplyType: string
Maximum Length:
255Value that indicates whether the channel program for an order line is applied by the user or the application. The values for this attribute are based on the value of ManuallyAppliedFlag. -
Comments: string
Maximum Length:
2000Comments for channel program for an order line. -
DeclinableFlag: boolean
Maximum Length:
1Contains one of the following values: true or false. If true, then the channel program for an order line can be declined by a user. If false, then the channel program for an order line can't be declined by a user. The default value is true. -
DeclineReason: string
Maximum Length:
255Reason to decline the channel program for an order line. -
DeclineReasonCode: string
Maximum Length:
30Abbreviation that identifies the reason to decline the channel program for an order line. A list of accepted values is defined in the lookup type ORA_FOM_INCENT_DECLINE_REASON. -
DiscountAmount: integer
(int64)
Amount of discount for the product rule.
-
DiscountType: string
Maximum Length:
255Value that identifies the discount type of the product rule. -
DiscountTypeCode: string
Maximum Length:
255Abbreviation that identifies the discount type of the product rule. A list of accepted values is defined in the lookup type ORA_CJM_LINE_DISCOUNT_TYPE. -
EndDate: string
(date)
Date when the product rule is no longer effective.
-
IncentiveEntitySubtypeCode: string
Maximum Length:
30Abbreviation that identifies the sub type of the channel program. -
IncentiveEntityTypeCode: string
Maximum Length:
30Abbreviation that identifies the type of the channel program. -
IncentiveId: integer
(int64)
Value that uniquely identifies the channel program for an order line.
-
ItemLevel: string
Maximum Length:
255Value that indicates the item level of the product rule. -
ItemLevelCode: string
Maximum Length:
255Abbreviation that indicates the item level of the product rule. A list of accepted values is defined in the lookup type ORA_CJM_ITEM_LEVEL. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ManuallyAppliedFlag: boolean
Maximum Length:
1Contains one of the following values: true or false. If true, then the channel program for an order line is selected by the user. If false, then the channel program for an order line is applied by the application. The default value is false. A list of accepted values is defined in the lookup type ORA_FOM_USER_APPLIED_INCENTIVE. -
ProgramCode: string
Maximum Length:
255Abbreviation that uniquely identifies the channel program. -
ProgramDescription: string
Maximum Length:
255Description of the channel program. -
ProgramDetails: string
Maximum Length:
255Details of the product rule. The value of this attribute is a concatenation of DiscountType and DiscountAmount from the product rule. -
ProgramId: string
Maximum Length:
50Value that uniquely identifies the channel program. -
ProgramLine: string
Maximum Length:
255Value that indicates the item level at which a channel program is applied for an order line. The values for this attribute are based on the value of ItemLevelCode. If the value of ItemLevelCode is ALL_ITEMS, then the value of ItemLevel is used as the value of this attribute. If the value of ItemLevelCode is ITEM, then item number from order line is used as the value of this attribute. Otherwise, the value of item identifier from product rule is used as the value of this attribute. -
ProgramLineId: string
Maximum Length:
50Value that uniquely identifies the product rule. -
ProgramName: string
Maximum Length:
255Name of the channel program. -
ProgramTypeName: string
Maximum Length:
255Name of the channel program type. -
SourceIncentiveId: string
Maximum Length:
50Value that uniquely identifies the channel program for an order line. The source application assigns this value. -
StartDate: string
(date)
Date when the product rule is effective.
-
Status: string
Maximum Length:
255Value that indicates the status of the channel program for an order line. -
StatusCode: string
Maximum Length:
30Abbreviation that indicates the status of the channel program for an order line. A list of accepted values is defined in the lookup type ORA_FOM_INCENTIVE_STATUS.
arrayLinksobject-
ApplyTo: string
Maximum Length:
255Specifies where pricing applies the charge: for the item, for shipping, or for the return. -
ApplyToCode: string
Maximum Length:
30Abbreviation that identifies where pricing applies the charge: for the item, for shipping, or for the return. -
AverageUnitSellingPrice: number
Weighted average of the selling price. This average is the total sales revenue divided by total units sold.
-
BlockAllowance: number
Value that indicates the block allowance for a non-tiered consumption charge. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
-
BlockSize: number
Number that represents the size of the block for charge calculation for a tier. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
-
CanAdjustFlag: boolean
Maximum Length:
1Default Value:falseContains one of the following values: true or false. If true, then the charge is eligible for adjustment. If false, then the charge is not eligible for adjustment. For Oracle Fusion application priced orders, the default value is set based on the pricing setup. For pre-priced orders, the default value is false. -
chargeComponents: array
Charge Components
Title:
Charge ComponentsThe Charge Components resource manages price details for the order line, including price elements and amounts. -
ChargeCurrency: string
Maximum Length:
255Charge currency. -
ChargeCurrencyCode: string
Maximum Length:
15Abbreviation that identifies the charge currency. -
ChargeDefinition: string
Maximum Length:
255Charge definition that defines the price type, charge type, and subtype. -
ChargeDefinitionCode: string
Maximum Length:
30Abbreviation that identifies the charge definition. -
ChargePeriod: string
Read Only:
trueMaximum Length:25Charge period for the usage charge. The charge period determines how frequently Pricing and Subscription Management add up the usages for a usage charge. -
ChargePeriodCode: string
Read Only:
trueMaximum Length:3Abbreviation that identifies the charge period for the usage charge. The charge period determines how frequently Pricing and Subscription Management add up the usages for a usage charge. -
ChargeSubType: string
Maximum Length:
255Charge subtype. -
ChargeSubtypeCode: string
Maximum Length:
30Abbreviation that identifies the charge subtype. -
chargeTiers: array
Charge Tiers
Title:
Charge TiersThe Charge Tiers resource manages details about tier definitions for charges. This resource is not currently used. -
ChargeType: string
Maximum Length:
255Charge type, such as item sale, service sale, financing, lease, shipping, restocking penalties, and so on. -
ChargeTypeCode: string
Maximum Length:
30Abbreviation that identifies the charge type. -
GSAUnitPrice: number
Price for each unit. Determined from the price list on the pricing strategy.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OrderChargeId: integer
(int64)
Read Only:
trueValue that uniquely identifies the transaction. -
PricedQuantity: number
Abbreviation that identifies the unit of measure for the priced quantity, such as Ton.
-
PricedQuantityUOM: string
Maximum Length:
255Unit of measure for priced quantity, such as Ton. Oracle Product Lifecycle Management Cloud or a service in Oracle Order Management Cloud provides this value. -
PricedQuantityUOMCode: string
Maximum Length:
3Abbreviation that identifies the unit of measure for the priced quantity. -
PricePeriodicity: string
Maximum Length:
255Periodicity for recurring price types, such as month, quarter, or year. -
PricePeriodicityCode: string
Maximum Length:
30Abbreviation that identifies the price periodicity. -
PriceType: string
Maximum Length:
255Price type, such as one time, recurring, and so on. -
PriceTypeCode: string
Maximum Length:
30Abbreviation that identifies the price type. -
PrimaryFlag: boolean
Maximum Length:
1Contains one of the following values: true or false. If true, then the charge is the primary charge. If false, then the charge is not the primary charge. For Oracle Fusion application priced orders, the default value is set based on the pricing setup. For pre-priced orders, the value is entered by the user. -
RollupFlag: boolean
Maximum Length:
1Contains one of the following values: true or false. If true, then the charge is a rollup charge. If false, then the charge is not a rollup charge. For Oracle Fusion application priced orders, the default value is set based on the pricing setup. For pre-priced orders, the default value is false. -
SequenceNumber: integer
(int32)
Sequence number for the charge.
-
SourceChargeId: string
Maximum Length:
120Value that uniquely identifies the charge. The source application applies this value. -
TierAppliesTo: string
Maximum Length:
80Value that identifies whether the applicability of the tier is for all tiers or the highest tier. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features. -
TierAppliesToCode: string
Maximum Length:
30Abbreviation that identifies the applicability of the tier whether all tiers or the highest tier. A list of accepted values is defined in the lookup type ORA_QP_TIER_GRADUATED_TYPES. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features. -
TieredFlag: boolean
Read Only:
trueMaximum Length:1Default Value:falseContains one of the following values: true or false. If true, then the charge has a tier defined. If false, then the charge does not have a tier defined. This attribute does not have a default value. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features. -
UsagePriceLockFlag: boolean
Maximum Length:
1Contains one of the following values: true or false. If true, then the usage pricing is used. If false, then the usage pricing isn't used. This attribute does not have a default value. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features. -
UsageUOM: string
Read Only:
trueMaximum Length:25Unit of measure for the usage price of the product. -
UsageUOMCode: string
Read Only:
trueMaximum Length:3Abbreviation that identifies the unit of measure for the usage price of the product.
arrayCharge ComponentsarrayCharge TiersarrayLinksobject-
ChargeCurrency: string
Maximum Length:
255Name of the currency that the charge component uses. -
ChargeCurrencyCode: string
Maximum Length:
15Abbreviation that identifies the currency that the charge component uses. -
ChargeCurrencyDurationExtendedAmount: number
Extended amount for the duration displayed in the currency that the charge uses.
-
ChargeCurrencyExtendedAmount: number
Extended amount displayed in the currency that the charge uses. Extended amount equals the unit price multiplied by the quantity on the order line. For a configured item, the extended amount equals the unit price multiplied by the extended quantity on the order line.
-
ChargeCurrencyUnitPrice: number
Price or adjustment for each unit displayed in the charge currency that the order line uses.
-
Explanation: string
Maximum Length:
1000Explanation of the charge component. -
ExplanationMessageName: string
Maximum Length:
30Message name of the explanation that displays in the price break down dialog. -
HeaderCurrency: string
Maximum Length:
255Name of the currency that the order header uses. -
HeaderCurrencyCode: string
Maximum Length:
15Abbreviation that identifies the currency that the order header uses. -
HeaderCurrencyDurationExtendedAmount: number
Extended amount for the duration, displayed in the currency that the order header uses.
-
HeaderCurrencyExtendedAmount: number
Extended amount, displayed in the currency that the order header uses.
-
HeaderCurrencyUnitPrice: number
Price or adjustment for each unit of the item, displayed in the currency that the order header uses.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OrderChargeComponentId: integer
(int64)
Read Only:
trueValue that uniquely identifies the transaction. -
PercentOfComparisonElement: number
Percent that the unit price constitutes of the basis charge component. The default value for the basis is List Price. This attribute stores the margin percent, the percent that net price constitutes of the list price, and so on.
-
PriceElement: string
Maximum Length:
255Name of the price element, such as list price, net price, and so on. -
PriceElementCode: string
Maximum Length:
30Abbreviation that identifies the price element. -
PriceElementUsage: string
Maximum Length:
255Name that describes charge component usage. -
PriceElementUsageCode: string
Maximum Length:
30Abbreviation that identifies the charge component usage. -
PricingSourceId: string
Maximum Length:
30Value that identifies the source of the lowest level pricing. For example, it contains the Id that identifies a line on the price list, a tier rule, a shipping line, and so on. -
PricingSourceType: string
Maximum Length:
255Type of the price source. -
PricingSourceTypeCode: string
Maximum Length:
30Type of the price source, such as the charge of a segment price list. A list of accepted values is defined in the lookup type ORA_QP_SOURCE_TYPES. -
RollupFlag: boolean
Maximum Length:
1Contains one of the following values: true or false. If true, then the value is a rollup value for the charge component. If false, then the value is not a rollup value. For Oracle Fusion application priced orders, the default value is set based on the pricing setup. For pre-priced orders, the default value is false. -
SequenceNumber: integer
(int32)
Sequence number for the charge component.
-
SourceChargeComponentId: string
Maximum Length:
50Value that uniquely identifies the charge component. The source application assigns this value. -
SourceMpaId: string
Maximum Length:
50Value that identifies the source of a manual price adjustment. -
TaxIncludedFlag: boolean
Maximum Length:
1Default Value:falseContains one of the following values: true or false. If true, then the price for the charge component includes tax. If false, then the price for the charge component does not include tax. For Oracle Fusion application priced orders, the default value is set based on the pricing setup. For pre-priced orders, the default value is false. -
totalComponents: array
Total Components
Title:
Total ComponentsThe Total Components resource retrieves the components that determine the total price of a sales order.
arrayLinksarrayTotal Componentsobject-
HeaderCurrencyCode: string
Read Only:
trueMaximum Length:15Abbreviation that identifies the currency that the order header uses. -
HeaderCurrencyExtendedAmount: number
Read Only:
trueExtended amount, displayed in currency that the order header uses. -
HeaderCurrencyName: string
Read Only:
trueMaximum Length:255Name of the currency that the order header uses. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OrderChargeComponentId: integer
(int64)
Value that identifies the charge component that stores the sales order total. Pricing might use more than one charge component when it calculates the total. For example, it can sum the values of more than one discount when it calculates the total discount.
-
OrderTotalComponentId: integer
(int64)
Value that identifies the charge component that stores the sales order total.
-
OrderTotalId: integer
(int64)
Value that identifies the sales order total.
-
PriceElement: string
Read Only:
trueMaximum Length:255Name of the price element. For example, list price, net price, and so on. -
PriceElementCode: string
Read Only:
trueMaximum Length:30Abbreviation that identifies the price element. -
PriceElementUsage: string
Read Only:
trueMaximum Length:255Name of the price element usage. -
PriceElementUsageCode: string
Read Only:
trueMaximum Length:30Abbreviation that identifies price element usage.
arrayLinksobject-
AdjustmentAmount: number
Amount to be adjusted or the price for each unit or block for the item. In Oracle Subscription Management Cloud, this attribute is mapped to the list price.
-
ApplicationMethod: string
Maximum Length:
80Method of application for the charge tier. In Oracle Subscription Management Cloud, this attribute is called PriceFormat. -
ApplicationMethodCode: string
Maximum Length:
30Abbreviation that identifies the application method to use for tiered pricing. A list of accepted values is defined in the lookup type ORA_QP_APPLICATION_METHODS. -
BlockSize: number
Number that represents the size of the block for charge calculation for a tier.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OrderChargeId: integer
(int64)
Value that uniquely identifies the charge.
-
OrderChargeTierId: integer
(int64)
Value that uniquely identifies the charge tier.
-
SourceOrderChargeTierId: string
Maximum Length:
50Value that uniquely identifies the charge tier in the source application. -
TierFrom: number
Number that indicates the starting value of the tier.
-
TierSequenceNumber: number
Sequence number for the charge tier.
-
TierTo: number
Number that indicates the ending value of the tier.
arrayLinksobject-
CoverageFulfillLineId: integer
(int64)
Read Only:
trueValue that uniquely identifies the fulfillment line that fulfills the coverage line. -
CoverageItemNumber: string
Read Only:
trueMaximum Length:255Item number of the coverage that the covered item covers. -
DisplayLineNumber: string
Read Only:
trueMaximum Length:255Number that the order management work area displays to identify the order line that contains the coverage. -
HeaderId: integer
(int64)
Read Only:
trueValue that uniquely identifies the sales order header that contains the coverage. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OrderNumber: string
Read Only:
trueMaximum Length:255Sales order number that contains the coverage line. -
SourceLineNumber: string
Title:
Source Order LineMaximum Length:100Value that uniquely identifies the order line in the source application that contains the coverage. -
SourceOrderNumber: string
Title:
Source OrderMaximum Length:50Value that uniquely identifies the source order in the source application that contains the coverage.
arrayLinksobject-
CoveredAssetId: integer
Value that uniquely identifies the asset that the coverage item covers.
-
CoveredAssetNumber: string
Maximum Length:
150Number that identifies the asset that the coverage item covers. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
arrayLinksobject-
CoveredFulfillLineId: integer
Value that uniquely identifies the fulfillment line that fulfills the covered item.
-
CoveredItemNumber: string
Read Only:
trueMaximum Length:255Number that identifies the covered item. -
DisplayLineNumber: string
Read Only:
trueMaximum Length:255Number that the order management work area displays to identify the order line that contains the covered item. -
HeaderId: integer
Read Only:
trueValue that uniquely identifies the sales order head that contains the covered item. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OrderNumber: string
Maximum Length:
150Number that identifies the sales order that contains the covered item. -
SourceLineId: string
Maximum Length:
255Value that uniquely identifies the source order line from order capture. -
SourceLineNumber: string
Maximum Length:
255Value that uniquely identifies the transaction in the source application that contains the order line for the covered item. -
SourceOrderId: string
Maximum Length:
255Value that uniquely identifies the source order from order capture. -
SourceOrderNumber: string
Maximum Length:
255Number that identifies the source application that contains the covered item. -
SourceOrderSystem: string
Maximum Length:
255Value that references to the order capture application that the source order came from.
arrayLinksobject-
DocumentSystemReferenceId: integer
(int64)
Value that uniquely identifies the document system for the drop ship.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
POHeaderId: string
Maximum Length:
255Value that uniquely identifies the purchase order header for the drop ship. -
POLineId: string
Maximum Length:
255Value that uniquely identifies the purchase order line for the drop ship. -
POLineLocationId: string
Maximum Length:
255Value that uniquely identifies the location of the purchase order line for the drop ship. -
PONumber: string
Maximum Length:
150Number that identifies the purchase order for the drop ship.
arrayLinksobject-
DocumentSystemReferenceId: integer
(int64)
Value that uniquely identifies the document system reference for the drop ship.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
RequisitionHeaderId: string
Maximum Length:
255Value that uniquely identifies the purchase requisition for the drop ship. -
RequisitionLineId: string
Maximum Length:
255Value that uniquely identifies the requisition line for the drop ship. -
RequisitionLineNumber: string
Maximum Length:
150Number that identifies the requisition line for the drop ship. -
RequisitionNumber: string
Maximum Length:
150Number that identifies the requisition for the drop ship.
arrayLinksobject-
ExternalAssetKey: string
Maximum Length:
150Value that identifies the asset key for the subscription or coverage item in an external application. -
ExternalParentAssetKey: string
Maximum Length:
150Value that identifies the parent asset key for the subscription or coverage item in an external application. -
ExternalRootParentAssetKey: string
Maximum Length:
150Value that identifies the root parent asset key for the subscription or coverage item in an external application. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SubscriptionProductPuid: string
Maximum Length:
150Value that uniquely identifies the product within the subscription in Oracle Subscription Management Cloud.
arrayLinksobject-
DocumentId: string
Maximum Length:
255Value that uniquely identifies the external order reference that the application sends to the fulfillment system. -
DocumentLineNumber: string
Maximum Length:
150Number that uniquely identifies the order line in the external order reference that the application sends to the fulfillment system. -
DocumentNumber: string
Maximum Length:
150Number that uniquely identifies the external order reference that the application sends to the fulfillment system. -
DocumentSystemReferenceId: integer
(int64)
Value that uniquely identifies the document system reference for an external order.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
arrayLinksobject-
ActiveFlag: boolean
Title:
ActiveMaximum Length:1Contains one of the following values: true or false. If true, then the hold is active. If false, then the hold is not active. -
ApplyDate: string
(date-time)
Title:
Hold DateRead Only:trueDate when the user applied the hold. -
ApplySystem: string
Maximum Length:
30Application that requested to apply the hold. -
ApplyUser: string
Read Only:
trueMaximum Length:255Name of the user who applied the hold. -
HoldCode: string
Read Only:
trueMaximum Length:255Abbreviation that identifies the hold. -
HoldComments: string
Title:
CommentsMaximum Length:240Comments that the user added when placing the hold. -
HoldInstanceId: integer
(int64)
Value that uniquely identifies the hold.
-
HoldName: string
Read Only:
trueMaximum Length:255Name of the hold. -
HoldReleaseComments: string
Title:
Release CommentsMaximum Length:240Comments that the user added when releasing the hold. -
HoldReleaseReason: string
Read Only:
trueMaximum Length:255Reason for releasing the hold. -
HoldReleaseReasonCode: string
Title:
Release ReasonMaximum Length:30Abbreviation that identifies the reason for releasing the hold. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ReleaseDate: string
(date-time)
Title:
Release DateDate when the user released the hold. -
ReleaseUser: string
Read Only:
trueMaximum Length:255Name of the user who released the hold. -
SourceRequestId: string
Maximum Length:
50Value that identifies the source application that requested the hold.
arrayLinksobject-
DocumentSystemReferenceId: integer
(int64)
Value that uniquely identifies the document system reference for an internal order.
-
InternalOrderDocumentType: string
Maximum Length:
255Type of internal order. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
arrayLinksobject-
ActualDeliveryDate: string
(date-time)
Date when the carrier delivered the item that the fulfillment line contains.
-
AvailabilityShipDate: string
(date-time)
Ship date for each fulfillment line that the carrier sends to order management.
-
BillingTransactionAmount: number
Title:
Charge AmountAmount of the billing transaction. -
BillingTransactionDate: string
(date-time)
Title:
Invoice DateDate on the customer invoice. The application uses this date to calculate the invoice due date according to the payment terms for the customer. -
BillingTransactionNumber: string
Title:
Invoice NumberMaximum Length:30Value that uniquely identifies the billing transaction. -
BillOfLadingNumber: string
Title:
Bill of LadingMaximum Length:120Contract and receipt from the carrier for the item that the carrier agrees to transport to the destination address. -
CustomerTransactionLineId: integer
(int64)
Value that uniquely identifies the billing line.
-
DeliveryName: string
Title:
DeliveryMaximum Length:120Group of items that the carrier carries under the terms of one bill of lading. -
ExceptionFlag: boolean
Maximum Length:
1Contains one of the following values: true or false. If true, then the available-to-ship date for the line on the supply order has past the requested date, or supply is not available for the fulfillment line. If false, then this available-to-ship date has not past the requested date, or supply is available for the fulfillment line. -
FulfillLineDetailId: integer
(int64)
Value that uniquely identifies details for the fulfillment line.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Quantity: number
Title:
Shipped QuantityQuantity of the item that the supplier fulfilled. -
RMAReceiptDate: string
(date)
Date when the fulfillment application sent the receipt.
-
RMAReceiptDateTime: string
(date-time)
Date and time when the fulfillment application sent the receipt.
-
RMAReceiptLineNumber: string
Maximum Length:
50Line number of the receipt sent by the receiving application. -
RMAReceiptNumber: string
Maximum Length:
50Receipt header number sent by the receiving application. -
RMAReceiptTransactionId: string
Maximum Length:
18Value that uniquely identifies receiving. -
SecondaryQuantity: number
Read Only:
trueShipped, received, or delivered quantity on the fulfillment line for the item or service in the secondary unit of measure. This attribute is applicable when more than one unit of measure is used to measure and track the item. -
Status: string
Read Only:
trueMaximum Length:255Status of the fulfillment line. -
StatusAsOfDate: string
(date-time)
Title:
Transaction DateDate when the transaction occurred. -
StatusCode: string
Title:
StatusMaximum Length:30Abbreviation that identifies the status of the fulfillment line. -
TaskType: string
Title:
Task TypeMaximum Length:50Task classification that assigns default attributes to tasks and controls task processing. -
TrackingNumber: string
Title:
Tracking NumberMaximum Length:120Unique value that the carriers provides to track shipment during transportation. -
TradeComplianceCode: string
Maximum Length:
30Abbreviation that identifies the trade compliance screening. -
TradeComplianceExplanation: string
Maximum Length:
1000Explanation that describes the result of trade compliance screening. -
TradeComplianceResultCode: string
Maximum Length:
30Abbreviation that identifies the result of trade compliance screening. -
TradeComplianceType: string
Read Only:
trueMaximum Length:255Type of trade compliance screening. -
TradeComplianceTypeCode: string
Maximum Length:
30Abbreviation that identifies the type of trade compliance screening. -
WaybillNumber: string
Title:
Waybill NumberMaximum Length:30Waybill or airbill number for the shipment.
arrayLinksobject-
DeletedFlag: boolean
Contains one of the following values: true or false. If true, then lot and serial lines are deleted during the patch or upsert operation. If false, then lot and serial lines are not deleted. This is a transient attribute. Use this attribute only on an order line that includes an inventory transaction. This attribute does not have a default value.
-
ItemRevisionNumber: string
Title:
Revision NumberMaximum Length:120Value that identifies the item revision. -
ItemSerialNumberFrom: string
Title:
From Serial NumberMaximum Length:120Starting serial number of a range of serial numbers. -
ItemSerialNumberTo: string
Title:
To Serial NumberMaximum Length:120Ending serial number of a range of serial numbers. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Locator: string
Concatenated segments for the locator flexfields from where the item is shipped from or received into.
-
LocatorId: integer
(int64)
Locator where the application ships or receives the item.
-
LotNumber: string
Title:
Lot NumberMaximum Length:320Identifies the quantity for the item. -
LotSerialId: integer
(int64)
Read Only:
trueValue that uniquely identifies the lot and serial. -
Quantity: number
Quantity of lots and serials.
-
SecondaryQuantity: number
Read Only:
trueQuantity of the lot for the item or service in the secondary unit of measure. This attribute is applicable when more than one unit of measure is used to measure and track the item. -
SourceLotSerialId: string
Maximum Length:
50Value that uniquely identifies the lot and serial. The source application assigns this value.
arrayLinksobject-
AdjustmentAmount: number
Amount of the manual price adjustment for a charge or total. The value is an amount or a percent.
-
AdjustmentElementBasis: string
Maximum Length:
30Basis that pricing uses to calculate the manual pricing adjustment. -
AdjustmentElementBasisName: string
Maximum Length:
255Name of the basis that pricing uses to calculate the manual pricing adjustment. -
AdjustmentType: string
Maximum Length:
255Method that pricing uses to calculate manual price adjustment for the item. -
AdjustmentTypeCode: string
Maximum Length:
30Abbreviation that identifies the type of manual price adjustment. -
ChargeDefinition: string
Maximum Length:
255Definition of the charge that pricing uses to apply a manual price adjustment. -
ChargeDefinitionCode: string
Maximum Length:
30Abbreviation that identifies the definition of the charge that pricing uses to apply a manual price adjustment. -
ChargeRollupFlag: boolean
Maximum Length:
1Contains one of the following values: true or false. If true, then the charge for the manual price adjustment is a rollup charge. If false, then it isn't a rollup charge. The default value is false. -
Comments: string
Maximum Length:
1000Comments that describe the manual price adjustment. -
EffectiveNumberOfPeriods: number
Number of periods to use for the price adjustment. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
-
EffectivePeriodFrom: number
Number that identifies the period when the price adjustment starts. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
-
EffectivePeriodUntil: number
Number that identifies the period when the price adjustment ends. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features.
-
EffectivityType: string
Maximum Length:
80Type of effectivity of the price adjustment. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features. -
EffectivityTypeCode: string
Maximum Length:
30Abbreviation that identifies the type of effectivity to use for the price adjustment. A list of accepted values is defined in the lookup type ORA_OSS_PRICE_ADJ_EFFECTIVITY. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ManualPriceAdjustmentId: integer
(int64)
Read Only:
trueValue that identifies the manual price adjustment. -
ParentEntityId: integer
(int64)
Read Only:
trueValue that identifies the parent entity where pricing applies the manual price adjustment. -
PricePeriodicity: string
Maximum Length:
255Price periodicity of the charge where pricing applies the manual price adjustment. -
PricePeriodicityCode: string
Maximum Length:
30Abbreviation that identifies the price periodicity of the charge where pricing applies the manual price adjustment. -
Reason: string
Maximum Length:
255Reason for the manual price adjustment. -
ReasonCode: string
Maximum Length:
30Abbreviation that identifies the reason for the manual price adjustment. -
SequenceNumber: integer
(int32)
Sequence that pricing uses to apply the manual price adjustment in relation to other manual price adjustments.
-
SourceManualPriceAdjustmentId: string
Maximum Length:
50Value that uniquely identifies the manual price adjustment. The source application assigns this value. -
ValidationStatusCode: string
Read Only:
trueMaximum Length:30Abbreviation that identifies the validation status of the manual price adjustment.
arrayLinksobject-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OriginalFulfillLineId: integer
Value that uniquely identifies the fulfillment line from the original sales order that the return order is returning.
-
OriginalHeaderId: integer
Read Only:
trueValue that uniquely identifies the original sales order header that the return order is returning. -
OriginalItemLineNumber: string
Read Only:
trueMaximum Length:255Number that identifies the original order line that the return order is returning. -
OriginalItemNumber: string
Read Only:
trueMaximum Length:255Number that identifies the original item that the return order is returning. -
OriginalOrderNumber: string
Maximum Length:
150Number that identifies the original sales order that the return order is returning. -
OriginalSourceLineId: string
Maximum Length:
255Value that uniquely identifies the original source line in the return order. This value refers to the original order. -
OriginalSourceLineNumber: string
Maximum Length:
255Number that identifies the original source line in the return order. This value refers to the original order. -
OriginalSourceOrderId: string
Maximum Length:
255Value that uniquely identifies the original source order in the return order. This value refers to the original order. -
OriginalSourceOrderNumber: string
Maximum Length:
255Number that identifies the original source order that the return order is returning. This source order resides in a source application. -
OriginalSourceOrderSystem: string
Maximum Length:
255Value that identifies the original source application in the return order. This value refers to the original order.
arrayLinksobject-
Amount: number
Amount authorized for the payment.
-
AuthorizationRequestId: string
Maximum Length:
30Value that uniquely identifies the authorization request received from the tokenization service provider to authorize the card number. If you want to import a card authorization other than the Card Token Number, then you must provide either the Card Authorization Request Identifier or the Card Voice Authorization Code. If both are provided, then the Card Authorization Request Identifier takes precedence. -
AuthorizationStatus: string
Maximum Length:
255Authorization status of the payment transaction. Values include Pass or Fail. -
AuthorizationStatusCode: string
Maximum Length:
30Status of the payment. Values include Pass or Fail. -
AuthorizedAmount: number
Authorized amount received from the tokenization service provider to authorize the transaction. The authorized amount must be provided if the authorization request identifier is sent in the payload.
-
AuthorizedInSourceFlag: boolean
Read Only:
trueMaximum Length:1Default Value:trueContains one of the following values: true or false. If true, then payment authorization occurs in the source application. If false, then payment authorization does not occur in the source application. The default value is true. -
AuthorizedOn: string
(date-time)
Date when the application authorized payment.
-
CardExpirationDate: string
Date when the card is no longer valid. The value is provided in the YYYY/MM/DD format.
-
CardFirstName: string
Maximum Length:
40First name of the card holder. -
CardIssuerCode: string
Maximum Length:
30Value that identifies the card issuer; for example, Visa or MasterCard. -
CardLastName: string
Maximum Length:
40Last name of the card holder. -
CardTokenNumber: string
Maximum Length:
30Token number issued by the tokenization service provider corresponding to a card number. This is a required field for card token and authorization import. -
InstrumentAssignmentId: integer
(int64)
Read Only:
trueValue that identifies the payment method. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MaskedCardNumber: string
Maximum Length:
30Masked format that displays only the last four digits of a card number, and replaces all other digits with X. This attribute is used for security purposes. The length of the masked card number should match the actual length of the number provided by the card issuer. For example, the masked card number for a Visa card number is XXXXXXXXXXXX2345. -
OriginalSystemPaymentReference: string
Maximum Length:
50Value that uniquely identifies the payment details from the source application. -
PaymentMethod: string
Maximum Length:
255Name of the billing payment method. -
PaymentMethodCode: integer
(int64)
Abbreviation that identifies the payment method. The application uses this payment method on the invoice to collect the open balance.
-
PaymentServerOrderNumber: string
Maximum Length:
80Number that identifies the card payment that was authorized by Oracle Payments Cloud. -
PaymentSetId: integer
(int64)
Value that uniquely identifies the group of payments for one prepaid sales order. If the payment is a prepayment, then this attribute uses a foreign key to reference billing.
-
PaymentTransactionId: integer
(int64)
Read Only:
trueValue that uniquely identifies the payment. -
PaymentType: string
Maximum Length:
255Name of the payment method for the transaction. -
PaymentTypeCode: string
Maximum Length:
30Abbreviation that identifies the payment type. -
TransactionExtensionId: integer
(int64)
Value that identifies the payment transaction extension in the payment system.
-
UniquePaymentReference: string
Read Only:
trueMaximum Length:30Unique payment reference that the application sends to the payment system for authorization. -
VoiceAuthorizationCode: string
Maximum Length:
100Abbreviation that identifies the card authorization. If you want to import a card authorization other than the Card Token Number, then you must provide either the Card Authorization Request Identifier or the Card Voice Authorization Code. If both are provided, then the Card Authorization Request Identifier takes precedence.
arrayLinksobject-
AdjustmentName: string
Maximum Length:
1000Name of the price adjustment, such as discount, charge, or cost. -
AdjustmentType: string
Read Only:
trueMaximum Length:255Type of price adjustment. -
AdjustmentTypeCode: string
Maximum Length:
30Abbreviation that identifies the type of price adjustment. -
Amount: number
Title:
AmountCost amount or charge amount of the price adjustment. -
InvoicedFlag: boolean
Maximum Length:
1Default Value:falseContains one of the following values: true or false. If true, then the application bills the price adjustment. If false, then the application does not bill the price adjustment. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OrigSystemAdjustmentReference: string
Maximum Length:
50Reference to the price adjustment from the source application. -
PriceAdjustmentId: integer
(int64)
Value that uniquely identifies the price adjustment.
arrayLinksobject-
ChargeDefinition: string
Read Only:
trueMaximum Length:255Value that identifies the pricing charge definition to use during price validation. -
ChargeDefinitionCode: string
Maximum Length:
30Abbreviation that identifies the pricing charge definition to use during price validation. -
ChargeId: integer
(int64)
Value that identifies the charge of the charge component during price validation.
-
ConstrainingValue: number
Specifies whether validation applies to discount percent or discount amount.
-
ConstrainingValueTypeCode: string
Maximum Length:
30Abbreviation that identifies the type of constraining value, such as percent or amount. -
ConstrainingValueTypeName: string
Read Only:
trueMaximum Length:255Name of the type of constraining value, such as percent or amount. -
Explanation: string
Maximum Length:
1000Explanation that describes the price validation. -
ExplanationMessageName: string
Maximum Length:
30Name of the explanation that describes the price validation. -
HeaderCurrencyCode: string
Maximum Length:
15Abbreviation that identifies the header currency during price validation. -
HeaderCurrencyConstrainingAmount: number
Value that constrains the calculation for the header currency during price validation.
-
HeaderCurrencyName: string
Read Only:
trueMaximum Length:255Name of the header currency used during price validation. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ManualPriceAdjustmentId: integer
(int64)
Value that identifies the manual price adjustment during price validation.
-
PricePeriodicity: string
Read Only:
trueMaximum Length:255Name of the price periodicity to use recurring prices during price validation. -
PricePeriodicityCode: string
Maximum Length:
30Price periodicity to use recurring prices during price validation. -
PriceValidationId: integer
(int64)
Value that uniquely identifies the price validation.
-
RollupFlag: boolean
Maximum Length:
1Contains one of the following values: true or false. If true, then apply validation on a rollup charge. If false, then validation do not apply validation on a rollup charge. -
ValidationComponent: string
Read Only:
trueMaximum Length:255Name of the charge component or total that pricing evaluates for the pricing guideline during price validation. -
ValidationComponentCode: string
Maximum Length:
30Abbreviation that identifies the charge component or total that pricing evaluates for the pricing guideline during price validation. -
ValidationComponentEntityId: integer
(int64)
Value that identifies the charge component or total that pricing evaluates for the pricing guideline during price validation.
-
ValidationComponentEntityType: string
Maximum Length:
30Type of component entity against which the guideline is evaluated. Valid values include Charge Component or Total. -
ValidationSourceRuleId: integer
(int64)
Value that identifies the rule that pricing uses to evaluate the pricing guideline during price validation.
-
ValidationSourceType: string
Maximum Length:
255Type of price validation. Values include Charge Guideline, Total Guideline, Floor Price, or GSA Price. -
ValidationSourceTypeCode: string
Maximum Length:
30Abbreviation that identifies the source type of the price validation. -
ValidationStatus: string
Maximum Length:
30Indicates whether price validation failed or passed. -
ViolationTypeCode: string
Maximum Length:
30Abbreviation that identifies the violation type that occurred during price validation. A list of accepted values is defined in the lookup type ORA_QP_GUIDE_VIOLATION_TYPES. -
ViolationTypeName: string
Read Only:
trueMaximum Length:255Name of the violation type that occurred during price validation.
arrayLinksobject-
DooOrderPrjId: integer
Value that uniquely identifies the project for an order line.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
projectDetail: array
Project Details
Title:
Project DetailsThe Project Details resource manages the descriptive flexfield data of the project for an order line.
arrayLinksarrayProject Detailsobject-
__FLEX_Context: string
Title:
Context ValueMaximum Length:40Default Value:OM_Sales_OrderDescriptive flexfield context that determines the segments displayed. -
__FLEX_Context_DisplayValue: string
Title:
Context ValueDescriptive flexfield context display value that determines the segments displayed. -
DooOrderPrjId: integer
Value that uniquely identifies the project details for an order line.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
arrayLinksobject-
ExternalAssetKey: string
Maximum Length:
150Value that identifies the asset key for the subscription or coverage item in an external application. -
ExternalParentAssetKey: string
Maximum Length:
150Value that identifies the parent asset key for the subscription or coverage item in an external application. -
ExternalRootParentAssetKey: string
Maximum Length:
150Value that identifies the root parent asset key for the subscription or coverage item in an external application. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SubscriptionProductPuid: string
Maximum Length:
150Value that uniquely identifies the subscription product in Oracle Subscription Management Cloud.
arrayLinksobject-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Percent: number
Value that specifies the sales credit percent for the salesperson.
-
SalesCreditId: integer
(int64)
Read Only:
trueValue that uniquely identifies the sales credit. -
SalesCreditType: string
Maximum Length:
255Name of the sales credit type. -
SalesCreditTypeId: integer
(int64)
Value that identifies the sales credit type.
-
Salesperson: string
Maximum Length:
255Name of person who sold the item. -
SalespersonId: integer
(int64)
Value that identifies the person who sold the item.
-
SourceTransactionSalesCreditIdentifier: string
Maximum Length:
50Value that uniquely identifies the sales credit. The source application assigns this value.
arrayLinksobject-
Address1: string
Maximum Length:
255First line of the ship-to customer address. -
Address2: string
Maximum Length:
255Second line of the ship-to customer address. -
Address3: string
Maximum Length:
255Third line of the ship-to customer address. -
Address4: string
Maximum Length:
255Fourth line of the ship-to customer address. -
AddressId: integer
(int64)
Value that uniquely identifies the ship-to customer address.
-
City: string
Maximum Length:
255City of the ship-to customer address. -
ContactFirstName: string
Maximum Length:
255First name of the person to contact at the ship-to party site. -
ContactId: integer
(int64)
Value that uniquely identifies the contact at the ship-to party site.
-
ContactLastName: string
Maximum Length:
255Title name of the person to contact at the ship-to party site. -
ContactMiddleName: string
Maximum Length:
255Middle name of the person to contact at the ship-to party site. -
ContactName: string
Maximum Length:
255Name of the person to contact at the ship-to party site. -
ContactNameSuffix: string
Maximum Length:
255Name suffix of the person to contact at the ship-to party site. -
ContactNumber: string
Maximum Length:
255Telephone number of the person to contact at the ship-to party site. -
ContactTitle: string
Maximum Length:
255Title of the person to contact at the ship-to party site. -
Country: string
Maximum Length:
255Country of the ship-to customer address. -
County: string
Maximum Length:
255County of the ship-to customer address. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PartyId: integer
(int64)
Value that uniquely identifies the ship-to party.
-
PartyName: string
Maximum Length:
255Name of the ship-to party. -
PartyNumber: string
Maximum Length:
255Telephone number of the ship-to party. -
PersonFirstName: string
Maximum Length:
255First name of the person to contact at the ship-to customer site. -
PersonLastName: string
Maximum Length:
255Last name of the person to contact at the ship-to customer site. -
PersonMiddleName: string
Maximum Length:
255Middle name of the person to contact at the ship-to customer site. -
PersonNameSuffix: string
Maximum Length:
255Name suffix of the person to contact at the ship-to customer site. -
PersonTitle: string
Maximum Length:
255Title of the person to contact at the ship-to customer site. -
PostalCode: string
Maximum Length:
255City of the ship-to customer address. -
PreferredContactPointId: integer
(int64)
Value that uniquely identifies the email for the preferred person to contact at the ship-to party site.
-
Province: string
Maximum Length:
255Province of the ship-to customer address. -
SiteId: integer
(int64)
Value that uniquely identifies the ship-to customer address.
-
SourceAddressId: string
Maximum Length:
255Value that uniquely identifies the ship-to customer address. Value is 1. -
State: string
Maximum Length:
255State of the ship-to customer address.
arrayLinksobject-
DisplayLineNumber: string
Read Only:
trueMaximum Length:255Number that the order management work area displays to identify the order line of the subscription item that is associated with the product. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OrderNumber: string
Read Only:
trueMaximum Length:255Number that identifies the sales order that contains the subscription item that is associated with the product. -
SourceLineNumber: string
Title:
Source Order LineMaximum Length:100Number that identifies the order line in the source application that contains the subscription item which is associated with the product. -
SourceOrderNumber: string
Title:
Source OrderMaximum Length:50Number that identifies the source order in the source application that contains the subscription item which is associated with the product. -
SubscriptionFulFillLineId: integer
(int64)
Read Only:
trueValue that uniquely identifies the fulfillment line of the subscription item that is associated with the product. -
SubscriptionHeaderId: integer
(int64)
Read Only:
trueValue that uniquely identifies the sales order header that contains the subscription item which is associated with the product. -
SubscriptionItemNumber: string
Read Only:
trueMaximum Length:255Number that identifies the subscription item that is associated with the product.
arrayLinksobject-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OrderTermId: integer
(int64)
Value that uniquely identifies the term.
-
SourceOrderTermId: string
Maximum Length:
50Value that uniquely identifies the order term in the source application. For subscription term, the value is 1. -
TermAdjustmentPercent: number
Percent of adjustment for the term.
-
TermApplicationMethod: string
Maximum Length:
80Method of application for the term. This depends on the type of term. In Oracle Subscription Management Cloud, this attribute is called PricingMethod. -
TermApplicationMethodCode: string
Maximum Length:
30Abbreviation that identifies the method of application for the term. For a subscription, a list of accepted values is defined in the lookup type ORA_OSS_RNWL_PRICE_ADJ_TYPE. -
TermDuration: number
Duration for the subscription term.
-
TermPeriod: string
Maximum Length:
25Name of the time unit of measure for the subscription term. -
TermPeriodCode: string
Maximum Length:
15Abbreviation that identifies the time unit of measure for the subscription term. -
TermStartDate: string
(date-time)
Date when the subscription term starts.
-
TermTypeCode: string
Read Only:
trueMaximum Length:30Default Value:SUBSCRIPTIONAbbreviation that identifies the type of the term. For subscription term, the TermTypeCode is SUBSCRIPTION.
arrayLinksobject-
DocumentSystemReferenceId: integer
(int64)
Value that uniquely identifies the document system reference for the supply order.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SupplyOrderNumber: string
Maximum Length:
150Number that identifies the supply order during back-to-back fulfillment.
arrayLinksobject-
CharacterAttributeValue: string
Maximum Length:
2000Character value for the transaction item attribute (TIA). -
DateAttributeValue: string
(date)
Date value for the transaction item attribute (TIA).
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NumberAttributeValue: number
Number value for the transaction item attribute (TIA).
-
SourceTransactionLineAttributeId: string
Maximum Length:
50Value that uniquely identifies the transaction item attribute on the fulfillment line. The source application assigns this value. -
TimestampAttributeValue: string
(date-time)
Time value for the transaction item attribute (TIA).
-
TransactionAttributeId: integer
(int64)
Read Only:
trueValue that uniquely identifies the transaction item attribute on the fulfillment line. -
TransactionAttributeMetadataid: integer
(int64)
Value that identifies the transaction item attribute (TIA) that stores the metadata.
-
TransactionAttributeName: string
Maximum Length:
255Name of the transaction item attribute. -
TransactionItemAttributeId: integer
(int64)
Value that identifies the transaction item attribute (TIA).
arrayLinks- additionalInformation
-
Parameters:
- OrderKey:
$request.path.OrderKey - linesUniqID:
$request.path.linesUniqID
The Additional Details resource manages details that flexfields store for the sales order. - OrderKey:
- amendSubscriptionReferences
-
Parameters:
- OrderKey:
$request.path.OrderKey - linesUniqID:
$request.path.linesUniqID
The Amend Subscription References resource manages details about unique references to the subscription product in Oracle Subscription Management Cloud. When ActionTypeCode is ORA_AMEND, this information is used for ending the old subscription lines in Subscription Management that are replaced by the new subscription being created in Subscription Management. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features. - OrderKey:
- assetTransactionDetails
-
Parameters:
- OrderKey:
$request.path.OrderKey - linesUniqID:
$request.path.linesUniqID
The Asset Transaction Details resource manages the asset transaction details to support license migration orders. This resource is not currently used. - OrderKey:
- associatedProductReferences
-
Parameters:
- OrderKey:
$request.path.OrderKey - linesUniqID:
$request.path.linesUniqID
The Associated Product Items resource manages details about the product item that is associated with the subscription item on an order line. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features. - OrderKey:
- attachments
-
Parameters:
- OrderKey:
$request.path.OrderKey - linesUniqID:
$request.path.linesUniqID
The Attachments resource manages attachments for the order header and order line. - OrderKey:
- billToCustomer
-
Parameters:
- OrderKey:
$request.path.OrderKey - linesUniqID:
$request.path.linesUniqID
The Bill-to Customers resource manages the bill-to customer that the sales order header references. - OrderKey:
- billingPlans
-
Parameters:
- OrderKey:
$request.path.OrderKey - linesUniqID:
$request.path.linesUniqID
The Billing Plans resource manages the billing plan for the sales order. - OrderKey:
- channelPrograms
-
Parameters:
- OrderKey:
$request.path.OrderKey - linesUniqID:
$request.path.linesUniqID
The Channel Programs resource retrieves the channel programs of a sales order line. - OrderKey:
- charges
-
Parameters:
- OrderKey:
$request.path.OrderKey - linesUniqID:
$request.path.linesUniqID
The Charges resource manages price details for the sales order. - OrderKey:
- coverageReferences
-
Parameters:
- OrderKey:
$request.path.OrderKey - linesUniqID:
$request.path.linesUniqID
The Coverage Items resource retrieves details about each coverage item that covers a covered item on an order line. - OrderKey:
- coveredAssetReference
-
Parameters:
- OrderKey:
$request.path.OrderKey - linesUniqID:
$request.path.linesUniqID
The Covered Assets resource manages details about Asset that a coverage item covers. This is available for use with the Integrate Order Management with Subscription Management to Process Coverages feature. - OrderKey:
- coveredProductReferences
-
Parameters:
- OrderKey:
$request.path.OrderKey - linesUniqID:
$request.path.linesUniqID
The Covered Items resource manages details about each covered item that a coverage item covers on an order line. - OrderKey:
- dropShipPurchaseOrderReference
-
Parameters:
- OrderKey:
$request.path.OrderKey - linesUniqID:
$request.path.linesUniqID
The Drop Ships resource retrieves the purchase order when order management uses drop ship to ship the sales order. - OrderKey:
- dropShipRequisitionReference
-
Parameters:
- OrderKey:
$request.path.OrderKey - linesUniqID:
$request.path.linesUniqID
The Drop Ship Requisitions resource retrieves the requisition when order management uses drop ship to ship the sales order. - OrderKey:
- externalAssetReference
-
Parameters:
- OrderKey:
$request.path.OrderKey - linesUniqID:
$request.path.linesUniqID
The External Asset References resource manages details about asset keys from an external application that are associated with subscription items on an order line when ActionTypeCode is null or ORA_ADD. The External Asset References resource also manages details about unique references to the subscription product in Oracle Subscription Management Cloud when ActionTypeCode is ORA_END. When ActionTypeCode is ORA_END, this information is used for ending the subscription in Subscription Management. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features. - OrderKey:
- externalFulfillmentSalesOrderReference
-
Parameters:
- OrderKey:
$request.path.OrderKey - linesUniqID:
$request.path.linesUniqID
The Fulfillment Orders resource retrieves the fulfillment order in the fulfillment system that fulfills the sales order that order management submitted to the fulfillment system. - OrderKey:
- holds
-
Parameters:
- OrderKey:
$request.path.OrderKey - linesUniqID:
$request.path.linesUniqID
The Holds resource retrieves active and released holds on the order line. - OrderKey:
- internalOrderReference
-
Parameters:
- OrderKey:
$request.path.OrderKey - linesUniqID:
$request.path.linesUniqID
The Internal Sales Orders resource retrieves sales orders that are internal to order management. - OrderKey:
- lineDetails
-
Parameters:
- OrderKey:
$request.path.OrderKey - linesUniqID:
$request.path.linesUniqID
The Line Details resource retrieves shipping and billing details for the order line. - OrderKey:
- lotSerials
-
Parameters:
- OrderKey:
$request.path.OrderKey - linesUniqID:
$request.path.linesUniqID
The Lot Serials resource manages the lot serial details for returns and inventory transaction order lines. - OrderKey:
- manualPriceAdjustments
-
Parameters:
- OrderKey:
$request.path.OrderKey - linesUniqID:
$request.path.linesUniqID
The Manual Price Adjustments resource manages manual price adjustments that the Order Entry Specialist applies for each order line. - OrderKey:
- originalOrderReference
-
Parameters:
- OrderKey:
$request.path.OrderKey - linesUniqID:
$request.path.linesUniqID
The Original Orders resource retrieves the original order for a return sales order. - OrderKey:
- payments
-
Parameters:
- OrderKey:
$request.path.OrderKey - linesUniqID:
$request.path.linesUniqID
The Payments resource manages payment details of the order. - OrderKey:
- priceAdjustments
-
Parameters:
- OrderKey:
$request.path.OrderKey - linesUniqID:
$request.path.linesUniqID
The Price Adjustments resource retrieves price adjustments, such as discounts. - OrderKey:
- priceValidations
-
Parameters:
- OrderKey:
$request.path.OrderKey - linesUniqID:
$request.path.linesUniqID
The Price Validations resource retrieves price validations and price violations that occur when pricing prices a sales order. - OrderKey:
- project
-
Parameters:
- OrderKey:
$request.path.OrderKey - linesUniqID:
$request.path.linesUniqID
The Projects resource manages the project details of a sales order line. - OrderKey:
- renewSubscriptionReference
-
Parameters:
- OrderKey:
$request.path.OrderKey - linesUniqID:
$request.path.linesUniqID
The Renew Subscription References resource manages details about unique reference to the subscription product in Oracle Subscription Management Cloud. When ActionTypeCode is ORA_RENEW, this information is used for associating the old subscription line in Subscription Management that is replaced by the renewed subscription being created in Subscription Management. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features. - OrderKey:
- salesCredits
-
Parameters:
- OrderKey:
$request.path.OrderKey - linesUniqID:
$request.path.linesUniqID
The Sales Credits resource manages sales credits for each salesperson on the sales order. - OrderKey:
- shipToCustomer
-
Parameters:
- OrderKey:
$request.path.OrderKey - linesUniqID:
$request.path.linesUniqID
The Ship-to Customers resource manages the ship-to customer that the sales order header references. - OrderKey:
- subscriptionReferences
-
Parameters:
- OrderKey:
$request.path.OrderKey - linesUniqID:
$request.path.linesUniqID
The Subscription Items resource retrieves details about subscription items that are associated with product items on an order line. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features. - OrderKey:
- subscriptionTerm
-
Parameters:
- OrderKey:
$request.path.OrderKey - linesUniqID:
$request.path.linesUniqID
The Subscription Terms resource manages details about pricing term definitions for subscriptions. When the pricing term is enabled, subscription generates the billing schedule for the duration of the pricing term, for both evergreen and termed lines based of the pricing method. This is available for use with the Integrate Order Management with Subscription Management to Process Subscriptions or Coverages features. - OrderKey:
- supplyOrderReference
-
Parameters:
- OrderKey:
$request.path.OrderKey - linesUniqID:
$request.path.linesUniqID
The Supply Orders resource retrieves the supply that order management uses to supply the item. - OrderKey:
- transactionItemAttributes
-
Parameters:
- OrderKey:
$request.path.OrderKey - linesUniqID:
$request.path.linesUniqID
The Transaction Item Attributes resource manages transaction item attributes for each item on each order line. - OrderKey:
Examples
This example describes how to get one order line.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/OrderKey/child/lines/linesUniqID"
| Example Number | Description |
|---|---|
| Example 1 | Get one order line using a hash key. |
| Example 2 | Get one order line using FulfillLineId. |
| Example 3 | Get order line charges using FulfillLineId. |
| Example 4 | Get order line charge components using FulfillLineId. |
| Example 5 | Get order line fulfillment details using FulfillLineId. |
| Example 6 | Get order line data with the "-" operator to remove fields from the response. |
| Example 7 | Get one order line from the latest version of an order. |
| Example 8 | Get one order line from a specific HeaderId, whether it's an older or the latest version of the order. |
Example 1 cURL Command Using Hash Key to Get Order Line Data
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR:R13_Sample_order_01/child/lines/00020000000EACED00057708000110F084E186160000000EACED00057708000110F084E18617"
Example 1 Response Body
The following shows an example of the response body in JSON format.
{
"HeaderId" : 300100184278547,
"LineId" : 300100184278551,
"FulfillLineId" : 300100184278550,
"SourceTransactionLineId" : "1",
"SourceTransactionLineNumber" : "1",
"SourceTransactionId" : "R13_Sample_order_01",
"SourceTransactionNumber" : "R13_Sample_Order_01",
"SourceTransactionSystem" : "GPR",
"RequestingBusinessUnitId" : 204,
"RequestingBusinessUnitName" : "Vision Operations",
"AccountingRuleCode" : null,
"AccountingRule" : null,
"ActionTypeCode" : null,
"ActionType" : null,
"ActualCompletionDate" : null,
"ActualShipDate" : null,
"AppliedPriceListId" : 300100071623855,
"AppliedPriceListName" : "Corporate Segment Price List",
"AssessableValue" : 1050,
"AssetGroupNumber" : null,
"AssetTrackedFlag" : false,
"AssetTrackingCode" : "N",
"AssetTracking" : "Not Tracked",
"BillingTransactionTypeId" : null,
"BillingTransactionTypeName" : null,
"BuyerId" : null,
"BuyerName" : null,
"BuyerFirstName" : null,
"BuyerLastName" : null,
"BuyerMiddleName" : null,
"CancelReasonCode" : null,
"CancelReason" : null,
"CanceledFlag" : false,
"CanceledQuantity" : null,
"ShippingCarrierId" : null,
"ShippingCarrier" : null,
"TransactionCategoryCode" : "ORDER",
"Comments" : null,
"ComponentIdPath" : null,
"ConfigCreationDate" : null,
"ConfigHeaderId" : null,
"ConfigInventoryItemId" : null,
"ConfigInventoryItemNumber" : null,
"ConfigInventoryItemDescription" : null,
"ConfigItemReference" : null,
"ConfigRevisionNumber" : null,
"ConfigTradeComplianceResultCode" : null,
"ConfigTradeComplianceResult" : null,
"ConfiguratorPath" : null,
"ContractEndDate" : null,
"ContractStartDate" : null,
"CreatedBy" : "SCMOPERATIONS",
"CreationDate" : "2019-11-10T06:32:06.062+00:00",
"CreditCheckAuthExpiryDate" : null,
"CreditCheckAuthorizationNumber" : null,
"CustomerProductId" : null,
"CustomerProductNumber" : null,
"CustomerProductDescription" : null,
"CustomerPOLineNumber" : null,
"CustomerPONumber" : null,
"CustomerPOScheduleNumber" : null,
"DefaultTaxationCountry" : "US",
"DefaultTaxationCountryShortName" : "United States",
"DemandClassCode" : null,
"DemandClass" : null,
"DestinationLocationId" : null,
"DestinationShippingOrganizationId" : null,
"DestinationShippingOrganizationCode" : null,
"DestinationShippingOrganizationName" : null,
"DocumentSubtype" : null,
"DocumentSubtypeName" : null,
"EarliestAcceptableShipDate" : null,
"EstimateFulfillmentCost" : 0,
"EstimateMargin" : 1050,
"ExemptionCertificateNumber" : null,
"ExtendedAmount" : 1000,
"FinalDischargeLocationId" : null,
"FinalDischargeLocationAddressLine1" : null,
"FinalDischargeLocationAddressLine2" : null,
"FinalDischargeLocationAddressLine3" : null,
"FinalDischargeLocationAddressLine4" : null,
"FinalDischargeLocationAddressCity" : null,
"FinalDischargeLocationAddressPostalCode" : null,
"FinalDischargeLocationAddressState" : null,
"FinalDischargeLocationAddressProvince" : null,
"FinalDischargeLocationAddressCounty" : null,
"FinalDischargeLocationAddressCountry" : null,
"FirstPartyTaxRegistration" : 35647,
"FirstPartyTaxRegistrationNumber" : "4567890",
"FOBPointCode" : null,
"FOBPoint" : null,
"FreightTermsCode" : null,
"FreightTerms" : null,
"FulfillInstanceId" : 100010026240309,
"FulfillLineNumber" : "1",
"RequestedFulfillmentOrganizationId" : 204,
"RequestedFulfillmentOrganizationCode" : "V1",
"RequestedFulfillmentOrganizationName" : "Vision Operations",
"OverFulfillmentTolerance" : 50,
"UnderFulfillmentTolerance" : 50,
"FulfilledQuantity" : null,
"FulfillmentDate" : null,
"FulfillmentMode" : null,
"FulfillmentSplitReferenceId" : null,
"GopReferenceId" : null,
"GopRequestRegion" : null,
"IntendedUseClassificationId" : null,
"IntendedUseClassificationName" : null,
"ProductId" : 2157,
"ProductNumber" : "AS92888",
"ProductDescription" : "AS92888",
"InventoryOrganizationId" : 204,
"InventoryOrganizationCode" : "V1",
"InventoryOrganizationName" : "Vision Operations",
"InvoiceEnabledFlag" : true,
"InvoiceInterfacedFlag" : false,
"InvoiceableItemFlag" : true,
"InvoicingRuleCode" : null,
"InvoicingRule" : null,
"ItemSubTypeCode" : "STANDARD",
"ItemSubType" : "Standard",
"ItemTypeCode" : "4",
"LastUpdateDate" : "2019-11-10T06:33:40.153+00:00",
"LastUpdateLogin" : "951C46CC2AB03D44E053CC5AF00A6A61",
"LastUpdatedBy" : "SCMOPERATIONS",
"LatestAcceptableArrivalDate" : null,
"LatestAcceptableShipDate" : null,
"TransactionLineTypeCode" : "ORA_BUY",
"TransactionLineType" : "Buy",
"OnHoldFlag" : false,
"OpenFlag" : true,
"OrderedQuantity" : 5,
"OrderedUOMCode" : "Ea",
"OrderedUOM" : "Each",
"BusinessUnitId" : 204,
"BusinessUnitName" : "Vision Operations",
"OrigSystemDocumentLineReference" : null,
"OrigSystemDocumentReference" : null,
"OriginalProductId" : null,
"OriginalProductNumber" : null,
"OriginalProductDescription" : null,
"OverrideScheduleDateFlag" : false,
"OwnerId" : null,
"PackingInstructions" : null,
"ParentFulfillLineId" : null,
"PartialShipAllowedFlag" : false,
"PaymentTermsCode" : 4,
"PaymentTerms" : "30 Net",
"POStatusCode" : null,
"PricedOn" : "2019-11-10T06:35:18.714+00:00",
"ProcessNumber" : "300100184278582",
"ProductFiscalCategoryId" : null,
"ProductFiscalCategory" : null,
"ProductCategory" : null,
"ProductCategoryName" : null,
"ProductType" : "GOODS",
"ProductTypeName" : "Goods",
"PromiseArrivalDate" : null,
"PromiseShipDate" : null,
"PurchasingEnabledFlag" : true,
"PurchasingUOMCode" : null,
"PurchasingUOM" : null,
"QuantityForEachModel" : null,
"ReceivablesOrgId" : null,
"ReceivablesOrgName" : null,
"RemnantFlag" : false,
"RequestedArrivalDate" : null,
"RequestedCancelDate" : null,
"RequestedShipDate" : "2019-10-19T20:49:12+00:00",
"RequiredFulfillmentDate" : null,
"RequisitionBusinessUnitId" : null,
"RequisitionBusinessUnitName" : null,
"RequisitionInventoryOrganizationId" : null,
"RequisitionInventoryOrganizationCode" : null,
"RequisitionInventoryOrganizationName" : null,
"ReservableFlag" : true,
"ReservationId" : null,
"ReservedQuantity" : 5,
"ReturnReasonCode" : null,
"ReturnReason" : null,
"ReturnableFlag" : true,
"RMADeliveredQuantity" : null,
"RootParentFulfillLineId" : null,
"SalesProductTypeCode" : null,
"SalesProductType" : null,
"SalespersonId" : null,
"Salesperson" : null,
"ScheduleArrivalDate" : "2019-11-08T23:59:59+00:00",
"ScheduleShipDate" : "2019-11-08T23:59:59+00:00",
"SchedulingReason" : null,
"SchedulingReasonCode" : null,
"ServiceDuration" : null,
"ServiceDurationPeriodCode" : null,
"ServiceDurationPeriodName" : null,
"ShippingServiceLevelCode" : null,
"ShippingServiceLevel" : null,
"ShippingModeCode" : null,
"ShippingMode" : null,
"ShipSetName" : null,
"ShipmentPriorityCode" : null,
"ShipmentPriority" : null,
"ShippableFlag" : true,
"ShippedQuantity" : null,
"ShippedUOMCode" : null,
"ShippedUOM" : null,
"ShippingInstructions" : null,
"ShowInSales" : null,
"SourceTransactionRevisionNumber" : 1,
"SourceTransactionScheduleId" : "1",
"SourceScheduleNumber" : "1",
"SplitFromFlineId" : null,
"StatusCode" : "AWAIT_SHIP",
"Status" : "Awaiting Shipping",
"SubinventoryCode" : null,
"Subinventory" : null,
"SubstitutionAllowedFlag" : null,
"SubstitutionReasonCode" : null,
"SubstitutionReason" : null,
"SupplierId" : null,
"SupplierName" : null,
"SupplierSiteId" : null,
"SupplierSiteName" : null,
"SupplyStatusCode" : null,
"TaxClassificationCode" : "VAT20",
"TaxClassification" : "VAT20",
"TaxExemptFlag" : false,
"TaxExemptCode" : "S",
"TaxExempt" : "Standard",
"TaxExemptReasonCode" : null,
"TaxExemptReason" : null,
"TaxInvoiceDate" : null,
"TaxInvoiceNumber" : null,
"ThirdPartyTaxRegistration" : null,
"ThirdPartyTaxRegistrationNumber" : null,
"TotalContractAmount" : null,
"TotalContractQuantity" : null,
"TradeComplianceDate" : null,
"TradeComplianceResultCode" : null,
"TradeComplianceResult" : null,
"TransportationPlannedFlag" : false,
"TransportationPlannedStatusCode" : "N",
"TransactionBusinessCategory" : "SALES_TRANSACTION",
"TransactionBusinessCategoryName" : "Sales Transaction",
"UnitListPrice" : 210,
"UnitQuantity" : null,
"UnitSellingPrice" : 200,
"UserDefinedFiscalClass" : null,
"UserDefinedFiscalClassName" : null,
"ValidConfigurationFlag" : null,
"LineNumber" : 1,
"DisplayLineNumber" : "1",
"ParentSourceTransactionLineId" : null,
"TransformFromLineId" : null,
"UnreferencedReturnFlag" : false,
"ServiceCancelDate" : null,
"CoveredProductId" : null,
"CoveredProductNumber" : null,
"CoveredProductDescription" : null,
"CoveredCustomerProductId" : null,
"CoveredCustomerProductNumber" : null,
"CoveredCustomerProductDescription" : null,
"JeopardyPriorityCode" : null,
"JeopardyPriority" : null,
"AgreementHeaderId" : null,
"AgreementLineId" : null,
"AgreementLineNumber" : null,
"AgreementVersionNumber" : null,
"SellingProfitCenterBusinessUnitId" : null,
"SellingProfitCenterBusinessUnitName" : null,
"TransportationPlanningOrder" : null,
"links" : [ {
"rel" : "self",
"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Sample_order_01/child/lines/00020000000EACED00057708000110F084E186160000000EACED00057708000110F084E18617",
"name" : "lines",
"kind" : "item",
"properties" : {
"changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000097371007E00020000000878"
}
}, {
"rel" : "canonical",
"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Sample_order_01/child/lines/00020000000EACED00057708000110F084E186160000000EACED00057708000110F084E18617",
"name" : "lines",
"kind" : "item"
}, {
"rel" : "parent",
"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Sample_order_01",
"name" : "salesOrdersForOrderHub",
"kind" : "item"
}, {
"rel" : "child",
"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Sample_order_01/child/lines/00020000000EACED00057708000110F084E186160000000EACED00057708000110F084E18617/child/additionalInformation",
"name" : "additionalInformation",
"kind" : "collection"
}, {
"rel" : "child",
"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Sample_order_01/child/lines/00020000000EACED00057708000110F084E186160000000EACED00057708000110F084E18617/child/attachments",
"name" : "attachments",
"kind" : "collection"
}, {
"rel" : "child",
"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Sample_order_01/child/lines/00020000000EACED00057708000110F084E186160000000EACED00057708000110F084E18617/child/billToCustomer",
"name" : "billToCustomer",
"kind" : "collection"
}, {
"rel" : "child",
"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Sample_order_01/child/lines/00020000000EACED00057708000110F084E186160000000EACED00057708000110F084E18617/child/billingPlans",
"name" : "billingPlans",
"kind" : "collection"
}, {
"rel" : "child",
"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Sample_order_01/child/lines/00020000000EACED00057708000110F084E186160000000EACED00057708000110F084E18617/child/channelPrograms",
"name" : "channelPrograms",
"kind" : "collection"
}, {
"rel" : "child",
"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Sample_order_01/child/lines/00020000000EACED00057708000110F084E186160000000EACED00057708000110F084E18617/child/charges",
"name" : "charges",
"kind" : "collection"
}, {
"rel" : "child",
"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Sample_order_01/child/lines/00020000000EACED00057708000110F084E186160000000EACED00057708000110F084E18617/child/coverageReferences",
"name" : "coverageReferences",
"kind" : "collection"
}, {
"rel" : "child",
"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Sample_order_01/child/lines/00020000000EACED00057708000110F084E186160000000EACED00057708000110F084E18617/child/coveredProductReferences",
"name" : "coveredProductReferences",
"kind" : "collection"
}, {
"rel" : "child",
"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Sample_order_01/child/lines/00020000000EACED00057708000110F084E186160000000EACED00057708000110F084E18617/child/dropShipPurchaseOrderReference",
"name" : "dropShipPurchaseOrderReference",
"kind" : "collection"
}, {
"rel" : "child",
"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Sample_order_01/child/lines/00020000000EACED00057708000110F084E186160000000EACED00057708000110F084E18617/child/dropShipRequisitionReference",
"name" : "dropShipRequisitionReference",
"kind" : "collection"
}, {
"rel" : "child",
"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Sample_order_01/child/lines/00020000000EACED00057708000110F084E186160000000EACED00057708000110F084E18617/child/externalFulfillmentSalesOrderReference",
"name" : "externalFulfillmentSalesOrderReference",
"kind" : "collection"
}, {
"rel" : "child",
"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Sample_order_01/child/lines/00020000000EACED00057708000110F084E186160000000EACED00057708000110F084E18617/child/holds",
"name" : "holds",
"kind" : "collection"
}, {
"rel" : "child",
"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Sample_order_01/child/lines/00020000000EACED00057708000110F084E186160000000EACED00057708000110F084E18617/child/internalOrderReference",
"name" : "internalOrderReference",
"kind" : "collection"
}, {
"rel" : "child",
"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Sample_order_01/child/lines/00020000000EACED00057708000110F084E186160000000EACED00057708000110F084E18617/child/lineDetails",
"name" : "lineDetails",
"kind" : "collection"
}, {
"rel" : "child",
"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Sample_order_01/child/lines/00020000000EACED00057708000110F084E186160000000EACED00057708000110F084E18617/child/lotSerials",
"name" : "lotSerials",
"kind" : "collection"
}, {
"rel" : "child",
"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Sample_order_01/child/lines/00020000000EACED00057708000110F084E186160000000EACED00057708000110F084E18617/child/manualPriceAdjustments",
"name" : "manualPriceAdjustments",
"kind" : "collection"
}, {
"rel" : "child",
"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Sample_order_01/child/lines/00020000000EACED00057708000110F084E186160000000EACED00057708000110F084E18617/child/originalOrderReference",
"name" : "originalOrderReference",
"kind" : "collection"
}, {
"rel" : "child",
"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Sample_order_01/child/lines/00020000000EACED00057708000110F084E186160000000EACED00057708000110F084E18617/child/payments",
"name" : "payments",
"kind" : "collection"
}, {
"rel" : "child",
"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Sample_order_01/child/lines/00020000000EACED00057708000110F084E186160000000EACED00057708000110F084E18617/child/priceAdjustments",
"name" : "priceAdjustments",
"kind" : "collection"
}, {
"rel" : "child",
"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Sample_order_01/child/lines/00020000000EACED00057708000110F084E186160000000EACED00057708000110F084E18617/child/priceValidations",
"name" : "priceValidations",
"kind" : "collection"
}, {
"rel" : "child",
"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Sample_order_01/child/lines/00020000000EACED00057708000110F084E186160000000EACED00057708000110F084E18617/child/project",
"name" : "project",
"kind" : "collection"
}, {
"rel" : "child",
"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Sample_order_01/child/lines/00020000000EACED00057708000110F084E186160000000EACED00057708000110F084E18617/child/salesCredits",
"name" : "salesCredits",
"kind" : "collection"
}, {
"rel" : "child",
"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Sample_order_01/child/lines/00020000000EACED00057708000110F084E186160000000EACED00057708000110F084E18617/child/shipToCustomer",
"name" : "shipToCustomer",
"kind" : "collection"
}, {
"rel" : "child",
"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Sample_order_01/child/lines/00020000000EACED00057708000110F084E186160000000EACED00057708000110F084E18617/child/supplyOrderReference",
"name" : "supplyOrderReference",
"kind" : "collection"
}, {
"rel" : "child",
"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Sample_order_01/child/lines/00020000000EACED00057708000110F084E186160000000EACED00057708000110F084E18617/child/transactionItemAttributes",
"name" : "transactionItemAttributes",
"kind" : "collection"
} ]
}
Example 2 cURL Command Using FulfillLineId to Get Order Line Data
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR:R13_Sample_order_01/child/lines?q=FulfillLineId=300100184278550&onlyData=true"
Example 2 Response Body
The following shows an example of the response body in JSON format.
{
"items" : [ {
"HeaderId" : 300100184278547,
"LineId" : 300100184278551,
"FulfillLineId" : 300100184278550,
"SourceTransactionLineId" : "1",
"SourceTransactionLineNumber" : "1",
"SourceTransactionId" : "R13_Sample_order_01",
"SourceTransactionNumber" : "R13_Sample_Order_01",
"SourceTransactionSystem" : "GPR",
"RequestingBusinessUnitId" : 204,
"RequestingBusinessUnitName" : "Vision Operations",
"AccountingRuleCode" : null,
"AccountingRule" : null,
"ActionTypeCode" : null,
"ActionType" : null,
"ActualCompletionDate" : null,
"ActualShipDate" : null,
"AppliedPriceListId" : 300100071623855,
"AppliedPriceListName" : "Corporate Segment Price List",
"AssessableValue" : 1050,
"AssetGroupNumber" : null,
"AssetTrackedFlag" : false,
"AssetTrackingCode" : "N",
"AssetTracking" : "Not Tracked",
"BillingTransactionTypeId" : null,
"BillingTransactionTypeName" : null,
"BuyerId" : null,
"BuyerName" : null,
"BuyerFirstName" : null,
"BuyerLastName" : null,
"BuyerMiddleName" : null,
"CancelReasonCode" : null,
"CancelReason" : null,
"CanceledFlag" : false,
"CanceledQuantity" : null,
"ShippingCarrierId" : null,
"ShippingCarrier" : null,
"TransactionCategoryCode" : "ORDER",
"Comments" : null,
"ComponentIdPath" : null,
"ConfigCreationDate" : null,
"ConfigHeaderId" : null,
"ConfigInventoryItemId" : null,
"ConfigInventoryItemNumber" : null,
"ConfigInventoryItemDescription" : null,
"ConfigItemReference" : null,
"ConfigRevisionNumber" : null,
"ConfigTradeComplianceResultCode" : null,
"ConfigTradeComplianceResult" : null,
"ConfiguratorPath" : null,
"ContractEndDate" : null,
"ContractStartDate" : null,
"CreatedBy" : "SCMOPERATIONS",
"CreationDate" : "2019-11-10T06:32:06.062+00:00",
"CreditCheckAuthExpiryDate" : null,
"CreditCheckAuthorizationNumber" : null,
"CustomerProductId" : null,
"CustomerProductNumber" : null,
"CustomerProductDescription" : null,
"CustomerPOLineNumber" : null,
"CustomerPONumber" : null,
"CustomerPOScheduleNumber" : null,
"DefaultTaxationCountry" : "US",
"DefaultTaxationCountryShortName" : "United States",
"DemandClassCode" : null,
"DemandClass" : null,
"DestinationLocationId" : null,
"DestinationShippingOrganizationId" : null,
"DestinationShippingOrganizationCode" : null,
"DestinationShippingOrganizationName" : null,
"DocumentSubtype" : null,
"DocumentSubtypeName" : null,
"EarliestAcceptableShipDate" : null,
"EstimateFulfillmentCost" : 0,
"EstimateMargin" : 1050,
"ExemptionCertificateNumber" : null,
"ExtendedAmount" : 1000,
"FinalDischargeLocationId" : null,
"FinalDischargeLocationAddressLine1" : null,
"FinalDischargeLocationAddressLine2" : null,
"FinalDischargeLocationAddressLine3" : null,
"FinalDischargeLocationAddressLine4" : null,
"FinalDischargeLocationAddressCity" : null,
"FinalDischargeLocationAddressPostalCode" : null,
"FinalDischargeLocationAddressState" : null,
"FinalDischargeLocationAddressProvince" : null,
"FinalDischargeLocationAddressCounty" : null,
"FinalDischargeLocationAddressCountry" : null,
"FirstPartyTaxRegistration" : 35647,
"FirstPartyTaxRegistrationNumber" : "4567890",
"FOBPointCode" : null,
"FOBPoint" : null,
"FreightTermsCode" : null,
"FreightTerms" : null,
"FulfillInstanceId" : 100010026240309,
"FulfillLineNumber" : "1",
"RequestedFulfillmentOrganizationId" : 204,
"RequestedFulfillmentOrganizationCode" : "V1",
"RequestedFulfillmentOrganizationName" : "Vision Operations",
"OverFulfillmentTolerance" : 50,
"UnderFulfillmentTolerance" : 50,
"FulfilledQuantity" : null,
"FulfillmentDate" : null,
"FulfillmentMode" : null,
"FulfillmentSplitReferenceId" : null,
"GopReferenceId" : null,
"GopRequestRegion" : null,
"IntendedUseClassificationId" : null,
"IntendedUseClassificationName" : null,
"ProductId" : 2157,
"ProductNumber" : "AS92888",
"ProductDescription" : "AS92888",
"InventoryOrganizationId" : 204,
"InventoryOrganizationCode" : "V1",
"InventoryOrganizationName" : "Vision Operations",
"InvoiceEnabledFlag" : true,
"InvoiceInterfacedFlag" : false,
"InvoiceableItemFlag" : true,
"InvoicingRuleCode" : null,
"InvoicingRule" : null,
"ItemSubTypeCode" : "STANDARD",
"ItemSubType" : "Standard",
"ItemTypeCode" : "4",
"LastUpdateDate" : "2019-11-10T06:33:40.153+00:00",
"LastUpdateLogin" : "951C46CC2AB03D44E053CC5AF00A6A61",
"LastUpdatedBy" : "SCMOPERATIONS",
"LatestAcceptableArrivalDate" : null,
"LatestAcceptableShipDate" : null,
"TransactionLineTypeCode" : "ORA_BUY",
"TransactionLineType" : "Buy",
"OnHoldFlag" : false,
"OpenFlag" : true,
"OrderedQuantity" : 5,
"OrderedUOMCode" : "Ea",
"OrderedUOM" : "Each",
"BusinessUnitId" : 204,
"BusinessUnitName" : "Vision Operations",
"OrigSystemDocumentLineReference" : null,
"OrigSystemDocumentReference" : null,
"OriginalProductId" : null,
"OriginalProductNumber" : null,
"OriginalProductDescription" : null,
"OverrideScheduleDateFlag" : false,
"OwnerId" : null,
"PackingInstructions" : null,
"ParentFulfillLineId" : null,
"PartialShipAllowedFlag" : false,
"PaymentTermsCode" : 4,
"PaymentTerms" : "30 Net",
"POStatusCode" : null,
"PricedOn" : "2019-11-10T06:35:18.714+00:00",
"ProcessNumber" : "300100184278582",
"ProductFiscalCategoryId" : null,
"ProductFiscalCategory" : null,
"ProductCategory" : null,
"ProductCategoryName" : null,
"ProductType" : "GOODS",
"ProductTypeName" : "Goods",
"PromiseArrivalDate" : null,
"PromiseShipDate" : null,
"PurchasingEnabledFlag" : true,
"PurchasingUOMCode" : null,
"PurchasingUOM" : null,
"QuantityForEachModel" : null,
"ReceivablesOrgId" : null,
"ReceivablesOrgName" : null,
"RemnantFlag" : false,
"RequestedArrivalDate" : null,
"RequestedCancelDate" : null,
"RequestedShipDate" : "2019-10-19T20:49:12+00:00",
"RequiredFulfillmentDate" : null,
"RequisitionBusinessUnitId" : null,
"RequisitionBusinessUnitName" : null,
"RequisitionInventoryOrganizationId" : null,
"RequisitionInventoryOrganizationCode" : null,
"RequisitionInventoryOrganizationName" : null,
"ReservableFlag" : true,
"ReservationId" : null,
"ReservedQuantity" : 5,
"ReturnReasonCode" : null,
"ReturnReason" : null,
"ReturnableFlag" : true,
"RMADeliveredQuantity" : null,
"RootParentFulfillLineId" : null,
"SalesProductTypeCode" : null,
"SalesProductType" : null,
"SalespersonId" : null,
"Salesperson" : null,
"ScheduleArrivalDate" : "2019-11-08T23:59:59+00:00",
"ScheduleShipDate" : "2019-11-08T23:59:59+00:00",
"SchedulingReason" : null,
"SchedulingReasonCode" : null,
"ServiceDuration" : null,
"ServiceDurationPeriodCode" : null,
"ServiceDurationPeriodName" : null,
"ShippingServiceLevelCode" : null,
"ShippingServiceLevel" : null,
"ShippingModeCode" : null,
"ShippingMode" : null,
"ShipSetName" : null,
"ShipmentPriorityCode" : null,
"ShipmentPriority" : null,
"ShippableFlag" : true,
"ShippedQuantity" : null,
"ShippedUOMCode" : null,
"ShippedUOM" : null,
"ShippingInstructions" : null,
"ShowInSales" : null,
"SourceTransactionRevisionNumber" : 1,
"SourceTransactionScheduleId" : "1",
"SourceScheduleNumber" : "1",
"SplitFromFlineId" : null,
"StatusCode" : "AWAIT_SHIP",
"Status" : "Awaiting Shipping",
"SubinventoryCode" : null,
"Subinventory" : null,
"SubstitutionAllowedFlag" : null,
"SubstitutionReasonCode" : null,
"SubstitutionReason" : null,
"SupplierId" : null,
"SupplierName" : null,
"SupplierSiteId" : null,
"SupplierSiteName" : null,
"SupplyStatusCode" : null,
"TaxClassificationCode" : "VAT20",
"TaxClassification" : "VAT20",
"TaxExemptFlag" : false,
"TaxExemptCode" : "S",
"TaxExempt" : "Standard",
"TaxExemptReasonCode" : null,
"TaxExemptReason" : null,
"TaxInvoiceDate" : null,
"TaxInvoiceNumber" : null,
"ThirdPartyTaxRegistration" : null,
"ThirdPartyTaxRegistrationNumber" : null,
"TotalContractAmount" : null,
"TotalContractQuantity" : null,
"TradeComplianceDate" : null,
"TradeComplianceResultCode" : null,
"TradeComplianceResult" : null,
"TransportationPlannedFlag" : false,
"TransportationPlannedStatusCode" : "N",
"TransactionBusinessCategory" : "SALES_TRANSACTION",
"TransactionBusinessCategoryName" : "Sales Transaction",
"UnitListPrice" : 210,
"UnitQuantity" : null,
"UnitSellingPrice" : 200,
"UserDefinedFiscalClass" : null,
"UserDefinedFiscalClassName" : null,
"ValidConfigurationFlag" : null,
"LineNumber" : 1,
"DisplayLineNumber" : "1",
"ParentSourceTransactionLineId" : null,
"TransformFromLineId" : null,
"UnreferencedReturnFlag" : false,
"ServiceCancelDate" : null,
"CoveredProductId" : null,
"CoveredProductNumber" : null,
"CoveredProductDescription" : null,
"CoveredCustomerProductId" : null,
"CoveredCustomerProductNumber" : null,
"CoveredCustomerProductDescription" : null,
"JeopardyPriorityCode" : null,
"JeopardyPriority" : null,
"AgreementHeaderId" : null,
"AgreementLineId" : null,
"AgreementLineNumber" : null,
"AgreementVersionNumber" : null,
"SellingProfitCenterBusinessUnitId" : null,
"SellingProfitCenterBusinessUnitName" : null,
"TransportationPlanningOrder" : null
} ],
"count" : 1,
"hasMore" : false,
"limit" : 25,
"offset" : 0,
"links" : [ {
"rel" : "self",
"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Sample_order_01/child/lines",
"name" : "lines",
"kind" : "collection"
} ]
}
Example 3 cURL Command Using FulfillLineId to Get Order Line Charges
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_charges_01/child/lines?q=FulfillLineId=300100187170597&expand=charges&fields=charges:*&onlyData=true"
Example 3 Response Body
The following shows an example of the response body in JSON format.
{
"items" : [ {
"charges" : [ {
"OrderChargeId" : 300100187876059,
"SourceChargeId" : "SC1",
"PriceTypeCode" : "ONE_TIME",
"PriceType" : "One time",
"ChargeTypeCode" : "ORA_SALE",
"ChargeType" : "Sale",
"ChargeDefinitionCode" : "QP_SALE_PRICE",
"ChargeDefinition" : "Sale Price",
"ChargeSubtypeCode" : "ORA_PRICE",
"ChargeSubType" : "Price",
"PricedQuantity" : 1,
"ChargeCurrencyCode" : "USD",
"ChargeCurrency" : "US Dollar",
"PricedQuantityUOMCode" : "Ea",
"PricedQuantityUOM" : "Each",
"PricePeriodicityCode" : null,
"PricePeriodicity" : null,
"SequenceNumber" : 1,
"PrimaryFlag" : true,
"RollupFlag" : false,
"AverageUnitSellingPrice" : null,
"CanAdjustFlag" : true,
"GSAUnitPrice" : null,
"ApplyToCode" : "PRICE",
"ApplyTo" : "Price"
}, {
"OrderChargeId" : 300100187876060,
"SourceChargeId" : "SC2",
"PriceTypeCode" : "RECURRING",
"PriceType" : "Recurring",
"ChargeTypeCode" : "ORA_SALE",
"ChargeType" : "Sale",
"ChargeDefinitionCode" : "QP_RECURRING_SALE_PRICE",
"ChargeDefinition" : "Recurring Sale Price",
"ChargeSubtypeCode" : "ORA_PRICE",
"ChargeSubType" : "Price",
"PricedQuantity" : null,
"ChargeCurrencyCode" : "USD",
"ChargeCurrency" : "US Dollar",
"PricedQuantityUOMCode" : null,
"PricedQuantityUOM" : null,
"PricePeriodicityCode" : "MTH",
"PricePeriodicity" : "Month",
"SequenceNumber" : 1,
"PrimaryFlag" : false,
"RollupFlag" : false,
"AverageUnitSellingPrice" : null,
"CanAdjustFlag" : false,
"GSAUnitPrice" : null,
"ApplyToCode" : "PRICE",
"ApplyTo" : "Price"
}, {
"OrderChargeId" : 300100187876061,
"SourceChargeId" : "SC3",
"PriceTypeCode" : "ONE_TIME",
"PriceType" : "One time",
"ChargeTypeCode" : "ORA_SHIPPING_FREIGHT",
"ChargeType" : "Freight",
"ChargeDefinitionCode" : "QP_SHIP_FREIGHT",
"ChargeDefinition" : "Freight",
"ChargeSubtypeCode" : "ORA_PRICE",
"ChargeSubType" : "Price",
"PricedQuantity" : null,
"ChargeCurrencyCode" : "USD",
"ChargeCurrency" : "US Dollar",
"PricedQuantityUOMCode" : null,
"PricedQuantityUOM" : null,
"PricePeriodicityCode" : null,
"PricePeriodicity" : null,
"SequenceNumber" : 2,
"PrimaryFlag" : true,
"RollupFlag" : false,
"AverageUnitSellingPrice" : null,
"CanAdjustFlag" : false,
"GSAUnitPrice" : null,
"ApplyToCode" : "SHIPPING",
"ApplyTo" : "Shipping"
} ]
} ],
"count" : 1,
"hasMore" : false,
"limit" : 25,
"offset" : 0,
"links" : [ {
"rel" : "self",
"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_charges_01/child/lines",
"name" : "lines",
"kind" : "collection"
} ]
}
Example 4 cURL Command Using FulfillLineId to Get Order Line Charge Components
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_charges_01/child/lines?q=FulfillLineId=300100187170597&expand=charges.chargeComponents&fields=charges.chargeComponents:*&onlyData=true"
Example 4 Response Body
The following shows an example of the response body in JSON format.
{
"items" : [ {
"charges" : [ {
"chargeComponents" : [ {
"OrderChargeComponentId" : 300100187876062,
"SourceChargeComponentId" : "SC1-SCC1",
"ChargeCurrencyUnitPrice" : 100,
"ChargeCurrencyExtendedAmount" : 100,
"ChargeCurrencyDurationExtendedAmount" : null,
"ChargeCurrencyCode" : "USD",
"ChargeCurrency" : "US Dollar",
"PriceElementCode" : "QP_LIST_PRICE",
"PriceElement" : "List Price",
"PriceElementUsageCode" : "LIST_PRICE",
"PriceElementUsage" : "List price",
"SequenceNumber" : 1,
"RollupFlag" : false,
"Explanation" : null,
"ExplanationMessageName" : null,
"HeaderCurrencyUnitPrice" : 100,
"HeaderCurrencyExtendedAmount" : 100,
"HeaderCurrencyDurationExtendedAmount" : null,
"HeaderCurrencyCode" : "USD",
"HeaderCurrency" : "US Dollar",
"PercentOfComparisonElement" : null,
"PricingSourceId" : null,
"PricingSourceTypeCode" : null,
"PricingSourceType" : null,
"SourceMpaId" : null,
"TaxIncludedFlag" : false
}, {
"OrderChargeComponentId" : 300100187876063,
"SourceChargeComponentId" : "SC1-SCC2",
"ChargeCurrencyUnitPrice" : -20,
"ChargeCurrencyExtendedAmount" : -20,
"ChargeCurrencyDurationExtendedAmount" : null,
"ChargeCurrencyCode" : "USD",
"ChargeCurrency" : "US Dollar",
"PriceElementCode" : "QP_DISCOUNT_ADJ",
"PriceElement" : "Discount Line Adjustment",
"PriceElementUsageCode" : "PRICE_ADJUSTMENT",
"PriceElementUsage" : "Price adjustment",
"SequenceNumber" : 2,
"RollupFlag" : false,
"Explanation" : "Price Adjustment Applied - Updated",
"ExplanationMessageName" : null,
"HeaderCurrencyUnitPrice" : -20,
"HeaderCurrencyExtendedAmount" : -20,
"HeaderCurrencyDurationExtendedAmount" : null,
"HeaderCurrencyCode" : "USD",
"HeaderCurrency" : "US Dollar",
"PercentOfComparisonElement" : null,
"PricingSourceId" : null,
"PricingSourceTypeCode" : null,
"PricingSourceType" : null,
"SourceMpaId" : null,
"TaxIncludedFlag" : false
}, {
"OrderChargeComponentId" : 300100187876064,
"SourceChargeComponentId" : "SC1-SCC3",
"ChargeCurrencyUnitPrice" : 80,
"ChargeCurrencyExtendedAmount" : 80,
"ChargeCurrencyDurationExtendedAmount" : null,
"ChargeCurrencyCode" : "USD",
"ChargeCurrency" : "US Dollar",
"PriceElementCode" : "QP_NET_PRICE",
"PriceElement" : "Your Price",
"PriceElementUsageCode" : "NET_PRICE",
"PriceElementUsage" : "Net price",
"SequenceNumber" : 3,
"RollupFlag" : false,
"Explanation" : null,
"ExplanationMessageName" : null,
"HeaderCurrencyUnitPrice" : 80,
"HeaderCurrencyExtendedAmount" : 80,
"HeaderCurrencyDurationExtendedAmount" : null,
"HeaderCurrencyCode" : "USD",
"HeaderCurrency" : "US Dollar",
"PercentOfComparisonElement" : null,
"PricingSourceId" : null,
"PricingSourceTypeCode" : null,
"PricingSourceType" : null,
"SourceMpaId" : null,
"TaxIncludedFlag" : false
}, {
"OrderChargeComponentId" : 300100187876066,
"SourceChargeComponentId" : "SC1-SCC5",
"ChargeCurrencyUnitPrice" : 90,
"ChargeCurrencyExtendedAmount" : 90,
"ChargeCurrencyDurationExtendedAmount" : null,
"ChargeCurrencyCode" : "USD",
"ChargeCurrency" : "US Dollar",
"PriceElementCode" : "QP_NET_PRICE_PLUS_TAX",
"PriceElement" : "Net Price Plus Tax",
"PriceElementUsageCode" : "NET_PRICE_PLUS_TAX",
"PriceElementUsage" : "Net price plus tax",
"SequenceNumber" : 5,
"RollupFlag" : false,
"Explanation" : null,
"ExplanationMessageName" : null,
"HeaderCurrencyUnitPrice" : 90,
"HeaderCurrencyExtendedAmount" : 90,
"HeaderCurrencyDurationExtendedAmount" : null,
"HeaderCurrencyCode" : "USD",
"HeaderCurrency" : "US Dollar",
"PercentOfComparisonElement" : null,
"PricingSourceId" : null,
"PricingSourceTypeCode" : null,
"PricingSourceType" : null,
"SourceMpaId" : null,
"TaxIncludedFlag" : false
} ]
}, {
"chargeComponents" : [ {
"OrderChargeComponentId" : 300100187876067,
"SourceChargeComponentId" : "SC2-SCC1",
"ChargeCurrencyUnitPrice" : 30,
"ChargeCurrencyExtendedAmount" : 30,
"ChargeCurrencyDurationExtendedAmount" : null,
"ChargeCurrencyCode" : "USD",
"ChargeCurrency" : "US Dollar",
"PriceElementCode" : "QP_LIST_PRICE",
"PriceElement" : "List Price",
"PriceElementUsageCode" : "LIST_PRICE",
"PriceElementUsage" : "List price",
"SequenceNumber" : 1001,
"RollupFlag" : false,
"Explanation" : null,
"ExplanationMessageName" : null,
"HeaderCurrencyUnitPrice" : 30,
"HeaderCurrencyExtendedAmount" : 30,
"HeaderCurrencyDurationExtendedAmount" : null,
"HeaderCurrencyCode" : "USD",
"HeaderCurrency" : "US Dollar",
"PercentOfComparisonElement" : 1,
"PricingSourceId" : null,
"PricingSourceTypeCode" : null,
"PricingSourceType" : null,
"SourceMpaId" : null,
"TaxIncludedFlag" : false
}, {
"OrderChargeComponentId" : 300100187876068,
"SourceChargeComponentId" : "SC2-SCC2",
"ChargeCurrencyUnitPrice" : 30,
"ChargeCurrencyExtendedAmount" : 30,
"ChargeCurrencyDurationExtendedAmount" : null,
"ChargeCurrencyCode" : "USD",
"ChargeCurrency" : "US Dollar",
"PriceElementCode" : "QP_NET_PRICE",
"PriceElement" : "Your Price",
"PriceElementUsageCode" : "NET_PRICE",
"PriceElementUsage" : "Net price",
"SequenceNumber" : 1002,
"RollupFlag" : false,
"Explanation" : null,
"ExplanationMessageName" : null,
"HeaderCurrencyUnitPrice" : 30,
"HeaderCurrencyExtendedAmount" : 30,
"HeaderCurrencyDurationExtendedAmount" : null,
"HeaderCurrencyCode" : "USD",
"HeaderCurrency" : "US Dollar",
"PercentOfComparisonElement" : 1,
"PricingSourceId" : null,
"PricingSourceTypeCode" : null,
"PricingSourceType" : null,
"SourceMpaId" : null,
"TaxIncludedFlag" : false
} ]
}, {
"chargeComponents" : [ {
"OrderChargeComponentId" : 300100187876069,
"SourceChargeComponentId" : "SC3-SCC1",
"ChargeCurrencyUnitPrice" : null,
"ChargeCurrencyExtendedAmount" : null,
"ChargeCurrencyDurationExtendedAmount" : null,
"ChargeCurrencyCode" : "USD",
"ChargeCurrency" : "US Dollar",
"PriceElementCode" : "QP_LIST_PRICE",
"PriceElement" : "List Price",
"PriceElementUsageCode" : "LIST_PRICE",
"PriceElementUsage" : "List price",
"SequenceNumber" : 1,
"RollupFlag" : false,
"Explanation" : null,
"ExplanationMessageName" : null,
"HeaderCurrencyUnitPrice" : 45,
"HeaderCurrencyExtendedAmount" : 45,
"HeaderCurrencyDurationExtendedAmount" : null,
"HeaderCurrencyCode" : "USD",
"HeaderCurrency" : "US Dollar",
"PercentOfComparisonElement" : null,
"PricingSourceId" : null,
"PricingSourceTypeCode" : null,
"PricingSourceType" : null,
"SourceMpaId" : null,
"TaxIncludedFlag" : false
}, {
"OrderChargeComponentId" : 300100187876070,
"SourceChargeComponentId" : "SC3-SCC2",
"ChargeCurrencyUnitPrice" : null,
"ChargeCurrencyExtendedAmount" : null,
"ChargeCurrencyDurationExtendedAmount" : null,
"ChargeCurrencyCode" : "USD",
"ChargeCurrency" : "US Dollar",
"PriceElementCode" : "QP_NET_PRICE",
"PriceElement" : "Your Price",
"PriceElementUsageCode" : "NET_PRICE",
"PriceElementUsage" : "Net price",
"SequenceNumber" : 2,
"RollupFlag" : false,
"Explanation" : null,
"ExplanationMessageName" : null,
"HeaderCurrencyUnitPrice" : 45,
"HeaderCurrencyExtendedAmount" : 45,
"HeaderCurrencyDurationExtendedAmount" : null,
"HeaderCurrencyCode" : "USD",
"HeaderCurrency" : "US Dollar",
"PercentOfComparisonElement" : null,
"PricingSourceId" : null,
"PricingSourceTypeCode" : null,
"PricingSourceType" : null,
"SourceMpaId" : null,
"TaxIncludedFlag" : false
} ]
} ]
} ],
"count" : 1,
"hasMore" : false,
"limit" : 25,
"offset" : 0,
"links" : [ {
"rel" : "self",
"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_charges_01/child/lines",
"name" : "lines",
"kind" : "collection"
} ]
}
Example 5 cURL Command Using FulfillLineId to Get Order Line Fulfillment Details
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AFOM_1574942498623/child/lines?q=FulfillLineId=300100187756483&expand=lineDetails&fields=lineDetails:*&onlyData=true"
Example 5 Response Body
The following shows an example of the response body in JSON format.
{
"items" : [ {
"lineDetails" : [ {
"ActualDeliveryDate" : null,
"AvailabilityShipDate" : null,
"BillOfLadingNumber" : null,
"BillingTransactionAmount" : 1320,
"BillingTransactionDate" : "2019-11-28T12:00:00+00:00",
"BillingTransactionNumber" : "123021",
"CustomerTransactionLineId" : 1538937,
"DeliveryName" : null,
"ExceptionFlag" : null,
"FulfillLineDetailId" : 300100187757277,
"Quantity" : null,
"RMAReceiptDate" : null,
"RMAReceiptLineNumber" : null,
"RMAReceiptNumber" : null,
"RMAReceiptTransactionId" : null,
"StatusCode" : "BILLED",
"Status" : "Billed",
"StatusAsOfDate" : "2019-11-28T12:28:31+00:00",
"TaskType" : "Invoice",
"TrackingNumber" : null,
"TradeComplianceCode" : null,
"TradeComplianceExplanation" : null,
"TradeComplianceResultCode" : null,
"TradeComplianceTypeCode" : null,
"TradeComplianceType" : null,
"WaybillNumber" : null
}, {
"ActualDeliveryDate" : null,
"AvailabilityShipDate" : null,
"BillOfLadingNumber" : null,
"BillingTransactionAmount" : null,
"BillingTransactionDate" : null,
"BillingTransactionNumber" : null,
"CustomerTransactionLineId" : null,
"DeliveryName" : "2369839",
"ExceptionFlag" : null,
"FulfillLineDetailId" : 300100187757133,
"Quantity" : 11,
"RMAReceiptDate" : null,
"RMAReceiptLineNumber" : null,
"RMAReceiptNumber" : null,
"RMAReceiptTransactionId" : null,
"StatusCode" : "SHIPPED",
"Status" : "Shipped",
"StatusAsOfDate" : "2019-11-28T12:23:15+00:00",
"TaskType" : "Shipment",
"TrackingNumber" : null,
"TradeComplianceCode" : null,
"TradeComplianceExplanation" : null,
"TradeComplianceResultCode" : null,
"TradeComplianceTypeCode" : null,
"TradeComplianceType" : null,
"WaybillNumber" : null
} ]
} ],
"count" : 1,
"hasMore" : false,
"limit" : 25,
"offset" : 0,
"links" : [ {
"rel" : "self",
"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AFOM_1574942498623/child/lines",
"name" : "lines",
"kind" : "collection"
} ]
}
Example 6 cURL Command to Get Order Line Data with "-" operator to Remove Fields from Response
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR:R13_Std_Item_01/child/lines?fields=-AppliedPriceListName,-DefaultTaxationCountryShortName,-CoveredProductNumber,-CoveredProductDescription,-CoveredCustomerProductId,-CoveredCustomerProductNumber,-CoveredCustomerProductDescription,-AssessableValue&onlyData=true"
Example 6 Response Body
The following shows an example of the response body in JSON format. The "-" operator before the attribute in fields helps in removing attributes from the response body, for example:
AppliedPriceListName, DefaultTaxationCountryShortName, CoveredProductNumber, CoveredProductDescription CoveredCustomerProductId, CoveredCustomerProductNumber, CoveredCustomerProductDescription, AssessableValue.
{
"items" : [ {
"HeaderId" : 300100550776157,
"LineId" : 300100550776160,
"FulfillLineId" : 300100550776159,
"SourceTransactionLineId" : "1",
"SourceTransactionLineNumber" : "1",
"SourceTransactionId" : "R13_Std_Item_01",
"SourceTransactionNumber" : "R13_Std_Item_01",
"SourceTransactionSystem" : "GPR",
"RequestingBusinessUnitId" : 204,
"RequestingBusinessUnitName" : "Vision Operations",
"AccountingRuleCode" : null,
"AccountingRule" : null,
"ActionTypeCode" : null,
"ActionType" : null,
"ActualCompletionDate" : null,
"ActualShipDate" : null,
"AppliedPriceListId" : 300100071623855,
"AssetGroupNumber" : null,
"AssetTrackedFlag" : false,
"AssetTrackingCode" : "N",
"AssetTracking" : "Not Tracked",
"BillingTransactionTypeId" : null,
"BillingTransactionTypeName" : null,
"BuyerId" : null,
"BuyerName" : null,
"BuyerFirstName" : null,
"BuyerLastName" : null,
"BuyerMiddleName" : null,
"CancelReasonCode" : null,
"CancelReason" : null,
"CanceledFlag" : false,
"CanceledQuantity" : null,
"ShippingCarrierId" : null,
"ShippingCarrier" : null,
"TransactionCategoryCode" : "ORDER",
"Comments" : null,
"ComponentIdPath" : null,
"ConfigCreationDate" : null,
"ConfigHeaderId" : null,
"ConfigInventoryItemId" : null,
"ConfigInventoryItemNumber" : null,
"ConfigInventoryItemDescription" : null,
"ConfigItemReference" : null,
"ConfigRevisionNumber" : null,
"ConfigTradeComplianceResultCode" : null,
"ConfigTradeComplianceResult" : null,
"ConfiguratorPath" : null,
"ContractEndDate" : null,
"ContractStartDate" : null,
"CreatedBy" : "SCMOPERATIONS",
"CreationDate" : "2021-08-24T19:04:45.108+00:00",
"CreditCheckAuthExpiryDate" : null,
"CreditCheckAuthorizationNumber" : null,
"CustomerProductId" : null,
"CustomerProductNumber" : null,
"CustomerProductDescription" : null,
"CustomerPOLineNumber" : null,
"CustomerPONumber" : null,
"CustomerPOScheduleNumber" : null,
"DefaultTaxationCountry" : "US",
"DemandClassCode" : null,
"DemandClass" : null,
"DestinationLocationId" : null,
"DestinationShippingOrganizationId" : null,
"DestinationShippingOrganizationCode" : null,
"DestinationShippingOrganizationName" : null,
"DocumentSubtype" : null,
"DocumentSubtypeName" : null,
"EarliestAcceptableShipDate" : null,
"EstimateFulfillmentCost" : 0,
"EstimateMargin" : 1000,
"ExemptionCertificateNumber" : null,
"ExtendedAmount" : 950,
"FinalDischargeLocationId" : null,
"FinalDischargeLocationAddressLine1" : null,
"FinalDischargeLocationAddressLine2" : null,
"FinalDischargeLocationAddressLine3" : null,
"FinalDischargeLocationAddressLine4" : null,
"FinalDischargeLocationAddressCity" : null,
"FinalDischargeLocationAddressPostalCode" : null,
"FinalDischargeLocationAddressState" : null,
"FinalDischargeLocationAddressProvince" : null,
"FinalDischargeLocationAddressCounty" : null,
"FinalDischargeLocationAddressCountry" : null,
"FirstPartyTaxRegistration" : 35647,
"FirstPartyTaxRegistrationNumber" : "4567890",
"FOBPointCode" : null,
"FOBPoint" : null,
"FreightTermsCode" : null,
"FreightTerms" : null,
"FulfillInstanceId" : 100010026240309,
"FulfillLineNumber" : "1",
"RequestedFulfillmentOrganizationId" : 204,
"RequestedFulfillmentOrganizationCode" : "V1",
"RequestedFulfillmentOrganizationName" : "Vision Operations",
"RequestedFulfillmentOrganizationAddress1" : "90 Fifth Avenue",
"RequestedFulfillmentOrganizationAddress2" : null,
"RequestedFulfillmentOrganizationAddress3" : null,
"RequestedFulfillmentOrganizationAddress4" : null,
"RequestedFulfillmentOrganizationCity" : "New York",
"RequestedFulfillmentOrganizationState" : "NY",
"RequestedFulfillmentOrganizationPostalCode" : "10022-3422",
"RequestedFulfillmentOrganizationCounty" : "New York",
"RequestedFulfillmentOrganizationProvince" : null,
"RequestedFulfillmentOrganizationCountry" : "US",
"OverFulfillmentTolerance" : 0,
"UnderFulfillmentTolerance" : 0,
"FulfilledQuantity" : null,
"SecondaryFulfilledQuantity" : null,
"FulfillmentDate" : null,
"FulfillmentMode" : null,
"FulfillmentSplitReferenceId" : null,
"GopReferenceId" : null,
"GopRequestRegion" : null,
"IntendedUseClassificationId" : null,
"IntendedUseClassificationName" : null,
"ProductId" : 2157,
"ProductNumber" : "AS92888",
"ProductDescription" : "Envoy Laptop - Rugged",
"InventoryOrganizationId" : 204,
"InventoryOrganizationCode" : "V1",
"InventoryOrganizationName" : "Vision Operations",
"InvoiceEnabledFlag" : true,
"InvoiceInterfacedFlag" : false,
"InvoiceableItemFlag" : true,
"InvoicingRuleCode" : null,
"InvoicingRule" : null,
"ItemSubTypeCode" : "STANDARD",
"ItemSubType" : "Standard",
"ItemTypeCode" : "4",
"LastUpdateDate" : "2021-08-24T19:05:35.880+00:00",
"LastUpdateLogin" : "CA342E8AE2664C71E05368BFF20AE6D3",
"LastUpdatedBy" : "SCMOPERATIONS",
"LatestAcceptableArrivalDate" : null,
"LatestAcceptableShipDate" : null,
"TransactionLineTypeCode" : "ORA_BUY",
"TransactionLineType" : "Buy",
"OnHoldFlag" : false,
"OpenFlag" : true,
"OrderedQuantity" : 5,
"SecondaryOrderedQuantity" : null,
"OrderedUOMCode" : "Ea",
"OrderedUOM" : "Each",
"SecondaryUOMCode" : null,
"SecondaryUOM" : null,
"BusinessUnitId" : 204,
"BusinessUnitName" : "Vision Operations",
"OrigSystemDocumentLineReference" : null,
"OrigSystemDocumentReference" : null,
"OriginalProductId" : null,
"OriginalProductNumber" : null,
"OriginalProductDescription" : null,
"OverrideScheduleDateFlag" : false,
"OwnerId" : null,
"PackingInstructions" : null,
"ParentFulfillLineId" : null,
"PartialShipAllowedFlag" : false,
"PaymentTermsCode" : 4,
"PaymentTerms" : "30 Net",
"POStatusCode" : null,
"PricedOn" : "2021-08-24T19:04:47.642+00:00",
"ProcessNumber" : "300100550776243",
"ProductFiscalCategoryId" : null,
"ProductFiscalCategory" : null,
"ProductCategory" : null,
"ProductCategoryName" : null,
"ProductType" : "GOODS",
"ProductTypeName" : "Goods",
"PromiseArrivalDate" : null,
"PromiseShipDate" : null,
"PurchasingEnabledFlag" : true,
"PurchasingUOMCode" : null,
"PurchasingUOM" : null,
"QuantityForEachModel" : null,
"ReceivablesOrgId" : null,
"ReceivablesOrgName" : null,
"RemnantFlag" : false,
"RequestedArrivalDate" : null,
"RequestedCancelDate" : null,
"RequestedShipDate" : "2019-10-19T20:49:12+00:00",
"RequiredFulfillmentDate" : null,
"RequisitionBusinessUnitId" : null,
"RequisitionBusinessUnitName" : null,
"RequisitionInventoryOrganizationId" : null,
"RequisitionInventoryOrganizationCode" : null,
"RequisitionInventoryOrganizationName" : null,
"ReservableFlag" : true,
"ReservationId" : null,
"ReservedQuantity" : 5,
"ReturnReasonCode" : null,
"ReturnReason" : null,
"ReturnableFlag" : true,
"RMADeliveredQuantity" : null,
"SecondaryRMADeliveredQuantity" : null,
"RootParentFulfillLineId" : null,
"SalesProductTypeCode" : null,
"SalesProductType" : null,
"SalespersonId" : null,
"Salesperson" : null,
"ScheduleArrivalDate" : "2021-08-24T23:59:59+00:00",
"ScheduleShipDate" : "2021-08-24T23:59:59+00:00",
"SchedulingReason" : null,
"SchedulingReasonCode" : null,
"ServiceDuration" : null,
"ServiceDurationPeriodCode" : null,
"ServiceDurationPeriodName" : null,
"ShippingServiceLevelCode" : null,
"ShippingServiceLevel" : null,
"ShippingModeCode" : null,
"ShippingMode" : null,
"ShipSetName" : null,
"ShipmentPriorityCode" : null,
"ShipmentPriority" : null,
"ShippableFlag" : true,
"ShippedQuantity" : null,
"SecondaryShippedQuantity" : null,
"ShippedUOMCode" : null,
"ShippedUOM" : null,
"ShippingInstructions" : null,
"ShowInSales" : null,
"SourceTransactionRevisionNumber" : 1,
"SourceTransactionScheduleId" : "1",
"SourceScheduleNumber" : "1",
"SplitFromFlineId" : null,
"StatusCode" : "AWAIT_SHIP",
"Status" : "Awaiting Shipping",
"SubinventoryCode" : null,
"Subinventory" : null,
"SubstitutionAllowedFlag" : null,
"SubstitutionReasonCode" : null,
"SubstitutionReason" : null,
"SupplierId" : null,
"SupplierName" : null,
"SupplierSiteId" : null,
"SupplierSiteName" : null,
"SupplyStatusCode" : null,
"TaxClassificationCode" : "VAT20",
"TaxClassification" : "VAT20",
"TaxExemptFlag" : false,
"TaxExemptCode" : "S",
"TaxExempt" : "Standard",
"TaxExemptReasonCode" : null,
"TaxExemptReason" : null,
"TaxInvoiceDate" : null,
"TaxInvoiceNumber" : null,
"ThirdPartyTaxRegistration" : null,
"ThirdPartyTaxRegistrationNumber" : null,
"TotalContractAmount" : null,
"TotalContractQuantity" : null,
"TradeComplianceDate" : null,
"TradeComplianceResultCode" : null,
"TradeComplianceResult" : null,
"TransportationPlannedFlag" : false,
"TransportationPlannedStatusCode" : "N",
"TransactionBusinessCategory" : "SALES_TRANSACTION",
"TransactionBusinessCategoryName" : "Sales Transaction",
"UnitListPrice" : 200,
"UnitQuantity" : null,
"UnitSellingPrice" : 190,
"UserDefinedFiscalClass" : null,
"UserDefinedFiscalClassName" : null,
"ValidConfigurationFlag" : null,
"LineNumber" : 1,
"DisplayLineNumber" : "1",
"ParentSourceTransactionLineId" : null,
"TransformFromLineId" : null,
"UnreferencedReturnFlag" : false,
"ServiceCancelDate" : null,
"CoveredProductId" : null,
"JeopardyPriorityCode" : "HIGH",
"JeopardyPriority" : "High",
"AgreementHeaderId" : null,
"AgreementLineId" : null,
"AgreementLineNumber" : null,
"AgreementVersionNumber" : null,
"AgreementNumber" : null,
"SellingProfitCenterBusinessUnitId" : 204,
"SellingProfitCenterBusinessUnitName" : "Vision Operations",
"TransportationPlanningOrder" : null,
"ContractEndDateTime" : null,
"ContractStartDateTime" : null,
"SubscriptionProfileId" : null,
"SubscriptionProfileName" : null,
"ExternalPriceBookName" : null,
"EndReasonCode" : null,
"EndReason" : null,
"EndCreditMethodCode" : null,
"EndCreditMethod" : null,
"EndDate" : null,
"InventoryTransactionFlag" : false,
"InventoryInterfacedFlag" : false,
"PriceUsingSecondaryUOMFlag" : null,
"SubscriptionInterfacedFlag" : false,
"RatePlanDocumentId" : null,
"SupplierAddress1" : null,
"SupplierAddress2" : null,
"SupplierAddress3" : null,
"SupplierAddress4" : null,
"SupplierCity" : null,
"SupplierState" : null,
"SupplierPostalCode" : null,
"SupplierProvince" : null,
"SupplierCounty" : null,
"SupplierCountry" : null
} ],
"count" : 1,
"hasMore" : false,
"limit" : 25,
"offset" : 0,
"links" : [ {
"rel" : "self",
"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Std_Item_01/child/lines",
"name" : "lines",
"kind" : "collection"
} ]
}
Example 7 cURL Command to Get an Order Line from the Latest Version of an Order
Use the following cURL command to submit a request on the REST resource. When a draft exists, URL then order line from the draft order is returned.
curl -u username:password "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Std_Item_01/child/lines/00020000000EACED00057708000110F09BA47C680000000EACED00057708000110F09BA47C69"
In this example, SourceTransactionId R13_Std_Item_01 has gone through multiple revisions. Using this URL you can access a specific order line from the latest version of the order and can make changes to it.
Example 7 Response Body
{
"HeaderId" : 300100566154342,
"LineId" : 300100566154345,
"FulfillLineId" : 300100566154344,
"SourceTransactionLineId" : "1",
"SourceTransactionLineNumber" : "1",
"SourceTransactionId" : "R13_Std_Item_01",
"SourceTransactionNumber" : "R13_Std_Item_01",
"SourceTransactionSystem" : "GPR",
"RequestingBusinessUnitId" : 204,
"RequestingBusinessUnitName" : "Vision Operations",
...
"OrderedQuantity" : 10,
...
"links" : [ {
"rel" : "self",
"href" : "https://server/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Std_Item_01/child/lines/00020000000EACED00057708000110F09BA47C680000000EACED00057708000110F09BA47C69",
"name" : "lines",
"kind" : "item",
"properties" : {
"changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000E7371007E00020000000578"
}
}, ... {
"rel" : "child",
"href" : "https://server/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Std_Item_01/child/lines/00020000000EACED00057708000110F09BA47C680000000EACED00057708000110F09BA47C69/child/transactionItemAttributes",
"name" : "transactionItemAttributes",
"kind" : "collection"
} ]
}
Example 8 cURL Command to Get an Order Line from a Specific HeaderId, Whether Older or Latest Version of the Order
Use the following cURL command to get an order line belonging to an order with a specific HeaderId.
This is useful when the order has multiple revisions because it helps in accessing the older or the latest version of the order. Create, update, and delete operations are not allowed on older versions of the order. Updates are allowed if the HeaderId belongs to the latest version of the order.
curl -u username:password "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/100100804812005/child/lines/00020000000EACED0005770800005B0A88E99CE70000000EACED0005770800005B0A88E99CE6"
In this example, SourceTransactionId R13_Std_Item_01 has gone through multiple revisions. Using the HeaderId of the specific version of the order in the URL you can access specific order line data that belongs to that version of the order.
Example 8 Response Body
{
"HeaderId" : 100100804812005,
"LineId" : 100100804812006,
"FulfillLineId" : 100100804812007,
"SourceTransactionLineId" : "1",
"SourceTransactionLineNumber" : "1",
"SourceTransactionId" : "R13_Std_Item_01",
"SourceTransactionNumber" : "R13_Std_Item_01",
"SourceTransactionSystem" : "GPR",
"RequestingBusinessUnitId" : 204,
"RequestingBusinessUnitName" : "Vision Operations",
...
"OrderedQuantity" : 5,
...
"links" : [ {
"rel" : "self",
"href" : "https://server/fscmRestApi/resources/version/salesOrdersForOrderHub/100100804812005/child/lines/00020000000EACED0005770800005B0A88E99CE70000000EACED0005770800005B0A88E99CE6",
"name" : "lines",
"kind" : "item",
"properties" : {
"changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000017371007E00020000000178"
}
}, ...{
"rel" : "child",
"href" : "https://server/fscmRestApi/resources/version/salesOrdersForOrderHub/100100804812005/child/lines/00020000000EACED0005770800005B0A88E99CE70000000EACED0005770800005B0A88E99CE6/child/transactionItemAttributes",
"name" : "transactionItemAttributes",
"kind" : "collection"
} ]
}