Outbound Shipments APIs

Overview ¶

The Outbound Shipments API is used to manage outbound shipments. It allows you to retrieve a list of outbound shipments, get a shipment by ID, filter shipments by destination, facility, common name, truck, disposal site, driver, and trailer, edit a shipment, and add a shipment. These are RESTFUL APIs that use the GET and POST methods to retrieve and update data.

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.

Outbound Shipments ¶

outbound_shipments ¶

outbound_shipments
GET`/api/shipments/outbound_shipments/{?page,pageSize,selectedFields,filter,sort}`

Overview:

The outbound_shipments endpoint, accessible at /api/shipments/outbound_shipments, is a GET request that is used to retrieve a list of outbound shipments.

Request Body and Response Description:

Name	Data Type	Description
success	boolean	Indicates whether the operation was successful.
content	array	An array of outbound shipments.
id	number	The unique identifier for the shipment.
shipment_number	number	The shipment number.
package_bulk	string	The package bulk.
shipment_date	string	The shipment date.
fromfacility	string	The facility the shipment is from.
destination	string	The destination of the shipment.
common_name	string	The common name.
shipped	string	Indicates whether the shipment has been shipped.
truck_assigned	string	The truck assigned to the shipment.
disposal_load	string	The disposal load.
trailer_number	string	The trailer number.
can_delete	boolean	Indicates whether the shipment can be deleted.
totalElements	number	The total number of elements.

Example URI

GET [Outbound Shipments APIs](https://test-api.wastelinq.com)./api/shipments/outbound_shipments/?page=&pageSize=&selectedFields=&filter=&sort=

URI Parameters

HideShow

page: number (optional)
The page number.
pageSize: number (optional)
The number of items per page.
selectedFields: string (optional)
The fields to be selected.
filter: string (optional)
The filter to be applied.
sort: string (optional)
The sort order.

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "id": 125157,
      "shipment_number": 108115,
      "package_bulk": "",
      "shipment_date": "08/15/2024",
      "fromfacility": "Company A",
      "destination": "Company B",
      "common_name": "",
      "shipped": "No",
      "truck_assigned": null,
      "disposal_load": null,
      "trailer_number": null,
      "can_delete": false
    }
  ],
  "totalElements": 8366
}

get_shipment ¶

get_shipment
GET`/api/shipments/get_shipment/{shipment_id}/{?esc_transfer}`

Overview:

The get_shipment endpoint, accessible at /api/shipments/get_shipment, is a GET request that is used to retrieve a shipment by ID.

Request Body and Response Description:

