List of pickups for a company

SecurityAuthToken
Request
query Parameters
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
string

search query

scheduled_date
string <date>

Date of a scheduled pickup

scheduled_date__gte
string <date>

Return pickups with a scheduled date greater than or equal to this value

scheduled_date__lte
string <date>

Return pickups with a scheduled date less than or equal to this value

scheduled_time_window_start__gte
string

Return pickups with a scheduled start time window date and time greater than or equal to this value

scheduled_time_window_start__lte
string

Return pickups with a scheduled start time window date and time less than or equal to this value

scheduled_time_window_end__gte
string

Return pickups with a scheduled end time window date and time greater than or equal to this value

scheduled_time_window_end__lte
string

Return pickups with a scheduled end time window date and time less than or equal to this value

point_of_contact
string

Include pickups with this point of contact name

point_of_contact__contains
string

Include pickups where the point of contact includes this value

point_of_contact__excludes
string

Exclude pickups where the point of contact includes this value

special_instructions
string

Include pickups with these special instructions

special_instructions__contains
string

Include pickups where the special instructions includes this value

special_instructions__excludes
string

Exclude pickups where the special instructions includes this value

pickup_number
string

Include pickups with this pickup number

pickup_number__contains
string

Include pickups where the pickup number contains this value

pickup_number__excludes
string

Exclude pickups with this pickup number

provider_code
string

Include pickups with this provider code

provider_carrier_code
string

Include pickups with this provider carrier code

provider_carrier_code__contains
string

Include pickups where the provider carrier code contains this value

provider_carrier_code__excludes
string

Exclude pickups with this provider carrier code

provider_location_id
string

Include pickups with this provider location id

provider_location_id__contains
string

Include pickups where the provider location id contains this value

provider_location_id__excludes
string

Exclude pickups with this provider location id

address_book_entry
string

Include pickups with this address book entry id

is_regularly_scheduled
boolean

Include pickups with this is_regularly_scheduled value

cancelled
boolean

Return pickups based on if they are cancelled

shipment_ids
string

Return pickup with that include this shipment

company
string

Return pickups specific to this company

fedex_account
string

Return pickups specific to this FedEx account

ups_account
string

Return pickups specific to this UPS account

Responses
200

List of cases for a given company

Response Schema: application/json
page_size
integer
Array of objects (ShipmentPickup)
total_count
integer
total_pages
integer
get/shipments/pickups/
Request samples
Response samples
application/json
{
  • "page_size": 0,
  • "results": [
    ],
  • "total_count": 0,
  • "total_pages": 0
}
Copyright © Shipwell 2024. All right reserved.