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_ids

Collection of 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_proposal_currency_id

integer

None.

shipment_proposal_cost_per_ton

integer

None.

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.

shipment_is_unpriced

boolean

None.

shipment_state_reason

integer

None.

shipment_show_offerable_list

boolean

None.

shipment_custom_id

string

None.

shipment_customer_custom_code

string

None.

shipment_departure_stop_pallet_count

integer

None.

shipment_departure_stop_cubic_meter

decimal number

None.

shipment_departure_stop_weight

decimal number

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_ids": [
    1,
    2
  ],
  "shipment_vehicle_base_slab_id": 8,
  "shipment_vehicle_capacity_type_id": 9,
  "shipment_payment_type_id": 10,
  "shipment_departure_date": "sample string 11",
  "shipment_departure_address_id": 12,
  "shipment_departure_contact_name": "sample string 13",
  "shipment_departure_contact_phone_number": "sample string 14",
  "shipment_distance": 15.0,
  "shipment_proposal_cost": 16,
  "shipment_proposal_currency_id": 17,
  "shipment_proposal_cost_per_ton": 18,
  "shipment_cubic_meter": "sample string 19",
  "shipment_weight": "sample string 20",
  "shipment_length": "sample string 21",
  "shipment_remark": "sample string 22",
  "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_freight_waybill_no": "sample string 5",
      "shipment_freight_delivery_no": "sample string 6",
      "shipment_buyer_id": "sample string 7",
      "shipment_buyer_name": "sample string 8",
      "shipment_buyer_phone_number": "sample string 9",
      "shipment_buyer_email": "sample string 10",
      "shipment_arrival_external_address_id": "sample string 11",
      "shipment_arrival_address_details": "sample string 12",
      "shipment_stop_pallet_count": 13,
      "shipment_stop_cubic_meter": 14.0,
      "shipment_stop_weight": 15.0
    },
    {
      "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_freight_waybill_no": "sample string 5",
      "shipment_freight_delivery_no": "sample string 6",
      "shipment_buyer_id": "sample string 7",
      "shipment_buyer_name": "sample string 8",
      "shipment_buyer_phone_number": "sample string 9",
      "shipment_buyer_email": "sample string 10",
      "shipment_arrival_external_address_id": "sample string 11",
      "shipment_arrival_address_details": "sample string 12",
      "shipment_stop_pallet_count": 13,
      "shipment_stop_cubic_meter": 14.0,
      "shipment_stop_weight": 15.0
    }
  ],
  "shipment_temperature": 24,
  "shipment_offer_user_id": "sample string 25",
  "shipment_offer_vehicle_id": 26,
  "shipment_has_adr": true,
  "shipment_is_unpriced": true,
  "shipment_state_reason": 1,
  "shipment_show_offerable_list": true,
  "shipment_custom_id": "sample string 29",
  "shipment_customer_custom_code": "sample string 30",
  "shipment_departure_stop_pallet_count": 31,
  "shipment_departure_stop_cubic_meter": 32.0,
  "shipment_departure_stop_weight": 33.0,
  "user_company_id": "sample string 34",
  "user_id": "sample string 35",
  "user_signature": "sample string 36"
}

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"
  }
}