Name	Data Type	Description
success	boolean	Indicates whether the operation was successful.
content	object	The shipment details.
id	number	The unique identifier for the shipment.
shipment_number	number	The shipment number.
shipped	string	Indicates whether the shipment has been shipped.
shipment_date	string	The shipment date.
from_facility	number	The facility the shipment is from.
to_facility	number	The destination of the shipment.
packaged_bulk	string	The packaged bulk.
disposal_site	string	The disposal site.
select_manifest	string	The selected manifest.
truck_assigned	string	The truck assigned to the shipment.
trailer_number	string	The trailer number.
disposal_load_number	string	The disposal load number.
shipment_comments	string	The shipment comments.
driver	string	The driver.
third_party	string	The third party.
selected_driver_id	string	The selected driver ID.
is_active	boolean	Indicates whether the shipment is active.
created_date	string	The created date.
modified_date	string	The modified date.
modifier	string	The modifier.
broker_id	number	The broker ID.
is_wastelinq	boolean	Indicates whether the shipment is a WasteLinq shipment.
is_archived	boolean	Indicates whether the shipment is archived.
shipment_network_logistics	object	The shipment network logistics.
network_type	string	The network type.
esc_pickup_type	boolean	Indicates whether the pickup is an ESC pickup.
esc_pickup_ltl_pickup_day	string	The ESC pickup LTL pickup day.
wlq_ten_day_type	boolean	Indicates whether the shipment was the ten-day type.
wlq_ten_day_facility	string	The WasteLinq ten-day facility.
wlq_ten_day_dropoff_date	string	The WasteLinq ten-day drop-off date.
wlq_ten_day_dropoff_time	string	The WasteLinq ten-day drop-off time.
ltl_pickup_day	string	The LTL pickup day.
shipment_custom_fields	array	An array of custom fields.
id	number	The unique identifier for the custom field.
name	string	The name of the custom field.
value_id	number	The value ID.
value	string	The value of the custom field.
ship_items	array	An array of ship items.
id	number	The unique identifier for the ship item.
status	number	The status of the ship item.
shipid	number	The ship ID.
tsdf	number	The TSDF.
order_id	number	The order ID.
order_number	string	The order number.
shipping_manifest	string	The shipping manifest.
schedule_date	string	The schedule date.
customer_name	string	The customer name.
line_tsdf	string	The line TSDF.
manifest_disposal_no	string	The manifest disposal number.
apifiles	array	An array of API files.
webstatus	string	The web status.
ship_subitems	array	An array of ship subitems.
id	number	The unique identifier for the ship subitem.
sub_id	number	The sub ID.
sub_parentid	number	The sub parent ID.
order_number	string	The order number.
sub_manifest_no	string	The sub manifest number.
line	string	The line.
cnt_type	string	The container type.
cnt_size	string	The container size.
cnt_unit	string	The container unit.
cnt_count	number	The container count.
55equivalent	number	The 55 equivalent.
weight	number	The weight.
customer_name	string	The customer name.
profile	string	The profile.
pickupdate	string	The pickup date.
daysininventory	number	The days in inventory.
tsdf_id	number	The TSDF ID.
tsdf_name	string	The TSDF name.
common_name	string	The common name.
date	string	The date.
ordernumber	string	The order number.
facility	number	The facility.
isbulk	boolean	Indicates whether the shipment is bulk.
delete_ship_items	array	An array of deleted ship items.
gen_tsdf_signed_data	array	An array of generator TSDF signed data.

Example URI

GET [Outbound Shipments APIs](https://test-api.wastelinq.com)./api/shipments/get_shipment/shipment_id/?esc_transfer=

URI Parameters

HideShow

shipment_id: number (required)
The shipment ID.
esc_transfer: boolean (optional)
Indicates whether the transfer is an ESC transfer.

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": {
    "id": "125157",
    "shipment_number": 108115,
    "shipped": "No",
    "shipment_date": "08/15/2024",
    "from_facility": 71,
    "to_facility": 70,
    "packaged_bulk": "",
    "disposal_site": null,
    "select_manifest": null,
    "truck_assigned": null,
    "trailer_number": null,
    "disposal_load_number": null,
    "shipment_comments": null,
    "driver": null,
    "third_party": null,
    "selected_driver_id": "",
    "is_active": true,
    "created_date": "08/15/2024",
    "modified_date": "08/15/2024",
    "modifier": "Jane Doe",
    "broker_id": 31,
    "is_wastelinq": false,
    "is_archived": false,
    "shipment_network_logistics": {
      "network_type": "",
      "esc_pickup_type": false,
      "esc_pickup_ltl_pickup_day": null,
      "wlq_ten_day_type": false,
      "wlq_ten_day_facility": null,
      "wlq_ten_day_dropoff_date": null,
      "wlq_ten_day_dropoff_time": null,
      "ltl_pickup_day": null
    },
    "shipment_custom_fields": [
      {
        "id": 5,
        "name": "Refactor",
        "value_id": 693,
        "value": ""
      }
    ],
    "ship_items": [
      {
        "id": 324116,
        "status": 0,
        "shipid": 125157,
        "tsdf": 20442,
        "order_id": 445611,
        "order_number": "484880",
        "shipping_manifest": "22222",
        "schedule_date": "2023-03-28",
        "customer_name": "Company A",
        "line_tsdf": "Company A",
        "manifest_disposal_no": "",
        "apifiles": [],
        "webstatus": ""
      }
    ],
    "ship_subitems": [
      {
        "id": 980743,
        "sub_id": 980743,
        "sub_parentid": 324116,
        "order_number": "484880",
        "sub_manifest_no": "22222",
        "line": "1",
        "cnt_type": "BA",
        "cnt_size": "202",
        "cnt_unit": "P",
        "cnt_count": 20,
        "_55equivalent": 80,
        "weight": 40500,
        "customer_name": "Company A",
        "profile": "Magnesium Oxide (Product)",
        "pickupdate": "2023-03-28",
        "daysininventory": 454,
        "tsdf_id": 20442,
        "tsdf_name": "Company A",
        "common_name": null,
        "date": "2023-03-23",
        "ordernumber": "484880",
        "facility": 71,
        "isbulk": false
      }
    ],
    "delete_ship_items": [],
    "gen_tsdf_signed_data": []
  }
}

