Back to top

Orders APIs Documentation

Overview

The Orders API is used to manage orders in the WasteLinq system. It provides endpoints to retrieve the details of orders, get general information, additional information, waste lines, product/service lines, applied tax, applied fee, available forms, disposal facilities, order status, and transportation schedule. These are RESTful APIs and use standard HTTP methods like GET, POST, PUT, and DELETE.

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 with your actual bearer token.

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.

Orders

orders

orders
GET/api/orders/esc/

Overview:

The orders endpoint, accessible at /api/orders/esc/, is a GET request that is used to retrieve the details of orders.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
totalElements number The total number of elements.
content array An array of objects containing the details of the orders.
id number The unique identifier for the order.
Order_Number number The order number.
Manifests string The manifests.
Customer_Name string The name of the customer.
schedule_date string The schedule date.
Modifier string The modifier.
Order_Name string The name of the order.
Order_type string The type of the order.
Order_Logistics_Status string The logistics status of the order.
Customer_PO_Number string The customer PO number.
total_amount number The total amount.
total_invoice_amount number The total invoice amount.
order_contact_name string The name of the order contact.
Customer number The customer number.
network_enterprise_field string The network enterprise field.
Date_Created string The date the order was created.
sub_orders array An array of sub-orders.
id number The unique identifier for the sub-order.
Full_Sub_Order_Number string The full sub-order number.
schedule_date string The schedule date.
schedule_time string The schedule time.
sub_order_status string The status of the sub-order.
tsdf_name string The name of the TSDF.
is_network boolean Indicates whether the sub-order is part of the network.
Being_Accessed boolean Indicates whether the order is being accessed.
Accessing_User_id number The unique identifier for the accessing user.
Accessing_User string The name of the accessing user.
recurrenceState number The recurrence state.
extra_content array An array of extra content.
override_system_lock boolean Indicates whether the system lock should be overridden.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/orders/esc/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "totalElements": 14698,
  "content": [
    {
      "id": 577696,
      "Order_Number": 616965,
      "Manifests": "222222",
      "Customer_Name": "Company ABC",
      "schedule_date": "08-06-2024 12:00 AM",
      "Modifier": "janedoe@wastelinq.com",
      "Order_Name": "BLAST MEDIA DUST - 353922 - 162515",
      "Order_type": "Waste",
      "Order_Logistics_Status": "Order Scheduled",
      "Customer_PO_Number": "",
      "total_amount": 1796.03,
      "total_invoice_amount": 0,
      "order_contact_name": "Jane Doe",
      "Customer": 40629,
      "network_enterprise_field": "Network",
      "Date_Created": "08/05/2024",
      "sub_orders": [
        {
          "id": 517543,
          "Full_Sub_Order_Number": "616965-01",
          "schedule_date": "08/06/2024",
          "schedule_time": "12:00 AM",
          "sub_order_status": "Order Scheduled",
          "tsdf_name": "Company ABC",
          "is_network": true
        },
        {
          "id": 517544,
          "Full_Sub_Order_Number": "616965-02",
          "schedule_date": "08/06/2024",
          "schedule_time": "12:00 AM",
          "sub_order_status": "Order Scheduled",
          "tsdf_name": null,
          "is_network": false
        }
      ],
      "Being_Accessed": false,
      "Accessing_User_id": null,
      "Accessing_User": null,
      "recurrenceState": 0
    }
  ],
  "extra_content": {
    "override_system_lock": true
  }
}

get_general_info

get_general_info
GET/api/generators/orders/{order_id}/get_general_info

Overview:

The get_general_info endpoint, accessible at /api/generators/orders/{order_id}/get_general_info, is a GET request that is used to retrieve the general information of an order.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the general information of the order.
esc_order_number string The ESC order number.
suborder_order_number string The sub-order number.
sub_order_view string The view of the sub-order.
date_created string The date the order was created.
updated_by string The user who updated the order.
order_type number The type of the order.
order_source number The source of the order.
order_logistics_status number The logistics status of the order.
first_network_order_logistics_status string The first network order logistics status.
pick_up_date string The pick-up date.
schedule_date_time string The schedule date and time.
invoice_date string The invoice date.
in_slot_date string The in-slot date.
in_slot_time string The in-slot time.
work_order string The work order.
tsdf_signed_date string The TSDF signed date.
order_contact string The order contact.
order_contact_name string The name of the order contact.
customer_po_number string The customer PO number.
project string The project.
phase string The phase.
order_name string The name of the order.
generator_pickup_requested_date string The generator pick-up requested date.
freight_Status string The freight status.
tsdf_in_slot_status string The TSDF in-slot status.
assigned_to string The user the order is assigned to.
conf_date_time string The confirmation date and time.
delay_reason string The delay reason.
integ_sync_status string The integration sync status.
integ_sync_reference string The integration sync reference.
cancel_reason string The cancel reason.
custom_fields object An object containing the custom fields.
has_Recurrence number Indicates whether the order has a recurrence.
is_archived boolean Indicates whether the order is archived.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/order_id/get_general_info
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "esc_order_number": "",
    "suborder_order_number": "616965",
    "sub_order_view": "parent",
    "date_created": "08/05/2024",
    "updated_by": "Jane Doe",
    "order_type": 187,
    "order_source": 79,
    "order_logistics_status": 138,
    "first_network_order_logistics_status": "",
    "pick_up_date": "2024-08-05",
    "schedule_date_time": "08/06/2024 12:00 AM",
    "invoice_date": "",
    "in_slot_date": "",
    "in_slot_time": null,
    "work_order": null,
    "tsdf_signed_date": "",
    "order_contact": "20329",
    "order_contact_name": "Jane Doe",
    "customer_po_number": "",
    "project": "",
    "phase": "",
    "order_name": "BLAST MEDIA DUST - 353922 - 162515",
    "generator_pickup_requested_date": null,
    "freight_Status": null,
    "tsdf_in_slot_status": null,
    "assigned_to": null,
    "conf_date_time": "",
    "delay_reason": null,
    "integ_sync_status": "Posted by Jane Doe 08/07/2024 09:35 PM",
    "integ_sync_reference": "616965",
    "cancel_reason": "",
    "custom_fields": {},
    "has_Recurrence": 0,
    "is_archived": false
  }
}

get_wasteline_add_infos

get_wasteline_add_infos
GET/api/generators/orders/{order_id}/get_wasteline_add_infos

Overview:

The get_wasteline_add_infos endpoint, accessible at /api/generators/orders/{order_id}/get_wasteline_add_infos, is a GET request that is used to retrieve the additional information of an order.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the additional information of the order.
shipment_request_id number The unique identifier for the shipment request.
check_FKOrder_doc boolean Indicates whether the FKOrder document should be checked.
display_logistics_type_button array An array of booleans indicating whether the logistics type button should be displayed.
disable_logistics_type_button_with_no_line array An array of booleans indicating whether the logistics type button should be disabled with no line.
order_logistics_status number The logistics status of the order.
order_logistics_status_statcode string The logistics status statcode.
messages array An array of messages.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/order_id/get_wasteline_add_infos
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "shipment_request_id": null,
    "check_FKOrder_doc": true,
    "display_logistics_type_button": [
      true
    ],
    "disable_logistics_type_button_with_no_line": [
      false
    ],
    "order_logistics_status": 138,
    "order_logistics_status_statcode": "2",
    "messages": [
      "Credit Line has exceeded."
    ]
  }
}

get_waste_lines

get_waste_lines
GET/api/generators/orders/{order_id}/get_waste_lines

Overview:

The get_waste_lines endpoint, accessible at /api/generators/orders/{generator_id}/get_waste_lines, is a GET request that is used to retrieve the waste lines of an order.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the details of the waste lines.
id number The unique identifier for the waste line.
status string The status of the waste line.
minPrice string The minimum price.
apply_current_price boolean Indicates whether the current price should be applied.
UseSubLine boolean Indicates whether the sub-line should be used.
enteredActualWeight boolean Indicates whether the actual weight was entered.
unit_billing_weight_volume_count number The unit billing weight volume count.
isSpecialHandlingRestrictionsWMP string Indicates whether there are special handling restrictions.
specialHandlingRestrictionsWMPContent string The content of the special handling restrictions.
profileNumber number The profile number.
profileName string The name of the profile.
prodetail_cnt_id number The unique identifier for the profile detail.
specificGravity string The specific gravity.
isProfilExpired boolean Indicates whether the profile has expired.
approvalNumber string The approval number.
disposalSite string The disposal site.
disposalSiteId number The unique identifier for the disposal site.
WPC string The WPC.
empty_container boolean Indicates whether the container is empty.
vendorCode string The vendor code.
Mainfest_Number string The manifest number.
Line_Number string The line number.
containerType string The container type.
containerSize string The container size.
containerSizeWeight number The container size weight.
Container_Count number The container count.
Converted_Value number The converted value.
Container_Unit string The container unit.
shippingUnitOptions array An array of shipping unit options.
id string The unique identifier for the shipping unit option.
name string The name of the shipping unit option.
Total_Volume number The total volume.
Total_Weight number The total weight.
VUnit string The volume unit.
WUnit string The weight unit.
billing_weight_volume_count number The billing weight volume count.
line_total_using_min_price boolean Indicates whether the line total should be calculated using the minimum price.
CostBasis_id number The unique identifier for the cost basis.
billingBasis string The billing basis.
showingBillingBasis string The billing basis to show.
Price number The price.
profile_billing_price string The profile billing price.
Line_total number The line total.
Line_Status string The status of the line.
lineStatusOptions array An array of line status options.
location number The location.
facilityOptions array An array of facility options.
id number The unique identifier for the facility option.
Name string The name of the facility option.
current_rcra_code array An array of current RCRA codes.
current_state_waste_code array An array of current state waste codes.
current_state_rcra_code string The current state RCRA code.
state_waste_code object An object containing the state waste codes.
state_rcra_code object An object containing the state RCRA codes.
default_state_waste_code_dic object An object containing the default state waste codes.
default_state_waste_code_rcra_dic object An object containing the default state waste RCRA codes.
stateRCRACode string The state RCRA code.
finalHandlingCode string The final handling code.
handlingCodeOptions array An array of handling code options.
id number The unique identifier for the handling code option.
Name string The name of the handling code option.
Description string The description of the handling code option.
ten_day_start_date string The ten-day start date.
ten_day_start_time string The ten-day start time.
Warehouse string The warehouse.
warehouseOptions object An object containing the warehouse options.
id array An array of warehouse options.
Name string The name of the warehouse option.
networkStatus string The network status.
logisticsType string The logistics type.
suborderNumber string The sub-order number.
networkFreightScheduledDate string The network freight scheduled date.
TSDFWorkOrderNumber string The TSDF work order number.
genSignedDate string The generator signed date.
TSDFSignedDate string The TSDF signed date.
paperworkRequested string The paperwork requested.
Sales_Tax boolean Indicates whether sales tax is applicable.
Note string The note.
using_emanifest boolean Indicates whether the e-manifest is being used.
inbound_mmp_id string The inbound MMP identifier.
balance_detail_id string The balance detail identifier.
inbound_containers string The inbound containers.
final_handling_code number The final handling code.
rcra_code array An array of RCRA codes.
is_from_labpack_profile boolean Indicates whether the profile is from a lab pack.
deletable boolean Indicates whether the waste line is deletable.
childs array An array of child waste lines.
is_edit boolean Indicates whether the waste line is editable.
transporter string The transporter.
mmc string The MMC.
is_manifest_in_outbount_shipment boolean Indicates whether the manifest is in the outbound shipment.
order_addinfo object An object containing the additional information of the order.
shipment_request_id number The unique identifier for the shipment request.
check_FKOrder_doc boolean Indicates whether the FKOrder document should be checked.
display_logistics_type_button array An array of booleans indicating whether the logistics type button should be displayed.
disable_logistics_type_button_with_no_line array An array of booleans indicating whether the logistics type button should be disabled with no line.
order_logistics_status number The logistics status of the order.
order_logistics_status_statcode string The logistics status statcode.
messages array An array of messages.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/order_id/get_waste_lines
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 1324418,
      "status": "0",
      "minPrice": "0",
      "apply_current_price": false,
      "UseSubLine": false,
      "enteredActualWeight": true,
      "unit_billing_weight_volume_count": 1,
      "isSpecialHandlingRestrictionsWMP": null,
      "specialHandlingRestrictionsWMPContent": null,
      "profileNumber": 170125,
      "profileName": "Blast Media Dust",
      "prodetail_cnt_id": 527760,
      "specificGravity": "1",
      "isProfilExpired": false,
      "approvalNumber": "0760 23 2238",
      "disposalSite": "Company ABC",
      "disposalSiteId": 11874,
      "WPC": "7603",
      "empty_container": false,
      "vendorCode": "None",
      "Mainfest_Number": "22222",
      "Line_Number": "1",
      "containerType": "DM",
      "containerSize": "55 (G)",
      "containerSizeWeight": 44,
      "Container_Count": 10,
      "Converted_Value": 5027,
      "Container_Unit": "P",
      "shippingUnitOptions": [
        {
          "id": "M",
          "name": "M- Metric Tons"
        },
        {
          "id": "N",
          "name": "N- Cubic Meters"
        }
      ],
      "Total_Volume": 550,
      "Total_Weight": 5027,
      "VUnit": "G",
      "WUnit": "P",
      "billing_weight_volume_count": 10,
      "line_total_using_min_price": false,
      "CostBasis_id": 2,
      "billingBasis": "Per Container",
      "showingBillingBasis": "Per Container",
      "Price": 85,
      "profile_billing_price": "85.00",
      "Line_total": 850,
      "Line_Status": null,
      "lineStatusOptions": [],
      "location": 71,
      "facilityOptions": [
        {
          "id": 70,
          "Name": "Company QWE"
        },
        {
          "id": 71,
          "Name": "Company ERT"
        }
      ],
      "current_rcra_code": [],
      "current_state_waste_code": [
        "10063892"
      ],
      "current_state_rcra_code": "{\"state_code\": \"[\\\"10063892\\\"]\", \"rcra_code\": \"\"}",
      "state_waste_code": {
        "10063892": "10063892"
      },
      "state_rcra_code": {},
      "default_state_waste_code_dic": {
        "10063892": "10063892"
      },
      "default_state_waste_code_rcra_dic": {},
      "stateRCRACode": "",
      "finalHandlingCode": "H010",
      "handlingCodeOptions": [
        {
          "id": 1,
          "Name": "H010",
          "Description": "METALS RECOVERY"
        }
      ],
      "ten_day_start_date": "",
      "ten_day_start_time": null,
      "Warehouse": null,
      "warehouseOptions": {
        "70": [
          {
            "id": 44,
            "Name": "Company ABC"
          }
        ],
        "71": [
          {
            "id": 45,
            "Name": "Company ERT"
          }
        ]
      },
      "networkStatus": "Submitted",
      "logisticsType": "No Scheduling Needed",
      "suborderNumber": "616965-01",
      "networkFreightScheduledDate": "",
      "TSDFWorkOrderNumber": "",
      "genSignedDate": "",
      "TSDFSignedDate": "",
      "paperworkRequested": "No",
      "Sales_Tax": false,
      "Note": null,
      "using_emanifest": false,
      "inbound_mmp_id": null,
      "balance_detail_id": null,
      "inbound_containers": null,
      "final_handling_code": 16,
      "rcra_code": [],
      "is_from_labpack_profile": false,
      "deletable": false,
      "childs": [],
      "is_edit": true,
      "transporter": "",
      "mmc": "",
      "is_manifest_in_outbount_shipment": false
    }
  ],
  "order_addinfo": {
    "shipment_request_id": null,
    "check_FKOrder_doc": true,
    "display_logistics_type_button": [
      true
    ],
    "disable_logistics_type_button_with_no_line": [
      false
    ],
    "order_logistics_status": 138,
    "order_logistics_status_statcode": "2",
    "messages": [
      "Credit Line has exceeded."
    ]
  }
}

get_product_service_lines

get_product_service_lines
GET/api/generators/orders/{order_id}/get_product_service_lines

Overview:

