Attributes That You Can Use with Web Services

Get details about the attributes you can include in the request payload when you use the Receive Order Request web service.

Learn more about the objects and operations that you can use. Go to SOAP Web Services for Oracle SCM, then expand the table of contents to get details about the service you need.

  • Business Objects Services > Import Sales Orders. Get details about the attributes you must include in the order header and other child entities when you use the Order Import service.

  • Business Objects Services > Order Fulfillment Response Service

  • Business Objects Services > Order Information Service

  • Business Objects Services > Order Information Service

Attributes for the Order Header

Required Attributes You Must Include in Your Payload

Attribute

Type

Description

BuyingPartyId

Number

Value that identifies the person, company, or organization that placed the source order, sometimes known as the Sold To Customer.

RequestingBusinessUnitIdentifier

Number

Value that identifies the organization that sold the source order.

SourceTransactionIdentifier

VARCHAR2

Value that uniquely identifies the transaction.

SourceTransactionNumber

VARCHAR2

Transaction number that the source system uses.

SourceTransactionRevisionNumber

VARCHAR2

Revision number of the transaction.

SourceTransactionSystem

VARCHAR2

Source system that placed the request for fulfillment.

TransactionalCurrencyCode

VARCHAR2

Currency code for pricing the transaction.

TransactionOn

Timestamp

Date and time that the transaction started. This value identifies the date that the customer committed to purchase the items that this source order contains. Order Management uses this date to measure the time required to fulfill the sales order.

Optional Attributes

Attribute

Type

Description

BillToAccountContactIdentifier

VARCHAR2

Value that identifies the contact for the billing address.

BillToAccountContactName

VARCHAR2

Contact name for the billing address.

BillToAccountContactNumber

VARCHAR2

Contact number for the billing address.

BillToAccountContactOrigSystemReference

VARCHAR2

Cross-reference value of the account contact.

BillToAddress1

VARCHAR2

Address Line 1 of the party that's legally responsible for payment.

BillToAddress2

VARCHAR2

Address Line 2 of the party that's legally responsible for payment.

BillToAddress3

VARCHAR2

Address Line 3 of the party that's legally responsible for payment.

BillToAddress4

VARCHAR2

Address Line 4 of the party that's legally responsible for payment.

BillToAddressOrigSystemReference

VARCHAR2

Cross-reference value for the account site.

BillToCity

VARCHAR2

City of the party that's legally responsible for payment.

BillToCounty

VARCHAR2

County of the party that's legally responsible for payment.

BillToCustomerIdentifier

VARCHAR2

Value that identifies the party that's legally responsible for payment.

BillToPartyName

VARCHAR2

Name of the party that's legally responsible for payment.

BillToPartyNumber

VARCHAR2

Number of the party that's legally responsible for payment.

BillToPartySiteIdentifier

VARCHAR2

Value that identifies the party that's legally responsible for payment.

BillToPostalCode

VARCHAR2

Postal Code of the party that's legally responsible for payment.

BillToProvince

VARCHAR2

Province of the party that's legally responsible for payment.

BillToState

VARCHAR2

State of the party that's legally responsible for payment.

BuyingPartyContactId

Number

Value that identifies the person who placed the source order or whose the primary contact for the source order.

BuyingPartyContactName

VARCHAR2

Name of the person who placed the source order or whose the primary contact for the source order.

BuyingPartyContactNumber

VARCHAR2

Contact number for the person who placed the source order or whose the primary contact for the source order.

BuyingPartyContactOrigSystemReference

VARCHAR2

Cross-reference value of the person who placed the source order or whose the primary contact for the source order. The customer master in TCA maintains this value.

BuyingPartyName

VARCHAR2

Name of the person, company, or organization that placed the source order, also known as the Sold To Customer.

BuyingPartyNumber

VARCHAR2

Person, company, or organization number that placed the source order, also known as the Sold To Customer.

BuyingPartyOrigSystemReference

VARCHAR2

Cross reference value for the person, company, or organization number that placed the source order. The customer master in the TCA maintains this value.

CancelReason

VARCHAR2

Reason for the cancel.

CancelReasonCode

VARCHAR2

Brief text that identifies the cancel reason.

Comments

VARCHAR2

Text that describes the transaction.

CurrencyConversionDate

Date

Currency conversion date.

CurrencyConversionRate

Number

The exchange rate that Order Management must use if it converts the value from one currency to another currency.

CurrencyConversionType

VARCHAR2

Conversion type for foreign currency.

