Zákazníci

unikátním identifikátorem zákazníků je email
pro práci se zákazníky lze využívat webhooky.
více o zákaznících v Upgates e-shopech naleznete zde.

Seznam zákazníků

GET

/api/v2/customers

Seznam zákazníků › query Parameters

creation_time_from

DateTime · date-time

vrátí zákazníky vytvořené od data

datum a čas zapsaný jako řeťezec znaků dle ISO 8601

last_update_time_from

DateTime · date-time

vrátí zákazníky upravené od data

datum a čas zapsaný jako řeťezec znaků dle ISO 8601

code

string

kód zákazníka

customer_id

integer

ID zákazníka

ids

QueryParameterArrayInt

ID zákazníků oddělené středníkem ; nebo jako pole

active_yn

boolean

aktivní / neaktivní

blocked_yn

boolean

blokovaní / neblokovaní

language

Language

kód jazyka dle ISO 639-1

pricelist

string

ceník

email

string · email

phone

string · phone

telefon

company_name

string

název firmy

company_number

string

DIČ

company_vat_number

string

IČO

newsletter_accept

string · enum

akceptuje zákazník newsletter

Enum values:

notset

yes

excluded

page

integer

stránka

Default: 1

Seznam zákazníků › Responses

200

current_page

integer · min: 1

aktuální strana

current_page_items

integer

počet položek na aktuální straně

number_of_items

integer

celkový počet položek

number_of_pages

integer

celkový počet stran

object[]

GET/api/v2/customers

curl --request GET \
  --url /api/v2/customers

shell

Example Responses

{
  "current_page": 1,
  "current_page_items": 1,
  "number_of_items": 1,
  "number_of_pages": 1,
  "customers": [
    {
      "customer_id": 0,
      "type": "contact",
      "degree": "degree",
      "firstname": "firstname",
      "surname": "surname",
      "nickname": "nickname",
      "code": "code",
      "language": "cz",
      "newsletter_yn": true,
      "newsletter_accept": "notset",
      "pricelist": "pricelist",
      "loyalty_system_points": 0,
      "base_turnover": 0,
      "turnover": "turnover",
      "turnover_currency": "CZK",
      "company": {
        "name": "name",
        "company_number": "company_number",
        "vat_number": "vat_number",
        "vat_payer_yn": true
      },
      "communication": {
        "phone": "phone",
        "fax": "fax",
        "im": "im",
        "salutation": "salutation",
        "declension": "declension"
      },
      "login": {
        "active_yn": true,
        "blocked_yn": true,
        "email": "test@example.com"
      },
      "groups": {
        "1": "1"
      },
      "note": "note",
      "addresses": {
        "billing": {
          "street": "street",
          "city": "city",
          "state": "state",
          "zip_code": "zip_code",
          "country_id": "cz"
        },
        "postal": [
          {
            "company_name": "company_name",
            "firstname": "firstname",
            "surname": "surname",
            "street": "street",
            "city": "city",
            "state": "state",
            "zip_code": "zip_code",
            "country_id": "cz"
          }
        ]
      },
      "metas": [
        {
          "key": "key",
          "type": "checkbox",
          "value": "value"
        }
      ],
      "creation_time": "2026-04-28T13:57:48+02:00",
      "last_update_time": "2026-04-28T13:57:48+02:00",
      "admin_url": "admin_url"
    }
  ]
}

json

application/json

Aktualizace zákazníků

PUT

/api/v2/customers

Aktualizace zákazníků › Request Body

object[]

pole objektů se zákazníky

Aktualizace zákazníků › Responses

200

object[]

PUT/api/v2/customers

curl --request PUT \
  --url /api/v2/customers \
  --header 'Content-Type: application/json' \
  --data '
{
  "customers": [
    {
      "type": "contact",
      "degree": "degree",
      "firstname": "firstname",
      "surname": "surname",
      "nickname": "nickname",
      "code": "code",
      "language": "cz",
      "newsletter_accept": "notset",
      "pricelist": "pricelist",
      "base_turnover": 0,
      "note": "note",
      "company": {
        "name": "name",
        "company_number": "company_number",
        "vat_number": "vat_number",
        "vat_payer_yn": true
      },
      "communication": {
        "phone": "phone",
        "fax": "fax",
        "im": "im",
        "salutation": "salutation",
        "declension": "declension"
      },
      "login": {
        "active_yn": true,
        "blocked_yn": true,
        "email": "test@example.com",
        "password": "password"
      },
      "groups": [
        {
          "id": 0
        }
      ],
      "addresses": {
        "billing": {
          "street": "street",
          "city": "city",
          "state": "state",
          "zip_code": "zip_code",
          "country_id": "cz"
        },
        "postal": [
          {
            "company_name": "company_name",
            "firstname": "firstname",
            "surname": "surname",
            "street": "street",
            "city": "city",
            "state": "state",
            "zip_code": "zip_code",
            "country_id": "cz"
          }
        ]
      },
      "metas": [
        {
          "key": "key",
          "value": "value"
        }
      ]
    }
  ]
}
'

