Transitional Order XML Structure (Order Fields)

Description

The <ExternalData> element is the document root element. Required.

Required. Encapsulates multiple transactions of transitional data and its occurrence one or multiple Max count: 250 (it depends on proposed size of the file).

Required.

The element <Order> represents an original sales order in an order. Required.

The email address of the customer placing the order.

Indicates the kind of order category. For example: Sales Order, Return Order, Exchange Order

The date that the order was taken. Defaults to the current date-time if not provided. Required for each <order>.

The identifier of customer. A unique value used to identify the customer.

Total tax amount at the time of the order creation.

The total amount at the time of the order creation.

The sum total of all credit and debit memos issued against this order.

Identifies the exchange type of the order. The payment processing logic is dependent on this attribute.

This field is mandatory for exchange order.

Valid values are: REGULAR, ADVANCED_PP, ADVANCED

This flag indicates whether the buyer is exempt from paying taxes. Valid values = Y or N

Stores order ID for orders from sources other than web store.

Sales order – Customer Sales Order Number

Return order – Return Order Number

Exchange order – Sales order number created for exchange.

Required for each <Order>.

Extended Field for Order No for storing the webstore’s order number if that is different from client’s current OMS system, else it can be same as ExtnReferenceOrderNo.

Customer sales order no for sales order and return order.

For exchange, the new sales order that is created

Extended field for storing value of Return Order No.

Required for Exchange Orders only. Its value should be equal to Return Order No.

Represents price information for an order. Required for each <Order>.

The currency code for processing the order. All price fields are assumed to be in this currency. If not provided, this will default to the default currency for the enterprise.

Currency=”USD”

Invoiced amount for an order.

Amount refunded due to returns against the order.

Represents HeaderCharges that are applied at the order level

This tag can be repeated as many Charges as you have in order.

The amount of the charge.

The charge category. This is a defined category that is used to classify a charge against an order. For example, “Shipping”.

The element <OrderLineRelationShips>represents line relationship like warranty etc.

This element represent single relationship.

The type of relationship between the parent and the child line. Valid values are ACCESSORY.CUSTOM, MUPPET, SHIPTOGETHER, SIM, WARRANTY, and INSTALL.

Line element of parent line.

Primelineno of parent line.

Sublineno of parent line.

Line element of child line.

Primelineno of Child line.

Sublineno of Child line.

Represents HeaderTaxes that are applied at the order level

This tag can be repeated as many taxes as you have in order.

The charge category that the tax is being applied against. This is a defined category that is used to classify a charge against an order. For example, “Shipping”. Required for each <header-tax>. The value of this field must contain the same header-charge-category value as the charge that the tax is related to. See Charge Category.

Name assigned to Tax item referred. For example, City tax.

The amount of tax that has been invoiced for HFR. Must be an amount greater than zero. Fifteen digits total are supported with two digits eligible to the right of the decimal. Use “0.00” if tax exempt. Required for return orders.

The tax name.

Required for each <header-tax>.

To provide tax items not defined above.

Extended Field for Jurisdiction ID.

Extended Field for Jurisdiction Level.

Encapsulates all order level Bill-to address data. Required for each <Order>.

A user-specified label for an address.

The first address line field. Required for <PersonInfoBillTo>.

The second address line field.

The third address line field.

The alternate email address at which the person in the address can be contacted.

The city field for the address.

The country field for the address. See Country. Required for <PersonInfoBillTo>.

The company this person is associated with.

The daytime phone for the person or organization referred to in the address.

The daytime fax for the person in the address.

The email address for the person in the address.

The evening fax for the person in the address.

The evening phone for the person in the address.

The first name of the person.

The last name of the person.

The middle name of the person.

The mobile phone number for the person.

The state in the address.

Required for <PersonInfoBillTo>.

The title of the person or contact. For example: Mr., Mrs., Dr.

The postal code field for the address. Required for <PersonInfoBillTo>.

Encapsulates all order level Ship to address data. Required for each <Order>.

A user-specified label for an address.

The first address line field. Required for <PersonInfoShipTo>.

The second address line field.

The third address line field.

The alternate email address for the person in the address.

The city field for the address.

The country field for the address. See Country. Required for <PersonInfoShipTo>.

The company this person is associated with.

The daytime phone for the person or organization referred to in the address.

The daytime fax for the person in the address.

The email address for the person in the address.

The evening fax for the person in the address.

The evening phone for the person in the address.

The first name of the person.

The last name of the person or contact.

The middle name of the person.

The mobile phone number for the person.

The state in the address.

Required for <PersonInfoShipTo>.

The title of the person or contact. For example: Mr., Mrs., Dr.

The postal code field for the address. Required for <PersonInfoShipTo>.

Encapsulates all payment methods for an order. Required for each <Order>.

The element <PaymentMethod> represents a payment method. Required for each <PaymentMethods>.

The credit card type group. This field is only used when a credit card was supplied as the payment method (a payment-type of “CC”). See Credit Card Type.

The payment type of this payment method. See Payment Type.

Encapsulates a list of all the payment details for a payment method.

The element <payment-details> represents the details for a payment method. Required for each <PaymentDetailsList>.

The authorized amount that was processed. Fifteen digits total are supported with two digits eligible to the right of the decimal. Required for each <PaymentDetails>.

Encapsulates all order lines for the order. Required for each <Order>.

The element <OrderLine> represents an order line. Required for each <OrderLines>.

Attribute of <OrderLine>element. Numeric identifier for the Order line. Required for each <OrderLine>.

The Delivery Type for the order line. See Delivery Type.

