Represents a decimal currency with two decimal points. Sample value: 4.75.
Allowable Values: Two integers separated by a decimal point. .The second integer must be two characters
in length.
Required: No
Length: TBD
Default Value: blank
Restrictions: Note that this indicates only a quantity, not the type of currency being used.
Aliases: N/A
Represents a decimal currency with two decimal points. Sample value: 4.75.
Allowable Values: Two integers separated by a decimal point. .The second integer must be two characters
in length.
Required: No
Length: TBD
Default Value: blank
Restrictions: Note that this indicates only a quantity, not the type of currency being used.
Aliases: N/A
Same as AmountBaseType but allows negative values.
Represents the identifier for an inventoriable product. a.k.a. SKU
Allowable Values: Text string
Required: No
Length: 20
Default Value: blank
Restrictions: N/A
Aliases: N/A
The email address associated with a person or enterprise.
Allowable Values: Text string
Required: Yes
Length: 70 characters
Default Value: blank
Restrictions: This field is restricted to a valid email address containing an at sign (@) and a period
(.).
Aliases: N/A
IPv4 address in the dotted-decimal notation.
An IP version 6 address.
An IP version 4 or version 6 address.
The street, city, state and country of a location.
The "Line#" 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
Name of the city.
Allowable Values: Text string
Required: Yes
Length: 35
Default Value: blank
Restrictions: N/A
Aliases: N/A
Typically a two- or three-digit postal abbreviation for the state or province. .
Allowable Values: Text string
Required: Yes
Length: 35
Default Value: blank
Restrictions: Use of the ISO 3166-2 code is recommended, but not required..See
http://en.wikipedia.org/wiki/ISO_3166-2.
Aliases: N/A
Two digit country code.
Allowable Values: Text string
Required: Yes
Length: 2-40 characters
Default Value: blank
Restrictions: Use of ISO 3166 alpha 2 code is recommended, but not required. See:
http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
Aliases: N/A
Typically, the string of letters and/or numbers that more closely specifies the delivery area
than just the City component alone, for example, the Zip Code in the U.S.
Allowable Values: Text string
Required: Yes
Length: 15
Default Value: blank
Restrictions: N/A
Aliases: N/A.
A title you can assign to a person. Typically "Dr.", "Mr.", "Ms." etc.
Allowable Values: Text string.
Required: No
Length: 10
Default Value: blank
Restrictions: N/A
Aliases: Salutation
The surname of the person.
Allowable Values: Text string.
Required: Yes
Length: 64
Default Value: blank
Restrictions: N/A
Aliases: N/A
The middle name or names of the person.
Allowable Values: Text string.
Required: No
Length: 40
Default Value: blank
Restrictions: N/A
Aliases: N/A
The first name of the person.
Allowable Values: Text string.
Required: Yes
Length: 64
Default Value: blank
Restrictions: N/A
Aliases: N/A
This xsd:any element indicates that future optional elements may show up in this location of the
XML document in the
responses returned from the service.
The purpose of this xsd:any element is to define a more robust service interface that allows for
new, optional elements to be added
to the service's responses without the service clients' code throwing exceptions.
The client code for this service call should be written to not break if new optional XML
elements show up in this part
of the service response. Modern XML marshalling frameworks often process xsd:any elements
properly out-of-the-box
(for example, in Java, JAXB and JibX XML marshalling frameworks both honor xsd:any elements and
don't throw exceptions
if new optional elements appear within the xsd:any section of the XML document).
Developers' unit tests of their service client code should include a test case where this reply
message
contains one or more new elements in this location of the XML document.
If new optional elements are added to this interface, a new schema will be created,
communications will be sent out,
and you will have the option to modify your service client code to process and use the new
elements.
If there is no need/desire to process the new optional elements, your service client should
continue to run
uninterrupted as long as it is built to honor this xsd:any element.
simple type to validate string elements are not empty
simple type to validate string elements are not empty
and are at most 16 characters long
simple type to validate string elements are not empty
and are at most 20 characters long
simple type to validate string elements are not empty
and are at most 30 characters long
simple type to validate string elements are not empty
and are at most 40 characters long
simple type to validate string elements are not empty
and are at most 200 characters long
RequestId is used to globally identify a request message and is used
for duplicate request protection.
Identifier for an available to promise inventory reservation.
Allowable Values: Text string
Required: No
Length: 40
Default Value: blank
Restrictions: N/A
Aliases: N/A
A period of time. The "From" date must precede the "To" date. You must specify both values. Used, for
example, to represent an estimated delivery date range.
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
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
A period of time. The "From" date must precede the "To" date. You must
specify both values. Used, for example, to represent an estimated delivery date range.
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
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
Shipping Carrier such as "UPS" or "FEDEX"
Carrier mode is such as 1Day or Ground, etc.
Represents the logical Carriers (SCAC) and modes (CarrierServiceCode).
Shipping Carrier such as "UPS" or "FEDEX"
Carrier mode is such as 1Day or Ground, etc.
Represents the
logical Carriers (SCAC) and modes (CarrierServiceCode)
Indicates the carrier method for example Std_GnD or 2Day
Allowable Values: Text string
Required: No
Length: 40
Default Value: blank
Restrictions: N/A
Aliases: N/A
Specifies the text to display when the mode is quierried.
Example: Standard Ground
Allowable Values: Text string
Required: No
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A
Categorizes the tax being imposed. Examples include include General Sales and
Use Tax, Surcharge, and VAT.
Allowable Values: Text string
Required: Yes
Length: 60
Default Value: blank
Restrictions: N/A
Aliases: N/A
This type maps to Tax response Invoice Text Codes.
Value returned from the tax Calculation message.
Allowable Values: Text string See Appendix
Required: Yes
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A
Identifies the jurisdiction's common classification based on its geopolitical
and/or taxing context. The values listed below are recommended and commonly used.
Allowable Values: Text String
- APO
- BOROUGH
- CITY
- COUNTRY
- COUNTY
- DISTRICT
- FPO LOCAL_IMPROVEMENT_DISTRICT
- PARISH
- PROVINCE SPECIAL_PURPOSE_DISTRICT
- STATE
- TERRITORY
- TOWNSHIP
- TRADE_BLOCK
- TRANSIT_DISTRICT
Required: Yes
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A
Jurisdiction code assigned by the relevant governmental authority.
Allowable Values: Text string
Required: Yes
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A
The situs or taxing location as determined by the calculation engine for the line
item.
Allowable Values: Text string
Required: No
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A
The name of jurisdiction to which a tax is applied.
The name of the imposition to which the relevant tax rule belongs.
For Buyer Input tax and Seller Import tax, this rate is calculated based on the
Extended Price and Tax Amount (Import or Input) passed in the Request message.
If you total the Extended Price and Tax Amounts before passing them in, this rate is an average.
For all other message types, this is the effective rate the system used to calculate tax.
Represents a decimal representation of currency. Sample value: 4.75.
Allowable Values: Two integers separated by a decimal point. The second integer must be two
characters in length. For example: 4.05
Allowable Values: decimal
Required: No
Length: two integers
Default Value: 0.00
Restrictions: N/A
Aliases: N/A
The amount for which tax is calculated.
Represents a decimal representation of currency. Sample value: 4.75.
Allowable Values: Two integers separated by a decimal point. The second integer must be two
characters in length. For example: 4.05
Required: No
Length: two integers
Default Value: 0.00
Restrictions: Note that this indicates only a quantity, not the type of currency being used.
Aliases: N/A
Amount of the line item not subject to tax due to exempt status. Represents a
decimal representation of currency. Sample value: 4.75.
Allowable Values: Two integers separated by a decimal point. The second integer must be two
characters in length. For example: 4.05
Required: No
Length: TBD
Default Value: 0.00
Restrictions: Note that this indicates only a quantity, not the type of currency being used.
Aliases: N/A
Amount of the line item not subject to tax due to nontaxable status.
Represents a decimal representation of currency. Sample value: 4.75.
Allowable Values: Two integers separated by a decimal point. The second integer must be two
characters in length. For example: 4.05
Required: No
Length: TBD
Default Value: 0.00
Restrictions: Note that this indicates only a quantity, not the type of currency being used.
Aliases: N/A
Amount of tax calculated by the calculation engine.
Represents a decimal representation of currency. Sample value: 4.75.
Allowable Values: Two integers separated by a decimal point. The second integer must be two
characters in length. For example: 4.05
Required: No
Length: TBD
Default Value: 0.00
Restrictions: Note that this indicates only a quantity, not the type of currency being used.
Aliases: N/A
The Registration ID for the Seller associated with this line item tax.
Allowable Values: text string
Required: No
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A
System determined tax type, based on situs, transaction type, and party role type
(perspective). The possible values are:
Allowable Values: Text string acceptable values:
SALES SELLER_USE CONSUMERS_USE
VAT
IMPORT_VAT
NONE
Required: Yes
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A
System determination of taxable status based on situs and item type. The possible
values are shown below:
Allowable Values: Text string
TAXABLE - item is taxable
NONTAXABLE - item is nontaxable
EXEMPT - item is exempt from tax
DPPAPPLIED - Direct Pay Permit was used on this transaction.
NO_TAX - no tax on this item
DEFERRED - tax deferred on this item
Required: Yes
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A
System determination of taxable status based on situs and item type. The possible values are:
TAXABLE
NONTAXABLE
EXEMPT
DPPAPPLIED
NO_TAX
DEFERRED
Allowable Values: Text string
Required: Yes
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A
This type represents class for Tax calculation purposes. Typically the default
tax class for shipping is 93000.
For fees default tax class will be used as 89999.
Allowable Values: Text string
Required: No
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A
System determined tax type, based on situs, transaction type, and party role type (perspective). The
possible values are:
SALES
SELLER_USE
CONSUMERS_USE
VAT
IMPORT_VAT
NONE
Allowable Values: Text string
Required: No
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A
Unique key used for relating orders through IDREFs
Allowable Values: IDREF
Required: Yes
Length:TBD
Default Value: TBD
Restrictions: N/A
Aliases: N/A
Combines a name with a physical address.
The number, street, city state, postal code and country that define a location.
The initial reply message for asynchronous APIs like Payment Auth Cancel,
Payment Settlement Request, Risk Assessment, etc to acknowledge that Public Api has successfully
received the request. Note that there is a subsequent final asynchronous reply for the request.
Tells the recipient that the public API successfully received the request.
Allowable Values: Text string
Required: Yes
Length: TBD
Default Value: blank
Restrictions: N/A
Aliases: N/A
This xsd:any element indicates that future optional elements may
show up in this location of the XML document in the responses returned from the service.
The purpose of this xsd:any element is to define a more robust service interface that allows for
new, optional elements to be added to the service's responses without the service clients' code
throwing exceptions.
The client code for this service call should be written to not break if new optional XML
elements show up in this part of the service response. Modern XML marshalling frameworks often
process xsd:any elements properly out-of-the-box (for example, in Java, JAXB and JibX XML
marshalling frameworks both honor xsd:any elements and don't throw exceptions if new optional
elements appear within the xsd:any section of the XML document).
Developers' unit tests of their service client code should include a test case where this reply
message contains one or more new elements in this location of the XML document.
If new optional elements are added to this interface, a new schema will be created,
communications will be sent out, and you will have the option to modify your service client code
to process and use the new elements.
If there is no need/desire to process the new optional elements, your service client should
continue to run uninterrupted as long as it is built to honor this xsd:any element.
An empty element representing a successful acknowledgement.
Sample:
This xsd:any element indicates that future optional elements may show up in this location of the
XML document in the
responses returned from the service.
The purpose of this xsd:any element is to define a more robust service interface that allows for
new, optional elements to be added
to the service's responses without the service clients' code throwing exceptions.
The client code for this service call should be written to not break if new optional XML
elements show up in this part
of the service response. Modern XML marshalling frameworks often process xsd:any elements
properly out-of-the-box
(for example, in Java, JAXB and JibX XML marshalling frameworks both honor xsd:any elements and
don't throw exceptions
if new optional elements appear within the xsd:any section of the XML document).
Developers' unit tests of their service client code should include a test case where this reply
message
contains one or more new elements in this location of the XML document.
If new optional elements are added to this interface, a new schema will be created,
communications will be sent out,
and you will have the option to modify your service client code to process and use the new
elements.
If there is no need/desire to process the new optional elements, your service client should
continue to run
uninterrupted as long as it is built to honor this xsd:any element.
Customer care element
Represents a decimal currency with two decimal points. Sample value: 4.205
Customer care element : Combines status and description into one element.
Customer care element
Each item has a HTSCode assigned by TradeBeam for duty calculation purposes.
This code is required if duty calculation is desired.
A list of Generic Key/Value pair used for partner customizations.
Example use: Loyalty Program
Generic Key/Value pair
Represents the string returned by a hash function.
Hash function algorithm types.