The get_product_service_lines endpoint, accessible at /api/generators/orders/{order_id}/get_product_service_lines, is a GET request that is used to retrieve the product/service lines of an order.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the details of the product/service lines.
id number The unique identifier for the product/service line.
status string The status of the product/service line.
Description string The description.
Warehouse string The warehouse.
Line_Number string The line number.
Product_Service_id number The unique identifier for the product/service.
Product_Service string The product/service.
Product_Type string The type of the product.
Quanity number The quantity.
Unit_Price number The unit price.
Unit_Cost number The unit cost.
Each string The unit.
Line_Total number The line total.
Sales_Tax boolean Indicates whether sales tax is applicable.
Inv string The invoice.
suborderNumber string The sub-order number.
warehouseOptions array An array of warehouse options.
id number The unique identifier for the warehouse option.
Name string The name of the warehouse option.
prodserv_FS number The unique identifier for the product/service.
isfs boolean Indicates whether the product/service is FS.
iseis boolean Indicates whether the product/service is EIS.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/order_id/get_product_service_lines
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 1530896,
      "status": "0",
      "Description": "TRANSPORTATION - Bulk per Hour",
      "Warehouse": null,
      "Line_Number": "1",
      "Product_Service_id": 4163,
      "Product_Service": "860",
      "Product_Type": "Transportation",
      "Quanity": 4,
      "Unit_Price": 120,
      "Unit_Cost": 0,
      "Each": "Per Hour",
      "Line_Total": 480,
      "Sales_Tax": false,
      "Inv": "No",
      "suborderNumber": "616965-02",
      "warehouseOptions": [
        {
          "id": 45,
          "Name": "Company ABC"
        }
      ],
      "prodserv_FS": 4167,
      "isfs": false,
      "iseis": false
    }
  ]
}

get_order_applied_tax

get_order_applied_tax
GET/api/generators/orders/{order_id}/get_order_applied_tax

Overview:

The get_order_applied_tax endpoint, accessible at /api/generators/orders/{order_id}/get_order_applied_tax, is a GET request that is used to retrieve the applied tax of an order.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the details of the applied tax.
id number The unique identifier for the applied tax.
taxVheader string The tax header.
Applied_Sales_Tax_Exempt boolean Indicates whether sales tax is exempt.
Applied_Tax_ID string The tax identifier.
Applied_Sales_Tax_Rate string The sales tax rate.
Amount number The amount.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/order_id/get_order_applied_tax
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 312215125,
      "taxVheader": "Sales Tax",
      "Applied_Sales_Tax_Exempt": false,
      "Applied_Tax_ID": "",
      "Applied_Sales_Tax_Rate": "8.25",
      "Amount": 14.03
    }
  ]
}

get_order_applied_fee

get_order_applied_fee
GET/api/generators/orders/{order_id}/get_order_applied_fee

Overview:

The get_order_applied_fee endpoint, accessible at /api/generators/orders/{order_id}/get_order_applied_fee, is a GET request that is used to retrieve the applied fee of an order.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the details of the applied fee.
id number The unique identifier for the applied fee.
Fee_id number The unique identifier for the fee.
Name string The name of the fee.
Type string The type of the fee.
Value string The value of the fee.
Apply string The application of the fee.
Amount number The amount.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/order_id/get_order_applied_fee
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 214975,
      "Fee_id": 31677,
      "Name": "EIS ",
      "Type": "Rate",
      "Value": "14",
      "Apply": "Waste Material",
      "Amount": 142.8
    }
  ]
}

get_order_avail_forms

get_order_avail_forms
GET/api/generators/orders/get_order_avail_forms

Overview:

The get_order_avail_forms endpoint, accessible at /api/generators/orders/get_order_avail_forms, is a GET request that is used to retrieve the available forms for an order.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the available forms for the order.
show_print_type boolean Indicates whether the print type should be shown.
order_avail_forms array An array of available forms.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/get_order_avail_forms
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "show_print_type": false,
    "order_avail_forms": [
      "Texas Scrap Tire Manifest",
      "GEC NH",
      "Land Ban",
      "Manifest",
      "Driver Work Order",
      "GEC Universal",
      "Straight Bill of Lading",
      "Driver Route Check-In Sheet",
      "Order Summary",
      "Uniform Hazardous Waste Manifest",
      "Order Worksheet",
      "Thermal Order Label",
      "Thermal Accumulation Label",
      "Order Confirmation",
      "Bill of Lading - Multi-Part Form",
      "Non Hazardous Waste Manifest",
      "WM Non Haz",
      "Driver Sheet"
    ]
  }
}

get_disposal_facilities_array

get_disposal_facilities_array
GET/api/generators/orders/get_disposal_facilities_array/{order_id}

Overview:

The get_disposal_facilities_array endpoint, accessible at /api/generators/orders/get_disposal_facilities_array/{order_id}, is a GET request that is used to retrieve the disposal facilities for an order.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of disposal facilities.
value string The value.
valid_code string The valid code.
print_types array An array of print types.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/get_disposal_facilities_array/order_id
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "value": "222222",
      "valid_code": "",
      "print_types": []
    }
  ]
}

get_order_status

get_order_status
GET/api/generators/orders/{order_id}/get_order_status

Overview:

The get_order_status endpoint, accessible at /api/generators/orders/{order_id}/get_order_status, is a GET request that is used to retrieve the status of an order.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the status of the order.
is_archived boolean Indicates whether the order is archived.
Inv_Rev_Req boolean Indicates whether the invoice review request is applicable.
Order_Confirmed boolean Indicates whether the order is confirmed.
Conf_Date_Time string The confirmation date and time.
Cash_On_Delivery boolean Indicates whether cash on delivery is applicable.
Bill_Disposal_Facility boolean Indicates whether the disposal facility should be billed.
Paperwork boolean Indicates whether paperwork is applicable.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/order_id/get_order_status
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "is_archived": false,
    "Inv_Rev_Req": false,
    "Order_Confirmed": false,
    "Conf_Date_Time": "",
    "Cash_On_Delivery": false,
    "Bill_Disposal_Facility": false,
    "Paperwork": false
  }
}

get_transportation_schedule

get_transportation_schedule
GET/api/generators/orders/{order_id}/get_transportation_schedule/

Overview:

The get_transportation_schedule endpoint, accessible at /api/generators/orders/{order_id}/get_transportation_schedule/, is a GET request that is used to retrieve the transportation schedule of an order.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the transportation schedule of the order.
PK_Address1 string The address line 1.
PK_Address2 string The address line 2.
PK_City string The city.
PK_State string The state.
PK_Zone string The zone.
PK_Zone_id number The unique identifier for the zone.
zip string The zip code.
OutsideUSA boolean Indicates whether the address is outside the USA.
ForeignerAddress string The foreign address.
TS_Pick_Up_Date string The pick-up date.
TS_Pick_Up_Time string The pick-up time.
Pick_Up_Run_End_Date string The pick-up run end date.
PUP_Time_In string The pick-up time in.
PUP_Time_Out string The pick-up time out.
PUP_Stop_Time string The pick-up stop time.
DEL_Time_In string The delivery time in.
DEL_Time_Out string The delivery time out.
DEL_Stop_Time string The delivery stop time.
PTL_Time_Dpt_1 string The departure time for the first part load.
PTL_Time_Ret_1 string The return time for the first part load.
PTLToPTLHr_1 string The time between the first part load.
PTL_Time_Dpt_2 string The departure time for the second part load.
PTL_Time_Ret_2 string The return time for the second part load.
PTLToPTLHr_2 string The time between the second part load.
transportation array An array of transportation details.
id number The unique identifier for the transportation.
status string The status of the transportation.
transporter string The transporter.
transporter_type string The type of the transporter.
driver_thrid_party_id number The unique identifier for the driver.
truck_id string The truck identifier.
truck_vendor_id string The truck vendor identifier.
truck_vendor_name string The truck vendor name.
trailer_id string The trailer identifier.
trailer_vendor_id string The trailer vendor identifier.
trailer_vendor_name string The trailer vendor name.
truck_trailer string The truck trailer.
vendor_id string The vendor identifier.
transporter_signed_date string The signed date of the transporter.
pk_zone_zip string The zip code of the zone.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/order_id/get_transportation_schedule/
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "PK_Address1": "132, My Street, Kingston, New York 12401.",
    "PK_Address2": "132, My Street, Kingston, New York 12401.",
    "PK_City": "Kingston",
    "PK_State": "NY",
    "PK_Zone": "Zone 1",
    "PK_Zone_id": 1,
    "zip": "76180",
    "OutsideUSA": false,
    "ForeignerAddress": null,
    "TS_Pick_Up_Date": "08/08/2024",
    "TS_Pick_Up_Time": "12:00 AM",
    "Pick_Up_Run_End_Date": "",
    "PUP_Time_In": "",
    "PUP_Time_Out": "",
    "PUP_Stop_Time": "",
    "DEL_Time_In": "",
    "DEL_Time_Out": "",
    "DEL_Stop_Time": "",
    "PTL_Time_Dpt_1": "",
    "PTL_Time_Ret_1": "",
    "PTLToPTLHr_1": "",
    "PTL_Time_Dpt_2": "",
    "PTL_Time_Ret_2": "",
    "PTLToPTLHr_2": "",
    "transportation": [
      {
        "id": 1596375,
        "status": "0",
        "transporter": "Transporter 1",
        "transporter_type": "driver",
        "driver_thrid_party_id": 537,
        "truck_id": null,
        "truck_vendor_id": "",
        "truck_vendor_name": "",
        "trailer_id": null,
        "trailer_vendor_id": "",
        "trailer_vendor_name": "",
        "truck_trailer": "",
        "vendor_id": null,
        "transporter_signed_date": null
      }
    ],
    "pk_zone_zip": "76180"
  }
}

get_sub_orders

get_sub_orders
GET/api/generators/orders/{order_id}/get_sub_orders/

Overview:

The get_sub_orders endpoint, accessible at /api/generators/orders/{order_id}/get_sub_orders/, is a GET request that is used to retrieve the sub-orders of an order.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the details of the sub-orders.
page_view string The page view.
id number The unique identifier for the sub-order.
solist_id number The unique identifier for the solist.
id number The unique identifier for the solist.
label string The label of the solist.
sub_order_status string The status of the sub-order.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/order_id/get_sub_orders/
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "page_view": "parent",
    "id": 517553,
    "solist": [
      {
        "id": 517553,
        "label": "Company A"
      },
      {
        "id": 517554,
        "label": "616976-02 - [Products/Services]  - Enterprise"
      }
    ],
    "sub_order_status": "Order Scheduled"
  }
}

get_order_note

get_order_note
GET/api/generators/orders/{order_id}/get_order_note/

Overview:

The get_order_note endpoint, accessible at /api/generators/orders/{order_id}/get_order_note/, is a GET request that is used to retrieve the notes of an order.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the notes of the order.
Pickup_Instr_For_Driver string The pick-up instructions for the driver.
Internal_Notes string The internal notes.
Inv_Cmt_For_Cust string The invoice comment for the customer
Trans_Notes string The transportation notes.
Sec_14_per_15_Mainf_Cmt string The section 14 per 15 mainfest comment.
section32 array An array of section 32 comments.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/order_id/get_order_note/
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "Pickup_Instr_For_Driver": null,
    "Internal_Notes": null,
    "Inv_Cmt_For_Cust": null,
    "Trans_Notes": null,
    "Sec_14_per_15_Mainf_Cmt": "-",
    "section32": []
  }
}

weight_grade_distribute_options

weight_grade_distribute_options
GET/api/generators/orders/{order_id}/weight_grade_distribute_options

Overview:

The weight_grade_distribute_options endpoint, accessible at /api/generators/orders/{order_id}/weight_grade_distribute_options, is a GET request that is used to retrieve the weight grade distribution options of an order.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
manifest_whole list The list of manifest whole.
id number The unique identifier for the manifest.
wmc_id number The unique identifier for the WMC.
value string The value.
wpc string The WPC.
wpc_id number The unique identifier for the WPC.
profile_id number The unique identifier for the profile.
wpcs array An array of WPCs.
mmps array An array of MMPs.
grades array An array of grades.
manifest_line list The list of manifest lines.
id number The unique identifier for the manifest.
wmc_id number The unique identifier for the WMC.
value string The value.
manifest_no string The manifest number.
line string The line number.
wpc string The WPC.
wpc_id number The unique identifier for the WPC.
profile_id number The unique identifier for the profile.
wpcs array An array of WPCs.
mmps array An array of MMPs.
grades array An array of grades.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/order_id/weight_grade_distribute_options
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "manifest_whole": [
    {
      "id": 1324432,
      "wmc_id": 1324432,
      "value": "22222",
      "wpc": "6104",
      "wpc_id": 3944,
      "profile_id": 311239,
      "wpcs": [],
      "mmps": [],
      "grades": []
    }
  ],
  "manifest_line": [
    {
      "id": 1324432,
      "wmc_id": 1324432,
      "value": "22222-1",
      "manifest_no": "22222",
      "line": "1",
      "wpc": "6104",
      "wpc_id": 3944,
      "profile_id": 311239,
      "wpcs": [],
      "mmps": [],
      "grades": []
    }
  ]
}

get_weight_grade_lines

get_weight_grade_lines
GET/api/generators/orders/{order_id}/get_weight_grade_lines

Overview:

The get_weight_grade_lines endpoint, accessible at /api/generators/orders/{order_id}/get_weight_grade_lines, is a GET request that is used to retrieve the weight grade lines of an order.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the details of the weight grade lines.
id number The unique identifier for the weight grade line.
status string The status of the weight grade line.
manifest_no string The manifest number.
line string The line number.
edited_weight boolean Indicates whether the weight was edited.
pkid number The unique identifier for the PK.
processing_detail_content_id number The unique identifier for the processing detail content.
orderNumber string The order number.
WPC string The WPC.
re_class string The re-class.
profileName string The name of the profile.
mmp_assignment_showingname string The MMP assignment showing name.
mmp_assignment string The MMP assignment.
mmp_assignmentOptions array An array of MMP assignment options.
id number The unique identifier for the MMP assignment option.
Name string The name of the MMP assignment option.
mmp_approved boolean Indicates whether the MMP is approved.
containerType string The container type.
containerSize string The container size.
cnt_id_no string The container identifier number.
weight number The weight.
showingBillingBasis string The billing basis to show.
piece_count string The piece count.
actual_weight string The actual weight.
net_explosive_weight string The net explosive weight.
Grade string The grade.
scanComments string The scan comments.
inboundScanDate string The inbound scan date.
mmps array An array of MMPs.
addinfo object An object containing the additional information of the order.
order_number string The order number.
pickupdate string The pick-up date.
customername string The customer name.
truck string The truck.
is_archived boolean Indicates whether the order is archived.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/order_id/get_weight_grade_lines
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 3092446,
      "status": "0",
      "manifest_no": "222222",
      "line": "1",
      "edited_weight": false,
      "pkid": 1324432,
      "processing_detail_content_id": 592107,
      "orderNumber": "616976",
      "WPC": "6104",
      "re_class": "",
      "profileName": "New Profile #212701",
      "mmp_assignment_showingname": null,
      "mmp_assignment": null,
      "mmp_assignmentOptions": [
        {
          "id": 44,
          "Name": "Company ABC"
        }
      ],
      "mmp_approved": false,
      "containerType": "CF",
      "containerSize": "202",
      "cnt_id_no": "22222-1-1",
      "weight": 1,
      "showingBillingBasis": "Per Container",
      "piece_count": null,
      "actual_weight": null,
      "net_explosive_weight": null,
      "Grade": null,
      "scanComments": "",
      "inboundScanDate": "",
      "mmps": []
    }
  ],
  "addinfo": {
    "order_number": "616976",
    "pickupdate": "08/08/2024",
    "customername": "Company ABC",
    "truck": "",
    "is_archived": false
  }
}

orders_outbound

orders_outbound
GET/api/generators/orders/outbound/{order_id}/{?page,pageSize,filter}

Overview:

The orders_outbound endpoint, accessible at /api/generators/orders/outbound/{order_id}/{?page,pageSize,filter}, is a GET request that is used to retrieve the outbound orders of an order.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the details of the outbound orders.
id number The unique identifier for the outbound order.
orderNumber string The order number.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/outbound/order_id/?page=&pageSize=&filter=
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

page
number (optional) 

The page number.

pageSize
number (optional) 

The page size.

filter
string (optional) 

The filter.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [],
  "id": 577707,
  "totalElements": 0
}

get_project_cost_category