Defines the method of fulfilling the order line during scheduling. See Fulfillment Type.

Specifies a collection of items that form a single unit; for example, a home theater unit that contains kit components such as a TV, Speakers, CD player, DVD player, tuner, etc. Only accepted values are “LK” (logical kit), “PK” (physical kit), “DPK” (dynamic physical kit) or “BUNDLE” (bundle item). If “LK” or “PK” is given as a value, the API does not validate that kit lines have been included in the input XML. It returns an error if kit lines are provided and a kit code has not been specified. See Kit Code.

The quantity of the item that has been ordered. If part of the order line is cancelled, this number is reduced appropriately. Fourteen digits total are supported with four digits eligible to the right of the decimal. Required for each <OrderLine>.

The sum of all the line level charges. Fifteen digits total are supported with two digits eligible to the right of the decimal.

The requested cancel date. If not specified, this is defaulted from the date in the order header during order creation.

The reason for returning the order line. See Return Reason for pre-defined values.

The Delivery carrier to be used for this order line.

See Delivery Carrier.

Part of the key that uniquely identifies the line. If the value provided is less than or equal to 0, this is set to 1.

This field represents that it is reshipped Order Line.

Required field for Reshipped lines.

Primelineno and Sublineno should not be more than three digits.

Format of ReshipParentLineKey is:

Primelineno of parent Orderline + Sublineno of parent Orderline + OrderNo

If length of Primelineno or Sublineno is not equal to 3, then add leading zeroes in the numbers to create a 3-digit number.

For example:

If Prime line No of Parent line =1 &

Sub line No of Parent line =1,

Order No = 70000002

Represents an order line item. Required for each <OrderLine>.

Attribute of the <Item> element. The unique identifier for the item. Required for each <Item>.

The item description.

Encapsulates price information related to the order line. Required for each <OrderLine>.

The grand total for the line. Fifteen digits total are supported with two digits eligible to the right of the decimal.

The list price of the item associated with the line. This field is informational and is not used by the OMS. Nineteen digits total are supported with six digits eligible to the right of the decimal.

The tax associated with the line. This value is summed from the individual line taxes. Fifteen digits total are supported with two digits eligible to the right of the decimal.

All the Taxes on that Order-Line

The unit price of the item associated with the line. Nineteen digits total are supported with six digits eligible to the right of the decimal.

Quantity billed to the customer.

Encapsulates Information the orderline is derived from an orderline of an existing order.

This Node is mandatory for Return and Exchange Orders.

Indicates the kind of order category. The value is always 0001.

PrimeLineNo of parent OrderLine

SubLineNo of parent OrderLine

The element <Extn> represents extended fields for the order.

ExtnReferenceOrderNo of parent Order. This is required for Return and Exchange orders

The element <PersonInfoShipTo> represents the “ship-to” information for an order line. The order line <PersonInfoShipTo> information always overrides the order level <PersonInfoShipTo>information. Required if <PersonInfoShipTo> of type “shipping” has not been supplied for the <Order>.

A user specified label for an address.

The first address line field. Required for <PersonInfoShipTo>.

The second address line field.

The third address line field.

The alternate email address at which the person in the address can be contacted

The city field for the address.

The country field for the address. See Country. Required for <PersonInfoShipTo>.

The daytime phone for the person or organization referred to in the address.

The email address for the person in the address.

The first name of the person.

The last name of the person or contact.

The middle name of the person or contact.

The mobile phone number for the person.

The state in the address.

Required for <PersonInfoShipTo>.

The title of the person or contact. For example: Mr., Mrs., Dr.

The postal code field for the address. Required for <PersonInfoShipTo>.

Encapsulates kitted component items for an order line.

The element <KitLine> represents an kit component. Required for each <KitLines>.

Description for the item.

The unique identifer for the component item. Required

The number of components required to one kit.

Encapsulates instructions for an order line.

The element <Instruction> represents an instruction. Required for each <Instructions>.

Free-form text indicating any additional information related to the instruction. Required for each <Instruction>.

Categorization of instructions so that they can be grouped together for reference or reporting. This is a code in the Radial OMS. See Instruction Type.

Encapsulates all line charges for an order line.

The element <LineCharge> represents an order line charge. Required for each <LineCharges>.

The total charge for the line, taking into account the quantity ordered and charge per unit. Fifteen digits total are supported with two digits eligible to the right of the decimal. Required for each <line-charge>.

All the Charges on that particular Line

The charge category. For example, “Labeling”, “Shipping” or “Handling”. See Charge Category.

The name of the charge. For example, “Price Ticket”.

Fixed charge amount for the line. When the charge is associated with the line, this amount will be invoiced on the first invoice for the line. Fifteen digits total are supported with two digits eligible to the right of the decimal.

Charge per unit for the item associated with this line. Nineteen digits total are supported with six digits eligible to the right of the decimal.

Encapsulates all line taxes for an order line.

The element <LineTax> represents an order line tax. Required for each <LineTaxes> .

The category for which the tax is being charged. For example, “Labeling” or “Handling”. See Charge Category.

The charge name for which the tax is being charged.

The tax amount. Must be greater than or equal to zero. Fifteen digits total are supported with two digits eligible to the right of the decimal.

The name of the tax. Required for each <LineTax>

The element <Extn> represents extended data.

Extended Field for Jurisdiction ID.

Extended Field for Jurisdiction Level.

Encapsulates the order line statuses for an order line. Required for each <OrderLine>.

The element <OrderStatuses> represents an order status. Required for each <OrderStatuses>.

The status code. See Order Status. Required for each <order-line-status>.

The date when the last positive quantity was moved to this status.