List Orders

SecurityAPIKeyHeader
Request
query Parameters
status
Array of strings (ProductOrderStatus)
Items Enum: "NOT_READY" "READY" "FILLED" "ASSIGNED" "CANCELLED" "DISPATCHED" "IN_TRANSIT" "OUT_FOR_DELIVERY" "DELIVERED"
order_number
Array of strings (Order Number)
supplier__name
Array of strings (Supplier Name)
customer__name
Array of strings (Customer Name)
ship_from__address
Array of strings (Ship From Address)
ship_from__company_name
Array of strings (Ship From Company Name)
ship_from__company_name__icontains
string (Ship From Company Name Icontains)
ship_from__company_name__contains
string (Ship From Company Name Contains)
ship_from__region
Array of strings (Ship From Region)
ship_to__address
Array of strings (Ship To Address)
ship_to__company_name
Array of strings (Ship To Company Name)
ship_to__company_name__icontains
string (Ship To Company Name Icontains)
ship_to__company_name__contains
string (Ship To Company Name Contains)
ship_to__region
Array of strings (Ship To Region)
items__handling_unit_id
Array of strings (Items Handling Unit Id)
shipwell_custom_data_id
string (Shipwell Custom Data Id)
shipwell_custom_data_value
string (Shipwell Custom Data Value)
page
integer (Page) >= 1
Default: 1
limit
integer (Limit) [ 1 .. 200 ]
Default: 50
q
string (Q)
order_by
string (Order By)
Default: "id"
id
string (Id)
id__in
string (Id In)
status__in
string (Status In)
order_number__contains
string (Order Number Contains)
order_number__icontains
string (Order Number Icontains)
order_number__in
string (Order Number In)
name
string (Name)
name__contains
string (Name Contains)
name__icontains
string (Name Icontains)
name__in
string (Name In)
created_at
string <date-time> (Created At)
created_at__gte
string <date-time> (Created At Gte)
created_at__lte
string <date-time> (Created At Lte)
archived
boolean (Archived)
Default: false
updated_at
string <date-time> (Updated At)
updated_at__gte
string <date-time> (Updated At Gte)
updated_at__lte
string <date-time> (Updated At Lte)
references
string (References)
references__contains
string (References Contains)
references__icontains
string (References Icontains)
references__in
string (References In)
references__purchase_order_number
string (References Purchase Order Number)
references__purchase_order_number__contains
string (References Purchase Order Number Contains)
references__purchase_order_number__icontains
string (References Purchase Order Number Icontains)
references__purchase_order_number__in
string (References Purchase Order Number In)
purchase_order_number
string (Purchase Order Number)
purchase_order_number__contains
string (Purchase Order Number Contains)
purchase_order_number__icontains
string (Purchase Order Number Icontains)
purchase_order_number__in
string (Purchase Order Number In)
ship_to__company_name__in
string (Ship To Company Name In)
ship_to__region__contains
string (Ship To Region Contains)
ship_to__region__icontains
string (Ship To Region Icontains)
ship_to__region__in
string (Ship To Region In)
ship_to__plan_window_start__gte
string <date-time> (Ship To Plan Window Start Gte)
ship_to__plan_window_start__lte
string <date-time> (Ship To Plan Window Start Lte)
ship_to__plan_window_end__gte
string <date-time> (Ship To Plan Window End Gte)
ship_to__plan_window_end__lte
string <date-time> (Ship To Plan Window End Lte)
ship_to__address__icontains
string (Ship To Address Icontains)
ship_from__company_name__in
string (Ship From Company Name In)
ship_from__region__contains
string (Ship From Region Contains)
ship_from__region__icontains
string (Ship From Region Icontains)
ship_from__region__in
string (Ship From Region In)
ship_from__plan_window_start__gte
string <date-time> (Ship From Plan Window Start Gte)
ship_from__plan_window_start__lte
string <date-time> (Ship From Plan Window Start Lte)
ship_from__plan_window_end__gte
string <date-time> (Ship From Plan Window End Gte)
ship_from__plan_window_end__lte
string <date-time> (Ship From Plan Window End Lte)
ship_from__address__icontains
string (Ship From Address Icontains)
supplier__name__contains
string (Supplier Name Contains)
supplier__name__icontains
string (Supplier Name Icontains)
supplier__name__in
string (Supplier Name In)
customer__name__contains
string (Customer Name Contains)
customer__name__icontains
string (Customer Name Icontains)
customer__name__in
string (Customer Name In)
releases__released_onto_shipment_id
string (Releases Released Onto Shipment Id)
releases__released_onto_shipment_id__contains
string (Releases Released Onto Shipment Id Contains)
releases__released_onto_shipment_id__icontains
string (Releases Released Onto Shipment Id Icontains)
releases__released_onto_shipment_id__in
string (Releases Released Onto Shipment Id In)
items__handling_unit_id__contains
string (Items Handling Unit Id Contains)
items__handling_unit_id__icontains
string (Items Handling Unit Id Icontains)
items__handling_unit_id__in
string (Items Handling Unit Id In)
tags__slug__in
string (Tags Slug In)
tags__id__in
string (Tags Id In)
tags__slug__not_in
string (Tags Slug Not In)
tags__id__not_in
string (Tags Id Not In)
Responses
200

Successful Response

Response Schema: application/json
required
Array of any (Data)
count
required
integer (Count)

Number of the items within the 'data' array.

total_count
integer (Total Count)

Number of items in the entire result set. Value is always >= count. Inclusion depends on the underlying result set.

required
object (PaginationLinks)
400

Validation Error

get/orders
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "count": 0,
  • "total_count": 0,
  • "links": {}
}
Copyright © Shipwell 2024. All right reserved.