Orders to Fulfill API Structure
|
| Field Name |
DataType |
Required |
Instances |
Minimum Usage |
Maximum Usage |
Minimum Length |
Maximum Length |
XPath |
Documentation |
| OrdersToFulfill |
AnyType |
Yes |
0 |
|
|
|
|
/OrdersToFulfill |
|
| |
MessageHeader |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/OrdersToFulfill/MessageHeader |
Encapsulates message routing data. The elements included in this grouping are standard across all messages. |
| |
|
Standard |
String |
Yes |
0 |
1 |
1 |
|
10 |
/OrdersToFulfill/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 |
/OrdersToFulfill/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 |
/OrdersToFulfill/MessageHeader/VersionReleaseNumber |
Release number within the current message header version number.
Allowable Values: Text string
Required: Yes
Length: 15
Default Value: blank
Restrictions: N/A
Aliases: N/A
Offering: Exchange Platform, Webstore |
| |
|
SourceData |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/OrdersToFulfill/MessageHeader/SourceData |
Encapsulates data related to the Source or the Sending system. |
| |
|
|
SourceId |
String |
Yes |
0 |
1 |
1 |
|
20 |
/OrdersToFulfill/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 |
/OrdersToFulfill/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 |
|
|
/OrdersToFulfill/MessageHeader/DestinationData |
Encapsulates data related to the Destination or Receiving system. |
| |
|
|
DestinationId |
String |
Yes |
0 |
1 |
1 |
|
20 |
/OrdersToFulfill/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 |
/OrdersToFulfill/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 |
/OrdersToFulfill/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 |
|
|
/OrdersToFulfill/MessageHeader/MessageData |
Encapsulates message identification information. |
| |
|
|
MessageId |
String |
Yes |
0 |
1 |
1 |
|
20 |
/OrdersToFulfill/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/A
Offering: Exchange Platform, Webstore |
| |
|
|
CorrelationId |
String |
No |
0 |
0 |
1 |
|
20 |
/OrdersToFulfill/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 |
|
|
/OrdersToFulfill/MessageHeader/CreateDateAndTime |
Original message creation date and time assigned by the Source.
Allowable Values: 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: Yes
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
Order |
AnyType |
Yes |
1..n |
1 |
-1 |
|
|
/OrdersToFulfill/Order |
Encapsulates the order header and order line data to allow for multiple orders to be contained within a single message. |
| |
|
OrderHeader |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader |
Encapsulates the order invoice header information that applies to all lines on the invoice. |
| |
|
|
ClientId |
String |
Yes |
0 |
1 |
1 |
|
32 |
/OrdersToFulfill/Order/OrderHeader/ClientId |
The identifier provided by Radial for an individual or organization that has a contractual relationship with Radial in which Radial is providing e-commerce, fulfillment or other services for the individual or organization.
Allowable Values: Text string
Required: Yes
Length: 32
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
gsi_client_id |
String |
Yes |
0 |
1 |
1 |
|
32 |
/OrdersToFulfill/Order/OrderHeader/gsi_client_id |
The identifier provided by Radial for an individual or organization that has a contractual relationship with Radial in which Radial is providing e-commerce, fulfillment or other services for the individual or organization. This refers to the V11 gsi_client_id. e.g. TMSNA.
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 |
/OrdersToFulfill/Order/OrderHeader/gsi_store_id |
The identifier provided by Radial for an individual or organization that has a contractual relationship with Radial in which Radial is providing e-commerce, fulfillment or other services for the individual or organization. This refers to the V11 gsi_store_id. e.g. TMSUS.
Allowable Values: Text string
Required: Yes
Length: 32
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
FacilityId |
String |
Yes |
0 |
1 |
1 |
|
32 |
/OrdersToFulfill/Order/OrderHeader/FacilityId |
Unique identifier provided by Radial that designates the facility housing the goods. Typically a distribution center of physical warehouse.
Allowable Values: Text string
Required: Yes
Length: 32
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
ExternalReferenceFacilityId |
String |
No |
0 |
0 |
1 |
|
32 |
/OrdersToFulfill/Order/OrderHeader/ExternalReferenceFacilityId |
The unique identifier that maps to what an external client/facility uses to identify their facility.
Allowable Values: Text string
Required: No
Length: 32
Default Value: blank
Restrictions: N/A
Aliases: ExternaFacilityId |
| |
|
|
FulfillmentChannel |
String |
Yes |
0 |
1 |
1 |
|
40 |
/OrdersToFulfill/Order/OrderHeader/FulfillmentChannel |
Identifies the type of fulfillment outlet for this order. For example an Instore pickup fulfillment channel vs. a warehouse to consumer fulfillment channel.
Allowable Values:
SHIP_FROM_STORE - Order is shipped from the store to the customer
SHIP_TO_HOME - Order is shipped from a non-store location to the customer
SHIP_TO_STORE - Order is shipped from a non-store location to the store. The customer has paid for it and will pick it up at the store upon its arrival.
STORE_PICK_UP - Order is available in the store and paid for by the customer, who will pick it up there.
STORE_RESERVATION - Order is available in the store and reserved for the customer, who will pay for it when he receives it
Required: Yes
Length: 40
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
OrderType |
String |
Yes |
0 |
1 |
1 |
|
20 |
/OrdersToFulfill/Order/OrderHeader/OrderType |
Defines the category for the order.
Allowable Values: Text string
Required: Yes
Length: 20
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
OMSOrderId |
|
Yes |
0 |
1 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/OMSOrderId |
The OMS OrderId created internally by the OMS. This is typically not known by the consumer. The OMS Order ID is a combination of the 12-digit OMS Order Number and the 3-digit release sequence.
Allowable Values: Integer
Required: Yes
Length: 15
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
CustomerOrderId |
String |
Yes |
0 |
1 |
1 |
|
30 |
/OrdersToFulfill/Order/OrderHeader/CustomerOrderId |
The OrderId that is visible to the consumer, typically this is known as the Web Order ID.
Allowable Values: Integer
Required: Yes
Length: 30
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
VATInvoiceNumber |
String |
No |
0 |
0 |
1 |
|
256 |
/OrdersToFulfill/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 |
| |
|
|
PurchaseOrderNumber |
String |
No |
0 |
0 |
1 |
|
100 |
/OrdersToFulfill/Order/OrderHeader/PurchaseOrderNumber |
The reference number related to the request from a purchasing organization to an external supplier (vendor, manufacturer) to deliver a quantity of items or to perform services at a certain point in time. This is ExternalOrder.
Allowable Values: Text string
Required: No
Length: 100
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
ReturnOrderNumber |
String |
No |
0 |
0 |
1 |
|
30 |
/OrdersToFulfill/Order/OrderHeader/ReturnOrderNumber |
Client Generated In Store return Order Number.
Allowable Values: Text string
Required: No
Length: 30
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
ExternalShipmentId |
String |
No |
0 |
0 |
1 |
|
30 |
/OrdersToFulfill/Order/OrderHeader/ExternalShipmentId |
A third-party fulfiller’s Shipment Identifier.
Allowable Values: Text string
Required: No
Length: 30
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
SplitOrderIndicator |
String |
No |
0 |
0 |
1 |
|
1 |
/OrdersToFulfill/Order/OrderHeader/SplitOrderIndicator |
Indicates if the order has been divided into multiple shipment groups.
Allowable Values:
Y = Yes,
N = No.
Required: No
Length: 1
Default Value: If not sent, then default = N.
Restrictions: N/A
Aliases: N/A |
| |
|
|
OrderEntryDateTime |
|
Yes |
0 |
1 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/OrderEntryDateTime |
Date/Time that the order was entered at the Webstore or Order Entry Point.
Allowable Values: 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: Yes
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
InvoiceCreateDateTime |
|
Yes |
0 |
1 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/InvoiceCreateDateTime |
Date/Time that the order was released for fulfillment in the OMS. Follows ISO 8601 standard with offset from UTC.
Allowable Values: 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: Yes
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
PromiseShipDate |
|
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/PromiseShipDate |
The Expected date of when the merchandise contained in the order will be shipped by.
Allowable Values: 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 |
| |
|
|
PromiseReceiptDate |
|
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/PromiseReceiptDate |
The Expected date of when the merchandise contained in the order will be received by the facility.
Allowable Values: 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 |
| |
|
|
ExpeditedOrderIndicator |
String |
No |
0 |
0 |
1 |
|
1 |
/OrdersToFulfill/Order/OrderHeader/ExpeditedOrderIndicator |
Indicates if the order has been flagged as an expedited order requiring immediate shipment.
Allowable Values:
Y - Order has expedited shipping
N - Order does not have expedited shipping
Required: No
Length: 1
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
CatalogId |
String |
No |
0 |
0 |
1 |
|
12 |
/OrdersToFulfill/Order/OrderHeader/CatalogId |
Catalog number for paper mail catalogs. This is not the Radial Catalog ID assigned to each client.
Allowable Values: Text string
Required: No
Length: 12
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
DeliveryInstructions |
String |
No |
0 |
0 |
1 |
|
60 |
/OrdersToFulfill/Order/OrderHeader/DeliveryInstructions |
Provides an area for the customer to detail specific delivery instructions for the shipment of the package. This is commonly used in the UK.
Allowable Values: Text string
Required: No
Length: 60
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
Locale |
String |
Yes |
0 |
1 |
1 |
|
5 |
/OrdersToFulfill/Order/OrderHeader/Locale |
The locale code of the environment in which the order was placed. The locale defines the language and country rules to be applied to the data.
Allowable Values: Text string. 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 ISO country code.
Common values:
en_US - English/United States
fr_CA - French/Canada
en_GB - English/United Kingdom
de_DE - German/Germany
fr_FR - French/France
Required: Yes
Length: 5
Default Value: blank
Restrictions: N/A
Aliases: N/A. |
| |
|
|
BillTo |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/BillTo |
|
| |
|
|
|
CustomerId |
String |
Yes |
0 |
1 |
1 |
|
40 |
/OrdersToFulfill/Order/OrderHeader/BillTo/CustomerId |
The customer account number typically provided by the web store.
Allowable Values: Text string
Required: Yes
Length: 40
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
FullName |
String |
No |
0 |
0 |
1 |
|
168 |
/OrdersToFulfill/Order/OrderHeader/BillTo/FullName |
Contains the entire name. This is a legacy field that can be used when connected systems do not support multi-field names.
Allowable Values: Text string.
Required: No
Length: 168
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
Salutation |
String |
No |
0 |
0 |
1 |
|
15 |
/OrdersToFulfill/Order/OrderHeader/BillTo/Salutation |
A title you can assign to a person. Typically "Dr.", "Mr.", "Ms." etc.
Allowable Values: Text string.
Required: No
Length: 15
Default Value: blank
Restrictions: N/A
Aliases: Salutation |
| |
|
|
|
FirstName |
String |
Yes |
0 |
1 |
1 |
|
64 |
/OrdersToFulfill/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 |
| |
|
|
|
LastName |
String |
No |
0 |
0 |
1 |
|
64 |
/OrdersToFulfill/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 |
| |
|
|
|
EmailAddress |
String |
No |
0 |
0 |
1 |
|
150 |
/OrdersToFulfill/Order/OrderHeader/BillTo/EmailAddress |
Customer Email address, for example: mike@gsicommerce.com.
Allowable Values: Text string
Required: Yes
Length: 150 characters
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
PreferredLanguageCode |
String |
No |
0 |
0 |
1 |
|
5 |
/OrdersToFulfill/Order/OrderHeader/BillTo/PreferredLanguageCode |
The locale code of the environment where the order is being billed. The locale defines the language and country rules to be applied to the data.
Allowable Values: Text string. The format is "ll_CC" where ll is the language argument and is a valid ISO Language Code. These codes are the lower_case, A two_letter codes as defined by ISO_639. CC is the upper_case, two_letter codes as defined by ISO_3166 ISO country code.
Common values:
en_US - English/United States
fr_CA - French/Canada
en_GB - English/United Kingdom
de_DE - German/Germany
fr_FR - French/France
Required: No
Length: 5
Default Value: blank
Restrictions: N/A
Aliases: N/A. |
| |
|
|
|
Address |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/BillTo/Address |
|
| |
|
|
|
|
CompanyName |
String |
No |
0 |
0 |
1 |
|
50 |
/OrdersToFulfill/Order/OrderHeader/BillTo/Address/CompanyName |
|
| |
|
|
|
|
AddressLine1 |
String |
Yes |
0 |
1 |
1 |
|
70 |
/OrdersToFulfill/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 |
/OrdersToFulfill/Order/OrderHeader/BillTo/Address/AddressLine2 |
|
| |
|
|
|
|
AddressLine3 |
String |
No |
0 |
0 |
1 |
|
70 |
/OrdersToFulfill/Order/OrderHeader/BillTo/Address/AddressLine3 |
|
| |
|
|
|
|
City |
String |
Yes |
0 |
1 |
1 |
|
35 |
/OrdersToFulfill/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 |
/OrdersToFulfill/Order/OrderHeader/BillTo/Address/StateOrProvince |
The state, province or other country sub-division code for the store address.
Allowable Values: Text string. 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 |
|
20 |
/OrdersToFulfill/Order/OrderHeader/BillTo/Address/CountyOrLocality |
Additonal information about the address
Allowable Values: Text string
Required: Yes
Length: 20
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
CountryCode |
String |
Yes |
0 |
1 |
1 |
|
3 |
/OrdersToFulfill/Order/OrderHeader/BillTo/Address/CountryCode |
The country code for the address.
Allowable Values: Text string. 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 |
/OrdersToFulfill/Order/OrderHeader/BillTo/Address/PostalCode |
An additional part of an address that further clarifies the location, for example, the zip code in the United States.
Allowable Values: Text string
Required: No
Length: 35
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
Telephone |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/OrdersToFulfill/Order/OrderHeader/BillTo/Telephone |
|
| |
|
|
|
|
TelephoneType |
String |
No |
0 |
0 |
1 |
|
18 |
/OrdersToFulfill/Order/OrderHeader/BillTo/Telephone/TelephoneType |
Indicates where the phone number is located (home, business, mobile, etc.).
Allowable Values:
DayFaxNo - Daytime Fax Number
DayPhone - Daytime Phone Number
EveningFaxNo - Evening Fax Number
EveningPhone - Evening Phone Number
MobilePhone - Mobile Phone Number
OtherPhone - Other Phone Number
Required: No
Length: 18
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
AreaCode |
String |
No |
0 |
0 |
1 |
|
5 |
/OrdersToFulfill/Order/OrderHeader/BillTo/Telephone/AreaCode |
Specifies the region within a country where the phone number is located.
Allowable Values: Text string
Required: No
Length: 5
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
CountryCode |
String |
No |
0 |
0 |
1 |
|
3 |
/OrdersToFulfill/Order/OrderHeader/BillTo/Telephone/CountryCode |
Specifies the country where the phone number is located.
Allowable Values: Text string
Required: No
Length: 3
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
ExtensionNumber |
String |
No |
0 |
0 |
1 |
|
5 |
/OrdersToFulfill/Order/OrderHeader/BillTo/Telephone/ExtensionNumber |
Specifies the extension within an organization where the phone number is located.
Allowable Values: Text string
Required: No
Length: 3
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
TelephoneNumber |
String |
No |
0 |
0 |
1 |
|
18 |
/OrdersToFulfill/Order/OrderHeader/BillTo/Telephone/TelephoneNumber |
The telephone number as entered without a country code.
Allowable Values: Text string.
Required: No
Length: 18
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
FullTelephoneNumber |
String |
No |
0 |
0 |
1 |
|
40 |
/OrdersToFulfill/Order/OrderHeader/BillTo/Telephone/FullTelephoneNumber |
The telephone number as entered with a country code. If the country code is not entered, his field and the TelephoneNumber field are the same.
Allowable Values: Text string.
Required: No
Length: 40
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
ShipTo |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/ShipTo |
|
| |
|
|
|
CustomerId |
String |
Yes |
0 |
1 |
1 |
|
40 |
/OrdersToFulfill/Order/OrderHeader/ShipTo/CustomerId |
The customer account number typically provided by the web store.
Allowable Values: Text string
Required: Yes
Length: 40
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
FullName |
String |
No |
0 |
0 |
1 |
|
168 |
/OrdersToFulfill/Order/OrderHeader/ShipTo/FullName |
Contains the entire name. This is a legacy field that can be used when connected systems do not support multi-field names.
Allowable Values: Text string.
Required: No
Length: 168
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
Salutation |
String |
No |
0 |
0 |
1 |
|
15 |
/OrdersToFulfill/Order/OrderHeader/ShipTo/Salutation |
A title you can assign to a person. Typically "Dr.", "Mr.", "Ms." etc.
Allowable Values: Text string.
Required: No
Length: 15
Default Value: blank
Restrictions: N/A
Aliases: Salutation |
| |
|
|
|
FirstName |
String |
Yes |
0 |
1 |
1 |
|
64 |
/OrdersToFulfill/Order/OrderHeader/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 |
| |
|
|
|
LastName |
String |
No |
0 |
0 |
1 |
|
64 |
/OrdersToFulfill/Order/OrderHeader/ShipTo/LastName |
The surname of the person.
Allowable Values: Text string.
Required: Yes
Length: 64
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
EmailAddress |
String |
No |
0 |
0 |
1 |
|
150 |
/OrdersToFulfill/Order/OrderHeader/ShipTo/EmailAddress |
Customer Email address, for example: mike@gsicommerce.com.
Allowable Values: Text string
Required: Yes
Length: 150 characters
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
PreferredLanguageCode |
String |
No |
0 |
0 |
1 |
|
5 |
/OrdersToFulfill/Order/OrderHeader/ShipTo/PreferredLanguageCode |
The locale code of the environment where the order is being billed. The locale defines the language and country rules to be applied to the data.
Allowable Values: Text string. The format is "ll_CC" where ll is the language argument and is a valid ISO Language Code. These codes are the lower_case, A two_letter codes as defined by ISO_639. CC is the upper_case, two_letter codes as defined by ISO_3166 ISO country code.
Common values:
en_US - English/United States
fr_CA - French/Canada
en_GB - English/United Kingdom
de_DE - German/Germany
fr_FR - French/France
Required: No
Length: 5
Default Value: blank
Restrictions: N/A
Aliases: N/A. |
| |
|
|
|
Address |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/ShipTo/Address |
|
| |
|
|
|
|
CompanyName |
String |
No |
0 |
0 |
1 |
|
50 |
/OrdersToFulfill/Order/OrderHeader/ShipTo/Address/CompanyName |
|
| |
|
|
|
|
AddressLine1 |
String |
Yes |
0 |
1 |
1 |
|
70 |
/OrdersToFulfill/Order/OrderHeader/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 |
/OrdersToFulfill/Order/OrderHeader/ShipTo/Address/AddressLine2 |
|
| |
|
|
|
|
AddressLine3 |
String |
No |
0 |
0 |
1 |
|
70 |
/OrdersToFulfill/Order/OrderHeader/ShipTo/Address/AddressLine3 |
|
| |
|
|
|
|
City |
String |
Yes |
0 |
1 |
1 |
|
35 |
/OrdersToFulfill/Order/OrderHeader/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 |
/OrdersToFulfill/Order/OrderHeader/ShipTo/Address/StateOrProvince |
The state, province or other country sub-division code for the store address.
Allowable Values: Text string. 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 |
|
20 |
/OrdersToFulfill/Order/OrderHeader/ShipTo/Address/CountyOrLocality |
Additonal information about the address
Allowable Values: Text string
Required: Yes
Length: 20
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
CountryCode |
String |
Yes |
0 |
1 |
1 |
|
3 |
/OrdersToFulfill/Order/OrderHeader/ShipTo/Address/CountryCode |
The country code for the address.
Allowable Values: Text string. 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 |
/OrdersToFulfill/Order/OrderHeader/ShipTo/Address/PostalCode |
An additional part of an address that further clarifies the location, for example, the zip code in the United States.
Allowable Values: Text string
Required: No
Length: 35
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
Telephone |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/OrdersToFulfill/Order/OrderHeader/ShipTo/Telephone |
|
| |
|
|
|
|
TelephoneType |
String |
No |
0 |
0 |
1 |
|
18 |
/OrdersToFulfill/Order/OrderHeader/ShipTo/Telephone/TelephoneType |
Indicates where the phone number is located (home, business, mobile, etc.).
Allowable Values:
DayFaxNo - Daytime Fax Number
DayPhone - Daytime Phone Number
EveningFaxNo - Evening Fax Number
EveningPhone - Evening Phone Number
MobilePhone - Mobile Phone Number
OtherPhone - Other Phone Number
Required: No
Length: 18
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
AreaCode |
String |
No |
0 |
0 |
1 |
|
5 |
/OrdersToFulfill/Order/OrderHeader/ShipTo/Telephone/AreaCode |
Specifies the region within a country where the phone number is located.
Allowable Values: Text string
Required: No
Length: 5
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
CountryCode |
String |
No |
0 |
0 |
1 |
|
3 |
/OrdersToFulfill/Order/OrderHeader/ShipTo/Telephone/CountryCode |
Specifies the country where the phone number is located.
Allowable Values: Text string
Required: No
Length: 3
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
ExtensionNumber |
String |
No |
0 |
0 |
1 |
|
5 |
/OrdersToFulfill/Order/OrderHeader/ShipTo/Telephone/ExtensionNumber |
Specifies the extension within an organization where the phone number is located.
Allowable Values: Text string
Required: No
Length: 3
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
TelephoneNumber |
String |
No |
0 |
0 |
1 |
|
18 |
/OrdersToFulfill/Order/OrderHeader/ShipTo/Telephone/TelephoneNumber |
The telephone number as entered without a country code.
Allowable Values: Text string.
Required: No
Length: 18
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
FullTelephoneNumber |
String |
No |
0 |
0 |
1 |
|
40 |
/OrdersToFulfill/Order/OrderHeader/ShipTo/Telephone/FullTelephoneNumber |
The telephone number as entered with a country code. If the country code is not entered, his field and the TelephoneNumber field are the same.
Allowable Values: Text string.
Required: No
Length: 40
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
Carrier |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/Carrier |
Encapsulates the information regarding the individual/organization responsible for the trasportation of the goods from source location to the destination location. |
| |
|
|
|
Name |
String |
No |
0 |
0 |
1 |
|
30 |
/OrdersToFulfill/Order/OrderHeader/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 |
/OrdersToFulfill/Order/OrderHeader/Carrier/CarrierId |
The 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
Required: Yes
Length: 4
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
CarrierServiceLevel |
String |
Yes |
0 |
1 |
1 |
|
40 |
/OrdersToFulfill/Order/OrderHeader/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 |
| |
|
|
InvoiceAmount |
AnyType |
Yes |
1..n |
1 |
-1 |
|
|
/OrdersToFulfill/Order/OrderHeader/InvoiceAmount |
Encapsulates the invoice amounts that can be provided for an order |
| |
|
|
|
Amount |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/InvoiceAmount/Amount |
|
| |
|
|
|
|
AmountType |
String |
Yes |
0 |
1 |
1 |
|
40 |
/OrdersToFulfill/Order/OrderHeader/InvoiceAmount/Amount/AmountType |
Defines the type of amount included in the -Value- element.
Allowable Values: Text string.
Required: Yes
Length: 40
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
MonetaryAmount |
Decimal |
Yes |
0 |
1 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/InvoiceAmount/Amount/MonetaryAmount |
The monetary amount for the defined 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 |
/OrdersToFulfill/Order/OrderHeader/InvoiceAmount/Amount/CurrencyCode |
The type of currency (dollars, francs, etc.) associated with the monetary amount.
Allowable Values: ISO 4217 currency code. http://www.iso.org/iso/support/currency_codes_list-1.htm
Required: Yes
Length: 3
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
ChargeName |
String |
No |
0 |
0 |
1 |
|
40 |
/OrdersToFulfill/Order/OrderHeader/InvoiceAmount/Amount/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 |
| |
|
|
Payment |
AnyType |
Yes |
1..n |
1 |
-1 |
|
|
/OrdersToFulfill/Order/OrderHeader/Payment |
Encapsulates the payment and tender details |
| |
|
|
|
PaymentReference |
String |
Yes |
0 |
1 |
1 |
|
30 |
/OrdersToFulfill/Order/OrderHeader/Payment/PaymentReference |
Defines the payment reference for tender type.
Allowable Values: Text string.
Common values
BR - Marketplace
CC - Credit Card
GC - Gift Card
GS - Gift Certificate
Required: Yes
Length: 30
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
TenderType |
String |
No |
0 |
0 |
1 |
|
32 |
/OrdersToFulfill/Order/OrderHeader/Payment/TenderType |
This defines the CreditCardType or tender type for the PaymentReference.
Allowable Values: Text string. Common values = VISA; AMEX, MC, FV
Required: Yes
Length: 32
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
AdditionalPaymentDetails |
AnyType |
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/Payment/AdditionalPaymentDetails |
Additional Payment information. |
| |
|
|
|
|
PaymentReference1 |
String |
No |
0 |
0 |
1 |
|
100 |
/OrdersToFulfill/Order/OrderHeader/Payment/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 AdditionalPaymentReference is VISA |
| |
|
|
|
|
PaymentReference2 |
String |
No |
0 |
0 |
1 |
|
100 |
/OrdersToFulfill/Order/OrderHeader/Payment/AdditionalPaymentDetails/PaymentReference2 |
Additional reference value for the Payment information. |
| |
|
|
|
|
PaymentReference3 |
String |
No |
0 |
0 |
1 |
|
100 |
/OrdersToFulfill/Order/OrderHeader/Payment/AdditionalPaymentDetails/PaymentReference3 |
Additional reference value for the Payment information. for e.g. PLCC |
| |
|
|
|
|
DisplayCreditCardNumber |
String |
No |
0 |
0 |
1 |
|
30 |
/OrdersToFulfill/Order/OrderHeader/Payment/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 |
| |
|
|
|
|
SoldToAccountNumber |
String |
No |
0 |
0 |
1 |
|
40 |
/OrdersToFulfill/Order/OrderHeader/Payment/AdditionalPaymentDetails/SoldToAccountNumber |
Defines Customer Sold To Account Number when the "PO" is used a tender.
Allowable Values: Text string
Required: No
Length: 40
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
PurchaseOrderNumber |
String |
No |
0 |
0 |
1 |
|
100 |
/OrdersToFulfill/Order/OrderHeader/Payment/AdditionalPaymentDetails/PurchaseOrderNumber |
Defines PO Number when the "PO" is used a tender.
Allowable Values: Text string
Required: No
Length: 100
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
ExtendedAttributes |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/OrdersToFulfill/Order/OrderHeader/Payment/ExtendedAttributes |
|
| |
|
|
|
|
Name |
String |
No |
0 |
0 |
1 |
|
30 |
/OrdersToFulfill/Order/OrderHeader/Payment/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 |
/OrdersToFulfill/Order/OrderHeader/Payment/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 |
/OrdersToFulfill/Order/OrderHeader/Payment/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 |
| |
|
|
TaxInvoice |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/OrdersToFulfill/Order/OrderHeader/TaxInvoice |
|
| |
|
|
|
TaxInvoiceType |
String |
Yes |
0 |
1 |
1 |
|
15 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceType |
Encapsulates the VAT tax information , TaxType. For e.g. VAT |
| |
|
|
|
Locale |
String |
No |
0 |
0 |
1 |
|
5 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/Locale |
The locale code of the environment in which 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: No
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
CurrencyCode |
String |
Yes |
0 |
1 |
1 |
|
3 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/CurrencyCode |
The type of currency (dollars, francs, etc.) associated with the monetary amount.
Allowable Values: ISO 4217 currency code. http://www.iso.org/iso/support/currency_codes_list-1.htm
Required: Yes
Length: 3
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
ConversionRate |
Decimal |
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/ConversionRate |
The conversion rate applied from 1 of the charged currency to this many of the local currency.
Allowable Values: Decimal
Required: No
Length: 6.5
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
SendWithShipmentIndicator |
String |
Yes |
0 |
1 |
1 |
|
1 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/SendWithShipmentIndicator |
Specifies if an invoice is sent wth the shipment.
Allowable Values:
Y - send invoice with the shipment
N - do not send invoice with the shipment
Required: Yes
Length: 1
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
InvoiceTemplate |
AnyType |
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/InvoiceTemplate |
Encapsulates the invoice template details on which the tax invoice will be printed |
| |
|
|
|
|
InvoiceTemplateId |
String |
No |
0 |
0 |
1 |
|
20 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/InvoiceTemplate/InvoiceTemplateId |
If multiple templates are used by the warehouse, this is an identifying field.
Allowable Values: Text string
Required: No
Length: 20
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
InvoiceTemplateLanguage |
String |
No |
0 |
0 |
1 |
|
2 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/InvoiceTemplate/InvoiceTemplateLanguage |
Two character identifier if a language is required.
Allowable Values: Lower-case, two-letter codes as defined by ISO-639.
Required: No
Length: 2
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
TaxInvoiceData |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData |
Encapsulates all the details for VAT invoice. |
| |
|
|
|
|
TaxInvoiceId |
String |
Yes |
0 |
1 |
1 |
|
20 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/TaxInvoiceId |
The VAT invoice ID or a unique identification id for the invoice.
Allowable Values: Text string
Required: Yes
Length: 20
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
TaxInvoiceDate |
|
Yes |
0 |
1 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/TaxInvoiceDate |
The invoice date of the VAT invoice. Typically the date of allocation of the order. Follows ISO 8601 standard.
Allowable Values: 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: Yes
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
CustomerFiscalDetail |
AnyType |
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/CustomerFiscalDetail |
Optional but required in case of the Exchange Platform transactions |
| |
|
|
|
|
|
CustomerTaxId |
String |
No |
0 |
0 |
1 |
|
20 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/CustomerFiscalDetail/CustomerTaxId |
Typically only required on a Exchange Platform sale. It is the VAT ID of the customer company.
Allowable Values: Text string
Required: No
Length: 20
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
|
CustomerTaxRegistrationCountry |
String |
No |
0 |
0 |
1 |
|
2 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/CustomerFiscalDetail/CustomerTaxRegistrationCountry |
The country code of VAT registration for the customer.
Allowable Values: Country code following the ISO 3166-2 standard
Required: No
Length: 2
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
|
Salutation |
String |
No |
0 |
0 |
1 |
|
15 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/CustomerFiscalDetail/Salutation |
The salutation of the Bill-to customer. Typically "Dr.", "Mr.", "Ms." etc.
Allowable Values: Text string.
Required: No
Length: 15
Default Value: blank
Restrictions: N/A
Aliases: Salutation |
| |
|
|
|
|
|
FirstName |
String |
Yes |
0 |
1 |
1 |
|
64 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/CustomerFiscalDetail/FirstName |
The first name of the person.
Allowable Values: Text string.
Required: Yes
Length: 64
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
|
LastName |
String |
No |
0 |
0 |
1 |
|
64 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/CustomerFiscalDetail/LastName |
The surname of the person.
Allowable Values: Text string.
Required: Yes
Length: 64
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
|
Address |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/CustomerFiscalDetail/Address |
|
| |
|
|
|
|
|
|
CompanyName |
String |
No |
0 |
0 |
1 |
|
50 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/CustomerFiscalDetail/Address/CompanyName |
|
| |
|
|
|
|
|
|
AddressLine1 |
String |
Yes |
0 |
1 |
1 |
|
70 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/CustomerFiscalDetail/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 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/CustomerFiscalDetail/Address/AddressLine2 |
|
| |
|
|
|
|
|
|
AddressLine3 |
String |
No |
0 |
0 |
1 |
|
70 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/CustomerFiscalDetail/Address/AddressLine3 |
|
| |
|
|
|
|
|
|
City |
String |
Yes |
0 |
1 |
1 |
|
35 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/CustomerFiscalDetail/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 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/CustomerFiscalDetail/Address/StateOrProvince |
The state, province or other country sub-division code for the store address.
Allowable Values: Text string. 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 |
|
20 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/CustomerFiscalDetail/Address/CountyOrLocality |
Additonal information about the address
Allowable Values: Text string
Required: Yes
Length: 20
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
|
|
CountryCode |
String |
Yes |
0 |
1 |
1 |
|
3 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/CustomerFiscalDetail/Address/CountryCode |
The country code for the address.
Allowable Values: Text string. 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 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/CustomerFiscalDetail/Address/PostalCode |
An additional part of an address that further clarifies the location, for example, the zip code in the United States.
Allowable Values: Text string
Required: No
Length: 35
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
|
Telephone |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/CustomerFiscalDetail/Telephone |
|
| |
|
|
|
|
|
|
TelephoneType |
String |
No |
0 |
0 |
1 |
|
18 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/CustomerFiscalDetail/Telephone/TelephoneType |
Indicates where the phone number is located (home, business, mobile, etc.).
Allowable Values:
DayFaxNo - Daytime Fax Number
DayPhone - Daytime Phone Number
EveningFaxNo - Evening Fax Number
EveningPhone - Evening Phone Number
MobilePhone - Mobile Phone Number
OtherPhone - Other Phone Number
Required: No
Length: 18
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
|
|
AreaCode |
String |
No |
0 |
0 |
1 |
|
5 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/CustomerFiscalDetail/Telephone/AreaCode |
Specifies the region within a country where the phone number is located.
Allowable Values: Text string
Required: No
Length: 5
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
|
|
CountryCode |
String |
No |
0 |
0 |
1 |
|
3 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/CustomerFiscalDetail/Telephone/CountryCode |
Specifies the country where the phone number is located.
Allowable Values: Text string
Required: No
Length: 3
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
|
|
ExtensionNumber |
String |
No |
0 |
0 |
1 |
|
5 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/CustomerFiscalDetail/Telephone/ExtensionNumber |
Specifies the extension within an organization where the phone number is located.
Allowable Values: Text string
Required: No
Length: 3
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
|
|
TelephoneNumber |
String |
No |
0 |
0 |
1 |
|
18 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/CustomerFiscalDetail/Telephone/TelephoneNumber |
The telephone number as entered without a country code.
Allowable Values: Text string.
Required: No
Length: 18
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
|
|
FullTelephoneNumber |
String |
No |
0 |
0 |
1 |
|
40 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/CustomerFiscalDetail/Telephone/FullTelephoneNumber |
The telephone number as entered with a country code. If the country code is not entered, his field and the TelephoneNumber field are the same.
Allowable Values: Text string.
Required: No
Length: 40
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
SupplierAdministrativeDetail |
AnyType |
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/SupplierAdministrativeDetail |
Encapsulates the Supplier's Administrative Address and name details |
| |
|
|
|
|
|
SupplierTaxId |
String |
No |
0 |
0 |
1 |
|
20 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/SupplierAdministrativeDetail/SupplierTaxId |
The VAT ID of the selling party. Typically required for VAT invoices. Format varies by registration country. |
| |
|
|
|
|
|
SupplierTaxRegistrationCountry |
String |
No |
0 |
0 |
1 |
|
2 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/SupplierAdministrativeDetail/SupplierTaxRegistrationCountry |
The country code of VAT registration for the supplier following the ISO 3166-2 standard. |
| |
|
|
|
|
|
Address |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/SupplierAdministrativeDetail/Address |
|
| |
|
|
|
|
|
|
CompanyName |
String |
No |
0 |
0 |
1 |
|
50 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/SupplierAdministrativeDetail/Address/CompanyName |
|
| |
|
|
|
|
|
|
AddressLine1 |
String |
Yes |
0 |
1 |
1 |
|
70 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/SupplierAdministrativeDetail/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 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/SupplierAdministrativeDetail/Address/AddressLine2 |
|
| |
|
|
|
|
|
|
AddressLine3 |
String |
No |
0 |
0 |
1 |
|
70 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/SupplierAdministrativeDetail/Address/AddressLine3 |
|
| |
|
|
|
|
|
|
City |
String |
Yes |
0 |
1 |
1 |
|
35 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/SupplierAdministrativeDetail/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 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/SupplierAdministrativeDetail/Address/StateOrProvince |
The state, province or other country sub-division code for the store address.
Allowable Values: Text string. 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 |
|
20 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/SupplierAdministrativeDetail/Address/CountyOrLocality |
Additonal information about the address
Allowable Values: Text string
Required: Yes
Length: 20
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
|
|
CountryCode |
String |
Yes |
0 |
1 |
1 |
|
3 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/SupplierAdministrativeDetail/Address/CountryCode |
The country code for the address.
Allowable Values: Text string. 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 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/SupplierAdministrativeDetail/Address/PostalCode |
An additional part of an address that further clarifies the location, for example, the zip code in the United States.
Allowable Values: Text string
Required: No
Length: 35
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
|
Telephone |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/SupplierAdministrativeDetail/Telephone |
|
| |
|
|
|
|
|
|
TelephoneType |
String |
No |
0 |
0 |
1 |
|
18 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/SupplierAdministrativeDetail/Telephone/TelephoneType |
Indicates where the phone number is located (home, business, mobile, etc.).
Allowable Values:
DayFaxNo - Daytime Fax Number
DayPhone - Daytime Phone Number
EveningFaxNo - Evening Fax Number
EveningPhone - Evening Phone Number
MobilePhone - Mobile Phone Number
OtherPhone - Other Phone Number
Required: No
Length: 18
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
|
|
AreaCode |
String |
No |
0 |
0 |
1 |
|
5 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/SupplierAdministrativeDetail/Telephone/AreaCode |
Specifies the region within a country where the phone number is located.
Allowable Values: Text string
Required: No
Length: 5
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
|
|
CountryCode |
String |
No |
0 |
0 |
1 |
|
3 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/SupplierAdministrativeDetail/Telephone/CountryCode |
Specifies the country where the phone number is located.
Allowable Values: Text string
Required: No
Length: 3
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
|
|
ExtensionNumber |
String |
No |
0 |
0 |
1 |
|
5 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/SupplierAdministrativeDetail/Telephone/ExtensionNumber |
Specifies the extension within an organization where the phone number is located.
Allowable Values: Text string
Required: No
Length: 3
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
|
|
TelephoneNumber |
String |
No |
0 |
0 |
1 |
|
18 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/SupplierAdministrativeDetail/Telephone/TelephoneNumber |
The telephone number as entered without a country code.
Allowable Values: Text string.
Required: No
Length: 18
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
|
|
FullTelephoneNumber |
String |
No |
0 |
0 |
1 |
|
40 |
/OrdersToFulfill/Order/OrderHeader/TaxInvoice/TaxInvoiceData/SupplierAdministrativeDetail/Telephone/FullTelephoneNumber |
The telephone number as entered with a country code. If the country code is not entered, his field and the TelephoneNumber field are the same.
Allowable Values: Text string.
Required: No
Length: 40
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
PaymentInvoice |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/OrdersToFulfill/Order/OrderHeader/PaymentInvoice |
Encapsulates the Payment details for tax |
| |
|
|
|
PaymentInvoiceType |
String |
Yes |
0 |
1 |
1 |
|
15 |
/OrdersToFulfill/Order/OrderHeader/PaymentInvoice/PaymentInvoiceType |
Indicates the payment type. For e.g. OpenInvoice etc.
Allowable Values: Text string. User-defined.
Required: Yes
Length: 15
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
PaymentInvoiceId |
String |
No |
0 |
0 |
1 |
|
20 |
/OrdersToFulfill/Order/OrderHeader/PaymentInvoice/PaymentInvoiceId |
Identifier for the payment invoice. For e.g. OpenInvoiceId
etc.
Allowable Values: Text string
Required: No
Length: 20
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
Locale |
String |
Yes |
0 |
1 |
1 |
|
5 |
/OrdersToFulfill/Order/OrderHeader/PaymentInvoice/Locale |
The locale code of the environment in which the order was placed. The locale defines the language and country rules to be applied to the data.
Allowable Values: Text string. 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 ISO country code.
Common values:
en_US - English/United States
fr_CA - French/Canada
en_GB - English/United Kingdom
de_DE - German/Germany
fr_FR - French/France
Required: Yes
Length: 5
Default Value: blank
Restrictions: N/A
Aliases: N/A. |
| |
|
|
|
PaymentTerms |
AnyType |
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/PaymentInvoice/PaymentTerms |
Specify the payment terms and conditions |
| |
|
|
|
|
TermsTypeCode |
String |
No |
0 |
0 |
1 |
|
2 |
/OrdersToFulfill/Order/OrderHeader/PaymentInvoice/PaymentTerms/TermsTypeCode |
Code identifying type of payment terms. Example ZZ=Mutually Defined.
Allowable Values: Text string. User-defined.
Required: No
Length: 2
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
TermsBasisDateCode |
String |
No |
0 |
0 |
1 |
|
2 |
/OrdersToFulfill/Order/OrderHeader/PaymentInvoice/PaymentTerms/TermsBasisDateCode |
Code identifying the beginning of the terms period. Example ZZ=Mutually Defined.
Allowable Values: Text string. User-defined
Required: No
Length: 2
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
TermsNetdays |
|
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/PaymentInvoice/PaymentTerms/TermsNetdays |
When the customer owes money for the order (such as open invoice) this is the number of days when payment is due.
Allowable Values: Integer
Required: .If TermsNetDueDate is not present then TermsNetDays is required
Length: 3
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
TermsNetDueDate |
|
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/PaymentInvoice/PaymentTerms/TermsNetDueDate |
When the customer owes money for the order (such as open invoice) this is the date payment is due. Follows ISO 8601 standard.
Allowable Values: 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: If TermsNetday is not present then TermsNetDueDate is required.
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
CommentText |
String |
No |
1..n |
0 |
-1 |
|
4000 |
/OrdersToFulfill/Order/OrderHeader/PaymentInvoice/PaymentTerms/CommentText |
Free form comments and description related to payment terms.
Allowable Values: Text string
Required: No
Length: 4000
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
PaymentDetails |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/OrdersToFulfill/Order/OrderHeader/PaymentInvoice/PaymentDetails |
|
| |
|
|
|
|
PaymentMethod |
String |
No |
0 |
0 |
1 |
|
2 |
/OrdersToFulfill/Order/OrderHeader/PaymentInvoice/PaymentDetails/PaymentMethod |
A Payment method identifier that a customer would use to pay for the invoice. For e.g. DD=DirectDebit.
Allowable Values: Text string. User-defined.
Required: No
Length: 2
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
PaymentChannel |
String |
No |
0 |
0 |
1 |
|
25 |
/OrdersToFulfill/Order/OrderHeader/PaymentInvoice/PaymentDetails/PaymentChannel |
For most suppliers, this will be a part of the template for open invoices.
Allowable Values: Text string
Required: No
Length: 25
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
AccountDetails |
AnyType |
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/PaymentInvoice/PaymentDetails/AccountDetails |
|
| |
|
|
|
|
|
BankCode |
|
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/PaymentInvoice/PaymentDetails/AccountDetails/BankCode |
Bank Code.
Allowable Values: Integer
Required: No
Length: 10
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
|
AccountNumber |
String |
No |
0 |
0 |
1 |
|
40 |
/OrdersToFulfill/Order/OrderHeader/PaymentInvoice/PaymentDetails/AccountDetails/AccountNumber |
Account Number.
Allowable Values: Text string
Required: No
Length: 40
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
|
AccountHolderName |
String |
No |
0 |
0 |
1 |
|
35 |
/OrdersToFulfill/Order/OrderHeader/PaymentInvoice/PaymentDetails/AccountDetails/AccountHolderName |
Name of the Account Holder.
Allowable Values: Text string
Required: No
Length: 35
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
|
Instructions |
String |
No |
1..n |
0 |
-1 |
|
254 |
/OrdersToFulfill/Order/OrderHeader/PaymentInvoice/PaymentDetails/AccountDetails/Instructions |
Additional instructions or information needed for the payment.
Allowable Values: Text string
Required: No
Length: 254
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
BalanceCleared |
Decimal |
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/PaymentInvoice/PaymentDetails/BalanceCleared |
The total amount of the order already paid in the transaction currency.
Allowable Values: Decimal
Required: No
Length: 16.5
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
PayableAmount |
Decimal |
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/PaymentInvoice/PaymentDetails/PayableAmount |
The total amount still due on the order in the transaction currency.
Allowable Values: Decimal
Required: No
Length: 16.5
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
CurrencyCode |
String |
No |
0 |
0 |
1 |
|
3 |
/OrdersToFulfill/Order/OrderHeader/PaymentInvoice/PaymentDetails/CurrencyCode |
The type of currency (dollars, francs, etc.) associated with the monetary amount.
Allowable Values: ISO 4217 currency code. http://www.iso.org/iso/support/currency_codes_list-1.htm
Required: Yes
Length: 3
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
ConversionRate |
Decimal |
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/PaymentInvoice/PaymentDetails/ConversionRate |
The conversion rate applied from 1 of the charged currency to this many of the local currency.
Allowable Values: Decimal
Required: No
Length: 6.5
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
ReturnLabel |
AnyType |
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/ReturnLabel |
Encapsulates the data required to create the shipping return label provided with some orders. The shipping return label is provided with certain items to allow the customer the ability to easily return an item without printing an additional return shipping label. |
| |
|
|
|
ReturnLabelNumber |
String |
Yes |
0 |
1 |
1 |
|
48 |
/OrdersToFulfill/Order/OrderHeader/ReturnLabel/ReturnLabelNumber |
Return Label ID |
| |
|
|
|
SecondaryReturnLabelNumber |
String |
Yes |
0 |
1 |
1 |
|
48 |
/OrdersToFulfill/Order/OrderHeader/ReturnLabel/SecondaryReturnLabelNumber |
Secondary Return Label ID |
| |
|
|
|
MaxiCode |
AnyType |
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/ReturnLabel/MaxiCode |
Encapsulates the MaxiCode of the return location to be included on the return label. |
| |
|
|
|
|
TransportationFormat |
|
Yes |
0 |
1 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/ReturnLabel/MaxiCode/TransportationFormat |
Unique Trans format number assigned to the MaxiCode.
Allowable Values: Text string
Required: No
Length: 2
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
DateValue |
|
Yes |
0 |
1 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/ReturnLabel/MaxiCode/DateValue |
Unique DateValue assigned to the MaxiCode.
Allowable Values: Text string
Required: No
Length: 2
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
JulianPickupDate |
|
Yes |
0 |
1 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/ReturnLabel/MaxiCode/JulianPickupDate |
Unique Julian Date assigned to the MaxiCode.
Allowable Values: Text string
Required: No
Length: 3
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
DestinationCity |
String |
Yes |
0 |
1 |
1 |
|
20 |
/OrdersToFulfill/Order/OrderHeader/ReturnLabel/MaxiCode/DestinationCity |
DestinationCity |
| |
|
|
|
|
DestinationState |
String |
Yes |
0 |
1 |
1 |
|
2 |
/OrdersToFulfill/Order/OrderHeader/ReturnLabel/MaxiCode/DestinationState |
DestinationState |
| |
|
|
|
|
DestinationZipCode |
|
Yes |
0 |
1 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/ReturnLabel/MaxiCode/DestinationZipCode |
Unique Postal Code assigned to the MaxiCode.
Allowable Values: Text string
Required: No
Length: 9
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
DestinationCountryCode |
|
Yes |
0 |
1 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/ReturnLabel/MaxiCode/DestinationCountryCode |
Unique country code assigned to the MaxiCode.
Allowable Values: Text string
Required: No
Length: 3
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
AddressValidation |
String |
Yes |
0 |
1 |
1 |
|
1 |
/OrdersToFulfill/Order/OrderHeader/ReturnLabel/MaxiCode/AddressValidation |
AddressValidation |
| |
|
|
|
|
UPSService |
|
Yes |
0 |
1 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/ReturnLabel/MaxiCode/UPSService |
Unique UPS service number assigned to the MaxiCode.
Allowable Values: Text string
Required: No
Length: 3
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
UPSAccountNumber |
String |
Yes |
0 |
1 |
1 |
|
6 |
/OrdersToFulfill/Order/OrderHeader/ReturnLabel/MaxiCode/UPSAccountNumber |
UPSAccountNumber |
| |
|
|
|
|
TrackingNumber |
String |
Yes |
0 |
1 |
1 |
|
10 |
/OrdersToFulfill/Order/OrderHeader/ReturnLabel/MaxiCode/TrackingNumber |
TrackingNumber |
| |
|
|
|
|
SCAC |
String |
Yes |
0 |
1 |
1 |
|
4 |
/OrdersToFulfill/Order/OrderHeader/ReturnLabel/MaxiCode/SCAC |
DestinationCity |
| |
|
|
|
|
PackageCode |
String |
Yes |
0 |
1 |
1 |
|
3 |
/OrdersToFulfill/Order/OrderHeader/ReturnLabel/MaxiCode/PackageCode |
PackageCode |
| |
|
|
|
|
PackageWeight |
|
Yes |
0 |
1 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/ReturnLabel/MaxiCode/PackageWeight |
Unique Weight assigned to the MaxiCode.
Allowable Values: Text string
Required: No
Length: 3
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
PostalBarCode |
String |
Yes |
0 |
1 |
1 |
|
256 |
/OrdersToFulfill/Order/OrderHeader/ReturnLabel/PostalBarCode |
Postal Bar Code |
| |
|
|
|
PackageWeight |
String |
Yes |
0 |
1 |
1 |
|
15 |
/OrdersToFulfill/Order/OrderHeader/ReturnLabel/PackageWeight |
Package Weight |
| |
|
|
|
ReturnLabelFee |
Decimal |
Yes |
0 |
1 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/ReturnLabel/ReturnLabelFee |
The monetary amount associated with the return label.
Allowable Values: Decimal
Required: Yes
Length: 16.5
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
ReturnAddress |
AnyType |
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/ReturnLabel/ReturnAddress |
Encapsulates the address of the return location to be included on the return label. |
| |
|
|
|
|
CompanyName |
String |
No |
0 |
0 |
1 |
|
50 |
/OrdersToFulfill/Order/OrderHeader/ReturnLabel/ReturnAddress/CompanyName |
|
| |
|
|
|
|
AddressLine1 |
String |
Yes |
0 |
1 |
1 |
|
70 |
/OrdersToFulfill/Order/OrderHeader/ReturnLabel/ReturnAddress/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 |
/OrdersToFulfill/Order/OrderHeader/ReturnLabel/ReturnAddress/AddressLine2 |
|
| |
|
|
|
|
AddressLine3 |
String |
No |
0 |
0 |
1 |
|
70 |
/OrdersToFulfill/Order/OrderHeader/ReturnLabel/ReturnAddress/AddressLine3 |
|
| |
|
|
|
|
City |
String |
Yes |
0 |
1 |
1 |
|
35 |
/OrdersToFulfill/Order/OrderHeader/ReturnLabel/ReturnAddress/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 |
/OrdersToFulfill/Order/OrderHeader/ReturnLabel/ReturnAddress/StateOrProvince |
The state, province or other country sub-division code for the store address.
Allowable Values: Text string. 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 |
|
20 |
/OrdersToFulfill/Order/OrderHeader/ReturnLabel/ReturnAddress/CountyOrLocality |
Additonal information about the address
Allowable Values: Text string
Required: Yes
Length: 20
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
CountryCode |
String |
Yes |
0 |
1 |
1 |
|
3 |
/OrdersToFulfill/Order/OrderHeader/ReturnLabel/ReturnAddress/CountryCode |
The country code for the address.
Allowable Values: Text string. 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 |
/OrdersToFulfill/Order/OrderHeader/ReturnLabel/ReturnAddress/PostalCode |
An additional part of an address that further clarifies the location, for example, the zip code in the United States.
Allowable Values: Text string
Required: No
Length: 35
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
ReturnLabelType |
String |
Yes |
0 |
1 |
1 |
|
2 |
/OrdersToFulfill/Order/OrderHeader/ReturnLabel/ReturnLabelType |
The Return Label Type.
Allowable Values: Text string. User-defined.
Required: Yes
Length: 2
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
PackageNumber |
|
Yes |
0 |
1 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/ReturnLabel/PackageNumber |
Unique package number assigned to the return label.
Allowable Values: Text string
Required: Yes
Length: 8
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
PermitNumber |
String |
No |
0 |
0 |
1 |
|
20 |
/OrdersToFulfill/Order/OrderHeader/ReturnLabel/PermitNumber |
The permit number assigned to the return label.
Allowable Values: Text string
Required: No
Length: 20
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
Comment |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/OrdersToFulfill/Order/OrderHeader/Comment |
Encapsulates details needed to add order specific comments to a pack slip, shipping label, the distribution center personnel, etc. |
| |
|
|
|
CommentSequence |
|
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/Comment/CommentSequence |
Sequence of the comment typically used when multiple comments are provided on the same line.
Allowable Values: Integer
Required: No
Length: 4
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
CommentType |
String |
No |
0 |
0 |
1 |
|
10 |
/OrdersToFulfill/Order/OrderHeader/Comment/CommentType |
The type of customization needed.
Required: No
Length: 10
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
CommentText |
String |
No |
0 |
0 |
1 |
|
4000 |
/OrdersToFulfill/Order/OrderHeader/Comment/CommentText |
Additional instructions needed for the comment type.
Allowable Values: Text string
Required: No
Length: 4000
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
CommentName |
String |
No |
0 |
0 |
1 |
|
4000 |
/OrdersToFulfill/Order/OrderHeader/Comment/CommentName |
Name to identify the comment text for a given CommentType.
Allowable Values: Text string
Required: No
Length: 4000
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
Gift |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/OrdersToFulfill/Order/OrderHeader/Gift |
Encapsulates details needed for Gift Wrap at the order level. When Gift Wrap is present at the order level then it can not be at the item level and vice versa. |
| |
|
|
|
GiftWrapId |
String |
No |
0 |
0 |
1 |
|
15 |
/OrdersToFulfill/Order/OrderHeader/Gift/GiftWrapId |
Identifier for the type of gift wrapping paper that should be used.
Allowable Values: Text string
Required: No
Length: 15
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
WrapGroupNumber |
|
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/Gift/WrapGroupNumber |
Used when items are to be wrapped together.
Allowable Values: Integer
Required: No
Length: 5
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
GiftMessageSequence |
|
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/Gift/GiftMessageSequence |
Sequence of the comment typically used when multiple messages are provided on the same line.
Allowable Values: Integer
Required: No
Length: 4
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
GiftMessageType |
String |
No |
0 |
0 |
1 |
|
10 |
/OrdersToFulfill/Order/OrderHeader/Gift/GiftMessageType |
The type of gift message needed.
Allowable Values:
DST_GIFT - Destination-level gifting instructions
GIFT - Line level gifting instructions
Required: No
Length: 10
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
GiftMessage |
String |
No |
0 |
0 |
1 |
|
254 |
/OrdersToFulfill/Order/OrderHeader/Gift/GiftMessage |
The text of the gift message.
Allowable Values: Text string
Required: No
Length: 254
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
OrderLineRelationships |
AnyType |
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/OrderLineRelationships |
Container for OrderLineRelationship. |
| |
|
|
|
OrderLineRelationship |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/OrdersToFulfill/Order/OrderHeader/OrderLineRelationships/OrderLineRelationship |
Defines the relationship between a parent line and its children lines. |
| |
|
|
|
|
RelationshipType |
String |
Yes |
0 |
1 |
1 |
|
40 |
/OrdersToFulfill/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 |
|
|
/OrdersToFulfill/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 |
|
|
/OrdersToFulfill/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 |
| |
|
|
AssociateDetails |
AnyType |
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/AssociateDetails |
Defines the AOS Associate details for the order placed |
| |
|
|
|
AssociateName |
String |
No |
0 |
0 |
1 |
|
150 |
/OrdersToFulfill/Order/OrderHeader/AssociateDetails/AssociateName |
Associate (employee) name for AOS (in-store) orders.
Allowable Values: Text string
Required: No
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
AssociateNumber |
String |
No |
0 |
0 |
1 |
|
20 |
/OrdersToFulfill/Order/OrderHeader/AssociateDetails/AssociateNumber |
Associate (employee) number for AOS (in-store) orders.
Allowable Values: Text string
Required: No
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
AssociateStore |
String |
No |
0 |
0 |
1 |
|
20 |
/OrdersToFulfill/Order/OrderHeader/AssociateDetails/AssociateStore |
Store number for AOS (in-store) orders.
Allowable Values: Text string
Required: No
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
AdditionalOrderAttributes |
AnyType |
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderHeader/AdditionalOrderAttributes |
Encapsulates the addtional order header level attributes pass thru from Webstore. |
| |
|
|
|
TaxExemptionId |
String |
No |
0 |
0 |
1 |
|
40 |
/OrdersToFulfill/Order/OrderHeader/AdditionalOrderAttributes/TaxExemptionId |
Tax Exemption Certificate information for the order.
Allowable Values: Text string
Required: No
Length: 40
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
ExtendedAttributes |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/OrdersToFulfill/Order/OrderHeader/ExtendedAttributes |
|
| |
|
|
|
Name |
String |
No |
0 |
0 |
1 |
|
30 |
/OrdersToFulfill/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 |
/OrdersToFulfill/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 |
/OrdersToFulfill/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 |
| |
|
OrderDetail |
AnyType |
Yes |
1..n |
1 |
-1 |
|
|
/OrdersToFulfill/Order/OrderDetail |
Encapsulates the order line details for the order invoice. |
| |
|
|
LineNumber |
|
Yes |
0 |
1 |
1 |
|
|
/OrdersToFulfill/Order/OrderDetail/LineNumber |
The line sequence number.
Allowable Values: Integer
Required: Yes
Length: 4
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
ItemId |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/OrdersToFulfill/Order/OrderDetail/ItemId |
Encapsulates the order line details for the order invoice. |
| |
|
|
|
GsiCatalogId |
String |
Yes |
0 |
1 |
1 |
|
4 |
/OrdersToFulfill/Order/OrderDetail/ItemId/GsiCatalogId |
Radial assigned unique V11 catalog id for each client (gsi_client_id).
Allowable Values: Text string
Required: Yes
Length: 4
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
ClientItemId |
String |
Yes |
0 |
1 |
1 |
|
35 |
/OrdersToFulfill/Order/OrderDetail/ItemId/ClientItemId |
The retailer's/client's/partner's SKU number or unique item identifier. (Partner Item Number).
Allowable Values: Text string
Required: Yes
Length: 35
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
OMSItemId |
|
Yes |
0 |
1 |
1 |
|
|
/OrdersToFulfill/Order/OrderDetail/ItemId/OMSItemId |
The Order Management Systems internally assigned SKU or unique item identifier.
Allowable Values: Integer
Required: Yes
Length: 9
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
ClientAltItemId |
String |
No |
0 |
0 |
1 |
|
15 |
/OrdersToFulfill/Order/OrderDetail/ItemId/ClientAltItemId |
An Alternative item identifier provided by the client. Typically used for reference information only and not to identify/locate an item.
Allowable Values: Text string
Required: No
Length: 15
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
SupplierItemId |
String |
No |
0 |
0 |
1 |
|
15 |
/OrdersToFulfill/Order/OrderDetail/ItemId/SupplierItemId |
The code assigned by the supplier to uniquely identify the Item. (Vendor SKU, Vendor Item Number).
Allowable Values: Text string
Required: No
Length: 15
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
ManufacturerItemId |
String |
No |
0 |
0 |
1 |
|
15 |
/OrdersToFulfill/Order/OrderDetail/ItemId/ManufacturerItemId |
The code assigned to the item by the manufacturer to uniquely identify the item. Manufacturer's SKU or item number.
Allowable Values: Text string
Required: No
Length: 15
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
UPCList |
AnyType |
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderDetail/ItemId/UPCList |
Encapsulates the UPC information on the item. |
| |
|
|
|
|
ItemUPC |
AnyType |
Yes |
1..n |
1 |
-1 |
|
|
/OrdersToFulfill/Order/OrderDetail/ItemId/UPCList/ItemUPC |
|
| |
|
|
|
|
|
UPC |
String |
Yes |
0 |
1 |
1 |
|
128 |
/OrdersToFulfill/Order/OrderDetail/ItemId/UPCList/ItemUPC/UPC |
UPCs (Universal Product Code) or GTINs (Global Trade Identification Number) refer to a specific barcode encoding used mainly in the United States and Canada and are most commonly 12, 13 or 14 digits long.
Allowable Values: Text string
Required: Yes
Length: 128
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
|
UPCType |
String |
Yes |
0 |
1 |
1 |
|
128 |
/OrdersToFulfill/Order/OrderDetail/ItemId/UPCList/ItemUPC/UPCType |
The type of UPC (ex. A).
Allowable Values: Text string
Required: Yes
Length: 128
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
ExtendedAttributes |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/OrdersToFulfill/Order/OrderDetail/ItemId/ExtendedAttributes |
|
| |
|
|
|
|
Name |
String |
No |
0 |
0 |
1 |
|
30 |
/OrdersToFulfill/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 |
/OrdersToFulfill/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 |
/OrdersToFulfill/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 |
| |
|
|
ItemAttributes |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/OrdersToFulfill/Order/OrderDetail/ItemAttributes |
Encapsulates descriptive information regarding the identified item. |
| |
|
|
|
ItemDescription |
String |
Yes |
0 |
1 |
1 |
|
4000 |
/OrdersToFulfill/Order/OrderDetail/ItemAttributes/ItemDescription |
Title or Short Description of the Item of the client’s item.
Allowable Values: Text string
Required: Yes
Length: 4000
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
SizeDescription |
String |
No |
0 |
0 |
1 |
|
4000 |
/OrdersToFulfill/Order/OrderDetail/ItemAttributes/SizeDescription |
The size of the item purchased.
Allowable Values: Text string
Required: No
Length: 4000
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
ColorDescription |
String |
No |
0 |
0 |
1 |
|
4000 |
/OrdersToFulfill/Order/OrderDetail/ItemAttributes/ColorDescription |
The color of the item purchased.
Allowable Values: Text string
Required: No
Length: 4000
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
OrderedQuantity |
Decimal |
Yes |
0 |
1 |
1 |
|
|
/OrdersToFulfill/Order/OrderDetail/ItemAttributes/OrderedQuantity |
The number of items ordered.
Allowable Values: Decimal
Required: Yes
Length: 10.2
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
OriginalUnitPrice |
Decimal |
Yes |
0 |
1 |
1 |
|
|
/OrdersToFulfill/Order/OrderDetail/ItemAttributes/OriginalUnitPrice |
The price for one unit of the item.
Allowable Values: Decimal
Required: Yes
Length: 16.5
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
OriginalRetailUnitPrice |
Decimal |
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderDetail/ItemAttributes/OriginalRetailUnitPrice |
The original price for one unit of the item.
Allowable Values: Decimal
Required: Yes
Length: 16.5
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
CurrencyCode |
String |
Yes |
0 |
1 |
1 |
|
3 |
/OrdersToFulfill/Order/OrderDetail/ItemAttributes/CurrencyCode |
The type of currency (dollars, francs, etc.) associated with the monetary amount.
Allowable Values: ISO 4217 currency code. http://www.iso.org/iso/support/currency_codes_list-1.htm
Required: Yes
Length: 3
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
ProductLine |
String |
No |
0 |
0 |
1 |
|
40 |
/OrdersToFulfill/Order/OrderDetail/ItemAttributes/ProductLine |
Defines the hierarchy [Department] of the item in the format of Dept.SubDept.Class.SubClass.
Allowable Values: Text string
Required: No
Length: 40
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
ConfigurationId |
String |
No |
0 |
0 |
1 |
|
30 |
/OrdersToFulfill/Order/OrderDetail/ItemAttributes/ConfigurationId |
Defines the configuration id for CTO items.
Allowable Values: Text string
Required: No
Length: 30
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
KitCode |
String |
No |
0 |
0 |
1 |
|
30 |
/OrdersToFulfill/Order/OrderDetail/ItemAttributes/KitCode |
Defines the kit code for the kit lines. if present then defines the item to be CTO.
Allowable Values: Text string
Required: No
Length: 30
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
ReshipFlag |
|
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderDetail/ItemAttributes/ReshipFlag |
Will be used to indicate whether line is a is a reship - default false.
Allowable Values:
true - item is a reship
false - item is not a reship
Required: No
Length: TBD
Default Value: false
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
ExtendedAttributes |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/OrdersToFulfill/Order/OrderDetail/ItemAttributes/ExtendedAttributes |
|
| |
|
|
|
|
Name |
String |
No |
0 |
0 |
1 |
|
30 |
/OrdersToFulfill/Order/OrderDetail/ItemAttributes/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 |
/OrdersToFulfill/Order/OrderDetail/ItemAttributes/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 |
/OrdersToFulfill/Order/OrderDetail/ItemAttributes/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 |
| |
|
|
KitLines |
AnyType |
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderDetail/KitLines |
|
| |
|
|
|
KitLine |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/OrdersToFulfill/Order/OrderDetail/KitLines/KitLine |
|
| |
|
|
|
|
ClientItemId |
String |
Yes |
0 |
1 |
1 |
|
35 |
/OrdersToFulfill/Order/OrderDetail/KitLines/KitLine/ClientItemId |
The retailer's/client's/partner's SKU number or unique item identifier. (Partner Item Number).
Allowable Values: Text string
Required: Yes
Length: 35
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
OMSItemId |
|
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderDetail/KitLines/KitLine/OMSItemId |
The Order Management Systems internally assigned SKU or unique item identifier.
Allowable Values: Integer
Required: No
Length: 9
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
KitQty |
Decimal |
Yes |
0 |
1 |
1 |
|
|
/OrdersToFulfill/Order/OrderDetail/KitLines/KitLine/KitQty |
quantity for the kit item.
Allowable Values: Decimal
Required: Yes
Length: 16.5
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
ProductClass |
String |
Yes |
0 |
1 |
1 |
|
30 |
/OrdersToFulfill/Order/OrderDetail/KitLines/KitLine/ProductClass |
Product class for the kit item.
Allowable Values: Text string
Required: Yes
Length: 30
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
UnitOfMeasure |
String |
Yes |
0 |
1 |
1 |
|
30 |
/OrdersToFulfill/Order/OrderDetail/KitLines/KitLine/UnitOfMeasure |
Product class for the kit item.
Allowable Values: Text string. Possible values include:
in
cm
lb
kg
Required: Yes
Length: 30
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
Promotions |
AnyType |
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderDetail/Promotions |
Encapsulates all promotions on the line |
| |
|
|
|
Promotion |
AnyType |
Yes |
1..n |
1 |
-1 |
|
|
/OrdersToFulfill/Order/OrderDetail/Promotions/Promotion |
|
| |
|
|
|
|
PromotionId |
String |
Yes |
0 |
1 |
1 |
|
100 |
/OrdersToFulfill/Order/OrderDetail/Promotions/Promotion/PromotionId |
The unique identifier of the promotion.
Allowable Values: Text string
Required: Yes
Length: 100
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
LineAmount |
AnyType |
Yes |
1..n |
1 |
-1 |
|
|
/OrdersToFulfill/Order/OrderDetail/LineAmount |
Encapsulates the various set of amounts that can be provided for an order. |
| |
|
|
|
Amount |
AnyType |
Yes |
0 |
1 |
1 |
|
|
/OrdersToFulfill/Order/OrderDetail/LineAmount/Amount |
|
| |
|
|
|
|
AmountType |
String |
Yes |
0 |
1 |
1 |
|
40 |
/OrdersToFulfill/Order/OrderDetail/LineAmount/Amount/AmountType |
Defines the type of amount included in the -Value- element.
Allowable Values: Text string.
Required: Yes
Length: 40
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
MonetaryAmount |
Decimal |
Yes |
0 |
1 |
1 |
|
|
/OrdersToFulfill/Order/OrderDetail/LineAmount/Amount/MonetaryAmount |
The monetary amount for the defined 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 |
/OrdersToFulfill/Order/OrderDetail/LineAmount/Amount/CurrencyCode |
The type of currency (dollars, francs, etc.) associated with the monetary amount.
Allowable Values: ISO 4217 currency code. http://www.iso.org/iso/support/currency_codes_list-1.htm
Required: Yes
Length: 3
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
ChargeName |
String |
No |
0 |
0 |
1 |
|
40 |
/OrdersToFulfill/Order/OrderDetail/LineAmount/Amount/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 |
| |
|
|
Tax |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/OrdersToFulfill/Order/OrderDetail/Tax |
Total line level tax amount |
| |
|
|
|
TaxType |
String |
Yes |
0 |
1 |
1 |
|
20 |
/OrdersToFulfill/Order/OrderDetail/Tax/TaxType |
The type of tax being imposed.
Allowable Values:
CONSUMERS_USE - use Tax applied to purchaser
IMPORT_VAT - VAT applied to the import of an item
NONE - No tax applied
SALES - Sales tax
SELLER_USE - Use tax applied to the selling organization
VAT - Value Added Tax
Required: Yes
Length: 20
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
Exemption |
String |
Yes |
0 |
1 |
1 |
|
1 |
/OrdersToFulfill/Order/OrderDetail/Tax/Exemption |
This defines if the item has Zero tax or not based on the tax amount.
Allowable Values:
Y - yes item is tax-exempt
N - no, item is not tax exempt
Required: Yes
Length: 1
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
Situs |
String |
Yes |
0 |
1 |
1 |
|
30 |
/OrdersToFulfill/Order/OrderDetail/Tax/Situs |
Address used in determining tax governance.
Allowable Values:
ADMINISTRATIVE_DESTINATION - Tax address of the receiving entity
ADMINISTRATIVE_ORIGIN - Tax address of the shipping entity
DESTINATION - Ship-to location
PHYSICAL_ORIGIN - Ship-from location
Required: Yes
Length: 30
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
Jurisdiction |
String |
No |
0 |
0 |
1 |
|
100 |
/OrdersToFulfill/Order/OrderDetail/Tax/Jurisdiction |
The name of the jurisdiction to which the tax is applied.
Allowable Values: Text strings
Required: No
Length: 100
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
JurisdictionLevel |
String |
No |
0 |
0 |
1 |
|
40 |
/OrdersToFulfill/Order/OrderDetail/Tax/JurisdictionLevel |
The level of the jurisdiction (ex. State, City).
Required: No
Length: 100
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
JurisdictionId |
String |
No |
0 |
0 |
1 |
|
9 |
/OrdersToFulfill/Order/OrderDetail/Tax/JurisdictionId |
The Vertex-specific number that identifies a juridiction.
Allowable Values: Integer
Required: No
Length: 9
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
Imposition |
String |
No |
0 |
0 |
1 |
|
60 |
/OrdersToFulfill/Order/OrderDetail/Tax/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 |
/OrdersToFulfill/Order/OrderDetail/Tax/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 |
|
|
/OrdersToFulfill/Order/OrderDetail/Tax/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 |
|
|
/OrdersToFulfill/Order/OrderDetail/Tax/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 |
|
|
/OrdersToFulfill/Order/OrderDetail/Tax/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: Yes
Length: 16.5
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
ChargeCategory |
String |
Yes |
0 |
1 |
1 |
|
20 |
/OrdersToFulfill/Order/OrderDetail/Tax/ChargeCategory |
The different categories of items/services for which the tax was charged.
Required: Yes
Length: 20
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
ChargeName |
String |
No |
0 |
0 |
1 |
|
40 |
/OrdersToFulfill/Order/OrderDetail/Tax/ChargeName |
The Name or Id associated with the Charge or Discount categories of items/services for which the tax was charged.
Allowable Values: Text string
Required: No
Length: 40
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
Comment |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/OrdersToFulfill/Order/OrderDetail/Comment |
|
| |
|
|
|
CommentSequence |
|
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderDetail/Comment/CommentSequence |
Sequence of the comment typically used when multiple comments are provided on the same line.
Allowable Values: Integer
Required: No
Length: 4
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
CommentType |
String |
No |
0 |
0 |
1 |
|
10 |
/OrdersToFulfill/Order/OrderDetail/Comment/CommentType |
The type of customization needed.
Required: No
Length: 10
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
CommentText |
String |
No |
0 |
0 |
1 |
|
4000 |
/OrdersToFulfill/Order/OrderDetail/Comment/CommentText |
Additional instructions needed for the comment type.
Allowable Values: Text string
Required: No
Length: 4000
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
CommentName |
String |
No |
0 |
0 |
1 |
|
4000 |
/OrdersToFulfill/Order/OrderDetail/Comment/CommentName |
Name to identify the comment text for a given CommentType.
Allowable Values: Text string
Required: No
Length: 4000
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
Gift |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/OrdersToFulfill/Order/OrderDetail/Gift |
|
| |
|
|
|
GiftWrapId |
String |
No |
0 |
0 |
1 |
|
15 |
/OrdersToFulfill/Order/OrderDetail/Gift/GiftWrapId |
Identifier for the type of gift wrapping paper that should be used.
Allowable Values: Text string
Required: No
Length: 15
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
WrapGroupNumber |
|
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderDetail/Gift/WrapGroupNumber |
Used when items are to be wrapped together.
Allowable Values: Integer
Required: No
Length: 5
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
GiftMessageSequence |
|
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderDetail/Gift/GiftMessageSequence |
Sequence of the comment typically used when multiple messages are provided on the same line.
Allowable Values: Integer
Required: No
Length: 4
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
GiftMessageType |
String |
No |
0 |
0 |
1 |
|
10 |
/OrdersToFulfill/Order/OrderDetail/Gift/GiftMessageType |
The type of gift message needed.
Allowable Values:
DST_GIFT - Destination-level gifting instructions
GIFT - Line level gifting instructions
Required: No
Length: 10
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
GiftMessage |
String |
No |
0 |
0 |
1 |
|
254 |
/OrdersToFulfill/Order/OrderDetail/Gift/GiftMessage |
The text of the gift message.
Allowable Values: Text string
Required: No
Length: 254
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
ShipGroup |
AnyType |
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderDetail/ShipGroup |
Encapsulates the shipping group information for items that are required to ship together. |
| |
|
|
|
ShipGroupNumber |
String |
No |
0 |
0 |
1 |
|
5 |
/OrdersToFulfill/Order/OrderDetail/ShipGroup/ShipGroupNumber |
Ship Group Number is used in the order management system to group lines so they can ship together. In the OMS, we wait until all items are in stock before dropping the detail line with the same ship group number to the warehouse. Use of Ship Group Number does not require (and usually does not have) a Ship Group Type or Ship Group Name.
Allowable Values: Text string
Required: No
Length: 5
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
ShipGroupType |
String |
No |
0 |
0 |
1 |
|
3 |
/OrdersToFulfill/Order/OrderDetail/ShipGroup/ShipGroupType |
Primarily used to print an indented pack slip.
Allowable Values: KIT
Required: No
Length: 3
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
ShipGroupName |
String |
No |
0 |
0 |
1 |
|
50 |
/OrdersToFulfill/Order/OrderDetail/ShipGroup/ShipGroupName |
The indenting along with the Ship Group Name help warehouse personnel "assembles" the order.
Allowable Values: Text string
Required: No
Length: 50
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
GroupId |
|
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderDetail/ShipGroup/GroupId |
Identifies groupings of items.
Allowable Values: Integer
Required: No
Length: 2
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
SpecialHandlingCode |
String |
No |
0 |
0 |
1 |
|
20 |
/OrdersToFulfill/Order/OrderDetail/SpecialHandlingCode |
Code used to define additional special shipping/handling items.
Allowable Values: Text string
Required: No
Length: 20
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
AccessCode |
String |
No |
0 |
0 |
1 |
|
20 |
/OrdersToFulfill/Order/OrderDetail/AccessCode |
PIN Number, Access Code for the item.
Allowable Values: Text string
Required: No
Length: 20
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
ProxyPickupInfo |
AnyType |
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderDetail/ProxyPickupInfo |
Contains information about the person, other than the buyer, who is designated to take delivery of a paid for purchase in a store. |
| |
|
|
|
ProxyPickupEmail |
String |
Yes |
0 |
1 |
1 |
|
150 |
/OrdersToFulfill/Order/OrderDetail/ProxyPickupInfo/ProxyPickupEmail |
Email of the person taking delivery of the order.
Allowable Values: Text string
Required: Yes
Length: 150
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
ProxyPickupName |
String |
Yes |
0 |
1 |
1 |
|
168 |
/OrdersToFulfill/Order/OrderDetail/ProxyPickupInfo/ProxyPickupName |
Name of the person taking delivery of the order.
Allowable Values: Text string
Required: Yes
Length: 168
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
ProxyPickupPhoneNumber |
String |
Yes |
0 |
1 |
1 |
|
40 |
/OrdersToFulfill/Order/OrderDetail/ProxyPickupInfo/ProxyPickupPhoneNumber |
Phone number of the person taking delivery of the order.
Allowable Values: Text string
Required: Yes
Length: 40
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
ProxyRelationshipType |
String |
No |
0 |
0 |
1 |
|
150 |
/OrdersToFulfill/Order/OrderDetail/ProxyPickupInfo/ProxyRelationshipType |
relationship between the customer and the person taking delivery of the order.
Allowable Values: Text string
Required: Yes
Length: 150
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
ProxyPickupAddress |
AnyType |
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderDetail/ProxyPickupInfo/ProxyPickupAddress |
Additional information for the person picking up the order to minimize the fraud |
| |
|
|
|
|
CompanyName |
String |
No |
0 |
0 |
1 |
|
50 |
/OrdersToFulfill/Order/OrderDetail/ProxyPickupInfo/ProxyPickupAddress/CompanyName |
|
| |
|
|
|
|
AddressLine1 |
String |
Yes |
0 |
1 |
1 |
|
70 |
/OrdersToFulfill/Order/OrderDetail/ProxyPickupInfo/ProxyPickupAddress/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 |
/OrdersToFulfill/Order/OrderDetail/ProxyPickupInfo/ProxyPickupAddress/AddressLine2 |
|
| |
|
|
|
|
AddressLine3 |
String |
No |
0 |
0 |
1 |
|
70 |
/OrdersToFulfill/Order/OrderDetail/ProxyPickupInfo/ProxyPickupAddress/AddressLine3 |
|
| |
|
|
|
|
City |
String |
Yes |
0 |
1 |
1 |
|
35 |
/OrdersToFulfill/Order/OrderDetail/ProxyPickupInfo/ProxyPickupAddress/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 |
/OrdersToFulfill/Order/OrderDetail/ProxyPickupInfo/ProxyPickupAddress/StateOrProvince |
The state, province or other country sub-division code for the store address.
Allowable Values: Text string. 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 |
|
20 |
/OrdersToFulfill/Order/OrderDetail/ProxyPickupInfo/ProxyPickupAddress/CountyOrLocality |
Additonal information about the address
Allowable Values: Text string
Required: Yes
Length: 20
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
CountryCode |
String |
Yes |
0 |
1 |
1 |
|
3 |
/OrdersToFulfill/Order/OrderDetail/ProxyPickupInfo/ProxyPickupAddress/CountryCode |
The country code for the address.
Allowable Values: Text string. 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 |
/OrdersToFulfill/Order/OrderDetail/ProxyPickupInfo/ProxyPickupAddress/PostalCode |
An additional part of an address that further clarifies the location, for example, the zip code in the United States.
Allowable Values: Text string
Required: No
Length: 35
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
OrderLineRelationships |
AnyType |
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderDetail/OrderLineRelationships |
Container for OrderLineRelationship. |
| |
|
|
|
OrderLineRelationship |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/OrdersToFulfill/Order/OrderDetail/OrderLineRelationships/OrderLineRelationship |
Defines the relationship between a parent line and its children lines. |
| |
|
|
|
|
RelationshipType |
String |
Yes |
0 |
1 |
1 |
|
40 |
/OrdersToFulfill/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 |
|
|
/OrdersToFulfill/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 |
|
|
/OrdersToFulfill/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 |
| |
|
|
ServicesInstructions |
AnyType |
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderDetail/ServicesInstructions |
Defines the special instructions for each service types.e.g. CUSTOM, ENGRAVING |
| |
|
|
|
ServicesInstruction |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/OrdersToFulfill/Order/OrderDetail/ServicesInstructions/ServicesInstruction |
Defines the special instructions for each service types |
| |
|
|
|
|
InstructionSeq |
|
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderDetail/ServicesInstructions/ServicesInstruction/InstructionSeq |
The sequence in which this instruction falls.
Allowable Values: Text string
Required: No
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
InstructionType |
|
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderDetail/ServicesInstructions/ServicesInstruction/InstructionType |
The name in a name/value pair of special instructions, for example, StickVogelReadyID Allowable Values: Text string
Required: No
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
InstructionTypeDesc |
|
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderDetail/ServicesInstructions/ServicesInstruction/InstructionTypeDesc |
Provides a text description of the instruction type.
Allowable Values: Text string
Required: No
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
InstructionValue |
|
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderDetail/ServicesInstructions/ServicesInstruction/InstructionValue |
The value in the name/value pair of speicial instructions.
Allowable Values: Text string
Required: No
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
|
|
InstructionValueDesc |
|
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/Order/OrderDetail/ServicesInstructions/ServicesInstruction/InstructionValueDesc |
Provides a text description of the instruction value.
Allowable Values: Text string
Required: No
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A |
| |
|
|
RewardPoints |
AnyType |
No |
0 |
0 |
1 |
|
|
/OrdersToFulfill/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 |
|
|
/OrdersToFulfill/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 |
|
|
/OrdersToFulfill/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 |
|
|
/OrdersToFulfill/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 |
| |
|
|
ExtendedAttributes |
AnyType |
No |
1..n |
0 |
-1 |
|
|
/OrdersToFulfill/Order/OrderDetail/ExtendedAttributes |
|
| |
|
|
|
Name |
String |
No |
0 |
0 |
1 |
|
30 |
/OrdersToFulfill/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 |
/OrdersToFulfill/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 |
/OrdersToFulfill/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 |