| page | integer indicates what page of a list of query results you want to view
|
| page-size | integer indicates the how many items to return per page in a list request
|
| ordering | string determines which column to sort by. Prepend with '-' to sort desc
|
| q | |
| archived | boolean Filter on whether or not a PurchaseOrder is archived
|
| created_at | string <date> Include PurchaseOrders where created_at is equal to this value
|
| created_at__gte | string <date> Include PurchaseOrders where created_at is greater than or equal to this value
|
| created_at__lte | string <date> Include PurchaseOrders where created_at is less than or equal to this value
|
| created_by_user__contains | string Include PurchaseOrders where created_by_user object contains this string e.g first_name, last_name or email
|
| created_by_user_id | Array of strings <uuid> Include PurchaseOrders where created_by_user_id is in the array.
|
| created_by_user_name | string Include PurchaseOrders where created_by_user_name is exactly this string
|
| created_by_user_name__contains | string Include PurchaseOrders where created_by_user_name contains this string
|
| customer_external_id__contains | string Include PurchaseOrders where customer_external_id contains this string
|
| customer_name__contains | string Include PurchaseOrders where customer_name contains this string
|
| description__contains | string Include PurchaseOrders where description contains this string
|
| destination_address__contains | string Include PurchaseOrders where destination_address contains this string
|
| invoice_external_id__contains | string Include PurchaseOrders where invoice_external_id contains this string
|
| origin_address__contains | string Include PurchaseOrders where origin_address contains this string
|
| planned_delivery_start_datetime | string <date-time> Include PurchaseOrders where planned_delivery_start_datetime is equal to this value
|
| planned_delivery_end_datetime | string <date-time> Include PurchaseOrders where planned_delivery_end_datetime is equal to this value
|
| planned_delivery_start_datetime__gte | string <date-time> Include PurchaseOrders where planned_delivery_start_datetime is greater than or equal to this value
|
| planned_delivery_end_datetime__gte | string <date-time> Include PurchaseOrders where planned_delivery_end_datetime is greater than or equal to this value
|
| planned_delivery_start_datetime__lte | string <date-time> Include PurchaseOrders where planned_delivery_start_datetime is less than or equal to this value
|
| planned_delivery_end_datetime__lte | string <date-time> Include PurchaseOrders where planned_delivery_end_datetime is less than or equal to this value
|
| planned_pickup_start_datetime | string <date-time> Include PurchaseOrders where planned_pickup_start_datetime is equal to this value
|
| planned_pickup_end_datetime | string <date-time> Include PurchaseOrders where planned_pickup_end_datetime is equal to this value
|
| planned_pickup_start_datetime__gte | string <date-time> Include PurchaseOrders where planned_pickup_start_datetime__gte is greater than or equal to this value
|
| planned_pickup_end_datetime__gte | string <date-time> Include PurchaseOrders where planned_pickup_end_datetime is greater than or equal to this value
|
| planned_pickup_start_datetime__lte | string <date-time> Include PurchaseOrders where planned_pickup_start_datetime__gte is less than or equal to this value
|
| planned_pickup_end_datetime__lte | string <date-time> Include PurchaseOrders where planned_pickup_end_datetime is less than or equal to this value
|
| actual_delivery_datetime | string <date-time> Include PurchaseOrders where actual_delivery_datetime is equal to this value
|
| actual_pickup_datetime | string <date-time> Include PurchaseOrders where actual_pickup_datetime is equal to this value
|
| actual_delivery_datetime__gte | string <date-time> Include PurchaseOrders where actual_delivery_datetime is greater than or equal to this value
|
| actual_pickup_datetime__gte | string <date-time> Include PurchaseOrders where actual_pickup_datetime is greater than or equal to this value
|
| actual_delivery_datetime__lte | string <date-time> Include PurchaseOrders where actual_delivery_datetime is less than or equal to this value
|
| actual_pickup_datetime__lte | string <date-time> Include PurchaseOrders where actual_pickup_datetime is less than or equal to this value
|
| overall_status | Array of strings Return PurchaseOrders with an overall_status provided
|
| order_number__contains | string Include PurchaseOrders where order_number contains this string
|
| purchase_order_number__contains | string Include PurchaseOrders where purchase_order_number contains this string
|
| shipment_assigned | boolean Include PurchaseOrders that have/do not have a shipment assigned
|
| shipment_id | string <uuid> Include PurchaseOrders where shipment_id is exactly this string
|
| shipment_reference_id | string <uuid> Include PurchaseOrders where shipment_reference_id is exactly this string
|
| source | Array of strings Return PurchaseOrders created by sources in the array.
|
| source_system_id__contains | string Include PurchaseOrders where source_system_id contains this string
|
| status | string Include PurchaseOrders where status is exactly this string
|
| total_price__gte | number Include PurchaseOrders where total_price is greater than or equal to this amount
|
| total_price__lte | number Include PurchaseOrders where total_price is less than or equal to this amount
|
| supplier_external_id__contains | string Include PurchaseOrders where vendor_external_id contains this string
|
| supplier_name__contains | string Include PurchaseOrders where vendor_name contains this string
|
| name | string Include PurchaseOrders where name is exactly this string
|
| shipment_shipwell_custom_data | Array of strings Include shipments that contain these shipment-level custom data values
|
| purchase_order_shipwell_custom_data | Array of strings Include purchase orders that contain these level custom data values
|