Transitional Order XML Structure (Shipment Fields)

The following table shows the structure for Shipment fields. See also Transitional Order XML Structure (Order Fields).

Field Name

Required

Instances*

Type

Length

Description

<ExternalData>

Y

1

Complex

 

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

_ <OrderData>

Y

1…n

Complex

 

Required.

_ _ <ImportOrder>

Y

1…n

Complex

 

Required.

_ _ _ <Shipment>

Y

1

Complex

 

The element <Shipment> represents an order shipment.

_ _ _ _ ActualDeliveryDate

N

0…1

TimeStamp

 

The date on which the shipment was actually delivered to the customer.

_ _ _ _ ActualShipmentDate

N

0…1

TimeStamp

 

The actual shipment date.

_ _ _ _ DeliveryType

N

0…1

String

40

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

_ _ _ _ Currency

N

0…1

String

20

The currency corresponding to the shipment charges. See Currency.

_ _ _ _ DeliveryCarrierCode

N

0…1

String

24

The Delivery carrier by which this shipment will be transported. See Delivery Carrier.

_ _ _ _ ShipNode

Y

1

String

255

Seller warehouse Location to which this shipment belongs. See Ship Node. This is set up for each client

_ _ _ _ <ToAddress>

Y

1

Complex

 

The address that the shipment is being delivered to. Required for each <Shipment>.

_ _ _ _ _ AddressID

Y

1

String

256

A user specified label for an address.

_ _ _ _ _ AddressLine1

Y

1

String

70

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

_ _ _ _ _ AddressLine2

N

0…1

String

70

The second address line field.

_ _ _ _ _ AddressLine3

N

0…1

String

70

The third address line field.

_ _ _ _ _ AlternateEmailId

N

0…1

String

150

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

_ _ _ _ _ City

Y

1

String

35

The city field for the address.

_ _ _ _ _ Country

Y

1

String

40

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

_ _ _ _ _ Company

N

0…1

String

50

The company this person is associated with.

_ _ _ _ _ DayPhone

N

0…1

String

40

The daytime phone at which the person or organization referred to in the address can be called

_ _ _ _ _ DayFaxNo

N

0…1

String

40

The daytime fax at which the person in the address can be notified.

_ _ _ _ _ EMailID

N

0…1

String

150

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

_ _ _ _ _ EveningFaxNo

N

0…1

String

40

The evening fax at which the person in the address can be notified.

_ _ _ _ _ EveningPhone

N

0…1

String

40

The evening phone at which the person in the address can be called.

_ _ _ _ _ FirstName

Y

1

String

64

The first name of the person.

_ _ _ _ _ LastName

Y

1

String

64

The last name of the person or contact.

_ _ _ _ _ MiddleName

N

0…1

String

40

The middle name of the person or contact.

_ _ _ _ _ MobilePhone

N

0…1

String

40

The mobile phone number at which the person can be contacted.

_ _ _ _ _ State

Y

1

String

35

The state in the address. Required for <ToAddress>.

_ _ _ _ _ Title

N

0…1

String

10

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

_ _ _ _ _ ZipCode

Y

1

String

35

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

_ _ _ _ <FromAddress>

Y

1

Complex

 

The address that the shipment is being delivered from. Required for each <Shipment>.

_ _ _ _ _ AddressI>

Y

1

String

256

A user specified label for an address.

_ _ _ _ _ AddressLine1

Y

1

String

70

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

_ _ _ _ _ AddressLine2

N

0…1

String

70

The second address line field.

_ _ _ _ _ AddressLine3

N

0…1

String

70

The third address line field.

_ _ _ _ _ AlternateEmailId

N

0…1

String

150

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

_ _ _ _ _ City

Y

1

String

35

The city field for the address.

_ _ _ _ _ Country

Y

1

String

40

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

_ _ _ _ _ Company>

N

0…1

String

50

The company this person is associated with.

_ _ _ _ _ DayPhone

N

0…1

String

40

The daytime phone at which the person or organization referred to in the address can be called

_ _ _ _ _ DayFaxNo

N

0…1

String

40

The daytime fax at which the person in the address can be notified.

_ _ _ _ _ EMailID

N

0…1

String

150

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

_ _ _ _ _ EveningFaxNo

N

0…1

String

40

The evening fax at which the person in the address can be notified.

_ _ _ _ _ EveningPhone

N

0…1

String

40

The evening phone at which the person in the address can be called.

_ _ _ _ _ FirstName

Y

1

