Skip to Content
Dgmos dokümantasyonu yayında 🎉
DokümantasyonAPIShipment Parameters

Shipment Parameters

This page is auto-generated from cmd/web/routes.go.

Endpoint List

MethodPathHandlerRequest
Post/api/modules/add-shipment-masterhandlers.Repo.AddShipmentToMasterShipmentRequest.ShipmentMasterAddShipmentRequest
Post/api/modules/create-driver-daily-expeditionhandlers.Repo.CreateDriverDailyExpeditionDriverRequest.DriverDailyExpeditionCreateRequest
Post/api/modules/create-shipment-masterhandlers.Repo.CreateShipmentMasterShipmentRequest.ShipmentMasterCreateRequest
Post/api/modules/delete-shipment-masterhandlers.Repo.DeleteShipmentMasterrequests.DeleteRequest
Post/api/modules/list-carrier-typehandlers.Repo.ListCarrierType-
Post/api/modules/list-driver-expeditionhandlers.Repo.ListDriverExpeditionListByUserIdentityrequests.ListRequest
Post/api/modules/list-driver-last-expeditionhandlers.Repo.ListDriverLastExpeditionByUserIdentityrequests.ListRequest
Post/api/modules/list-driver-vehicle-assignmenthandlers.Repo.ListDriverVehicleAssignmentByUserIdentityrequests.ListRequest
Post/api/modules/list-export-typehandlers.Repo.ListExportType-
Post/api/modules/list-master-equipmenthandlers.Repo.ListMasterEquipmentUnit-
Post/api/modules/list-shipment-categoryhandlers.Repo.ListShipmentCategory-
Post/api/modules/list-shipment-delivery-typehandlers.Repo.ListShipmentDeliveryType-
Post/api/modules/list-shipment-masterhandlers.Repo.ListShipmentMasterrequests.ListRequest
Post/api/modules/list-shipment-notehandlers.Repo.ListShipmentNote-
Post/api/modules/list-shipment-transport-typehandlers.Repo.ListShipmentTransportType-
Post/api/modules/list-shipment-typehandlers.Repo.ListShipmentType-
Post/api/modules/read-shipment-masterhandlers.Repo.ReadShipmentMasterrequests.ReadRequest
Post/api/modules/report-uetds-transactionhandlers.Repo.ListUetdsReportrequests.ListRequest
Post/api/modules/update-shipment-masterhandlers.Repo.UpdateShipmentMasterShipmentRequest.ShipmentMasterUpdateRequest
Post/api/modules/update-shipment-with-masterhandlers.Repo.UpdateShipmentWithMasterShipmentRequest.ShipmentMasterShipmentConnectionRequest

Request Example: ShipmentRequest.ShipmentMasterAddShipmentRequest

{
  "master_id": 0
}

Fields:

FieldTypeRequired
master_idint64yes

Request Example: DriverRequest.DriverDailyExpeditionCreateRequest

{
  "vehicle1_id": 0,
  "vehicle": "string",
  "vehicle2_id": 0,
  "vehicle2": "string",
  "personal_id": 0,
  "identification_number": "string",
  "start_time": 0,
  "end_time": 0
}

Fields:

FieldTypeRequired
vehicle1_id*int64no
vehicle*stringno
vehicle2_id*int64no
vehicle2*stringno
personal_id*int64no
identification_number*stringno
start_time*int64no
end_time*int64no

Request Example: ShipmentRequest.ShipmentMasterCreateRequest

{
  "shipment_export_type_id": 0,
  "carriage_type_id": 0,
  "shipment_type_id": 0,
  "shipment_transport_type_id": 0,
  "master_number": "string",
  "started_at": 0,
  "finished_at": 0,
  "vehicle_type_id": 0,
  "vehicle1_id": 0,
  "vehicle2_id": 0,
  "driver1_id": 0,
  "driver2_id": 0,
  "is_combined_transport": 0,
  "departure_country_id": 0,
  "departure_province_id": 0,
  "arrival_country_id": 0,
  "arrival_province_id": 0,
  "status_id": 0,
  "eta_at": 0,
  "is_transit": 0
}

Fields:

FieldTypeRequired
shipment_export_type_idint64yes
carriage_type_idintno
shipment_type_idintno
shipment_transport_type_idintno
master_numberstringno
started_atint64yes
finished_atint64yes
vehicle_type_idintno
vehicle1_idint64yes
vehicle2_idint64no
driver1_idint64yes
driver2_idint64no
is_combined_transportintno
departure_country_idintno
departure_province_idintno
arrival_country_idintno
arrival_province_idintno
status_idintno
eta_atint64no
is_transitintno

Request Example: requests.DeleteRequest

{
  "id": 0
}

Fields:

FieldTypeRequired
idintyes

Request Example: requests.ListRequest

{
  "per_page": 0,
  "page": 0,
  "sort_column": "string",
  "sort_order": "string"
}

Fields:

FieldTypeRequired
per_pageintyes
pageintyes
sort_columnstringno
sort_orderstringno

Request Example: requests.ReadRequest

{
  "id": 0
}

Fields:

FieldTypeRequired
idintyes

Request Example: ShipmentRequest.ShipmentMasterUpdateRequest

{
  "id": 0,
  "shipment_export_type_id": 0,
  "carriage_type_id": 0,
  "shipment_type_id": 0,
  "shipment_transport_type_id": 0,
  "master_number": "string",
  "started_at": 0,
  "finished_at": 0,
  "vehicle_type_id": 0,
  "vehicle1_id": 0,
  "vehicle2_id": 0,
  "driver1_id": 0,
  "driver2_id": 0,
  "is_combined_transport": 0,
  "departure_country_id": 0,
  "departure_province_id": 0,
  "arrival_country_id": 0,
  "arrival_province_id": 0,
  "status_id": 0,
  "eta_at": 0,
  "is_transit": 0
}

Fields:

FieldTypeRequired
idint64yes
shipment_export_type_idint64no
carriage_type_idintno
shipment_type_idintno
shipment_transport_type_idintno
master_numberstringno
started_atint64yes
finished_atint64yes
vehicle_type_idintno
vehicle1_idint64yes
vehicle2_idint64no
driver1_idint64yes
driver2_idint64no
is_combined_transportintno
departure_country_idintno
departure_province_idintno
arrival_country_idintno
arrival_province_idintno
status_idintno
eta_atint64no
is_transitintno

Request Example: ShipmentRequest.ShipmentMasterShipmentConnectionRequest

{
  "master_id": 0,
  "shipment_ids": [
    0
  ]
}

Fields:

FieldTypeRequired
master_idint64yes
shipment_ids[]int64yes

Response Examples

Create:

{
  "status": "succeeded",
  "message": "record created successfully",
  "id": 1
}

Delete:

{
  "status": "succeeded",
  "message": "deleted successfully"
}

List:

{
  "status": "succeeded",
  "data": [ ],
  "totalPage": 1,
  "currentPage": 1,
  "perPage": 10
}

Read:

{
  "status": "succeeded",
  "data": { }
}

Update:

{
  "status": "succeeded",
  "message": "updated successfully"
}

Error (example):

{
  "status": "invalid_request",
  "message": "validation failed",
  "errors": [ ]
}
Last updated on
Shipment ManagementVehicle Management