CustomerPONumber

VARCHAR2

The purchase order number that the customer sends to identify the source order.

FreezePriceFlag

VARCHAR2

Set to true or false.

  • true. The source system prices the sales order, prices are frozen so Oracle Pricing won't price it, and you must provide data for charges and charge components in the import payload.

  • false. Prices aren't frozen, Oracle Pricing will price it, and you don't need to provide values for charges and charge components in the import payload.

FreezeShippingChargeFlag

VARCHAR2

Set to true or false.

  • true. The source system calculates shipping charges for the sales order, and prices are frozen so Oracle Pricing won't calculate shipping charges.

  • false. Shipping charges aren't frozen and Oracle Pricing will calculate them.

FreezeTaxFlag

VARCHAR2

Set to true or false.

  • true. The source system calculates tax charges for the sales order, and prices are frozen so Oracle Pricing won't calculate tax charges.

  • false. Tax charges aren't frozen and Oracle Pricing will calculate them.

OperationMode

VARCHAR2

A value of CANCEL for this attribute indicates to cancel the sales order. You can use only CANCEL.

OrigSysDocumentReference

VARCHAR2

Document number from the source system.

PartialShipAllowedFlag

VARCHAR2

Specify how to ship the items that the source order contains.

  • true. Ship items in more than one shipment, if necessary.

  • false. Ship all items in a single shipment.

PricedOn

Date

The date when the document is priced. Order Management populates this attribute with the system date at the beginning of a pricing process.

RequestCancelDate

Date

Time and day when you requested the cancel.

RequestingLegalUnit

VARCHAR2

Name of the legal entity that formed a contract with the customer.

RequestingLegalUnitIdentifier

Number

Value that identifies the legal entity that formed a contract with the customer.

ShipToAddress1

VARCHAR2

Address Line 1 of the ship-to destination.

ShipToAddress2

VARCHAR2

Address Line 2 of the ship-to destination.

ShipToAddress3

VARCHAR2

Address Line 3 of the ship-to destination.

ShipToAddress4

VARCHAR2

Address Line 4 of the ship-to destination.

ShipToAddressOrigSystemReference

VARCHAR2

Cross-reference value of the address for the ship-to destination.

ShipToCity

VARCHAR2

City of the ship-to destination.

ShipToContactPartyIdentifier

VARCHAR2

Value that identifies the contact for the shipping address.

ShipToContactPartyName

VARCHAR2

Contact name for the shipping address.

ShipToContactPartyNumber

VARCHAR2

Contact number for the shipping address.

ShipToContactPartyOrigSystemReference

VARCHAR2

Cross-reference value of the party contact.

ShipToCounty

VARCHAR2

County of the ship-to destination.

ShipToPartyIdentifier

VARCHAR2

Value that identifies the party that must receive the goods.

ShipToPartyName

VARCHAR2

Name of the party that must receive the goods.

ShipToPartyNumber

VARCHAR2

Number that identifies the party that must receive the goods.

ShipToPartySiteIdentifier

VARCHAR2

Value that identifies the party site of the ship-to destination, such as 1036.

ShipToPostalCode

VARCHAR2

Postal code of the ship-to destination.

ShipToProvince

VARCHAR2

Province of the ship-to destination.

ShipToState

VARCHAR2

State of the ship-to destination.

TransactionalCurrencyName

VARCHAR2

Currency name that Order Management must use to price the transaction.

TransactionDocumentTypeCode

VARCHAR2

Specify the type of request.

  • Sales order

  • Purchase order

  • Internal material transfer

Attributes for Order Lines

Required Attributes

Attribute

Type

Description

OrderedQuantity

Number

Quantity of the item that the source system requested.

OrderedUOMCode

VARCHAR2

Code for the unit of measure that the source system requested, such as Unit or Kg.

ProductIdentifier

Number

Value that uniquely identifies the item that Order Management processes to fulfill the sales order.

SourceTransactionIdentifier

VARCHAR2

Value that uniquely identifies the transaction.

SourceTransactionLineIdentifier

VARCHAR2

Value that uniquely identifies the transaction line.

SourceTransactionLineNumber

VARCHAR2

Line number of the transaction line. Order Management uses this value to sort transaction lines.

SourceTransactionNumber

VARCHAR2

Transaction number that resides in the source system.

SourceTransactionRevisionNumber

VARCHAR2

Revision number of the transaction.

SourceTransactionScheduleIdentifier

VARCHAR2

Value that uniquely identifies the source transaction schedule number.

