Shipment Specification
All line items must be contained on a single Shipment. Multiple Shipments are not allowed. In the event of a cancellation, the supplier must create a valid Acknowledgment prior to shipping. For EDI suppliers not integrated with the 855, the cancelled line items must be appended to the Shipment. If a line item is missing from the Shipment, and there is no Acknowledgment created for a cancellation, the Shipment will fail to process. See the Acknowledgment Specification for more details.
| EDI Field | Logicbroker Field | Description | Requirement |
|---|---|---|---|
|
N/A |
Identifier.SourceKey |
Identifier that will come from the source system; typically this will match the PartnerPO. |
Read Only |
|
N/A |
Identifier.LogicbrokerKey |
ID to identify the document in the Logicbroker system. |
Read Only |
|
N/A |
Identifier.LinkKey |
Used to link the document to the original source document. For example, It is best to supply the Order's LinkKey when posting a shipment. This will make sure the order shipped quantities are updated on the original order and all statuses are updated appropriately. |
Optional |
|
N/A |
SenderCompanyId |
Logicbroker Internal Company ID to specify what company is sending the document. |
Required |
|
N/A |
ReceiverCompanyId |
Logicbroker Internal Company ID to specify what company is to receive the document. |
Required |
|
BSN102 |
ShipmentNumber |
Unique ID to identify the shipment. |
Required |
|
BSN103 |
ShipmentDate |
Date units are shipped |
Optional |
|
N/A |
DocumentDate |
Date the document was created. This field will automatically default with the date the document is created. |
N/A |
|
HL*O:PRF01 |
PartnerPO |
This will be the purchase order number, this will be the main Key to link all your documents. This should match the order. |
Required |
|
HL*O:PRF04 |
OrderDate |
Date on the Purchase Order |
Optional - will be pulled from original order if not provided |
|
N/A |
OrderNumber |
Contains the end customer's order number, this will be used on the packing slip. |
Optional |
|
HL*S:REF02 (IV) |
InvoiceNumber |
Vendors Invoice Number |
Required |
|
REF02 (BM) |
BillofLading |
Document number issued by the carrier which contains details of the shipment. |
Conditional - if available |
|
REF02 (CN) |
PRONumber |
Typically used by LTL freight carriers, A PRO number is a series of numbers used by carriers as a reference for freight movement; this is like a tracking number. |
Conditional - if available |
|
REF02 (IA) |
VendorNumber |
This is the internal vendor number provided to the supplier from the merchant. If available it is always recommended to send. |
Optional |
|
Note |
Notes or shipping instructions provided by supplier; see the meaning of the notes on the individual partners notes. |
Optional |
|
|
DTM02 (067) |
ExpectedDeliveryDate |
Date the shipment is expected to be received at the shipping location. |
Optional |
|
N/A |
Payments.Method |
Shipment method of payment. Typical codes received are listed below: CC: Collect PO: Prepaid Only |
Optional |
|
N102 (ST) |
ShipToAddress.CompanyName |
ShipToAddress is only required if it is being changed from the Order. |
Optional |
|
N201 (ST) |
ShipToAddress.FirstName |
Optional |
|
|
N202 (ST) |
ShipToAddress.LastName |
Optional |
|
|
N301 (ST) |
ShipToAddress.Address1 |
Optional |
|
|
N302 (ST) |
ShipToAddress.Address2 |
Optional |
|
|
N401 (ST) |
ShipToAddress.City |
Optional |
|
|
N402 (ST) |
ShipToAddress.State |
Optional |
|
|
N404 (ST) |
ShipToAddress.Country |
Optional |
|
|
N403 (ST) |
ShipToAddress.Zip |
Optional |
|
|
N104 (ST*92) |
ShipToAddress.AddressCode |
Optional |
|
|
N1:PER06 (TE) |
ShipToAddress.Phone |
Optional |
|
|
N1:PER04 (EM) |
ShipToAddress.Email |
Optional |
|
|
N102 (SF) |
ShipFromAddress.CompanyName |
ShipFromAddress will be defaulted from the order if not provided. |
Optional |
|
N201 (SF) |
ShipFromAddress.FirstName |
Optional |
|
|
N202 (SF) |
ShipFromAddress.LastName |
Optional |
|
|
N301 (SF) |
ShipFromAddress.Address1 |
Optional |
|
|
N302 (SF) |
ShipFromAddress.Address2 |
Optional |
|
|
N401 (SF) |
ShipFromAddress.City |
Optional |
|
|
N402 (SF) |
ShipFromAddress.State |
Optional |
|
|
N404 (SF) |
ShipFromAddress.Country |
Optional |
|
|
N403 (SF) |
ShipFromAddress.Zip |
Optional |
|
|
N104 (SF*92) |
ShipFromAddress.AddressCode |
Optional |
|
|
N1:PER06 (TE) |
ShipFromAddress.Phone |
Optional |
|
|
N1:PER04 (EM) |
ShipFromAddress.Email |
Optional |
|
|
HL*T:MAN02 (GM) |
ShipmentInfo.ContainerCode |
SSCC-18 and Application Identifier to be used to identify the pallet. If not provided the tracking number can be used. To identify what cartons belong to the pallet, you will need to enter this value in the "ParentContainerCode" under the "ShipmentInfos" (containers) on the line level. |
Conditional - only required if sending a pallet |
|
HL*T:TD101 |
ShipmentInfo.ContainerType |
Use "PLT" to Specify Pallet |
Conditional - only required if sending a pallet |
|
HL*T:REF02 (ZH) |
ShipmentInfo.TrackingNumber |
Conditional - only required if sending a pallet |
|
|
HL*T:TD107 |
ShipmentInfo.Weight |
Total gross weight of the package or carton. |
Conditional - only required if sending a pallet |
|
HL*T:TD108 |
ShipmentInfo.WeightUnit |
Weight Unit of Measure for the package or carton. |
Conditional - only required if sending a pallet |
|
HL*T:TD109 |
ShipmentInfo.Length |
Length of the container or package. |
Conditional - only required if sending a pallet |
|
HL*T:TD109 |
ShipmentInfo.Width |
Width of the container or package. |
Conditional - only required if sending a pallet |
|
HL*T:TD109 |
ShipmentInfo.Height |
Height of the container or package. Should be provided in inches. |
Conditional - only required if sending a pallet |
|
HL*T:TD110 |
ShipmentInfo.DimensionUnit |
Dimension unit of measure used for Length, Height and Width. |
Conditional - only required if sending a pallet |
|
HL*I:PID05 (08) |
ShipmentLine.Description |
Standard short description or name of the product. |
Optional |
|
N/A |
ShipmentLine.Quantity |
Will be copied from the QTY Shipped provided under Shipment Infos. |
Required |
|
HL*I:LIN101 |
ShipmentLine.LineNumber |
Line Number from the Order. If not provided this will be taked from the order automatically. |
Required |
|
HL*I:SN103 |
ShipmentLine.QuantityUOM |
Unit of measure to identify the quantity in the container or package. Defaulted from the order if not provided. |
Optional |
|
N/A |
ShipmentLine.Price |
Unit cost that the merchant expects to be billed for each unit fulfilled. |
Optional |
|
HL*I:LIN105 (IN) |
ShipmentLine.ItemIdentifier.PartnerSKU |
The Item identifier that is internal to the purchaser/merchant. |
Conditional - if received on an order this value should be returned |
|
N/A |
ShipmentLine.ItemIdentifier.ManufacturerSKU |
Manufacturer's ID for the product. |
Conditional - if received on an order this value should be returned |
|
N/A |
ShipmentLine.ItemIdentifier.ISBN |
International Standard Book Number |
Conditional - if received on an order this value should be returned |
|
HL*I:LIN103 (VN) |
ShipmentLine.ItemIdentifier.SupplierSKU |
The Item Identifier that is used by the supplier or the person fulfilling the product. This will always contain a value. |
Required |
|
HL*I:LIN07(UP) |
ShipmentLine.ItemIdentifier.UPC |
Typically the U.P.C Consumer Package code will be provided; however additional standardized codes can be provided here as well. See specific partner instructions for details. |
Conditional - if received on an order this value should be returned |
|
DTM02 (011) |
ShipmentLine.ShipmentInfo.DateShipped |
Date the package was shipped. This will updated all header DateShipped values.Defaulted to the time the documented was created if not provided. |
Optional |
|
HL*P:MAN02 (GM) |
ShipmentLine.ShipmentInfo.ContainerCode |
SSCC-18 and Application Identifier to be used to identify the child container. Field is required, hoewever if no value is provided the tracking number will be used as the container code. |
Conditional - Only required if partner requires GS1-128 |
|
HL*I:SN102 |
ShipmentLine.ShipmentInfo.Qty |
Total Qty of the product within the package or container. This quantity will be summed up across all containers and the total will be supplied on the item level "Quantity" field. |
Required |
|
HL*P:MAN02 (CP) |
ShipmentLine.ShipmentInfo.TrackingNumber |
Tracking number Identifier provided from the carrier to be used to identify the container. If no container code is being used, this will be used as the container code. |
Required |
|
TD503 |
ShipmentLine.ShipmentInfo.CarrierCode |
This will typically be the Standard Carrier Alpha Code (SCAC). If you are using your own custom shipping methods to map "CarrierCode" and "ServiceLevelCode" then this will not be required, however the proper mapped code will need to be provided in the ClassCode. |
Required |
|
TD505 |
ShipmentLine.ShipmentInfo.ClassCode |
The shipping method that will be used to send the merchandise. This can be a free form field or if using the shipment code mappings will need to match the Custom Code that was setup. When sending the Custom Code, the corresponding CarrierCode and Class Code will automatically get populated. |
Required |
|
TD512 |
ShipmentLine.ShipmentInfo.ServiceLevelCode |
Service Level set to ship by the carrier. Check with trading partner to see applicable codes. An example of a few would be: ND = Next Day CG = Ground ON = Overnight SA = Same Day If you are using your own custom shipping methods to map "ServiceLevelCode" then you will not need to provide the value, however the proper mapped code will need to be provided in the ClassCode. |
Optional |
|
N/A |
ShipmentLine.ShipmentInfo.ShipmentContainerParentCode |
SSCC-18 and Application Identifier to be used to identify the pallet. If you are shipping a pallet and need to identify which cartons belong to it, this value needs to match the container code provided on the pallet in the header level "ShipmentInfo" |
Optional |
|
HL*P:TD101 |
ShipmentLine.ShipmentInfo.ContainerType |
Specifies the code used to identify the package type. See specific trading partner for correct codes. "0" will indicate what number pallet is being used. Numbers will start at 0, and increment by 1. Required if the container is not "Box" |
Optional |
|
HL*P:TD107 |
ShipmentLine.ShipmentInfo.Weight |
Total weight of the package or carton. Default will be in pounds. |
Optional |
|
HL*P:TD108 |
ShipmentLine.ShipmentInfo.WeightUnit |
Weight Unit of Measure for the package or carton. Default will be in pounds. |
Optional |
|
HL*P:PO410 |
ShipmentLine.ShipmentInfo.Length |
Length of the container or package. To be provided in inches. |
Optional |
|
HL*P:PO411 |
ShipmentLine.ShipmentInfo.Width |
Width of the container or package. To be provided in inches. |
Optional |
|
HL*P:PO412 |
ShipmentLine.ShipmentInfo.Height |
Height of the container or package. To be provided in inches. |
Optional |
|
HL*P:PO413 |
ShipmentLine.ShipmentInfo.DimensionUnit |
Dimension for the values in Length, Width and Height fields. |
Optional |