Back to top

Order Supplies APIs

Overview

Welcome to the Order Supplies API section of the Wastelinq API suite. This collection of APIs is specifically designed to manage and interact with supply orders within the Wastelinq system.

The Order Supplies API provides functionalities such as creating, updating, retrieving, and deleting supply orders. It allows for efficient management of supply orders, enabling seamless integration with other systems or services.

Each API endpoint in this section corresponds to a unique functionality related to supply orders. The response from each API call includes specific fields and data types, providing detailed information about the supply orders.

For comprehensive documentation of each API, follow the respective link provided in the APIs section.

For more detailed information on the structure of requests and responses, please refer to the individual API sections.

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.

APIs

Order Catalog Product Type

Order Catalog Product Type
GET/api/ordersupplie/order_catalog_product_type/

Overview:

Retrieve data from the database to load into the Product Type table.

Response Description:

Name Data Type Description
success boolean Indicates if the request was successful (true/false)
content array Array containing response data
id numeric Unique identifier for each item in the content array
name string Name of the item

Example URI

GET https://test-api.wastelinq.com/api/ordersupplie/order_catalog_product_type/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": "true",
  "content": [
    {
      "id": 5,
      "name": "Analytical"
    }
  ]
}

Order Catalog Product Sub Type

Order Catalog Product Sub Type
GET/api/ordersupplie/order_catalog_product_sub_type/

Overview:

Retrieve data from the database to load into the Product Type table.

Response Description:

Name Data Type Description
success boolean Indicates if the request was successful (true/false)
content array Array containing response data
id numeric Unique identifier for each item in the content array
name string Name of the item

Example URI

GET https://test-api.wastelinq.com/api/ordersupplie/order_catalog_product_sub_type/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": "true",
  "content": [
    {
      "id": 8,
      "name": "Absorbent and Vermiculite"
    }
  ]
}

Order Catalog

Order Catalog
GET/api/ordersupplie/order_catalog?page=0&pageSize=10&filter=producttype=,subtype=,brokerid=0

Overview:

Retrieve data from the database to load into the Catalog table.

Response Description:

Name Data Type Description
success boolean Indicates if the request was successful (true/false)
content array Array containing response data
id numeric Unique identifier for each item in the content array
description string Description of the item
title string Title/name of the item
image string URL of the image for the item
price string Price of the item
discount numeric Discount percentage applied
bookprice string Calculated price after discount
productdetail string Details of the product like material, size etc.
unitofmeasure string Unit the item is measured in
subtype string Sub-category the item belongs to
unrating string UN rating of the item
amount numeric Quantity of the item
inoutstock string Stock status
totalElements numeric Total number of elements in the collection

Example URI

GET https://test-api.wastelinq.com/api/ordersupplie/order_catalog?page=0&pageSize=10&filter=producttype=,subtype=,brokerid=0
URI Parameters
HideShow
page
number (required) Example: 0

The page number for pagination

pageSize
number (required) Example: 10

The number of items per page

filter
string (optional) Example: producttype=,subtype=,brokerid=0

The filter query

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": "true",
  "content": [
    {
      "id": 19157,
      "description": "05 Gallon, Poly Pail, Open Top with Screw Top Lid (Black)",
      "title": "23001",
      "image": "https://upload/broker_documents/23001_-_Pipeline_Packaging_-_5_Gallon_Open_Top_Poly_Pail_with_Screw_Top_Lid_Black.jpeg",
      "price": "12.05",
      "discount": 15,
      "bookprice": "10.24",
      "productdetail": "Capacity: 5 gal\nColor: Black\nMaterial: High-Density Polyethylene\nStyle: Screw Top\nShape: Round\nUN Rating: 1H2\nCountry of Origin: USA\nHandle: Plastic Handle\nCover: Cover\nPallet Qty: 120",
      "unitofmeasure": "Each",
      "subtype": "Pails",
      "unrating": "",
      "amount": 1,
      "inoutstock": "In Stock"
    }
  ],
  "totalElements": 1
}

Order Catalog Cart

Order Catalog Cart
GET/api/ordersupplie/order_catalog_cart/

Overview:

This API is used to load the current user’s shopping cart.

Response Description:

Name Data Type Description
success boolean Indicates if the request was successful (true/false)
content array Array containing response data
id numeric Unique identifier for each item in the content array
description string Description of the item
title string Title/name of the item
image string URL of the image for the item
price string Price of the item
discount numeric Discount percentage applied
bookprice string Calculated price after discount
productdetail string Details of the product like capacity, material etc.
unitofmeasure string Unit the item is measured in
subtype string Sub-category the item belongs to
amount numeric Quantity of the item
unrating string UN rating of the item
inoutstock string Stock status
ordId numeric Order ID