shell

Example Request Body

{
  "customers": [
    {
      "type": "contact",
      "degree": "degree",
      "firstname": "firstname",
      "surname": "surname",
      "nickname": "nickname",
      "code": "code",
      "language": "cz",
      "newsletter_accept": "notset",
      "pricelist": "pricelist",
      "base_turnover": 0,
      "note": "note",
      "company": {
        "name": "name",
        "company_number": "company_number",
        "vat_number": "vat_number",
        "vat_payer_yn": true
      },
      "communication": {
        "phone": "phone",
        "fax": "fax",
        "im": "im",
        "salutation": "salutation",
        "declension": "declension"
      },
      "login": {
        "active_yn": true,
        "blocked_yn": true,
        "email": "test@example.com",
        "password": "password"
      },
      "groups": [
        {
          "id": 0
        }
      ],
      "addresses": {
        "billing": {
          "street": "street",
          "city": "city",
          "state": "state",
          "zip_code": "zip_code",
          "country_id": "cz"
        },
        "postal": [
          {
            "company_name": "company_name",
            "firstname": "firstname",
            "surname": "surname",
            "street": "street",
            "city": "city",
            "state": "state",
            "zip_code": "zip_code",
            "country_id": "cz"
          }
        ]
      },
      "metas": [
        {
          "key": "key",
          "value": "value"
        }
      ]
    }
  ]
}

json

Example Responses

{
  "customers": [
    {
      "email": "test@example.com",
      "updated_yn": true,
      "messages": [
        {
          "object": "object",
          "property": "property",
          "message": "message",
          "level": "info"
        }
      ]
    }
  ]
}

json

application/json

Vytvoření zákazníků

POST

/api/v2/customers

Vytvoření zákazníků › Request Body

object[] · required

pole objektů se zákazníky

Vytvoření zákazníků › Responses

200

object[]

pole objektů se zákazníky

POST/api/v2/customers

curl --request POST \
  --url /api/v2/customers \
  --header 'Content-Type: application/json' \
  --data '
{
  "customers": [
    {
      "type": "contact",
      "degree": "degree",
      "firstname": "firstname",
      "surname": "surname",
      "nickname": "nickname",
      "code": "code",
      "language": "cz",
      "newsletter_accept": "notset",
      "pricelist": "pricelist",
      "base_turnover": 0,
      "note": "note",
      "company": {
        "name": "name",
        "company_number": "company_number",
        "vat_number": "vat_number",
        "vat_payer_yn": true
      },
      "communication": {
        "phone": "phone",
        "fax": "fax",
        "im": "im",
        "salutation": "salutation",
        "declension": "declension"
      },
      "login": {
        "active_yn": true,
        "blocked_yn": true,
        "email": "test@example.com",
        "password": "password"
      },
      "groups": [
        {
          "id": 0
        }
      ],
      "addresses": {
        "billing": {
          "street": "street",
          "city": "city",
          "state": "state",
          "zip_code": "zip_code",
          "country_id": "cz"
        },
        "postal": [
          {
            "company_name": "company_name",
            "firstname": "firstname",
            "surname": "surname",
            "street": "street",
            "city": "city",
            "state": "state",
            "zip_code": "zip_code",
            "country_id": "cz"
          }
        ]
      },
      "metas": [
        {
          "key": "key",
          "value": "value"
        }
      ]
    }
  ]
}
'

shell

Example Request Body