get_project_cost_category
GET/api/generators/orders/get_project_cost_category/

Overview:

The get_project_cost_category endpoint, accessible at /api/generators/orders/get_project_cost_category/, is a GET request that is used to retrieve the project cost categories.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the project cost categories.
id number The unique identifier for the project cost category.
Name string The name of the project cost category.
Broker number The unique identifier for the broker.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/get_project_cost_category/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 220,
      "Name": "Disposal",
      "Broker": 31
    },
    {
      "id": 221,
      "Name": "Transportation",
      "Broker": 31
    },
    {
      "id": 229,
      "Name": "Taxes & Fees",
      "Broker": 31
    },
    {
      "id": 222,
      "Name": "Products & Services",
      "Broker": 31
    }
  ],
  "totalElements": 4
}

get_material_list

get_material_list
GET/api/generators/orders/get_material_list/{order_id}/

Overview:

The get_material_list endpoint, accessible at /api/generators/orders/get_material_list/{order_id}/, is a GET request that is used to retrieve the material list of an order.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the material list of the order.
material_service_list array An array of material services.
list array An array of material services.
id string The unique identifier for the material service.
id_element number The unique identifier for the element.
type string The type of the material service.
quantity number The quantity.
unitprice string The unit price.
tsdf number The TSDF.
tsdf_name string The TSDF name.
costbasis string The cost basis.
costbasis_name string The cost basis name.
Mainfest_Number string The manifest number.
Line_Number string The line number.
label string The label.
primary_vendor string The primary vendor.
cost_category_name string The cost category name.
cost_category_id number The unique identifier for the cost category.
totalElements number The total elements.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/get_material_list/order_id/
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "material_service_list": [
      {
        "list": [
          {
            "id": "1-1324432",
            "id_element": 1324432,
            "type": "1-",
            "quantity": 1,
            "unitprice": "30.00",
            "tsdf": 12162,
            "tsdf_name": "Company ABC",
            "costbasis": "Per Container",
            "costbasis_name": "Per Container",
            "Mainfest_Number": "22222",
            "Line_Number": "1",
            "label": "Manifest # : 22222 - Line # : 1"
          }
        ],
        "label": "Waste Material Pick-Up",
        "type": "1-"
      },
      {
        "list": [],
        "label": "Products & Services",
        "type": "3-"
      },
      {
        "list": [
          {
            "id": "2-1530901",
            "id_element": 1530901,
            "type": "2-",
            "quantity": 1,
            "unitprice": "{'3191': '10'}",
            "primary_vendor": "{'id': 841, 'name': 'Company ABC', 'vendor_id': 3191, 'price': '10'}",
            "cost_category_name": "Transportation",
            "cost_category_id": 221,
            "tsdf": 0,
            "costbasis": 0,
            "label": "814 - Transportation - TRANSPORTATION - 10gl Cont"
          }
        ],
        "label": "Products & Services",
        "type": "2-"
      }
    ]
  },
  "totalElements": 3
}

get_project_cost

get_project_cost
GET/api/generators/orders/get_project_cost/{order_id}/

Overview:

The get_project_cost endpoint, accessible at /api/generators/orders/get_project_cost/{order_id}/, is a GET request that is used to retrieve the project cost of an order.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the project cost of the order.
data array An array of data.
file_data array An array of file data.
totalElements number The total elements.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/get_project_cost/order_id/
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "data": [],
    "file_data": []
  },
  "totalElements": 0
}

orders_invoice

orders_invoice
GET/api/generators/orders/invoice/{order_id}/

Overview:

The invoice endpoint, accessible at /api/generators/orders/invoice/{order_id}/, is a GET request that is used to retrieve the invoice of an order.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the invoice of the order.
full_invoice string The full invoice.
invoice_comments_for_customer string The invoice comments for the customer.
invoicing_protocol string The invoicing protocol.
extend_buttons object An object containing the extend buttons.
quickbook_user string The QuickBooks user.
btn_pay_credit_card boolean Indicates whether the credit card payment button is applicable.
btn_save_netsuite boolean Indicates whether the NetSuite save button is applicable.
btn_save_acumatica boolean Indicates whether the Acumatica save button is applicable.
btn_save_quickbooks boolean Indicates whether the QuickBooks save button is applicable.
btn_update_invoice_acumatica boolean Indicates whether the Acumatica update invoice button is applicable.
btn_update_invoice_quickbooks boolean Indicates whether the QuickBooks update invoice button is applicable.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/invoice/order_id/
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "fully_invoiced": false,
    "invoice_comments_for_customer": null,
    "invoicing_protocol": "make sure you have a reference number to reference",
    "extend_buttons": {
      "quickbook_user": "company_admin",
      "btn_pay_credit_card": false,
      "btn_save_netsuite": false,
      "btn_save_acumatica": true,
      "btn_save_quickbooks": false,
      "btn_update_invoice_acumatica": true,
      "btn_update_invoice_quickbooks": false
    }
  }
}

get_orderinvoices

get_orderinvoices
GET/api/accounting/get_orderinvoices/{order_id}/

Overview:

The get_orderinvoices endpoint, accessible at /api/accounting/get_orderinvoices/{order_id}/, is a GET request that is used to retrieve the order invoices of an order.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
order_status string The status of the order.
content array An array of objects containing the details of the order invoices.
totalElements number The total elements.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/accounting/get_orderinvoices/order_id/
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "order_status": 146,
  "content": [],
  "totalElements": 0
}

recurrence

recurrence
GET/api/generators/orders/recurrence/{order_id}/

Overview:

The recurrence endpoint, accessible at /api/generators/orders/recurrence/{order_id}/, is a GET request that is used to retrieve the recurrence of an order.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the recurrence of the order.
Name string The name of the recurrence.
Frequency string The frequency of the recurrence.
Daily_Type string The daily type of the recurrence.
Daily_Interval number The daily interval of the recurrence.
Weekly_Interval number The weekly interval of the recurrence.
Weekly_DaysOfWeek array An array of the days of the week.
Monthly_Type string The monthly type of the recurrence.
Monthly_DayInMonth number The day in the month of the recurrence.
Monthly_Interval number The monthly interval of the recurrence.
Monthly_Order string The monthly order of the recurrence.
Monthly_DaysOfWeek string The days of the week of the recurrence.
Monthly_Interval_1 number The monthly interval 1 of the recurrence.
Yearly_Interval number The yearly interval of the recurrence.
Yearly_Type string The yearly type of the recurrence.
Yearly_Month string The yearly month of the recurrence.
Yearly_DayInMonth number The yearly day in the month of the recurrence.
Yearly_Order string The yearly order of the recurrence.
Yearly_DaysOfWeek string The days of the week of the recurrence.
Yearly_Month_1 string The yearly month 1 of the recurrence.
StartDate string The start date of the recurrence.
EndType string The end type of the recurrence.
End_Interval number The end interval of the recurrence.
End_Date string The end date of the recurrence.
IsAutofillOrder boolean Indicates whether the order is autofilled.
extra_content object An object containing the extra content of the order.
order_id string The unique identifier for the order.
isAcounting boolean Indicates whether the order is accounting.
is_archived boolean Indicates whether the order is archived.
is_suborder_originorder__all boolean Indicates whether the order is a sub-order.
after_sub_order boolean Indicates whether the order is after the sub-order.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/recurrence/order_id/
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "Name": "",
    "Frequency": "",
    "Daily_Type": "",
    "Daily_Interval": null,
    "Weekly_Interval": null,
    "Weekly_DaysOfWeek": [],
    "Monthly_Type": "",
    "Monthly_DayInMonth": null,
    "Monthly_Interval": null,
    "Monthly_Order": "",
    "Monthly_DaysOfWeek": "",
    "Monthly_Interval_1": null,
    "Yearly_Interval": null,
    "Yearly_Type": "",
    "Yearly_Month": "",
    "Yearly_DayInMonth": null,
    "Yearly_Order": "",
    "Yearly_DaysOfWeek": "",
    "Yearly_Month_1": "",
    "StartDate": null,
    "EndType": "",
    "End_Interval": null,
    "End_Date": null,
    "IsAutofillOrder": false
  },
  "extra_content": {
    "order_id": "577707",
    "isAcounting": true,
    "is_archived": false,
    "is_suborder_originorder__all": true,
    "after_sub_order": true
  }
}

systeminformation

systeminformation
GET/api/generators/orders/systeminformation/{order_id}/{?page,pageSize,selectedFields,filter}

Overview:

The systeminformation endpoint, accessible at /api/generators/orders/systeminformation/{order_id}/{?page,pageSize,selectedFields,filter,sort}, is a GET request that is used to retrieve the system information of an order.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the system information of the order.
id number The unique identifier for the system information.
Created_Date string The created date.
Creator__Name string The name of the creator.
FieldName string The field name.
OldValue string The old value.
NewValue string The new value.
sub_order_number string The sub-order number.
totalElements number The total elements.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/systeminformation/order_id/?page=&pageSize=&selectedFields=&filter=
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

page
number (optional) 

The page number.

pageSize
number (optional) 

The page size.

selectedFields
string (optional) 

The selected fields.

filter
string (optional) 

The filter.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 5292501,
      "Created_Date": "08/08/2024 03:45 AM",
      "Creator__Name": "Jane Doe",
      "FieldName": "State waste code",
      "OldValue": "",
      "NewValue": "ABZ",
      "sub_order_number": ""
    }
  ],
  "id": 577707,
  "totalElements": 1
}

get_discrepancies

get_discrepancies
GET/api/generators/orders/{order_id}/get_discrepancies/

Overview:

The get_discrepancies endpoint, accessible at /api/generators/orders/{order_id}/get_discrepancies/, is a GET request that is used to retrieve the discrepancies of an order.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the discrepancies of the order.
discrepancies array An array of discrepancies.
manifestNumberList array An array of manifest numbers.
Mainfest_Number string The manifest number.
lineNumberList object An object containing the line number list.
ENT1354432 array An array of line numbers.
Line_Number string The line number.
typeOptions array An array of type options.
key string The key of the type option.
content string The content of the type option.
statusOptions array An array of status options.
key string The key of the status option.
content string The content of the status option.
isArchived boolean Indicates whether the order is archived.
suborder_order_number string The sub-order order number.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/order_id/get_discrepancies/
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "discrepancies": [],
    "manifestNumberList": [
      {
        "Mainfest_Number": "222222"
      }
    ],
    "lineNumberList": {
      "22222": [
        {
          "Line_Number": "1"
        }
      ]
    },
    "typeOptions": [
      {
        "key": "Quantity",
        "content": "Quantity"
      },
      {
        "key": "Waste Type",
        "content": "Waste Type"
      },
      {
        "key": "Partial Rejection",
        "content": "Partial Rejection"
      },
      {
        "key": "Complete Rejection",
        "content": "Complete Rejection"
      },
      {
        "key": "Financial",
        "content": "Financial"
      },
      {
        "key": "Document Type",
        "content": "Document Type"
      }
    ],
    "statusOptions": [
      {
        "key": "In Progress",
        "content": "In Progress"
      },
      {
        "key": "Completed",
        "content": "Completed"
      },
      {
        "key": "Waiting For Customer Approval",
        "content": "Waiting For Customer Approval"
      }
    ],
    "isArchived": false,
    "suborder_order_number": "616976"
  }
}

messages

messages
GET/api/generator/order/messages/{order_id}/

Overview:

The messages endpoint, accessible at /api/generator/order/messages/{order_id}/, is a GET request that is used to retrieve the messages of an order.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the messages of the order.
messages array An array of messages.
tsdfs array An array of TSDFs.
id number The unique identifier for the TSDF.
value string The value.
current_user_is_network boolean Indicates whether the current user is a network.
order_number number The order number.
order_id number The unique identifier for the order.
users array An array of users.
id number The unique identifier for the user.
first_name string The first name of the user.
last_name string The last name of the user.
username string The username of the user.
is_network boolean Indicates whether the user is a network.
files_list array An array of files.
all_links array An array of all links.
is_network_order string The network order.
totalElements number The total elements.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/generator/order/messages/order_id/
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "messages": [],
    "tsdfs": [
      {
        "id": "1324432|12162|22222|Enterprise",
        "value": "22222 - Company ABC"
      }
    ],
    "current_user_is_network": false,
    "order_number": 616976,
    "order_id": 577707,
    "users": [
      {
        "id": 627,
        "first_name": "Jane",
        "last_name": "Doe",
        "username": "janedoe_network",
        "is_network": true
      }
    ],
    "files_list": [],
    "all_links": [],
    "is_network_order": "Enterprise"
  },
  "totalElements": 0
}

comments

comments
GET/api/generator/order/comments/{order_id}/

Overview:

The comments endpoint, accessible at /api/generator/order/comments/{order_id}/, is a GET request that is used to retrieve the comments of an order.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the comments of the order.
comments array An array of comments.
tsdfs array An array of TSDFs.
id number The unique identifier for the TSDF.
value string The value.
current_user_is_network boolean Indicates whether the current user is a network.
order_number number The order number.
totalElements number The total elements.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/generator/order/comments/order_id/
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "comments": [],
    "tsdfs": [
      {
        "id": "1324432|12162|22222|Enterprise",
        "value": "22222 - Company ABC"
      }
    ],
    "current_user_is_network": false,
    "order_number": 616976
  },
  "totalElements": 0
}

get_all_attachments

get_all_attachments
GET/api/generator/order/get_all_attachments/{order_id}/

Overview:

The get_all_attachments endpoint, accessible at /api/generator/order/get_all_attachments/{order_id}/, is a GET request that is used to retrieve all the attachments of an order.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the attachments of the order.
files_list array An array of files.
totalElements number The total elements.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/generator/order/get_all_attachments/order_id/
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "files_list": []
  },
  "totalElements": 0
}

view_listfiles_and_getnode_order_apis

view_listfiles_and_getnode_order_apis
GET/api/generator/order/view_listfiles_and_getnode_order_apis/{order_id}

Overview:

The view_listfiles_and_getnode_order_apis endpoint, accessible at /api/generator/order/view_listfiles_and_getnode_order_apis/{order_id}, is a GET request that is used to view the list of files and get the node order APIs of an order.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the files list and the node order APIs.
id number The unique identifier for the file.
issystem boolean Indicates whether the file is a system file.
showmenu boolean Indicates whether the menu is shown.
readonly boolean Indicates whether the file is read-only.
hidenewfolder string The hidden new folder.
showuploaddiv string The show upload div.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/generator/order/view_listfiles_and_getnode_order_apis/order_id
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "id": "gen_31_2742185_577707",
    "issystem": true,
    "showmenu": true,
    "readonly": false,
    "hidenewfolder": "hidenewfolder",
    "showuploaddiv": "showuploaddiv"
  }
}

get_line_statuses_for_dropdown

get_line_statuses_for_dropdown
GET/api/generators/orders/get_line_statuses_for_dropdown{?fields}

Overview:

The get_line_statuses_for_dropdown endpoint, accessible at /api/generators/orders/get_line_statuses_for_dropdown{?fields}, is a GET request that is used to retrieve the line statuses for the dropdown.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the line statuses for the dropdown.
id number The unique identifier for the line status.
Name string The name of the line status.
StatCode string The status code.
Disabled boolean Indicates whether the line status is disabled.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/get_line_statuses_for_dropdown?fields=
URI Parameters
HideShow
fields
string (optional) 

The fields.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 218,
      "Name": "Direct Bulk/Package Outbound",
      "StatCode": "5",
      "Disabled": false
    },
    {
      "id": 216,
      "Name": "Fully Scheduled Outbound",
      "StatCode": "3",
      "Disabled": true
    },
    {
      "id": 217,
      "Name": "Fully Shipped to Disposal",
      "StatCode": "4",
      "Disabled": true
    },
    {
      "id": 799,
      "Name": "MMP Completed",
      "StatCode": "11",
      "Disabled": false
    },
    {
      "id": 798,
      "Name": "MMP Scheduled",
      "StatCode": "10",
      "Disabled": false
    },
    {
      "id": 416,
      "Name": "Pending Transfer",
      "StatCode": "12",
      "Disabled": true
    },
    {
      "id": 215,
      "Name": "Reconciled",
      "StatCode": "2",
      "Disabled": false
    },
    {
      "id": 220,
      "Name": "Rejected",
      "StatCode": "8",
      "Disabled": false
    },
    {
      "id": 219,
      "Name": "Transferred",
      "StatCode": "6",
      "Disabled": true
    }
  ]
}

