Get one partner data

This endpoint is deprecated.
POST/api/RPC.common.Api.Partners.get?token=<TOKEN>

Key Partners.get · API version 2.0.0

Parameters

9 body parameters inside data[]
FieldTypeDescription
idIntegerPartner ID
is_companyBooleanThe customer is a Company
egnStringID
eikStringUIC
dds_numStringVAT Number
phoneStringPhone
emailStringE-mail
from_dateStringFrom date
to_dateStringTo date

Request example

Search Partner By ID:
{
   "data" : [
      {
         "id" : 1026831288
      }
   ]
}
Search Partner By Phone, E-mail, UIC, PID:
{
   "data" : [
      {
         "email" : "b.krastev@antipodes.bg",
         "phone" : "+359878100027"
      }
   ]
}

cURL

Search Partner By ID:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -d '{   "data" : [      {         "id" : 1026831288      }   ]}' "https://<DOMAIN_NAME>/api/RPC.common.Api.Partners.get?token=<TOKEN>"
Search Partner by Phone, E-mail, UIC, PID:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -d '{   "data" : [      {         "email" : "b.krastev@antipodes.bg",         "phone" : "+359878100027"      }   ]}' "https://<DOMAIN_NAME>/api/RPC.common.Api.Partners.get?token=<TOKEN>"

Response example

// Success-Response (company):
    HTTP/1.1 200 OK
{
   "total_count" : "Total matching records",
   "count" : "Returned records count",
   "result" : [
      {
         "nickname" : "Nickname",
         "updatedon" : "YYYY-MM-DD HH:MM:SS",
         "createdon" : "YYYY-MM-DD HH:MM:SS",
         "status" : "Partner status",
         "fax" : "Fax",
         "archive" : 0,
         "is_client" : 1,
         "id" : "Partner Id",
         "trader" : "Trader username",
         "is_company" : 1,
         "dds_num" : "VAT number",
         "eik" : "UIC (company)",
         "params" : {
            "Param name" : "Param value"
         },
         "promo_cards" : [
            {
               "last_update_date" : "YYYY-MM-DD HH:MM:SS",
               "status" : "active | archive",
               "points" : "Points balance",
               "num" : "Card number"
            }
         ],
         "name" : "Partner Name",
         "email" : "E-mail",
         "note" : "Note",
         "client_type" : "Client type name",
         "phone" : "Phone",
         "vendor_type" : "Vendor type name",
         "is_vendor" : 0
      }
   ]
}

// Success-Response (person):
    HTTP/1.1 200 OK
{
   "result" : [
      {
         "email" : "E-mail",
         "name" : "Partner Name",
         "promo_cards" : [
            {
               "last_update_date" : "YYYY-MM-DD HH:MM:SS",
               "status" : "active | archive",
               "num" : "Card number",
               "points" : "Points balance"
            }
         ],
         "note" : "Note",
         "client_type" : "Client type name",
         "is_vendor" : 0,
         "vendor_type" : "Vendor type name",
         "phone" : "Phone",
         "createdon" : "YYYY-MM-DD HH:MM:SS",
         "egn" : "PID (person)",
         "updatedon" : "YYYY-MM-DD HH:MM:SS",
         "nickname" : "Nickname",
         "status" : "Partner status",
         "fax" : "Fax",
         "trader" : "Trader username",
         "id" : "Partner Id",
         "archive" : 0,
         "is_client" : 1,
         "params" : {
            "Param name" : "Param value"
         },
         "is_company" : 0
      }
   ],
   "total_count" : "Total matching records",
   "count" : "Returned records count"
}