{
  "customers": [
    {
      "type": "contact",
      "degree": "degree",
      "firstname": "firstname",
      "surname": "surname",
      "nickname": "nickname",
      "code": "code",
      "language": "cz",
      "newsletter_accept": "notset",
      "pricelist": "pricelist",
      "base_turnover": 0,
      "note": "note",
      "company": {
        "name": "name",
        "company_number": "company_number",
        "vat_number": "vat_number",
        "vat_payer_yn": true
      },
      "communication": {
        "phone": "phone",
        "fax": "fax",
        "im": "im",
        "salutation": "salutation",
        "declension": "declension"
      },
      "login": {
        "active_yn": true,
        "blocked_yn": true,
        "email": "test@example.com",
        "password": "password"
      },
      "groups": [
        {
          "id": 0
        }
      ],
      "addresses": {
        "billing": {
          "street": "street",
          "city": "city",
          "state": "state",
          "zip_code": "zip_code",
          "country_id": "cz"
        },
        "postal": [
          {
            "company_name": "company_name",
            "firstname": "firstname",
            "surname": "surname",
            "street": "street",
            "city": "city",
            "state": "state",
            "zip_code": "zip_code",
            "country_id": "cz"
          }
        ]
      },
      "metas": [
        {
          "key": "key",
          "value": "value"
        }
      ]
    }
  ]
}

json

Example Responses

{
  "customers": [
    {
      "email": "test@example.com",
      "inserted_yn": true,
      "messages": [
        {
          "object": "object",
          "property": "property",
          "message": "message",
          "level": "info"
        }
      ]
    }
  ]
}

json

application/json

Smazání zákazníků

DELETE

/api/v2/customers

Smazání zákazníků › query Parameters

id

integer

ID zákazníka

ids

QueryParameterArrayInt

ID zákazníků oddělené středníkem ; nebo jako pole

email

string · email

Smazání zákazníků › Responses

200

object[]

Seznam souhlasů

GET

/api/v2/customers/{customer_id}/agreements

Vrací seznam souhlasů zákazníka (GDPR).

Seznam souhlasů › path Parameters

customer_id

integer · required

ID zákazníka, povinný parametr

Seznam souhlasů › query Parameters

email

string · email

email zákazníka

only_valid_yn

boolean

vrátí pouze platné souhlasy

status

boolean

pokud bude TRUE, vrátí pouze souhlasy, kde zákazník zaklikl svůj souhlas

agreement_id

integer

ID souhlasu

Seznam souhlasů › Responses

200

object[]

pole objektů se souhlasy

Ověření přihlášení

POST

/api/v2/customers/login

Ověření emailu a hesla zákazníka.

Ověření přihlášení › Request Body

email

string · email · required

přihlašovací email

password

string · required

heslo

Ověření přihlášení › Responses

200

authenticated

boolean

když vrací true, je to platný přihlašovací email a heslo

object[]

chybové zprávy

Webhooky Other endpoints

Seznam zákazníků

GET

/api/v2/customers

Seznam zákazníků › query Parameters

creation_time_from

DateTime · date-time

vrátí zákazníky vytvořené od data

datum a čas zapsaný jako řeťezec znaků dle ISO 8601

last_update_time_from

DateTime · date-time

vrátí zákazníky upravené od data

datum a čas zapsaný jako řeťezec znaků dle ISO 8601

code

string

kód zákazníka

customer_id

integer

ID zákazníka

ids

QueryParameterArrayInt

ID zákazníků oddělené středníkem ; nebo jako pole

active_yn

boolean

aktivní / neaktivní

blocked_yn

boolean

blokovaní / neblokovaní

language

Language

kód jazyka dle ISO 639-1

pricelist

string

ceník

email

string · email

phone

string · phone

telefon

company_name

string

název firmy

company_number

string

DIČ

company_vat_number

string

IČO

newsletter_accept

string · enum

akceptuje zákazník newsletter

Enum values:

notset

yes

excluded

page

integer

stránka

Default: 1

Seznam zákazníků › Responses

200

current_page

integer · min: 1

aktuální strana

current_page_items

integer

počet položek na aktuální straně

number_of_items

integer

celkový počet položek

number_of_pages

integer

celkový počet stran

object[]

Seznam souhlasů

GET

/api/v2/customers/{customer_id}/agreements

Vrací seznam souhlasů zákazníka (GDPR).

Seznam souhlasů › path Parameters

customer_id

integer · required

ID zákazníka, povinný parametr

Seznam souhlasů › query Parameters

email

string · email

email zákazníka

only_valid_yn

boolean

vrátí pouze platné souhlasy

status

boolean

pokud bude TRUE, vrátí pouze souhlasy, kde zákazník zaklikl svůj souhlas

agreement_id

integer

ID souhlasu

Seznam souhlasů › Responses

200

object[]

pole objektů se souhlasy

Ověření přihlášení

POST

/api/v2/customers/login

Ověření emailu a hesla zákazníka.

Ověření přihlášení › Request Body

email

string · email · required

přihlašovací email

password

string · required

heslo

Ověření přihlášení › Responses

200

authenticated

boolean

když vrací true, je to platný přihlašovací email a heslo

object[]

chybové zprávy