Example URI

GET https://test-api.wastelinq.com/api/ordersupplie/order_catalog_cart/
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": "true",
  "content": [
    {
      "id": 6318,
      "description": "55 Gallon, Poly Drum, Open Top with Bolt (Blue) ",
      "title": "24291",
      "image": "https://upload/broker_documents/24281.jpeg",
      "price": "87.23",
      "discount": 15,
      "bookprice": "74.15",
      "productdetail": "Capacity\t55 gal\nColor\tBlue\nMaterial\tHDPE\nStyle\tOpen Head\nUN Rating\t1H2/X300/S\nCover\tBlue Plain Cover\nWeight\t25.5 lbs\nPallet Qty\t8\nCountry of Origin\tUSA",
      "unitofmeasure": "Each",
      "subtype": "Drums",
      "amount": 1,
      "unrating": "1H2/X300/S, ",
      "inoutstock": "In Stock"
    }
  ],
  "ordId": 890
}

Order Catalog Add To Cart

Order Catalog Add To Cart
POST/api/ordersupplie/order_catalog_add_to_cart

Overview:

This API is used to add items from the Catalog table to the user’s shopping cart.

Response Description:

Name Data Type Description
id boolean Unique identifier for this request
ordId numeric Order ID
qty numeric Total quantity of items in this request
success boolean Indicates if the request was successful (true/false)
ordId numeric Order ID

Example URI

POST https://test-api.wastelinq.com/api/ordersupplie/order_catalog_add_to_cart
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": 19157,
  "ordId": 0,
  "qty": 1
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": "true",
  "ordId": 891
}

Order Catalog Empty Cart

Order Catalog Empty Cart
POST/api/ordersupplie/order_catalog_empty_cart

Overview:

This API is used to remove all items from the user’s shopping cart.

Response Description:

Name Data Type Description
ordId numeric Order ID
content object Object containing response data

Example URI

POST https://test-api.wastelinq.com/api/ordersupplie/order_catalog_empty_cart
Request
HideShow
Headers
Authorization: {TOKEN}
Body
{
  "ordId": 887
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "content": {}
}

Shopping Cart

Shopping Cart
GET/api/ordersupplie/shopping_cart?page=0&pageSize=100000&selectedFields=DateCreated,OrderCreator,OrderNumber,LineAmount,SH,Tax,OrderTotal,RequestedDate,ExpectedDeliveryDate,TrackingNo,Status,actions&filter=esc=0,startDate=2024-01-15,endDate=2024-02-15

Overview:

Retrieve data from the database to load into the List Shopping Cart.

Response Description:

Name Data Type Description
content array Array containing response data
id numeric Unique identifier for the order
DateCreated string The date when the order was created
OrderCreator string The person who created the order
OrderNumber string Unique identifier for the order
LineAmount string The total amount of the order before tax and shipping
SH string Shipping and handling costs
Tax string The tax amount for the order
OrderTotal string The total amount of the order after tax and shipping
RequestedDate string The date when the order was requested
ExpectedDeliveryDate string The expected delivery date for the order
TrackingNo string The tracking number for the order
Status string The status of the order (e.g., New/Pending)
childs array Array containing information about the items in the order
id (in childs) numeric Unique identifier for the order item
OrderDate string The date when the order item was ordered
OrderNumber string Unique identifier for the order item
Customer string The customer who ordered the item
ProductItem string The product item ordered
Quantity numeric The quantity of the product item ordered
Description string The description of the product item
LineAmount (in childs) string The total amount of the order item before tax and shipping
SH (in childs) string Shipping and handling costs for the order item
RequestedDate (in childs) string The date when the order item was requested
ExpectedDate string The expected delivery date for the order item
TrackingNo (in childs) string The tracking number for the order item
Status (in childs) string The status of the order item (e.g., Pending)
ediable boolean Indicates if the order is editable (true/false)

Example URI

GET https://test-api.wastelinq.com/api/ordersupplie/shopping_cart?page=0&pageSize=100000&selectedFields=DateCreated,OrderCreator,OrderNumber,LineAmount,SH,Tax,OrderTotal,RequestedDate,ExpectedDeliveryDate,TrackingNo,Status,actions&filter=esc=0,startDate=2024-01-15,endDate=2024-02-15
URI Parameters
HideShow
page
number (required) Example: 0

