PRprototyping
admin-shipping-logistics

Schedule Pickup

post/api/v1/admin/shipments/{shipment_id}/pickup

Request

Path parameters

shipment_idstring uuid required

Request body

window_startstring date-time required
window_endstring date-time required
locationstring nullable
instructionsstring nullable

Response

Successful Response

idstring uuid required
shipment_idstring uuid required
carrier'ups' | 'dhl' | 'fedex' | 'usps' | 'other' required
pickup_confirmation_numberstring nullable
status'not_scheduled' | 'scheduled' | 'cancelled' | 'failed' required
window_startstring date-time nullable
window_endstring date-time nullable
locationstring nullable
instructionsstring nullable
cancelled_atstring date-time nullable
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.