destination ¶

destination
GET`/api/shipments/filter/destination/`

Overview:

The destination endpoint, accessible at /api/shipments/filter/destination, is a GET request that is used to retrieve a list of destinations.

Request Body and Response Description:

Name	Data Type	Description
success	boolean	Indicates whether the operation was successful.
content	array	An array of destinations.
id	string	The unique identifier for the destination.
orginal_id	number	The original identifier for the destination.
name	string	The name of the destination.
type	string	The type of the destination.
totalElements	number	The total number of elements.

Example URI

GET [Outbound Shipments APIs](https://test-api.wastelinq.com)./api/shipments/filter/destination/

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "id": "0_71",
      "orginal_id": 71,
      "name": "Company A",
      "type": "facility"
    },
    {
      "id": "0_70",
      "orginal_id": 70,
      "name": "Company B",
      "type": "facility"
    }
  ],
  "totalElements": 126
}

from_facility ¶

from_facility
GET`/api/shipments/filter/from_facility/{?outbound_id,esc_transfer}`

Overview:

The from_facility endpoint, accessible at /api/shipments/filter/from_facility, is a GET request that is used to retrieve a list of facilities.

Request Body and Response Description:

Name	Data Type	Description
success	boolean	Indicates whether the operation was successful.
content	array	An array of facilities.
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 [Outbound Shipments APIs](https://test-api.wastelinq.com)./api/shipments/filter/from_facility/?outbound_id=&esc_transfer=

URI Parameters

HideShow

outbound_id: number (optional)
The outbound ID.
esc_transfer: boolean (optional)
Indicates whether the transfer is an ESC transfer.

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"
    }
  ],
  "totalElements": 2
}

common_name ¶

common_name
GET`/api/shipments/filter/common_name/`

Overview:

The common_name endpoint, accessible at /api/shipments/filter/common_name, is a GET request that is used to retrieve a list of common names.

Request Body and Response Description:

Name	Data Type	Description
success	boolean	Indicates whether the operation was successful.
content	array	An array of common names.
id	number	The unique identifier for the common name.
name	string	The name of the common name.
totalElements	number	The total number of elements.

Example URI

GET [Outbound Shipments APIs](https://test-api.wastelinq.com)./api/shipments/filter/common_name/

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "id": 9793,
      "Name": "Company A"
    },
    {
      "id": 23404,
      "Name": "Company B"
    }
  ],
  "totalElements": 70
}

filter_trucks ¶

filter_trucks
GET`/api/shipments/filter/filter_trucks/{?outbound_id,esc_transfer}`

Overview:

The filter_trucks endpoint, accessible at /api/shipments/filter/filter_trucks, is a GET request that is used to retrieve a list of trucks.

Request Body and Response Description:

Name	Data Type	Description
success	boolean	Indicates whether the operation was successful.
content	array	An array of trucks.
id	number	The unique identifier for the truck.
Name	string	The name of the truck.
totalElements	number	The total number of elements.

Example URI

GET [Outbound Shipments APIs](https://test-api.wastelinq.com)./api/shipments/filter/filter_trucks/?outbound_id=&esc_transfer=

URI Parameters

HideShow

outbound_id: number (optional)
The outbound ID.
esc_transfer: boolean (optional)
Indicates whether the transfer is an ESC transfer.

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "id": 302,
      "Name": "115 - [2007 Peterbilt 378 R/O Truck]"
    },
    {
      "id": 307,
      "Name": "122 - [2015 Mack 3-M8653]"
    }
  ],
  "totalElements": 29
}

filter_disposal_site ¶

filter_disposal_site
GET`/api/shipments/filter/filter_disposal_site/{?outbound_id,from_facility,esc_transfer}`

Overview:

The filter_disposal_site endpoint, accessible at /api/shipments/filter/filter_disposal_site, is a GET request that is used to retrieve a list of disposal sites.

