POST v1/company/shipment/update

WEB - UPDATE SHIPMENT

Request Information

URI Parameters

None.

Body Parameters

ShipmentUpdateRequestModel
NameDescriptionTypeAdditional information
shipment_uid

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.

enable_public_notification

boolean

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_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:
{
  "shipment_uid": "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",
  "enable_public_notification": true,
  "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": 23,
  "shipment_offer_user_id": "sample string 24",
  "shipment_offer_vehicle_id": 25,
  "shipment_has_adr": true,
  "user_company_id": "sample string 27",
  "user_id": "sample string 28",
  "user_signature": "sample string 29"
}

Response Information

Resource Description

WEB - UPDATE SHIPMENT

BaseMetaResultModel
NameDescriptionTypeAdditional information
meta

Basic meta information for the operation result

MetaModel

None.

Response Format

application/json, text/json

Sample:
{
  "meta": {
    "status_code": 1,
    "status_message": "sample string 2"
  }
}