The page number for pagination

pageSize
number (required) Example: 10000

The number of items per page

selectedFields
string (required) Example: DateCreated,OrderCreator,OrderNumber,LineAmount,SH,Tax,OrderTotal,RequestedDate,ExpectedDeliveryDate,TrackingNo,Status,actions

The selected fields for the response

filter
string (required) Example: esc=0,startDate=2024-01-15,endDate=2024-02-15

The filter query

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "content": [
    {
      "id": 891,
      "DateCreated": "02/16/2024",
      "OrderCreator": "Jane Doe",
      "OrderNumber": "891-S",
      "LineAmount": "$10.24",
      "SH": "$0.00",
      "Tax": "$0.84",
      "OrderTotal": "$11.08",
      "RequestedDate": "",
      "ExpectedDeliveryDate": "",
      "TrackingNo": "",
      "Status": "New/Pending",
      "childs": [
        {
          "id": 1910,
          "OrderDate": "02/16/2024",
          "OrderNumber": "891-S_1",
          "Customer": "Company ABC",
          "ProductItem": "23001",
          "Quantity": 1,
          "Description": "05 Gallon, Poly Pail, Open Top with Screw Top Lid (Black)",
          "LineAmount": "$10.24",
          "SH": "$0.00",
          "RequestedDate": "",
          "ExpectedDate": "",
          "TrackingNo": null,
          "Status": "Pending"
        }
      ],
      "ediable": true
    }
  ]
}

Order Catalog Delete Cart

Order Catalog Delete Cart
POST/api/ordersupplie/order_catalog_delete_cart

Overview:

This API is used to remove a shopping cart.

Response Description:

Name Data Type Description
content array Array containing response data
id numeric Unique identifier for the order
DateCreated string The date when the order was created
OrderCreator string The person who created the order
OrderNumber string Unique identifier for the order
LineAmount string The total amount of the order before tax and shipping
SH string Shipping and handling costs
Tax string The tax amount for the order
OrderTotal string The total amount of the order after tax and shipping
RequestedDate string The date when the order was requested
ExpectedDeliveryDate string The expected delivery date for the order
TrackingNo string The tracking number for the order
Status string The status of the order (e.g., New/Pending)
childs array Array containing information about the items in the order
id (in childs) numeric Unique identifier for the order item
OrderDate string The date when the order item was ordered
OrderNumber string Unique identifier for the order item
Customer string The customer who ordered the item
ProductItem string The product item ordered
Quantity numeric The quantity of the product item ordered
Description string The description of the product item
LineAmount (in childs) string The total amount of the order item before tax and shipping
SH (in childs) string Shipping and handling costs for the order item
RequestedDate (in childs) string The date when the order item was requested
ExpectedDate string The expected delivery date for the order item
TrackingNo (in childs) string The tracking number for the order item
Status (in childs) string The status of the order item (e.g., Pending)
ediable boolean Indicates if the order is editable (true/false)

Example URI

POST https://test-api.wastelinq.com/api/ordersupplie/order_catalog_delete_cart
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "ordId": 885
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "content": [
    {
      "id": 891,
      "DateCreated": "02/16/2024",
      "OrderCreator": "Jane Doe",
      "OrderNumber": "891-S",
      "LineAmount": "$10.24",
      "SH": "$0.00",
      "Tax": "$0.84",
      "OrderTotal": "$11.08",
      "RequestedDate": "",
      "ExpectedDeliveryDate": "",
      "TrackingNo": "",
      "Status": "New/Pending",
      "childs": [
        {
          "id": 1910,
          "OrderDate": "02/16/2024",
          "OrderNumber": "891-S_1",
          "Customer": "Company ABC",
          "ProductItem": "23001",
          "Quantity": 1,
          "Description": "05 Gallon, Poly Pail, Open Top with Screw Top Lid (Black)",
          "LineAmount": "$10.24",
          "SH": "$0.00",
          "RequestedDate": "",
          "ExpectedDate": "",
          "TrackingNo": null,
          "Status": "Pending"
        }
      ],
      "ediable": true
    }
  ]
}

Order History Detail

Order History Detail
GET/api/ordersupplie/order_history_detail?id=884

Overview:

This API retrieves all necessary information to load into the Order History Detail page

Response Description:

