Skip to main content

Pickups And Webhooks

These endpoints support operational coordination and event-driven system integration.

Create pickup​

POST /pickups

Schedules a pickup for one or more shipments or for a pickup window at a warehouse or merchant location.

Key request fields:

  • pickupAddress
  • requestedWindow
  • shipmentIds

Key response fields:

  • pickupId
  • status
  • requestedWindow

Create webhook subscription​

POST /webhooks/subscriptions

Registers a callback endpoint for shipment and pickup events.

Key request fields:

  • url
  • events
  • secret

List webhook subscriptions​

GET /webhooks/subscriptions

Returns the current webhook registrations for the authenticated partner context.

  • shipment.created
  • shipment.in_transit
  • shipment.out_for_delivery
  • shipment.delivered
  • shipment.exception
  • pickup.updated