Request Body and Response Description:

Name	Data Type	Description
success	boolean	Indicates whether the operation was successful.
content	array	An array of disposal sites.
id	number	The unique identifier for the disposal site.
Name	string	The name of the disposal site.
color	string	The color of the disposal site.
totalElements	number	The total number of elements.

Example URI

GET [Outbound Shipments APIs](https://test-api.wastelinq.com)./api/shipments/filter/filter_disposal_site/?outbound_id=&from_facility=&esc_transfer=

URI Parameters

HideShow

outbound_id: number (optional)
The outbound ID.
from_facility: number (optional)
The facility the shipment is from.
esc_transfer: boolean (optional)
Indicates whether the transfer is an ESC transfer.

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "id": 20442,
      "Name": "Company A"
    },
    {
      "id": 21315,
      "Name": "Company B",
      "color": "black"
    }
  ],
  "totalElements": 406
}

filter_drivers ¶

filter_drivers
GET`/api/shipments/filter/filter_drivers/{?outbound_id,esc_transfer}`

Overview:

The filter_drivers endpoint, accessible at /api/shipments/filter/filter_drivers, is a GET request that is used to retrieve a list of drivers.

Request Body and Response Description:

Name	Data Type	Description
success	boolean	Indicates whether the operation was successful.
content	array	An array of drivers.
id	number	The unique identifier for the driver.
orginal_id	number	The original identifier for the driver.
name	string	The name of the driver.
type	string	The type of the driver.
totalElements	number	The total number of elements.

Example URI

GET [Outbound Shipments APIs](https://test-api.wastelinq.com)./api/shipments/filter/filter_drivers/?outbound_id=&esc_transfer=

URI Parameters

HideShow

outbound_id: number (optional)
The outbound ID.
esc_transfer: boolean (optional)
Indicates whether the transfer is an ESC transfer.

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "id": "0_536",
      "orginal_id": 536,
      "name": "Jane Doe",
      "type": "Driver"
    },
    {
      "id": "0_567",
      "orginal_id": 567,
      "name": "John Doe",
      "type": "Driver"
    }
  ],
  "totalElements": 87
}

filter_trailers ¶

filter_trailers
GET`/api/shipments/filter/filter_trailers/{?outbound_id,esc_transfer}`

Overview:

The filter_trailers endpoint, accessible at /api/shipments/filter/filter_trailers, is a GET request that is used to retrieve a list of trailers.

Request Body and Response Description:

Name	Data Type	Description
success	boolean	Indicates whether the operation was successful.
content	array	An array of trailers.
id	number	The unique identifier for the trailer.
Name	string	The name of the trailer.
totalElements	number	The total number of elements.

Example URI

GET [Outbound Shipments APIs](https://test-api.wastelinq.com)./api/shipments/filter/filter_trailers/?outbound_id=&esc_transfer=

URI Parameters

HideShow

outbound_id: number (optional)
The outbound ID.
esc_transfer: boolean (optional)
Indicates whether the transfer is an ESC transfer.

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": [
    {
      "id": 645,
      "Name": "201 - [1981 Trim 40']"
    },
    {
      "id": 636,
      "Name": "204 - [1989 Trailmobile 48' W/LG]"
    }
  ],
  "totalElements": 32
}

filter_facility ¶

filter_facility
GET`/api/shipments/filter/filter_facility/{?outbound_id,esc_transfer}`

Overview:

The filter_facility endpoint, accessible at /api/shipments/filter/filter_facility, is a GET request that is used to retrieve a list of facilities.

Request Body and Response Description:

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

Example URI

GET [Outbound Shipments APIs](https://test-api.wastelinq.com)./api/shipments/filter/filter_facility/?outbound_id=&esc_transfer=

URI Parameters

HideShow

outbound_id: number (optional)
The outbound ID.
esc_transfer: boolean (optional)
Indicates whether the transfer is an ESC transfer.

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",
      "is_wastelinq": false
    },
    {
      "id": 70,
      "Name": "Company B",
      "is_wastelinq": false
    },
    {
      "id": 345,
      "Name": "Company C",
      "is_wastelinq": true
    }
  ],
  "totalElements": 3
}

