GET

getClient

GET<baseUrl>/?section=publicInterface&action=getClient

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

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

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

clientPhone^*string—

Відповідь

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

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

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

client not found
client phone not found
access denied

cURL

curl "<baseUrl>/?section=publicInterface&action=getClient&companyId=<companyId>&token=<token>&clientPhone=<clientPhone>"

200 · Успіх

{
  "status": "done",
  "data": {
    "clientId": "<number>",
    "clientName": "<string>",
    "clientPhone": "<string>",
    "clientBalance": "<number>",
    "clientType": "<string>",
    "clientData": {
      "name": "<string>",
      "phone": "<string>",
      "address": "<string>",
      "birth": "<string>",
      "card": "<string>",
      "city": "<string>",
      "comment": "<string>",
      "sex": "<string>",
      "bonusGroup": "<number>",
      "discountGroup": "<number>",
      "email": "<string>",
      "clientDiscount": null
    },
    "purchaseAmount": "<string>",
    "salesHistory": [
      {
        "comment": "<string>",
        "datetime": "<string>",
        "discountId": null,
        "documentId": "<number>",
        "items": [
          {
            "logo": "…",
            "nomenclatureId": "…",
            "nomenclatureName": "…",
            "nomenclatureUnit": "…",
            "price": "…",
            "warehouseId": "…",
            "recipeId": "…",
            "type": "…",
            "categoryId": "…",
            "queryOf": "…",
            "count": "…",
            "status": "…",
            "priceTagColor": "…",
            "description": "…",
            "…": "…"
          }
        ],
        "category": null,
        "price": "<string>",
        "tradepointId": "<number>"
      }
    ],
    "topSales": [
      {
        "logo": "<string>",
        "nomenclatureId": "<number>",
        "nomenclatureName": "<string>",
        "nomenclatureUnit": "<string>",
        "price": "<number>",
        "warehouseId": "<number>",
        "recipeId": "<number>",
        "type": "<string>",
        "categoryId": "<number>",
        "queryOf": {
          "count": "<boolean>",
          "price": "<boolean>"
        },
        "count": "<number>",
        "status": "<string>",
        "priceTagColor": "<string>",
        "description": "<string>",
        "…": "…"
      }
    ],
    "receipts": [
      {
        "comment": "<string>",
        "datetime": "<string>",
        "discountId": null,
        "documentId": "<number>",
        "items": [
          {
            "fat": "…",
            "type": "…",
            "count": "…",
            "price": "…",
            "taxId": "…",
            "markup": "…",
            "status": "…",
            "uktzed": "…",
            "article": "…",
            "caloric": "…",
            "comment": "…",
            "queryOf": "…",
            "barcodes": "…",
            "category": "…",
            "…": "…"
          }
        ],
        "category": null,
        "price": "<string>",
        "tradepointId": "<number>",
        "orderType": "<string>",
        "discount": [],
        "bonus": []
      }
    ]
  }
}

Помилка

{
  "status": "error",
  "error": ["client not found"]
}