SourceTransactionScheduleNumber

VARCHAR2

Line number of a schedule line, shipment line, or subline. The source system assigned this value when it captured the source order in the source system.

SourceTransactionSystem

VARCHAR2

Name of the source system that placed the request for fulfillment.

Optional Attributes

Attribute

Type

Description

AccountingRule

VARCHAR2

Name of the accounting rule that determines the accounting period to use when recording the revenue distribution for an invoice line.

AccountingRulecode

VARCHAR2

Brief text that identifies that identifies the accounting rule.

AssessableValue

Number

Price that a tax authority uses to value an item.

BillToAccountContactIdentifier

VARCHAR2

Value that identifies the bill-to account contact.

BillToAccountContactName

VARCHAR2

Name of the contact who resides at the billing address.

BillToAccountContactNumber

VARCHAR2

Number for the contact who resides at the billing address.

BillToAccountContactOrigSystemReference

VARCHAR2

Cross-reference value for the account contact.

BillToAccountSiteUseIdentifier

VARCHAR2

Value that identifies the party site whose legally responsible for payment.

BillToAddress1

VARCHAR2

Address Line 1 of the party whose responsible for payment.

BillToAddress2

VARCHAR2

Address Line 2 of the party whose responsible for payment.

BillToAddress3

VARCHAR2

Address Line 3 of the party whose responsible for payment.

BillToAddress4

VARCHAR2

Address Line 4 of the party whose responsible for payment.

BillToAddressOrigSystemReference

VARCHAR2

Cross-reference value for the account site.

BillToCity

VARCHAR2

City of the party whose responsible for payment.

BillToCounty

VARCHAR2

County of the party whose responsible for payment.

BillToCustomerIdentifier

VARCHAR2

Value that identifies the bill-to customer.

BillToCustomerName

VARCHAR2

Name of the party whose legally responsible for payment.

BillToCustomerNumber

VARCHAR2

Number of the party whose legally responsible for payment.

BillToPostalCode

VARCHAR2

Postal code of the party whose responsible for payment.

BillToProvince

VARCHAR2

Province of the party whose responsible for payment.

BillToState

VARCHAR2

State of the party whose responsible for payment.

BusinessUnitIdentifier

Number

Value that identifies the business unit.

BusinessUnitName

VARCHAR2

Name of the organization that fulfills the sales order.

CancelReason

VARCHAR2

Reason for the cancel request.

CancelReasonCode

VARCHAR2

Brief text that identifies the cancel reason.

Comments

VARCHAR2

Text that you can use to add details that are related to the order line.

ComponentIdPath

VARCHAR2

Path to the inventory item identifier for the parent of this line. The configurator populates and uses this attribute.

ConfigHeaderId

Number

Header Id of the configuration. The configurator populates and uses this attribute.

ConfigRevisionNumber

Number

Revision number of the configuration. The configurator populates and uses this attribute.

ConfiguratorPath

VARCHAR2

Runtime representation of the path to the Inventory Item Id for the component. The configurator populates and uses this attribute.

CreditChkAuthExpDate VARCHAR2 Date when the credit authorization expires.
CreditChkAuthNumber NUMBER Value that uniquely identifies the authorization that Credit Management creates for the requested amount for the customer. Use CreditChkAuthNumber only if the Credit Check attribute contains Authorization or Reauthorization.

CustomerPOLineNumber

VARCHAR2

Line number from the purchase order that the buying party provides.

CustomerPONumber

VARCHAR2

Purchase order number that the buying party provides.

CustomerPOScheduleNumber

VARCHAR2

Schedule number from the purchase order that the buying party provides.

CustomerProductDescription

VARCHAR2

Description of an item.

CustomerProductidentifier

Number

Value that identifies the customer item number.

CustomerProductNumber

VARCHAR2

Number that identifies the item that the customer ordered. This number resides in the customer item table.

DefaultTaxationCountry

VARCHAR2

Name of the country that Order Management uses to calculate tax.

DemandClass

VARCHAR2

Name of the demand class. A demand class can represent.

  • A group of customers, such as government customers or commercial customers

  • Sales channels

  • Regions

  • Different sources of demand, such as retail, mail order, or wholesale

DemandClassCode

VARCHAR2

Brief text that identifies the demand class.

DestinationShippingLocationIdentifier

Number

Value that identifies the shipment destination.

DestinationShipppingOrganizationIdentifier

Number

Value that identifies the organization that receives the shipment.

DocumentSubType

VARCHAR2