edit_shipment ¶

edit_shipment
POST`/api/shipments/edit_shipment/{?esc_transfer}`

Overview:

The edit_shipment endpoint, accessible at /api/shipments/edit_shipment, is a POST request that is used to edit a shipment.

Request Body and Response Description:

Name	Data Type	Description
success	boolean	Indicates whether the operation was successful.
content	object	The shipment details.
id	number	The unique identifier for the shipment.
shipment_number	number	The shipment number.
shipped	string	Indicates whether the shipment has been shipped.
shipment_date	string	The shipment date.
from_facility	number	The facility the shipment is from.
to_facility	number	The destination of the shipment.
packaged_bulk	string	The packaged bulk.
disposal_site	string	The disposal site.
select_manifest	string	The selected manifest.
truck_assigned	string	The truck assigned to the shipment.
trailer_number	string	The trailer number.
disposal_load_number	string	The disposal load number.
shipment_comments	string	The shipment comments.
driver	string	The driver.
third_party	string	The third party.
selected_driver_id	string	The selected driver ID.
is_active	boolean	Indicates whether the shipment is active.
created_date	string	The created date.
modified_date	string	The modified date.
modifier	string	The modifier.
broker_id	number	The broker ID.
is_wastelinq	boolean	Indicates whether the shipment is a WasteLinq shipment.
is_archived	boolean	Indicates whether the shipment is archived.
shipment_network_logistics	object	The shipment network logistics.
network_type	string	The network type.
esc_pickup_type	boolean	Indicates whether the pickup is an ESC pickup.
esc_pickup_ltl_pickup_day	string	The ESC pickup LTL pickup day.
wlq_ten_day_type	boolean	Indicates whether the shipment was the ten-day type.
wlq_ten_day_facility	string	The WasteLinq ten-day facility.
wlq_ten_day_dropoff_date	string	The WasteLinq ten-day drop-off date.
wlq_ten_day_dropoff_time	string	The WasteLinq ten-day drop-off time.
ltl_pickup_day	string	The LTL pickup day.
shipment_custom_fields	array	An array of custom fields.
id	number	The unique identifier for the custom field.
name	string	The name of the custom field.
value_id	number	The value ID.
value	string	The value of the custom field.
ship_items	array	An array of ship items.
id	number	The unique identifier for the ship item.
status	number	The status of the ship item.
shipid	number	The ship ID.
tsdf	number	The TSDF.
order_id	number	The order ID.
order_number	string	The order number.
shipping_manifest	string	The shipping manifest.
schedule_date	string	The schedule date.
customer_name	string	The customer name.
line_tsdf	string	The line TSDF.
manifest_disposal_no	string	The manifest disposal number.
apifiles	array	An array of API files.
webstatus	string	The web status.
ship_subitems	array	An array of ship subitems.
id	number	The unique identifier for the ship subitem.
sub_id	number	The sub ID.
sub_parentid	number	The sub parent ID.
order_number	string	The order number.
sub_manifest_no	string	The sub manifest number.
line	string	The line.
cnt_type	string	The container type.
cnt_size	string	The container size.
cnt_unit	string	The container unit.
cnt_count	number	The container count.
55equivalent	number	The 55 equivalent.
weight	number	The weight.
customer_name	string	The customer name.
profile	string	The profile.
pickupdate	string	The pickup date.
daysininventory	number	The days in inventory.
tsdf_id	number	The TSDF ID.
tsdf_name	string	The TSDF name.
common_name	string	The common name.
date	string	The date.
ordernumber	string	The order number.
facility	number	The facility.
isbulk	boolean	Indicates whether the shipment is bulk.
delete_ship_items	array	An array of deleted ship items.
gen_tsdf_signed_data	array	An array of generator TSDF signed data.

Example URI

