Create
POST {{baseUrl}}/shipment
Creates new empty shipment record for a specific RTL Device ID. The Device ID must be free and not used for any other shipment with Incomplete status.
■ Ability to specify a single Product ID
■ Ability to specify locations (Shipper Location ID, Receiver Location ID, Airport
and Marine Port IDs, etc)
■ Available receiver locations include this account's receiver locations, plus any
receiver locations shared by receiver sharing
■ If user specifies a 3rd party receiver location, then the list of available products
to associate is limited to that receiver's locations, meaning product and receiver
location must match accounts
■ API should throw an error if the selected product doesn't match the account of
the selected receiver location.
Request Body
{"shipment_name"=>"test", "trip_number"=>"12341", "carrier_id"=>"L2348717831021", "shipper_id"=>"L3246871783122", "receiver_id"=>"L1668717831024", "product_id"=>"Ammgzwkj2h3!", "estimated_arrival_date"=>"2022-11-17T17:56:54.586Z", "estimated_departure_date"=>"2022-11-17T17:56:54.586Z", "purchase_order"=>"AB120341", "maritime"=>{"arrival_port_id"=>"L3246871783122", "departure_port_id"=>"L3246871783122", "bol"=>"A1", "scac"=>"S1", "vessel_imo"=>"1221", "vessel_name"=>"Test"}}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Authorization | string |
RESPONSES
status: OK