POS API Structure
|
| Field Name |
DataType |
Required |
Instances |
Minimum Usage |
Maximum Usage |
Minimum Length |
Maximum Length |
XPath |
Documentation |
| POS |
AnyType |
Yes |
0 |
|
|
|
|
/POS |
|
| |
MessageHeader |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/POS/MessageHeader |
Encapsulates message routing data. The elements included in this grouping are standard across all messages. |
| |
|
Standard |
String |
Yes |
0 |
1 |
1 |
|
10 |
/POS/MessageHeader/Standard |
Code identifying the schema controlling agency, for example, GSI.
Allowable Values: Text string
Required: Yes
Length: 10
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
HeaderVersion |
String |
Yes |
0 |
1 |
1 |
|
10 |
/POS/MessageHeader/HeaderVersion |
Version of the message being used. Each new version whole number represents a significant change from a previous whole version and reflects a need for upgrades. For example, a change from Version 1.X to 2.X represents a substantial change in the framework and would be a recommended upgrade point. A change in the number after the decimal represents a minor upgrade/modification to the framework.
Allowable Values: Text string
Required: Yes
Length: 10
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
VersionReleaseNumber |
String |
Yes |
0 |
1 |
1 |
|
15 |
/POS/MessageHeader/VersionReleaseNumber |
Release number within the current message header version number.
Allowable Values: Text string
Required: No
Length: 15
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
SourceData |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/POS/MessageHeader/SourceData |
Encapsulates data related to the Source or the Sending system. |
| |
|
|
SourceId |
String |
Yes |
0 |
1 |
1 |
|
20 |
/POS/MessageHeader/SourceData/SourceId |
Unique identifier of the System that originated the message. The SourceId is a unique identifier provided by the initiator of the message. For those messages originating from an Order Management System (OMS), it would be the unique OMS identifier. For those messages originating from a Warehouse Management System (WMS), it would be the unique WMS identifier.
Allowable Values: Text string
Required: Yes
Length: 20
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
|
SourceType |
String |
Yes |
0 |
1 |
1 |
|
10 |
/POS/MessageHeader/SourceData/SourceType |
The descriptive category/name/code used to define the system that originated the message.
Allowable Values:
OMS = Order Management System
WMS = Warehouse Management System
Required: Yes
Length: 10
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
DestinationData |
AnyType |
Yes |
1..n |
1 |
-1 |
|
|
/POS/MessageHeader/DestinationData |
Encapsulates data related to the Destination or Receiving system. |
| |
|
|
DestinationId |
String |
Yes |
0 |
1 |
1 |
|
20 |
/POS/MessageHeader/DestinationData/DestinationId |
Unique identifier of the System that is the intended recipient of the message. There can be multiple DestinationId/DestinationType sets per message to allow for one message to be sent to multiple receiving systems.
Allowable Values: Text string
Required: Yes
Length: 20
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
|
DestinationType |
String |
Yes |
0 |
1 |
1 |
|
10 |
/POS/MessageHeader/DestinationData/DestinationType |
The descriptive category used to define the system that is the intended recipient of the message.
Allowable Values:
OMS = Order Management System,
WMS = Warehouse Management System,
FH= Fulfillment Hub.
Required: Yes
Length: 10
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
EventType |
String |
Yes |
0 |
1 |
1 |
|
35 |
/POS/MessageHeader/EventType |
The name of the event to which the message pertains.
Allowable Values: Varies depending on the feed, for example InventoryStatus
Required: Yes
Length: 35
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore. |
| |
|
MessageData |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/POS/MessageHeader/MessageData |
Encapsulates message identification information. |
| |
|
|
MessageId |
String |
Yes |
0 |
1 |
1 |
|
20 |
/POS/MessageHeader/MessageData/MessageId |
Globally unique identifier for each Message. The Message ID is populated from the Source system and must be a global identifier for Radial Xchange.
Allowable Values: Text string
Required: Yes
Length: 20
Default Value: blank
Restrictions: In cases when the Product Hub or Fulfillment Hub originates the message, this field is the unique Business Process ID (BPID).
Aliases: N/AXchange. |
| |
|
|
CorrelationId |
String |
No |
0 |
0 |
1 |
|
20 |
/POS/MessageHeader/MessageData/CorrelationId |
When present, it must contain the MessageId value of an earlier Radial Xchange Message to which this message relates.
Allowable Values: Text string
Required: No
Length: 20
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
CreateDateAndTime |
|
Yes |
0 |
1 |
1 |
|
|
/POS/MessageHeader/CreateDateAndTime |
Original message creation date and time assigned by the Source. Follows ISO 8601 standard with offset from UTC.
Allowable Values: Text string
Required: No
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
Order |
AnyType |
Yes |
1..n |
1 |
-1 |
|
|
/POS/Order |
|
| |
|
OrderHeader |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/POS/Order/OrderHeader |
|
| |
|
|
gsi_client_id |
String |
Yes |
0 |
1 |
1 |
|
32 |
/POS/Order/OrderHeader/gsi_client_id |
The Radial-assigned value that specifies the client organization providing data.
Allowable Values: Text string
Required: Yes
Length: 32
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
gsi_store_id |
String |
Yes |
0 |
1 |
1 |
|
32 |
/POS/Order/OrderHeader/gsi_store_id |
Radial-assigned value that specifies the store ID of the client’s web store.
Allowable Values: Text string
Required: Yes
Length: 32
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
InvoiceType |
String |
Yes |
0 |
1 |
1 |
|
20 |
/POS/Order/OrderHeader/InvoiceType |
The transaction type that identifies the invoice event.
Allowable Values: SHIPMENT; RETURN; CREDIT_MEMO; DEBIT_MEMO
Required: Yes
Length: 20
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
OMSOrderNumber |
|
Yes |
0 |
1 |
1 |
|
|
/POS/Order/OrderHeader/OMSOrderNumber |
12-digit Radial order number used in the Radial OMS.
Allowable Values: Text string
Required: Yes
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
ReleaseSequence |
|
No |
0 |
0 |
1 |
|
|
/POS/Order/OrderHeader/ReleaseSequence |
A sequence number assigned to each transactional event.
Allowable Values: 001-999
Required: No
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
OMSOrderID |
|
No |
0 |
0 |
1 |
|
|
/POS/Order/OrderHeader/OMSOrderID |
15-digit Radial OMS order number and release sequence.
Allowable Values: Integer
Required: No
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
ShipmentNumber |
String |
No |
0 |
0 |
1 |
|
40 |
/POS/Order/OrderHeader/ShipmentNumber |
The unique Radial OMS shipment number.
Allowable Values: Text string
Required: No
Length: 40
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
ExternalShipmentId |
String |
No |
0 |
0 |
1 |
|
40 |
/POS/Order/OrderHeader/ExternalShipmentId |
An ID for the order/shipment provided by the fulfiller.
Allowable Values: Text string
Required: No
Length: 40
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
InvoiceNumber |
String |
Yes |
0 |
1 |
1 |
|
40 |
/POS/Order/OrderHeader/InvoiceNumber |
Unique Radial OMS invoice number.
Allowable Values: Text string
Required: Yes
Length: 40
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
VATInvoiceNumber |
String |
No |
0 |
0 |
1 |
|
256 |
/POS/Order/OrderHeader/VATInvoiceNumber |
The VAT Invoice number generated in OMS to identify VAT for the given release.
Allowable Values: Integer
Required: No
Length: 256
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
WebOrderNumber |
String |
No |
0 |
0 |
1 |
|
30 |
/POS/Order/OrderHeader/WebOrderNumber |
The number assigned to the order by the web store.
Allowable Values: Text string
Required: No
Length: 30
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
CustomerOrderID |
String |
No |
0 |
0 |
1 |
|
30 |
/POS/Order/OrderHeader/CustomerOrderID |
The order ID that the customer is aware of. Typically this is the web store order ID.
Allowable Values: Text string
Required: No
Length: 30
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
OrderEntryDateTime |
|
Yes |
0 |
1 |
1 |
|
|
/POS/Order/OrderHeader/OrderEntryDateTime |
The date and time that the order was submitted at the web store or other order entry point.
Allowable Values: Date in the format = yyyy-mm-ddThh:mm:ss-hh:mm standard with offset from GMT/UTC.
Required: Yes
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
FacilityID |
String |
No |
0 |
0 |
1 |
|
32 |
/POS/Order/OrderHeader/FacilityID |
The Radial-assigned string specifying the facility housing the goods, typically a distribution center or physical warehouse.
Allowable Values: Text string
Required: No
Length: 32
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
ExternalFacilityID |
String |
No |
0 |
0 |
1 |
|
32 |
/POS/Order/OrderHeader/ExternalFacilityID |
Alternate external identifier used by the fulfiller.
Typical use is Client Retail Store ID
Allowable Values: Text string
Required: No
Length: 32
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
ShipDateTime |
|
No |
0 |
0 |
1 |
|
|
/POS/Order/OrderHeader/ShipDateTime |
The date and time that the shipment was processed by the fulfiller.
Allowable Values: Date in format = yyyy-mm-ddThh:mm:ss-hh:mm standard with offset from GMT/UTC.
Required: No
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
ReturnDateTime |
|
No |
0 |
0 |
1 |
|
|
/POS/Order/OrderHeader/ReturnDateTime |
The date and time that the return was processedr.
Allowable Values: Date in format = yyyy-mm-ddThh:mm:ss-hh:mm standard with offset from GMT/UTC.
Required: No
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
ReturnOrderId |
String |
No |
0 |
0 |
1 |
|
30 |
/POS/Order/OrderHeader/ReturnOrderId |
The identifier assigned to the return transaction from the client.
Allowable Values: Text string
Required: No
Length: 30
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
InvoiceDateTime |
|
Yes |
0 |
1 |
1 |
|
|
/POS/Order/OrderHeader/InvoiceDateTime |
The date and time that the invoice was created in the OMSr.
Allowable Values: Date in format = yyyy-mm-ddThh:mm:ss-hh:mm standard with offset from GMT/UTC.
Required: No
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
InvoiceAmount |
AnyType |
No |
0 |
0 |
1 |
|
|
/POS/Order/OrderHeader/InvoiceAmount |
|
| |
|
|
|
Amount |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/POS/Order/OrderHeader/InvoiceAmount/Amount |
|
| |
|
|
|
|
AmountType |
String |
Yes |
0 |
1 |
1 |
|
40 |
/POS/Order/OrderHeader/InvoiceAmount/Amount/AmountType |
Defines the invoice amount type included in the MonetaryAmount element.
Allowable Values: Text string
Required: Yes
Length: 40
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
MonetaryAmount |
Decimal |
Yes |
0 |
1 |
1 |
|
|
/POS/Order/OrderHeader/InvoiceAmount/Amount/MonetaryAmount |
The monetary amount for the defined invoice amount type.
Allowable Values: Decimal
Required: Yes
Length: 16.5
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
CurrencyCode |
String |
Yes |
0 |
1 |
1 |
|
3 |
/POS/Order/OrderHeader/InvoiceAmount/Amount/CurrencyCode |
The currency code for amounts in the order line.
Allowable Values: ISO 4217 currency code.
Required: Yes
Length: 3
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
Locale |
String |
Yes |
0 |
1 |
1 |
|
5 |
/POS/Order/OrderHeader/Locale |
The locale code provided or selected when the order was placed. The locale defines the language and country rules to be applied to the data.
Allowable Values: The format is "ll_CC" where ll is the language argument and is a valid ISO language code. These codes are the lower case, two letter codes as defined by ISO_639. CC is the upper case, two letter codes as defined by ISO 3166 country code.
Required: Yes
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
BillTo |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/POS/Order/OrderHeader/BillTo |
|
| |
|
|
|
CustomerId |
String |
No |
0 |
0 |
1 |
|
40 |
/POS/Order/OrderHeader/BillTo/CustomerId |
The customer account number typically provided by the web store.
Allowable Values: Text string
Required: No
Length: 40
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
Title |
String |
No |
0 |
0 |
1 |
|
10 |
/POS/Order/OrderHeader/BillTo/Title |
A title you can assign to a person. Typically "Dr.", "Mr.", "Ms." etc.
Allowable Values: Text string.
Required: No
Length: 10
Default Value: blank
Restrictions: N/A
Aliases: Salutation |
| |
|
|
|
FirstName |
String |
Yes |
0 |
1 |
1 |
|
64 |
/POS/Order/OrderHeader/BillTo/FirstName |
The first name of the person.
Allowable Values: Text string.
Required: Yes
Length: 64
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
MiddleName |
String |
No |
0 |
0 |
1 |
|
64 |
/POS/Order/OrderHeader/BillTo/MiddleName |
The middle name or names of the person.
Allowable Values: Text string.
Required: No
Length: 40
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
LastName |
String |
No |
0 |
0 |
1 |
|
64 |
/POS/Order/OrderHeader/BillTo/LastName |
The surname of the person.
Allowable Values: Text string.
Required: Yes
Length: 64
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
Suffix |
String |
No |
0 |
0 |
1 |
|
40 |
/POS/Order/OrderHeader/BillTo/Suffix |
An additional modifier at the end of a person's name, for example, "Jr."
Allowable Values: Text string.
Required: Yes
Length: 40
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
EmailAddress |
String |
No |
0 |
0 |
1 |
|
150 |
/POS/Order/OrderHeader/BillTo/EmailAddress |
The email address associated with a person or enterprise.
Allowable Values: Text string
Required: No
Length: 150
Default Value: blank
Restrictions: Must be a valid email address
Alieases: N/A |
| |
|
|
|
Address |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/POS/Order/OrderHeader/BillTo/Address |
|
| |
|
|
|
|
CompanyName |
String |
No |
0 |
0 |
1 |
|
50 |
/POS/Order/OrderHeader/BillTo/Address/CompanyName |
Organization or Business to which the person belongs.
Allowable Values: Text string
Required: No
Length: 50
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
|
|
|
AddressLine1 |
String |
Yes |
0 |
1 |
1 |
|
70 |
/POS/Order/OrderHeader/BillTo/Address/AddressLine1 |
The "AddressLine#" components contain the street address and, if necessary, suite and building identifiers for the physical address.
Allowable Values: Text string
Required: Line1 is required. Other Line# components are optional.
Length: 70
Default Value: blank
Restrictions: For U.S. addresses, the last Line# component valued before the U.S. state must contain the number and street. Additional address information, such as a building name or a department mustt precede it.
Aliases: N/A |
| |
|
|
|
|
AddressLine2 |
String |
No |
0 |
0 |
1 |
|
70 |
/POS/Order/OrderHeader/BillTo/Address/AddressLine2 |
|
| |
|
|
|
|
AddressLine3 |
String |
No |
0 |
0 |
1 |
|
70 |
/POS/Order/OrderHeader/BillTo/Address/AddressLine3 |
|
| |
|
|
|
|
City |
String |
Yes |
0 |
1 |
1 |
|
35 |
/POS/Order/OrderHeader/BillTo/Address/City |
Name of the city.
Allowable Values: Text string
Required: Yes
Length: 35
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
StateOrProvince |
String |
No |
0 |
0 |
1 |
|
35 |
/POS/Order/OrderHeader/BillTo/Address/StateOrProvince |
The state, province or other country sub-division code for the store address.
Allowable Values: ISO 3166-2 country sub-division code.
Required: No
Length: 35
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
CountyOrLocality |
String |
No |
0 |
0 |
1 |
|
35 |
/POS/Order/OrderHeader/BillTo/Address/CountyOrLocality |
Additional information about the address, such as a county or township.
Allowable Values: Text string
Required: No
Length: 35
Default Value: blank
Restrictions: N/A
Aliases: N/A. |
| |
|
|
|
|
CountryCode |
String |
Yes |
0 |
1 |
1 |
|
3 |
/POS/Order/OrderHeader/BillTo/Address/CountryCode |
The country code for the store address.
Allowable Values: ISO 3166 alpha-2 country code.
Required: Yes
Length: 3
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
PostalCode |
String |
No |
0 |
0 |
1 |
|
35 |
/POS/Order/OrderHeader/BillTo/Address/PostalCode |
Typically, the string of letters and/or numbers that more closely specifies the delivery area than just the City component alone, for example, the Zip Code in the U.S.
Allowable Values: Text string
Required: No
Length: 35
Default Value: blank
Restrictions: N/A
Aliases: N/A. |
| |
|
|
|
Telephone |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/POS/Order/OrderHeader/BillTo/Telephone |
|
| |
|
|
|
|
TelephoneType |
String |
No |
0 |
0 |
1 |
|
18 |
/POS/Order/OrderHeader/BillTo/Telephone/TelephoneType |
|
| |
|
|
|
|
FullTelephoneNumber |
String |
No |
0 |
0 |
1 |
|
20 |
/POS/Order/OrderHeader/BillTo/Telephone/FullTelephoneNumber |
|
| |
|
|
LoyaltyAccountNumber |
String |
No |
0 |
0 |
1 |
|
25 |
/POS/Order/OrderHeader/LoyaltyAccountNumber |
The loyalty account number assigned to the customer.
Allowable Values: Text string
Required: No
Length: 25
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
OrderType |
String |
Yes |
0 |
1 |
1 |
|
20 |
/POS/Order/OrderHeader/OrderType |
Identifies the application type used for order placement.
examples are web, OMS, catalog
Allowable Values: Text string
Required: Yes
Length: 20
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
CatalogSourceCode |
String |
No |
0 |
0 |
1 |
|
15 |
/POS/Order/OrderHeader/CatalogSourceCode |
Identifies the paper catalog used to place the order.
Allowable Values: Text string
Required: No
Length: 15
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
AssociateName |
String |
No |
0 |
0 |
1 |
|
150 |
/POS/Order/OrderHeader/AssociateName |
The name of the store employee that placed the order using the Associate Order System application.
Allowable Values: Text string
Required: No
Length: 150
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
AssociateNumber |
String |
No |
0 |
0 |
1 |
|
20 |
/POS/Order/OrderHeader/AssociateNumber |
The identifier for the store employee that placed the order using the Associate Order System application.
Allowable Values: Text string
Required: No
Length: 20
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
AssociateStore |
String |
No |
0 |
0 |
1 |
|
20 |
/POS/Order/OrderHeader/AssociateStore |
The identifier for the retail store that placed the order using the Associate Ordering System application.
Allowable Values: Text string
Required: No
Length: 20
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
OriginalOMSOrderNumber |
|
No |
0 |
0 |
1 |
|
|
/POS/Order/OrderHeader/OriginalOMSOrderNumber |
OMS original order number used for returns.
Allowable Values: Text string
Required: No
Length: 12
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
ReasonCode |
String |
No |
0 |
0 |
1 |
|
3 |
/POS/Order/OrderHeader/ReasonCode |
The order-level ustomer reason code for return or price modification.
Allowable Values: Text string
Required: No
Length: 3
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
ExtendedAttributes |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/POS/Order/OrderHeader/ExtendedAttributes |
|
| |
|
|
|
Name |
String |
No |
0 |
0 |
1 |
|
30 |
/POS/Order/OrderHeader/ExtendedAttributes/Name |
The short title of the additional attribute.
Allowable Values: Text string
Required: No
Length: 30
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
Description |
String |
No |
0 |
0 |
1 |
|
100 |
/POS/Order/OrderHeader/ExtendedAttributes/Description |
A brief description of the additional attribute.
Allowable Values: Text string
Required: No
Length: 100
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
Value |
String |
No |
0 |
0 |
1 |
|
100 |
/POS/Order/OrderHeader/ExtendedAttributes/Value |
The specific value of the additional attribute.
Allowable Values: Text string
Required: No
Length: 100
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
HeaderCharges |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/POS/Order/OrderHeader/HeaderCharges |
|
| |
|
|
|
ChargeCategory |
String |
Yes |
0 |
1 |
1 |
|
20 |
/POS/Order/OrderHeader/HeaderCharges/ChargeCategory |
Defines the type of header charge included in the MonetaryAmount element.
Allowable Values: Text string
Required: Yes
Length: 20
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
MonetaryAmount |
Decimal |
Yes |
0 |
1 |
1 |
|
|
/POS/Order/OrderHeader/HeaderCharges/MonetaryAmount |
The monetary amount for the defined header charge type.
Allowable Values: Decimal
Required: No
Length: 16.5
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
CurrencyCode |
String |
Yes |
0 |
1 |
1 |
|
3 |
/POS/Order/OrderHeader/HeaderCharges/CurrencyCode |
The code that represents the type of currency being used for a transaction.
Allowable Values: IS-4217 three-letter code.
Required: Only when a transaction amount is specified..
Length: 3
Default Value: blank
Restrictions: .Currency codes are defined by ISO 4217:2008 See: http://en.wikipedia.org/wiki/ISO_4217
Aliases: N/A |
| |
|
|
|
ChargeName |
String |
No |
0 |
0 |
1 |
|
40 |
/POS/Order/OrderHeader/HeaderCharges/ChargeName |
The name of LineCharge or HeaderCharge. Charge Category and Charge Name together make a unique key for any line/header charge.
Allowable Values: Text string
Required: No
Length: 40
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
OriginalInvoiceNumber |
String |
No |
0 |
0 |
1 |
|
40 |
/POS/Order/OrderHeader/HeaderCharges/OriginalInvoiceNumber |
Invoice from the original purchase. Used to track an order in the event of a return.
Allowable Values: Text string
Required: No
Length: 40
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
OriginalOMSOrderID |
|
No |
0 |
0 |
1 |
|
|
/POS/Order/OrderHeader/HeaderCharges/OriginalOMSOrderID |
OMS Order ID from the original purchase. Used to track an order in the event of a return.
Allowable Values: Integer
Required: No
Length: 15
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
OriginalReleaseNumber |
|
No |
0 |
0 |
1 |
|
|
/POS/Order/OrderHeader/HeaderCharges/OriginalReleaseNumber |
Release number from the original purchase. Used to track an order in the event of a return.
Allowable Values: Integer
Required: No
Length: 3
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
OriginalInvoiceDateTime |
|
No |
0 |
0 |
1 |
|
|
/POS/Order/OrderHeader/HeaderCharges/OriginalInvoiceDateTime |
Invoice date and time from the original purchase. Used to track an order in the event of a return.
Allowable Values: Date. ISO 8601 standard with offset from UTC in datetime data format which is yyyy-mm-ddTHH:mm:ss-hh:mm for e.g. 2012-01-11T14:19:05-06:00.
Required: No
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
HeaderChargeTax |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/POS/Order/OrderHeader/HeaderChargeTax |
|
| |
|
|
|
TaxType |
String |
Yes |
0 |
1 |
1 |
|
20 |
/POS/Order/OrderHeader/HeaderChargeTax/TaxType |
The type of tax being imposed.
Allowable Values: Text string. Common values: Sales; VAT
Required: Yes
Length: 20
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
Exemption |
String |
Yes |
0 |
1 |
1 |
|
1 |
/POS/Order/OrderHeader/HeaderChargeTax/Exemption |
Specifies that the customer is exempt from paying taxes for the order.
Allowable Values:
Y - Customer is exempt from paying taxes
N - Customer is not exempt from paying taxes
Required: Yes
Length: 1
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
Situs |
String |
Yes |
0 |
1 |
1 |
|
30 |
/POS/Order/OrderHeader/HeaderChargeTax/Situs |
The order address type used to determine the taxing jurisdiction.
Allowable Values: Text string. Ccommon value = DESTINATION; PHYSICAL_ORIGIN
Required: Yes
Length: 30
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
Jurisdiction |
String |
No |
0 |
0 |
1 |
|
100 |
/POS/Order/OrderHeader/HeaderChargeTax/Jurisdiction |
The name of the taxing jurisdiction.
Allowable Values: Text string
Required: No
Length: 100
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
JurisdictionLevel |
String |
No |
0 |
0 |
1 |
|
40 |
/POS/Order/OrderHeader/HeaderChargeTax/JurisdictionLevel |
The level within the jurisdiction that the tax applies to.
Allowable Values: Text string. Common values = Country; State; County; City
Required: No
Length: 40
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
JurisdictionId |
|
No |
0 |
0 |
1 |
|
|
/POS/Order/OrderHeader/HeaderChargeTax/JurisdictionId |
The unique number that identifies a jurisdiction. This value is assigned by the Vertex tax application.
Allowable Values: Text string
Required: No
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
Imposition |
String |
No |
0 |
0 |
1 |
|
60 |
/POS/Order/OrderHeader/HeaderChargeTax/Imposition |
The name of the imposition to which the relevant tax rule belongs. This is assigned either by Vertex or by the user when setting up a user-defined imposition in Vertex.
Allowable Values: Text string
Required: No
Length: 60
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
ImpositionType |
String |
No |
0 |
0 |
1 |
|
60 |
/POS/Order/OrderHeader/HeaderChargeTax/ImpositionType |
The type description assigned to the imposition. When multiple impositions are imposed within a jurisdiction, each must have a different type. This is assigned either by Vertex or by the user when setting up a user-defined imposition in Vertex.
Allowable Values: Text string
Required: No
Length: 60
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
TaxRate |
Decimal |
No |
0 |
0 |
1 |
|
|
/POS/Order/OrderHeader/HeaderChargeTax/TaxRate |
The tax rate percentage that is being applied to the basis amount.
Allowable Values: Decimal
Required: No
Length: 8.5
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
BasisAmount |
Decimal |
No |
0 |
0 |
1 |
|
|
/POS/Order/OrderHeader/HeaderChargeTax/BasisAmount |
The amount of the line for which the tax is applicable.
Allowable Values: Decimal
Required: No
Length: 16.5
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
TransactionalTaxAmount |
Decimal |
Yes |
0 |
1 |
1 |
|
|
/POS/Order/OrderHeader/HeaderChargeTax/TransactionalTaxAmount |
The monetary amount of sales tax calculated by applying a set percentage to the line item. These percentages can vary by county, state and country.
Allowable Values: Decimal
Required: No
Length: 16.5
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
ChargeCategory |
String |
Yes |
0 |
1 |
1 |
|
20 |
/POS/Order/OrderHeader/HeaderChargeTax/ChargeCategory |
The different categories of items/services for which the tax was charged.
Allowable Values: Text string
Required: No
Length: 20
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
ChargeName |
String |
No |
0 |
0 |
1 |
|
40 |
/POS/Order/OrderHeader/HeaderChargeTax/ChargeName |
The name of LineCharge or HeaderCharge. Charge Category and Charge Name together make a unique key for any line/header charge. |
| |
|
|
OrderLineRelationships |
AnyType |
No |
0 |
0 |
1 |
|
|
/POS/Order/OrderHeader/OrderLineRelationships |
Container for OrderLineRelationships. |
| |
|
|
|
OrderLineRelationship |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/POS/Order/OrderHeader/OrderLineRelationships/OrderLineRelationship |
Defines the relationship between a parent line and its child lines. |
| |
|
|
|
|
RelationshipType |
String |
Yes |
0 |
1 |
1 |
|
40 |
/POS/Order/OrderHeader/OrderLineRelationships/OrderLineRelationship/RelationshipType |
Defines the type of relationship between the parent line and a child line. E.g. WARRANTY, INSTALL, CUSTOM, ACCESSORY
Allowable Values: Text string
Required: Yes
Length: 40
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
ParentLine |
|
Yes |
0 |
1 |
1 |
|
|
/POS/Order/OrderHeader/OrderLineRelationships/OrderLineRelationship/ParentLine |
Indicates the parent line number of the order.
Allowable Values: Integer
Required: Yes
Length: 5
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
ChildLine |
|
Yes |
0 |
1 |
1 |
|
|
/POS/Order/OrderHeader/OrderLineRelationships/OrderLineRelationship/ChildLine |
Indicates the child line number of the order.
Allowable Values: Integer
Required: Yes
Length: 5
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
OrderTenders |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/POS/Order/OrderTenders |
|
| |
|
|
PaymentReference |
String |
Yes |
0 |
1 |
1 |
|
30 |
/POS/Order/OrderTenders/PaymentReference |
Defines the payment reference for tender type.
Allowable Values: Text string. Common values = GS, GC, CC, BR
Required: Yes
Length: 30
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
TenderType |
String |
Yes |
0 |
1 |
1 |
|
30 |
/POS/Order/OrderTenders/TenderType |
Sub tender type code or OMS Credit Card Type
Allowable Values: Text string. Common values = VISA; AMEX, MC, FV
Required: Yes
Length: 30
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
TenderAmount |
Decimal |
Yes |
0 |
1 |
1 |
|
|
/POS/Order/OrderTenders/TenderAmount |
Amount tendered to the transaction for the tender type and account number.
Allowable Values: Decimal
Required: Yes
Length: 16.5
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
TenderAmountInPoints |
Decimal |
No |
0 |
0 |
1 |
|
|
/POS/Order/OrderTenders/TenderAmountInPoints |
Indicates the equivalent of Total Charged Points redeemed.
Allowable Values: Integer
Required: No
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
CurrencyCode |
String |
No |
0 |
0 |
1 |
|
3 |
/POS/Order/OrderTenders/CurrencyCode |
The code that represents the type of currency being used for a transaction.
Allowable Values: IS-4217 three-letter code.
Required: Only when a transaction amount is specified..
Length: 3
Default Value: blank
Restrictions: .Currency codes are defined by ISO 4217:2008 See: http://en.wikipedia.org/wiki/ISO_4217 |
| |
|
|
PurchaseOrderNumber |
String |
No |
0 |
0 |
1 |
|
100 |
/POS/Order/OrderTenders/PurchaseOrderNumber |
Defines the PO Number when the "PO" is used as tender.
Allowable Values: Text string
Required: No
Length: 100
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
AccountNumber |
String |
No |
0 |
0 |
1 |
|
40 |
/POS/Order/OrderTenders/AccountNumber |
Customer Account number when Check is used as a tender or Customer Sold To Account Number when the "PO" is used as a tender. . This value is typically masked in this feed.
Allowable Values: Text string
Required: No
Length: 40
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
AccountExpirationDate |
|
No |
0 |
0 |
1 |
|
|
/POS/Order/OrderTenders/AccountExpirationDate |
Expiration date of the card or account (MMYY). This is in a number format not in date. E.g. 1115, 314.
Allowable Values: Integer
Required: No
Length: 4
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
PIN |
|
No |
0 |
0 |
1 |
|
|
/POS/Order/OrderTenders/PIN |
The Personal Identification Number for the gift card.
Allowable Values: Integer
Required: No
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
AdditionalPaymentDetails |
AnyType |
No |
0 |
0 |
1 |
|
|
/POS/Order/OrderTenders/AdditionalPaymentDetails |
Additional Payment information. |
| |
|
|
|
PaymentReference1 |
String |
No |
0 |
0 |
1 |
|
100 |
/POS/Order/OrderTenders/AdditionalPaymentDetails/PaymentReference1 |
Defines the additional payment reference in case of the Market Place tender types.
Allowable Values: Text string. Common values = GS, GC, CC, BR
Required: No
Length: 100
Default Value: blank
Restrictions: N/A
Aliases: N/A for e.g. PaymentReference is BR, TenderType is CC and PaymentReference1 is VISA. |
| |
|
|
|
PaymentReference2 |
String |
No |
0 |
0 |
1 |
|
100 |
/POS/Order/OrderTenders/AdditionalPaymentDetails/PaymentReference2 |
Additional reference value for the Payment information. |
| |
|
|
|
PaymentReference3 |
String |
No |
0 |
0 |
1 |
|
100 |
/POS/Order/OrderTenders/AdditionalPaymentDetails/PaymentReference3 |
Additional reference value for the Payment information. for e.g. PLCC |
| |
|
|
|
DisplayCreditCardNumber |
String |
No |
0 |
0 |
1 |
|
30 |
/POS/Order/OrderTenders/AdditionalPaymentDetails/DisplayCreditCardNumber |
Tokenized and Masked value for the Payment information.
Allowable Values: Text string
Required: No
Length: 30
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
AuthCode |
String |
No |
0 |
0 |
1 |
|
100 |
/POS/Order/OrderTenders/AdditionalPaymentDetails/AuthCode |
Authorization Code for payment.
Allowable Values: Text string
Required: No
Length: 100
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
ExtendedAttributes |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/POS/Order/OrderTenders/ExtendedAttributes |
|
| |
|
|
|
Name |
String |
No |
0 |
0 |
1 |
|
30 |
/POS/Order/OrderTenders/ExtendedAttributes/Name |
The short title of the additional attribute.
Allowable Values: Text string
Required: No
Length: 30
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
Description |
String |
No |
0 |
0 |
1 |
|
100 |
/POS/Order/OrderTenders/ExtendedAttributes/Description |
A brief description of the additional attribute.
Allowable Values: Text string
Required: No
Length: 100
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
Value |
String |
No |
0 |
0 |
1 |
|
100 |
/POS/Order/OrderTenders/ExtendedAttributes/Value |
The specific value of the additional attribute.
Allowable Values: Text string
Required: No
Length: 100
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
OrderDetail |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/POS/Order/OrderDetail |
|
| |
|
|
LineNumber |
|
Yes |
0 |
1 |
1 |
|
|
/POS/Order/OrderDetail/LineNumber |
OMS line sequence number.
Allowable Values: Integer
Required: Yes
Length: 4
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
ReshipFlag |
|
Yes |
0 |
1 |
1 |
|
|
/POS/Order/OrderDetail/ReshipFlag |
Indicates if the line is a is a reship.
Allowable Values:
true - line is a reship
false - line is not a reship
Required: Yes
Length: TBD
Default Value: false
Restrictions: N/A
Aliases: N/A |
| |
|
|
OriginalInvoiceNumber |
String |
No |
0 |
0 |
1 |
|
40 |
/POS/Order/OrderDetail/OriginalInvoiceNumber |
|
| |
|
|
OriginalOMSOrderID |
|
No |
0 |
0 |
1 |
|
|
/POS/Order/OrderDetail/OriginalOMSOrderID |
|
| |
|
|
OriginalReleaseNumber |
|
No |
0 |
0 |
1 |
|
|
/POS/Order/OrderDetail/OriginalReleaseNumber |
Orignal Realease Number |
| |
|
|
OriginalInvoiceDateTime |
|
No |
0 |
0 |
1 |
|
|
/POS/Order/OrderDetail/OriginalInvoiceDateTime |
|
| |
|
|
Shipment |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/POS/Order/OrderDetail/Shipment |
|
| |
|
|
|
TrackingNumber |
String |
No |
0 |
0 |
1 |
|
40 |
/POS/Order/OrderDetail/Shipment/TrackingNumber |
Description: The tracking number assigned to the package by the carrier.
Allowable Values: Text string
Required: No
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
CartonId |
String |
No |
0 |
0 |
1 |
|
40 |
/POS/Order/OrderDetail/Shipment/CartonId |
The carton number of the shipment.
Allowable Values: Text string
Required: No
Length: 40
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
SerialNumberData |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/POS/Order/OrderDetail/Shipment/SerialNumberData |
Gift card serial number information. |
| |
|
|
|
|
SerialNumberSequence |
String |
No |
0 |
0 |
1 |
|
4 |
/POS/Order/OrderDetail/Shipment/SerialNumberData/SerialNumberSequence |
The sequence number of the gift card.
Allowable Values: Text string
Required: No
Length: 4
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
SerialNumber |
String |
No |
0 |
0 |
1 |
|
120 |
/POS/Order/OrderDetail/Shipment/SerialNumberData/SerialNumber |
The unique serial number of the gift card.
Allowable Values: Text string
Required: No
Length: 120
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
GiftCardId |
String |
No |
0 |
0 |
1 |
|
30 |
/POS/Order/OrderDetail/Shipment/SerialNumberData/GiftCardId |
The unique card number of the gift card.
Allowable Values: Text string
Required: No
Length: 30
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
ShipTo |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/POS/Order/OrderDetail/ShipTo |
|
| |
|
|
|
CustomerId |
String |
No |
0 |
0 |
1 |
|
40 |
/POS/Order/OrderDetail/ShipTo/CustomerId |
The customer account number typically provided by the web store.
Allowable Values: Text string
Required: No
Length: 40
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
Title |
String |
No |
0 |
0 |
1 |
|
10 |
/POS/Order/OrderDetail/ShipTo/Title |
A title you can assign to a person. Typically "Dr.", "Mr.", "Ms." etc.
Allowable Values: Text string.
Required: No
Length: 10
Default Value: blank
Restrictions: N/A
Aliases: Salutation |
| |
|
|
|
FirstName |
String |
Yes |
0 |
1 |
1 |
|
64 |
/POS/Order/OrderDetail/ShipTo/FirstName |
The first name of the person.
Allowable Values: Text string.
Required: Yes
Length: 64
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
MiddleName |
String |
No |
0 |
0 |
1 |
|
64 |
/POS/Order/OrderDetail/ShipTo/MiddleName |
The middle name or names of the person.
Allowable Values: Text string.
Required: No
Length: 40
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
LastName |
String |
No |
0 |
0 |
1 |
|
64 |
/POS/Order/OrderDetail/ShipTo/LastName |
The surname of the person.
Allowable Values: Text string.
Required: Yes
Length: 64
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
Suffix |
String |
No |
0 |
0 |
1 |
|
40 |
/POS/Order/OrderDetail/ShipTo/Suffix |
An additional modifier at the end of a person's name, for example, "Jr."
Allowable Values: Text string.
Required: Yes
Length: 40
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
EmailAddress |
String |
No |
0 |
0 |
1 |
|
150 |
/POS/Order/OrderDetail/ShipTo/EmailAddress |
The email address associated with a person or enterprise.
Allowable Values: Text string
Required: No
Length: 150
Default Value: blank
Restrictions: Must be a valid email address
Alieases: N/A |
| |
|
|
|
Address |
AnyType |
No |
0 |
0 |
1 |
|
|
/POS/Order/OrderDetail/ShipTo/Address |
|
| |
|
|
|
|
CompanyName |
String |
No |
0 |
0 |
1 |
|
50 |
/POS/Order/OrderDetail/ShipTo/Address/CompanyName |
Organization or Business to which the person belongs.
Allowable Values: Text string
Required: No
Length: 50
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
|
|
|
AddressLine1 |
String |
Yes |
0 |
1 |
1 |
|
70 |
/POS/Order/OrderDetail/ShipTo/Address/AddressLine1 |
The "AddressLine#" components contain the street address and, if necessary, suite and building identifiers for the physical address.
Allowable Values: Text string
Required: Line1 is required. Other Line# components are optional.
Length: 70
Default Value: blank
Restrictions: For U.S. addresses, the last Line# component valued before the U.S. state must contain the number and street. Additional address information, such as a building name or a department mustt precede it.
Aliases: N/A |
| |
|
|
|
|
AddressLine2 |
String |
No |
0 |
0 |
1 |
|
70 |
/POS/Order/OrderDetail/ShipTo/Address/AddressLine2 |
|
| |
|
|
|
|
AddressLine3 |
String |
No |
0 |
0 |
1 |
|
70 |
/POS/Order/OrderDetail/ShipTo/Address/AddressLine3 |
|
| |
|
|
|
|
City |
String |
Yes |
0 |
1 |
1 |
|
35 |
/POS/Order/OrderDetail/ShipTo/Address/City |
Name of the city.
Allowable Values: Text string
Required: Yes
Length: 35
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
StateOrProvince |
String |
No |
0 |
0 |
1 |
|
35 |
/POS/Order/OrderDetail/ShipTo/Address/StateOrProvince |
The state, province or other country sub-division code for the store address.
Allowable Values: ISO 3166-2 country sub-division code.
Required: No
Length: 35
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
CountyOrLocality |
String |
No |
0 |
0 |
1 |
|
35 |
/POS/Order/OrderDetail/ShipTo/Address/CountyOrLocality |
Additional information about the address, such as a county or township.
Allowable Values: Text string
Required: No
Length: 35
Default Value: blank
Restrictions: N/A
Aliases: N/A. |
| |
|
|
|
|
CountryCode |
String |
Yes |
0 |
1 |
1 |
|
3 |
/POS/Order/OrderDetail/ShipTo/Address/CountryCode |
The country code for the store address.
Allowable Values: ISO 3166 alpha-2 country code.
Required: Yes
Length: 3
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
PostalCode |
String |
No |
0 |
0 |
1 |
|
35 |
/POS/Order/OrderDetail/ShipTo/Address/PostalCode |
Typically, the string of letters and/or numbers that more closely specifies the delivery area than just the City component alone, for example, the Zip Code in the U.S.
Allowable Values: Text string
Required: No
Length: 35
Default Value: blank
Restrictions: N/A
Aliases: N/A. |
| |
|
|
|
Telephone |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/POS/Order/OrderDetail/ShipTo/Telephone |
|
| |
|
|
|
|
TelephoneType |
String |
No |
0 |
0 |
1 |
|
18 |
/POS/Order/OrderDetail/ShipTo/Telephone/TelephoneType |
|
| |
|
|
|
|
FullTelephoneNumber |
String |
No |
0 |
0 |
1 |
|
20 |
/POS/Order/OrderDetail/ShipTo/Telephone/FullTelephoneNumber |
|
| |
|
|
ItemId |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/POS/Order/OrderDetail/ItemId |
|
| |
|
|
|
GsiCatalogId |
String |
Yes |
0 |
1 |
1 |
|
4 |
/POS/Order/OrderDetail/ItemId/GsiCatalogId |
|
| |
|
|
|
ClientItemId |
String |
Yes |
0 |
1 |
1 |
|
35 |
/POS/Order/OrderDetail/ItemId/ClientItemId |
The retailer/client unique item id used to identify the item.
Allowable Values: Text string
Required: Yes
Length: 35
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
OMSItemId |
|
Yes |
0 |
1 |
1 |
|
|
/POS/Order/OrderDetail/ItemId/OMSItemId |
The identifier assigned to the item by the OMS.
Allowable Values: Text string
Required: Yes
Length: 9
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
ClientAltItemId |
String |
No |
0 |
0 |
1 |
|
15 |
/POS/Order/OrderDetail/ItemId/ClientAltItemId |
An additional identifier assigned to the item by the client.
Allowable Values: Text string
Required: No
Length: 15
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
SupplierItemId |
String |
No |
0 |
0 |
1 |
|
15 |
/POS/Order/OrderDetail/ItemId/SupplierItemId |
The identifier assigned to the item by its supplier.
Allowable Values: Text string
Required: No
Length: 15
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
ManufacturerItemId |
String |
No |
0 |
0 |
1 |
|
15 |
/POS/Order/OrderDetail/ItemId/ManufacturerItemId |
The identifier assigned to the item by its manufacturer.
Allowable Values: Text string
Required: No
Length: 15
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
UPCNumber |
|
No |
1..n |
0 |
-1 |
|
|
/POS/Order/OrderDetail/ItemId/UPCNumber |
The UPC number assigned to the item.
Allowable Values: Text string
Required: No
Length: 18
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
ExtendedAttributes |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/POS/Order/OrderDetail/ItemId/ExtendedAttributes |
|
| |
|
|
|
|
Name |
String |
No |
0 |
0 |
1 |
|
30 |
/POS/Order/OrderDetail/ItemId/ExtendedAttributes/Name |
The short title of the additional attribute.
Allowable Values: Text string
Required: No
Length: 30
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
Description |
String |
No |
0 |
0 |
1 |
|
100 |
/POS/Order/OrderDetail/ItemId/ExtendedAttributes/Description |
A brief description of the additional attribute.
Allowable Values: Text string
Required: No
Length: 100
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
Value |
String |
No |
0 |
0 |
1 |
|
100 |
/POS/Order/OrderDetail/ItemId/ExtendedAttributes/Value |
The specific value of the additional attribute.
Allowable Values: Text string
Required: No
Length: 100
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
OrderedQuantity |
Decimal |
Yes |
0 |
1 |
1 |
|
|
/POS/Order/OrderDetail/OrderedQuantity |
total quantity ordered for this line.
Allowable Values: Decimal
Required: Yes
Length: 10
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
ReleasedQuantity |
Decimal |
Yes |
0 |
1 |
1 |
|
|
/POS/Order/OrderDetail/ReleasedQuantity |
The total number of items in an order.
Allowable Values: Decimal
Required: Yes
Length: 10.2
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
ShippedQuantity |
Decimal |
Yes |
0 |
1 |
1 |
|
|
/POS/Order/OrderDetail/ShippedQuantity |
The number of items shipped, returned or adjusted.
Allowable Values: Decimal
Required: Yes
Length: 10.2
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
ItemType |
String |
Yes |
0 |
1 |
1 |
|
40 |
/POS/Order/OrderDetail/ItemType |
Identifies that the item is a physical SKU or some other special item such as a gift card, gift wrap, etc.
Allowable Values: Text string. Common values = merch; giftwrap; giftcard
Required: Yes
Length: 40
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
Carrier |
AnyType |
No |
0 |
0 |
1 |
|
|
/POS/Order/OrderDetail/Carrier |
|
| |
|
|
|
Name |
String |
No |
0 |
0 |
1 |
|
30 |
/POS/Order/OrderDetail/Carrier/Name |
The name of the company responsible for the transportation of goods from the source location to the destination location.
Allowable Values: Text string
Required: No
Length: 30
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
CarrierID |
String |
Yes |
0 |
1 |
1 |
|
4 |
/POS/Order/OrderDetail/Carrier/CarrierID |
The Radial-assigned unique reference for the external party that transports merchandise and/or supply items from their source to the destination and from the destination back to their source.
Allowable Values: Text string. Sample values might include UPS, USPS, etc.
Required: Yes
Length: 4
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
CarrierServiceLevel |
String |
Yes |
0 |
1 |
1 |
|
40 |
/POS/Order/OrderDetail/Carrier/CarrierServiceLevel |
The Radial-assigned value that indicates the method used to ship the order to the destination.
Allowable Values: Text string. Common values might include 1DAY, 2DAY, GROUND
Required: Yes
Length: 40
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
ReasonCode |
String |
No |
0 |
0 |
1 |
|
3 |
/POS/Order/OrderDetail/ReasonCode |
Customer reason code for return or price modification.
Allowable Values: Text string
Required: No
Length: 3
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
InventoryCondition |
String |
No |
0 |
0 |
1 |
|
15 |
/POS/Order/OrderDetail/InventoryCondition |
Indicates whether returned item is sellable or non-sellable.
Allowable Values: Text string
- sellable
- nonsellable
Required: No
Length: 15
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
GiftRegistryType |
String |
No |
0 |
0 |
1 |
|
20 |
/POS/Order/OrderDetail/GiftRegistryType |
Specifies the type of regisry, for example "wedding" "baby", etc. where the item was listed.
Allowable Values: Text string
Required: No
Length: 20
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
GiftRegistryID |
String |
No |
0 |
0 |
1 |
|
20 |
/POS/Order/OrderDetail/GiftRegistryID |
gift registry ID of purchased item
Specifies the identifier of the regisry where the item was listed.
Allowable Values: Text string
Required: No
Length: 20
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
GiftCertificateId |
String |
No |
0 |
0 |
1 |
|
30 |
/POS/Order/OrderDetail/GiftCertificateId |
ID of the gift certificate used to purchase the item.
Allowable Values: Text string
Required: No
Length: 30
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
Promotions |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/POS/Order/OrderDetail/Promotions |
Line level promotion detail |
| |
|
|
|
PromoID |
String |
Yes |
0 |
1 |
1 |
|
100 |
/POS/Order/OrderDetail/Promotions/PromoID |
Unique identifier for the promotion code triggered or entered.
Allowable Values: Text string
Required: Yes
Length: 100
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
DiscountType |
String |
Yes |
0 |
1 |
1 |
|
100 |
/POS/Order/OrderDetail/Promotions/DiscountType |
type of promotion, e.g. BASIC, FREIGHT, etc.
Allowable Values: Text string
Required: Yes
Length: 100
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
PromoCode |
String |
No |
0 |
0 |
1 |
|
100 |
/POS/Order/OrderDetail/Promotions/PromoCode |
Code entered by customerto trigger the promotion.
Allowable Values: Text string
Required: No
Length: 100
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
MonetaryAmount |
Decimal |
Yes |
0 |
1 |
1 |
|
|
/POS/Order/OrderDetail/Promotions/MonetaryAmount |
The monetary amount for the discount of the promotion.
Allowable Values: Decimal
Required: Yes
Length: 16.5
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
CurrencyCode |
String |
Yes |
0 |
1 |
1 |
|
3 |
/POS/Order/OrderDetail/Promotions/CurrencyCode |
The currency code for amounts in the order line.
Allowable Values: ISO 4217 currency code.
Required: Yes
Length: 3
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
ExtendedAttributes |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/POS/Order/OrderDetail/Promotions/ExtendedAttributes |
|
| |
|
|
|
|
Name |
String |
No |
0 |
0 |
1 |
|
30 |
/POS/Order/OrderDetail/Promotions/ExtendedAttributes/Name |
The short title of the additional attribute.
Allowable Values: Text string
Required: No
Length: 30
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
Description |
String |
No |
0 |
0 |
1 |
|
100 |
/POS/Order/OrderDetail/Promotions/ExtendedAttributes/Description |
A brief description of the additional attribute.
Allowable Values: Text string
Required: No
Length: 100
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
Value |
String |
No |
0 |
0 |
1 |
|
100 |
/POS/Order/OrderDetail/Promotions/ExtendedAttributes/Value |
The specific value of the additional attribute.
Allowable Values: Text string
Required: No
Length: 100
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
ExtendedAttributes |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/POS/Order/OrderDetail/ExtendedAttributes |
|
| |
|
|
|
Name |
String |
No |
0 |
0 |
1 |
|
30 |
/POS/Order/OrderDetail/ExtendedAttributes/Name |
The short title of the additional attribute.
Allowable Values: Text string
Required: No
Length: 30
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
Description |
String |
No |
0 |
0 |
1 |
|
100 |
/POS/Order/OrderDetail/ExtendedAttributes/Description |
A brief description of the additional attribute.
Allowable Values: Text string
Required: No
Length: 100
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
Value |
String |
No |
0 |
0 |
1 |
|
100 |
/POS/Order/OrderDetail/ExtendedAttributes/Value |
The specific value of the additional attribute.
Allowable Values: Text string
Required: No
Length: 100
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
DetailTax |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/POS/Order/OrderDetail/DetailTax |
|
| |
|
|
|
TaxType |
String |
Yes |
0 |
1 |
1 |
|
20 |
/POS/Order/OrderDetail/DetailTax/TaxType |
The type of tax being imposed.
Allowable Values: Text string. Common values: Sales; VAT
Required: Yes
Length: 20
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
Exemption |
String |
Yes |
0 |
1 |
1 |
|
1 |
/POS/Order/OrderDetail/DetailTax/Exemption |
Specifies that the customer is exempt from paying taxes for the order.
Allowable Values:
Y - Customer is exempt from paying taxes
N - Customer is not exempt from paying taxes
Required: Yes
Length: 1
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
Situs |
String |
Yes |
0 |
1 |
1 |
|
30 |
/POS/Order/OrderDetail/DetailTax/Situs |
The order address type used to determine the taxing jurisdiction.
Allowable Values: Text string. Ccommon value = DESTINATION; PHYSICAL_ORIGIN
Required: Yes
Length: 30
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
Jurisdiction |
String |
No |
0 |
0 |
1 |
|
100 |
/POS/Order/OrderDetail/DetailTax/Jurisdiction |
The name of the taxing jurisdiction.
Allowable Values: Text string
Required: No
Length: 100
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
JurisdictionLevel |
String |
No |
0 |
0 |
1 |
|
40 |
/POS/Order/OrderDetail/DetailTax/JurisdictionLevel |
The level within the jurisdiction that the tax applies to.
Allowable Values: Text string. Common values = Country; State; County; City
Required: No
Length: 40
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
JurisdictionId |
|
No |
0 |
0 |
1 |
|
|
/POS/Order/OrderDetail/DetailTax/JurisdictionId |
The unique number that identifies a jurisdiction. This value is assigned by the Vertex tax application.
Allowable Values: Text string
Required: No
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
Imposition |
String |
No |
0 |
0 |
1 |
|
60 |
/POS/Order/OrderDetail/DetailTax/Imposition |
The name of the imposition to which the relevant tax rule belongs. This is assigned either by Vertex or by the user when setting up a user-defined imposition in Vertex.
Allowable Values: Text string
Required: No
Length: 60
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
ImpositionType |
String |
No |
0 |
0 |
1 |
|
60 |
/POS/Order/OrderDetail/DetailTax/ImpositionType |
The type description assigned to the imposition. When multiple impositions are imposed within a jurisdiction, each must have a different type. This is assigned either by Vertex or by the user when setting up a user-defined imposition in Vertex.
Allowable Values: Text string
Required: No
Length: 60
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
TaxRate |
Decimal |
No |
0 |
0 |
1 |
|
|
/POS/Order/OrderDetail/DetailTax/TaxRate |
The tax rate percentage that is being applied to the basis amount.
Allowable Values: Decimal
Required: No
Length: 8.5
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
BasisAmount |
Decimal |
No |
0 |
0 |
1 |
|
|
/POS/Order/OrderDetail/DetailTax/BasisAmount |
The amount of the line for which the tax is applicable.
Allowable Values: Decimal
Required: No
Length: 16.5
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
TransactionalTaxAmount |
Decimal |
Yes |
0 |
1 |
1 |
|
|
/POS/Order/OrderDetail/DetailTax/TransactionalTaxAmount |
The monetary amount of sales tax calculated by applying a set percentage to the line item. These percentages can vary by county, state and country.
Allowable Values: Decimal
Required: No
Length: 16.5
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
ChargeCategory |
String |
Yes |
0 |
1 |
1 |
|
20 |
/POS/Order/OrderDetail/DetailTax/ChargeCategory |
The different categories of items/services for which the tax was charged.
Allowable Values: Text string
Required: No
Length: 20
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
ChargeName |
String |
No |
0 |
0 |
1 |
|
40 |
/POS/Order/OrderDetail/DetailTax/ChargeName |
The name of LineCharge or HeaderCharge. Charge Category and Charge Name together make a unique key for any line/header charge. |
| |
|
|
SellingRetailAmount |
Decimal |
Yes |
0 |
1 |
1 |
|
|
/POS/Order/OrderDetail/SellingRetailAmount |
The retail amount for the line.
Allowable Values: Decimal
Required: Yes
Length: 16.5
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
SellingRetailCurrencyCode |
String |
Yes |
0 |
1 |
1 |
|
3 |
/POS/Order/OrderDetail/SellingRetailCurrencyCode |
The currency code used for the retail sale of this line item.
Allowable Values: ISO 4217 currency code.
Required: Yes
Length: 3
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
SellingCostAmount |
Decimal |
No |
0 |
0 |
1 |
|
|
/POS/Order/OrderDetail/SellingCostAmount |
The cost amount for the line.
Allowable Values: Decimal
Required: No
Length: 16.5
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
SellingCostCurrencyCode |
String |
No |
0 |
0 |
1 |
|
3 |
/POS/Order/OrderDetail/SellingCostCurrencyCode |
Selling amount currency.
Allowable Values: ISO 4217 currency code.
Required: Yes
Length: 3
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
LineCharges |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/POS/Order/OrderDetail/LineCharges |
|
| |
|
|
|
ChargeCategory |
String |
Yes |
0 |
1 |
1 |
|
20 |
/POS/Order/OrderDetail/LineCharges/ChargeCategory |
The client-defined area to which the charge belongs.
Allowable Values: Text string
Required: Yes
Length: 20
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
MonetaryAmount |
Decimal |
Yes |
0 |
1 |
1 |
|
|
/POS/Order/OrderDetail/LineCharges/MonetaryAmount |
The amount associated with the line item payment.
Allowable Values: Decimal
Required: Yes
Length: 16.5
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
CurrencyCode |
String |
Yes |
0 |
1 |
1 |
|
3 |
/POS/Order/OrderDetail/LineCharges/CurrencyCode |
The type of currency associated with the line item payment.
Allowable Values: ISO 4217 currency code.
Required: Yes
Length: 3
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
ChargeName |
String |
No |
0 |
0 |
1 |
|
40 |
/POS/Order/OrderDetail/LineCharges/ChargeName |
The name of LineCharge or HeaderCharge. Charge Category and Charge Name together make a unique key for any line/header charge.
Allowable Values: Text string
Required: No
Length: 40
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
ItemId |
AnyType |
No |
0 |
0 |
1 |
|
|
/POS/Order/OrderDetail/LineCharges/ItemId |
|
| |
|
|
|
|
ClientItemId |
String |
No |
0 |
0 |
1 |
|
35 |
/POS/Order/OrderDetail/LineCharges/ItemId/ClientItemId |
The unique SKU-level identifier for the item. This is the retailer/client unique item ID or SKU. This is the primary key for the Item Master.
Allowable Values: Text string
Required: No
Length: 35
Default Value: blank
Restrictions: This item ID may not change or the new key is considered a new item.
Aliases: N/A |
| |
|
|
|
|
OMSItemId |
|
No |
0 |
0 |
1 |
|
|
/POS/Order/OrderDetail/LineCharges/ItemId/OMSItemId |
The unique identifier for the item in the OMS.
Allowable Values: Text string
Required: No
Length: 9
Default Value: blank
Restrictions: This item ID may not change or the new key is considered a new item.
Aliases: N/A |
| |
|
|
|
|
ClientAltItemId |
String |
No |
0 |
0 |
1 |
|
15 |
/POS/Order/OrderDetail/LineCharges/ItemId/ClientAltItemId |
|
| |
|
|
|
|
SupplierItemId |
String |
No |
0 |
0 |
1 |
|
15 |
/POS/Order/OrderDetail/LineCharges/ItemId/SupplierItemId |
The identifier assigned to the item by its supplier.
Allowable Values: Text string
Required: No
Length: 15
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
ManufacturerItemId |
String |
No |
0 |
0 |
1 |
|
15 |
/POS/Order/OrderDetail/LineCharges/ItemId/ManufacturerItemId |
The identifier assigned to the item by the manufacturer to uniquely identify the item.
Allowable Values: Text string
Required: No
Length: 15
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
UPCNumber |
|
No |
1..n |
0 |
-1 |
|
|
/POS/Order/OrderDetail/LineCharges/ItemId/UPCNumber |
The UPC number assigned to the item.
Allowable Values: Text string
Required: No
Length: 18
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
ExtendedAttributes |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/POS/Order/OrderDetail/LineCharges/ItemId/ExtendedAttributes |
|
| |
|
|
|
|
|
Name |
String |
No |
0 |
0 |
1 |
|
30 |
/POS/Order/OrderDetail/LineCharges/ItemId/ExtendedAttributes/Name |
The short title of the additional attribute.
Allowable Values: Text string
Required: No
Length: 30
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
|
Description |
String |
No |
0 |
0 |
1 |
|
100 |
/POS/Order/OrderDetail/LineCharges/ItemId/ExtendedAttributes/Description |
A brief description of the additional attribute.
Allowable Values: Text string
Required: No
Length: 100
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
|
Value |
String |
No |
0 |
0 |
1 |
|
100 |
/POS/Order/OrderDetail/LineCharges/ItemId/ExtendedAttributes/Value |
The specific value of the additional attribute.
Allowable Values: Text string
Required: No
Length: 100
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
ExtendedAttributes |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/POS/Order/OrderDetail/LineCharges/ExtendedAttributes |
|
| |
|
|
|
|
Name |
String |
No |
0 |
0 |
1 |
|
30 |
/POS/Order/OrderDetail/LineCharges/ExtendedAttributes/Name |
The short title of the additional attribute.
Allowable Values: Text string
Required: No
Length: 30
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
Description |
String |
No |
0 |
0 |
1 |
|
100 |
/POS/Order/OrderDetail/LineCharges/ExtendedAttributes/Description |
A brief description of the additional attribute.
Allowable Values: Text string
Required: No
Length: 100
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
Value |
String |
No |
0 |
0 |
1 |
|
100 |
/POS/Order/OrderDetail/LineCharges/ExtendedAttributes/Value |
The specific value of the additional attribute.
Allowable Values: Text string
Required: No
Length: 100
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
RewardPoints |
AnyType |
No |
0 |
0 |
1 |
|
|
/POS/Order/OrderDetail/RewardPoints |
Points earned for the given line.To calculate the total points earned per line use OrderedQuantity * PerUnit + Bonus |
| |
|
|
|
PerUnit |
Decimal |
No |
0 |
0 |
1 |
|
|
/POS/Order/OrderDetail/RewardPoints/PerUnit |
Indicates the total points earned per unit for the line.
Allowable Values: Integer
Required: No
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
Bonus |
Decimal |
No |
0 |
0 |
1 |
|
|
/POS/Order/OrderDetail/RewardPoints/Bonus |
Indicates the total Bonus points earned for the line.
Allowable Values: Integer
Required: No
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
Multiplier |
Decimal |
No |
0 |
0 |
1 |
|
|
/POS/Order/OrderDetail/RewardPoints/Multiplier |
Indicates the multiplier used to calculate the RewardPointsPerUnit.
Allowable Values: Decimal
Required: No
Length: 16.5
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
OrderLineRelationships |
AnyType |
No |
0 |
0 |
1 |
|
|
/POS/Order/OrderDetail/OrderLineRelationships |
Container for OrderLineRelationship. |
| |
|
|
|
OrderLineRelationship |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/POS/Order/OrderDetail/OrderLineRelationships/OrderLineRelationship |
Defines the relationship between a parent line and its child lines. |
| |
|
|
|
|
RelationshipType |
String |
Yes |
0 |
1 |
1 |
|
40 |
/POS/Order/OrderDetail/OrderLineRelationships/OrderLineRelationship/RelationshipType |
Defines the type of relationship between the parent line and a child line. E.g. WARRANTY, INSTALL, CUSTOM, ACCESSORY
Allowable Values: Text string
Required: Yes
Length: 40
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
ParentLine |
|
Yes |
0 |
1 |
1 |
|
|
/POS/Order/OrderDetail/OrderLineRelationships/OrderLineRelationship/ParentLine |
Indicates the parent line number of the order.
Allowable Values: Integer
Required: Yes
Length: 5
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
ChildLine |
|
Yes |
0 |
1 |
1 |
|
|
/POS/Order/OrderDetail/OrderLineRelationships/OrderLineRelationship/ChildLine |
Indicates the child line number of the order.
Allowable Values: Integer
Required: Yes
Length: 5
Default Value: blank
Restrictions: N/A
Aliases: N/A |