get_profile_list_for_waste_lines

get_profile_list_for_waste_lines
GET/api/generators/orders/{order_id}/get_profile_list_for_waste_lines{?page,pageSize,selectedFields,filter}

Overview:

The get_profile_list_for_waste_lines endpoint, accessible at /api/generators/orders/{order_id}/get_profile_list_for_waste_lines{?page,pageSize,selectedFields,filter}, is a GET request that is used to retrieve the profile list for the waste lines of an order.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the profile list for the waste lines.
id number The unique identifier for the profile.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/order_id/get_profile_list_for_waste_lines?page=&pageSize=&selectedFields=&filter=
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

page
number (optional) 

The page number.

pageSize
number (optional) 

The page size.

selectedFields
string (optional) 

The selected fields.

filter
string (optional) 

The filter.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [],
  "totalElements": 0
}

check_discrepancies_islogged

check_discrepancies_islogged
GET/api/generators/orders/check_discrepancies_islogged/{order_id}/

Overview:

The check_discrepancies_islogged endpoint, accessible at /api/generators/orders/check_discrepancies_islogged/{order_id}/, is a GET request that is used to check whether the discrepancies are logged.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content boolean Indicates whether the discrepancies are logged.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/check_discrepancies_islogged/order_id/
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": false
}

check_order_is_archived

check_order_is_archived
GET/api/generators/orders/check_order_is_archived/{order_id}

Overview:

The check_order_is_archived endpoint, accessible at /api/generators/orders/check_order_is_archived/{order_id}, is a GET request that is used to check whether the order is archived.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the details of the order.
isArchived boolean Indicates whether the order is archived.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/check_order_is_archived/order_id
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "isArchived": false
  }
}

manifest_dot_information

manifest_dot_information
GET/api/generators/orders/parent/{order_id}/{sub_order_id}/{is_network}/manifest_dot_information/

Overview:

The manifest_dot_information endpoint, accessible at /api/generators/orders/parent/{order_id}/{sub_order_id}/{is_network}/manifest_dot_information/, is a GET request that is used to retrieve the manifest DOT information of an order.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the manifest DOT information.
id number The unique identifier for the manifest DOT information.
status number The status of the manifest DOT information.
Mainfest_Number string The manifest number.
Line_Number string The line number.
Final_TSDF__Name string The final TSDF name.
Description string The description.
Default boolean Indicates whether the manifest DOT information is the default.
default_description string The default description.
is_from_labpack_profile boolean Indicates whether the manifest DOT information is from the labpack profile.
CustomerProfile__Name string The customer profile name.
generic_US_DOT_comment string The generic US DOT comment.
is_network_exempt boolean Indicates whether the manifest DOT information is network exempt.
totalElements number The total elements.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/parent/order_id/sub_order_id/is_network/manifest_dot_information/
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

sub_order_id
number (required) 

The unique identifier for the sub-order.

is_network
boolean (required) 

Indicates whether the order is a network.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 692810,
      "status": 0,
      "Mainfest_Number": "22222",
      "Line_Number": "1",
      "Final_TSDF__Name": "Jane Doe",
      "Description": "",
      "Default": true,
      "default_description": "",
      "is_from_labpack_profile": true,
      "CustomerProfile__Name": "New Profile #212701",
      "generic_US_DOT_comment": "",
      "is_network_exempt": true
    }
  ],
  "totalElements": 1
}

order_historical_inventory_transaction_ajax

order_historical_inventory_transaction_ajax
GET/api/generators/orders/order_historical_inventory_transaction_ajax/{order_id}/{?page,pageSize,selectedFields,filter}

Overview:

The order_historical_inventory_transaction_ajax endpoint, accessible at /api/generators/orders/order_historical_inventory_transaction_ajax/{order_id}/{?page,pageSize,selectedFields,filter}, is a GET request that is used to retrieve the historical inventory transaction of an order.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the historical inventory transaction of the order.
totalElements number The total elements.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/order_historical_inventory_transaction_ajax/order_id/?page=&pageSize=&selectedFields=&filter=
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

page
number (optional) 

The page number.

pageSize
number (optional) 

The page size.

selectedFields
string (optional) 

The selected fields.

filter
string (optional) 

The filter.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [],
  "totalElements": 0
}

check_allow_adding_order

check_allow_adding_order
GET/api/generators/check_allow_adding_order/{generator_id}/

Overview:

The check_allow_adding_order endpoint, accessible at /api/generators/check_allow_adding_order/{generator_id}/, is a GET request that is used to check whether an order can be added.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the details of the order.
can_addnew boolean Indicates whether the order can be added.
msg string The message.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/generators/check_allow_adding_order/generator_id/
URI Parameters
HideShow
generator_id
number (required) 

The unique identifier for the generator.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "can_addnew": true,
    "msg": ""
  }
}

get_product_item_list_for_product_service_lines

get_product_item_list_for_product_service_lines
GET/api/generators/orders/{order_id}/get_product_item_list_for_product_service_lines{?page,pageSize}

Overview:

The get_product_item_list_for_product_service_lines endpoint, accessible at /api/generators/orders/{order_id}/get_product_item_list_for_product_service_lines{?page,pageSize}, is a GET request that is used to retrieve the product item list for the product service lines of an order.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content array An array of objects containing the product item list for the product service lines.
id number The unique identifier for the product item.
Each string The each.
Product_Service string The product service.
Product_Type string The product type.
Inv string The inventory.
Sales_Tax boolean Indicates whether the sales tax is applicable.
Description string The description.
Unit_Cost number The unit cost.
Unit_Price string The unit price.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/order_id/get_product_item_list_for_product_service_lines?page=&pageSize=
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

page
number (optional) 

The page number.

pageSize
number (optional) 

The page size.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 4150,
      "Each": "Each",
      "Product_Service": "814",
      "Product_Type": "Transportation",
      "Inv": "No",
      "Sales_Tax": false,
      "Description": "TRANSPORTATION - 10gl Cont",
      "Unit_Cost": 0,
      "Unit_Price": "0"
    }
  ]
}

get_current_tax

get_current_tax
GET/api/generators/orders/{order_id}/get_current_tax

Overview:

The get_current_tax endpoint, accessible at /api/generators/orders/{order_id}/get_current_tax, is a GET request that is used to retrieve the current tax information of an order.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the current tax information.
taxInfo array An array of tax information.
id number The unique identifier for the tax information.
taxVheader string The tax Vheader.
Applied_Sales_Tax_Exempt boolean Indicates whether the sales tax is exempt.
Applied_Tax_ID string The tax ID.
Applied_Sales_Tax_Rate string The sales tax rate.
Amount number The amount.
wastelineTaxInfo object An object containing the waste line tax information.
proserTaxInfo object An object containing the proser tax information.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/order_id/get_current_tax
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "taxInfo": [
      {
        "id": 312215125,
        "taxVheader": "Sales Tax",
        "Applied_Sales_Tax_Exempt": false,
        "Applied_Tax_ID": "",
        "Applied_Sales_Tax_Rate": "8.25",
        "Amount": 0
      }
    ],
    "wastelineTaxInfo": {
      "1324480": false
    },
    "proserTaxInfo": {
      "1531017": false
    }
  }
}

get_current_fee

get_current_fee
GET/api/generators/orders/{order_id}/get_current_fee

Overview:

The get_current_fee endpoint, accessible at /api/generators/orders/{order_id}/get_current_fee, is a GET request that is used to retrieve the current fee information of an order.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the current fee information.
id number The unique identifier for the fee.
Fee_id number The unique identifier for the fee.
Name string The name of the fee.
Type string The type of the fee.
Value string The value of the fee.
Apply string The application of the fee.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/order_id/get_current_fee
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 3898,
      "Fee_id": 3898,
      "Name": "EIS ",
      "Type": "Rate",
      "Value": "14",
      "Apply": "Waste Material"
    }
  ]
}

get_data_for_auto_generate_product_service_lines

get_data_for_auto_generate_product_service_lines
GET/api/generators/orders/{order_id}/get_data_for_auto_generate_product_service_lines/

Overview:

The get_data_for_auto_generate_product_service_lines endpoint, accessible at /api/generators/orders/{order_id}/get_data_for_auto_generate_product_service_lines/, is a GET request that is used to retrieve the data for auto-generating product service lines of an order.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
items array An array of items.
use_min_stop boolean Indicates whether the minimum stop is used.
use_max_stop boolean Indicates whether the maximum stop is used.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/order_id/get_data_for_auto_generate_product_service_lines/
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "items": [],
  "use_min_stop": false,
  "use_max_stop": false
}

save_purchase_order_quickbooks

save_purchase_order_quickbooks
GET/api/generators/orders/save_purchase_order_quickbooks/{order_id}/

Overview:

The save_purchase_order_quickbooks endpoint, accessible at /api/generators/orders/save_purchase_order_quickbooks/{order_id}/, is a GET request that is used to save the purchase order to QuickBooks.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
message string The message.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/save_purchase_order_quickbooks/order_id/
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "message": "No Action"
}

get_reconciled_should_know_infor

get_reconciled_should_know_infor
GET/api/generators/orders/{order_id}/get_reconciled_should_know_infor/

Overview:

The get_reconciled_should_know_infor endpoint, accessible at /api/generators/orders/{order_id}/get_reconciled_should_know_infor/, is a GET request that is used to retrieve the reconciled should know information of an order.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the reconciled should know information.
orderNotes object An object containing the order notes.
Pickup_Instr_For_Driver string The pickup instruction for
Trans_Notes string The transportation notes.
transportationInfor object An object containing the transportation information.
Transportation_Note string The transportation note.
transpEquipRequirement array An array of transportation equipment requirements.
thirdPartyTransportationRestrictionDetail array An array of third-party transportation restriction details.
vendorInfor object An object containing the vendor information.
Avg_PUP_Stop string Average Stop.
Avg_Bik_PUP_Stop string Average Bulk Stop.
Avg_DEL_Stop string Average Delivery Stop.
Hours_Of_Operation string The hours of operation.
Note string The note.
Site_Access_Restrictions string The site access restrictions
No_3rd_Party_Transportation string Indicates whether the third-party transportation
Trans_Restriction_Detail string The transportation restriction detail.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/order_id/get_reconciled_should_know_infor/
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "orderNotes": {
      "Pickup_Instr_For_Driver": "",
      "Trans_Notes": ""
    },
    "transportationInfor": {
      "Transportation_Note": ""
    },
    "transpEquipRequirement": [],
    "thirdPartyTransportationRestrictionDetail": [],
    "vendorInfor": {
      "Avg_PUP_Stop": "",
      "Avg_Bik_PUP_Stop": "",
      "Avg_DEL_Stop": "",
      "Hours_Of_Operation": "",
      "Note": "",
      "Site_Access_Restrictions": "",
      "No_3rd_Party_Transportation": "No",
      "Trans_Restriction_Detail": ""
    }
  }
}

get_number_of_line_order

get_number_of_line_order
GET/api/generators/orders/get_number_of_line_order/{order_id}/

Overview:

The get_number_of_line_order endpoint, accessible at /api/generators/orders/get_number_of_line_order/{order_id}/, is a GET request that is used to retrieve the number of lines in an order.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
number_of_line number The number of lines in the order.
list_obj_indexed array An array of indexed objects.
index number The index.
type number The type.
id number The unique identifier for the object.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/get_number_of_line_order/order_id/
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "number_of_line": 2,
  "list_obj_indexed": [
    {
      "index": 0,
      "type": 1,
      "id": 1324483
    },
    {
      "index": 1,
      "type": 2,
      "id": 1531018
    }
  ]
}

get_min_cost_processing_detail

get_min_cost_processing_detail
GET/api/generators/orders/get_min_cost_processing_detail/{?waste_line_id}

Overview:

The get_min_cost_processing_detail endpoint, accessible at /api/generators/orders/get_min_cost_processing_detail/{?waste_line_id}, is a GET request that is used to retrieve the minimum cost processing detail of an order.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the minimum cost processing detail.
min_cost string The minimum cost.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/get_min_cost_processing_detail/?waste_line_id=
URI Parameters
HideShow
waste_line_id
number (optional) 

The unique identifier for the waste line.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "min_cost": "0.00"
  }
}

orders_add

orders_add
POST/api/generators/{generator_id}/orders/add

Overview:

The orders_add endpoint, accessible at /api/generators/{generator_id}/orders/add, is a POST request that is used to add an order.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the details of the order.
id number The unique identifier for the order.

Example URI

POST [Orders APIs](https://test-api.wastelinq.com)./api/generators/generator_id/orders/add
URI Parameters
HideShow
generator_id
number (required) 

The unique identifier for the generator.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "id": 577712
  }
}

save_general_info

save_general_info
PUT/api/generators/orders/{order_id}/save_general_info

Overview:

The save_general_info endpoint, accessible at /api/generators/orders/{order_id}/save_general_info{?is_calendar_event,series}, is a PUT request that is used to save the general information of an order.

Request Body and Response Description:

Name Data Type Description
has_Recurrence number Indicates whether the order has a recurrence.
custom_fields object An object containing the custom fields.
integ_sync_reference string The integration sync reference.
integ_sync_status string The integration sync status.
delay_reason string The delay reason.
conf_date_time string The confirmation date and time.
assigned_to string The assigned to.
tsdf_in_slot_status string The TSDF in slot status.
freight_Status string The freight status.
generator_pickup_requested_date string The generator pickup requested date.
order_name string The order name.
phase string The phase.
project string The project.
customer_po_number string The customer PO number.
order_contact_name string The order contact name.
order_contact string The order contact.
tsdf_signed_date string The TSDF signed date.
work_order string The work order.
in_slot_time string The in slot time.
in_slot_date string The in slot date.
invoice_date string The invoice date.
schedule_date_time string The schedule date and time.
first_network_order_logistics_status string The first network order logistics status.
cancel_reason string The cancel reason.
order_logistics_status string The order logistics status.
order_source string The order source.
order_type string The order type.
updated_by string The updated by.
date_created string The date created.
sub_order_view string The sub-order view.
suborder_order_number string The sub-order order number.
esc_order_number string The ESC order number.
pick_up_date string The pick-up date.
is_archived boolean Indicates whether the order is archived.
success boolean Indicates whether the operation was successful.
content array An array of content.

Example URI

PUT [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/order_id/save_general_info
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "has_Recurrence": 0,
  "custom_fields": {},
  "integ_sync_reference": "",
  "integ_sync_status": "",
  "delay_reason": "20",
  "conf_date_time": "",
  "assigned_to": "",
  "tsdf_in_slot_status": "",
  "freight_Status": "",
  "generator_pickup_requested_date": "",
  "order_name": "test",
  "phase": "",
  "project": "666",
  "customer_po_number": "",
  "order_contact_name": "",
  "order_contact": "20727",
  "tsdf_signed_date": "",
  "work_order": "",
  "in_slot_time": "",
  "in_slot_date": "",
  "invoice_date": "",
  "schedule_date_time": "",
  "first_network_order_logistics_status": "",
  "cancel_reason": "",
  "order_logistics_status": "137",
  "order_source": "78",
  "order_type": "303",
  "updated_by": "kien dao",
  "date_created": "08/12/2024",
  "sub_order_view": "parent",
  "suborder_order_number": "616990",
  "esc_order_number": "",
  "pick_up_date": "2024-08-12",
  "is_archived": false
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": []
}

save_waste_line

save_waste_line
POST/api/generators/orders/{order_id}/save_waste_line/

Overview:

