Customer

Last updated 1 year ago

get

/api/app/customer

Query parameters

Keywordstring

BranchIdstring · uuid

Sortingstring

SkipCountinteger · int32 · max: 2147483647

MaxResultCountinteger · int32 · min: 1 · max: 2147483647

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/app/customer'

200

400

401

403

404

500

501

text/plain

application/json

text/json

{
  "totalCount": 1,
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "creationTime": "2025-02-20T19:16:05.761Z",
      "creatorId": "123e4567-e89b-12d3-a456-426614174000",
      "lastModificationTime": "2025-02-20T19:16:05.761Z",
      "lastModifierId": "123e4567-e89b-12d3-a456-426614174000",
      "isDeleted": true,
      "deleterId": "123e4567-e89b-12d3-a456-426614174000",
      "deletionTime": "2025-02-20T19:16:05.761Z",
      "name": "text",
      "mobileNumber": "text",
      "subscriptionStatus": 1,
      "statusString": "text",
      "branchId": "123e4567-e89b-12d3-a456-426614174000",
      "branchName": "text",
      "customerType": 1,
      "customerTypeString": "text",
      "address": "text",
      "crNumber": "text",
      "vatNumber": "text"
    }
  ]
}

Success

post

/api/app/customer

Body

namestring | nullable

mobileNumberstring | nullable

addressstring | nullable

customerTypeinteger · enum

Options: 1, 2

crNumberstring | nullable

vatNumberstring | nullable

branchIdstring · uuid | nullable

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/app/customer' \
  --header 'Content-Type: application/json' \
  --data '{"customerType":1}'

200

400

401

403

404

500

501

text/plain

application/json

text/json

123e4567-e89b-12d3-a456-426614174000

Success

get

/api/app/customer/{id}

Path parameters

idstring · uuidrequired

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/app/customer/{id}'

200

400

401

403

404

500

501

text/plain

application/json

text/json

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "creationTime": "2025-02-20T19:16:05.761Z",
  "creatorId": "123e4567-e89b-12d3-a456-426614174000",
  "lastModificationTime": "2025-02-20T19:16:05.761Z",
  "lastModifierId": "123e4567-e89b-12d3-a456-426614174000",
  "isDeleted": true,
  "deleterId": "123e4567-e89b-12d3-a456-426614174000",
  "deletionTime": "2025-02-20T19:16:05.761Z",
  "name": "text",
  "mobileNumber": "text",
  "subscriptionStatus": 1,
  "statusString": "text",
  "branchId": "123e4567-e89b-12d3-a456-426614174000",
  "branchName": "text",
  "customerType": 1,
  "customerTypeString": "text",
  "address": "text",
  "crNumber": "text",
  "vatNumber": "text"
}

Success

put

/api/app/customer/{id}

Path parameters

idstring · uuidrequired

Body

namestring | nullable

mobileNumberstring | nullable

addressstring | nullable

customerTypeinteger · enum

Options: 1, 2

crNumberstring | nullable

vatNumberstring | nullable

branchIdstring · uuid | nullable

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/app/customer/{id}' \
  --header 'Content-Type: application/json' \
  --data '{"customerType":1}'

200

400

401

403

404

500

501

No body

Success