This complex type defines a discount applied to an order item or shipping charge A number that uniquely identifies a discount line within an order line item. A enum indicating how the discount will be accounted for. A boolean flag indicating if the discount isautomatically applied to the order item as the result of an advanced pricing rule, or manually applied by the operator. The possible values are "Y" or "N". A enum indicating the basis the discount is assigned to the order item. A boolean flag indicating if the discount is applied as the result of item damage. The possible values are "Y" or "N". The currency ISO code The discount amount for the order item. The discount amount applied to item units that have been picked up or shipped. This is to support partial pickup/ship of an order item. The discount amount applied to item units that have been cancelled. This is to support partial cancellation of an order item. The discount amount applied to item units that have been returned. This is to support partial return of an order item. The unit discount amount for each order item unit. It is different from the discount amount if the order item has multiple quantities. The employee id captured if the discount is an employee based discount A enum indicating if the discount is percentage based or amount based. The discount rate if it is a percentage based discount. The id of the discount rule that is applied to the order item. A enum indicating if the discount is applied at the entire order level or at the order item level. A boolean flag indicating if the discount is applied because it is the best deal among all the discounts that the order item is eligible of.The possible values are "Y" or "N". The reason code indicating why this discount is applied to the order item. A store coupon id that is associated with the discount. The promotion component detail id in MOM for this discount. The promotion component id in MOM for this discount. The promotion id in MOM for this discount This is the top level CustOrdItemRtVo The line item no that uniquely identifies the order item to return. The item quantities that are returned or return voided for this order item in this transaction. This is the additional, not the total returned or return voided quantities of an order item. It can be positive or negative. It is positive for return, and negative for return voided. This is to support partial return or return voided for an order item. The unit of measure of the order item. the currency ISO code The additional amount returned or return voided for this order item in this transaction. It can be positive or negative. It is positive for return, and negative for return voided. This is to support partial return or return voided for an order item. The discount amount applied to item units returned or return voided for this order item in this transaction. It can be positive or negative. It is positive for return, and negative for return voided. This is to support partial return or return voided for an order item. The tax amount applied to item units returned or return voided for this order item in this transaction. It can be positive or negative. It is positive for return, and negative for return voided. This is to support partial return or return voided for an order item. The VAT tax amount applied to item units returned or return voided for this order item in this transaction. It can be positive or negative. It is positive for return, and negative for return voided. This is to support partial return or return voided for an order item. A collection of discounts applied to item units returned in this transaction for this order line item. A collection of tax applied to item units returned in this transaction for this order line item. This complex type defines a customer order delivery record. The sequence no of an order delivery record. An enum indicating the location type the items are delivered or cancelled. The possible values are "S" for store, or "W" for warehouse. The location id where the order items are delivered or cancelled. An enum indicating the delivery type. The possible values are "C" for customer pickup and "S" for ship direct. The actual date the items are delivered or cancelled. This will be the GMT time. The actual time the items are delivered or cancelled. This will be the GMT time. The customer id of the person who receives or cancels the items. The signature of the person who receives or cancels the items in SVG format Base64 encoded. The carrier code to deliver the order items. The carrier service code to deliver the order items. The carrier tracking no to deliver the order items. Contains the contact information for a customer Unique identifier for this contact Contact first name. ORPOS Usage - For regular customers that are fed into ORPOS from an external customer system, if this field is not populated, ORPOS will prompt for a value. For Customers created by ORPOS, this field needs to be populated. Contact last name. ORPOS Usage - For regular customers that are fed into ORPOS, if this field is not populated, ORPOS will prompt for a value. For Customers created by ORPOS, this field needs to be populated. Contact middle name Contact preferred name Contains the full name for a regular customer. A Title placed before a name. Example Ms, Mr The name suffix, can be academic, honorary, professional or generational. Example: PhD, MBA, PMP, Sr, Jr, JDA Fax number for this contact Contains the name of a business/ organization. List of phones for this contact address. List of emails for this contact address Contains a list of emails for this contact address Contact Email. Contains a list of phones for this contact address Phone information Contains the email information Unique identifier for the email Contains the email type. For ORPOS if the field is not populated, will default to "HOME". Indicates whether this email is the primary contact email address. Defaults to false. Contains the email address. Contains the format for the email for example TEXT or HTML. Indicates the type of communications being sent to this email address. Sample values: order information only, promotion info only, marketing, no contact If the retailer integrates with an external system that does email validation at the time of adding this record, this flag is set to true. Absence of this element should indicate "false". It defines a collection of tax applied to item units returned in this trausnaction. A collection of tax applied to item units returned in this transaction for this order line item. The collection size. The breakdown of points issued (or projected to be depending on the request) for a specific line item. The index of the line item within the context of the order or transaction. The item id, such as the sku or upc, that identifies the item(s) for this line. The points earned for this line item purchase/order. The points in escrow for this line item purchase/order. The points awarded in bonus for this line item purchase/order. An invoice of loyalty points that were, or could be, issued (depending on the request made) for a retail transaction or order. The full identifier for the retail transaction from the point-of-sale system. This element should be missing if the invoice is for an order. The full identifier for the customer order from the order management system. This element should be missing if the invoice is for a transaction. The id of the loyalty account that was attached to the transaction or order as per the loyalty system of record. The id of the loyalty program that the loyalty account is a part of. The id of the loyalty program that the loyalty account is a part of. A list of LineItemPoints may exist here to breakdown the points that were issued (or projected to be depending on the request) per line. Limited to 999 to prevent XML overflow. A breakdown of the points issued (or projected to be depending on the request) for the entire order or transaction. The breakdown of points issued (or projected to be depending on the request) for the entire order or transaction. The points earned for this order or transaction. The points in escrow for this order or transaction. The points awarded in bonus for this order or transaction. It defines a collection of discounts applied to item units returned in this trausnaction. A collection of discounts applied to item units returned in this transaction for this order line item. The collection size. ISO country code ISO language code Alteration details of an order item The type of alteration User entered instructions for the alteration The complex type define a customer order item A number that uniquely identifies an order line item within an order in OMS. During an order create, it is initiated by an order capture application such as ORPOS. Once an order is created, OMS owns the order. OMS is responsible to manage or alter line_item_no in any way it deems appropriate. In addition, OMS is responsible of maintaining a mapping between line_item_no and captured_line_item_no. A number that uniquely identifies an order line item within an order in an order capture application such as ORPOS. This is a number assigned by the order capture application, and should never be altered by OMS. The order item id The order item UPC. The order item description in its original receipt locale. The total item quantity ordered The item quantity available to be picked up or shipped to a customer or store. The item quantity that has been picked up or shipped. The item quantity that has been cancelled. The item quantity that has been returned. The unit of measure of the order item. The currency ISO code The total extended price of an item with discount and tax applied. The sell unit price of the item. This reflects the promotional or manually overriden price. The regular unit price of the item. The amount that has been picked up or shipped for the item. The amount that has been cancelled for the item. The amount that has been returned for the item. The amount already paid for the item The total discount applied to the item The discount amount applied to item units that have been picked up or shipped in this order line item. The discount amount applied to item units that have been cancelled in this order line item. The discount amount applied to item units that have been returned in this order line item. The tax applied to the item The tax amount applied to item units that have been picked up or shipped in this order line item. The tax amount applied to item units that have been cancelled in this order line item. The tax amount applied to item units that have been returned in this order line item. The VAT tax amount that is included in the item price The VAT tax amount applied to item units that have been picked up or shipped in this order line item. The VAT tax amount applied to item units that have been cancelled in this order line item. The VAT tax amount applied to item units that have been returned in this order line item. The manual price override applied to the item. The price promtion applied to the item. A collection of discount line items for the item. A collection of tax line items of the item The order item department id. The minimum age required to purchase the order item. The boolean flag indicating if the order item is eligible for discount. The possible values are "Y" or "N". The boolean flag indicating if the order item is eligible for damage discount. The possible values are "Y" or "N". The boolean flag indicating if the order item is eligible for employee discount. The possible values are "Y" or "N". The item type enum The manufacturer upc The merchandise hierarchy group id of the order item. The product group of the order item A boolean flag indicating if restocking fee should be applied to the order item during return. The possible values are "Y" or "N". A boolean flag indicating if the order item is eligible for return. The possible values are "Y" or "N". A boolean flag indicating if the order item requires a serial number. The possible values are "Y" or "N". If the order item requires a serial number, this boolean flag indicates if the entered serial number must be validated by the store inventory system. The possible values are "Y" or "N". If the order item requires a serial number, this boolean flag indicates if it is allowed to enter a serial number that is new to the store inventory system. The possible values are "Y" or "N". A boolean flag indicating if the order item requires a size code. The possible values are "Y" or "N". The order item's tax group id that indicates how tax is calculated for the item. A boolean flag that indicates if the order item is taxable. The possible values are "Y" or "N". The weight of the item. The serial number of the order item if it has one The size code of the order item if it has one. The gift registry id if the order item is purchased from a gift registry. A boolean flag indicating if a gift receipt is printed for the order item. The possible values are "Y" and "N". A boolean flag indicating if the item is a shipping charge. The possible values are "Y" and "N". A entry method enum indicating how the order item is entered. Additional info if the order item is an alteration service item Additional info if the order item is a gift card item. The sequence no of an order's fulfillment detail. It should match a sequence no in CustOrdFulDesc. This complex type that records gift card item details. The gift card number The request type: issue or reload The authorization code returned by the authorizer The date and time the gift card is authorized The original balance of the gift card The current balance of the gift card The authorization settlement data This complex type records a check payment The bank id The account number The MICR number The check number The authorization code returned by the authorizer The authorization method The personal id number The name of the id issuer The issuer country code The issuer state code A boolean flag indicating if the ID is swiped or manually entered. The possible values are "Y" or "N". The customer phone number The entry method of the check The conversion code of a ECheck This complex type records a coupon payment The coupon type The entry method of the coupon The coupon number This complex type records a credit/debit card payment. The masked card account number The card token returned by the authorizer The card type such as Visa, Master etc The method the card is entered. The authorization code returned by the authorizer. The date and time the card is authorized. The authorization method The country that issues the personal ID. The state that issues the personal ID. The expiration date of the personal ID. The prepaid amount on the card The account APR The account APR type The promotional APR The promotional APR type The description of the promotion The duration of the promotion The authorization settlement data The customer signature in encoded SVG format. The additional security info required of a debit card This complex type records a gift card payment The gift card number The authorization code returned by the authorizer The date and time the gift card is authorized The authorization method A boolean flag indicating if the payment is a credit to the gift card. The possible values are "Y" or "N". The entry method of the gift card The original balance of the gift card The remaining balance of the gift card The authorization settlement data This complex type records a gift certificate payment The gift certificate type A enum indicating the issue location type. The issuer store id The gift certificate serial number This complex type records a mail bank check refund payment The name of the person the check is mailed to. The address the check is mailed to. The personal id type used to verify customer identity This complex type defines payment information of an order. The sequence no of an order payment record. The payment type the currency ISO code The payment amount The foreign currency ISO code if payed by a foreign currency tender. The payment amount in foreign currency if payed by a foreign currency tender. This records a credit/debit card payment. The records a check payment. This records a coupon payment. This records a gift card payment. This records a gift certificate payment This records a refund payment by a check mailed to the customer. This records a purchase order payment. This records a store credit payment. This records a travelers check payment. The complex type records a purchase order payment The agent name the purchase order is sent to The purchase order number This complex type records a store credit payment The store credit certificate type The first name of the person the store credit is granted to. The last name of the person the store credit is granted to. The type of personal id used to verify customer identity. The store credit state The store credit id The complex type records a travelers check payment the check count This complex type describes billing destination of order items. The contact info of the person to bill the order items. The address of the person to bill the order items. This complex type defines a fulfillment detail of an order. The sequence no of an order's fulfillment detail. The fulfillment order id assigned by OMS. This field is not populated during order creation. An enum indicating the fulfillment location type. The possible values are "S" for store, and "W" for warehouse. For a customer pickup, the location type is specified by the customer during order creation; for a customer ship, the location type is determined by OMS. The location id where the order items are going to be fulfilled. For a customer pickup, the location id is specified by the customer during order creation; for a customer ship, the location id is determined by OMS. An enum indicating the delivery type. The possible values are "C" for customer pickup and "S" for ship direct. Indicates if the order can be picked and shipped partially ('N') or if it should be picked up or shipped only when complete ('Y'). A boolean flag indicating if items need to be shipped to the fulfill location for pickup if customer pickup is specified. The possible values are "Y" or "N". The carrier code if ship direct is specified. The carrier service code such as next day, overnight etc if ship direct is secified. Indicates the desired date the delivery is required by the customer. This will be the GMT time. Indicates the desired time the delivery is required by the customer. This will be the GMT time. Special instructions if any. The delivery destination of order items. The billing destination of order items. This complex type describes delivery desintation of order items. The contact info of the person to pickup the items if customer pickup is specified; or the person to ship the items to if ship direct is specfied. The address to ship the order items to if ship direct is specifed. This complex type defines a collection of customer order delivery records. A delivery record. The number of CustOrdDelDesc objects. This the top level CustOrdPayColDesc which is used to communicate customer order payments. A payment detail object. The number of CustOrdPayDesc objects. A collection of awards associated with a loyalty account. Limited to 99 to prevent XML overflow. A coupon of some value that has been awarded to a loyalty member. The ISO code of the currency in which the monetary amount of the coupon was awarded. A loyalty account is a what a loyalty system maintains for members who have agreed to participate in a merchant's loyalty program. It contains a link to the customer who is the member and status about the account, such as creation date, account level, and membership points that have been earned or are in escrow. When using this RBO to create a loyalty account, not all elements may be supported by the service provider system, such as specifying points balances, program level, or pre-existing awards. Check the system provider documentation for allowed elements. The id of the loyalty account as maintained by, and usually generated by, the loyalty system of record. This element is not required when using LoyAcctDesc as a parameter for creating a loyalty account. The id of the loyalty program that the account should be created for (i.e. for which the customer is enrolling into). Merchants may have more than one loyalty program per line-of-business. They may have variable durations and/or membership costs. May also be referred to a a scheme id. The date the member agreed to start participating in the loyalty program. The loyalty member number of the member that referred this customer. The level the member has attained within the loyalty program's scheme. The breakdown of all point totals currently accrued for this account. The list of awards associated with the account that may be used by its members. If any customers have been associated with this account as a loyalty member, those customers should be listed here. When creating a loyalty account, there should be at least one member specified, depending on system requirements. Limited to 99 to prevent XML overflow. Zero to many cards that have been issued for this account are listed here. When creating a loyalty account, some card information may be required, such as prefix and series sequence. Check with the service provider system documentation for requirements. Limited to 99 to prevent XML overflow. The details about a membership card linked to a loyalty account. The prefix, a 5-digit sequence, used on the card for the card number. The sequence number, a 2-digit sequence, that indicates the card series of the card. The physical card number, either printed, magnetically imprinted, or encoded and used by the member for identification. A unique identifier for the physical card that identifies a single card instance. The password or PIN number required to authenticate the customer as the correct loyalty member. If there is a primary customer associated with this card, the member number, i.e. customer id, can be specified here. This customer should also exist in the LoyaltyMember element of the LoyAcctDesc. The details about a customer linked to a loyalty account as a member. The customer id for this member, as given by the customer system of record, can be specified here. The breakdown of all point totals currently accrued for this account. This includes all the points currently earned (and unused) by the members of this account All the points issued but not yet earned or ready to be converted to an award. The amount of points that have been issued to a member as a bonus. The amount of points that have been earned since the beginning of the year. The amount of points that have been earned since the creation (lifetime) of the loyalty account. The level the member has attained within the loyalty program's scheme. The id of the loyalty program level. The name of the loyalty program level. The complex type describes a customer order retail business object. The customer order id. The id from an external source that is linked to this order. This is used for integration purpose. The currency ISO code. The order's original receipt locale. The order description in its original receipt locale. A enum indicating the order status. The possible values are "NEW", "PARTIAL", "CANCELED", or "COMPLETED". A enum indicating the location type where the order is initiated. The possible values are "O" for online or "S" for store. The location id where the order is initiated. The country code where the order is initiated. The grand total order amount that includes discount, tax, and shipping charges. The subtotal order amount that does not include discount, tax, and shipping charges. Total amount of sales tax paid for this order Total amount of VAT tax paid for this order. The VAT tax is already included in the item price. The total amount of shipping charge paid for this order. The total amount of discount for this order. The total amount picked up or shipped for this order. The total amount cancelled for this order. The total amount returned for this order. The discount amount applied to order items that have been picked up or shipped. The discount amount applied to order items that have been cancelled. The discount amount applied to order items that have been returned. The tax amount applied to order items that have been picked up or shipped. The tax amount applied to order items that have been cancelled. The tax amount applied to order items that have been returned. The VAT tax amount applied to order items that have been picked up or shipped. The VAT tax amount applied to order items that have been cancelled. The VAT tax amount applied to order items that have been returned. The total paid amount for this order. The following formula holds true. paid_amount + rounding_adjustment = total payment from payment collection - refund_amount_offset_by_sale The rounding adjustment for this order. It can be positive or negative. The following formula holds true. paid_amount + rounding_adjustment = total payment from payment collection - refund_amount_offset_by_sale The refund amount offset by take with items purchased. This amount is always positive. The following formula holds true. paid_amount + rounding_adjustment = total payment from payment collection - refund_amount_offset_by_sale The id for the customer that is assigned to this order. A boolean flag indicating if a gift receipt is assigned to this order. The possible values are "Y" or "N". The default gift registry id of the order if there is one. The birthday of the customer if the order has restrictive items. The order creation timestamp. The order update timestamp. A collection of order items. A collection of returns created on this order. A collection of order fulfillment details. A fulfullment detail defines how a group of items will be fulfilled: in store pick up or ship. A collection of order delivery records. A collection of order payments. The unique identifier for Customer Contains the unique identifier for the customer Top-level CustOrderRtnColVo that has a collection of return value objects A collection of customer order return value objects. The collection size. This the top level CustOrdItmRtColVo A collection of order item return value object. The collection size. This is the top level CustOrdDisColDesc which is used to communicate discounts. A collection of discounts. The collection size. A LoyAcctRef is a set of identifiers that refer to a specific loyalty account record. At least one of the optional elements should be specified. The id of the loyalty account as maintained by, and usually generated by, the loyalty system of record. The card number being searched when searching for a specific loyalty account. The card number could be the same as the account_id. There could also be more than one card associated with a single loyalty account. This complex type defines a discount applied to item units being returned. A number that uniquely identifies a discount line within an order line item. The currency ISO code The discount amount applied to item units returned or return voided for this order item discount line in this transaction. It can be positive or negative. It is positive for return, and negative for return voided. This is to support partial return or return voided for an order item. Top level CustOrderRtnVo used when returning order items from an existing order. The customer order id The currency ISO code of the paid amount The additional amount returned or return voided for the order in this transaction. It can be positive or negative. It is positive for return, and negative for return voided. The discount amount applied to order items returned or return voided in this transaction. It can be positive or negative. It is positive for return, and negative for return voided. The tax amount applied to order items returned or return voided in this transaction. It can be positive or negative. It is positive for return, and negative for return voided. The VAT tax amount applied to order items returned or return voided in this transaction. It can be positive or negative. It is positive for return, and negative for return voided. The order update timestamp A collection of order items to update incrementally. This is the top level CustOrdTaxColDesc which is used to communicate tax detail objects A tax detail object. The number of CustOrdTaxDesc objects. This complex type defines a price promotion for an order item or shipping charge. The currency ISO code. The unit discount amount of the order item due to the price promotion The promotion name in its original receipt locale. The promotion component detail id in MOM. The promotion component id in MOM. The promotion id in MOM. Contains the phone information. Unique identified for the phone Phone number Phone type. For ORPOS if the field is not populated will default to value "HOME". Contains the phone extension Indicates whether this phone is the primary contact phone Indicates the type of communications that this phone is being used for. Sample values: order information only, promotion info only, marketing, no phone contact This complex type defines a manual price override of an order item or shipping charge. The reason code indicating why the manual price override is applied to the order item. The currency ISO code The overridden price of an order item unit. This is the new unit price, not extended price. The employee id that authorizes the manual price override. A enum indicating how the manual price override is entered. This complex type define tax applied to item units being returned. A number that uniquely identifies a tax line within an order line item. The currency ISO code The tax amount applied to item units returned or return voided for this order item tax line in this transaction. It can be positive or negative. It is positive for return, and negative for return voided. This is to support partial return or return voided for an order item. A boolean flag indicating if the tax returned is already included in the item price. The possible values are "Y" or "N". Address used for mail, shipping or delivery Unique identifier for this address entry. The address type can be any of the enumerated values 'Home','Office','Billing','Shipping' Contains Address Line 1. Contains Address Line 2. Contains Address Line 3. Contains Address Line 4. Contains Address Line 5. Contains the city where the address is located. County where this address is located Contains the postal abbreviation for the state, province or territory in which the address is located. Indicates the state, province or territory name. Contains the postal abbreviation of the country in which the address is located Indicates the Country name For e.g Brazil,United States Contains the postal code for the address ID associated to the tax jurisdiction of the country-state relationship. Indicates the type of communications being sent to this address. Sample values are order information only, promotion info only, marketing material, no contact If the retailer integrates with an external system that does address validation at the time of adding this record, this flag is set to true. Absence of this element should indicate "false". This is the top level CustOrdFulColDesc which is used to communicate customer order fulfillments between OMS and ORPOS. A fulfillment detail object. The number of CustOrdFulDesc objects. This complex type define tax applied to an order item or shipping charge. A number that uniquely identifies a tax line within an order line item. ID_ATHY_TX The order item's tax group id A tax type code A boolean flag indicating if it is a tax holiday.The possible values are "Y" or "N". The currency ISO code The order item's taxable amount The order item's tax amount The tax amount applied to item units that have been picked up or shipped. This is to support partial pickup/ship of an order item. The tax amount applied to item units that have been cancelled. This is to support partial cancellation of an order item. The tax amount applied to item units that have been returned. This is to support partial return of an order item. A boolean flag indicating if the tax is already included in the item price. The possible values are "Y" or "N". A enum indicating if the order item is nottaxable, tax is applied in standard mode, or modified manually by the operator. A reason code indicating why the order item's tax is manually modified. A enum indicating if the tax is modified at the order level or order item level. The tax rate The tax rule name The tax authority name This object is used to recover loyalty points for orders or transactions that have not been awarded points. Use this object to submit an order id or transaction id and a valid loyalty account for a member who purchased said order/transaction. Submit the info to the loyalty provider system to re-evaluate the order/transaction and possibly award points. Contains the transaction or order id of the sale that should be re-evaluated for awarding loyalty points to the specified loyalty account. A set of identifiers that refer to a specific loyalty account record. Typical detail to include would be the loyalty account id or the card number used to identify the shopper. Other details may be excluded. This the top level CustOrdItmColDesc which is used to communicate customer order items. The customer order item detail. The number of CustOrdItmDesc objects. A set of service calls that consumers like web-commerce or point-of-sale would expect a loyalty system to provide. An example loyalty system within the Oracle RGBU would be Oracle Retail Customer Engagement (ORCE). The appName above is currently left generic since ORCE could provide services for much more than just loyalty.

Calculate the loyalty points that would be earned for the given order for the purposes of presenting to the shopper a pro forma invoice of the goods being purchased in the order or transaction. No points are earned or issued. See Siebel LoyaltyAccrualService ProcessExternalOrderTxn (simulated). See ORCE Loyalty Account Services calculateProformaPoints. CustOrderDesc object contains details about the order in progress between the customer and merchant. The service provider system may require the order to contain a customer with a loyalty account id in order for it to estimate the proper points since points may be different depending on loyalty program achieved.

LoyInvcDesc object contains an invoice of loyalty points that are projected to be awarded for the order.

Throw this exception when a "soap:Client" side message problem occurs. Throw this exception when an unknown "soap:Server" side problem occurs.