The save_waste_line endpoint, accessible at /api/generators/orders/{order_id}/save_waste_line/, is a POST request that is used to save a waste line.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the details of the waste line.
id number The unique identifier for the waste line.
status string The status of the waste line.
minPrice string The minimum price.
apply_current_price boolean Indicates whether the current price is applicable.
UseSubLine boolean Indicates whether the sub-line is used.
enteredActualWeight boolean Indicates whether the actual weight is entered.
unit_billing_weight_volume_count number The unit billing weight volume count.
isSpecialHandlingRestrictionsWMP string The special handling restrictions WMP.
specialHandlingRestrictionsWMPContent string The special handling restrictions WMP content.
profileNumber number The profile number.
profileName string The profile name.
prodetail_cnt_id number The unique identifier for the profile detail.
specificGravity string The specific gravity.
isProfilExpired boolean Indicates whether the profile is expired.
approvalNumber string The approval number.
disposalSite string The disposal site.
disposalSiteId number The unique identifier for the disposal site.
WPC string The WPC.
empty_container boolean Indicates whether the container is empty.
vendorCode string The vendor code.
Mainfest_Number string The manifest number.
Line_Number string The line number.
containerType string The container type.
containerSize string The container size.
containerSizeWeight number The container size weight.
Container_Count number The container count.
Converted_Value number The converted value.
Container_Unit string The container unit.
shippingUnitOptions array An array of shipping unit options.
id string The unique identifier for the shipping unit option.
name string The name of the shipping unit option.
Total_Volume number The total volume.
Total_Weight number The total weight.
VUnit string The VUnit.
WUnit string The WUnit.
billing_weight_volume_count number The billing weight volume count.
line_total_using_min_price boolean Indicates whether the line total is using the minimum price.
CostBasis_id number The unique identifier for the cost basis.
billingBasis string The billing basis.
showingBillingBasis string The showing billing basis.
Price number The price.
profile_billing_price string The profile billing price.
Line_total number The line total.
Line_Status string The line status.
lineStatusOptions array An array of line status options.
location number The location.
facilityOptions array An array of facility options.
id number The unique identifier for the facility option.
Name string The name of the facility option.
current_rcra_code array An array of current RCRA codes.
current_state_waste_code array An array of current state waste codes.
current_state_rcra_code string The current state RCRA code.
state_waste_code object An object containing the state waste code.
state_rcra_code object An object containing the state RCRA code.
default_state_waste_code_dic object An object containing the default state waste code.
default_state_waste_code_rcra_dic object An object containing the default state waste code RCRA.
stateRCRACode string The state RCRA code.
finalHandlingCode string The final handling code.
handlingCodeOptions array An array of handling code options.
id number The unique identifier for the handling code option.
Name string The name of the handling code option.
Description string The description of the handling code option.
ten_day_start_date string The ten-day start date.
ten_day_start_time string The ten-day start time.
Warehouse string The warehouse.
warehouseOptions object An object containing the warehouse options.
70 array An array of warehouse options.
id number The unique identifier for the warehouse option.
Name string The name of the warehouse option.
networkStatus string The network status.
logisticsType string The logistics type.
suborderNumber string The sub-order number.
networkFreightScheduledDate string The network freight scheduled date.
TSDFWorkOrderNumber string The TSDF work order number.
genSignedDate string The gen signed date.
TSDFSignedDate string The TSDF signed date.
paperworkRequested string The paperwork requested.
Sales_Tax boolean Indicates whether the sales tax is applicable.
Note string The note.
using_emanifest boolean Indicates whether the e-manifest is used.
inbound_mmp_id string The inbound MMP ID.
balance_detail_id string The balance detail ID.
inbound_containers string The inbound containers.
final_handling_code string The final handling code.
rcra_code array An array of RCRA codes.
is_from_labpack_profile boolean Indicates whether the profile is from the labpack profile.
deletable boolean Indicates whether the waste line is deletable.
childs array An array of child waste lines.
is_edit boolean Indicates whether the waste line is editable.
transporter string The transporter.
mmc string The MMC.
is_manifest_in_outbount_shipment boolean Indicates whether the manifest is in the outbound shipment.

Example URI

POST [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/order_id/save_waste_line/
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "data": {
    "orderid": 577721,
    "id": 0,
    "status": "1",
    "prodetail_cnt_id": 592110,
    "disposalSiteId": 12162,
    "Mainfest_Number": "",
    "Line_Number": "",
    "Container_Unit": "P",
    "Container_Count": 1,
    "Converted_Value": "1704.68",
    "Total_Volume": "202.00",
    "Total_Weight": "1704.68",
    "CostBasis_id": 2,
    "Price": "0.00",
    "VUnit": "G",
    "WUnit": "P",
    "Line_total": 0,
    "Line_Status": null,
    "ten_day_start_date": "",
    "location": null,
    "Warehouse": null,
    "Sales_Tax": false,
    "UseSubLine": false,
    "line_total_using_min_price": false,
    "Note": "",
    "using_emanifest": false,
    "inbound_mmp_id": null,
    "balance_detail_id": null,
    "network_type": "",
    "in_slot_date": "",
    "in_slot_time": "",
    "billing_weight_volume_count": 1,
    "is_changing": true,
    "state_code": []
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 1324479,
      "status": "0",
      "minPrice": "0",
      "apply_current_price": false,
      "UseSubLine": false,
      "enteredActualWeight": false,
      "unit_billing_weight_volume_count": 1,
      "isSpecialHandlingRestrictionsWMP": null,
      "specialHandlingRestrictionsWMPContent": null,
      "profileNumber": 203415,
      "profileName": "Universal Waste Lamps - Accumulation Date:",
      "prodetail_cnt_id": 581986,
      "specificGravity": "1",
      "isProfilExpired": false,
      "approvalNumber": "Approval",
      "disposalSite": "Company ABC",
      "disposalSiteId": 23651,
      "WPC": "6039",
      "empty_container": false,
      "vendorCode": "None",
      "Mainfest_Number": "22222",
      "Line_Number": "1",
      "containerType": "CF",
      "containerSize": "5 (G)",
      "containerSizeWeight": 1.67,
      "Container_Count": 1,
      "Converted_Value": 202,
      "Container_Unit": "G",
      "shippingUnitOptions": [
        {
          "id": "N",
          "name": "N- Cubic Meters"
        }
      ],
      "Total_Volume": 202,
      "Total_Weight": 1704.68,
      "VUnit": "G",
      "WUnit": "P",
      "billing_weight_volume_count": 1,
      "line_total_using_min_price": false,
      "CostBasis_id": 2,
      "billingBasis": "Per Container",
      "showingBillingBasis": "Per Container",
      "Price": 195,
      "profile_billing_price": "0",
      "Line_total": 195,
      "Line_Status": null,
      "lineStatusOptions": [],
      "location": 70,
      "facilityOptions": [
        {
          "id": 70,
          "Name": "Company ABC"
        },
        {
          "id": 71,
          "Name": "Company ERT"
        }
      ],
      "current_rcra_code": [],
      "current_state_waste_code": [
        "R - Material Recovery of more than 75 percent of the total material. Waste management method code to be used on e-Manifest only"
      ],
      "current_state_rcra_code": null,
      "state_waste_code": {
        "R - Material Recovery of more than 75 percent of the total material. Waste management method code to be used on e-Manifest only": "R - Material Recovery of more than 75 percent of the total material. Waste management method code to be used on e-Manifest only"
      },
      "state_rcra_code": {},
      "default_state_waste_code_dic": {
        "R - Material Recovery of more than 75 percent of the total material. Waste management method code to be used on e-Manifest only": "R - Material Recovery of more than 75 percent of the total material. Waste management method code to be used on e-Manifest only"
      },
      "default_state_waste_code_rcra_dic": {},
      "stateRCRACode": "",
      "finalHandlingCode": "",
      "handlingCodeOptions": [
        {
          "id": 1,
          "Name": "H010",
          "Description": "METALS RECOVERY"
        }
      ],
      "ten_day_start_date": "",
      "ten_day_start_time": null,
      "Warehouse": null,
      "warehouseOptions": {
        "70": [
          {
            "id": 44,
            "Name": "Company ABC"
          }
        ],
        "71": [
          {
            "id": 45,
            "Name": "Company ERT"
          }
        ]
      },
      "networkStatus": "Enterprise",
      "logisticsType": null,
      "suborderNumber": "616988-01",
      "networkFreightScheduledDate": "",
      "TSDFWorkOrderNumber": "",
      "genSignedDate": "",
      "TSDFSignedDate": "",
      "paperworkRequested": "No",
      "Sales_Tax": false,
      "Note": null,
      "using_emanifest": false,
      "inbound_mmp_id": null,
      "balance_detail_id": null,
      "inbound_containers": null,
      "final_handling_code": "",
      "rcra_code": [],
      "is_from_labpack_profile": false,
      "deletable": false,
      "childs": [],
      "is_edit": true,
      "transporter": "",
      "mmc": "",
      "is_manifest_in_outbount_shipment": false
    }
  ]
}

save_waste_lines

save_waste_lines
POST/api/generators/orders/{order_id}/save_waste_lines/

Overview:

The save_waste_lines endpoint, accessible at /api/generators/orders/{order_id}/save_waste_lines/, is a POST request that is used to save the waste lines.

Request Body and Response Description:

Name Data Type Description
id number The unique identifier for the waste line.
status string The status of the waste line.
minPrice string The minimum price.
apply_current_price boolean Indicates whether the current price is applicable.
UseSubLine boolean Indicates whether the sub-line is used.
enteredActualWeight boolean Indicates whether the actual weight is entered.
unit_billing_weight_volume_count number The unit billing weight volume count.
isSpecialHandlingRestrictionsWMP string The special handling restrictions WMP.
specialHandlingRestrictionsWMPContent string The special handling restrictions WMP content.
profileNumber number The profile number.
profileName string The profile name.
prodetail_cnt_id number The unique identifier for the profile detail.
specificGravity string The specific gravity.
isProfilExpired boolean Indicates whether the profile is expired.
approvalNumber string The approval number.
disposalSite string The disposal site.
disposalSiteId number The unique identifier for the disposal site.
WPC string The WPC.
empty_container boolean Indicates whether the container is empty.
vendorCode string The vendor code.
Mainfest_Number string The manifest number.
Line_Number string The line number.
containerType string The container type.
containerSize string The container size.
containerSizeWeight number The container size weight.
Container_Count number The container count.
Converted_Value number The converted value.
Container_Unit string The container unit.
shippingUnitOptions array An array of shipping unit options.
id string The unique identifier for the shipping unit option.
name string The name of the shipping unit option.
Total_Volume number The total volume.
Total_Weight number The total weight.
VUnit string The VUnit.
WUnit string The WUnit.
billing_weight_volume_count number The billing weight volume count.
line_total_using_min_price boolean Indicates whether the line total is using the minimum price.
CostBasis_id number The unique identifier for the cost basis.
billingBasis string The billing basis.
showingBillingBasis string The showing billing basis.
Price number The price.
profile_billing_price string The profile billing price.
Line_total number The line total.
Line_Status string The line status.
lineStatusOptions array An array of line status options.
location number The location.
facilityOptions array An array of facility options.
id number The unique identifier for the facility option.
Name string The name of the facility option.
current_rcra_code array An array of current RCRA codes.
current_state_waste_code array An array of current state waste codes.
current_state_rcra_code string The current state RCRA code.
state_waste_code object An object containing the state waste code.
state_rcra_code object An object containing the state RCRA code.
default_state_waste_code_dic object An object containing the default state waste code.
default_state_waste_code_rcra_dic object An object containing the default state waste code RCRA.
stateRCRACode string The state RCRA code.
finalHandlingCode string The final handling code.
handlingCodeOptions array An array of handling code options.
id number The unique identifier for the handling code option.
Name string The name of the handling code option.
Description string The description of the handling code option.
ten_day_start_date string The ten-day start date.
ten_day_start_time string The ten-day start time.
Warehouse string The warehouse.
warehouseOptions object An object containing the warehouse options.
70 array An array of warehouse options.
id number The unique identifier for the warehouse option.
Name string The name of the warehouse option.
networkStatus string The network status.
logisticsType string The logistics type.
suborderNumber string The sub-order number.
networkFreightScheduledDate string The network freight scheduled date.
TSDFWorkOrderNumber string The TSDF work order number.
genSignedDate string The gen signed date.
TSDFSignedDate string The TSDF signed date.
paperworkRequested string The paperwork requested.
Sales_Tax boolean Indicates whether the sales tax is applicable.
Note string The note.
using_emanifest boolean Indicates whether the e-manifest is used.
inbound_mmp_id string The inbound MMP ID.
balance_detail_id string The balance detail ID.
inbound_containers string The inbound containers.
final_handling_code string The final handling code.
rcra_code array An array of RCRA codes.
is_from_labpack_profile boolean Indicates whether the profile is from the labpack profile.
deletable boolean Indicates whether the waste line is deletable.
childs array An array of child waste lines.
is_edit boolean Indicates whether the waste line is editable.
transporter string The transporter.
mmc string The MMC.
is_manifest_in_outbount_shipment boolean Indicates whether the manifest is in the outbound shipment.
is_applied_current_price boolean Indicates whether the current price is applied.
success boolean Indicates whether the operation was successful.
showMess boolean Indicates whether the message is shown.
message string The message.

Example URI

