POST v1/company/shipment/share/detail

Request Information

URI Parameters

None.

Body Parameters

ShipmentShareDetailsRequestModel
NameDescriptionTypeAdditional information
shipment_share_token

Shipment share token acquired by the API

string

Required

Data type: Text

Max length: 32

Min length: 32

Request Format

application/json, text/json

Sample:
{
  "shipment_share_token": "sample string 1"
}

Response Information

Resource Description

BaseMetaResultModelOfShipmentModel
NameDescriptionTypeAdditional information
response

ShipmentModel

None.

meta

Basic meta information for the operation result

MetaModel

None.

Response Format

application/json, text/json

Sample:
{
  "response": {
    "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-05-21T12:18:24.5754259+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_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-05-21T12:18:24.5754259+03:00",
      "delivery_bill_date": "2018-05-21T12:18:24.5754259+03:00",
      "destination_entry_date": "2018-05-21T12:18:24.5754259+03:00",
      "destination_exit_date": "2018-05-21T12:18:24.5754259+03:00"
    },
    "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-05-21T12:18:24.5754259+03:00",
        "delivery_bill_date": "2018-05-21T12:18:24.5754259+03:00",
        "destination_entry_date": "2018-05-21T12:18:24.5754259+03:00",
        "destination_exit_date": "2018-05-21T12:18:24.5754259+03:00"
      },
      {
        "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-05-21T12:18:24.5754259+03:00",
        "delivery_bill_date": "2018-05-21T12:18:24.5754259+03:00",
        "destination_entry_date": "2018-05-21T12:18:24.5754259+03:00",
        "destination_exit_date": "2018-05-21T12:18:24.5754259+03:00"
      }
    ],
    "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_user_id": 1
  },
  "meta": {
    "status_code": 1,
    "status_message": "sample string 2"
  }
}