Name of the subtype that Order Management uses to calculate tax and tax reporting, depending on the requirements of different countries.

EarliestAcceptableArrivalDate

Date

Don't use this attribute.

EarliestAcceptableShipDate

Date

Date that specifies the earliest time that the customer is willing to ship the sales order.

ExtendedAmount

Number

Monetary value for the fulfill line quantity.

ExtendedQuantity

Number

Total quantity for a configured item. This value is a sum of the requested quantity of the components that a configured item contains. The configurator populates and uses this attribute.

FinalDischargeLocationIdentifier

Number

Final destination location for the purchases that the customer makes.

FirstpartyTaxRegistration

Number

Registration number that Order Management sends to the supplier. The supplier uses this number to tax the transaction.

FOBPoint

VARCHAR2

Location where the seller is willing to pay for transportation of the goods to the port of shipment, plus loading costs.

FOBPointcode

VARCHAR2

Brief text that identifies the FOB point.

FreightTerms

VARCHAR2

Terms for paying freight charges, such as paid by shipper, collect, prepaid, and so on.

FreightTermsCode

VARCHAR2

Brief text that identifies the freight terms.

FulfillmentLineIdentifier

Number

Value that uniquely identifies a fulfillment line. Order Management can use this value to identify the fulfillment line that its referencing in the context of the change.

IntendedUseClassificationIdentifier

Number

Identifies the intended use. For tax purposes.

InventoryOrganization

VARCHAR2

Name of the inventory organization that owns the item.

InventoryOrganizationIdentifier

Number

Value that identifies the inventory organization identifier.

InvoicingRule

VARCHAR2

Name of the invoicing rule that determines when to recognize the receivable so that Order Management can invoice it.

InvoicingRuleCode

VARCHAR2

Value that identifies the invoicing rule.

IsValidConfiguration

VARCHAR2

Specify whether configuration is valid.

  • true. Configuration is valid.

  • false. Configuration isn't valid. The configurator expects that an application that calls the configurator won't submit the sales order.

The web service populates this attribute only for the root order line. The configurator populates and uses this attribute.

LatestAcceptableArrivalDate

Date

Date that specifies the latest time that the customer is willing to receive the sales order at the ship-to address.

LatestAcceptableShipDate

Date

Date that specifies the latest time that the customer is willing to ship the sales order.

OperationMode

VARCHAR2

A value of CANCEL for this attribute indicates to cancel the order line. You can use only CANCEL.

OrderedUOM

VARCHAR2

Unit of measure of the requested item, such as Unit or Kgs.

OriginalProductDescription

VARCHAR2

SKU (stock keeping unit) that identifies the item that Order Management fulfills.

OriginalProductIdentifier

VARCHAR2

Value that identifies the item that the customer requested or ordered. Order Management subsequently substituted this item with some other item.

OriginalProductNumber

VARCHAR2

Display name of the item that Order Management fulfills.

OverrideScheduleDateFlag VARCHAR2 Set it to TRUE or FALSE. TRUE: you can manually override the schedule date that Global Order Promising calculates when it promises the item. FALSE: you can't do this.

PackingInstructions

VARCHAR2

Comment text for packing instructions.

ParentLineReference

VARCHAR2

Value that identifies the line that's the parent of this line in a configured item, or in any other parent and child relationship.

PartialShipAllowedFlag

VARCHAR2

Specify whether Order Management ships the items that the sales order contains in more than one shipment.

  • true. Ship in more than one shipment, if necessary.

  • false. Ship in one shipment.

PaymentTerm

VARCHAR2

The payment terms to use for this payment.

PaymentTermCode

VARCHAR2

Brief text that identifies the payment term.

ProductCategory

VARCHAR2

Classifies the item for tax purposes. If your deployment doesn't use Oracle Inventory to classify an item for tax purposes, then Order Management uses the product category.

ProductDescription

VARCHAR2

Display name of the item.

ProductFiscalCategoryIdentifier

Number

Fiscal category that the tax authority uses to tax the item.

ProductNumber

VARCHAR2

SKU (stock keeping unit) that identifies the item to fulfill.

ProductType

VARCHAR2

Specify the type of transaction line.

  • Goods

  • Services

PromiseArrivalDate

Date

Date that the fulfillment process promised to the customer that the item would arrive at the ship-to address.

PromiseShipDate

Date

Date that the fulfillment process promised to the customer that the item would ship.

RequestCancelDate

Date

Date when the customer requested to cancel the source order.

RequestedArrivalDate

Date

