เอกสารคู่มือสำหรับการเชื่อมต่อ MOVEMAX ด้วย API ซึ่งทาง MOVEMAX ได้เปิดให้บริการ API เป็น RESTFUL SERVICE API และจะตอบกลับด้วย JSON เสมอ โดยก่อนที่จะเชื่อมต่อ API มารู้จักคำศัพท์ ในระบบ Movemax กันก่อนดีกว่า
| คำศัพท์ | ความหมาย |
|---|---|
| ใบนำส่ง (Shipping note) | เอกสารที่แสดงรายละเอียดการจัดส่งโดยจะจัดเก็บข้อมูลดังนี้ ที่อยู่ผู้รับ/ผู้ส่ง, รายการสินค้าที่จัดส่ง, สถานะการจัดส่งสินค้า, ต้นทุนการจัดส่ง และการเก็บเงินปลายทาง |
| ใบปิดบรรทุก (Manifest note) | เอกสารที่แสดงรายละเอียดการออกรถเพื่อจัดส่งโดยจะจัดเก็บข้อมูลดังนี้ รถขนส่ง/พ่่วงที่ใช้ในการจัดส่ง, คนขับรถที่รับผิดชอบ, ต้นทางการจัดส่ง, ปลายทางการจัดส่ง, รายการใบนำส่ง, ต้นทุนรวมการจัดส่ง |
| โครงการจัดส่ง (Delivery project) | เป็นหัวใจหลักของระบบ ขนส่งใน Movemax จะประกอบไปด้วย เรื่องสัญญาการจัดส่ง, ตั้งค่าการ Generator เลขที่ Tracking ใบนำส่ง และการตั้งค่าเกี่ยวกับการจัดส่งอื่นๆ |
| Cod (Cash on delivery) | เป็นการเก็บเงินปลายทางกรณี ที่ต้องการให้ผู้ส่งไปเก็บเงินปลายทางต้องระบุ ค่า field นี้ |
อัพเดทสถานะใบปิดบรรทุก Webhook
เป็น Webhook ที่จะส่งไปยัง URL ที่ user ระบุเมื่อ ระบบมีการเปลี่ยนสถานะใบปิดบรรทุกเพื่อเอาไป update สถานะกับระบบอื่น
Request Body schema: application/json
ข้อมูลใบปิดบรรทุก และสถานะที่อัพเดท
| id | integer <int64> ID ใบปิดบรรทุก |
| code | string เลข Tracking ใบปิดบรรทุก |
| state | integer <int32> type สถานะใบปิดบรรทุก |
| stateText | string สถานะใบปิดบรรทุก |
Responses
Request samples
- Payload
{- "id": 0,
- "code": "string",
- "state": 0,
- "stateText": "string"
}เพิ่มใบนำส่งและใบปิดบรรทุก
เป็น API ที่ใช้สำหรับนำเข้า ใบปิดบรรทุกและใบนำส่งเข้าไปในระบบ Movemax โดย API ตัวนี้รองรับการสร้างได้หลายใบนำส่งในคราวเดียว
header Parameters
| Authorization required | string Api Key |
Request Body schema: application/jsonrequired
required | Array of objects (ManifestNoteBookingData) รายการใบนำส่งที่ต้องการเพิ่ม | ||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||
Responses
Request samples
- Payload
{- "manifestNoteList": [
- {
- "manifestNoteNumber": "string",
- "deliveryProjectCode": "string",
- "merchantCode": "string",
- "endRouteLineCode": "string",
- "companyAcronym": "string",
- "coopfirmCode": "string",
- "driverCode": "string",
- "vehicleCode": "string",
- "addOnVehicleCode": "string",
- "vehicleTypeCode": "string",
- "fuelTypeCode": "string",
- "vehicleFuelUseRate": 0.1,
- "vehiclePercentReFuel": 100,
- "startConsumerDistributionCenterCode": "string",
- "startDistributionCenterCode": "string",
- "underDistributionCenterCode": "string",
- "startType": 1,
- "documentType": 0,
- "documentDate": "2019-08-24T14:15:22Z",
- "receiveProductDate": "2019-08-24T14:15:22Z",
- "hasSubApprove": true,
- "useMilkrun": true,
- "totalDistance": 0.1,
- "shippingNoteBookingList": [
- {
- "shippingNote": {
- "code": "string",
- "orderNo": "string",
- "referenceData": "string",
- "documentType": "string",
- "startDeliveryDate": "2019-08-24T14:15:22Z",
- "endDeliveryDate": "2019-08-24T14:15:22Z",
- "paymentType": 1,
- "merchantCode": "string",
- "deliverProjectCode": "string",
- "distributionCenterCode": "string",
- "sender": {
- "name": "string",
- "code": "string",
- "addressDescription": "ชื่อถนน หรือซอย",
- "address": "ต.บางบัวทอง อ.บางบัวทอง จ.นนทบุรี 11110",
- "lat": 0.1,
- "lng": 0.1,
- "contactTel": "string"
}, - "receiver": {
- "name": "string",
- "code": "string",
- "addressDescription": "ชื่อถนน หรือซอย",
- "address": "ต.บางบัวทอง อ.บางบัวทอง จ.นนทบุรี 11110",
- "lat": 0.1,
- "lng": 0.1,
- "contactTel": "string"
}, - "shipmentPriceType": 1,
- "deliveryPrice": 0.1,
- "pickUp": {
- "addressDescription": "ชื่อถนน หรือซอย",
- "address": "ต.บางบัวทอง อ.บางบัวทอง จ.นนทบุรี 11110",
- "lat": 0.1,
- "lng": 0.1,
- "name": "string",
- "contactTel": "string"
}, - "delivery": {
- "addressDescription": "ชื่อถนน หรือซอย",
- "address": "ต.บางบัวทอง อ.บางบัวทอง จ.นนทบุรี 11110",
- "lat": 0.1,
- "lng": 0.1,
- "name": "string",
- "contactTel": "string"
}, - "qty": 0,
- "weight": 0.1,
- "volume": 0.1,
- "productList": [
- {
- "code": "string",
- "name": "string",
- "orderNo": "string",
- "packageNo": "string",
- "cod": 0.1,
- "description": "string",
- "qty": 0.1,
- "actualQty": 0.1,
- "unitCode": "string",
- "hasCalWeightPerUnit": false,
- "weightPerUnit": 0.1,
- "volumeType": 1,
- "boxSizeWidth": 0.1,
- "boxSizeLength": 0.1,
- "boxSizeHeight": 0.1,
- "hasCalVolumePerUnit": true,
- "volumePerUnit": 0.1
}
], - "trickSendCreateManifestNote": true,
- "description": "string"
}, - "pickUpAddressText": "ชื่อถนน หรือซอย",
- "pickUpAddress": "ต.บางบัวทอง อ.บางบัวทอง จ.นนทบุรี 11110",
- "pickUpLat": 0.1,
- "pickUpLng": 0.1,
- "sendAddressText": "ชื่อถนน หรือซอย",
- "sendAddress": "ต.บางบัวทอง อ.บางบัวทอง จ.นนทบุรี 11110",
- "sendLat": 0.1,
- "sendLng": 0.1
}
], - "draft": true
}
]
}ใช้สำหรับปิด ManifestNote (ปิด Job)
เป็น API ที่ใช้สำหรับปิดงานใบปิดบรรทุก
header Parameters
| Authorization required | string Api Key |
Request Body schema: application/jsonrequired
| manifestNoteNumber | string รหัสใบปิดบรรทุก |
Array of objects |
Responses
Request samples
- Payload
[- {
- "manifestNoteNumber": "string",
- "shipmentList": [
- {
- "shippingNoteNumber": "string",
- "state": 3
}
]
}
]ค้นหาใบปิดบรรทุก
เป็น API ที่ใช้สำหรับค้นหาใบปิดบรรทุก
header Parameters
| Authorization required | string Api Key |
Request Body schema: application/jsonrequired
| manifestNoteNumber | string เลขใบปิดบรรทุก |
| vehicleLicensePlate | string ทะเบียนรถ |
| startDocumentDate | string <date-time> วันที่เริ่มต้นใบปิดบรรทุก |
| endDocumentDate | string <date-time> วันที่สิ้นสุดใบปิดบรรทุก |
| deliveryProjectCode | string รหัสโครงการ |
Responses
Request samples
- Payload
[- {
- "manifestNoteNumber": "string",
- "vehicleLicensePlate": "string",
- "startDocumentDate": "2019-08-24T14:15:22Z",
- "endDocumentDate": "2019-08-24T14:15:22Z",
- "deliveryProjectCode": "string"
}
]แทรกใบงานนำส่งในใบปิดบรรทุก
แทรกใบงานนำส่งในใบปิดบรรทุก
header Parameters
| Authorization required | string Api Key |
Request Body schema: application/json
| manifestNoteCode | string รหัสใบปิดบรรทุก |
Array of objects | |
| shippingBookingDeletedIdList | Array of numbers <int64> [ items <int64 > ] |
Responses
Request samples
- Payload
[- {
- "manifestNoteCode": "string",
- "newShippingBookingList": [
- {
- "shippingNoteNumber": "string",
- "pickUpAddressText": "ชื่อถนน หรือซอย",
- "pickUpAddress": "ต.บางบัวทอง อ.บางบัวทอง จ.นนทบุรี 11110",
- "sendAddressText": "ชื่อถนน หรือซอย",
- "sendAddress": "ต.บางบัวทอง อ.บางบัวทอง จ.นนทบุรี 11110"
}
], - "shippingBookingDeletedIdList": [
- 0
]
}
]อัพเดทสถานะใบนำส่ง Webhook
เป็น Webhook ที่จะส่งไปยัง URL ที่ user ระบุเมื่อ ระบบมีการเปลี่ยนสถานะใบนำส่งเพื่อเอาไป update สถานะกับระบบอื่น
Request Body schema: application/json
ข้อมูลใบนำส่ง และสถานะที่อัพเดท
| id | integer <int64> ID ใบนำส่ง |
| code | string เลข Tracking ใบนำส่ง |
| state | integer <int32> type สถานะใบนำส่ง |
| stateText | string สถานะใบนำส่ง |
Responses
Request samples
- Payload
{- "id": 0,
- "code": "string",
- "state": 0,
- "stateText": "string"
}สร้างใบนำส่ง
เป็น API ที่ใช้สำหรับนำเข้า order การจัดส่งเข้าไปในระบบ Movemax โดย API ตัวนี้รองรับการสร้างได้หลายใบนำส่งในคราวเดียว
header Parameters
| Authorization required | string Api Key |
Request Body schema: application/jsonrequired
Array of objects รายการใบนำส่งที่ต้องการเพิ่ม | |||||||||||||||||||||||
Array
| |||||||||||||||||||||||