Scribd
Upload
19 views

Dist

This document provides a summary of the APIs available for orders, order status updates, and fleet expenses. It includes the method, URL, request body format, and possible response statuses and bodies for getting order details, posting order status, and posting fleet expenses.

Uploaded by

ibrahim Tumeh
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
19 views

Dist

This document provides a summary of the APIs available for orders, order status updates, and fleet expenses. It includes the method, URL, request body format, and possible response statuses and bodies for getting order details, posting order status, and posting fleet expenses.

Uploaded by

ibrahim Tumeh
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 6

Oak Tree Tech Solutions

DisTech – Implementation APIs


Version 1.1

11-25-2023

1
Index
Table of Contents
Orders ........................................................................................................................................................... 3
Get Orders with Details......................................................................................................................... 3
Post Order Status ...................................................................................................................................... 4
Fleet .............................................................................................................................................................. 5
Post Expenses............................................................................................................................................ 5

2
Orders
Get Orders with Details

Method URL

GET

Response

Status Response

200 "data": {

"ref_num": "string", // ex: ERP04589

"storage_type": "string", // ex: Dry, Frozen, Chilled...

"delivery_address": "text", // Adderss in words To Dilever the order to

"date": "date", // Invoice Date

"total_amount": "double", // Total Invoice Amount

"total quantity": "double", // Total Quantities in Units

"cbm": "double", // Total Order CBM

"weight": "double", // Total Order Weight

"status": "string", // Order Current Status

"delivery_date": "date", // Order Delivery Date

"latitude": "double", // Delivery Latitude

"longitude": "double", // Delivery Longitude

"notes": "text", // External Notes to show to driver

"customer": {

"ref_num": "string", // Customer Ref Number ex: C123

"name": "string", // Customer Name

"mobile": "number", // Customer Mobile number

"address": "string", // Customer Address

"latitude": "double", // Cusotmer Latitude

3
"longitude": "double" // Cusotmer Longitude

},

"features": [ // Array of Order Features

"array of string"

],

"details": [ // Array of order details

"ref_num": "string", // Item Detail Ref Number

"sku": "string", // Unique Item Code

"name": "string", // Item Name

"unit": "string", // Unit sold

"packing": "double", // Items per unit

"quantity": "double", // Unit Quantity

"amount": "double", // Item Total

"cbm": "double", // Item CBM

"weight": "double" // Item Weight

401 "status": "error",

"message": "Unauthenticated"

500 "message": "Server Error"

Post Order Status

Method URL

POST

Request

4
Response

"order": {

"ref_num": "string", // ex: ERP04589

"status": "string", // Order Current Status: Delivered, Cancelled, Returned,


Partial Return

"details": [

"ref_num": "string", // Item Detail Ref Number

"status": "string" // Detail Current Status: Delivered, Cancelled, Returned

Response

Status Response

200 "status": "success",

"message": "",

"data": null

500 "message": "Server Error"

Fleet

Post Expenses

Method URL

POST

Request

5
Response

"data": {

"invoice_ref_number": "string", // invoice number

"service_name": "string", // Service name as posted on the system

"service_type": "string", // Service Type ex: oil change

"amount": "double", // Total Cost

"plate_number": "string", // Vehicle Plate Number

"vehicle_type": "string", // Vehicle Type

"documents": ["strings"] // Array of documents links

Response

Status Response

200 "status": "success",

"message": "",

"data": null

500 "message": "Server Error"

You might also like