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

Customer Management

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

Endpoint List

MethodPathHandlerRequest
Post/api/modules/create-customerhandlers.Repo.CreateCustomerCustomerRequest.CustomerCreateRequest
Post/api/modules/create-customer-government-userhandlers.Repo.CreateCustomerGovernmentUserCustomerRequest.CustomerGovernmentUserCreateRequest
Post/api/modules/create-customer-typehandlers.Repo.CreateCustomerTypeCustomerRequest.CustomerTypeCreateRequest
Post/api/modules/delete-customerhandlers.Repo.DeleteCustomerCustomerRequest.CustomerDeleteRequest
Post/api/modules/delete-customer-typehandlers.Repo.DeleteCustomerTypeCustomerRequest.CustomerTypeDeleteRequest
Post/api/modules/list-client-customerhandlers.Repo.ListClientCustomerrequests.ListRequest
Post/api/modules/list-customerhandlers.Repo.ListCustomerrequests.ListRequest
Post/api/modules/list-customer-document-analyzehandlers.Repo.ListCustomerDocumentAnalizerequests.ListRequest
Post/api/modules/list-customer-filterhandlers.Repo.ListCustomerFilter-
Post/api/modules/list-customer-typehandlers.Repo.ListCustomerTyperequests.ListRequest
Post/api/modules/read-customerhandlers.Repo.ReadCustomerrequests.ReadRequest
Get/api/modules/read-customer-government-infohandlers.Repo.ReadCustomerGovernmentInfo-
Post/api/modules/read-customer-typehandlers.Repo.ReadCustomerTyperequests.ReadRequest
Post/api/modules/report-customer-listhandlers.Repo.ReportCustomerList-
Post/api/modules/update-customerhandlers.Repo.UpdateCustomerCustomerRequest.CustomerUpdateRequest
Post/api/modules/update-customer-bannerhandlers.Repo.UpdateCustomerBannerPhotoCustomerRequest.CustomerBannerUpdateRequest
Post/api/modules/update-customer-bulkhandlers.Repo.UpdateBulkCustomerCustomerRequest.CustomerBulkUpdateRequest
Post/api/modules/update-customer-competenceshandlers.Repo.CustomerCompetencesUpdateCustomerRequest.CustomerCompetencesRequest
Post/api/modules/update-customer-logohandlers.Repo.UpdateCustomerLogoCustomerRequest.CustomerLogoUpdateRequest
Post/api/modules/update-customer-profilehandlers.Repo.UpdateCustomerProfileCustomerRequest.CustomerProfileUpdateRequest
Post/api/modules/update-customer-typehandlers.Repo.UpdateCustomerTypeCustomerRequest.CustomerTypeUpdateRequest

Request Example: CustomerRequest.CustomerCreateRequest

{
  "logo_file_id": 0,
  "customer_name": "string",
  "customer_email": "string",
  "mobile_phone_area": "string",
  "mobile_phone_country": "string",
  "mobile_phone": "string",
  "customer_phone": "string",
  "customer_address": "string",
  "province_id": 0,
  "district_id": 0,
  "country_id": 0,
  "post_code": "string",
  "tax_office": "string",
  "tax_number": "string",
  "customer_type": [
    0
  ],
  "erp_code": "string",
  "coordinates": "string",
  "contact_info": "string",
  "authorization_code": "string",
  "latitude": {},
  "longitude": {}
}

Fields:

FieldTypeRequired
logo_file_idintno
customer_namestringyes
customer_emailstringno
mobile_phone_areastringno
mobile_phone_countrystringno
mobile_phonestringno
customer_phonestringno
customer_addressstringyes
province_idintyes
district_idintyes
country_idintyes
post_codestringno
tax_officestringno
tax_numberstringno
customer_type*[]intno
erp_codestringno
coordinates*stringno
contact_info*stringno
authorization_code*stringno
latitude*float64no
longitude*float64no

Request Example: CustomerRequest.CustomerGovernmentUserCreateRequest

{
  "tax_number": "string",
  "citizen_number": "string",
  "password": "string"
}

Fields:

FieldTypeRequired
tax_numberstringno
citizen_numberstringno
passwordstringno

Request Example: CustomerRequest.CustomerTypeCreateRequest