Date that the customer specified to deliver the goods.

RequestedFulfillmentOrganizationCode

VARCHAR2

Code that identifies the requested fulfillment organization.

RequestedFulfillmentOrganizationIdentifier

Number

Value that identifies the requested fulfillment organization.

RequestedFulfillmentOrganizationName

VARCHAR2

Name of the organization that shipped the sales order.

RequestedShipDate

Date

Date that the customer specified to ship the goods.

RequestedSupplierCode

VARCHAR2

Brief text that identifies the supplier name.

RequestedSupplierName

VARCHAR2

Name of the supplier whose responsible for shipping the item. You can specify a supplier according to a contractual obligation in a drop ship flow.

RequestedSupplierNumber

VARCHAR2

Number that identifies the supplier whose responsible for shipping the item. You can specify a supplier according to a contractual obligation in a drop ship flow.

RequestedSupplierSiteCode

VARCHAR2

Brief text that identifies the requested supplier site.

RequestingBusinessUnitIdentifier

Number

Value that identifies the requesting business unit.

RequestingBusinessUnitName

VARCHAR2

Internal organization that started or captured the transaction.

ReturnReason

VARCHAR2

Reason why the customer must return the item.

ReturnReasonCode

VARCHAR2

Brief text that identifies the return reason.

RootParentLineReference

VARCHAR2

Value that identifies the line that resides at the root of the configured item' hierarchy.

ScheduleArrivalDate

Date

Date that Order Management scheduled to deliver the goods.

ScheduleShipDate

Date

Date that Order Management scheduled to ship the goods.

ShipmentPriority

VARCHAR2

Priority that specifies the urgency to use when shipping the item.

ShipmentPriorityCode

VARCHAR2

Brief text that identifies the shipment priority.

ShippingCarrier

VARCHAR2

Name of the carrier who delivered the goods.

ShippingCarrierCode

VARCHAR2

Brief text that identifies the shipping carrier.

ShippingInstructions

VARCHAR2

Comment text for shipping instructions.

ShippingMode

VARCHAR2

Mode that Order Management used to deliver the shipment.

ShippingModeCode

VARCHAR2

Brief text that identifies the shipping mode.

ShippingServiceLevel

VARCHAR2

Level of service to use when delivering the item.

ShippingServiceLevelCode

VARCHAR2

Brief text that identifies the shipping service level.

ShipSetName

VARCHAR2

Name of the shipment set.

ShipToAddress1

VARCHAR2

Address Line 1 of the ship-to party.

ShipToAddress2

VARCHAR2

Address Line 2 of the ship-to party.

ShipToAddress3

VARCHAR2

Address Line 3 of the ship-to party.

ShipToAddress4

VARCHAR2

Address Line 4 of the ship-to party.

ShipToAddressOrigSystemReference

VARCHAR2

Cross-reference value for the party site.

ShipToCity

VARCHAR2

City of the ship-to party.

ShipToContactPartyIdentifier

VARCHAR2

Value that identifies the shipping address of the ship-to contact.

ShipToContactPartyName

VARCHAR2

Name of the contact who resides at the shipping address.

ShipToContactPartyNumber

VARCHAR2

Number of the contact for the shipping address.

ShipToContactPartyOrigSystemReference

VARCHAR2

Cross-reference value for the party contact.

ShipToCounty

VARCHAR2

County of the ship-to party.

ShipToPartyIdentifier

VARCHAR2

Value that identifies the ship-to party name.

ShipToPartyName

VARCHAR2

Name of the party that receives the goods.

ShipToPartyNumber

VARCHAR2

Number that identifies the party that receives the goods.

ShipToPartySiteIdentifier

VARCHAR2

Value that identifies the party site that receives the goods, such as 1036.

ShipToPostalCode

VARCHAR2

Postal Code of the ship-to party.

ShipToProvince

VARCHAR2

Province of the ship-to party.

ShipToRequestRegion

VARCHAR2

Identifies the region of the ship-to request. Global Order Promising uses this attribute to process a sales order according to region.

ShipToState

VARCHAR2

State of the ship-to party.

SourceSystemProductReference

VARCHAR2

Cross-reference value of the item.

Subinventory

VARCHAR2

Subinventory.

You can update this attribute through a web service but not in the Order Management work area. Order Management doesn't use it during processing but does send it to Oracle Shipping. Global Order Promising doesn't consider it during scheduling. Order Management doesn't send it to Oracle Inventory Management for reservations.

SubInventoryCode

