How to use?
General
Using this interface, users have 2 possibilities:
- Creating a new, unattached shipment
- Creating new labels or attach an existing labels to an existing shipment
Creating a new, unattached shipment
To create a new, unattached shipment, it is necessary to specify the following elements:
- PickupDate
- ArrivalDate (optional)
- VendorCodeFrom
- VendorCodeTo (optional)
- YourReference (optional)
* With unattached, we mean that the shipment is not yet attached to a transport order or a STOR!
* When creating an unattached shipment, the ‘ShipmentReference’ element must not be specified!
Creating new labels or attach an existing labels to an existing shipment
An existing shipment can be looked up by using the ‘ShipmentReference’ element.There are 3 possible values:
- ‘TransportOrderNumber’: use this to find a shipment that is attached to a transport order. As value for this element, we expect the transport order number. E.g.
201703280038
- ‘STORNumber’: use this to find a shipment that is attached to a STOR. As value for this element, we expect the STORNumber. E.g.
STOR20130910001
- ‘ShipmentNumber’: use this to find a shipment by using its id. E.g.
56128
There are 5 different possibilities to attach an existing order to a shipment.
Message format BE2NET_DISPATCH_ADVICE
Main element
| Xml Element |
Description |
Mandatory |
Type |
Remarks |
| ShipmentReference |
Shipment reference |
No |
ComplexType (with Type attribute) |
ComplexType content: see below |
| PickupDate |
Pickup date |
No |
Date |
Mandatory when the 'ShipmentReference' element is not specified.
This indicates that a new shipment will be created. |
| ArrivalDate |
Arrival data |
No |
Date |
|
| VendorCodeFrom |
Vendorcode from |
No |
Non Negative Long |
Mandatory when the 'ShipmentReference' element is not specified.
This indicates that a new shipment will be created. |
| VendorCodeTo |
Vendorcode to |
No |
Non Negative Long |
|
| YourReference |
Your reference |
No |
String |
|
| ActionDateTime |
Action datetime |
Yes |
DateTime |
|
| Actor |
Actor |
Yes |
String |
|
| Details |
Details |
Yes |
ComplexType (Choice) |
ComplexType content: see below |
ComplexType: ShipmentReference (with Type attribute)
| Xml Attribute |
Description |
Mandatory |
Type |
Remarks |
| Type |
Type |
No |
String, Restriction |
This attribute is an enumeration.
The following values are supported:
- TransportOrderNumber
- STORNumber
- ShipmentNumber
|
ComplexType: Details (Choice)
| Xml Element |
Description |
Mandatory |
Type |
Remarks |
| LabelNr |
Label number |
Yes |
ComplexType |
This type is used for existing labels.
ComplexType content: see below. |
| SingleLabel |
Single label |
Yes |
ComplexType |
This type is used for existing labels.
ComplexType content: see below. |
| GroupLabel |
Group label |
Yes |
ComplexType |
This type is used for existing labels.
ComplexType content: see below. |
| AirLabel |
Air label (Sequence label) |
Yes |
ComplexType |
This type is used for existing labels.
ComplexType content: see below. |
| TransportRequestLabel |
Transport request label |
Yes |
ComplexType |
This type is used for existing labels.
ComplexType content: see below. |
ComplexType: LabelNr
* LabelType can be SingleLabel/GroupLabel/AirLabel or TransportRequestLabel.
* TransportRequestNumberPrefix is an optional element because not all label types will use this element. It will only be used when the type is ‘TransportRequestLabel’.
You should use the ‘LabelNr’ element in case you want to attach an already existing label, based on the specified info, to a shipment.
| Xml Element |
Description |
Mandatory |
Type |
Remarks |
| Division |
Division |
Yes |
String |
|
| VendorCode |
Vendor code |
Yes |
Non Negative Long |
|
| LabelNumber |
Label number |
Yes |
Long |
|
| LabelType |
Label type |
Yes |
String, Restriction |
The following values are supported:
- SingleLabel
- GroupLabel
- AirLabel
- TransportRequestLabel
|
| TransportRequestNumberPrefix |
Transport Request Reference Number Prefix |
No |
String |
|
ComplexType: SingleLabel
A new (single) label is created using the above information. The new label will automatically be attached to the new/existing shipment.
* When the LabelNumber element is specified and a label already exists (for the specified vendor), an exception will be thrown.
* When no LabelNumber is specified, Be2NET will automatically assign a label number for you (based on the combination of the division and the vendorcode).
| Xml Element |
Description |
Mandatory |
Type |
Remarks |
| PurchaseOrderNumber |
Production purchase order number |
Yes |
Non Negative Long |
|
| Division |
Division |
Yes |
String |
|
| VendorCode |
Single label |
Yes |
ComplexType |
|
| ItemNumber |
Item number |
No |
Non Negative Long |
|
| ParcelQuantity |
Parcel quantity |
Yes |
Decimal |
|
| Location |
Location |
No |
String |
|
| SerialNumber |
Serial number |
No |
String |
|
| ShopOrderNumber |
Shoporder number |
No |
String |
|
| GrossWeight |
Gross weight |
No |
Decimal |
|
| NetWeight |
Net weight |
No |
Decimal |
|
| SHUNumber |
SHU number |
No |
String |
|
| LabelNumber |
Label number |
No |
Long |
You only need to send the LabelNumber in case the label is generated by you own system. |
ComplexType: GroupLabel
Based on the specified data, Be2NET will find a group-label and attach it to a shipment.
* When the LabelNumber element is specified and a label already exists (for the specified vendor), an exception will be thrown.
* When no LabelNumber is specified, Be2NET will automatically assign a label number for you (based on the combination of the division and the vendorcode).
| Xml Element |
Description |
Mandatory |
Type |
Remarks |
| Division |
Division |
Yes |
String |
|
| VendorCode |
Single label |
Yes |
ComplexType |
|
| ItemNumber |
Item number |
No |
Non Negative Long |
|
| Location |
Location |
No |
String |
|
| ShopOrderNumber |
Shoporder number |
No |
String |
|
| SHUNumber |
SHU number |
No |
String |
|
| LabelNumber |
Label number |
No |
Long |
You only need to send the LabelNumber in case the label is generated by you own system. |
ComplexType: AirLabel
Based on the specified data, Be2NET will find an air-label and attach it to a shipment.
* When the LabelNumber element is specified and a label already exists (for the specified vendor), an exception will be thrown.
* When no LabelNumber is specified, Be2NET will automatically assign a label number for you (based on the combination of the division and the vendorcode).
| Xml Element |
Description |
Mandatory |
Type |
Remarks |
| Division |
Division |
Yes |
String |
|
| VendorCode |
Single label |
Yes |
ComplexType |
|
| JobId |
JobId |
Yes |
String |
|
| SHUNumber |
SHU number |
No |
String |
|
| LabelNumber |
Label number |
No |
Long |
You only need to send the LabelNumber in case the label is generated by you own system. |
ComplexType: TransportRequestLabel
Be2NET will first check if the transportrequest exists or not. If the transportrequest itself does not exist, it will be created in Be2NET (using the specified data). Once this is completed, a label will be created for the transportrequest and the label will be attached to the shipment.
| Xml Element |
Description |
Mandatory |
Type |
Remarks |
| Division |
Division |
Yes |
String |
|
| TransportRequestNumber |
Transport request number |
Yes |
String |
|
| VendorCode |
Vendor code |
Yes |
Non Negative Long |
|
| Quantity |
Quantity |
Yes |
Decimal |
|
| ItemNumber |
Item number |
No |
String |
|
| Location |
Location number |
No |
String |
|
| SerialNumber |
Serial number |
No |
String |
|
| SHUNumber |
SHU number |
No |
String |
|
| ShopOrderNumber |
Shop order number |
No |
String |
|