Returns the list of scheduled pickups.

View-Specific Information

Select

The add-in will use the ShipStation API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the add-in.

• Id, CarrierId and WarehouseId support the following operator: =.
• CreatedAt supports the following operators: <=,<,>=,>.

For example, the following queries are processed server side:

SELECT * FROM Pickups WHERE Id = 'se-2345'

SELECT * FROM Pickups WHERE CarrierId = 'se-8765'

SELECT * FROM Pickups WHERE WarehouseId = 'se-3456'

SELECT * FROM Pickups WHERE CreatedAt >= '2024-11-13T23:47:25.293-05:00'

Columns

Name	Type	References	Description
Id [KEY]	String		A string that uniquely identifies the pickup.
CarrierId	String	Carriers.Id	A string that uniquely identifies the carrier.
WarehouseId	String	Warehouses.Id	A string that uniquely identifies the warehouse.
ConfirmationNumber	String		The carrier confirmation number for the pickup.
PickupNotes	String		Notes for the pickup.
CreatedAt	Datetime		The date and time the pickup was created.
CancelledAt	Datetime		The date and time the pickup was cancelled.
LabelIds	String		The label Ids associated with the pickup.
PickupAddressName	String		The name of the contact at the pickup address.
PickupAddressPhone	String		The phone number of the contact at the pickup address.
PickupAddressEmail	String		The email address of the contact at the pickup address.
PickupAddressCompanyName	String		The company name at the pickup address.
PickupAddressLine1	String		The first line of the pickup address.
PickupAddressLine2	String		The second line of the pickup address.
PickupAddressLine3	String		The third line of the pickup address.
PickupAddressCityLocality	String		The city or locality of the pickup address.
PickupAddressStateProvince	String		The state or province of the pickup address.
PickupAddressPostalCode	String		The postal code of the pickup address.
PickupAddressCountryCode	String		The 2-letter ISO country code of the pickup address.
PickupAddressResidentialIndicator	String		Indicates whether the pickup address is residential.
ContactDetailsName	String		The name of the contact for the pickup.
ContactDetailsEmail	String		The email address of the contact for the pickup.
ContactDetailsPhone	String		The phone number of the contact for the pickup.
PickupWindows	String		The scheduled time windows for the pickup.