post
https://pluto.cargobase.com/api/1/orders/create
This endpoint creates an order in the system.
Request Body Fields
| Field | Type | Required | Description |
|---|---|---|---|
| quick_request.title | string | No | Title of the order or request |
| quick_request.comments | string | No | Additional comments or instructions |
| quick_request.external_id | string | No | External ID used to identify the order in external systems |
| organizational.location | string | Yes | A reference to the 'location' the request is for, location references are shared by Cargobase. |
| organizational.cost_center | string | No | Associated cost center |
| organizational.reason_code | string | No | Code explaining reason for the shipment |
| organizational.reason_code_group | string | No | Group categorization for reason code |
| organizational.custom_field_01 | string | No | User-defined custom field 1 |
| organizational.custom_field_02 | string | No | User-defined custom field 2 |
| organizational.custom_field_03 | string | No | User-defined custom field 3 |
| organizational.custom_long_field_01 | string | No | Extended custom field |
| organizational.goods_confirmation_type | string | No | Goods confirmation type (Estimated or Finalized) |
| schedule.pickup_street | string | Yes | Street address of pickup location |
| schedule.pickup_street_line2 | string | No | Additional pickup address line |
| schedule.pickup_address_type | string | No | Type of pickup address (e.g., Address, Seaport or Airport) |
| schedule.pickup_address_name | string | Yes | Name/label of pickup address |
| schedule.pickup_company_name | string | No | Name of the pickup company |
| schedule.pickup_city | string | Yes | Pickup city |
| schedule.pickup_state | string | No | Pickup state |
| schedule.pickup_country | string | Yes | Pickup country |
| schedule.pickup_zipcode | string | No | Pickup postal code |
| schedule.pickup_airport_code | string | No | IATA code of pickup airport |
| schedule.pickup_airport | string | No | Pickup airport name |
| schedule.pickup_seaport | string | No | Pickup seaport name |
| schedule.pickup_seaport_code | string | No | Pickup seaport code |
| schedule.pickup_country_code | string | No | Pickup country code |
| schedule.pickup_before_date | string | No | Latest acceptable pickup date |
| schedule.pickup_before_time | string | No | Latest acceptable pickup time |
| schedule.pickup_ready_date | string | No | Earliest pickup readiness date |
| schedule.pickup_ready_time | string | No | Earliest pickup readiness time |
| schedule.pickup_hours_from | string | No | Pickup window start time |
| schedule.pickup_hours_to | string | No | Pickup window end time |
| schedule.pickup_timezone | string | No | Timezone for pickup |
| schedule.pickup_cargo_ready | string | No | Type of pickup time for the cargo (after, before, between, asap_delivery, unspecified) |
| schedule.pickup_notes | string | No | Notes for pickup location |
| schedule.delivery_hours_from | string | No | Delivery window start time |
| schedule.delivery_hours_to | string | No | Delivery window end time |
| schedule.stop1_address_type | string | No | Delivery address type |
| schedule.stop1_company_name | string | No | Delivery company name |
| schedule.stop1_notes | string | No | Delivery notes |
| schedule.stop1_street_line2 | string | No | Additional delivery address line |
| schedule.stop1_street | string | Yes | Delivery street |
| schedule.stop1_country | string | Yes | Delivery country |
| schedule.stop1_state | string | No | Delivery state |
| schedule.stop1_country_code | string | No | Delivery country code |
| schedule.stop1_zipcode | string | No | Delivery postal code |
| schedule.stop1_city | string | Yes | Delivery city |
| schedule.stop1_address_name | string | Yes | Delivery address name |
| schedule.stop1_contact_name | string | Yes | Contact person at delivery location |
| schedule.stop1_contact_phone | string | Yes | Delivery contact phone |
| schedule.stop1_contact_email | string | Yes | Delivery contact email |
| schedule.stop1_after_date | string | No | Earliest delivery date |
| schedule.stop1_after_time | string | No | Earliest delivery time |
| schedule.stop1_before_date | string | No | Latest delivery date |
| schedule.stop1_before_time | string | No | Latest delivery time |
| schedule.stop1_timezone | string | No | Delivery timezone |
| schedule.delivery_cargo_ready | string | No | Delivery cargo ready type |
| schedule.stop1_airport_code | string | No | Delivery airport code |
| schedule.stop1_airport | string | No | Delivery airport name |
| schedule.stop1_seaport_code | string | No | Delivery seaport code |
| schedule.stop1_seaport | string | No | Delivery seaport name |
| packing_list[].handling_unit | string | No | Type of handling unit (e.g., Pallet, Crate) |
| packing_list[].handling_unit_value | string | No | Value or count of handling units |
| packing_list[].units | integer | No | Number of items or boxes |
| packing_list[].length | number | No | Length in meters |
| packing_list[].width | number | No | Width in meters |
| packing_list[].height | number | No | Height in meters |
| packing_list[].m_unit | string | No | Unit of measure for dimensions |
| packing_list[].hazardous | boolean | No | Indicates if contents are hazardous |
| packing_list[].container_type | string | No | Container type |
| packing_list[].temperature_control_required | boolean | No | Temperature control required |
| packing_list[].temperature_control_value | string | No | Temperature control value |
| packing_list[].temperature_controlled_custom_value | string | No | Custom temperature instructions |
| packing_list[].cbm_scope | string | No | Cubic meter scope (Full/Partial) |
| packing_list[].l_w_h_cbm_total | number | No | Total volume in CBM |
| packing_list[].l_w_h_cbm_piece | number | No | Volume per piece in CBM |
| packing_list[].weight_piece | number | No | Weight per piece |
| packing_list[].weight_total | string | No | Total weight |
| packing_list[].w_unit | string | No | Weight unit |
| packing_list[].stackable | boolean | No | Is the item stackable |
| packing_list[].is_dangerous_good | boolean | No | Is it classified as dangerous goods |
| packing_list[].dangerous_good_value | string | No | Dangerous goods classification |
| packing_list[].additional_information | string | No | Additional information |
| packing_list[].crating_required | boolean | No | Crating required |
| packing_list[].crating_required_by | string | No | Crating required by date |
| packing_list[].additional_text | string | No | Additional text |
| packing_list[].nmfc_class | string | No | NMFC class |
| packing_list[].good_customs_information[].value | number | No | Monetary value of the item |
| packing_list[].good_customs_information[].currency_code | string | No | 3-letter ISO code of currency of the value of the item |
| packing_list[].good_customs_information[].description | string | No | Description of the item |
| packing_list[].good_customs_information[].hs_code | string | No | HS Code of the item |
| packing_list[].additional_field | string | No | Extra details |
| service.incoterms | string | No | Incoterms used for the shipment |
| service.incoterm_instructions | string | No | Instructions for incoterms |
| service.service_level | string | No | Service level |
| service.service_type | string | No | Service type |
| service.export_clearance | string | No | Export clearance requirement |
| service.export_clearance_instructions | string | No | Instructions for export clearance |
| service.transit_clearance | string | No | Transit clearance requirement |
| service.transit_clearance_instructions | string | No | Instructions for transit clearance |
| service.import_clearance | string | No | Import clearance requirement |
| service.import_clearance_instructions | string | No | Instructions for import clearance |
| service.insurance | string | No | Insurance information (if any) |
| service.insurance_instructions | string | No | Instructions for insurance |
| service.special_requirements | object | No | Additional special instructions or metadata |