POST [Outbound Shipments APIs](https://test-api.wastelinq.com)./api/shipments/edit_shipment/?esc_transfer=

URI Parameters

HideShow

esc_transfer: boolean (optional)
Indicates whether the transfer is an ESC transfer.

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Body

{
  "id": "125157",
  "shipment_number": 108115,
  "shipped": "No",
  "shipment_date": "08/15/2024",
  "from_facility": 71,
  "to_facility": 70,
  "packaged_bulk": "",
  "disposal_site": null,
  "select_manifest": null,
  "truck_assigned": null,
  "trailer_number": null,
  "disposal_load_number": null,
  "shipment_comments": null,
  "driver": null,
  "third_party": null,
  "selected_driver_id": "",
  "is_active": true,
  "created_date": "08/15/2024",
  "modified_date": "08/15/2024",
  "modifier": "Jane Doe",
  "broker_id": 31,
  "is_wastelinq": false,
  "is_archived": false,
  "shipment_network_logistics": {
    "network_type": "",
    "esc_pickup_type": false,
    "esc_pickup_ltl_pickup_day": null,
    "wlq_ten_day_type": false,
    "wlq_ten_day_facility": null,
    "wlq_ten_day_dropoff_date": null,
    "wlq_ten_day_dropoff_time": null,
    "ltl_pickup_day": null
  },
  "shipment_custom_fields": [
    {
      "id": 5,
      "name": "Refactor",
      "value_id": 693,
      "value": ""
    }
  ],
  "ship_items": [
    {
      "id": 324116,
      "status": 0,
      "shipid": 125157,
      "tsdf": 20442,
      "order_id": 445611,
      "order_number": "484880",
      "shipping_manifest": "22222",
      "schedule_date": "2023-03-28",
      "customer_name": "Company A",
      "line_tsdf": "Company A",
      "manifest_disposal_no": "",
      "apifiles": [],
      "webstatus": ""
    }
  ],
  "ship_subitems": [
    {
      "id": 980743,
      "sub_id": 980743,
      "sub_parentid": 324116,
      "order_number": "484880",
      "sub_manifest_no": "22222",
      "line": "1",
      "cnt_type": "BA",
      "cnt_size": "202",
      "cnt_unit": "P",
      "cnt_count": 20,
      "_55equivalent": 80,
      "weight": 40500,
      "customer_name": "Company A",
      "profile": "Magnesium Oxide (Product)",
      "pickupdate": "2023-03-28",
      "daysininventory": 454,
      "tsdf_id": 20442,
      "tsdf_name": "Company A",
      "common_name": null,
      "date": "2023-03-23",
      "ordernumber": "484880",
      "facility": 71,
      "isbulk": false
    }
  ],
  "delete_ship_items": [],
  "gen_tsdf_signed_data": []
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": {
    "id": "125157",
    "shipment_number": 108115,
    "shipped": "No",
    "shipment_date": "08/15/2024",
    "from_facility": 71,
    "to_facility": 70,
    "packaged_bulk": "",
    "disposal_site": null,
    "select_manifest": null,
    "truck_assigned": null,
    "trailer_number": null,
    "disposal_load_number": null,
    "shipment_comments": null,
    "driver": null,
    "third_party": null,
    "selected_driver_id": "",
    "is_active": true,
    "created_date": "08/15/2024",
    "modified_date": "08/16/2024",
    "modifier": "kien dao",
    "broker_id": 31,
    "is_wastelinq": false,
    "is_archived": false,
    "shipment_network_logistics": {
      "network_type": "",
      "esc_pickup_type": false,
      "esc_pickup_ltl_pickup_day": null,
      "wlq_ten_day_type": false,
      "wlq_ten_day_facility": null,
      "wlq_ten_day_dropoff_date": null,
      "wlq_ten_day_dropoff_time": null,
      "ltl_pickup_day": null
    },
    "shipment_custom_fields": [
      {
        "id": 5,
        "name": "Refactor",
        "value_id": 693,
        "value": ""
      }
    ],
    "ship_items": [
      {
        "id": 324116,
        "status": 0,
        "shipid": 125157,
        "tsdf": 20442,
        "order_id": 445611,
        "order_number": "484880",
        "shipping_manifest": "22222",
        "schedule_date": "2023-03-28",
        "customer_name": "Company A",
        "line_tsdf": "Company A",
        "manifest_disposal_no": "",
        "apifiles": [],
        "webstatus": ""
      }
    ],
    "ship_subitems": [
      {
        "id": 980743,
        "sub_id": 980743,
        "sub_parentid": 324116,
        "order_number": "484880",
        "sub_manifest_no": "22222",
        "line": "1",
        "cnt_type": "BA",
        "cnt_size": "202",
        "cnt_unit": "P",
        "cnt_count": 20,
        "_55equivalent": 80,
        "weight": 40500,
        "customer_name": "Company A",
        "profile": "Magnesium Oxide (Product)",
        "pickupdate": "2023-03-28",
        "daysininventory": 454,
        "tsdf_id": 20442,
        "tsdf_name": "Company A",
        "common_name": null,
        "date": "2023-03-23",
        "ordernumber": "484880",
        "facility": 71,
        "isbulk": false
      }
    ],
    "delete_ship_items": [],
    "gen_tsdf_signed_data": []
  }
}

