POST

createClient

POST<baseUrl>/?section=publicInterface&action=createClient

Приклад запиту

{
  "clientPhone": "380000000000",
  "clientBalance": 0,
  "clientName": "Ivan",
  "clientData": {
    "address": "",
    "city": "Kyiv",
    "birth": "1996-05-08",
    "card": "",
    "comment": "",
    "email": "test@example.com",
    "bonusGroup": null,
    "discountGroup": null,
    "sex": "m"
  }
}

Параметри запиту

ПараметрТипОпис

timezonestringЗсув часового поясу для дат (напр. "+3", "-2").

tradepointIdintegerID торгової точки.

terminalIdinteger—

Тіло запиту JSON

ПолеТипОпис

clientBalancestring—

clientData^*string—

clientName^*string—

clientPhone^*string—

formIdstring—

logostring—

logoNamestring—

Відповідь

Успіх — status: "done" та обʼєкт data.

Повертає довільний обʼєкт у полі data.

Можливі помилки

error with adding client
client with this number has already been added
access denied
enter data

cURL

curl -X POST "<baseUrl>/?section=publicInterface&action=createClient&companyId=<companyId>&token=<token>" \
  -H "Content-Type: application/json" \
  -d '{
    "clientBalance": "...",
    "clientData": "...",
    "clientName": "...",
    "clientPhone": "...",
    "formId": "...",
    "logo": "...",
    "logoName": "..."
  }'

200 · Успіх

{
  "status": "done",
  "data": {
    "clients": {
      "1": {
        "counterpartyId": "<number>",
        "counterpartyName": "<string>",
        "counterpartyType": "<string>",
        "counterpartyData": {
          "sex": "<string>",
          "card": "<string>",
          "city": "<string>",
          "name": "<string>",
          "birth": "<string>",
          "email": "<string>",
          "phone": "<string>",
          "address": "<string>",
          "comment": "<string>",
          "bonusGroup": null,
          "discountGroup": null
        }
      },
      "2": {
        "counterpartyId": "<number>",
        "counterpartyName": "<string>",
        "counterpartyType": "<string>",
        "counterpartyData": {
          "sex": "<string>",
          "card": "<string>",
          "city": "<string>",
          "name": "<string>",
          "birth": "<string>",
          "email": "<string>",
          "phone": "<string>",
          "address": "<string>",
          "comment": "<string>",
          "bonusGroup": null,
          "discountGroup": null
        }
      },
      "3": {
        "counterpartyId": "<number>",
        "counterpartyName": "<string>",
        "counterpartyType": "<string>",
        "counterpartyData": {
          "sex": "<string>",
          "card": "<string>",
          "city": "<string>",
          "name": "<string>",
          "birth": "<string>",
          "email": "<string>",
          "phone": "<string>",
          "address": "<string>",
          "comment": "<string>",
          "bonusGroup": null,
          "discountGroup": null
        }
      }
    }
  }
}

Помилка

{
  "status": "error",
  "error": ["error with adding client"]
}