Name Data Type Description
content object Object containing response data
shippingaddress object Object containing shipping address details
GeneratorName (in shippingaddress) string Name of the generator for the shipping address
Address1 (in shippingaddress) string First line of the shipping address
Address2 (in shippingaddress) string Second line of the shipping address
City (in shippingaddress) string City of the shipping address
State (in shippingaddress) string State of the shipping address
Zip (in shippingaddress) string Zip code of the shipping address
Attention (in shippingaddress) string Attention field for the shipping address
OrderNumber (in shippingaddress) string Order number associated with the shipping address
ESC (in shippingaddress) string ESC field for the shipping address
billingaddress object Object containing billing address details
GeneratorName (in billingaddress) string Name of the generator for the billing address
Address1 (in billingaddress) string First line of the billing address
Address2 (in billingaddress) string Second line of the billing address
City (in billingaddress) string City of the billing address
State (in billingaddress) string State of the billing address
Zip (in billingaddress) string Zip code of the billing address
deliverywindows object Object containing delivery window details
Days (in deliverywindows) string Days for the delivery window
Times (in deliverywindows) string Times for the delivery window
Dock (in deliverywindows) string Dock for the delivery window
ReceiveOrderBy (in deliverywindows) string Receive order by field for the delivery window
PONumber (in deliverywindows) string Purchase order number for the delivery window
dropships array Array containing dropship details
id (in dropships) numeric Unique identifier for the dropship
name (in dropships) string Name of the dropship
inventorys array Array containing inventory details
id (in inventorys) numeric Unique identifier for the inventory
name (in inventorys) string Name of the inventory
items array Array placeholder for item details

Example URI

GET https://test-api.wastelinq.com/api/ordersupplie/order_history_detail?id=884
URI Parameters
HideShow
id
number (required) Example: 884

The ID of the supply

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "content": {
    "shippingaddress": {
      "GeneratorName": "Company ABC",
      "Address1": "132, My Street, Kingston, New York 12401.",
      "Address2": "132, My Street, Kingston, New York 12401.",
      "City": "New York",
      "State": "NY",
      "Zip": "12401",
      "Attention": "",
      "OrderNumber": "884-S",
      "ESC": "Company ABC"
    },
    "billingaddress": {
      "GeneratorName": "Company ABC",
      "Address1": "132, My Street, Kingston, New York 12401.",
      "Address2": "132, My Street, Kingston, New York 12401.",
      "City": "New York",
      "State": "NY",
      "Zip": "12401"
    },
    "deliverywindows": {
      "Days": "",
      "Times": "",
      "Dock": "",
      "ReceiveOrderBy": "",
      "PONumber": ""
    },
    "dropships": [
      {
        "id": 10000,
        "name": "Company ABC"
      }
    ],
    "inventorys": [
      {
        "id": 71,
        "name": "Name ABC"
      }
    ]
  },
  "items": []
}

Order Catalog Add Shipping Cart

Order Catalog Add Shipping Cart
POST/api/ordersupplie/order_catalog_add_shipping_cart

Overview:

This API is used to Add Shipping Cart.

Response Description:

Name Data Type Description
id numeric Unique identifier
shiptype string Type of shipping
ordId numeric Order identifier
content object Object containing response data
shippingaddress object Object containing shipping address details
GeneratorName (in shippingaddress) string Name of the generator for the shipping address
Address1 (in shippingaddress) string First line of the shipping address
Address2 (in shippingaddress) string Second line of the shipping address
City (in shippingaddress) string City of the shipping address
State (in shippingaddress) string State of the shipping address
Zip (in shippingaddress) string Zip code of the shipping address
Attention (in shippingaddress) string Attention field for the shipping address
OrderNumber (in shippingaddress) string Order number associated with the shipping address

Example URI

POST https://test-api.wastelinq.com/api/ordersupplie/order_catalog_add_shipping_cart
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "id": 41024,
  "shiptype": "Drop-ship",
  "ordId": 884
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "content": {
    "shippingaddress": {
      "GeneratorName": "Company ABC",
      "Address1": "132, My Street, Kingston, New York 12401.",
      "Address2": "132, My Street, Kingston, New York 12401.",
      "City": "New York",
      "State": "NY",
      "Zip": "12401",
      "Attention": "",
      "OrderNumber": "884-S"
    }
  }
}

Order History

Order History
GET/api/ordersupplie/order_history?page=0&pageSize=100000&selectedFields=OrderDate,OrderNumber,Customer,ShipTo,LineAmount,SH,Tax,OrderTotal,OrderContact,RequestedDate,Status,actions&filter=searchText=

