POST v1/company/shipment/add

WEB - ADD NEW SHIPMENT

Request Information

URI Parameters

None.

Body Parameters

ShipmentAddRequestModel
NameDescriptionTypeAdditional 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_id

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_cubic_meter

string

None.

shipment_weight

string

Required

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.

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_id": 8,
  "shipment_vehicle_base_slab_id": 9,
  "shipment_vehicle_capacity_type_id": 10,
  "shipment_payment_type_id": 11,
  "shipment_departure_date": "sample string 12",
  "shipment_departure_address_id": 13,
  "shipment_departure_contact_name": "sample string 14",
  "shipment_departure_contact_phone_number": "sample string 15",
  "shipment_distance": 16.0,
  "shipment_proposal_cost": 17,
  "shipment_cubic_meter": "sample string 18",
  "shipment_weight": "sample string 19",
  "shipment_length": "sample string 20",
  "shipment_remark": "sample string 21",
  "shipment_custom_id": "sample string 22",
  "enable_public_notification": true,
  "vehicle_count": 24,
  "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_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_temperature": 25,
  "shipment_offer_user_id": "sample string 26",
  "shipment_offer_vehicle_id": 27,
  "shipment_has_adr": true,
  "user_id": "sample string 29",
  "user_signature": "sample string 30"
}

Response Information

Resource Description

WEB - ADD NEW SHIPMENT

ShipmentAddResultModel
NameDescriptionTypeAdditional information
response

ShipmentsModel

None.

meta

Basic meta information for the operation result

MetaModel

None.

Response Format

application/json, text/json

