POST v1/company/shipment/address/add

WEB - ADD NEW ADDRESS.

Request Information

URI Parameters

None.

Body Parameters

ShipmentAddressAddRequestModel
NameDescriptionTypeAdditional 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

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,
  "user_id": "sample string 13",
  "user_signature": "sample string 14"
}

Response Information

Resource Description

WEB - ADD NEW ADDRESS.

ShipmentAddressAddResultModel
NameDescriptionTypeAdditional 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",
        "address_location": {
          "latitude": "sample string 1",
          "longitude": "sample string 2"
        },
        "address_zip_code": "sample string 19",
        "address_is_active": true,
        "departure_bill_date": "2018-09-22T21:24:46.4099494+03:00",
        "delivery_bill_date": "2018-09-22T21:24:46.4099494+03:00",
        "destination_entry_date": "2018-09-22T21:24:46.4099494+03:00",
        "destination_exit_date": "2018-09-22T21:24:46.4099494+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-09-22T21:24:46.4099494+03:00",
        "delivery_bill_date": "2018-09-22T21:24:46.4099494+03:00",
        "destination_entry_date": "2018-09-22T21:24:46.4099494+03:00",
        "destination_exit_date": "2018-09-22T21:24:46.4099494+03:00"
      }
    ]
  },
  "meta": {
    "status_code": 1,
    "status_message": "sample string 2"
  }
}