Overview:

This API retrieves all necessary information to load into the Order History page.

Response Description:

Name Data Type Description
success boolean Indicates if the request was successful (true/false)
content array Array containing response data
id (in content) numeric Unique identifier for the order
OrderDate string Date of the order
OrderNumber string Number of the order
Customer string Name of the customer
ShipTo string Destination of the shipment
LineAmount string Amount for the line item
SH string Shipping and handling details
Tax string Tax amount
OrderTotal string Total amount of the order
RequestedDate string Date when the order was requested
OrderContact string Contact details for the order
Status string Status of the order
childs array Array containing child order details
id (in childs) numeric Unique identifier for the child order
OrderDate (in childs) string Date of the child order
OrderNumber (in childs) string Number of the child order
Customer (in childs) string Name of the customer for the child order
ProductItem string Item number of the product
Quantity numeric Quantity of the product
Description string Description of the product
LineAmount (in childs) string Amount for the line item in the child order
SH (in childs) string Shipping and handling details for the child order
RequestedDate (in childs) string Date when the child order was requested
ExpectedDate string Expected date for the child order
TrackingNo null Tracking number for the child order
Status (in childs) string Status of the child order
totalElements numeric Total number of elements in the response

Example URI

GET https://test-api.wastelinq.com/api/ordersupplie/order_history?page=0&pageSize=100000&selectedFields=OrderDate,OrderNumber,Customer,ShipTo,LineAmount,SH,Tax,OrderTotal,OrderContact,RequestedDate,Status,actions&filter=searchText=
URI Parameters
HideShow
page
number (required) Example: 0

The page number for pagination

pageSize
number (required) Example: 10000

The number of items per page

selectedFields
string (required) Example: OrderDate,OrderNumber,Customer,ShipTo,LineAmount,SH,Tax,OrderTotal,OrderContact,RequestedDate,Status,actions

The selected fields for the response

filter
string (optional) Example: searchText=

The search text filter

Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "success": "true",
  "content": [
    {
      "id": 889,
      "OrderDate": "02/16/2024",
      "OrderNumber": "889-S",
      "Customer": "Company A",
      "ShipTo": "Company B",
      "LineAmount": "See Details",
      "SH": "See Details",
      "Tax": "$9.16",
      "OrderTotal": "$120.21",
      "RequestedDate": "02/15/2024",
      "OrderContact": "See Details",
      "Status": "Submitted",
      "childs": [
        {
          "id": 1906,
          "OrderDate": "02/16/2024",
          "OrderNumber": "889-S_1",
          "Customer": "Company A",
          "ProductItem": "23154",
          "Quantity": 1,
          "Description": "55 Gallon, Poly Drum, Closed Top (Natural)",
          "LineAmount": "$36.90",
          "SH": "$0.00",
          "RequestedDate": "02/15/2024",
          "ExpectedDate": "",
          "TrackingNo": null,
          "Status": "Pending"
        }
      ]
    }
  ],
  "totalElements": 88
}

Order Catalog Add Order

Order Catalog Add Order
POST/api/ordersupplie/order_catalog_add_order

Overview:

This API is utilized for creating orders.

Response Description:

Name Data Type Description
ordId numeric Unique identifier for the order
Attn string Attention field, typically used to specify who the order is for or any special instructions
Dock string Dock number or identifier where the order will be received
Days string Number of days for delivery or processing of the order
Times string Specific times related to the order, could be delivery time or processing time
ReceiveOrderBy string Date by which the order should be received
PONumber string Purchase Order number associated with the order
content object Object containing response data

Example URI

POST https://test-api.wastelinq.com/api/ordersupplie/order_catalog_add_order
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "ordId": 887,
  "Attn": "10",
  "Dock": "10",
  "Days": "10",
  "Times": "10",
  "ReceiveOrderBy": "2024-02-15",
  "PONumber": "10"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "content": {}
}

Order Catalog Order Again

Order Catalog Order Again
POST/api/ordersupplie/order_catalog_order_again

Overview:

This API is utilized for recreating orders.

Response Description:

Name Data Type Description
ordId numeric Order ID
content object Object containing response data

Example URI

POST https://test-api.wastelinq.com/api/ordersupplie/order_catalog_order_again
Request
HideShow
Headers
Content-Type: application/json
Authorization: {TOKEN}
Body
{
  "ordId": 886
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "content": {}
}

Generated by aglio on 08 May 2024