POST v1/company/shipment/add

WEB - ADD NEW SHIPMENT

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
shipment_company_id		string	Required
shipment_customer_id		string	Required
shipment_shape_type_id		integer	Required
shipment_shape_type_type_id		integer	Required
shipment_pallet_count		integer	None.
shipment_type_id		integer	Required
shipment_vehicle_type_id		integer	Required
shipment_vehicle_trailer_type_ids		Collection of integer	Required
shipment_vehicle_base_slab_id		integer	Required
shipment_vehicle_capacity_type_id		integer	Required
shipment_payment_type_id		integer	Required
shipment_departure_date		string	Required
shipment_departure_address_id		integer	Required
shipment_departure_contact_name		string	None.
shipment_departure_contact_phone_number		string	None.
shipment_distance		decimal number	None.
shipment_proposal_cost		integer	Required
shipment_proposal_currency_id		integer	None.
shipment_proposal_cost_per_ton		integer	None.
shipment_cubic_meter		string	None.
shipment_weight		string	None.
shipment_length		string	None.
shipment_remark		string	None.
shipment_custom_id		string	None.
enable_public_notification		boolean	None.
vehicle_count		integer	None.
shipment_destinations		Collection of ShipmentDestination	None.
shipment_temperature		integer	None.
shipment_offer_user_id		string	None.
shipment_offer_vehicle_id		integer	None.
shipment_has_adr		boolean	None.
shipment_is_unpriced		boolean	None.
shipment_show_offerable_list		boolean	None.
shipment_offerable_company_list		Collection of string	None.
shipment_has_blank_load		boolean	None.
shipment_departure_address_departure_date		date	None.
shipment_customer_custom_code		string	None.
shipment_departure_stop_pallet_count		integer	None.
shipment_departure_stop_cubic_meter		decimal number	None.
shipment_departure_stop_weight		decimal number	None.
shipment_trailer_license_plate		string	None.
shipment_container_number		string	None.
user_id	User ID (GUID)	string	Required Data type: Text
user_signature	MD5 hash signature for the active user to validate the request	string	Required Data type: Text

Request Format

application/json, text/json

Sample:

{
  "shipment_company_id": "sample string 1",
  "shipment_customer_id": "sample string 2",
  "shipment_shape_type_id": 3,
  "shipment_shape_type_type_id": 4,
  "shipment_pallet_count": 5,
  "shipment_type_id": 6,
  "shipment_vehicle_type_id": 7,
  "shipment_vehicle_trailer_type_ids": [
    1,
    2
  ],
  "shipment_vehicle_base_slab_id": 8,
  "shipment_vehicle_capacity_type_id": 9,
  "shipment_payment_type_id": 10,
  "shipment_departure_date": "sample string 11",
  "shipment_departure_address_id": 12,
  "shipment_departure_contact_name": "sample string 13",
  "shipment_departure_contact_phone_number": "sample string 14",
  "shipment_distance": 15.0,
  "shipment_proposal_cost": 16,
  "shipment_proposal_currency_id": 17,
  "shipment_proposal_cost_per_ton": 18,
  "shipment_cubic_meter": "sample string 19",
  "shipment_weight": "sample string 20",
  "shipment_length": "sample string 21",
  "shipment_remark": "sample string 22",
  "shipment_custom_id": "sample string 23",
  "enable_public_notification": true,
  "vehicle_count": 25,
  "shipment_destinations": [
    {
      "shipment_arrival_date": "sample string 1",
      "shipment_arrival_address_id": 2,
      "shipment_arrival_contact_name": "sample string 3",
      "shipment_arrival_contact_phone_number": "sample string 4",
      "shipment_freight_waybill_no": "sample string 5",
      "shipment_freight_delivery_no": "sample string 6",
      "shipment_buyer_id": "sample string 7",
      "shipment_buyer_name": "sample string 8",
      "shipment_buyer_phone_number": "sample string 9",
      "shipment_buyer_email": "sample string 10",
      "shipment_arrival_external_address_id": "sample string 11",
      "shipment_arrival_address_details": "sample string 12",
      "shipment_stop_pallet_count": 13,
      "shipment_stop_cubic_meter": 14.0,
      "shipment_stop_weight": 15.0
    },
    {
      "shipment_arrival_date": "sample string 1",
      "shipment_arrival_address_id": 2,
      "shipment_arrival_contact_name": "sample string 3",
      "shipment_arrival_contact_phone_number": "sample string 4",
      "shipment_freight_waybill_no": "sample string 5",
      "shipment_freight_delivery_no": "sample string 6",
      "shipment_buyer_id": "sample string 7",
      "shipment_buyer_name": "sample string 8",
      "shipment_buyer_phone_number": "sample string 9",
      "shipment_buyer_email": "sample string 10",
      "shipment_arrival_external_address_id": "sample string 11",
      "shipment_arrival_address_details": "sample string 12",
      "shipment_stop_pallet_count": 13,
      "shipment_stop_cubic_meter": 14.0,
      "shipment_stop_weight": 15.0
    }
  ],
  "shipment_temperature": 26,
  "shipment_offer_user_id": "sample string 27",
  "shipment_offer_vehicle_id": 28,
  "shipment_has_adr": true,
  "shipment_is_unpriced": true,
  "shipment_show_offerable_list": true,
  "shipment_offerable_company_list": [
    "sample string 1",
    "sample string 2"
  ],
  "shipment_has_blank_load": true,
  "shipment_departure_address_departure_date": "2024-11-25T22:54:43.264801+03:00",
  "shipment_customer_custom_code": "sample string 33",
  "shipment_departure_stop_pallet_count": 34,
  "shipment_departure_stop_cubic_meter": 35.0,
  "shipment_departure_stop_weight": 36.0,
  "shipment_trailer_license_plate": "sample string 37",
  "shipment_container_number": "sample string 38",
  "user_id": "sample string 39",
  "user_signature": "sample string 40"
}

