admin-shipping-logistics

Update Inbound Shipment

patch/api/v1/admin/inbound-shipments/{inbound_shipment_id}

Path parameters

inbound_shipment_idstring uuid required

Request body

carrier'ups' | 'dhl' | 'fedex' | 'usps' | 'other'
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
last_known_locationstring nullable

Response

Successful Response

idstring uuid required
project_idstring uuid required
supplier_order_idstring uuid required
supplier_contact_idstring uuid required
carrier'ups' | 'dhl' | 'fedex' | 'usps' | 'other' required
tracking_numberstring required
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
last_known_locationstring nullable
origin_locationstring nullable
destination_locationstring nullable
service_namestring nullable
last_synced_atstring date-time nullable
sync_status'never_synced' | 'syncing' | 'synced' | 'failed' required
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.