get
https://pluto.cargobase.com/api/1/shipments/
The Shipment Detail end-point can be used to retrieve all specifics of a Shipment.
However, please be aware; if a Shipment has not been awarded, you will need the Request Detail end-point to view the specifics.
Request URI
GET https://pluto.cargobase.com/api/1/shipments/`SHIPMENT_ID`
Authorization: Token your_token_here
Status codes
| Status | Description | Resolution |
|---|---|---|
| 200 | OK | -- |
| 403 | Forbidden | check Authentication token, or status of the request |
| 404 | Not Found | Check the shipment ID |
Request Response
Shipment Response categories
The response is divided into 6 possible categories for shippers and 6 for providers, these are:
| Category | Definition |
|---|---|
| organization | Details related to the organization, such as WBS Codes or Cost Centers |
| service | Details related to the service, such as freight mode, incoterms or clearance instructions |
| schedule | Details related to pickup & delivery timing and locations |
| good_items | Details related to the packing list |
| good_customs_information | Customs details per good item |
| special_requirements | Specific requirements of the shipment such as 'air ride trucks' or 'shock tilt' requirements, not available for most. |
Shipment Response: Organization
Details related to the organization, such as WBS Codes or Cost Centers.
| Key | Value | Description |
|---|---|---|
| shipment_id | STRING | The request ID |
| requestor | STRUBG | The name of the person that created this request |
| shipment_status | STRING | Current status of the shipment, see list for potential status below |
| shipment_book_datetime | TIMESTAMP | Format YYYY-MM-DD HH:MM:SS |
| shipment_approved_by | STRING | Name of person that performed final booking |
| shipment_booked_by | STRING | Name of person that initiated booking |
| title | STRING | Title of the Request, as provided by the Shipper |
| location | STRING | Name of payment location for this shipment |
| cost_center | STRING | Value entered in the cost_center field, the shipper might use a custom label for this field and therefore not recognise the term cost_center |
| custom_field1 | STRING | Value entered in the custom_field1 field, the shipper might use a custom label for this field and therefore not recognise the term custom_field |
| reason_code | STRING | Value entered in the reason_code field, the shipper might use a custom label for this field and therefore not recognise the term reason_code |
| goods_confirmation_type | STRING | Details related to the status of the packing list, only available to some. Status can be Estimated or Finalised |
| good_items | GROUP | Packing list with details |
| special_requirements | GROUP | Specific requirements of the shipment such as 'air ride trucks' or 'shock tilt' requirements, not available for most. |
Shipment status options
| Status | Definition |
|---|---|
| Booked | An awarded shipment with a pickup time in the future |
| In Transit | An active shipment expected to be in transit |
| Delayed | An active shipment where the ETA has passed |
| Delivered | A shipment that has a POD |
| Canceled | A shipment that was canceled after being awarded |
Shipment Response: Service
Details related to the service, such as requested freight mode, incoterms or clearance instructions.
| Key | Value | Description |
|---|---|---|
| incoterm | STRING | The requested incoterm |
| delivery_service_level | INTEGER | Number of days associated with Service level, not available for most |
| export_clearance | STRING | Indicator if Export clearance is expected, and what kind |
| export_clearance_instructions | STRING | Instructions related to Export clearance |
| transit_clearance | STRING | Indicator if Transit clearance is expected, and what kind |
| transit_clearance_instructions | STRING | Instructions related to Transit clearance |
| import_clearance | STRING | Indicator if Import clearance is expected, and what kind |
| import_clearance_instructions | STRING | Instructions related to Import clearance |
| insurance | BOOLEAN | Indicator to see if the provider is expected to arrange shipment insurance |
| insurance_instructions | STRING | Instructions related to a positive insurance request |
| service_requirement | STRING | Related to Door-to-Door, Door-to-Port, Port-to-Door or Port-to-Port but abbreviated in a TLA |
| freight_mode | STRING | The freight mode of the shipment - see freight mode options below |
| road_freight_type | STRING | Description of road freight type, in case of road freight |
| provider | STRING | Name of the awarded party |
| quote_id | STRING | Reference number of the selected quote |
| airline | STRING | IATA Airline code, if available |
| flight_number | STRING | Flight number, if available |
| primary_tracking_number | STRING | Main tracking number, used for automated tracking events |
| mawb | STRING | Master Airway Bill number, for air cargo tracking |
| other_tracking_number | STRING | Any additional tracking reference |
Freight mode values
- Air charter
- Next flight out (NFO)
- Ocean freight
- Rail freight
- Regular air freight
- Road freight
- Parcel
- On board courier (OBC)
Shipment Response: Schedule
Details related to pickup & delivery timing and locations.
| Key | Value | Description |
|---|---|---|
| pickup_airport_code | STRING | IATA Airport code, if identified otherwise null |
| pickup_airport | STRING | Airport Name, if identified otherwise null |
| pickup_seaport_code | STRING | Seaport code, if identified otherwise null |
| pickup_seaport | TYPE | Seaport name, if identified otherwise null |
| pickup_street | STRING | Pickup street address |
| pickup_address_name | STRING | Pickup company name |
| pickup_state | STRING | The pickup State in case of US or Mexico |
| pickup_zipcode | STRING | The pickup postal code |
| pickup_city | STRING | The pickup city |
| pickup_country | STRING | The pickup country |
| quoted_pickup_date | TIMESTAMP | Quoted pickup date, format YYYY-MM-DD |
| quoted_pickup_time | TIMESTAMP | Quoted pickup time, format HH:MM |
| actual_pickup_date | TIMESTAMP | Quoted or Updated Pickup date. |
| actual_pickup_time | TIMESTAMP | Quoted or Updated Pickup time. |
| pickup_timezone | STRING | Timezone name |
| pickup_notes | STRING | Additional pickup notes |
| pickup_contact_name | STRING | Name of contact person at pickup location |
| pickup_contact_phone | STRING | Phone number of contact person at pickup location |
| pickup_contact_email | STRING | Email of contact person at pickup location |
| pickup_address_type | STRING | Can be Address, Seaport or Airport |
| stop1_airport | STRING | Airport Name, if identified otherwise null |
| stop1_seaport_code | STRING | Seaport code, if identified otherwise null |
| stop1_seaport | TYPE | Seaport name, if identified otherwise null |
| stop1_street | STRING | Delivery street address |
| stop1_address_name | STRING | Delivery company name |
| stop1_state | STRING | The delivery State in case of US or Mexico |
| stop1_zipcode | STRING | The delivery postal code |
| stop1_city | STRING | The delivery city |
| stop1_country | STRING | The delivery country |
| stop1_quoted_delivery_date | TIMESTAMP | Quoted delivery date, format YYYY-MM-DD |
| stop1_quoted_delivery_time | TIMESTAMP | Quoted deliverytime, format HH:MM |
| stop1_actual_delivery_date | TIMESTAMP | Quoted or Updated delivery date. |
| stop1_actual_delivery_time | TIMESTAMP | Quoted or Updated delivery time. |
| stop1_notes | STRING | Additional delivery notes |
| stop1_contact_name | STRING | Name of contact person at delivery location |
| stop1_contact_phone | STRING | Phone number of contact person at delivery location |
| stop1_contact_email | STRING | Email of contact person at delivery location |
| stop1_address_type | STRING | Can be Address, Seaport or Airport |
| vessel_information | OBJECT | For Ocean Freight Only Details with regards to vessel departure, delivery and IMO |
Vessel information
Please Note, vessel_information is part of Schedule for Shipments, but part of Quotes in Requests
Vessel information is ocean freight specific, and can contain details provided by the provider about vessel departure, arrival and the vessel number (IMO).
These details are only present in case they are populated. These details will not be sent as null if missing.
In similar fashion to other quotes details, the content of vessel_information is an array of key value pairs.
The potential pairs are:
- Vessel departure : a date in YYYY-MM-DD
- Arrival in port : a date in YYYY-MM-DD
- Vessel / IMO : A string containing the IMO number
Shipment Response: Good items
Details related to the packing list. This category is a child of Organization.
These values are grouped per handling unit, each shipment can have multiple handling units.
Each shipment can also have multiple handling units of the same type, but differences in dimensions, notes or classifications.
| Key | Value | Description |
|---|---|---|
| units | INTEGER | Number of this type of handling unit |
| handling_unit | STRING | Handling unit type |
| length | DOUBLE | Length value |
| height | DOUBLE | Height value |
| width | DOUBLE | Width value |
| m_unit | STRING | LxWxH unit of measurement, can be cm or inch |
| weight | INTEGER | Weight of individual handling unit piece, should be multiple by number of units for total Weight |
| w_unit | STRING | Weight unit of measurement, can be kg or lbs |
| stackable | BOOLEAN | Indicator if individual piece can be stacked |
| hazardous | BOOLEAN | Indicator if goods are considered hazardous |
| crating_required | BOOLEAN | Indicator if the provider is requested to provide crating, will be null for most |
| crating_required_by_date | TIMESTAMP | Date & Time of final possibility to provide crating services, will be null for most |
| is_dangerous_good | BOOLEAN | Indicator if contents are classified as a Dangerous good |
| dangerous_good_value | INTEGER | Indicator of DG Category |
| other_instructions | STRING | Description in case of handling unit other |
| additional_information | STRING | Additional instructions related to these goods |
| container_type | STRING | Description of container type, in case of handling unit container (e.g. 20Ft standard) |
| refrigerated_container | BOOLEAN | Indicator if container should be refridgerated, in case of handling unit container |
| good_customs_information | GROUP | Customs details related to this handling unit |
Shipment Response: Good customs information
Customs details per good item. This category is a child of a handling unit within category Good items.
| Key | Value | Description |
|---|---|---|
| value | INTEGER | Value of the contents of the handling unit |
| currency_code | STRING | Currency of the value of the handling unit |
| Description | STRING | Description of the contents of the handling unit |
| hs_code | STRING | Harmonised Systems code for this handling unit, as provided by the shipper |
Shipment Response: Special requirements
Specific requirements of the shipment such as 'air ride trucks' or 'shock tilt' requirements, not available for most.
| Key | Value | Description |
|---|---|---|
| air_truck_required | BOOLEAN | To indicate if shipment will require this feature |
| air_truck_additional_information | STRING | Additional information in case this feature is requested |
| shock_tilt_required | BOOLEAN | To indicate if shipment will require this feature |
| shock_tilt_additional_information | STRING | Additional information in case this feature is requested |
| unique_handling_required | BOOLEAN | To indicate if shipment will require this feature |
| unique_handling_additional_information | STRING | Additional information in case this feature is requested |
| chemical_magnetic_concerns | BOOLEAN | To indicate if shipment will require this feature |
| chemical_magnetic_additional_information | STRING | Additional information in case this feature is requested |
| unique_warehousing_required | BOOLEAN | To indicate if shipment will require this feature |
| unique_warehousing_additional_information | STRING | Additional information in case this feature is requested |
| special_transport_required | BOOLEAN | To indicate if shipment will require this feature |
| special_transport_additional_information | STRING | Additional information in case this feature is requested |
| special_provider_requirements | BOOLEAN | To indicate if shipment will require this feature |
| special_provider_additional_information | STRING | Additional information in case this feature is requested |
| special_lift_fixtures_required | BOOLEAN | To indicate if shipment will require this feature |
| special_lift_fixtures_additional_information | STRING | Additional information in case this feature is requested |
Known issues
- None at the moment