Response Information

Resource Description

WEB - ADD NEW SHIPMENT

ShipmentAddResultModel

Name	Description	Type	Additional information
response		ShipmentsModel	None.
meta	Basic meta information for the operation result	MetaModel	None.

Response Format

application/json, text/json

Sample:

{
  "response": {
    "shipments": [
      null,
      {
        "shipment_id": 1,
        "shipment_uid": "sample string 2",
        "shipment_company_id": "sample string 3",
        "company_name": "sample string 4",
        "shipment_customer_id": "sample string 5",
        "shipment_group_id": "sample string 6",
        "shipment_shape_type_id": "sample string 7",
        "shipment_shape_type_type_id": "sample string 8",
        "shipment_type_id": "sample string 9",
        "shipment_vehicle_type_id": "sample string 10",
        "shipment_pallet_count": 1,
        "shipment_vehicle_trailer_type_id": "sample string 11",
        "shipment_vehicle_trailer_type_ids": [
          {
            "shipment_vehicle_trailer_type_id": 1
          },
          {
            "shipment_vehicle_trailer_type_id": 1
          }
        ],
        "shipment_vehicle_base_slab_id": "sample string 12",
        "shipment_vehicle_capacity_type_id": "sample string 13",
        "shipment_payment_type_id": 1,
        "shipment_departure_date": "2024-11-25T22:54:43.2708007+03:00",
        "shipment_departure_address_id": 15,
        "shipment_distance": 1.0,
        "shipment_proposal_cost": "sample string 16",
        "shipment_proposal_currency_id": 17,
        "shipment_proposal_cost_per_ton": 18,
        "shipment_accepted_cost": 1,
        "shipment_cubic_meter": "sample string 19",
        "shipment_weight": "sample string 20",
        "shipment_length": "sample string 21",
        "shipment_remark": "sample string 22",
        "shipment_state": 1,
        "shipment_accepted_offer_id": 1,
        "shipment_freight_delivery_invoice": "sample string 23",
        "shipment_custom_id": "sample string 24",
        "shipment_offer_count": 1,
        "shipment_latitude": 1.1,
        "shipment_longitude": 1.1,
        "shipment_date_time": "2024-11-25T22:54:43.2708007+03:00",
        "shipment_has_problem": true,
        "shipment_departure_address": {
          "address_id": 1,
          "address_stop_id": "sample string 2",
          "address_name": "sample string 3",
          "address_country_id": 5,
          "address_city_id": 6,
          "address_city_name": "sample string 7",
          "address_district": "sample string 8",
          "address_neighborhood": "sample string 9",
          "address_street": "sample string 10",
          "address_building_number": "sample string 11",
          "address_contact_name": "sample string 12",
          "address_contact_phone_number": "sample string 13",
          "address_arrival_date": "sample string 14",
          "shipment_freight_departure_bill": "sample string 15",
          "shipment_freight_delivery_bill": "sample string 16",
          "shipment_freight_delivery_bill_missing": true,
          "location_latitude": "sample string 1",
          "location_longitude": "sample string 2",
          "address_location": {
            "latitude": "sample string 1",
            "longitude": "sample string 2"
          },
          "address_zip_code": "sample string 19",
          "address_is_active": true,
          "shipment_freight_waybill_no": "sample string 21",
          "departure_bill_date": "2024-11-25T22:54:43.2708007+03:00",
          "delivery_bill_date": "2024-11-25T22:54:43.2708007+03:00",
          "destination_entry_date": "2024-11-25T22:54:43.2708007+03:00",
          "destination_exit_date": "2024-11-25T22:54:43.2708007+03:00",
          "driver_arrival_address_time_spent": 1,
          "address_description": "sample string 22",
          "address_create_date": "2024-11-25T22:54:43.2708007+03:00",
          "address_user_name": "sample string 23",
          "shipment_freight_delivery_no": "sample string 24",
          "required_documents": [
            {
              "required_document": {
                "id": 1,
                "name": "sample string 2",
                "type": 3
              },
              "document": {
                "id": 1,
                "image": "sample string 2",
                "type": 3
              }
            },
            {
              "required_document": {
                "id": 1,
                "name": "sample string 2",
                "type": 3
              },
              "document": {
                "id": 1,
                "image": "sample string 2",
                "type": 3
              }
            }
          ],
          "address_external_id": "sample string 25",
          "shipment_stop_pallet_count": 1,
          "shipment_stop_cubic_meter": 1.0,
          "shipment_stop_weight": 1.0
        },
        "shipment_destinations": [
          {
            "address_id": 1,
            "address_stop_id": "sample string 2",
            "address_name": "sample string 3",
            "address_country_id": 5,
            "address_city_id": 6,
            "address_city_name": "sample string 7",
            "address_district": "sample string 8",
            "address_neighborhood": "sample string 9",
            "address_street": "sample string 10",
            "address_building_number": "sample string 11",
            "address_contact_name": "sample string 12",
            "address_contact_phone_number": "sample string 13",
            "address_arrival_date": "sample string 14",
            "shipment_freight_departure_bill": "sample string 15",
            "shipment_freight_delivery_bill": "sample string 16",
            "shipment_freight_delivery_bill_missing": true,
            "location_latitude": "sample string 1",
            "location_longitude": "sample string 2",
            "address_location": {
              "latitude": "sample string 1",
              "longitude": "sample string 2"
            },
            "address_zip_code": "sample string 19",
            "address_is_active": true,
            "shipment_freight_waybill_no": "sample string 21",
            "departure_bill_date": "2024-11-25T22:54:43.2708007+03:00",
            "delivery_bill_date": "2024-11-25T22:54:43.2708007+03:00",
            "destination_entry_date": "2024-11-25T22:54:43.2708007+03:00",
            "destination_exit_date": "2024-11-25T22:54:43.2708007+03:00",
            "driver_arrival_address_time_spent": 1,
            "address_description": "sample string 22",
            "address_create_date": "2024-11-25T22:54:43.2708007+03:00",
            "address_user_name": "sample string 23",
            "shipment_freight_delivery_no": "sample string 24",
            "required_documents": [
              {
                "required_document": {
                  "id": 1,
                  "name": "sample string 2",
                  "type": 3
                },
                "document": {
                  "id": 1,
                  "image": "sample string 2",
                  "type": 3
                }
              },
              {
                "required_document": {
                  "id": 1,
                  "name": "sample string 2",
                  "type": 3
                },
                "document": {
                  "id": 1,
                  "image": "sample string 2",
                  "type": 3
                }
              }
            ],
            "address_external_id": "sample string 25",
            "shipment_stop_pallet_count": 1,
            "shipment_stop_cubic_meter": 1.0,
            "shipment_stop_weight": 1.0
          },
          {
            "address_id": 1,
            "address_stop_id": "sample string 2",
            "address_name": "sample string 3",
            "address_country_id": 5,
            "address_city_id": 6,
            "address_city_name": "sample string 7",
            "address_district": "sample string 8",
            "address_neighborhood": "sample string 9",
            "address_street": "sample string 10",
            "address_building_number": "sample string 11",
            "address_contact_name": "sample string 12",
            "address_contact_phone_number": "sample string 13",
            "address_arrival_date": "sample string 14",
            "shipment_freight_departure_bill": "sample string 15",
            "shipment_freight_delivery_bill": "sample string 16",
            "shipment_freight_delivery_bill_missing": true,
            "location_latitude": "sample string 1",
            "location_longitude": "sample string 2",
            "address_location": {
              "latitude": "sample string 1",
              "longitude": "sample string 2"
            },
            "address_zip_code": "sample string 19",
            "address_is_active": true,
            "shipment_freight_waybill_no": "sample string 21",
            "departure_bill_date": "2024-11-25T22:54:43.2708007+03:00",
            "delivery_bill_date": "2024-11-25T22:54:43.2708007+03:00",
            "destination_entry_date": "2024-11-25T22:54:43.2708007+03:00",
            "destination_exit_date": "2024-11-25T22:54:43.2708007+03:00",
            "driver_arrival_address_time_spent": 1,
            "address_description": "sample string 22",
            "address_create_date": "2024-11-25T22:54:43.2708007+03:00",
            "address_user_name": "sample string 23",
            "shipment_freight_delivery_no": "sample string 24",
            "required_documents": [
              {
                "required_document": {
                  "id": 1,
                  "name": "sample string 2",
                  "type": 3
                },
                "document": {
                  "id": 1,
                  "image": "sample string 2",
                  "type": 3
                }
              },
              {
                "required_document": {
                  "id": 1,
                  "name": "sample string 2",
                  "type": 3
                },
                "document": {
                  "id": 1,
                  "image": "sample string 2",
                  "type": 3
                }
              }
            ],
            "address_external_id": "sample string 25",
            "shipment_stop_pallet_count": 1,
            "shipment_stop_cubic_meter": 1.0,
            "shipment_stop_weight": 1.0
          }
        ],
        "shipment_temperature": 26,
        "offer_confirmation_company_user_name": "sample string 27",
        "shipment_has_adr": true,
        "shipment_is_unpriced": true,
        "shipment_state_reason": 1,
        "shipment_departure_contact_name": "sample string 30",
        "shipment_departure_contact_phone_number": "sample string 31",
        "shipment_has_blank_load": true,
        "shipment_state_update_user_name": "sample string 32",
        "shipment_company_user_id": "sample string 33",
        "shipment_archived": true,
        "shipment_freight_departure_bill_missing": true,
        "shipment_departure_address_arrival_date": "2024-11-25T22:54:43.2708007+03:00",
        "user_last_location_time": "2024-11-25T22:54:43.2708007+03:00",
        "shipment_driver_departure_address_time_spent": 1,
        "shipment_departure_address_json": "",
        "shipment_destinations_address_json": "",
        "shipment_actual_arrival_date": null,
        "shipment_accept_user_id": null,
        "vehicle_licence_plate": null,
        "user_first_name": null,
        "shipment_company_user_name": null,
        "shipment_visit_count": 0,
        "shipment_parent_company_name": null,
        "vehicle_company_user_name": null,
        "vehicle_create_date": null,
        "shipment_arrival_date": null,
        "shipment_departure_document_date": null,
        "shipment_arrival_document_date": null,
        "user_cell_number": null,
        "user_viewed_shipment": false,
        "shipment_company_user_role_name": null,
        "arrival_address_city_id": 0,
        "shipment_payment_cost": null,
        "shipment_tirport_payment_is_active": false,
        "shipment_tirport_payment_is_completed": false,
        "shipment_departure_stop_pallet_count": null,
        "shipment_departure_stop_cubic_meter": null,
        "shipment_departure_stop_weight": null
      }
    ],
    "total_count": 1,
    "shipments_with_missing_documents": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "meta": {
    "status_code": 1,
    "status_message": "sample string 2"
  }
}