add_shipment ¶

add_shipment
POST`/api/shipments/add_shipment/`

Overview:

The add_shipment endpoint, accessible at /api/shipments/add_shipment, is a POST request that is used to add a shipment.

Request Body and Response Description:

Name	Data Type	Description
success	boolean	Indicates whether the operation was successful.
content	object	The shipment details.
id	number	The unique identifier for the shipment.
shipment_number	number	The shipment number.
shipped	string	Indicates whether the shipment has been shipped.
shipment_date	string	The shipment date.
from_facility	number	The facility the shipment is from.
to_facility	number	The destination of the shipment.
packaged_bulk	string	The packaged bulk.
disposal_site	string	The disposal site.
select_manifest	string	The selected manifest.
truck_assigned	string	The truck assigned to the shipment.
trailer_number	string	The trailer number.
disposal_load_number	string	The disposal load number.
shipment_comments	string	The shipment comments.
driver	string	The driver.
third_party	string	The third party.
selected_driver_id	string	The selected driver ID.
is_active	boolean	Indicates whether the shipment is active.
created_date	string	The created date.
modified_date	string	The modified date.
modifier	string	The modifier.
broker_id	number	The broker ID.
is_wastelinq	boolean	Indicates whether the shipment is a WasteLinq shipment.
is_archived	boolean	Indicates whether the shipment is archived.
shipment_network_logistics	object	The shipment network logistics.
network_type	string	The network type.
esc_pickup_type	boolean	Indicates whether the pickup is an ESC pickup.
esc_pickup_ltl_pickup_day	string	The ESC pickup LTL pickup day.
wlq_ten_day_type	boolean	Indicates whether the shipment was the ten-day type.
wlq_ten_day_facility	string	The WasteLinq ten-day facility.
wlq_ten_day_dropoff_date	string	The WasteLinq ten-day drop-off date.
wlq_ten_day_dropoff_time	string	The WasteLinq ten-day drop-off time.
ltl_pickup_day	string	The LTL pickup day.
shipment_custom_fields	array	An array of custom fields.
id	number	The unique identifier for the custom field.
name	string	The name of the custom field.
value_id	number	The value ID.
value	string	The value of the custom field.
ship_items	array	An array of ship items.
ship_subitems	array	An array of ship subitems.
delete_ship_items	array	An array of deleted ship items.
gen_tsdf_signed_data	array	An array of generator TSDF signed data.

Example URI

POST [Outbound Shipments APIs](https://test-api.wastelinq.com)./api/shipments/add_shipment/

Request

HideShow

Headers

Content-Type: application/json
Authorization: {TOKEN}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "content": {
    "id": 125158,
    "shipment_number": 108116,
    "shipped": "No",
    "shipment_date": "",
    "from_facility": null,
    "to_facility": null,
    "packaged_bulk": "",
    "disposal_site": null,
    "select_manifest": null,
    "truck_assigned": null,
    "trailer_number": null,
    "disposal_load_number": null,
    "shipment_comments": null,
    "driver": null,
    "third_party": null,
    "selected_driver_id": "",
    "is_active": false,
    "created_date": "08/16/2024",
    "modified_date": "08/16/2024",
    "modifier": "kien dao",
    "broker_id": 31,
    "is_wastelinq": false,
    "is_archived": false,
    "shipment_network_logistics": {
      "network_type": "",
      "esc_pickup_type": false,
      "esc_pickup_ltl_pickup_day": null,
      "wlq_ten_day_type": false,
      "wlq_ten_day_facility": null,
      "wlq_ten_day_dropoff_date": null,
      "wlq_ten_day_dropoff_time": null,
      "ltl_pickup_day": null
    },
    "shipment_custom_fields": [
      {
        "id": 5,
        "name": "Refactor",
        "value_id": "",
        "value": ""
      }
    ],
    "ship_items": [],
    "ship_subitems": [],
    "delete_ship_items": [],
    "gen_tsdf_signed_data": []
  }
}

