Order modification types
The default order modification types are associated with modification levels.
The following are the default order modification types and their associated modification levels:
Modification Types | Description | Modification Levels |
---|---|---|
Add Component | A bundle component can be added to an order document line. | Line |
Add Instruction | An instruction can be added to an order document's header,
line, or shipment. For example, you may want to add an instruction stating that a line item needs to be gift wrapped. |
Header Line Shipment Receipt |
Add Line | A line can be added to an order document's header, release,
negotiation, or shipment. Important: When adding a line to an order, the Add Line modification type does not get audited, if the prices are not configured. |
Header Release Negotiation Shipment |
Add Line Relationship | A line relationship type can be added to an order document line. | Line |
Add Note | A note can be added to an order document's header or release. | Header Release |
Add Option | An option can be added to a provided service or delivery service order line. | Line |
Add Product Item For Stand Alone Service Line | A product item for a stand-alone service line can be added to an order document line. | Line |
Add Quantity | Additional quantity can be added to an order document's line or release line. | Line Release Line |
Add/Remove Additional Date | A date type used for shipment monitoring (such as, Ship Date)
can either be added to or removed from an order document's shipment. For example, you may want to add an additional delivery date used by your organization to monitor shipments. |
Shipment |
Add/Remove Charge | A charge can either be added to or removed from an order document's
shipment. For example, if a shipment contains hazardous materials and your organization has an extra shipping charge for shipment of hazardous materials, you can add an extra charge to the shipment. |
Shipment |
Add/Remove Container | A container can either be added to or removed from an order document's shipment. | Shipment |
Associate Delivery Line With Product Line | When the delivery method of a product order line is delivery, the product line can be associated to a delivery line to indicate how the product line is delivered. | Line |
Associate Product Line With Delivery Line | When the delivery method of a product order line is delivery, the product line can be associated to a delivery line to indicate how the product line is delivered. | Line |
Associate Product Line With Service Line | A provided service can be associated to a product line to indicate that the service is somehow dependent on the product line. | Line |
Associate Service Line With Product Line | A provided service can be associated to a product line to indicate that the service is somehow dependent on the product line. | Line |
Attribute Modification | A receipts attributes can be modified. For a list of attributes that can be modified, see the changeReceipt API in Javadoc. | Receipt |
Backorder | An order document's line, release, or release line can be backordered. For example, if an order is released to a node and the node does not have enough quantity to fulfill the order, they can backorder the release. |
Line Release Release Line |
Cancel | An order document's header, line, release, or release line can be manually cancelled from the Application Consoles. | Header Line Release Release Line |
Change Additional Address | A modification can be made to the fields of any additional addresses that may have been configured for an order document's header or line. | Header Line |
Change Answer Set | A modification can be made to an answer associated with an order document header. | Header |
Change Appointment | Appointments can be taken and changed for delivery and provided service order lines. | Line |
Change Bill To | A modification can be made to any bill to address field associated with an order document's header or release. | Header Release |
Change Bundle Definition | The existing bundle definition can be replaced with the new
bundle definition. For example, you can change an existing bundle definition by passing the 'REPLACE_BUNDLE' action to the bundle parent. All the components passed remain with order and as well as with bundle. All remaining components are deleted. Important: In addition to this, the modification type DELETE is executed on all the components getting removed and modification type ADD_LINE is executed on components getting added. This modification is applied to bundle parent's immediate components. |
Line |
Change Bundle Parent | A modification can be made to the bundle parent associated with an order document line. | Line |
Change Buyer Organization | The buyer organization associated with an order document's header can be changed. This modification can only be made in the Order Detail screen. | Header |
Change Carrier | A modification can be made to the Carrier/Service or Carrier
field associated with an order document's header, line, or release. For example, you can change the carrier and service from UPS Next Day Air to FedEx Express Saver Pack. Important: If you want this modification type to be allowed, Change Carrier Service Code must also be allowed. |
Header Line Release |
Change Carrier Account No | A modification can be made to the Carrier Account # field associated with an order document's header, line, or release. | Header Line Release |
Change Carrier Service Code | A modification can be made to the Carrier/Service field associated
with an order document's header, line, or release. For example, you can change the carrier and service from UPS Next Day Air to FedEx Express Saver Pack. Important: If you want this modification type to be allowed, Change Carrier must also be allowed. |
Header Line Release |
Change Contact Info | A modification can be made the fields for the Buyer/Seller contact information associated with an order document's header. | Header |
Change Cost | A adjustment can be made to the Unit Cost field associated with an order document's release or release line. | Release Release Line |
Change Currency | The currency associated with an order document's header can be changed. Upon a change to the currency, Sterling Order Management System Software automatically reprices the order. However, preexisting charges and taxes have to be converted manually. | Header |
Change Custom Date | A modification can be made to the date type fields used for
order monitoring associated with an order document's header, line,
or release. The following custom date fields can be modified when this modification type is allowed:
For example, if there is a delay in a release's processing, you can change the expected delivery date. |
Header Line Release |
Change Delivery Code | A modification can be made to the Delivery Code field associated
with an order document's header, line, or release. For example, if you want to indicate that an order's freight charges are paid by the Enterprise, you can choose the ENTERPRISE delivery code. |
Header Line Release |
Change Delivery Method | A product order line indicates how the product id sent to its final destination. It can be changed to SHIP, DELIVER, or PICKUP. | Line |
Change Freight Terms | A modification can be made to the Freight Terms field associated
with an order document's header, line, or release. For example, you can change an order line's freight term from CIF (Cost Insurance and Freight) to CFR (Cost and Freight). |
Header Line Release |
Change Gift Flag | A modification can be made to the Gift Flag field associated with an order document line. | Line |
Change Gift Wrap | A modification can be made to the Gift Wrap fields associated with an order document line. | Line |
Change Instruction | A modification can be made to an instruction associated with
an order document's header, line, or shipment. The following instruction fields can be modified when this modification type is allowed:
|
Header Line Shipment Receipt |
Change Inventory Attributes | A modification can be made to inventory attributes associated with an order document line. | Line |
Change Item Description | A modification can be made to the Description field of an item associated with an order document's line. | Line |
Change Iteration | A modification can be made to the iteration fields associated
with an order document's header or line. For example, you can change the next iteration date of a master order to a time in the future. |
Header Line |
Change Level of Service | A modification can be made to the Level of Service fields associated with an order document's header or line. | Header Line |
Change Mark For | A modification can be made to the fields of the mark for address associated with an order document's header, line, or release. | Header Line Release |
Change Order Name | A modification can be made to the Order Name field associated with an order document's header. | Header |
Change Other Attributes | A modification can be made to fields that do not have system or user-defined modification types associated with them. | Header Line Release Negotiation Negotiation Line Shipment |
Change Other Relationships | Not used in this version. | Shipment |
Change Payment Method | A modification can be made to the Payment Type field associated
with an order document's header or release. For example, you can change an order's payment type from Check to Credit Card. |
Header Release |
Change Payment Rule ID | The Payment Rule field associated with an order document's
header can be changed. For example, you can change the payment rule from the default rule to a custom rule that pertains to the order. |
Header |
Change Payment Status | The Payment Status field associated with an order document's
header can be changed. For example, you can change an order's payment status from Await Authorization to Authorized. |
Header |
Change Pipeline | A change can be made to the pipeline associated with an order document line. | Line |
Change Price | Charges can be added to an order document's header or line. | Header Line |
Change Promotion | An order document's promotion can be changed at the header or line. Promotions include coupons and manual pricing rules. | Header Line |
Change Receiving Node | The Receiving Node field associated with an order document's
line can be changed. For example, if for some reason it has been determined that an order line's original receiving node cannot receive the line, you can change it to another receiving node. |
Line |
Change References | A modification can be made to the name/value pair in the YFS_REFERENCE_TABLE using APIs. | Header Line |
Change Requested Ship Date | A modification can be made to the Requested Ship Date associated
with an order document's header, line, or release. For example, if the customer decides they want an order to be shipped on a date later than what they originally requested, you can change the requested shipment date. |
Header Line Release |
Change Schedule | A modification can be made to schedule attributes, such as expected ship date, expected delivery date, and lot number, associated with an order document's header, line, release, or release line. | Header Line Release Release Line |
Change Schedule Rule ID | A modification can be made to the schedule rule associated with an order document's header. This allows the user to select the scheduling rule they want to use for the order from the Scheduling Rule drop-down list on the Schedule Order popup window. | Header |
Change Seller Organization | The seller organization associated with an order document's header can be changed. This modification can only be made in the Order Detail screen. | Header |
Change Ship Node | The Ship Node field associated with an order document's header
or line can be changed. For example, if for some reason it has been determined that an order line's original ship node cannot handle the order line, you can change it to another node. |
Header Line |
Change Ship To | A modification can be made to the fields of a ship to address associated with an order document's header, line, or release. | Header Line Release |
Change Status | The order status (such as, Created) associated with an order
document's header, line, release, release line, or negotiation can
be changed. Only order statuses existing in process type repositories are affected by this modification type. Actions performed against order documents, such as putting an order on hold or canceling an order, are not impacted. |
Header Line Release Release Line Negotiation |
Change Tax | A modification can be made to the Tax Amount associated with an order document's header or line. | Header Line |
Delete | An order line can be deleted. | Line |
Delete Shipment | An order document's shipment can be deleted. | Shipment |
Expiration Date | A modification can be made to the expiration date associated with an order document's negotiation. | Negotiation |
Hold | An order document's header or release can be manually put on
hold. For example, you may want to perform a security check on a particular Buyer, you can then place the order on hold until you clear the necessary information before the order is scheduled. |
Header Release |
Hold Type Modifications | A modification can be made to the Hold Type fields associated with an order document's header or line. | Header Line |
Include In Load | An order document's shipment can be included in a load document. | Shipment |
Include Shipment in Delivery Plan | An order document's shipment can be included in a delivery plan. | Shipment |
Pack Shipment | An order document's shipment can be packed. | Shipment |
Price Program | The price program associated with an order document's header can be changed. | Header |
Receipt Complete | An order document's receipt can be marked as complete. | Receipt |
Release from Hold | An order document's header can be released from hold. | Header |
Remove Component | A bundle component can be removed from an order document line. | Line |
Remove Delivery Line From Product Line Association | Delivery lines can be removed from product order lines. | Line |
Remove Order Line | A line can be removed from an order document's header, line, and shipment. | Header Line Shipment |
Remove Option | Options can be removed from delivery and provided services. | Line |
Remove Product Item For Stand Alone Service Line | A product item for a stand alone service line can be removed from an order document line. | Line |
Remove Product Line From Delivery Line Association | Product lines can be removed from delivery lines. | Line |
Remove Product Line From Service Line Association | Product lines can be removed from provided service order lines. | Line |
Remove Promotion | An order document's promotion can be removed from the header or line. Promotions include coupons and manual pricing rules. | Header Line |
Remove Service Line From Product Line Association | Provided service lines can be removed from product order lines. | Line |
Remove Shipment From Delivery Plan | An order document's shipment can be removed from a delivery plan. | Shipment |
Rework Quote | A quote can be reworked. | Header |
Short | An order document's header, line, release, release line, and receipt can be shorted. This occurs when there is a shortage in the expected quantity. | Header Line Release Release Line Receipt |
Sourcing Control Modifications | Modifications can be made to the Sourcing Control fields associated with an order document's line. | Line |
Split Line | An order document's line or release line can be split into multiple lines. | Line Release Line |
Unpack Shipment | An order document's shipment can be unpacked. | Shipment |
Unreceive | An order document's receipt can be fully or partially unreceived. This moves the quantity you are identifying as unreceived back to Shipped status. | Receipt |
Unschedule | An order document's header or line can be unscheduled from a scheduled node. This cancels any inventory that has been reserved for the order at the scheduled node. | Header Line |