POST v1/company/shipment/address/detail

WEB - COMPANY ADDRESSES BY ID

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
address_id		integer	Required
user_company_id	Company UID of the active user	string	Required Data type: Text
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:

{
  "address_id": 1,
  "user_company_id": "sample string 2",
  "user_id": "sample string 3",
  "user_signature": "sample string 4"
}

Response Information

Resource Description

WEB - COMPANY ADDRESSES BY ID

BaseMetaResultModelOfShipmentAddressModel

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

Response Format

application/json, text/json

Sample:

{
  "response": {
    "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-04-20T12:13:03.7135228+03:00",
    "delivery_bill_date": "2024-04-20T12:13:03.7135228+03:00",
    "destination_entry_date": "2024-04-20T12:13:03.7135228+03:00",
    "destination_exit_date": "2024-04-20T12:13:03.7135228+03:00",
    "driver_arrival_address_time_spent": 1,
    "address_description": "sample string 22",
    "address_create_date": "2024-04-20T12:13:03.7135228+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
  },
  "meta": {
    "status_code": 1,
    "status_message": "sample string 2"
  }
}