Label Upload From Multipe Files API
It supports to upload labels for outbound order from Multiple Files. This article introduces the general Label Upload from Multiple Files API use case for easily understanding and applying this API.
Note: Please keep the format type of the all files are the same.
Introduction
The Label Upload from Multiple Files API enables users to upload multiple shipping labels from different files in a single request. This allows for efficient handling of bulk label uploads, especially when labels are generated across multiple sources or systems.
This API is to streamline the process of uploading numerous shipping labels at once, reducing manual input and potential errors. It centralizes label management and enhances the efficiency of outbound shipping operations by integrating multiple files into WMS.
API Request
API: POST /edi/outbound/order/file-upload
Body Request:
| FieldName | Description | DataType | Length | Required | Version | Sample | ||
|---|---|---|---|---|---|---|---|---|
| Root | ||||||||
| 1 | CompanyID | Company ID | string | 15 | Yes | 1.3 | "LT" | |
| 2 | FacilityID | Facility Id | string | 15 | Yes | 1.3 | "889" | |
| 3 | CustomerID | Customer Id | string | 15 | Yes | 1.3 | "AUKINT0001" | |
| 4 | ReferenceNo | Reference Number | string | 50 | Yes | 1.3 | "LIV2020021804-10" | |
| 6 | DocumentType | Document Type | string | 50 | Yes | 1.3.3 | Available Value: ------------------------ BOL Packing List Pallet Label (4" x 6") Shipping Label (4" x 6") Shipping Label (4" x 8") Shipping Label (Letter) UCC Label (4" x 6") | |
| 7 | TrackingNo | Tracking Number for shipping label | string | 50 | No | 1.3.3 | "1Z12345688ABC" | |
| 8 | SubTrackingNos | All tracking numbers for shipping lables | array | No | 1.3.4 | ["1Z12345688ABC1", "1Z12345688ABC2", "1Z12345688ABC3"] | ||
| 9 | Files | array | Yes | 1.3.4 | File Array | |||
| 9.1 | File Data | File Data | string | Yes | 1.3.4 | BASE64 of the file | ||
| 9.2 | FileName | File Name | string | 50 | Yes | 1.3.4 | "bol.png" |
Example
Request
{
"FacilityID": "889",
"CompanyID": "LT",
"CustomerID": "AUKINT0001",
"ReferenceNo": "Roy022501-1",
"DocumentType": "Shipping Label (4\" x 6\")",
"TrackingNo": "1Z1234567800001",
"Files": [
{
"FileData": "iVBORw0KGgoAAAANSUhEUgAAAtoAAALiCAYAAADnx3HzAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAAFiUAABYlAUlSJPAAAP+lSURBVHhe7N0H2G9VdSf+2..",
"FileName": "label1.png"
},
{
"FileData": "iVBORw0KGgoAAAANSUhEUgAAAtoAAALiCAYAAADnx3HzAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAAFiUAABYlAUlSJPAAAP+lSURBVHhe7N0H2G9VdSf+2..",
"FileName": "label2.png"
},
{
"FileData": "iVBORw0KGgoAAAANSUhEUgAAAtoAAALiCAYAAADnx3HzAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAAFiUAABYlAUlSJPAAAP+lSURBVHhe7N0H2G9VdSf+2..",
"FileName": "label3.png"
}
]
}