Menu ¶

Other APIs docs ¶

Overview ¶

Bearer Token ¶

Error Messages ¶

Outbound Shipments ¶

outbound_shipments ¶

outbound_shipmentsGET/api/shipments/outbound_shipments/{?page,pageSize,selectedFields,filter,sort}

Overview: ¶

Request Body and Response Description: ¶

Example URI

Headers

Headers

Body

get_shipment ¶

get_shipmentGET/api/shipments/get_shipment/{shipment_id}/{?esc_transfer}

Overview: ¶

Request Body and Response Description: ¶

Example URI

Headers

Headers

Body

destination ¶

destinationGET/api/shipments/filter/destination/

Overview: ¶

Request Body and Response Description: ¶

Example URI

Headers

Headers

Body

from_facility ¶

from_facilityGET/api/shipments/filter/from_facility/{?outbound_id,esc_transfer}

Overview: ¶

Request Body and Response Description: ¶

Example URI

Headers

Headers

Body

common_name ¶

common_nameGET/api/shipments/filter/common_name/

Overview: ¶

Request Body and Response Description: ¶

Example URI

Headers

Headers

Body

filter_trucks ¶

filter_trucksGET/api/shipments/filter/filter_trucks/{?outbound_id,esc_transfer}

Overview: ¶

Request Body and Response Description: ¶

Example URI

Headers

Headers

Body

filter_disposal_site ¶

filter_disposal_siteGET/api/shipments/filter/filter_disposal_site/{?outbound_id,from_facility,esc_transfer}

Overview: ¶

Request Body and Response Description: ¶

Example URI

Headers

Headers

Body

filter_drivers ¶

filter_driversGET/api/shipments/filter/filter_drivers/{?outbound_id,esc_transfer}

Overview: ¶

Request Body and Response Description: ¶

Example URI

Headers

Headers

Body

filter_trailers ¶

filter_trailersGET/api/shipments/filter/filter_trailers/{?outbound_id,esc_transfer}

Overview: ¶

Request Body and Response Description: ¶

Example URI

Headers

Headers

Body

filter_facility ¶

filter_facilityGET/api/shipments/filter/filter_facility/{?outbound_id,esc_transfer}

Other APIs docs

Bearer Token

Error Messages

outbound_shipments
GET`/api/shipments/outbound_shipments/{?page,pageSize,selectedFields,filter,sort}`

Overview:

Request Body and Response Description:

get_shipment
GET`/api/shipments/get_shipment/{shipment_id}/{?esc_transfer}`

Overview:

Request Body and Response Description:

destination
GET`/api/shipments/filter/destination/`

Overview:

Request Body and Response Description:

from_facility
GET`/api/shipments/filter/from_facility/{?outbound_id,esc_transfer}`

Overview:

Request Body and Response Description:

common_name
GET`/api/shipments/filter/common_name/`

Overview:

Request Body and Response Description:

filter_trucks
GET`/api/shipments/filter/filter_trucks/{?outbound_id,esc_transfer}`

Overview:

Request Body and Response Description:

filter_disposal_site
GET`/api/shipments/filter/filter_disposal_site/{?outbound_id,from_facility,esc_transfer}`

Overview:

Request Body and Response Description:

filter_drivers
GET`/api/shipments/filter/filter_drivers/{?outbound_id,esc_transfer}`

Overview:

Request Body and Response Description:

filter_trailers
GET`/api/shipments/filter/filter_trailers/{?outbound_id,esc_transfer}`

Overview:

Request Body and Response Description:

filter_facility
GET`/api/shipments/filter/filter_facility/{?outbound_id,esc_transfer}`

Overview:

Request Body and Response Description:

edit_shipment
POST`/api/shipments/edit_shipment/{?esc_transfer}`

Overview:

Request Body and Response Description:

add_shipment
POST`/api/shipments/add_shipment/`

Overview:

Request Body and Response Description: