Sign in
admin-shipping-logistics

Update Outbound Shipment

patch/api/v1/admin/shipments/{shipment_id}/outbound-shipment

Path parameters

shipment_idstring uuid required

Request body

carrier'ups' | 'dhl' | 'fedex' | 'usps' | 'other'
carrier_service_codestring nullable
tracking_numberstring nullable
tracking_urlstring nullable
status'pending' | 'processing' | 'ready_to_ship' | 'shipped' | 'in_transit' | 'out_for_delivery' | 'delivered' | 'failed_delivery' | 'returned' | 'cancelled'
estimated_deliverystring date nullable
actual_deliverystring date nullable
shipped_atstring date-time nullable
notesstring nullable

Response

Successful Response

idstring uuid required
project_idstring uuid required
carrierstring nullable
carrier_codestring nullable
carrier_service_codestring nullable
carrier_shipment_idstring nullable
tracking_numberstring nullable
tracking_urlstring nullable
status'pending' | 'processing' | 'ready_to_ship' | 'shipped' | 'in_transit' | 'out_for_delivery' | 'delivered' | 'failed_delivery' | 'returned' | 'cancelled' required
estimated_deliverystring date nullable
actual_deliverystring date nullable
shipped_atstring date-time nullable
notesstring nullable
label_status'not_created' | 'creating' | 'created' | 'voiding' | 'voided' | 'failed' required
tracking_sync_status'never_synced' | 'syncing' | 'synced' | 'failed' required
tracking_last_synced_atstring date-time nullable
tracking_sync_errorstring nullable
created_atstring date-time required
updated_atstring date-time required

Changes

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