It is possible to attach an external document to a shipment and send it to the carrier, provided they support receiving it in their EDI or web service request.
Learn how to:
- Attach a document in Ship On-premises
- Attach a document using filedrop import
- Attach a document using the API
Attach a document in Ship On-premises
- First, you must activate the Attach document field. Go to Main > Production, right-click in the References section, and select Field selector.
- Scroll down and select Attach documents, and click OK to save. You will now see the field in the References section.
- Click on the dots in the Attach documents field to open the Add documents box.
- Click Add and click the dots next to the Path field to browse and select your document. Fill in Type, Description, and Reference, and click OK. Note that some carriers support predefined types available in a drop-down list.
- Fill in the shipment details and print the label as usual.
Attach a document using filedrop import
If you are using the import setup in nShift On-premises, follow these steps to attach a document:
- First, you must add the necessary field to your Import setup. Go to Setup and double-click on the Import Setup icon.
- Go to the Import Setup tab and click on Fields. Select Append or Insert to add a new field. (Choose Append if you want the new field added at the bottom or Insert if you want it added between two existing fields).
- Click on the new field and select Import external documents->Shipment
- You may set a default value in the field or include the path to the document in the import file. It should follow the syntax of this example:
[path=C:\Users\Jdoe\Desktop\attachment.pdf|type=OTHER|description=Attachment|reference=Ref123]
For base64 encoded documents, the syntax should follow this example:
[content=W3BhdGg9RDpcV29|type=OTHER|description=Attachment|reference=Ref123]
Attach a document using the API
Example of an API request that supports attaching documents to a shipment.
{
"Kind": 1,
"ActorCSID": "XXXXX",
"ProdCSID": 1287,
"OrderNo": "TEST SHIPMENT",
"Addresses": [
{
"Kind": 1,
"Name1": "John Doe",
"Street1": "Test address 1",
"Street2": "Test address 2",
"PostCode": "0580",
"City": "OSLO",
"CountryCode": "NO",
"Phone": "03455534534543534"
}
],
"ExternalDocuments": [
{
"Contents": "JVBERi0xL[...]HhyZWYNCjMyNzE1DQolJUVPRg==",
"Type": "COMMERCIAL_INVOICE",
"Format": "PDF",
"Name": "Test pic.",
"Description": "Test",
"Reference": "SS"
}
],
"Amounts": [
{
"Value": "89.16",
"Kind": 10,
"CurrencyCode": 5
}
],
"Lines": [
{
"GoodsTypeID": 1,
"PkgWeight": 5000,
"Pkgs": [
{
"ItemNo": 1
}
],
"References": [
{
"Kind": 23,
"Value": "Clothing"
}
]
}
],
"DetailGroups": [
{
"Rows": [
{
"Details": [
{
"Value": "9920999904206",
"KindID": 1
},
{
"Value": "1",
"KindID": 5
},
{
"Value": "GB",
"KindID": 4
},
{
"Value": "KG",
"KindID": 8
},
{
"Value": "CHAOS BLACK",
"KindID": 7
},
{
"Value": "32091000",
"KindID": 18
},
{
"Value": "2.4300",
"KindID": 6
},
{
"Value": "44.58",
"KindID": 2
},
{
"Value": "KG",
"KindID": 517
},
{
"Value": "EUR",
"KindID": 17
},
{
"Value": "1",
"KindID": 32
},
{
"Value": "2",
"KindID": 9
}
],
"GoodsLineNo": 1
}
],
"GroupID": 1
},
{
"Details": [
{
"Value": "89.16",
"KindID": 174
},
{
"Value": "EUR",
"KindID": 175
}
],
"GroupID": 4
},
{
"Details": [
{
"Value": "sale",
"KindID": 20
},
{
"Value": "EUR",
"KindID": 21
},
{
"Value": "DDU",
"KindID": 25
},
{
"Value": "89.16",
"KindID": 181
}
],
"GroupID": 2
}
]
}