VARCHAR2

Brief text that identifies the subInventory.

SubstitutionAllowedFlag

VARCHAR2

Specify whether Order Management substitutes items during fulfillment.

  • true. Substitute items.

  • false. Don't substitute.

SubstitutionReason

VARCHAR2

Reason for the substitution.

SubstitutionReasonCode

VARCHAR2

Brief text that identifies the substitution reason.

SupplierAddressCity

VARCHAR2

City of the organization that supplies and ships the items.

SupplierAddressCountry

VARCHAR2

Country of the organization that supplies and ships the items.

SupplierAddressCounty

VARCHAR2

County of the organization that supplies and ships the items.

SupplierAddressLine1

VARCHAR2

Address Line 1of the organization that supplies and ships the items.

SupplierAddressLine2

VARCHAR2

Address Line 2 of the organization that supplies and ships the items.

SupplierAddressLine3

VARCHAR2

Address Line 3 of the organization that supplies and ships the items.

SupplierAddressLine4

VARCHAR2

Address Line 4 of the organization that supplies and ships the items.

SupplierAddressPostalCode

VARCHAR2

Postal code of the organization that supplies and ships the items.

SupplierAddressProvince

VARCHAR2

Province of the organization that supplies and ships the items.

SupplierAddressState

VARCHAR2

State of the organization that supplies and ships the items.

TaxClassificationCode

VARCHAR2

Brief text that identifies the tax classification.

TaxExemptFlag

VARCHAR2

Specify whether to exempt the transaction from taxation.

  • true. Exempt from taxation.

  • false. Don't exempt.

TaxExemptionCertificateNumber

VARCHAR2

Number that identifies the tax exemption certificate that a taxing authority grants for a customer whose tax exempt.

TaxExemptReason

VARCHAR2

The reason to grant and take a tax exemption.

TaxExemptReasonCode

VARCHAR2

Brief text that identifies the tax exempt reason.

ThirdpartyTaxRegistration

Number

Registration number that the customer specifies in the purchase order.

TransactionBusinessCategory

VARCHAR2

Category of a transaction that a tax authority might require. For tax purposes.

TransactionCategoryCode

VARCHAR2

Brief text that identifies the transaction category.

  • ORDER. Process a new source order.

  • RETURN. Process a return of an existing sales order.

TransactionLineType

VARCHAR2

Type of line or action that resides in the source system. Some example values include Buy, Replace with, Return For Credit, Upgrade, and so on.

TransactionLineTypeCode

VARCHAR2

Code that identifies the transaction line type.

UnitListPrice

Number

List price of the item prior to any discounts and adjustments.

UnitSellingPrice

Number

Selling price of the item with discounts and adjustments applied.

UserDefinedFiscClass

VARCHAR2

Classification of the transaction into different categories for tax purposes.

Other Attributes

Attribute

Description

Fulfillment Line Standardized Value

Equals the Ordered Quantity multiplied by the Unit Selling Price multiplied by the Unit Currency Conversion Rate.

Fulfillment Line Transactional Value

Equals the Ordered Quantity multiplied by the Unit Selling Price.

Attributes for Order Preferences

Attribute

Type

Description

CreateCustomerInformationFlag

VARCHAR2

Specify whether to create details for missing attributes.

  • true. Create the missing attribute. For example, if the Sold-to attribute and the Ship-to attribute are each missing, then create a Sold-to attribute and a Ship-to attribute.

  • false. Don't create the missing attribute.

Other Optional Attributes You Can Include in the Request Payload

Source Transaction Details

You can include these optional attributes in the request payload for the source transaction.

Attribute

Type

Description

SourceTransactionIdentifier

VARCHAR2

Value that uniquely identifies the transaction.

SourceTransactionLineIdentifier

VARCHAR2

Value that uniquely identifies the transaction line.

SourceTransactionNumber

VARCHAR2

Transaction number.

SourceTransactionRevisionNumber

VARCHAR2

Revision number of the transaction.

SourceTransactionScheduleIdentifier

VARCHAR2

Value that uniquely identifies the transaction for a schedule, shipment, or subline. The source system assigns this value.

SourceTransactionSystem

VARCHAR2

Name of the source system that placed the request for fulfillment.

SubmitFlag