POST [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/order_id/save_waste_lines/
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "data": [
    {
      "id": 1324482,
      "status": "0",
      "minPrice": "0",
      "apply_current_price": false,
      "UseSubLine": false,
      "enteredActualWeight": false,
      "unit_billing_weight_volume_count": 1,
      "isSpecialHandlingRestrictionsWMP": null,
      "specialHandlingRestrictionsWMPContent": null,
      "profileNumber": 212720,
      "profileName": "New Profile #212720",
      "prodetail_cnt_id": 592111,
      "specificGravity": "1",
      "isProfilExpired": false,
      "approvalNumber": "",
      "disposalSite": "Company ABC",
      "disposalSiteId": 12162,
      "WPC": "6104",
      "empty_container": false,
      "vendorCode": "None",
      "Mainfest_Number": "22222",
      "Line_Number": "1",
      "containerType": "CF",
      "containerSize": "202 (G)",
      "containerSizeWeight": 20,
      "Container_Count": 1,
      "Converted_Value": 1704,
      "Container_Unit": "P",
      "shippingUnitOptions": [
        {
          "id": "N",
          "name": "N- Cubic Meters"
        }
      ],
      "Total_Volume": 202,
      "Total_Weight": 1704.68,
      "VUnit": "G",
      "WUnit": "P",
      "billing_weight_volume_count": 1,
      "line_total_using_min_price": false,
      "CostBasis_id": 2,
      "billingBasis": "Per Container",
      "showingBillingBasis": "Per Container",
      "Price": 0,
      "profile_billing_price": "0",
      "Line_total": 0,
      "Line_Status": null,
      "lineStatusOptions": [],
      "location": 70,
      "facilityOptions": [
        {
          "id": 70,
          "Name": "Company ABC"
        },
        {
          "id": 71,
          "Name": "Company ERT"
        }
      ],
      "current_rcra_code": [
        "F001",
        "D001",
        "D002"
      ],
      "current_state_waste_code": [
        "ABZ"
      ],
      "current_state_rcra_code": null,
      "state_waste_code": {
        "ABZ": "ABZ"
      },
      "state_rcra_code": {
        "WCGF-1": "F001",
        "WCGIGNITABLE-D001": "D001",
        "WCGCORROSIVE-D002": "D002"
      },
      "default_state_waste_code_dic": {
        "ABZ": "ABZ"
      },
      "default_state_waste_code_rcra_dic": {
        "WCGF-1": "F001",
        "WCGIGNITABLE-D001": "D001",
        "WCGCORROSIVE-D002": "D002"
      },
      "stateRCRACode": "",
      "finalHandlingCode": "",
      "handlingCodeOptions": [
        {
          "id": 42,
          "Name": "H139",
          "Description": "OTHER DISPOSAL"
        }
      ],
      "ten_day_start_date": "",
      "ten_day_start_time": null,
      "Warehouse": null,
      "warehouseOptions": {
        "70": [
          {
            "id": 44,
            "Name": "Company ABC"
          }
        ],
        "71": [
          {
            "id": 45,
            "Name": "Company ERT"
          }
        ]
      },
      "networkStatus": "Enterprise",
      "logisticsType": null,
      "suborderNumber": "616990-01",
      "networkFreightScheduledDate": "",
      "TSDFWorkOrderNumber": "",
      "genSignedDate": "",
      "TSDFSignedDate": "",
      "paperworkRequested": "No",
      "Sales_Tax": false,
      "Note": null,
      "using_emanifest": false,
      "inbound_mmp_id": null,
      "balance_detail_id": null,
      "inbound_containers": null,
      "final_handling_code": "",
      "rcra_code": [],
      "is_from_labpack_profile": true,
      "deletable": false,
      "childs": [],
      "is_edit": true,
      "transporter": "",
      "mmc": "",
      "is_manifest_in_outbount_shipment": false
    }
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "showMess": false,
  "message": "Outbound # created."
}

save_product_service_line

save_product_service_line
POST/api/generators/orders/{order_id}/save_product_service_line/

Overview:

The save_product_service_line endpoint, accessible at /api/generators/orders/{order_id}/save_product_service_line/, is a POST request that is used to save a product service line.

Request Body and Response Description:

Name Data Type Description
data object An object containing the details of the product service line.
orderid number The unique identifier for the order.
Warehouse string The warehouse.
id number The unique identifier for the product service line.
status string The status of the product service line.
Product_Service_id number The unique identifier for the product service.
Product_Service string The product service.
Line_Number string The line number.
Description string The description.
Quanity number The quantity.
Unit_Price string The unit price.
Each string The each.
Unit_Cost number The unit cost.
Inv string The inventory.
Sales_Tax string Indicates whether the sales tax is applicable.

Example URI

POST [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/order_id/save_product_service_line/
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "data": {
    "orderid": 577719,
    "Warehouse": null,
    "id": 0,
    "status": "1",
    "Product_Service_id": 4150,
    "Product_Service": "814",
    "Line_Number": "",
    "Description": "TRANSPORTATION - 10gl Cont",
    "Quanity": 1,
    "Unit_Price": "0",
    "Each": "Each",
    "Unit_Cost": 0,
    "Inv": "No",
    "Sales_Tax": "False"
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true
}

save_product_service_lines

save_product_service_lines
POST/api/generators/orders/{order_id}/save_product_service_lines/

Overview:

The save_product_service_lines endpoint, accessible at /api/generators/orders/{order_id}/save_product_service_lines/, is a POST request that is used to save the product service lines.

Request Body and Response Description:

Name Data Type Description
data array An array of data.
id number The unique identifier for the product service line.
status string The status of the product service line.
Description string The description of the product service line.
Warehouse string The warehouse.
Line_Number number The line number.
Product_Service_id number The unique identifier for the product service.
Product_Service string The product service.
Product_Type string The product type.
Quanity number The quantity.
Unit_Price number The unit price.
Unit_Cost number The unit cost.
Each string The each.
Line_Total number The line total.
Sales_Tax boolean Indicates whether the sales tax is applicable.
Inv string The inventory.
suborderNumber string The sub-order number.
warehouseOptions array An array of warehouse options.
id number The unique identifier for the warehouse option.
Name string The name of the warehouse option.
prodserv_FS number The prodserv FS.
isfs boolean Indicates whether the FS is applicable.
iseis boolean Indicates whether the EIS is applicable.

Example URI

POST [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/order_id/save_product_service_lines/
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "data": [
    {
      "id": 1531018,
      "status": "2",
      "Description": "RENTAL - Frac Tank rental",
      "Warehouse": null,
      "Line_Number": 1,
      "Product_Service_id": 4174,
      "Product_Service": "412",
      "Product_Type": "Equipment",
      "Quanity": 1,
      "Unit_Price": 40,
      "Unit_Cost": 0,
      "Each": "Per Day",
      "Line_Total": 40,
      "Sales_Tax": true,
      "Inv": "No",
      "suborderNumber": "616990-02",
      "warehouseOptions": [
        {
          "id": 44,
          "Name": "GEC - NB"
        }
      ],
      "prodserv_FS": 4167,
      "isfs": false,
      "iseis": false
    }
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true
}

get_data_for_apply_current_price

get_data_for_apply_current_price
POST/api/generators/orders/{order_id}/get_data_for_apply_current_price

Overview:

The get_data_for_apply_current_price endpoint, accessible at /api/generators/orders/{order_id}/get_data_for_apply_current_price, is a POST request that is used to retrieve the data for applying the current price.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the operation was successful.
content object An object containing the details of the data.
1324480 object An object containing the details of the data.
NotRejectedItemsNo number The number of not rejected items.
items array An array of items.
id number The unique identifier for the item.
parentUseSubLine boolean Indicates whether the parent sub-line is used.
status string The status of the item.
wasteLineId number The unique identifier for the waste line.
IsRejected boolean Indicates whether the item is rejected.
Container_ID_Number string The container ID number.
Disposal_Process string The disposal process.
WPC string The WPC.
wpc_options array An array of WPC options.
wpc_info_map object An object containing the WPC information map.
vendorCode string The vendor code.
containerType string The container type.
containerSize string The container size.
ProcessingDetail_Content number The unique identifier for the processing detail.
billingBasisName string The billing basis name.
showingBillingBasis string The showing billing basis.
price_basis_id number The unique identifier for the price basis.
Mainfest_Number string The manifest number.
Line_Number string The line number.
LIMS string The LIMS.
Line_Status_id string The line status ID.
Line_Status string The line status.
line_status_options array An array of line status options.
RejectedReason string The rejected reason.
FacilityName_id number The unique identifier for the facility name.
location string The location.
is_edited_billing_basis boolean Indicates whether the billing basis is edited.
Warehouse_id string The unique identifier for the warehouse.
Warehouse string The warehouse.
count number The count.
Price number The price.
Line_total number The line total.
Sales_Tax boolean Indicates whether the sales tax is applicable.
billing_weight_volume_count number The billing weight volume count.
edited_weight boolean Indicates whether the weight is edited.
LastAnswer string The last answer.
containersizeweight number The container size weight.
minprice string The minimum price.
line_total_using_min_price string Indicates whether the line total is using the minimum price.
current_price number The current price.
current_sub_line_total number The current sub-line total.
current_sub_line_total_using_min_price boolean Indicates whether the current sub-line total is using the minimum price.
wl_price_basis_id number The unique identifier for the price basis.
wl_price_basis_name string The price basis name.
default_weight_per_one_unit number The default weight per one unit.
print_type_tsdf string The print type TSDF.
print_sub_type_tsdf string The print sub-type TSDF.
is_applied_current_price boolean Indicates whether the current price is applied.
new_price string The new price.
is_price_basis_updated boolean Indicates whether the price basis is updated.

Example URI

POST [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/order_id/get_data_for_apply_current_price
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "data": {
    "waste_line_list": [
      {
        "id": 1324480,
        "status": "0",
        "minPrice": "0",
        "apply_current_price": false,
        "UseSubLine": false,
        "enteredActualWeight": false,
        "unit_billing_weight_volume_count": 1,
        "isSpecialHandlingRestrictionsWMP": null,
        "specialHandlingRestrictionsWMPContent": null,
        "profileNumber": 212701,
        "profileName": "New Profile #212701",
        "prodetail_cnt_id": 592107,
        "specificGravity": "1",
        "isProfilExpired": false,
        "approvalNumber": "",
        "disposalSite": "Company ABC",
        "disposalSiteId": 12162,
        "WPC": "6104",
        "empty_container": false,
        "vendorCode": "None",
        "Mainfest_Number": "22222",
        "Line_Number": "1",
        "containerType": "CF",
        "containerSize": "202 (G)",
        "containerSizeWeight": 20,
        "Container_Count": 1,
        "Converted_Value": 1704,
        "Container_Unit": "P",
        "shippingUnitOptions": [
          {
            "id": "N",
            "name": "N- Cubic Meters"
          }
        ],
        "Total_Volume": 202,
        "Total_Weight": 1704.68,
        "VUnit": "G",
        "WUnit": "P",
        "billing_weight_volume_count": 1,
        "line_total_using_min_price": false,
        "CostBasis_id": 2,
        "billingBasis": "Per Container",
        "showingBillingBasis": "Per Container",
        "Price": 0,
        "profile_billing_price": "0",
        "Line_total": 0,
        "Line_Status": null,
        "lineStatusOptions": [],
        "location": 70,
        "facilityOptions": [
          {
            "id": 70,
            "Name": "Company ABC"
          },
          {
            "id": 71,
            "Name": "Company ERT"
          }
        ],
        "current_rcra_code": [
          "F001",
          "D001",
          "D002"
        ],
        "current_state_waste_code": [
          "ABZ"
        ],
        "current_state_rcra_code": null,
        "state_waste_code": {
          "ABZ": "ABZ"
        },
        "state_rcra_code": {
          "WCGF-1": "F001",
          "WCGIGNITABLE-D001": "D001",
          "WCGCORROSIVE-D002": "D002"
        },
        "default_state_waste_code_dic": {
          "ABZ": "ABZ"
        },
        "default_state_waste_code_rcra_dic": {
          "WCGF-1": "F001",
          "WCGIGNITABLE-D001": "D001",
          "WCGCORROSIVE-D002": "D002"
        },
        "stateRCRACode": "",
        "finalHandlingCode": "",
        "handlingCodeOptions": [
          {
            "id": 42,
            "Name": "H137",
            "Description": "DISCHARGE TO NPDES PERMIT"
          }
        ],
        "ten_day_start_date": "",
        "ten_day_start_time": null,
        "Warehouse": null,
        "warehouseOptions": {
          "70": [
            {
              "id": 44,
              "Name": "Company ABC"
            }
          ],
          "71": [
            {
              "id": 45,
              "Name": "Company ERT"
            }
          ]
        },
        "networkStatus": "Enterprise",
        "logisticsType": null,
        "suborderNumber": "616989-01",
        "networkFreightScheduledDate": "",
        "TSDFWorkOrderNumber": "",
        "genSignedDate": "",
        "TSDFSignedDate": "",
        "paperworkRequested": "No",
        "Sales_Tax": false,
        "Note": null,
        "using_emanifest": false,
        "inbound_mmp_id": null,
        "balance_detail_id": null,
        "inbound_containers": null,
        "final_handling_code": "",
        "rcra_code": [],
        "is_from_labpack_profile": true,
        "deletable": false,
        "childs": [],
        "is_edit": true,
        "transporter": "",
        "mmc": "",
        "is_manifest_in_outbount_shipment": false
      }
    ],
    "is_applied_current_price": true
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": {
    "1324480": {
      "NotRejectedItemsNo": 1,
      "items": [
        {
          "id": 3092477,
          "parentUseSubLine": false,
          "status": "0",
          "wasteLineId": 1324480,
          "IsRejected": false,
          "Container_ID_Number": "ENT1354480-1-1",
          "Disposal_Process": "",
          "WPC": "6104",
          "wpc_options": [],
          "wpc_info_map": {},
          "vendorCode": "None",
          "containerType": "CF",
          "containerSize": "202 (G)",
          "ProcessingDetail_Content": 592107,
          "billingBasisName": "Per Container",
          "showingBillingBasis": "Per Container",
          "price_basis_id": 2,
          "Mainfest_Number": "ENT1354480",
          "Line_Number": "1",
          "LIMS": "N/A",
          "Line_Status_id": null,
          "Line_Status": "",
          "line_status_options": [],
          "RejectedReason": null,
          "FacilityName_id": 70,
          "location": "Company ABC",
          "is_edited_billing_basis": false,
          "Warehouse_id": null,
          "Warehouse": "",
          "count": 1,
          "Price": 0,
          "Line_total": 0,
          "Sales_Tax": false,
          "billing_weight_volume_count": 1,
          "edited_weight": false,
          "LastAnswer": "",
          "containersizeweight": 20,
          "minprice": "0",
          "line_total_using_min_price": "False",
          "current_price": 0,
          "current_sub_line_total": 0,
          "current_sub_line_total_using_min_price": false,
          "wl_price_basis_id": 2,
          "wl_price_basis_name": "Per Container",
          "default_weight_per_one_unit": 1,
          "print_type_tsdf": "",
          "print_sub_type_tsdf": "",
          "is_applied_current_price": true
        }
      ],
      "new_price": "0",
      "wl_price_basis_name": "Per Container",
      "wl_price_basis_id": 2,
      "default_weight_per_one_unit": 1,
      "is_price_basis_updated": false
    }
  }
}

get_data_for_network_submitting

get_data_for_network_submitting
POST/api/generators/orders/{order_id}/get_data_for_network_submitting/

Overview:

The get_data_for_network_submitting endpoint, accessible at /api/generators/orders/{order_id}/get_data_for_network_submitting/, is a POST request that is used to retrieve the data for network submitting.

Request Body and Response Description:

Name Data Type Description
id number The unique identifier for the waste line.
status string The status of the waste line.
minPrice string The minimum price.
apply_current_price boolean Indicates whether the current price is applicable.
UseSubLine boolean Indicates whether the sub-line is used.
enteredActualWeight boolean Indicates whether the actual weight is entered.
unit_billing_weight_volume_count number The unit billing weight volume count.
isSpecialHandlingRestrictionsWMP string The special handling restrictions WMP.
specialHandlingRestrictionsWMPContent string The special handling restrictions WMP content.
profileNumber number The profile number.
profileName string The profile name.
prodetail_cnt_id number The unique identifier for the profile detail.
specificGravity string The specific gravity.
isProfilExpired boolean Indicates whether the profile is expired.
approvalNumber string The approval number.
disposalSite string The disposal site.
disposalSiteId number The unique identifier for the disposal site.
WPC string The WPC.
empty_container boolean Indicates whether the container is empty.
vendorCode string The vendor code.
Mainfest_Number string The manifest number.
Line_Number string The line number.
containerType string The container type.
containerSize string The container size.
containerSizeWeight number The container size weight.
Container_Count number The container count.
Converted_Value number The converted value.
Container_Unit string The container unit.
shippingUnitOptions array An array of shipping unit options.
id string The unique identifier for the shipping unit option.
name string The name of the shipping unit option.
Total_Volume number The total volume.
Total_Weight number The total weight.
VUnit string The VUnit.
WUnit string The WUnit.
billing_weight_volume_count number The billing weight volume count.
line_total_using_min_price boolean Indicates whether the line total is using the minimum price.
CostBasis_id number The unique identifier for the cost basis.
billingBasis string The billing basis.
showingBillingBasis string The showing billing basis.
Price number The price.
profile_billing_price string The profile billing price.
Line_total number The line total.
Line_Status string The line status.
lineStatusOptions array An array of line status options.
location number The location.
facilityOptions array An array of facility options.
id number The unique identifier for the facility option.
Name string The name of the facility option.
current_rcra_code array An array of current RCRA codes.
current_state_waste_code array An array of current state waste codes.
current_state_rcra_code string The current state RCRA code.
state_waste_code object An object containing the state waste code.
state_rcra_code object An object containing the state RCRA code.
default_state_waste_code_dic object An object containing the default state waste code.
default_state_waste_code_rcra_dic object An object containing the default state waste code RCRA.
stateRCRACode string The state RCRA code.
finalHandlingCode string The final handling code.
handlingCodeOptions array An array of handling code options.
id number The unique identifier for the handling code option.
Name string The name of the handling code option.
Description string The description of the handling code option.
ten_day_start_date string The ten-day start date.
ten_day_start_time string The ten-day start time.
Warehouse string The warehouse.
warehouseOptions object An object containing the warehouse options.
70 array An array of warehouse options.
id number The unique identifier for the warehouse option.
Name string The name of the warehouse option.
networkStatus string The network status.
logisticsType string The logistics type.
suborderNumber string The sub-order number.
networkFreightScheduledDate string The network freight scheduled date.
TSDFWorkOrderNumber string The TSDF work order number.
genSignedDate string The gen signed date.
TSDFSignedDate string The TSDF signed date.
paperworkRequested string The paperwork requested.
Sales_Tax boolean Indicates whether the sales tax is applicable.
Note string The note.
using_emanifest boolean Indicates whether the e-manifest is used.
inbound_mmp_id string The inbound MMP ID.
balance_detail_id string The balance detail ID.
inbound_containers string The inbound containers.
final_handling_code string The final handling code.
rcra_code array An array of RCRA codes.
is_from_labpack_profile boolean Indicates whether the profile is from the labpack profile.
deletable boolean Indicates whether the waste line is deletable.
childs array An array of child waste lines.
is_edit boolean Indicates whether the waste line is editable.
transporter string The transporter.
mmc string The MMC.
is_manifest_in_outbount_shipment boolean Indicates whether the manifest is in the outbound shipment.

Example URI

POST [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/order_id/get_data_for_network_submitting/
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "data": [
    {
      "id": 1324482,
      "status": "0",
      "minPrice": "0",
      "apply_current_price": false,
      "UseSubLine": false,
      "enteredActualWeight": false,
      "unit_billing_weight_volume_count": 1,
      "isSpecialHandlingRestrictionsWMP": null,
      "specialHandlingRestrictionsWMPContent": null,
      "profileNumber": 212720,
      "profileName": "New Profile #212720",
      "prodetail_cnt_id": 592111,
      "specificGravity": "1",
      "isProfilExpired": false,
      "approvalNumber": "",
      "disposalSite": "Company ABC",
      "disposalSiteId": 12162,
      "WPC": "6104",
      "empty_container": false,
      "vendorCode": "None",
      "Mainfest_Number": "22222",
      "Line_Number": "1",
      "containerType": "CF",
      "containerSize": "202 (G)",
      "containerSizeWeight": 20,
      "Container_Count": 1,
      "Converted_Value": 1704,
      "Container_Unit": "P",
      "shippingUnitOptions": [
        {
          "id": "N",
          "name": "N- Cubic Meters"
        }
      ],
      "Total_Volume": 202,
      "Total_Weight": 1704.68,
      "VUnit": "G",
      "WUnit": "P",
      "billing_weight_volume_count": 1,
      "line_total_using_min_price": false,
      "CostBasis_id": 2,
      "billingBasis": "Per Container",
      "showingBillingBasis": "Per Container",
      "Price": 0,
      "profile_billing_price": "0",
      "Line_total": 0,
      "Line_Status": null,
      "lineStatusOptions": [],
      "location": 70,
      "facilityOptions": [
        {
          "id": 70,
          "Name": "Company ABC"
        },
        {
          "id": 71,
          "Name": "Company ABCE"
        }
      ],
      "current_rcra_code": [
        "F001",
        "D001",
        "D002"
      ],
      "current_state_waste_code": [
        "ABZ"
      ],
      "current_state_rcra_code": null,
      "state_waste_code": {
        "ABZ": "ABZ"
      },
      "state_rcra_code": {
        "WCGF-1": "F001",
        "WCGIGNITABLE-D001": "D001",
        "WCGCORROSIVE-D002": "D002"
      },
      "default_state_waste_code_dic": {
        "ABZ": "ABZ"
      },
      "default_state_waste_code_rcra_dic": {
        "WCGF-1": "F001",
        "WCGIGNITABLE-D001": "D001",
        "WCGCORROSIVE-D002": "D002"
      },
      "stateRCRACode": "",
      "finalHandlingCode": "",
      "handlingCodeOptions": [
        {
          "id": 42,
          "Name": "H139",
          "Description": "OTHER DISPOSAL"
        }
      ],
      "ten_day_start_date": "",
      "ten_day_start_time": null,
      "Warehouse": null,
      "warehouseOptions": {
        "70": [
          {
            "id": 44,
            "Name": "Company ABC"
          }
        ],
        "71": [
          {
            "id": 45,
            "Name": "Company ABCE"
          }
        ]
      },
      "networkStatus": "Enterprise",
      "logisticsType": null,
      "suborderNumber": "616990-01",
      "networkFreightScheduledDate": "",
      "TSDFWorkOrderNumber": "",
      "genSignedDate": "",
      "TSDFSignedDate": "",
      "paperworkRequested": "No",
      "Sales_Tax": false,
      "Note": null,
      "using_emanifest": false,
      "inbound_mmp_id": null,
      "balance_detail_id": null,
      "inbound_containers": null,
      "final_handling_code": "",
      "rcra_code": [],
      "is_from_labpack_profile": true,
      "deletable": false,
      "childs": [],
      "is_edit": true,
      "transporter": "",
      "mmc": "",
      "is_manifest_in_outbount_shipment": false
    }
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": false,
  "items": ""
}

save_tax

save_tax
POST/api/generators/orders/{order_id}/save_tax/

Overview:

The save_tax endpoint, accessible at /api/generators/orders/{order_id}/save_tax/, is a POST request that is used to save the tax.

Request Body and Response Description:

Name Data Type Description
data array An array of data.
id number The unique identifier for the tax.
taxVheader string The tax Vheader.
Applied_Sales_Tax_Exempt boolean Indicates whether the sales tax is exempt.
Applied_Tax_ID string The applied tax ID.
Applied_Sales_Tax_Rate string The applied sales tax rate.
Amount number The amount.
is_applied_new_tax boolean Indicates whether the new tax is applied.

Example URI

POST [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/order_id/save_tax/
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "data": [
    {
      "id": 312215125,
      "taxVheader": "Sales Tax",
      "Applied_Sales_Tax_Exempt": false,
      "Applied_Tax_ID": null,
      "Applied_Sales_Tax_Rate": "8.25",
      "Amount": 3.3
    }
  ],
  "is_applied_new_tax": false
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true
}

save_fees

save_fees
POST/api/generators/orders/{order_id}/save_fees/

Overview:

The save_fees endpoint, accessible at /api/generators/orders/{order_id}/save_fees/, is a POST request that is used to save the fees.

Request Body and Response Description:

Name Data Type Description
data array An array of data.
id number The unique identifier for the fee.
Fee_id number The unique identifier for the fee.
Name string The name of the fee.
Type string The type of the fee.
Value string The value of the fee.
Apply string The application of the fee.
Amount number The amount.
is_applied_new_fees boolean Indicates whether the new fees are applied.

Example URI

POST [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/order_id/save_fees/
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "data": [
    {
      "id": 214999,
      "Fee_id": 3898,
      "Name": "EIS",
      "Type": "Rate",
      "Value": "14",
      "Apply": "Waste Material",
      "Amount": 0
    }
  ],
  "is_applied_new_fees": false
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true
}

save_order_status

save_order_status
POST/api/generators/orders/{order_id}/save_order_status

Overview:

The save_order_status endpoint, accessible at /api/generators/orders/{order_id}/save_order_status, is a POST request that is used to save the status of an order.

Request Body and Response Description:

Name Data Type Description
is_archived boolean Indicates whether the order is archived.
Inv_Rev_Req boolean Indicates whether the inventory review request is applicable.
Order_Confirmed boolean Indicates whether the order is confirmed.
Conf_Date_Time string The confirmation date and time.
Cash_On_Delivery boolean Indicates whether the cash on delivery is applicable.
Bill_Disposal_Facility boolean Indicates whether the bill disposal facility is applicable.
Paperwork boolean Indicates whether the paperwork is applicable.

Example URI

POST [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/order_id/save_order_status
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "is_archived": false,
  "Inv_Rev_Req": false,
  "Order_Confirmed": true,
  "Conf_Date_Time": "08/13/2024 12:00 AM",
  "Cash_On_Delivery": false,
  "Bill_Disposal_Facility": false,
  "Paperwork": false
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": []
}

save_transportation_schedule

save_transportation_schedule
POST/api/generators/orders/{order_id}/save_transportation_schedule/

Overview:

The save_transportation_schedule endpoint, accessible at /api/generators/orders/{order_id}/save_transportation_schedule/, is a POST request that is used to save the transportation schedule.

Request Body and Response Description:

Name Data Type Description
data object An object containing the details of the transportation schedule.
transaction string The transaction.
TS_Pick_Up_Date string The pick-up date.
TS_Pick_Up_Time string The pick-up time.
Pick_Up_Run_End_Date string The end date of the pick-up run.
PUP_Time_In string The time in for the pick-up.
PUP_Time_Out string The time out for the pick-up.
PUP_Stop_Time string The stop time for the pick-up.
DEL_Time_In string The time in for the delivery.
DEL_Time_Out string The time out for the delivery.
DEL_Stop_Time string The stop time for the delivery.
PTL_Time_Dpt_1 string The departure time for the first part load.
PTL_Time_Ret_1 string The return time for the first part load.
PTLToPTLHr_1 string The time between the first part load.
PTL_Time_Dpt_2 string The departure time for the second part load.
PTL_Time_Ret_2 string The return time for the second part load.
PTLToPTLHr_2 string The time between the second part load.
OutsideUSA boolean Indicates whether the location is outside the USA.
ForeignerAddress string The foreign address.
PK_Address1 string The address line 1 for the pick-up.
PK_Address2 string The address line 2 for the pick-up.
PK_City string The city for the pick-up.
PK_State string The state for the pick-up.
PK_Zone string The zone for the pick-up.
PK_Zone_id number The unique identifier for the zone.
pk_zone_zip string The zip code for the zone.
zip string The zip code.
page_view string The page view.
sub_order string The sub-order.

Example URI

POST [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/order_id/save_transportation_schedule/
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "data": {
    "transportation": [],
    "TS_Pick_Up_Date": "08/14/2024",
    "TS_Pick_Up_Time": "01:00 AM",
    "Pick_Up_Run_End_Date": "08/15/2024",
    "PUP_Time_In": "",
    "PUP_Time_Out": "",
    "PUP_Stop_Time": "",
    "DEL_Time_In": "",
    "DEL_Time_Out": "",
    "DEL_Stop_Time": "",
    "PTL_Time_Dpt_1": "",
    "PTL_Time_Ret_1": "",
    "PTLToPTLHr_1": "",
    "PTL_Time_Dpt_2": "",
    "PTL_Time_Ret_2": "",
    "PTLToPTLHr_2": "",
    "OutsideUSA": false,
    "ForeignerAddress": "",
    "PK_Address1": "132, My Street, Kingston, New York 12401.",
    "PK_Address2": "132, My Street, Kingston, New York 12401.",
    "PK_City": "Kingston",
    "PK_State": "NY",
    "PK_Zone": "Zone 1",
    "PK_Zone_id": 12401,
    "pk_zone_zip": "12401",
    "zip": "12401"
  },
  "page_view": "parent",
  "sub_order": "517575"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true
}

save_manifest_dot_info

save_manifest_dot_info
POST/api/generators/orders/save_manifest_dot_info/

Overview:

The save_manifest_dot_info endpoint, accessible at /api/generators/orders/save_manifest_dot_info/, is a POST request that is used to save the manifest DOT information.

Request Body and Response Description:

Name Data Type Description
data array An array of data.
id number The unique identifier for the manifest DOT information.
status string The status of the manifest DOT information.
Mainfest_Number string The manifest number.
Line_Number string The line number.
Final_TSDF__Name string The name of the final TSDF.
Description string The description.
Default boolean Indicates whether the manifest DOT information is the default.
default_description string The default description.
is_from_labpack_profile boolean Indicates whether the manifest DOT information is from the labpack profile.
CustomerProfile__Name string The name of the customer profile.
generic_US_DOT_comment string The generic US DOT comment.
is_network_exempt boolean Indicates whether the network is exempt.

Example URI

POST [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/save_manifest_dot_info/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "data": [
    [
      {
        "id": 692879,
        "status": 0,
        "Mainfest_Number": "22222",
        "Line_Number": "2",
        "Final_TSDF__Name": "Company ABC",
        "Description": "",
        "Default": true,
        "default_description": "",
        "is_from_labpack_profile": true,
        "CustomerProfile__Name": "New Profile #212719",
        "generic_US_DOT_comment": "",
        "is_network_exempt": true
      }
    ],
    []
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true
}

save_order_note

save_order_note
POST/api/generators/orders/{order_id}/save_order_note/

Overview:

The save_order_note endpoint, accessible at /api/generators/orders/{order_id}/save_order_note/, is a POST request that is used to save the order note.

Request Body and Response Description:

Name Data Type Description
data object An object containing the details of the order note.
Pickup_Instr_For_Driver string The pick-up instructions for the driver.
Internal_Notes string The internal notes.
Inv_Cmt_For_Cust string The inventory comment for the customer
Trans_Notes string The transportation notes.
Sec_14_per_15_Mainf_Cmt string The section 14 per 15 mainfest comment.
section32 array An array of section 32.

Example URI

POST [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/order_id/save_order_note/
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "data": {
    "Pickup_Instr_For_Driver": null,
    "Internal_Notes": null,
    "Inv_Cmt_For_Cust": null,
    "Trans_Notes": null,
    "Sec_14_per_15_Mainf_Cmt": "-",
    "section32": []
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true
}

save_weight_grade_lines

save_weight_grade_lines
POST/api/generators/orders/{order_id}/save_weight_grade_lines/

Overview:

The save_weight_grade_lines endpoint, accessible at /api/generators/orders/{order_id}/save_weight_grade_lines/, is a POST request that is used to save the weight grade lines.

Request Body and Response Description:

Name Data Type Description
data array An array of data.
id number The unique identifier for the data.
status string The status of the data.
manifest_no string The manifest number.
line string The line number.
edited_weight boolean Indicates whether the weight is edited.
pkid number The unique identifier for the data.
processing_detail_content_id number The unique identifier for the processing detail content.
orderNumber string The order number.
WPC string The WPC.
re_class string The re-class.
profileName string The profile name.
mmp_assignment_showingname string The MMP assignment showing name.
mmp_assignment string The MMP assignment.
mmp_assignmentOptions array An array of MMP assignment options.
id number The unique identifier for the MMP assignment option.
Name string The name of the MMP assignment option.
mmp_approved boolean Indicates whether the MMP is approved.
containerType string The container type.
containerSize string The container size.
cnt_id_no string The container ID number.
weight number The weight.
showingBillingBasis string The showing billing basis.
piece_count string The piece count.
actual_weight number The actual weight.
net_explosive_weight string The net explosive weight.
Grade string The grade.
scanComments string The scan comments.
inboundScanDate string The inbound scan date.
mmps array An array of MMPs.

Example URI

POST [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/order_id/save_weight_grade_lines/
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "data": [
    {
      "id": 3092480,
      "status": "2",
      "manifest_no": "22222",
      "line": "2",
      "edited_weight": false,
      "pkid": 1324483,
      "processing_detail_content_id": 592110,
      "orderNumber": "616990",
      "WPC": "6104",
      "re_class": "",
      "profileName": "New Profile #212719",
      "mmp_assignment_showingname": null,
      "mmp_assignment": null,
      "mmp_assignmentOptions": [
        {
          "id": 44,
          "Name": "Company ABC"
        }
      ],
      "mmp_approved": false,
      "containerType": "CF",
      "containerSize": "202",
      "cnt_id_no": "22222-2-1",
      "weight": 1,
      "showingBillingBasis": "Per Container",
      "piece_count": null,
      "actual_weight": 15,
      "net_explosive_weight": null,
      "Grade": null,
      "scanComments": "",
      "inboundScanDate": "",
      "mmps": []
    }
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true
}

project_cost

project_cost
POST/api/generators/orders/project_cost/{order_id}/

Overview:

The project_cost endpoint, accessible at /api/generators/orders/project_cost/{order_id}/, is a POST request that is used to project the cost of an order.

Request Body and Response Description:

Name Data Type Description
data array An array of data.
id number The unique identifier for the data.
CostCategory object An object containing the cost category.
id number The unique identifier for the cost category.
Name string The name of the cost category.
Broker number The broker.
Vendor string The vendor.
Transportation string The transportation.
action_status number The action status.
DisposalFacility object An object containing the disposal facility.
id number The unique identifier for the disposal facility.
Name string The name of the disposal facility.
ProjectCostCategory string The project cost category.
Description string The description.
Vendor_Invoice_Number string The vendor invoice number.
Quantity number The quantity.
Unit_Price string The unit price.
Committed_Cost number The committed cost.
Actual_Cost number The actual cost.
CostBasis string The cost basis.
invoice_order_linked_to string The invoice order linked to.
network_customer_order_linked_to string The network customer order linked to.
network_order_waste_line_linked_to string The network order waste line linked to.
network_order_ps_line_linked_to string The network order PS line linked to.
is_tax boolean Indicates whether the cost is tax.
applied_fee_id string The applied fee ID.
WasteMaterialPickupContent number The unique identifier for the waste material pickup content.
ProductServiceContent string The product service content.
CustomerOrder number The customer order.

Example URI

POST [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/project_cost/order_id/
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "data": [
    {
      "id": 1851330010877,
      "CostCategory": {
        "id": 220,
        "Name": "Disposal",
        "Broker": 31
      },
      "Vendor": null,
      "Transportation": null,
      "action_status": 1,
      "DisposalFacility": {
        "id": 12162,
        "Name": "Company ABC"
      },
      "ProjectCostCategory": null,
      "Description": "",
      "Vendor_Invoice_Number": "",
      "Quantity": 1,
      "Unit_Price": "30.00",
      "Committed_Cost": 30,
      "Actual_Cost": 0,
      "CostBasis": "Per Container",
      "invoice_order_linked_to": null,
      "network_customer_order_linked_to": null,
      "network_order_waste_line_linked_to": null,
      "network_order_ps_line_linked_to": null,
      "is_tax": false,
      "applied_fee_id": null,
      "WasteMaterialPickupContent": 1324483,
      "ProductServiceContent": null,
      "CustomerOrder": 577721
    }
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "newid": 726306
}

recurrence_save

recurrence_save
POST/api/generators/orders/recurrence/save/{order_id}/

Overview:

The recurrence_save endpoint, accessible at /api/generators/orders/recurrence/save/{order_id}/, is a POST request that is used to save the recurrence of an order.

Request Body and Response Description:

Name Data Type Description
Frequency string The frequency.
Daily_Type string The daily type.
Daily_Interval number The daily interval.
Weekly_Interval number The weekly interval.
Monthly_Type string The monthly type.
Monthly_DayInMonth number The monthly day in month.
Monthly_Interval number The monthly interval.
Monthly_Order string The monthly order.
Monthly_DaysOfWeek string The monthly days of the week.
Monthly_Interval_1 number The monthly interval 1.
Yearly_Interval number The yearly interval.
Yearly_Type string The yearly type.
Yearly_Month string The yearly month.
Yearly_DayInMonth number The yearly day in month.
Yearly_Order string The yearly order.
Yearly_DaysOfWeek string The yearly days of the week.
Yearly_Month_1 string The yearly month 1.
StartDate string The start date.
EndType string The end type.
End_Interval number The end interval.
End_Date string The end date.
IsAutofillOrder boolean Indicates whether the order is autofilled.
Name string The name.
success boolean Indicates whether the recurrence is saved.
action string The action.
id number The unique identifier for the recurrence.
message string The message.

Example URI

POST [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/recurrence/save/order_id/
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "Frequency": "Yearly",
  "Daily_Type": "Day",
  "Daily_Interval": 1,
  "Weekly_Interval": 1,
  "Monthly_Type": "DayInMonth",
  "Monthly_DayInMonth": 1,
  "Monthly_Interval": 1,
  "Monthly_Order": "1",
  "Monthly_DaysOfWeek": "0",
  "Monthly_Interval_1": 1,
  "Yearly_Interval": 1,
  "Yearly_Type": "DayInYear",
  "Yearly_Month": "1",
  "Yearly_DayInMonth": 1,
  "Yearly_Order": "1",
  "Yearly_DaysOfWeek": "0",
  "Yearly_Month_1": "1",
  "StartDate": "2024-08-13",
  "EndType": "End_Interval",
  "End_Interval": 10,
  "End_Date": "2034-01-01",
  "IsAutofillOrder": true,
  "Name": "test_api"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "action": "CREATE",
  "id": 9726,
  "message": "Save recurrence successfully"
}

save_discrepancies

save_discrepancies
POST/api/generators/orders/{order_id}/save_discrepancies/

Overview:

The save_discrepancies endpoint, accessible at /api/generators/orders/{order_id}/save_discrepancies/, is a POST request that is used to save the discrepancies of an order.

Request Body and Response Description:

Name Data Type Description
data array An array of data.
existing boolean Indicates whether the discrepancy is existing.
discrepancies_id string The unique identifier for the discrepancy.
manifest_number string The manifest number.
line_number string The line number.
discrepancy_type string The discrepancy type.
status string The status.
note string The note.
resolution string The resolution.
files array An array of files.
have_e_signed_documents boolean Indicates whether the e-signed documents are available.
have_signed_documents boolean Indicates whether the signed documents are available.
id string The unique identifier for the discrepancy.
success boolean Indicates whether the discrepancy is saved.
is_red_discrepancy boolean Indicates whether the discrepancy is red.

Example URI

POST [Orders APIs](https://test-api.wastelinq.com)./api/generators/orders/order_id/save_discrepancies/
URI Parameters
HideShow
order_id
number (required) 

The unique identifier for the order.

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "data": [
    {
      "existing": false,
      "discrepancies_id": "",
      "manifest_number": "22222",
      "line_number": "2",
      "discrepancy_type": "Quantity",
      "status": "In Progress",
      "note": "test",
      "resolution": "test",
      "files": [],
      "have_e_signed_documents": false,
      "have_signed_documents": false,
      "id": "d88ecfa0"
    }
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "is_red_discrepancy": true
}

Order Queue & Archived Orders

integ_esc_order_queue_list_10day

integ_esc_order_queue_list_10day
POST/api/orderqueue/integ_esc_order_queue_list_10day

Overview:

The integ_esc_order_queue_list_10day endpoint, accessible at /api/orderqueue/integ_esc_order_queue_list_10day, is a POST request that is used to retrieve the list of orders in the order queue for the last 10 days.

Request Body and Response Description:

Name Data Type Description
page number The page number.
pageSize number The page size.
getSelectedFields array An array of selected fields.
getFilteredFields array An array of filtered fields.
getSortedFields array An array of sorted fields.
fromDate string The from date.
toDate string The to date.
billto string The bill-to.
transp string The transporter.
facName string The facility name.
icomp boolean Indicates whether the order is completed.
success boolean Indicates whether the request is successful.
content array An array of content.
totalElements number The total number of elements.

Example URI

POST [Orders APIs](https://test-api.wastelinq.com)./api/orderqueue/integ_esc_order_queue_list_10day
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "page": 0,
  "pageSize": 10,
  "getSelectedFields": [],
  "getFilteredFields": [
    "all="
  ],
  "getSortedFields": [
    "Name asc"
  ],
  "fromDate": "",
  "toDate": "",
  "billto": "",
  "transp": "",
  "facName": "",
  "icomp": false
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [],
  "totalElements": 0
}

integ_esc_order_queue_list_direct

integ_esc_order_queue_list_direct
POST/api/orderqueue/integ_esc_order_queue_list_direct

Overview:

The integ_esc_order_queue_list_direct endpoint, accessible at /api/orderqueue/integ_esc_order_queue_list_direct, is a POST request used to retrieve the list of orders in the order queue direct outbound.

Request Body and Response Description:

Name Data Type Description
page number The page number.
pageSize number The page size.
getSelectedFields array An array of selected fields.
getFilteredFields array An array of filtered fields.
getSortedFields array An array of sorted fields.
fromDate string The from date.
toDate string The to date.
billto string The bill-to.
transp string The transporter.
icomp boolean Indicates whether the order is completed.
success boolean Indicates whether the request is successful.
content array An array of content.
totalElements number The total number of elements.

Example URI

POST [Orders APIs](https://test-api.wastelinq.com)./api/orderqueue/integ_esc_order_queue_list_direct
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "page": 0,
  "pageSize": 10,
  "getSelectedFields": [],
  "getFilteredFields": [
    "all="
  ],
  "getSortedFields": [],
  "fromDate": "",
  "toDate": "",
  "billto": "",
  "transp": "",
  "icomp": false
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [],
  "totalElements": 0
}

integ_esc_order_queue_list_shipment

integ_esc_order_queue_list_shipment
POST/api/orderqueue/integ_esc_order_queue_list_shipment

Overview:

The integ_esc_order_queue_list_shipment endpoint, accessible at /api/orderqueue/integ_esc_order_queue_list_shipment, is a POST request used to retrieve the list of orders in the order queue shipment.

Request Body and Response Description:

Name Data Type Description
page number The page number.
pageSize number The page size.
getSelectedFields array An array of selected fields.
getFilteredFields array An array of filtered fields.
getSortedFields array An array of sorted fields.
fromDate string The from date.
toDate string The to date.
des string The description.
shipnum string The shipment number.
facName string The facility name.
icomp boolean Indicates whether the order is completed.
success boolean Indicates whether the request is successful.
content array An array of content.
totalElements number The total number of elements.

Example URI

POST [Orders APIs](https://test-api.wastelinq.com)./api/orderqueue/integ_esc_order_queue_list_shipment
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "page": 0,
  "pageSize": 10,
  "getSelectedFields": [],
  "getFilteredFields": [
    "all="
  ],
  "getSortedFields": [],
  "fromDate": "",
  "toDate": "",
  "des": "",
  "shipnum": "",
  "facName": "",
  "icomp": false
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [],
  "totalElements": 0
}

integ_esc_order_queue_list_unmatched

integ_esc_order_queue_list_unmatched
POST/api/orderqueue/integ_esc_order_queue_list_unmatched

Overview:

The integ_esc_order_queue_list_unmatched endpoint, accessible at /api/orderqueue/integ_esc_order_queue_list_unmatched, is a POST request that is used to retrieve the list of unmatched orders in the order queue.

Request Body and Response Description:

Name Data Type Description
page number The page number.
pageSize number The page size.
getSelectedFields array An array of selected fields.
getFilteredFields array An array of filtered fields.
getSortedFields array An array of sorted fields.
fromDate string The from date.
toDate string The to date.
driver string The driver.
fname string The facility name.
type string The type.
icomp boolean Indicates whether the order is completed.
success boolean Indicates whether the request is successful.
content array An array of content.
totalElements number The total number of elements.

Example URI

POST [Orders APIs](https://test-api.wastelinq.com)./api/orderqueue/integ_esc_order_queue_list_unmatched
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "page": 0,
  "pageSize": 10,
  "getSelectedFields": [],
  "getFilteredFields": [
    "all="
  ],
  "getSortedFields": [],
  "fromDate": "",
  "toDate": "",
  "driver": "",
  "fname": "",
  "type": "",
  "icomp": false
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [],
  "totalElements": 0
}

archived

archived
POST/api/orders/esc/archived

Overview:

The archived endpoint, accessible at /api/orders/esc/archived, is a POST request that is used to retrieve the list of archived orders.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the request is successful.
totalElements number The total number of elements.
content array An array of content.
id number The unique identifier for the order.
Order_Number number The order number.
Manifests string The manifests.
Customer_Name string The customer name.
schedule_date string The schedule date.
Modifier string The modifier.
Order_Name string The order name.
Order_type string The order type.
Order_Logistics_Status string The order logistics status.
Customer_PO_Number string The customer PO number.
total_amount number The total amount.
total_invoice_amount number The total invoice amount.
order_contact_name string The order contact name.
Customer number The customer.
network_enterprise_field string The network enterprise field.
Date_Created string The date created.
sub_orders array An array of sub orders.
Being_Accessed boolean Indicates whether the order is being accessed.
Accessing_User_id number The unique identifier for the accessing user.
Accessing_User string The accessing user.
recurrenceState number The recurrence state.
schedule_date_formatted string The formatted schedule date.
extra_content object An object containing extra content.
override_system_lock boolean Indicates whether the system lock is overridden.
filter object An object containing the filter.
page number The page number.
pageSize number The page size.
sort string The sort.
search string The search.

Example URI

POST [Orders APIs](https://test-api.wastelinq.com)./api/orders/esc/archived
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "filter": {},
  "page": 0,
  "pageSize": 25,
  "sort": "Order_Number desc",
  "search": ""
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "totalElements": 16042,
  "content": [
    {
      "id": 293457,
      "Order_Number": 332726,
      "Manifests": "",
      "Customer_Name": "Company ABC",
      "schedule_date": "12/27/2021 12:00 AM",
      "Modifier": "janedoe",
      "Order_Name": "SALES TAX EXEMPT",
      "Order_type": "Waste",
      "Order_Logistics_Status": "Cancelled",
      "Customer_PO_Number": "50236-39401-710",
      "total_amount": 0,
      "total_invoice_amount": 0,
      "order_contact_name": "Jane Doe",
      "Customer": 39936,
      "network_enterprise_field": "",
      "Date_Created": "03/01/2022",
      "sub_orders": [],
      "Being_Accessed": false,
      "Accessing_User_id": null,
      "Accessing_User": null,
      "recurrenceState": 0,
      "schedule_date_formatted": "12/27/2021 12:00 AM"
    },
    {
      "id": 292877,
      "Order_Number": 332146,
      "Manifests": "",
      "Customer_Name": "Company ABC",
      "schedule_date": "01/13/2022 12:00 AM",
      "Modifier": "janedoe",
      "Order_Name": "1-13 trans for order #325860",
      "Order_type": "Waste",
      "Order_Logistics_Status": "Invoiced",
      "Customer_PO_Number": null,
      "total_amount": 709.5,
      "total_invoice_amount": 709.5,
      "order_contact_name": "Jane Doe",
      "Customer": 40876,
      "network_enterprise_field": "",
      "Date_Created": "02/25/2022",
      "sub_orders": [],
      "Being_Accessed": false,
      "Accessing_User_id": null,
      "Accessing_User": null,
      "recurrenceState": 0,
      "schedule_date_formatted": "01/13/2022 12:00 AM"
    }
  ],
  "extra_content": {
    "override_system_lock": true
  }
}

integ_order_queue_list_10day_facility

integ_order_queue_list_10day_facility
GET/api/orderqueue/integ_order_queue_list_10day_facility/

Overview:

The integ_order_queue_list_10day_facility endpoint, accessible at /api/orderqueue/integ_order_queue_list_10day_facility/, is a GET request that is used to retrieve the list of facilities in the order queue for the last 10 days.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the request is successful.
content array An array of content.
id number The unique identifier for the facility.
Name string The name of the facility.
totalElements number The total number of elements.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/orderqueue/integ_order_queue_list_10day_facility/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 71,
      "name": "Company A"
    },
    {
      "id": 70,
      "name": "Company B"
    },
    {
      "id": 345,
      "name": "Company C"
    }
  ],
  "totalElements": 3
}

integ_esc_order_queue_list_destination

integ_esc_order_queue_list_destination
GET/api/orderqueue/integ_esc_order_queue_list_destination/

Overview:

The integ_esc_order_queue_list_destination endpoint, accessible at /api/orderqueue/integ_esc_order_queue_list_destination/, is a GET request that is used to retrieve the list of destinations in the order queue.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the request is successful.
content array An array of content.
totalElements number The total number of elements.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/orderqueue/integ_esc_order_queue_list_destination/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [],
  "totalElements": 0
}

integ_esc_order_queue_list_billto

integ_esc_order_queue_list_billto
GET/api/orderqueue/integ_esc_order_queue_list_billto/

Overview:

The integ_esc_order_queue_list_billto endpoint, accessible at /api/orderqueue/integ_esc_order_queue_list_billto/, is a GET request that is used to retrieve the list of bill-to in the order queue.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the request is successful.
content array An array of content.
name string The name of the bill-to.
totalElements number The total number of elements.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/orderqueue/integ_esc_order_queue_list_billto/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "name": "Company ABC"
    }
  ],
  "totalElements": 1
}

integ_esc_order_queue_list_transporter

integ_esc_order_queue_list_transporter
GET/api/orderqueue/integ_esc_order_queue_list_transporter/

Overview:

The integ_esc_order_queue_list_transporter endpoint, accessible at /api/orderqueue/integ_esc_order_queue_list_transporter/, is a GET request that is used to retrieve the list of transporters in the order queue.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the request is successful.
content array An array of content.
id number The unique identifier for the transporter.
Name string The name of the transporter.
totalElements number The total number of elements.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/orderqueue/integ_esc_order_queue_list_transporter/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 551,
      "name": "GT"
    },
    {
      "id": 557,
      "name": "Jane Doe"
    }
  ],
  "totalElements": 2
}

integ_esc_order_queue_list_unmatched_driver

integ_esc_order_queue_list_unmatched_driver
GET/api/orderqueue/integ_esc_order_queue_list_unmatched_driver/

Overview:

The integ_esc_order_queue_list_unmatched_driver endpoint, accessible at /api/orderqueue/integ_esc_order_queue_list_unmatched_driver/, is a GET request that is used to retrieve the list of unmatched drivers in the order queue.

Request Body and Response Description:

Name Data Type Description
success boolean Indicates whether the request is successful.
content array An array of content.
id number The unique identifier for the driver.
Name string The name of the driver.
totalElements number The total number of elements.

Example URI

GET [Orders APIs](https://test-api.wastelinq.com)./api/orderqueue/integ_esc_order_queue_list_unmatched_driver/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": true,
  "content": [
    {
      "id": 752,
      "name": "jane"
    },
    {
      "id": 748,
      "name": "john"
    },
    {
      "id": 557,
      "name": "ken"
    },
    {
      "id": 559,
      "name": "rock"
    }
  ],
  "totalElements": 4
}

Generated by aglio on 14 Aug 2024