POST v1/company/shipment/address/add

WEB - ADD NEW ADDRESS.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
address_company_id		string	Required Data type: Text
address_customer_id		string	Required Data type: Text
address_name		string	Required Data type: Text
address_country_id		integer	None.
address_city_id		integer	Required
address_city_name		string	None.
address_district		string	Required Data type: Text
address_neighborhood		string	Data type: Text
address_street		string	Data type: Text
address_building_number		string	Data type: Text
address_zip_code		string	Data type: Text
address_location_latitude		decimal number	Required Data type: Text
address_location_longitude		decimal number	Required Data type: Text
address_description		string	Data type: Text
address_external_id		string	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_company_id": "sample string 1",
  "address_customer_id": "sample string 2",
  "address_name": "sample string 3",
  "address_country_id": 1,
  "address_city_id": 4,
  "address_city_name": "sample string 5",
  "address_district": "sample string 6",
  "address_neighborhood": "sample string 7",
  "address_street": "sample string 8",
  "address_building_number": "sample string 9",
  "address_zip_code": "sample string 10",
  "address_location_latitude": 11.1,
  "address_location_longitude": 12.1,
  "address_description": "sample string 13",
  "address_external_id": "sample string 14",
  "user_id": "sample string 15",
  "user_signature": "sample string 16"
}

Response Information

Resource Description

WEB - ADD NEW ADDRESS.

ShipmentAddressAddResultModel

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

Response Format

application/json, text/json

Sample:

{
  "response": {
    "addresses": [
      {
        "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:45:54.0696862+03:00",
        "delivery_bill_date": "2024-11-25T22:45:54.0696862+03:00",
        "destination_entry_date": "2024-11-25T22:45:54.0696862+03:00",
        "destination_exit_date": "2024-11-25T22:45:54.0696862+03:00",
        "driver_arrival_address_time_spent": 1,
        "address_description": "sample string 22",
        "address_create_date": "2024-11-25T22:45:54.0696862+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:45:54.0696862+03:00",
        "delivery_bill_date": "2024-11-25T22:45:54.0696862+03:00",
        "destination_entry_date": "2024-11-25T22:45:54.0696862+03:00",
        "destination_exit_date": "2024-11-25T22:45:54.0696862+03:00",
        "driver_arrival_address_time_spent": 1,
        "address_description": "sample string 22",
        "address_create_date": "2024-11-25T22:45:54.0696862+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"
  }
}