Skip to content
API Reference
/
/
Retrieve pickup records

Retrieve pickup records

Request

Fetches a paginated list of pickup records created in the system. This endpoint supports optional filters such as USPS confirmation number, pickup status, and carrier code. Pagination parameters (page and page_size) allow controlling the size of the returned dataset, and the order_by flag determines the sorting order of the results.

Security
BearerAuth
Query
confirmation_numberstring(PickUpConfirmationNo)

This is the USPS assigned confirmation number of the pick-up.

Example:confirmation_number=WTC65384000
statusstring

Pickup status filter.

Enum:"CONFIRMED""CANCELED"
carrier_codestring(PickUpCarrierCodeEnum)

A code identifying the shipping carrier/provider for the pickup. This value determines which logistics provider should handle the pickup or shipment request. Currently only USPS is supported. Future values may include codes for other carriers (e.g., UPS, FedEx).

Value:"USPS"
Example:carrier_code=USPS
pageinteger, (int32)

Page number for paginated results (starting from 1).

Default:1
page_sizeinteger, (int32)

Number of results to return per page.

Default:50
order_bybooleanrequired

Sorting flag that controls the time order:

  • true: chronological order (oldest → newest)
  • false: reverse chronological order (newest → oldest)
GET
/api/shipment/pickup/list
curl -i -X GET \
  'https://x-api.shipsaving.com/api/shipment/pickup/list?confirmation_number=WTC65384000&status=CONFIRMED&carrier_code=USPS&page=1&page_size=50&order_by=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
codestring
Example:"ok"
msgstring
Example:"ok"
dataobject
Response
{
  "code": "ok",
  "msg": "ok",
  "data": {
    "pickup_data_list": [ … ],
    "total_count": 0
  }
}