Sample:
{
  "response": {
    "shipments": [
      {
        "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_base_slab_id": "sample string 12",
        "shipment_vehicle_capacity_type_id": "sample string 13",
        "shipment_payment_type_id": 1,
        "shipment_departure_date": "2018-11-21T08:26:26.7425787+03:00",
        "shipment_distance": 1.0,
        "shipment_proposal_cost": "sample string 15",
        "shipment_accepted_cost": 1,
        "shipment_cubic_meter": "sample string 16",
        "shipment_weight": "sample string 17",
        "shipment_length": "sample string 18",
        "shipment_remark": "sample string 19",
        "shipment_state": 1,
        "shipment_accepted_offer_id": 1,
        "shipment_freight_delivery_invoice": "sample string 20",
        "shipment_custom_id": "sample string 21",
        "shipment_offer_count": 1,
        "shipment_latitude": 1.1,
        "shipment_longitude": 1.1,
        "shipment_date_time": "2018-11-21T08:26:26.7425787+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",
          "address_location": {
            "latitude": "sample string 1",
            "longitude": "sample string 2"
          },
          "address_zip_code": "sample string 19",
          "address_is_active": true,
          "departure_bill_date": "2018-11-21T08:26:26.7425787+03:00",
          "delivery_bill_date": "2018-11-21T08:26:26.7425787+03:00",
          "destination_entry_date": "2018-11-21T08:26:26.7425787+03:00",
          "destination_exit_date": "2018-11-21T08:26:26.7425787+03:00",
          "address_description": "sample string 21"
        },
        "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",
            "address_location": {
              "latitude": "sample string 1",
              "longitude": "sample string 2"
            },
            "address_zip_code": "sample string 19",
            "address_is_active": true,
            "departure_bill_date": "2018-11-21T08:26:26.7425787+03:00",
            "delivery_bill_date": "2018-11-21T08:26:26.7425787+03:00",
            "destination_entry_date": "2018-11-21T08:26:26.7425787+03:00",
            "destination_exit_date": "2018-11-21T08:26:26.7425787+03:00",
            "address_description": "sample string 21"
          },
          {
            "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",
            "address_location": {
              "latitude": "sample string 1",
              "longitude": "sample string 2"
            },
            "address_zip_code": "sample string 19",
            "address_is_active": true,
            "departure_bill_date": "2018-11-21T08:26:26.7425787+03:00",
            "delivery_bill_date": "2018-11-21T08:26:26.7425787+03:00",
            "destination_entry_date": "2018-11-21T08:26:26.7425787+03:00",
            "destination_exit_date": "2018-11-21T08:26:26.7425787+03:00",
            "address_description": "sample string 21"
          }
        ],
        "shipment_temperature": 23,
        "offer_confirmation_company_user_name": "sample string 24",
        "shipment_has_adr": true,
        "shipment_container_id": 1,
        "shipment_vehicle_id": 1,
        "shipment_trailer_id": 1,
        "shipment_accept_user_id": 1,
        "vehicle_licence_plate": "sample string 26",
        "user_first_name": "sample string 27",
        "shipment_company_user_name": "sample string 28"
      },
      {
        "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_base_slab_id": "sample string 12",
        "shipment_vehicle_capacity_type_id": "sample string 13",
        "shipment_payment_type_id": 1,
        "shipment_departure_date": "2018-11-21T08:26:26.7425787+03:00",
        "shipment_distance": 1.0,
        "shipment_proposal_cost": "sample string 15",
        "shipment_accepted_cost": 1,
        "shipment_cubic_meter": "sample string 16",
        "shipment_weight": "sample string 17",
        "shipment_length": "sample string 18",
        "shipment_remark": "sample string 19",
        "shipment_state": 1,
        "shipment_accepted_offer_id": 1,
        "shipment_freight_delivery_invoice": "sample string 20",
        "shipment_custom_id": "sample string 21",
        "shipment_offer_count": 1,
        "shipment_latitude": 1.1,
        "shipment_longitude": 1.1,
        "shipment_date_time": "2018-11-21T08:26:26.7425787+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",
          "address_location": {
            "latitude": "sample string 1",
            "longitude": "sample string 2"
          },
          "address_zip_code": "sample string 19",
          "address_is_active": true,
          "departure_bill_date": "2018-11-21T08:26:26.7425787+03:00",
          "delivery_bill_date": "2018-11-21T08:26:26.7425787+03:00",
          "destination_entry_date": "2018-11-21T08:26:26.7425787+03:00",
          "destination_exit_date": "2018-11-21T08:26:26.7425787+03:00",
          "address_description": "sample string 21"
        },
        "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",
            "address_location": {
              "latitude": "sample string 1",
              "longitude": "sample string 2"
            },
            "address_zip_code": "sample string 19",
            "address_is_active": true,
            "departure_bill_date": "2018-11-21T08:26:26.7425787+03:00",
            "delivery_bill_date": "2018-11-21T08:26:26.7425787+03:00",
            "destination_entry_date": "2018-11-21T08:26:26.7425787+03:00",
            "destination_exit_date": "2018-11-21T08:26:26.7425787+03:00",
            "address_description": "sample string 21"
          },
          {
            "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",
            "address_location": {
              "latitude": "sample string 1",
              "longitude": "sample string 2"
            },
            "address_zip_code": "sample string 19",
            "address_is_active": true,
            "departure_bill_date": "2018-11-21T08:26:26.7425787+03:00",
            "delivery_bill_date": "2018-11-21T08:26:26.7425787+03:00",
            "destination_entry_date": "2018-11-21T08:26:26.7425787+03:00",
            "destination_exit_date": "2018-11-21T08:26:26.7425787+03:00",
            "address_description": "sample string 21"
          }
        ],
        "shipment_temperature": 23,
        "offer_confirmation_company_user_name": "sample string 24",
        "shipment_has_adr": true,
        "shipment_container_id": 1,
        "shipment_vehicle_id": 1,
        "shipment_trailer_id": 1,
        "shipment_accept_user_id": 1,
        "vehicle_licence_plate": "sample string 26",
        "user_first_name": "sample string 27",
        "shipment_company_user_name": "sample string 28"
      }
    ],
    "total_count": 1
  },
  "meta": {
    "status_code": 1,
    "status_message": "sample string 2"
  }
}