String

64

The first name of the person.

_ _ _ _ _ LastName

Y

1

String

64

The last name of the person or contact.

_ _ _ _ _ MiddleName

N

0…1

String

40

The middle name of the person or contact.

_ _ _ _ _ MobilePhone

N

0…1

String

40

The mobile phone number at which the person can be contacted.

_ _ _ _ _ State

Y

1

String

35

The state in the address.

Required for <FromAddress>.

_ _ _ _ _ Title

N

0…1

String

10

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

_ _ _ _ _ ZipCode

Y

1

String

35

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

_ _ _ _ <Containers>

N

0..n

Complex

 

Encapsulates Containers for a shipment.

_ _ _ _ _ <Container>

Y

1…n

Complex

 

The element <Container> represents an instruction. Required for each <Containers>

_ _ _ _ _ _ ContainerNo

N

0…1

String

40

Unique key or business key, which by itself identifies a delivery plan.

If not passed as input, the system generates this number using the database sequence SEQ_YFS_CONTAINER_NO

_ _ _ _ _ _ TrackingNo

N

0…1

String

40

The tracking number. If carrier integration is availed for the carrier on the shipment, then this information is returned by the carrier server. This is a unique number assigned to each container that can be used to track individual containers in a shipment.

_ _ _ _ _ <ContainerDetails>

N

1

Complex

 

Encapsulates Container Details for a shipment.

_ _ _ _ _ _ <ContainerDetail>

Y

1…n

Complex

 

The element <ContainerDetail> represents an instruction. Required for each <ContainerDetails>.

_ _ _ _ _ _ _ Quantity

Y

0…1

Decimal

14,4

The quantity of the item packed in this container

_ _ _ _ _ _ <ContainerShipmentLine>

N

0…1

Complex

 

Stores information about shipment lines.

_ _ _ _ _ _ _ ItemID

Y

1

String

40

Item ID

_ _ _ _ _ _ _ PrimeLineNo

Y

1

nonNegativeInteger

5

PrimeLineNo of the corresponding OrderLine.

_ _ _ _ _ _ _ ShipmentLineNo

Y

1

nonNegativeInteger

5

Part of Primary Key . Unique for a Shipment.

_ _ _ _ _ _ _ SubLineNo

Y

1

nonNegativeInteger

5

SubLineNo of the corresponding OrderLine.

_ _ _ _ <Instructions>

N

0…1

Complex

 

Encapsulates instructions for a Shipment.

_ _ _ _ _ <Instruction>

Y

1…n

Complex

 

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

_ _ _ _ _ _ InstructionText

Y

1

String

2000

Free-form text indicating any additional information related to the instruction type or otherwise.

_ _ _ _ _ _<InstructionType

N

0…1

String

10

Categorization of instructions so that they can be grouped together for reference.

_ _ _ _ <ShipmentLines>

Y

1

Complex

 

Encapsulates the Shipment lines for a shipment.

_ _ _ _ _ <ShipmentLine>

Y

1…n

Complex

 

The element <ShipmentLine> represents a shipment line for a shipment. Required for each <ShipmentLines>.

_ _ _ _ _ _ ItemID

Y

1

String

40

Item ID

_ _ _ _ _ _ PrimeLineNo

Y

1

nonNegativeInteger

5

PrimeLineNo of the corresponding OrderLine.

_ _ _ _ _ _ ShipmentLineNo

Y

1

nonNegativeInteger

5

Part of Primary Key. Unique for a Shipment.

_ _ _ _ _ _ SubLineNo

Y

1

nonNegativeInteger

5

SubLineNo of the corresponding OrderLine.

_ _ _ _ <Extn>

Y

1

Complex

 

Encapsulates extended fields for a shipment.

_ _ _ _ _ ExtnReferenceOrderNo

Y

1

String

24

Stores order ID for orders. This will be populated for both sales and exchange order

Required for each <Extn>.

_ _ _ _ _ ExtnExternalShipId

N

0…1

String

40

Stores external Ship ID.

Notes

  • ”Instances” refers to the number of times an element can be repeated within the XML Structure. For example, 1…n means that the element must appear at least once but can appear multiple times in the XML message, similarly 0…n means not required to appear, but can appear multiple times in the xml messages. For those elements that have 0…1, it means that the element does not need to appear but it can appear at least once.
  • If Parent is 0...1 or 0…n and Child is 1 or 1…n, then Child doesn’t exist, if Parent does not exist. This rule is common across the whole xml document.