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

Shipment Management

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

Endpoint List

MethodPathHandlerRequest
Post/api/modules/create-shipmenthandlers.Repo.CreateShipmentShipmentRequest.ShipmentCreateRequest
Post/api/modules/delete-shipmenthandlers.Repo.DeleteShipmentrequests.DeleteRequest
Post/api/modules/delete-shipment-itemhandlers.Repo.DeleteShipmentItemrequests.DeleteRequest
Post/api/modules/list-shipmenthandlers.Repo.ListShipmentrequests.ListRequest
Post/api/modules/read-shipmenthandlers.Repo.ReadShipmentrequests.ReadRequest
Post/api/modules/report-shipmenthandlers.Repo.ReportShipmentrequests.ReadRequest
Post/api/modules/update-shipmenthandlers.Repo.UpdateShipmentDetailShipmentRequest.ShipmentAndItemsUpdateRequest
Post/api/modules/update-shipment-headerhandlers.Repo.UpdateHeaderShipmentShipmentRequest.ShipmentUpdateHeaderRequest
Post/api/modules/update-shipment-itemhandlers.Repo.UpdateShipmentItemShipmentRequest.ShipmentItemUpdateRequest
Post/api/modules/update-shipment-statushandlers.Repo.UpdateShipmentStatusShipmentRequest.ShipmentStatusUpdateRequest

Request Example: ShipmentRequest.ShipmentCreateRequest

{
  "loading_at": 0,
  "loading_point_id": 0,
  "transported_at": 0,
  "unloading_at": 0,
  "unloading_point_id": 0,
  "shipment_number": "string",
  "order_number": "string",
  "shipment_date": 0,
  "sender_id": 0,
  "receiver_id": 0,
  "carrier_id": 0,
  "shipment_note": "string",
  "shipment_type_id": 0,
  "shipment_delivery_type_id": 0,
  "transport_unit_id": 0,
  "transport_unit_code": "string",
  "shipment_code": "string",
  "external_code": "string",
  "vehicle1_id": 0,
  "vehicle2_id": 0,
  "driver1_id": 0,
  "driver2_id": 0,
  "items": {}
}

Fields:

FieldTypeRequired
loading_atint64no
loading_point_idint64no
transported_atint64no
unloading_atint64no
unloading_point_id*int64no
shipment_number*stringno
order_number*stringno
shipment_date*int64no
sender_id*int64no
receiver_id*int64no
carrier_id*int64no
shipment_note*stringno
shipment_type_id*intno
shipment_delivery_type_id*intno
transport_unit_id*intno
transport_unit_code*stringno
shipment_code*stringno
external_code*stringno
vehicle1_id*int64no
vehicle2_id*int64no
driver1_id*int64no
driver2_id*int64no
items[]ShipmentItemCreateRequestno

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.ShipmentAndItemsUpdateRequest

{
  "id": 0,
  "loading_at": 0,
  "loading_point_id": 0,
  "transported_at": 0,
  "unloading_at": 0,
  "unloading_point_id": 0,
  "shipment_number": "string",
  "order_number": "string",
  "shipment_date": 0,
  "sender_id": 0,
  "receiver_id": 0,
  "carrier_id": 0,
  "shipment_note": "string",
  "shipment_type_id": 0,
  "shipment_delivery_type_id": 0,
  "transport_unit_id": 0,
  "transport_unit_code": "string",
  "shipment_code": "string",
  "external_code": "string",
  "vehicle1_id": 0,
  "vehicle2_id": 0,
  "driver1_id": 0,
  "driver2_id": 0,
  "items": {}
}

Fields:

FieldTypeRequired
idint64no
loading_atint64no
loading_point_idint64no
transported_atint64no
unloading_atint64no
unloading_point_id*int64no
shipment_number*stringno
order_number*stringno
shipment_dateint64no
sender_idint64no
receiver_idint64no
carrier_id*int64no
shipment_note*stringno
shipment_type_id*intno
shipment_delivery_type_id*intno
transport_unit_id*intno
transport_unit_code*stringno
shipment_code*stringno
external_code*stringno
vehicle1_id*int64no
vehicle2_id*int64no
driver1_id*int64no
driver2_id*int64no
items[]ShipmentItemsUpdateRequestno

Request Example: ShipmentRequest.ShipmentUpdateHeaderRequest

{
  "id": 0,
  "loading_at": 0,
  "loading_point_id": 0,
  "transported_at": 0,
  "unloading_at": 0,
  "unloading_point_id": 0,
  "shipment_number": "string",
  "order_number": "string",
  "shipment_date": 0,
  "sender_id": 0,
  "receiver_id": 0,
  "carrier_id": 0,
  "shipment_note": "string",
  "shipment_type_id": 0,
  "shipment_delivery_type_id": 0,
  "transport_unit_id": 0,
  "transport_unit_code": "string",
  "shipment_code": "string",
  "external_code": "string",
  "vehicle1_id": 0,
  "vehicle2_id": 0,
  "driver1_id": 0,
  "driver2_id": 0,
  "status_id": 0
}

Fields:

FieldTypeRequired
idint64no
loading_atint64no
loading_point_idint64no
transported_atint64no
unloading_atint64no
unloading_point_id*int64no
shipment_number*stringno
order_number*stringno
shipment_dateint64no
sender_idint64no
receiver_idint64no
carrier_id*int64no
shipment_note*stringno
shipment_type_id*intno
shipment_delivery_type_id*intno
transport_unit_id*intno
transport_unit_code*stringno
shipment_code*stringno
external_code*stringno
vehicle1_id*int64no
vehicle2_id*int64no
driver1_id*int64no
driver2_id*int64no
status_idint64no

Request Example: ShipmentRequest.ShipmentItemUpdateRequest

{
  "id": 0,
  "shipment_id": 0,
  "load_id": 0,
  "load_barcode": "string",
  "load_transport_category_id": 0,
  "load_description": "string",
  "load_transport_type_id": 0,
  "quantity": 0,
  "load_unit_id": 0,
  "unno_id": "string",
  "amount_unit_id": 0,
  "amount": {},
  "exemption_id": 0
}

Fields:

FieldTypeRequired
id*int64no
shipment_id*int64no
load_id*int64no
load_barcodestringno
load_transport_category_idint64no
load_description*stringno
load_transport_type_id*int64no
quantity*int64no
load_unit_idint64no
unno_idstringno
amount_unit_idint64no
amountfloat64no
exemption_idint64no

Request Example: ShipmentRequest.ShipmentStatusUpdateRequest

{
  "shipment_ids": [
    0
  ],
  "status_id": 0,
  "description": "string",
  "status_date": 0,
  "file_ids": [
    0
  ]
}

Fields:

FieldTypeRequired
shipment_ids[]int64no
status_idint64no
descriptionstringno
status_dateint64no
file_ids[]int64no

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 Expedition ManagementShipment Parameters