Receiving shipping information and sending carrier information using API
Name |
Description |
Mandatory |
DataType |
Length(Max) |
Example |
Format |
clientId |
Client ID(API Key) |
Y |
String |
|
|
|
Name |
Description |
Mandatory |
DataType |
Length(Max) |
Example |
Format |
carrierCode |
Carrier Code |
Y |
String |
10 |
111111 |
|
Name |
Description |
Mandatory |
DataType |
Length(Max) |
Example |
Format |
acceptDateFrom |
Accept Date From |
Y |
String |
8 |
20240129 |
yyyyMMdd |
acceptDateTo |
Accept Date To |
N |
String |
8 |
20240129 |
yyyyMMdd |
Name |
Description |
Mandatory |
DataType |
Length(Max) |
Example |
Format |
plant |
Plant |
Y |
String |
4 |
21R2 |
|
shipmentNo |
Shipment No |
Y |
String |
10 |
1009999999 |
|
carrierCode |
Carrier Code |
Y |
String |
10 |
0000111111 |
|
carrierName |
Carrier Name |
Y |
String |
100 |
Test Logistics |
|
deliveryNo |
Deliver No |
Y |
String |
10 |
8111111111 |
|
- Success(http status : 200)
{
"status": "OK",
"totalCount": 3,
"shippingList": [
{
"plant: "21R2",
"shipmentNo": "1009999999",
"carrierCode": "0000111111",
"carrierName": "Test Logistics",
"deliverNo": "8111111111"
},
{
"plant: "21R2",
"shipmentNo": "1009999999",
"carrierCode": "0000111111",
"carrierName": "Test Logistics",
"deliverNo": "8111111112"
},
{
"plant: "21R2",
"shipmentNo": "1009999999",
"carrierCode": "0000111111",
"carrierName": "Test Logistics",
"deliverNo": "8111111113"
}
]
}
- Error(http status : 400(Bad Request) / 500(Internal Server Error))
{
"message": "API key does not exist.",
"code": "BUSINESS_EXCEPTION",
"fieldErrors": []
}
- If the data type is string : Update if the value exists or is space(' ') and not update if the value is null.
- If the data type is Number or multipart/form-data : Update if the value exists and not update if the value is null.
Name |
Description |
Mandatory |
DataType |
Length(Max) |
Example |
Format |
clientId |
Client ID(API Key) |
Y |
String |
|
|
|
Name |
Description |
Mandatory |
DataType |
Length(Max) |
Example |
Format |
plant |
Plant |
Y |
String |
4 |
21R2 |
|
shipmentNo |
Shipment No |
Y |
String |
10 |
1009999999 |
|
carrierCode |
Carrier Code |
Y |
String |
10 |
111111 |
|
deliveryNo |
Deliver No |
Y |
String |
10 |
8111111111 |
|
truckNo |
Truck No |
N |
String |
20 |
4HIG204 |
|
finalPud |
Final PUD(Date) |
N |
String |
8 |
20240129 |
yyyyMMdd |
finalPut |
Final PUT(Time) |
N |
String |
4 |
1540 |
HHmm |
cstmrRdd |
Customer RDD(Date) |
N |
String |
8 |
20240129 |
yyyyMMdd |
cstmrRdt |
Customer RDT(Time) |
N |
String |
4 |
1540 |
HHmm |
actDeliveryDate |
Actual Delivery Date |
N |
String |
8 |
20240129 |
yyyyMMdd |
carrierRemark |
Remarks |
N |
String |
300 |
remarks |
|
waitingTimeRdc |
(Minute)RDC(WareHouse) Gate In Time - Gate Out Time |
N |
Number |
5 |
30 |
|
waitingTimeCstmr |
(Minute)Customer Gate in Time - Gate Out Time |
N |
Number |
5 |
30 |
|
layOver |
Lay Over(Delivery delay status), Y or N |
N |
String |
1 |
Y |
|
cstmrGateIn |
Customer Gate In(Date, Time) |
N |
String |
12 |
202401251500 |
yyyyMMddHHmm |
cstmrGateOut |
Customer Gate Out(Date, Time) |
N |
String |
12 |
202401251500 |
yyyyMMddHHmm |
podFile |
POD File |
N |
multipart/form-data |
|
|
|
invoiceFile |
Invoice File |
N |
multipart/form-data |
|
|
|
invoiceNo |
Invoice No |
N |
String |
10 |
262327 |
|
invoiceDate |
Invoice Date |
N |
String |
8 |
20240129 |
yyyyMMdd |
infoOfDelivery |
IOD(Information Of Delivery) - Delivery level(the date and time of arrival) |
N |
String |
12 |
202401251500 |
yyyyMMddHHmm |
vehicleLocLat |
Vehicle Location(Latitude) |
N |
String |
20 |
36.1080234388639 |
|
vehicleLocLon |
Vehicle Location(Longitude) |
N |
String |
20 |
-86.8155744216323 |
|
- Success(http status : 200)
{
"code": "200",
"status": "OK"
}
- Error(http status : 400(Bad Request) / 500(Internal Server Error))
{
"message": "API key does not exist.",
"code": "BUSINESS_EXCEPTION",
"fieldErrors": []
}
Receiving delivery order information and sending 3PL information using API
Name |
Description |
Mandatory |
DataType |
Length(Max) |
Example |
Format |
clientId |
Client ID(API Key) |
Y |
String |
|
|
|
Name |
Description |
Mandatory |
DataType |
Length(Max) |
Example |
Format |
plant |
Plant Code |
Y |
String |
4 |
27R0 |
|
Name |
Description |
Mandatory |
DataType |
Length(Max) |
Example |
Format |
doFromDate |
DO Creation Date From |
Y |
String |
8 |
20240129 |
yyyyMMdd |
doToDate |
DO Creation Date To |
Y |
String |
8 |
20240129 |
yyyyMMdd |
giFromDate |
Actual Goods Issue Date From |
N |
String |
8 |
20240129 |
yyyyMMdd |
giToDate |
Actual Goods Issue Date To |
N |
String |
8 |
20240129 |
yyyyMMdd |
deliveryNo |
Delivery Order No. |
N |
String |
10 |
1000000001 |
|
Name |
Description |
Mandatory |
DataType |
Length(Max) |
Example |
Format |
sorg |
Sales Org |
Y |
String |
4 |
2700 |
|
plant |
Plant |
Y |
String |
4 |
27R0 |
|
shipmentNo |
Shipment No. (SAP) |
Y |
String |
10 |
1000000000 |
|
deliveryNo |
Delivery order No. |
Y |
String |
10 |
1000000001 |
|
deliveryLineNo |
Delivery order line No. |
Y |
String |
6 |
000000 |
|
quantity |
Quantity |
Y |
Number |
10 |
100 |
|
materialCode |
Material Code |
Y |
String |
14 |
1022110 |
|
doCreationDate |
DO Creation Date |
Y |
String |
8 |
20240723 |
|
giDate |
Actual Goods Issue Date |
Y |
String |
8 |
20240723 |
|
- Success(http status : 200)
{
"status": "OK",
"totalCount": 3,
"shippingList": [
{
"sorg": "2700",
"plant": "27R0",
"shipmentNo": "1004733906",
"deliveryNo": "8120802345",
"deliveryLineNo": "000010",
"quantity": 2,
"materialCode": "3003285",
"doCreationDate": "20240208",
"giDate": "20240209"
},
{
"sorg": "2700",
"plant": "27R0",
"shipmentNo": "1004733906",
"deliveryNo": "8120802349",
"deliveryLineNo": "000010",
"quantity": 16,
"materialCode": "3003482",
"doCreationDate": "20240208",
"giDate": "20240209"
},
{
"sorg": "2700",
"plant": "27R0",
"shipmentNo": "1004733906",
"deliveryNo": "8120802349",
"deliveryLineNo": "000020",
"quantity": 4,
"materialCode": "3003285",
"doCreationDate": "20240208",
"giDate": "20240209"
},
...
],
}
- Error(http status : 400(Bad Request) / 500(Internal Server Error))
{
"message": "API key does not exist.",
"code": "BUSINESS_EXCEPTION",
"fieldErrors": []
}
- If the data type is string, Update if the value exists or is space(' ') and not update if the value is null.
Name |
Description |
Mandatory |
DataType |
Length(Max) |
Example |
Format |
clientId |
Client ID(API Key) |
Y |
String |
|
|
|
Name |
Description |
Mandatory |
DataType |
Length(Max) |
Example |
Format |
plant |
Plant |
Y |
String |
4 |
21O2 |
|
deliveryNo |
Delivery order No. |
Y |
String |
10 |
1000000001 |
|
shipmentNo |
Shipment No. (LSP) |
N |
String |
10 |
1000000000 |
|
shipmentMode |
Transfortation Type (LTL, FTL, Parcel, Groupage, ETC) |
N |
String |
10 |
Groupage |
|
iodDate |
Actual Delivery Date |
N |
String |
12 |
202407231530 |
yyyyMMddHHmm |
podFile |
POD File |
N |
multipart/form-data |
|
|
|
- Success(http status : 200)
{
"code": "200",
"status": "OK"
}
- Error(http status : 400(Bad Request) / 500(Internal Server Error))
{
"message": "API key does not exist.",
"code": "BUSINESS_EXCEPTION",
"fieldErrors": []
}