VARCHAR2

  • true. Submit the sales order to fulfillment after you import it. Use true when you don't need to modify the order after you import it into Order Management and instead want to submit it directly to fulfillment. The default value is true. If you don't send any value for SubmitFlag, then we assume it's true.If true, and if the import fails during submit, then we don't submit the sales order but instead save it in Draft status. If you're importing a sales order revision, then you must use true.
  • false. Create a draft of the sales order that you're importing but don't submit it. Use false when you need to modify the order in Order Management after you import and before you submit it to fulfillment. You can use the SubmitDraftOrder operation in a subsequent import to submit the draft order to fulfillment. Use false only for a new sales order. Don't use false when you revise a sales order.

You typically include these attributes when you specify one of these objects.

  • Lot Numbers and serial numbers

  • Sales credits

  • Payments

  • Attachments

  • Document references

  • Transaction items

  • Charges

  • Charge components

Lot Numbers and Serial Numbers

You can include these optional attributes in the request payload to define lot numbers and serial numbers.

Attribute

Type

Description

ItemRevisionNumber

VARCHAR2

Number that identifies the revision.

LocatorIdentifier

Number

Value that identifies the locator where Order Management ships the item from or received into.

LotNumber

VARCHAR2

Number assigned to a quantity of items for identification purposes. A lot number is an identification number that a manufacturer assigns to a quantity of material, typically for quality control. Some manufacturers combine the lot number with the serial number to form an identification number.

SerialNumberFrom

VARCHAR2

Starting serial number of a range of serial numbers.

SerialNumberTo

VARCHAR2

Ending serial number of a range of serial numbers.

SourceTransactionLotIdentifier

VARCHAR2

Value that uniquely identifies the lot. The source system assigns this value.

Sales Credits

You can include these optional attributes in the request payload to define sales credits.

Attribute

Type

Description

Percent

Number

Number that specifies the sales credit percentage for a salesperson.

SalesCreditTypeCode

VARCHAR2

Brief text that identifies the sales credit type.

SalesCreditTypeReference

VARCHAR2

Foreign key that references the sales credit type. This type is Revenue or Non Revenue.

SalesPersonIdentifier

Number

Value that uniquely identifies the salesperson. The source system assigns this value.

SourceTransactionSalesCreditIdentifier

VARCHAR2

Value that uniquely identifies the sales credit. The source system assigns this value.

Payments

You can include these optional attributes in the request payload to define payments.

Attribute

Type

Description

PaymentMethod

VARCHAR2

Payment method that's associated with the payment instrument for the customer account.

PaymentMethodCode

VARCHAR2

Brief text that identifies the payment method.

PaymentSetIdentifier

Number

Value that uniquely identifies a group of payments that belong to one prepaid order. If the set identifies a prepayment, then the foreign key references billing.

PaymentTransactionIdentifier

Number

Value that identifies the payment details. The source system contains this value.

SourceTransactionPaymentIdentifier

VARCHAR2

Value that uniquely identifies the internal payment. The source system assigns this value.

Attachments

You can include these optional attributes in the request payload to define attachments.

Attribute

Type

Description

Data

BlobDomain

Data that the attachment contains.

DataTypeCode

VARCHAR2

Type of attachment.

Description

VARCHAR2

Description of the attachment.

FileContent

VARCHAR2

Mime type for BLOB (Binary Large OBject) attachment.

FileName

VARCHAR2

File name of the attached document. If the attachment is a URL, then Order Management doesn't use this attribute.

Title

VARCHAR2

Title of the document.

URL

VARCHAR2

URL.

Document References

You can include these optional attributes in the request payload to define document references. The web service currently accepts only the original sales order or order line reference when creating a return line for the document reference entity.

Attribute

Type

Description

DocumentAdditionalIdentifier

VARCHAR2

Value that identifies more qualifiers for the ID. Used when multipart keys are present.

DocumentAdditionalLineIdentifier

VARCHAR2

Value that identifies more qualifiers for the document line. Used when multipart keys are present.

DocumentAdditionalLineNumber

VARCHAR2

Number that identifies the document line. You can use it as another way to identify the object instance. You can use it to capture more identifying details, as necessary.

DocumentAdditionalNumber

VARCHAR2

Number that identifies the document. You can use it as another way to identify the object instance. You can use it to capture more identifying details, as necessary.

DocumentAdditionalSubLineIdentifier

VARCHAR2

Value that identifies more qualifiers for the subline. Used when multipart keys are present.

DocumentAdditionalSubLineNumber

VARCHAR2

Number that identifies the document subline. You can use it as another way to identify the object instance. You can use it to capture more identifying details, as necessary.

DocumentIdentifier

VARCHAR2

Value that uniquely identifies the document.

DocumentLineIdentifier

