Scanner Admin APIs
Overview ¶
The Scanner Admin APIs are used to get the container details, inventory check details, facility details, inbound and outbound summary details, daily inbound detail summary details, total inventory summary details, outbound number details, outbound summary by order details, manifest number details, outbound summary by manifest details, order manifest number details, order number details, manifest order tracking by manifest details, manifest order tracking details, inbound adjustment details, manifest number outbound adjustment details, shipment transfer force details, outbound adjustment details, transfer force inbound details. These are RESTful APIs that use the HTTP request methods GET to retrieve the data. Authorization is required to access these APIs.
Bearer Token
A bearer token is a type of access token that is used for authorization in APIs. It is a cryptic string that is generated by the server in response to a login request. The client must send this token in the Authorization header when making requests to protected resources.
The “Bearer” keyword is a signal to the server that the token is a type of bearer token. Here’s an example of how to use it:
Authorization: Bearer <Your-Bearer-Token>
Replace
For example:
Authorization: Bearer 5262d64b892e8d4341000001
Error Messages
-
400 Bad Request: This error is returned when the server could not understand the request due to invalid syntax. Check your request body and parameters. -
401 Unauthorized: This error is returned when the request lacks valid authentication credentials for the target resource. Make sure your API key is correct. -
403 Forbidden: This error is returned when the server understood the request, but it refuses to authorize it. This status is often returned if you’re missing permissions to access the resource. -
404 Not Found: This error is returned when the server can’t find the requested resource. Check your endpoint and parameters. -
500 Internal Server Error: This error is returned when the server encounters an unexpected condition that prevented it from fulfilling the request.
Scanner Admin & Container Status & Inventory APIs ¶
getContainerDetails ¶
getContainerDetailsGET/api/wastetracking/containerstatus/getContainerDetails{?containerid}
Overview:
The getContainerDetails endpoint, accessible at /api/wastetracking/containerstatus/getContainerDetails, is a GET request that is used to get the container details.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the operation was successful. |
| content | object | An object containing the container details. |
| details | object | An object containing the container details. |
| listWarehouse | array | An array of warehouses. |
| listStorage | array | An array of storage locations. |
| listInboundPUP | array | An array of inbound PUPs. |
| listRejReason | array | An array of rejection reasons. |
| mmpList | array | An array of MMPs. |
| fingerCodeList | array | An array of finger codes. |
| container_Inbound | object | An object containing the container inbound details. |
Example URI
- containerid
number(required)The container ID.
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": {
"details": {},
"listWarehouse": [],
"listStorage": [],
"listInboundPUP": [],
"listRejReason": [],
"mmpList": [],
"fingerCodeList": [],
"container_Inbound": null
}
}inventorycheck ¶
inventorycheckGET/api/wastetracking/inventorycheck/
Overview:
The inventorycheck endpoint, accessible at /api/wastetracking/inventorycheck/, is a GET request that is used to get the inventory check details.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the operation was successful. |
| content | object | An object containing the inventory check details. |
| details | array | An array of inventory check details. |
Example URI
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": {
"details": []
}
}inbound_outbound_get_facility ¶
inbound_outbound_get_facilityGET/api/wastetracking/scanneradmin/inbound_outbound_get_facility/
Overview:
The inbound_outbound_get_facility endpoint, accessible at /api/wastetracking/scanneradmin/inbound_outbound_get_facility/, is a GET request that is used to get the facility details.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the operation was successful. |
| content | object | An object containing the facility details. |
| items | array | An array of facility items. |
| id | number | The facility ID. |
| Name | string | The facility name. |
Example URI
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": {
"items": [
{
"id": 345,
"Name": "WASTELINQ"
},
{
"id": 71,
"Name": "Company A"
},
{
"id": 70,
"Name": "Company B"
}
]
}
}get_inbound_outbound_summary ¶
get_inbound_outbound_summaryGET/api/wastetracking/scanneradmin/get_inbound_outbound_summary
Overview:
The get_inbound_outbound_summary endpoint, accessible at /api/wastetracking/scanneradmin/get_inbound_outbound_summary, is a GET request that is used to get the inbound and outbound summary details.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the operation was successful. |
| content | object | An object containing the inbound and outbound summary details. |
| details | array | An array of inbound and outbound summary details. |
Example URI
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": {
"details": []
}
}daily_inbound_detail_summary ¶
daily_inbound_detail_summaryGET/api/wastetracking/scanneradmin/daily_inbound_detail_summary{?pupdate,dayrun,truckid}
Overview:
The daily_inbound_detail_summary endpoint, accessible at /api/wastetracking/scanneradmin/daily_inbound_detail_summary, is a GET request that is used to get the daily inbound detail summary details.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the operation was successful. |
| content | object | An object containing the daily inbound detail summary. |
| details | array | An array of daily inbound detail summary. |
Example URI
- pupdate
string(required)The PUP date.
- dayrun
string(required)The day run.
- truckid
string(required)The truck ID.
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": {
"details": []
}
}total_inventory_summary ¶
total_inventory_summaryGET/api/wastetracking/scanneradmin/total_inventory_summary{?facility,facility_name}
Overview:
The total_inventory_summary endpoint, accessible at /api/wastetracking/scanneradmin/total_inventory_summary, is a GET request that is used to get the total inventory summary details.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the operation was successful. |
| content | object | An object containing the total inventory summary. |
| details | array | An array of total inventory summary. |
Example URI
- facility
number(required)The facility ID.
- facility_name
string(required)The facility name.
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": {
"details": []
}
}get_outbound_number ¶
get_outbound_numberGET/api/wastetracking/scanneradmin/get_outbound_number/
Overview:
The get_outbound_number endpoint, accessible at /api/wastetracking/scanneradmin/get_outbound_number/, is a GET request that is used to get the outbound number details.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the operation was successful. |
| content | object | An object containing the outbound number details. |
| items | array | An array of outbound number items. |
| id | number | The outbound number ID. |
| Name | number | The outbound number. |
Example URI
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": {
"items": [
{
"id": 42383,
"Name": 27903
},
{
"id": 51381,
"Name": 36897
}
]
}
}outbound_summary_by_order ¶
outbound_summary_by_orderGET/api/wastetracking/scanneradmin/outbound_summary_by_order{?shipmentid}
Overview:
The outbound_summary_by_order endpoint, accessible at /api/wastetracking/scanneradmin/outbound_summary_by_order, is a GET request that is used to get the outbound summary by order details.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the operation was successful. |
| content | object | An object containing the outbound summary by order details. |
| details | array | An array of outbound summary by order details. |
| id | number | The ID. |
| container_number | string | The container number. |
| type_volume | string | The type volume. |
| weight | number | The weight. |
| disposal_facility_mame | string | The disposal facility name. |
| facility | string | The facility. |
| outbound_number | number | The outbound number. |
Example URI
- shipmentid
number(required)The shipment ID.
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": {
"details": [
{
"id": 1236,
"container_number": "22222-1-1",
"type_volume": "DF - 95",
"weight": 1,
"disposal_facility_mame": "Company A"
},
{
"id": 1237,
"container_number": "22222-1-2",
"type_volume": "DF - 95",
"weight": 1,
"disposal_facility_mame": "Company B"
},
{
"id": "-1",
"container_number": "",
"type_volume": "Count - 2",
"weight": 2,
"disposal_facility_mame": ""
}
],
"facility": "Company ABC",
"outbound_number": 27903
}
}get_manifest_number ¶
get_manifest_numberGET/api/wastetracking/scanneradmin/get_manifest_number/
Overview:
The get_manifest_number endpoint, accessible at /api/wastetracking/scanneradmin/get_manifest_number/, is a GET request that is used to get the manifest number details.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the operation was successful. |
| content | object | An object containing the manifest number details. |
| items | array | An array of manifest number items. |
| id | number | The manifest number ID. |
| Name | number | The manifest number. |
Example URI
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": {
"items": [
{
"id": "22222",
"Name": "22222"
},
{
"id": "33333",
"Name": "33333"
}
]
}
}outbound_summary_by_manifest ¶
outbound_summary_by_manifestGET/api/wastetracking/scanneradmin/outbound_summary_by_manifest{?manifest}
Overview:
The outbound_summary_by_manifest endpoint, accessible at /api/wastetracking/scanneradmin/outbound_summary_by_manifest, is a GET request that is used to get the outbound summary by manifest details.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the operation was successful. |
| content | object | An object containing the outbound summary by manifest details. |
| details | array | An array of outbound summary by manifest details. |
| id | number | The ID. |
| container_number | string | The container number. |
| type_volume | string | The type volume. |
| weight | number | The weight. |
| disposal_facility_mame | string | The disposal facility name. |
| facility | string | The facility. |
| outbound_number | number | The outbound number. |
Example URI
- manifest
string(required)The manifest number.
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": {
"details": [
{
"id": 6489,
"container_number": "22222-1-1",
"type_volume": "DM - 55",
"weight": 1,
"disposal_facility_mame": "Company A"
},
{
"id": 6459,
"container_number": "22222-1-2",
"type_volume": "DM - 55",
"weight": 1,
"disposal_facility_mame": "Company B"
},
{
"id": "-1",
"container_number": "",
"type_volume": "Count - 2",
"weight": 2,
"disposal_facility_mame": ""
}
],
"facility": "Company ABC",
"outbound_number": 36897
}
}get_order_manifest_number ¶
get_order_manifest_numberGET/api/wastetracking/scanneradmin/get_order_manifest_number/
Overview:
The get_order_manifest_number endpoint, accessible at /api/wastetracking/scanneradmin/get_order_manifest_number/, is a GET request that is used to get the order manifest number details.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the operation was successful. |
| content | object | An object containing the order manifest number details. |
| items | array | An array of order manifest number items. |
| id | number | The order manifest number ID. |
| Name | number | The order manifest number. |
Example URI
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": {
"items": [
{
"id": "22222",
"Name": "22222"
},
{
"id": "333333",
"Name": "33333"
},
{
"id": "44444",
"Name": "44444"
}
]
}
}get_order_number ¶
get_order_numberGET/api/wastetracking/scanneradmin/get_order_number/
Overview:
The get_order_number endpoint, accessible at /api/wastetracking/scanneradmin/get_order_number/, is a GET request that is used to get the order number details.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the operation was successful. |
| content | object | An object containing the order number details. |
| items | array | An array of order number items. |
| id | number | The order number ID. |
| Name | number | The order number. |
Example URI
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": {
"items": [
{
"id": 148610,
"Name": 214501
},
{
"id": 148664,
"Name": 214555
}
]
}
}manifest_order_tracking_by_manifest ¶
manifest_order_tracking_by_manifestGET/api/wastetracking/scanneradmin/manifest_order_tracking_by_manifest{?manifest}
Overview:
The manifest_order_tracking_by_manifest endpoint, accessible at /api/wastetracking/scanneradmin/manifest_order_tracking_by_manifest, is a GET request that is used to get the manifest order tracking by manifest details.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the operation was successful. |
| content | object | An object containing the manifest order tracking by manifest details. |
| details | array | An array of manifest order tracking by manifest details. |
| id | number | The ID. |
| order_number | number | The order number. |
| manifest_line | string | The manifest line. |
| container_id | string | The container ID. |
| type_size | string | The type size. |
| disposal_facility | string | The disposal facility. |
| grade | string | The grade. |
| weight | number | The weight. |
| reject_reason | string | The reject reason. |
| last_inbound | string | The last inbound. |
| sub_table | array | An array of sub table details. |
| id | string | The ID. |
| inbound_scan_type | string | The inbound scan type. |
| inbound_scan_date | string | The inbound scan date. |
| inbound_scan_facility | string | The inbound scan facility. |
| outbound_id | string | The outbound ID. |
| outbound_trailer | string | The outbound trailer. |
Example URI
- manifest
string(required)The manifest number.
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": {
"details": [
{
"id": 11159,
"order_number": 348612,
"manifest_line": "22222 - 1",
"container_id": "22222-1-1",
"type_size": "CF - 202",
"disposal_facility": "Company A",
"grade": null,
"weight": 0,
"reject_reason": "None",
"last_inbound": "Company ABC",
"sub_table": [
{
"id": "11159-1",
"inbound_scan_type": "Inbound",
"inbound_scan_date": "09-09-2022 8:57:13 AM",
"inbound_scan_facility": "Company ABC",
"outbound_id": "",
"outbound_trailer": ""
},
{
"id": "11159-2",
"inbound_scan_type": "Outbound",
"inbound_scan_date": " ",
"inbound_scan_facility": "",
"outbound_id": "",
"outbound_trailer": ""
}
]
},
{
"id": 11158,
"order_number": 348612,
"manifest_line": "33333 - 3",
"container_id": "33333-3-1",
"type_size": "DM - 30",
"disposal_facility": "Company B",
"grade": null,
"weight": 0,
"reject_reason": "None",
"last_inbound": "Company ABC",
"sub_table": [
{
"id": "11158-1",
"inbound_scan_type": "Inbound",
"inbound_scan_date": "09-09-2022 8:56:30 AM",
"inbound_scan_facility": "Company ABC",
"outbound_id": "",
"outbound_trailer": ""
},
{
"id": "11158-2",
"inbound_scan_type": "Outbound",
"inbound_scan_date": " ",
"inbound_scan_facility": "",
"outbound_id": "",
"outbound_trailer": ""
}
]
}
]
}
}manifest_order_tracking ¶
manifest_order_trackingGET/api/wastetracking/scanneradmin/manifest_order_tracking{?orderid}
Overview:
The manifest_order_tracking endpoint, accessible at /api/wastetracking/scanneradmin/manifest_order_tracking, is a GET request that is used to get the manifest order tracking details.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the operation was successful. |
| content | object | An object containing the manifest order tracking details. |
| details | array | An array of manifest order tracking details. |
| id | number | The ID. |
| order_number | number | The order number. |
| manifest_line | string | The manifest line. |
| container_id | string | The container ID. |
| type_size | string | The type size. |
| disposal_facility | string | The disposal facility. |
| grade | string | The grade. |
| weight | number | The weight. |
| reject_reason | string | The reject reason. |
| last_inbound | string | The last inbound. |
| sub_table | array | An array of sub table details. |
| id | string | The ID. |
| inbound_scan_type | string | The inbound scan type. |
| inbound_scan_date | string | The inbound scan date. |
| inbound_scan_facility | string | The inbound scan facility. |
| outbound_id | string | The outbound ID. |
| outbound_trailer | string | The outbound trailer. |
Example URI
- orderid
number(required)The order ID.
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": {
"details": [
{
"id": 4581,
"order_number": 314073,
"manifest_line": "22222 - 1",
"container_id": "22222-1-11",
"type_size": "DM - 55",
"disposal_facility": "Company A",
"grade": null,
"weight": 0,
"reject_reason": "None",
"last_inbound": "Company ABC",
"sub_table": [
{
"id": "4581-1",
"inbound_scan_type": "Inbound",
"inbound_scan_date": "11-09-2021 2:09:7 PM",
"inbound_scan_facility": "Company ABC",
"outbound_id": "",
"outbound_trailer": ""
},
{
"id": "4581-2",
"inbound_scan_type": "Outbound",
"inbound_scan_date": " ",
"inbound_scan_facility": "",
"outbound_id": "",
"outbound_trailer": ""
}
]
}
]
}
}show_inbound_adjustment ¶
show_inbound_adjustmentGET/api/wastetracking/scanneradmin/show_inbound_adjustment{?id}
Overview:
The show_inbound_adjustment endpoint, accessible at /api/wastetracking/scanneradmin/show_inbound_adjustment, is a GET request that is used to get the inbound adjustment details.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the operation was successful. |
| content | object | An object containing the inbound adjustment details. |
| details | array | An array of inbound adjustment details. |
| id | number | The ID. |
| container_number | string | The container number. |
| disposal_facility_mame | string | The disposal facility name. |
| type_volume | string | The type volume. |
| created_date | string | The created date. |
| facility | string | The facility. |
Example URI
- id
number(required)The ID.
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": {
"details": [
{
"id": 10254,
"container_number": "22222-2-1",
"disposal_facility_mame": "Company A",
"type_volume": "DM - 55",
"created_date": "05-04-2022 - 8:43:6 AM",
"facility": "Company ABC"
}
]
}
}get_manifest_number_outbound_adjustment ¶
get_manifest_number_outbound_adjustmentGET/api/wastetracking/scanneradmin/get_manifest_number_outbound_adjustment/
Overview:
The get_manifest_number_outbound_adjustment endpoint, accessible at /api/wastetracking/scanneradmin/get_manifest_number_outbound_adjustment/, is a GET request that is used to get the manifest number outbound adjustment details.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the operation was successful. |
| content | object | An object containing the manifest number outbound adjustment details. |
| items | array | An array of manifest number outbound adjustment items. |
| id | number | The manifest number ID. |
| Name | number | The manifest number. |
Example URI
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": {
"items": [
{
"id": 42383,
"Name": 27903
},
{
"id": 51381,
"Name": 36897
}
]
}
}get_shipment_transfer_force ¶
get_shipment_transfer_forceGET/api/wastetracking/scanneradmin/get_shipment_transfer_force/
Overview:
The get_shipment_transfer_force endpoint, accessible at /api/wastetracking/scanneradmin/get_shipment_transfer_force/, is a GET request that is used to get the shipment transfer force details.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the operation was successful. |
| content | object | An object containing the shipment transfer force details. |
| items | array | An array of shipment transfer force items. |
| id | number | The shipment transfer force ID. |
| Name | number | The shipment transfer force. |
Example URI
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": {
"items": [
{
"id": 12567,
"Name": 10687
},
{
"id": 14280,
"Name": 12398
}
]
}
}show_outbound_adjustment ¶
show_outbound_adjustmentGET/api/wastetracking/scanneradmin/show_outbound_adjustment{?id}
Overview:
The show_outbound_adjustment endpoint, accessible at /api/wastetracking/scanneradmin/show_outbound_adjustment, is a GET request that is used to get the outbound adjustment details.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the operation was successful. |
| content | object | An object containing the outbound adjustment details. |
| details | array | An array of outbound adjustment details. |
| id | number | The ID. |
| container_number | string | The container number. |
| disposal_facility_mame | string | The disposal facility name. |
| type_volume | string | The type volume. |
| created_date | string | The created date. |
| weight | number | The weight. |
| outbound_number | number | The outbound number. |
| facility | string | The facility. |
Example URI
- id
number(required)The ID.
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": {
"details": [
{
"id": 1236,
"container_number": "22222-1-1",
"disposal_facility_mame": "Company A",
"type_volume": "DF - 95",
"created_date": "11-09-2021 - 1:51:19 PM",
"weight": 1
},
{
"id": 1237,
"container_number": "22222-1-2",
"disposal_facility_mame": "Company ABC",
"type_volume": "DF - 95",
"created_date": "11-09-2021 - 1:51:25 PM",
"weight": 1
}
],
"outbound_number": 27903,
"facility": "Company ABC"
}
}show_transfer_force_inbound ¶
show_transfer_force_inboundGET/api/wastetracking/scanneradmin/show_transfer_force_inbound{?id}
Overview:
The show_transfer_force_inbound endpoint, accessible at /api/wastetracking/scanneradmin/show_transfer_force_inbound, is a GET request that is used to get the transfer force inbound details.
Request Body and Response Description:
| Name | Data Type | Description |
|---|---|---|
| success | boolean | Indicates whether the operation was successful. |
| content | object | An object containing the transfer force inbound details. |
| details | array | An array of transfer force inbound details. |
| id | number | The ID. |
| manifest_number | string | The manifest number. |
| disposal_facility | string | The disposal facility. |
| Shipment_Number | number | The shipment number. |
Example URI
- id
number(required)The ID.
Headers
Content-Type: application/json
Authorization: {TOKEN}200Headers
Content-Type: application/jsonBody
{
"success": true,
"content": {
"details": [
{
"id": 636399,
"manifest_number": "22222",
"disposal_facility": "Company A",
"Shipment_Number": 38483
},
{
"id": 638809,
"manifest_number": "33333",
"disposal_facility": "Company B",
"Shipment_Number": 38483
},
{
"id": 638727,
"manifest_number": "44444",
"disposal_facility": "Company C",
"Shipment_Number": 38483
}
]
}
}