Contains the contact information for a business or regular customerContact 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.Phonetic first name.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.Phonetic last nameContact middle nameContact preferred nameContains the full name for a regular customer.A Title placed before a name. Example Ms, MrThe name suffix, can be academic, honorary, professional or generational.
Example: PhD, MBA, PMP, Sr, Jr, JDAContains the name of a business/ organization.Contains a collection of phone numbersContains a collection of email addresses.Contains all the emails for this contactContact Email.Contains the phone list for this contact.Contact Phone.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.Top-level CustOrderRef that contains the primary key of a
customer order.The mandatory order idThis is the top level CustOrdItmPkVoThe line item no that uniquely identifies the
order item to pick up.The fulfillment order id of this order item.The item quantities that are picked up in this
transaction. This is the additional, not the
total completed quantities of an order item.The item quantities that are cancelled in this
transaction. This is the additional, not the
total cancelled quantities of an order item.The item quantities that are picked up with new price
in this transaction. This is the additional, not the
total picked up with new price quantities of an order item.The unit of measure of the order item.the currency ISO codeThe additional amount picked up for the item in this
transaction. It is always positive.The additional amount cancelled for the item in this
transaction. It is always positive.The additional original amount repriced during pickup for the
item in this transaction. It is always positive.The additional amount picked up with new price for the item
in this transaction. It is always positive.The discount amount applied to item units picked
up in this transaction for this order line item.
It is always positive.The discount amount applied to item units
cancelled in this transaction for this order line
item. It is always positive.The original discount amount applied to item units
repriced during pickup in this transaction for this
order line item. It is always positive.The new discount amount applied to item units picked
up with new price in this transaction for this order
line item. It is always positive.The tax amount applied to item units picked up in
this transaction for this order line item. It is
always positive.The tax amount applied to item units cancelled in
this transaction for this order line item. It is
always positive.The original tax amount applied to item units repriced
during pickup in this transaction for this order line item.
It is always positive.The new tax amount applied to item units picked up with
new price in this transaction for this order line item. It is
always positive.The VAT tax amount applied to item units picked
up in this transaction for this order line item.
It is always positive.The VAT tax amount applied to item units
cancelled in this transaction for this order line
item. It is always positive.The original VAT tax amount applied to item units repriced
during pickup in this transaction for this order line item.
It is always positive.The new VAT tax amount applied to item units picked up with
new price in this transaction for this order line item.
It is always positive.The additional amount paid for the item in this
transaction. This amount can be negative if this
is a refund for a cancelled order item.The serial number of the order item entered in
pick up process.A collection of discounts applied to item units
picked up or cancelled in this transaction for
this order line item.A collection of tax applied to item units picked
up or cancelled in this transaction for this
order line item.Picked up order items with new price.Picked up order items with new priceA collection picked up order items with new price.ISO country codeISO language codeThis the top level CustOrdItmRtColVoA collection of order item return value object.The collection size.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.Contains the phone information.Unique identified for the phonePhone numberPhone type. For ORPOS if the field is not populated will default to value "HOME".Contains the phone extensionIndicates whether this phone is the primary contact phoneThis is the top level CustOrdTaxColDesc which is used to communicate tax detail objectsA tax detail object.The number of CustOrdTaxDesc objects.This the top level CustOrdItmPkColVoA collection of order item pickup value object.The collection size.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 codeThe 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.Contains an address book for the customerContains a collection of addresses for the customer.Unique identifier for this address entry.Indicates whether this address is the primary address (Y) or not (N).The address type.Contains a customer addressContains the contact information for an address. If no contact information provided
at this level, then the contact information provided at the customer header level will be used.Unique identifier for customer.Contains the customer type: regular customer or business.Contains the contact information for the customer.Contains multiple customer addresses.Contains the customer gender.Contains the customer birth date.Indicates if the customer wants to be contacted by mail.Indicates if the customer wants to be contacted by phone.Indicates if the customer wants to be contacted by email.Contains the customer receipt preference. Customer can opt for printed, or email or both printed and email receipts.Contains the id of the employee that created the customer.Contains the customer specific pricing group id that the customer is linked to.Contains a collection of preferred customer discount ids.Contains the customer preferred language.Contains the federal identifier assigned by a national government.Contains the number provided for sales tax exemption issued separately by the state where doing business.Contains the tax exempt reason code.Contains the job title.Contains a collection of preferred customer discount ids.Contains the id for a preferred customer discount.Successful message string.This the top level CustOrdItmColDesc which is used to
communicate customer order items.The customer order item detail.The number of CustOrdItmDesc objects.Alteration details of an order itemThe type of alterationUser entered instructions for the alterationThe complex type define a customer order itemA 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 idThe order item UPC.The order item description in its original
receipt locale.The total item quantity orderedThe 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 codeThe 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 itemThe total discount applied to the itemThe 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 itemThe 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
priceThe 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 itemThe 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 enumThe manufacturer upcThe merchandise hierarchy group id of the order
item.The product group of the order itemA 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 oneThe 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 itemAdditional 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 numberThe request type: issue or reloadThe authorization code returned by the authorizerThe date and time the gift card is authorizedThe original balance of the gift cardThe current balance of the gift cardThe authorization settlement dataTop level CustOrderRtnVo used when returning order
items from an existing order.The customer order idThe currency ISO code of the paid amountThe 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 timestampA collection of order items to update
incrementally.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_TXThe order item's tax group idA tax type codeA boolean flag indicating if it is a tax holiday.The possible values are "Y" or "N".The currency ISO codeThe order item's taxable amountThe order item's tax amountThe 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 rateThe tax rule nameThe tax authority nameIt 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.This complex type define tax applied to item units being picked up or cancelled.A number that uniquely identifies a tax line
within an order line item.The currency ISO codeThe tax amount applied to item units picked up in
this transaction for this order line item. It is
always positive. This is to support partial
pickup for an order item.The tax amount applied to item units cancelled in
this transaction for this order line item. It is
always positive. This is to support partial
cancellation of an order item.The original tax amount applied to item units repriced during
pickup in this transaction for this order line item. It is
always positive. This is to support partial
pickup with reprice of an order item.A boolean flag indicating if the tax completed or
cancelled is already included in the item price.
The possible values are "Y" or "N".The complex type defines credit/debit query criteriaEither a card token or a masked card number must
be set for order search by credit/debit card.Either a card token or a masked card number must
be set for order search by credit/debit card.An item id in the orderA date rangeThis complex type defines a customer order criteria
value objectLocation where the order search request is
initiated.Type of location where the order search request
is initiated. The possible value is only "S" for
store as of today.This element defines the query criteria for order
searchThis element defines what needs to be returned in
an order search result.This complex type defines customer query criteriaEither customer info or customer id must be set
for order search by customer.Either customer info or customer id must be set
for order search by customer.This complex type defines customer info query
criteriacustomer first namecustomer last namecustomer company namecustomer postal codecustomer phone numberthe start datethe end dateThis complex type defines a masked card numberThe first 6 digits of the card numberThe last 4 digits of the card numberThis complex type defines an order query criteriaThe type of order search to performBased on the search type, either a customer order
id, a customer criteria, or a credit debit card
criteria must be specified for order search.Based on the search type, either a customer order
id, a customer criteria, or a credit debit card
criteria must be specified for order search.Based on the search type, either a customer order
id, a customer criteria, or a credit debit card
criteria must be specified for order search.This complex type defines what needs to be returned
for an order itemA boolean flag indicating if order item header
info must be returned. The possible values are
"Y" or "N".A boolean flag indicating if discount line items
must be returned for an order item. The possible
values are "Y" or "N".A boolean flag indicating if tax line items must
be returned for an order item. The possible
values are "Y" or "N".The complex type defines an order query request that
describes what order information must be returned in
an order search result.A boolean flag indicating if order header
information must be returned. The possible values
are "Y" or "N".A flag indicating if order items must be
returned. The possible values are "NONE", "FIRST"
(first item only), or "ALL".A boolean flag indicating if order fulfillment
detail must be returned. The possible values are
"Y" or "N".A boolean flag indicating if order delivery
detail must be returned. The possible values
are "Y" or "N".A boolean flag indicating if order payment
information must be returned. The possible values
are "Y" or "N".This element defines what needs to be returned
for an order item. It is required only if the
return_order_item_flag is "FIRST" or "ALL".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 codeThe 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.Nothing to send.This complex type defines a discount applied to an order item or shipping chargeA 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 codeThe 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 discountA 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 discountThis complex type defines a discount applied to item
units being picked up or cancelled.A number that uniquely identifies a discount line
within an order line item.The currency ISO codeThe discount amount applied to item units picked
up in this transaction for this order line item.
It is always positive. This is to support partial
pickup for an order item.The discount amount applied to item units
cancelled in this transaction for this order line
item. It is always positive. This is to support
partial cancellation of an order item.The original discount amount applied to item units
repriced during pickup in this transaction for
this order line item. It is always positive.
This is to support partial pickup with reprice
of an order item.This the top level CustOrdPayColDesc which is used to
communicate customer order payments.A payment detail object.The number of CustOrdPayDesc objects.This is the top level CustOrdItemRtVoThe 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 codeThe 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 define tax applied to item units being returned.A number that uniquely identifies a tax line
within an order line item.The currency ISO codeThe 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".Top level CustOrderPicVo used when picking up or
cancelling order items from an existing order.The customer order idThe currency ISO code of the paid amountThe additional amount picked up for the order in this
transaction. This amount is always positive.The additional amount cancelled for the order in this
transaction. This amount is always positive.The additional original amount repriced during pickup for the order in
this transaction. This amount is always positive.The additional amount picked up with new price for the order in this
transaction. This amount is always positive.The discount amount applied to order items picked
up in this transaction. This amount is always
positive.The discount amount applied to order items
cancelled in this transaction. This amount is
always positive.The original discount amount applied to order items
repriced during pickup in this transaction. This amount
is always positive.The new discount amount applied to order items picked
up with new price in this transaction. This amount is
always positive.The tax amount applied to order items picked up
in this transaction. This amount is always
positive.The tax amount applied to order items cancelled
in this transaction. This amount is always
positive.The original tax amount applied to order items
repriced during pickup in this transaction. This
amount is always positive.The new tax amount applied to order items picked up
with new price in this transaction. This amount is
always positive.The VAT tax amount applied to order items picked
up in this transaction. This amount is always
positive.The VAT tax amount applied to order items
cancelled in this transaction. This amount is
always positive.The original VAT tax amount applied to order items
repriced during pickup in this transaction. This amount
is always positive.The new VAT tax amount applied to order items picked
up with new price in this transaction. This amount is
always positive.The additional amount paid for the order in this
transaction. This amount can be negative if it
contains refunds for cancelled order items.
The following formula holds true.
paid_amount + rounding_adjustment = total payment from payment collection - refund_amount_offset_by_saleThe rounding adjustment in this transaction. It can be
positive or negative. The following formula holds true.
paid_amount + rounding_adjustment = total payment from payment collection - refund_amount_offset_by_saleThe refund amount offset by additional take with items
purchased in this transaction. This amount is always
positive. The following formula holds true.
paid_amount + rounding_adjustment = total payment from payment collection - refund_amount_offset_by_saleThe order update timestampA collection of order items picked up or
cancelled..Delivery information of the order items picked
up or cancelled..A collection of order payments to add to the
order.This complex type records a check paymentThe bank idThe account numberThe MICR numberThe check numberThe authorization code returned by the authorizerThe authorization methodThe personal id numberThe name of the id issuerThe issuer country codeThe issuer state codeA boolean flag indicating if the ID is swiped or manually entered.
The possible values are "Y" or "N".The customer phone numberThe entry method of the checkThe conversion code of a ECheckThis complex type records a coupon paymentThe coupon typeThe entry method of the couponThe coupon numberThis complex type records a credit/debit card payment.The masked card account numberThe card token returned by the authorizerThe card type such as Visa, Master etcThe method the card is entered.The authorization code returned by the authorizer.The date and time the card is authorized.The authorization methodThe 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 cardThe account APRThe account APR typeThe promotional APRThe promotional APR typeThe description of the promotionThe duration of the promotionThe authorization settlement dataThe customer signature in encoded SVG format.The additional security info required of a debit cardThis complex type records a gift card paymentThe gift card numberThe authorization code returned by the authorizerThe date and time the gift card is authorizedThe authorization methodA 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 cardThe original balance of the gift cardThe remaining balance of the gift cardThe authorization settlement dataThis complex type records a gift certificate paymentThe gift certificate typeA enum indicating the issue location type.The issuer store idThe gift certificate serial numberThis complex type records a mail bank check refund paymentThe name of the person the check is mailed to.The address the check is mailed to.The personal id type used to verify customer identityThis complex type defines payment information of an order.The sequence no of an order payment record.The payment typethe currency ISO codeThe payment amountThe 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 paymentThis 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 paymentThe agent name the purchase order is sent toThe purchase order numberThis complex type records a store credit paymentThe store credit certificate typeThe 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 stateThe store credit idThe complex type records a travelers check paymentthe check countIt defines a collection of discounts applied to item
units picked up or cancelled in this trausnaction.A collection of discounts applied to item units
picked up or cancelled in this transaction for
this order line item.The collection size.This is the top level CustOrdDisColDesc which is used to communicate discounts.A collection of discounts.The collection size.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 orderTotal 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_saleThe 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_saleThe 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_saleThe linked customer for 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 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.Address used for mail, shipping or deliveryContains the alias for this addressContains 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 locatedContains 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 locatedIndicates the Country name For e.g Brazil,United StatesContains the postal code for the addressID associated to the tax jurisdiction of the
country-state relationship.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 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 promotionThe 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.It defines a collection of tax applied to item
units picked up or cancelled in this trausnaction.A collection of tax applied to item units picked
up or cancelled in this transaction for this
order line item.The collection size.Description is not available.This element corresponds to different RMS tables, depending on the document_type. 'A' -ALLOC_DETAIL.TO_LOC, 'P' - ORDLOC.LOCATION, 'T' - TSFHEAD.TO_LOCSpecified the unique identifier of the purchase order, allocation or transfer.This field holds the master customer order number from OMS.This field holds the number from OMS related to the fulfillment details. One or more fulfillment orders could relate back to a single customer order in OMS.Specified whether the receipt is for an allocation 'A', purchase order 'P', or transfer 'T'. Types 'D' and 'V' are also valid document types that are treated the same as transfers.Contains a reference number for a document associated to the shipment (e.g. Fiscal Document ID for Brazilian based transactions).Used to relate the receipt message to the previous ASN message. this field is required for doc types 'A' and 'T', not required for doc_type 'P'.Description is not available.Description is not available.This fied is required when receiving a transfer or allocation to determine if the receipt is at the 'BL' (BOL) level or 'SK' (SKU) level. It is not used for a PO receipt.Contains the source location of the shipment.Contains the from location type.Description is not available.Denotes the status of the carton received. It can be Actual (A), Dummy (D), or Overage (O). This field is used only for stock order receiving.Contains the carton ID for the shipment.Identifies the location to which the stock order is received.Specifies whether the carton receipt is for a 'R'eceipt, 'T'ranshipment, or 'A'djustment.This field contains the date on which the carton is received.This field holds the externally generated number when the shipment is received at the location.Description is not available.This value is used to determine if the inventory is available or unavailable, based on the code's INV_STATUS value on the INV_STATUS_CODES table.Contains the actual weight of the item received for the carton.Contains the unit of measure of the received weight (e.g. pounds, kilograms).Description is not available.Contains the Schedule Identifier Number.Unique identifier for receiving a group of items. This is usually an RDM-generated unique numerical
identifier for an Appointment.Description is not available.Contains the Receipt Overage InformationDescription is not available.Specifies the item on the allocation, purchase order, or transfer that has been received.Contains the quantity received for the allocation, purchase order, or transfer. The shipment record is
also updated with the quantity received (SHIPSKU.QTY_RECEIVED).Specifies whether the receipt detail line item is for a 'R'eceipt, 'T'ransshipment, or 'A'djustment. For
purchase order receiving, Transshipments are not allowed. For stock order (ie. Allocation and Transfer) receiving, Transshipments are handled the same way as 'R'eceipt type.Identifies the date on which the transaction was written.An externally generated numerical identifier corresponding to the successful reception of the item
at the location.Only used for doc_type of 'P', when the purchase order has an allocation attached to it. This element
specifies the location to which the allocation is being sent.Identifies the carton number for shipments originating from the Advance Shipment Notification
process as carton shipments.Only used for doc_type of 'P', when the purchase order has an allocation attached to it. This element
specifies the allocation id.Only used for doc_type of 'P', when the purchase order has an allocation attached to it. When populated, this value should always be 'A' to specify an allocation.This value is used to determine if the inventory is available or unavailable, based on the code's
INV_STATUS value on the INV_STATUS_CODES table.This value is used to determine inventory availability. It is not used by SIM.Description is not available.Description is not available.Description is not available.Description is not available.Identifies the point of origin for this inventory control document. An originator may be a program (for
automatically generated documents) or a person.Indicates if this carton is a dummy carton. This field is only used for transfer receipts.Indicates if the carton was tampered. This field is only used for transfer receipts.Only used for doc_type of 'P'. Specifies the unit_cost for the item on the order. Cost is converted to the
order's currency before insert/update.Only used for doc_type of 'P'. Updates the number of items expected to be received, originally set by
the ASN process.Contains the actual weight of the item received for the shipment.Contains the unit of measure of the received weight (e.g. pounds, kilograms).Contains the Unit cost and Expenses incurred on an item in a particular transaction.Collection of UIN(s) associated to the item.Contains UIN information.Universal Identification Number.Status associated with the UIN.Contains the Receipt Overage InformationContains purchase order number.Contains the document type information.Contains Advanced Shipment Notice number.Contains Overage Receipt Detail InformationDescription is not available.Unique identifier for the item.Contains the quantity of the item received at the location as overage, damaged etc.Contains the rejection reason code or overage reason code.Collection of UIN(s) associated to the item.Contains UIN information.Universal Identification Number.Status associated with the UIN.Contains the email informationUnique identifier for the emailContains the email type. For ORPOS if the field is not populated, will default to "HOME".Indicates whether this address is the primary contact email address.Contains the email address.Description is not available.Description is not available.It's a referenced element. For detailed description, please refer referenced element doc.This complex type defines a collection of customer order delivery records.A delivery record.The number of CustOrdDelDesc objects.Top-level CustOrderColRef that contains a collection of
customer order references.A collection of customer order references.The collection size.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.Top-level CustOrderRtnColVo that has a collection of
return value objectsA collection of customer order return value
objects.The collection size.A service to manage customer orders. It includes operations to create a customer order, query for customer
orders, pickup/cancel items from a customer order, and return items from customer orders.