{
  "translation": {}
}

Fields:

FieldTypeRequired
translation[]Translationno

Request Example: CustomerRequest.CustomerDeleteRequest

{
  "customer_id": 0
}

Fields:

FieldTypeRequired
customer_idint64yes

Request Example: CustomerRequest.CustomerTypeDeleteRequest

{
  "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: CustomerRequest.CustomerUpdateRequest

{
  "id": 0,
  "customer_type": [
    0
  ],
  "logo_file_id": 0,
  "country_id": 0,
  "post_code": "string",
  "province_id": 0,
  "district_id": 0,
  "customer_name": "string",
  "customer_address": "string",
  "tax_number": "string",
  "tax_office": "string",
  "telephone": "string",
  "mobile_phone_area": "string",
  "mobile_phone_country": "string",
  "mobile_phone": "string",
  "email": "string",
  "fax": "string",
  "coordinates": "string",
  "web_site": "string",
  "erp_code": "string",
  "contact_info": "string",
  "authorization_code": "string",
  "latitude": {},
  "longitude": {}
}

Fields:

FieldTypeRequired
idint64yes
customer_type*[]intno
logo_file_id*intno
country_id*intno
post_code*stringno
province_id*intno
district_id*intno
customer_namestringyes
customer_address*stringno
tax_number*stringno
tax_office*stringno
telephone*stringno
mobile_phone_area*stringno
mobile_phone_country*stringno
mobile_phone*stringno
email*stringno
fax*stringno
coordinates*stringno
web_site*stringno
erp_code*stringno
contact_info*stringno
authorization_code*stringno
latitude*float64no
longitude*float64no

Request Example: CustomerRequest.CustomerBannerUpdateRequest

{
  "banner_file_id": 0
}

Fields:

FieldTypeRequired
banner_file_id*int64yes

Request Example: CustomerRequest.CustomerBulkUpdateRequest

{
  "ids": [
    0
  ],
  "update_type": "string",
  "customer_type": [
    0
  ]
}

Fields:

FieldTypeRequired
ids[]int64yes
update_typestringyes
customer_type[]intyes

Request Example: CustomerRequest.CustomerCompetencesRequest

{
  "competences": [
    0
  ],
  "customer_id": 0
}

Fields:

FieldTypeRequired
competences*[]intno
customer_idint64no

Request Example: CustomerRequest.CustomerLogoUpdateRequest

{
  "logo_file_id": 0
}

Fields:

FieldTypeRequired
logo_file_id*int64yes

Request Example: CustomerRequest.CustomerProfileUpdateRequest

{
  "country_id": 0,
  "province_id": 0,
  "district_id": 0,
  "post_code": "string",
  "customer_name": "string",
  "customer_address": "string",
  "tax_number": "string",
  "tax_office": "string",
  "telephone": "string",
  "mobile_phone": "string",
  "mobile_phone_area": "string",
  "mobile_phone_country": "string",
  "email": "string",
  "fax": "string",
  "coordinates": "string",
  "web_site": "string",
  "erp_code": "string",
  "logo_file_id": 0,
  "customer_type": [
    0
  ],
  "contact_info": "string",
  "authorization_code": "string",
  "mini_description": "string",
  "description": "string",
  "latitude": {},
  "longitude": {},
  "banner_file_id": 0
}

Fields:

FieldTypeRequired
country_id*int64no
province_id*int64no
district_id*int64no
post_code*stringno
customer_name*stringno
customer_address*stringno
tax_number*stringno
tax_office*stringno
telephone*stringno
mobile_phone*stringno
mobile_phone_area*stringno
mobile_phone_country*stringno
email*stringno
fax*stringno
coordinates*stringno
web_site*stringno
erp_code*stringno
logo_file_id*int64no
customer_type*[]intno
contact_info*stringno
authorization_code*stringno
mini_description*stringno
description*stringno
latitude*float64no
longitude*float64no
banner_file_id*int64no

Request Example: CustomerRequest.CustomerTypeUpdateRequest

{
  "id": 0,
  "translation": {}
}

Fields:

FieldTypeRequired
idint64yes
translation[]UpdateTranslationno

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
Contact ManagementLoad Management