VARCHAR2

Value that uniquely identifies the document line. Order Management creates this value.

DocumentLineNumber

VARCHAR2

User-friendly number that identifies the document line, such as the line number in a sales order, or the line number in a purchase order.

DocumentNumber

VARCHAR2

User-friendly number that identifies the document, such as asset number, sales order number, or purchase order number.

DocumentReferenceType

VARCHAR2

Type of business document or object that the source order references, such as asset, sales order, or purchase order.

DocumentSubLineIdentifier

VARCHAR2

Value that uniquely identifies the document subline. Order Management creates this value.

DocumentSubLineNumber

VARCHAR2

User-friendly number that identifies the subline.

Transaction Items

You can include these optional attributes in the request payload to define transaction items.

Attribute

Type

Description

CharacterValue

VARCHAR2

Item attribute value of type character.

DateValue

Date

Item attribute value of type date.

NumberValue

Number

Item attribute value of type number.

TimestampValue

Timestamp

Item attribute value of type time.

TransactionAttributeName

VARCHAR2

Item attribute name.

Charges

You can include these optional attributes in the request payload to define charges.

Attribute

Type

Description

ApplyTo

long

Specify whether to apply a charge to the item, shipping, or return.

BatchIdentifier

Number

Number that identifies the batch.

ChargeDefinition

VARCHAR2

Value for the charge definition entity. A charge definition defines the price type, charge type, and the charge subtype. Order Management typically denormalizes these objects on this entity.

ChargeDefinitionCode

VARCHAR2

Brief text that identifies the charge definition.

ChargeSubType

VARCHAR2

Type of charge, defined for this configuration to aggregate totals.

  • Goods sale

  • Service sale

  • Financing compared to lease

  • Shipping charges

  • Restocking penalties

  • Special charges

The Pricing Engine returns the charge value for each line.

ChargeSubtypeCode

VARCHAR2

Brief text that identifies the charge subtype.

ParentEntityCode

VARCHAR2

Parent entity of the charge.

  • Line

  • Line Coverage

ParentEntityId

Number

ID of the parent entity of the charge.

PricedQuantity

Number

The priced quantity. This quantity equals Line.RequestedQuantity for the item.

PricedQuantityUOMCode

VARCHAR2

Brief text that identifies the UOM for the priced quantity. For example, Ton. Values for this attribute come from PIM (Product Information Management), or a similar service that Order Management provides.

PriceTypeCode

VARCHAR2

Price type of a charge.

  • One-time

  • Recurring

PrimaryFlag

string

Specify whether this charge is the primary charge.

  • true. Primary charge.

  • false. Not the primary charge.

RollupFlag

VARCHAR2

Specify whether this charge is a rollup charge or an aggregate charge.

  • true. Rollup charge.

  • false. Aggregate charge.

SourceChargeIdentifier

VARCHAR2

Value that uniquely identifies the charge. The order capture system assigns this value.

Charge Components

You can include these optional attributes in the request payload to define charge components.

Attribute

Type

Description

ChargeCurrencyCode

VARCHAR2

Brief text that identifies the currency that the charge component uses. Order Management uses this code to standardize service.

ChargeCurrencyUnitPrice

Number

Price or adjustment for each unit in the charge currency for the UOM that the order line uses.

HeaderCurrencyCode

VARCHAR2

Brief text that identifies the currency that the header uses. Order Management uses this code to standardize service.

HeaderCurrencyExtendedAmount

Number

Extended amount in the header currency.

HeaderCurrencyUnitPrice

Number

Price or adjustment for each unit in the charge currency for the UOM that the header uses.

PriceElementCode

Number

Brief text that identifies the price element, such as LISTPRICE, NETPRICE, and so on.

PriceElementUsageCode

VARCHAR2

Brief text that specifies how to use the charge component. A QP lookup provides the values for this attribute. Order Management comes predefined to use one of these values.

  • List Price

  • Invoice Price

RollupFlag

VARCHAR2

Specifies a charge component as a rollup value or aggregate value for the element code of the charge component price.

SequenceNum

Number

Sequence number for the charge component.

SourceChargeComponentIdentifier

VARCHAR2

Value that uniquely identifies the charge component. The source system assigns this value.

SourceChargeIdentifier

VARCHAR2

Value that uniquely identifies the charge. The source system assigns this value.

SourceParentChargeComponentId

VARCHAR2

Identifier for the charge component for the contributing charge. Order Management uses this attribute only for a charge component where the parent charge is a rollup charge.