EAeasyship
Pickups

List all Pickups

Changed on

Retrieve a list of pickups.

Required authorization scope: public.pickup:read

get/2024-09/pickups

Request

  • Base URL
    https://public-api.easyship.com
  • URL
    https://public-api.easyship.com/2024-09/pickups
  • Auth
    HTTP bearer

Query parameters

pageinteger

Page number to fetch, default: 1

per_pageinteger

Number of records per page to fetch, default: 20

pickup_datestring date

Selected pickup date. Only accept YYYY-MM-DD format.

courier'USPS' | 'Australia Post eParcel' | 'StarTrack' | 'Royal Mail' | 'DHL eCommerce' | 'Canada Post' | 'Quantium' | 'eBay Send' | 'Veho' | 'SpeedX' | 'Asendia'

Courier name

pickup_state'cancelled' | 'completed' | 'partially-completed' | 'pending-confirmation' | 'pending-delayed-api-request' | 'pending-drop-off' | 'pending-handover' | 'request-failed' | 'request-pickup-window-failed' | 'request-technical-failed' | 'requested'

Pickup state

shipment_idstring

Shipment ID

Response

list of pickups

Changes

  • b47b54b748a7Revision changes
    • breaking

      the response property /////// became nullable for the status

    • breaking

      the response property /////// became nullable for the status

    • breaking

      the response property /////// became nullable for the status

    • breaking

      the /////// response's property type changed from no type to string for status

    • breaking

      the /////// response's property type changed from no type to string, and format from no format to email for status

    • info

      added the new enum value Asendia to the query request parameter courier

    • info

      added the new enum value SpeedX to the query request parameter courier

    • info

      added the new enum value Veho to the query request parameter courier

    • info

      added the new enum value eBay Send to the query request parameter courier

    • info

      added the optional property /////// to the response with the status