Objednávky

unikátním identifikátorem objednávek je číslo objednávky (order_number)
pro práci s objednávkami lze využívat webhooky
více o objednávkách v Upgates e-shopech najdete zde

Seznam objednávek

GET

/api/v2/orders

Seznam objednávek je dostupný po jednotlivých stranách, výstup je omezený na 100 položek na stránku.

Seznam objednávek › query Parameters

order_numbers

QueryParameterArrayString

čísla objednávek oddělená středníkem ; nebo jako pole

creation_time_from

DateTime · date-time

vrátí objednávky vytvořené od tohoto data

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

creation_time_to

DateTime · date-time

vrátí objednávky vytvořené do tohoto data včetně

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

last_update_time_from

DateTime · date-time

vrátí objednávky změněné od tohoto data

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

paid_yn

boolean

pokud je true, vrátí zaplacené objednávky

delivered_yn

boolean

pokud je true, vrátí doručené objednávky

deleted_yn

boolean

pokud je true, vrátí smazané objednávky, pokud není uvedeno vrací pouze objednávky které nejsou smazané

status

string

stav objednávky. Pokud bude prázdný, vrátí objednávky, kde není zadaný žádný stav

status_id

string

ID stavu objednávky

status_ids

QueryParameterArrayInt

ID stavu objednávky oddělená středníkem ; nebo jako pole

language

Language

jazyková mutace, na které objednávka vznikla

kód jazyka dle ISO 639-1

email

string · email

email zákazníka na objednávce

phone

string

telefon zákazníka na objednávce, ve formátu MSISDN

external_order_number

string

číslo objednávky z externího systému

payment_type

PaymentType · enum

typ platby:

cash - hotově
cashOnDelivery - dobírka
command - převodem
moneybookers - skrill
paypal - PayPal
stripe - Stripe
payu - PayU
homecredit - Homecredit
computop - Computop
upgates - Upgates Pay
tatrapay - TatraPay
tatrapayplus - TatraPay+
tatracardpay - Tatra CardPay
comgate - ComGate
gopay - GoPay
fio - Fio
gpwebpay - GP webpay
cofidis - Cofidis
essox - Essox
twisto - Twisto
cashOnCashRegister - hotově na pokladně
cardOnCashRegister - kartou na pokladně
thepay - ThePay
custom - vlastní

Enum values:

cash

cashOnDelivery

command

moneybookers

paypal

stripe

payu

homecredit

shipment_type

ShipmentType · enum

typ dopravy:

ceskaPosta - Česká pošta
balikovna - Balíkovna
slovenskaPosta - Slovenská pošta
sps - SPS
ulozenka - Uloženka
zasilkovna - Zásilkovna
dpd - DPD
ppl - PPL
gls - GLS
wedo - WEDO
custom - Vlastní doprava
individual - Individuální

Enum values:

ceskaPosta

balikovna

slovenskaPosta

sps

zasilkovna

dpd

ppl

gls

page

integer

stránka

Default: 1

order_by

string · enum

řazení:

creation_time - seřadí podle času vytvoření
last_update_time - seřadí podle času změny

Enum values:

creation_time

last_update_time

order_dir

string · enum

směr řazení:

asc - vzestupně
desc - sestupně

Enum values:

asc

desc

Seznam objednávek › 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[]

pole objektů s objednávkami

GET/api/v2/orders

curl /api/v2/orders

Example Responses

{
  "current_page": 1,
  "current_page_items": 1,
  "number_of_items": 1,
  "number_of_pages": 1,
  "orders": [
    {
      "order_number": "order_number",
      "order_id": 0,
      "case_number": "case_number",
      "external_order_number": "external_order_number",
      "uuid": "uuid",
      "language_id": "cs",
      "currency_id": "CZK",
      "default_currency_rate": 0,
      "prices_with_vat_yn": true,
      "status": "status",
      "status_id": 0,
      "paid_date": "2026-04-28",
      "delivered_date": "2026-04-28",
      "tracking_code": "tracking_code",
      "tracking_url": "https://www.example.com/path/to/resource",
      "resolved_yn": true,
      "internal_note": "internal_note",
      "oss_yn": true,
      "statistics_yn": true,
      "last_update_time": "2026-04-28T13:57:48+02:00",
      "creation_time": "2026-04-28T13:57:48+02:00",
      "variable_symbol": 1,
      "dimensions": {
        "width": 0,
        "length": 0,
        "height": 0
      },
      "total_weight": 0,
      "order_total": 0,
      "order_total_before_round": 0,
      "order_total_rest": 0,
      "invoice_number": "invoice_number",
      "origin": "admin",
      "admin_url": "https://www.example.com/path/to/resource",
      "customer": {
        "email": "test@example.com",
        "phone": "phone",
        "code": "code",
        "customer_id": 0,
        "customer_pricelist_id": 0,
        "pricelist_name": "pricelist_name",
        "pricelist_percent": 0,
        "firstname_invoice": "firstname_invoice",
        "surname_invoice": "surname_invoice",
        "street_invoice": "street_invoice",
        "city_invoice": "city_invoice",
        "state_invoice": "state_invoice",
        "zip_invoice": "zip_invoice",
        "country_id_invoice": "country_id_invoice",
        "postal_yn": true,
        "firstname_postal": "firstname_postal",
        "surname_postal": "surname_postal",
        "street_postal": "street_postal",
        "city_postal": "city_postal",
        "state_postal": "state_postal",
        "zip_postal": "zip_postal",
        "country_id_postal": "country_id_postal",
        "company_postal": "company_postal",
        "company_yn": true,
        "company": "company",
        "ico": "ico",
        "dic": "dic",
        "vat_payer_yn": "vat_payer_yn",
        "customer_note": "customer_note",
        "agreements": [
          {
            "name": "name",
            "valid_to": "2026-04-28T13:57:48+02:00",
            "status": {}
          }
        ]
      },
      "products": [
        {
          "product_id": 0,
          "option_set_id": 0,
          "type": "product",
          "uuid": "uuid",
          "parent_uuid": "parent_uuid",
          "code": "code",
          "code_supplier": "code_supplier",
          "supplier": "supplier",
          "ean": "ean",
          "title": "title",
          "adult_yn": {},
          "unit": "unit",
          "length": "length",
          "length_unit": "length_unit",
          "quantity": 0,
          "price_per_unit": 0,
          "price_per_unit_with_vat": 0,
          "price_per_unit_without_vat": 0,
          "price": 0,
          "price_with_vat": 0,
          "price_without_vat": 0,
          "vat": 0,
          "buy_price": 0,
          "recycling_fee": 0,
          "weight": 0,
          "availability": "availability",
          "stock_position": "stock_position",
          "invoice_info": "invoice_info",
          "parameters": [
            {
              "name": "name",
              "value": "value"
            }
          ],
          "configurations": [
            {
              "name": "name",
              "type": "one_value",
              "values": [
                {
                  "value": "value",
                  "operation": "operation",
                  "price": 0
                }
              ]
            }
          ],
          "categories": [
            {
              "category_id": 0,
              "code": "code"
            }
          ],
          "image_url": "https://www.example.com/path/to/resource"
        }
      ],
      "discount_voucher": {
        "code": "code",
        "amount": 0,
        "type": "price",
        "discounts": [
          {
            "price": 0,
            "price_with_vat": 0,
            "price_without_vat": 0,
            "vat": 0
          }
        ]
      },
      "quantity_discount": {
        "amount": 0,
        "type": "price",
        "discounts": [
          {
            "price": 0,
            "price_with_vat": 0,
            "price_without_vat": 0,
            "vat": 0
          }
        ]
      },
      "loyalty_points": {
        "one_point_for": 0,
        "amount": 0,
        "discounts": [
          {
            "price": 0,
            "price_with_vat": 0,
            "price_without_vat": 0,
            "vat": 0
          }
        ]
      },
      "shipment": {
        "id": 0,
        "code": "code",
        "name": "name",
        "price": 0,
        "price_with_vat": 0,
        "price_without_vat": 0,
        "vat": 0,
        "affiliate_id": "affiliate_id",
        "affiliate_name": "affiliate_name",
        "type": "type",
        "packeta_carrier_id": "packeta_carrier_id"
      },
      "payment": {
        "id": 0,
        "code": "code",
        "name": "name",
        "payment_method": "payment_method",
        "price": 0,
        "price_with_vat": 0,
        "price_without_vat": 0,
        "vat": 0,
        "eet_yn": true,
        "type": "type"
      },
      "attachments": [
        {
          "id": 0,
          "name": "name",
          "url": "https://www.example.com/path/to/resource",
          "code": "code"
        }
      ],
      "metas": [
        {
          "key": "key",
          "type": "checkbox",
          "value": "value"
        }
      ]
    }
  ]
}

json

application/json

Aktualizace objednávek

PUT

/api/v2/orders

Při změně stavu se posílají emaily a SMS (pokud jsou nějaké u stavu objednávky nastaveny) a pokud jsou nastaveny atributy send_emails_yn a send_sms_yn.

I když API vrátí HTTP 200 OK, neznamená to že se objednávka aktualizovala, musíte sledovat příznak updated_yn a chybové hlášky messages v odpovědi.

Aktualizace objednávek › Request Body

object[] · required

pole objektů s objednávkami

send_emails_yn

boolean

poslání emailu, který je navázáný na stav objednávky. Výchozí hodnota je true

send_sms_yn

boolean

poslání SMS, která je navázána na stav objednávky. Výchozí hodnota je true (SMS služba není standardně aktivní, více najdete v Nastavení SMS)

delete_missing_products_yn

boolean

pokud je true, smažou se u objednávky produkty které se v požadavku nepošlou. Výchozí hodnota je false

Aktualizace objednávek › Responses

200

object

pole objektů s objednávkami

PUT/api/v2/orders

curl /api/v2/orders \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "send_emails_yn": true,
  "send_sms_yn": true,
  "delete_missing_products_yn": true,
  "orders": [
    {
      "order_number": "order_number",
      "external_order_number": "external_order_number",
      "prices_with_vat_yn": true,
      "status": "status",
      "status_id": 0,
      "paid_date": "2026-04-28",
      "delivered_date": "2026-04-28",
      "tracking_code": "tracking_code",
      "resolved_yn": true,
      "internal_note": "internal_note",
      "statistics_yn": true,
      "variable_symbol": 1,
      "dimensions": {
        "width": 0,
        "length": 0,
        "height": 0
      },
      "customer": {
        "email": "test@example.com",
        "phone": "phone",
        "firstname_invoice": "firstname_invoice",
        "surname_invoice": "surname_invoice",
        "street_invoice": "street_invoice",
        "city_invoice": "city_invoice",
        "state_invoice": "state_invoice",
        "zip_invoice": "zip_invoice",
        "country_id_invoice": "country_id_invoice",
        "postal_yn": true,
        "firstname_postal": "firstname_postal",
        "surname_postal": "surname_postal",
        "street_postal": "street_postal",
        "city_postal": "city_postal",
        "state_postal": "state_postal",
        "zip_postal": "zip_postal",
        "country_id_postal": "country_id_postal",
        "company_postal": "company_postal",
        "company_yn": true,
        "company": "company",
        "ico": "ico",
        "dic": "dic",
        "vat_payer_yn": "vat_payer_yn",
        "pricelist_name": "pricelist_name",
        "pricelist_percent": 0,
        "customer_note": "customer_note"
      },
      "products": [
        {
          "code": "code",
          "code_supplier": "code_supplier",
          "ean": "ean",
          "title": "title",
          "quantity": 0,
          "unit": "unit",
          "price_per_unit": 0,
          "vat": 0,
          "buy_price": 0,
          "recycling_fee": 0,
          "weight": 0,
          "invoice_info": "invoice_info",
          "parameters": [
            {
              "name": "name",
              "value": "value"
            }
          ]
        }
      ],
      "quantity_discount": {
        "amount": 0,
        "type": "price"
      },
      "shipment": {
        "code": "code",
        "name": "name",
        "price": 0,
        "vat": 0,
        "affiliate_id": "affiliate_id",
        "affiliate_name": "affiliate_name"
      },
      "payment": {
        "code": "code",
        "name": "name",
        "price": 0,
        "vat": 0,
        "eet_yn": true
      },
      "metas": [
        {
          "key": "key",
          "value": "value"
        }
      ],
      "invoice": {
        "generate_yn": true,
        "expiration_date": "2026-04-28",
        "date_of_issuance": "2026-04-28",
        "date_of_vat_revenue_recognition": "2026-04-28"
      },
      "receipt": {
        "generate_yn": true,
        "expiration_date": "2026-04-28",
        "date_of_issuance": "2026-04-28",
        "date_of_vat_revenue_recognition": "2026-04-28"
      },
      "credit_note": {
        "generate_yn": true,
        "expiration_date": "2026-04-28",
        "date_of_issuance": "2026-04-28",
        "date_of_vat_revenue_recognition": "2026-04-28"
      }
    }
  ]
}'

Example Request Body

{
  "send_emails_yn": true,
  "send_sms_yn": true,
  "delete_missing_products_yn": true,
  "orders": [
    {
      "order_number": "order_number",
      "external_order_number": "external_order_number",
      "prices_with_vat_yn": true,
      "status": "status",
      "status_id": 0,
      "paid_date": "2026-04-28",
      "delivered_date": "2026-04-28",
      "tracking_code": "tracking_code",
      "resolved_yn": true,
      "internal_note": "internal_note",
      "statistics_yn": true,
      "variable_symbol": 1,
      "dimensions": {
        "width": 0,
        "length": 0,
        "height": 0
      },
      "customer": {
        "email": "test@example.com",
        "phone": "phone",
        "firstname_invoice": "firstname_invoice",
        "surname_invoice": "surname_invoice",
        "street_invoice": "street_invoice",
        "city_invoice": "city_invoice",
        "state_invoice": "state_invoice",
        "zip_invoice": "zip_invoice",
        "country_id_invoice": "country_id_invoice",
        "postal_yn": true,
        "firstname_postal": "firstname_postal",
        "surname_postal": "surname_postal",
        "street_postal": "street_postal",
        "city_postal": "city_postal",
        "state_postal": "state_postal",
        "zip_postal": "zip_postal",
        "country_id_postal": "country_id_postal",
        "company_postal": "company_postal",
        "company_yn": true,
        "company": "company",
        "ico": "ico",
        "dic": "dic",
        "vat_payer_yn": "vat_payer_yn",
        "pricelist_name": "pricelist_name",
        "pricelist_percent": 0,
        "customer_note": "customer_note"
      },
      "products": [
        {
          "code": "code",
          "code_supplier": "code_supplier",
          "ean": "ean",
          "title": "title",
          "quantity": 0,
          "unit": "unit",
          "price_per_unit": 0,
          "vat": 0,
          "buy_price": 0,
          "recycling_fee": 0,
          "weight": 0,
          "invoice_info": "invoice_info",
          "parameters": [
            {
              "name": "name",
              "value": "value"
            }
          ]
        }
      ],
      "quantity_discount": {
        "amount": 0,
        "type": "price"
      },
      "shipment": {
        "code": "code",
        "name": "name",
        "price": 0,
        "vat": 0,
        "affiliate_id": "affiliate_id",
        "affiliate_name": "affiliate_name"
      },
      "payment": {
        "code": "code",
        "name": "name",
        "price": 0,
        "vat": 0,
        "eet_yn": true
      },
      "metas": [
        {
          "key": "key",
          "value": "value"
        }
      ],
      "invoice": {
        "generate_yn": true,
        "expiration_date": "2026-04-28",
        "date_of_issuance": "2026-04-28",
        "date_of_vat_revenue_recognition": "2026-04-28"
      },
      "receipt": {
        "generate_yn": true,
        "expiration_date": "2026-04-28",
        "date_of_issuance": "2026-04-28",
        "date_of_vat_revenue_recognition": "2026-04-28"
      },
      "credit_note": {
        "generate_yn": true,
        "expiration_date": "2026-04-28",
        "date_of_issuance": "2026-04-28",
        "date_of_vat_revenue_recognition": "2026-04-28"
      }
    }
  ]
}

json

Example Responses

{
  "orders": {
    "order_number": "order_number",
    "order_url": "https://www.example.com/path/to/resource",
    "updated_yn": true,
    "messages": [
      {
        "object": "object",
        "property": "property",
        "message": "message",
        "level": "info"
      }
    ]
  }
}

json

application/json

Vytvoření objednávek

POST

/api/v2/orders

Systém během importu objednávek přes API ověřuje zákaznické údaje v e-shopu s těmi v objednávce, když se najde zákazník se shodným emailem, pak je přiřazen k dané objednávce (je vytvořena vazba). Je to z důvodu správného výpočtu statistik. Stejným způsobem to funguje také u dopravy, platby a produktů (variant). Ty se párují podle kódu.

Při vytvoření objednávky se posílají emaily a SMS (pokud jsou nějaké u stavu objednávky nastaveny) a pokud jsou nastaveny atributy send_emails_yn a send_sms_yn.

Číslo objednávky (order_number) se bere vždy z číselné řady, pro poslání vlastního čísla slouží pole external_order_number.

I když API vrátí HTTP 200 OK, neznamená to že se objednávka založila, musíte sledovat příznak created_yn a chybové hlášky messages v odpovědi.

Vytvoření objednávek › Request Body

object[] · required

pole objektů s objednávkami

send_emails_yn

boolean

poslání emailu, který je navázáný na stav objednávky. Výchozí hodnota je true

send_sms_yn

boolean

poslání SMS, která je navázána na stav objednávky. Výchozí hodnota je true (SMS služba není standardně aktivní, více najdete v Nastavení SMS)

Vytvoření objednávek › Responses

200

object

pole objektů s objednávkami

POST/api/v2/orders

curl /api/v2/orders \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "send_emails_yn": true,
  "send_sms_yn": true,
  "orders": [
    {
      "external_order_number": "external_order_number",
      "language_id": "cs",
      "prices_with_vat_yn": true,
      "status": "status",
      "status_id": 0,
      "paid_date": "2026-04-28",
      "delivered_date": "2026-04-28",
      "tracking_code": "tracking_code",
      "resolved_yn": true,
      "internal_note": "internal_note",
      "statistics_yn": true,
      "variable_symbol": 1,
      "creation_time": "2026-04-28T13:57:48+02:00",
      "dimensions": {
        "width": 0,
        "length": 0,
        "height": 0
      },
      "customer": {
        "email": "test@example.com",
        "phone": "phone",
        "firstname_invoice": "firstname_invoice",
        "surname_invoice": "surname_invoice",
        "street_invoice": "street_invoice",
        "city_invoice": "city_invoice",
        "state_invoice": "state_invoice",
        "zip_invoice": "zip_invoice",
        "country_id_invoice": "country_id_invoice",
        "postal_yn": true,
        "firstname_postal": "firstname_postal",
        "surname_postal": "surname_postal",
        "street_postal": "street_postal",
        "city_postal": "city_postal",
        "state_postal": "state_postal",
        "zip_postal": "zip_postal",
        "country_id_postal": "country_id_postal",
        "company_postal": "company_postal",
        "company_yn": true,
        "company": "company",
        "ico": "ico",
        "dic": "dic",
        "vat_payer_yn": "vat_payer_yn",
        "pricelist_name": "pricelist_name",
        "pricelist_percent": 0,
        "customer_note": "customer_note"
      },
      "products": [
        {
          "code": "code",
          "code_supplier": "code_supplier",
          "ean": "ean",
          "title": "title",
          "quantity": 0,
          "unit": "unit",
          "price_per_unit": 0,
          "vat": 0,
          "buy_price": 0,
          "recycling_fee": 0,
          "weight": 0,
          "invoice_info": "invoice_info",
          "parameters": [
            {
              "name": "name",
              "value": "value"
            }
          ]
        }
      ],
      "quantity_discount": {
        "amount": 0,
        "type": "price"
      },
      "shipment": {
        "code": "code",
        "name": "name",
        "price": 0,
        "vat": 0,
        "affiliate_id": "affiliate_id",
        "affiliate_name": "affiliate_name"
      },
      "payment": {
        "code": "code",
        "name": "name",
        "price": 0,
        "vat": 0,
        "eet_yn": true
      },
      "metas": [
        {
          "key": "key",
          "value": "value"
        }
      ],
      "invoice": {
        "generate_yn": true,
        "expiration_date": "2026-04-28",
        "date_of_issuance": "2026-04-28",
        "date_of_vat_revenue_recognition": "2026-04-28"
      },
      "receipt": {
        "generate_yn": true,
        "expiration_date": "2026-04-28",
        "date_of_issuance": "2026-04-28",
        "date_of_vat_revenue_recognition": "2026-04-28"
      }
    }
  ]
}'

Example Request Body

{
  "send_emails_yn": true,
  "send_sms_yn": true,
  "orders": [
    {
      "external_order_number": "external_order_number",
      "language_id": "cs",
      "prices_with_vat_yn": true,
      "status": "status",
      "status_id": 0,
      "paid_date": "2026-04-28",
      "delivered_date": "2026-04-28",
      "tracking_code": "tracking_code",
      "resolved_yn": true,
      "internal_note": "internal_note",
      "statistics_yn": true,
      "variable_symbol": 1,
      "creation_time": "2026-04-28T13:57:48+02:00",
      "dimensions": {
        "width": 0,
        "length": 0,
        "height": 0
      },
      "customer": {
        "email": "test@example.com",
        "phone": "phone",
        "firstname_invoice": "firstname_invoice",
        "surname_invoice": "surname_invoice",
        "street_invoice": "street_invoice",
        "city_invoice": "city_invoice",
        "state_invoice": "state_invoice",
        "zip_invoice": "zip_invoice",
        "country_id_invoice": "country_id_invoice",
        "postal_yn": true,
        "firstname_postal": "firstname_postal",
        "surname_postal": "surname_postal",
        "street_postal": "street_postal",
        "city_postal": "city_postal",
        "state_postal": "state_postal",
        "zip_postal": "zip_postal",
        "country_id_postal": "country_id_postal",
        "company_postal": "company_postal",
        "company_yn": true,
        "company": "company",
        "ico": "ico",
        "dic": "dic",
        "vat_payer_yn": "vat_payer_yn",
        "pricelist_name": "pricelist_name",
        "pricelist_percent": 0,
        "customer_note": "customer_note"
      },
      "products": [
        {
          "code": "code",
          "code_supplier": "code_supplier",
          "ean": "ean",
          "title": "title",
          "quantity": 0,
          "unit": "unit",
          "price_per_unit": 0,
          "vat": 0,
          "buy_price": 0,
          "recycling_fee": 0,
          "weight": 0,
          "invoice_info": "invoice_info",
          "parameters": [
            {
              "name": "name",
              "value": "value"
            }
          ]
        }
      ],
      "quantity_discount": {
        "amount": 0,
        "type": "price"
      },
      "shipment": {
        "code": "code",
        "name": "name",
        "price": 0,
        "vat": 0,
        "affiliate_id": "affiliate_id",
        "affiliate_name": "affiliate_name"
      },
      "payment": {
        "code": "code",
        "name": "name",
        "price": 0,
        "vat": 0,
        "eet_yn": true
      },
      "metas": [
        {
          "key": "key",
          "value": "value"
        }
      ],
      "invoice": {
        "generate_yn": true,
        "expiration_date": "2026-04-28",
        "date_of_issuance": "2026-04-28",
        "date_of_vat_revenue_recognition": "2026-04-28"
      },
      "receipt": {
        "generate_yn": true,
        "expiration_date": "2026-04-28",
        "date_of_issuance": "2026-04-28",
        "date_of_vat_revenue_recognition": "2026-04-28"
      }
    }
  ]
}

json

Example Responses

{
  "orders": {
    "external_order_number": "external_order_number",
    "order_number": "order_number",
    "order_url": "https://www.example.com/path/to/resource",
    "created_yn": true,
    "messages": [
      {
        "object": "object",
        "property": "property",
        "message": "message",
        "level": "info"
      }
    ]
  }
}

json

application/json

Smazání objednávek

DELETE

/api/v2/orders

Smazání objednávek › query Parameters

order_number

string

číslo objednávky

order_numbers

QueryParameterArrayString

čísla objednávek oddělená středníkem ; nebo pole

complete_delete_yn

bool

true - objednávka se smaže nenávratně i se všemi dokumenty
false (výchozí) - označí se pouze jako smazaná. Taková objednávka je vidět v administraci v seznamu objednávek přes filtr Smazáno.

Smazání objednávek › Responses

200

object[]

Detail objednávky

GET

/api/v2/orders/{order_number}

Detail objednávky › path Parameters

order_number

string · required

číslo objednávky

Detail objednávky › 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[]

pole objektů s objednávkami

GET/api/v2/orders/{order_number}

curl /api/v2/orders/:order_number

Example Responses

{
  "current_page": 1,
  "current_page_items": 1,
  "number_of_items": 1,
  "number_of_pages": 1,
  "orders": [
    {
      "order_number": "order_number",
      "order_id": 0,
      "case_number": "case_number",
      "external_order_number": "external_order_number",
      "uuid": "uuid",
      "language_id": "cs",
      "currency_id": "CZK",
      "default_currency_rate": 0,
      "prices_with_vat_yn": true,
      "status": "status",
      "status_id": 0,
      "paid_date": "2026-04-28",
      "delivered_date": "2026-04-28",
      "tracking_code": "tracking_code",
      "tracking_url": "https://www.example.com/path/to/resource",
      "resolved_yn": true,
      "internal_note": "internal_note",
      "oss_yn": true,
      "statistics_yn": true,
      "last_update_time": "2026-04-28T13:57:48+02:00",
      "creation_time": "2026-04-28T13:57:48+02:00",
      "variable_symbol": 1,
      "dimensions": {
        "width": 0,
        "length": 0,
        "height": 0
      },
      "total_weight": 0,
      "order_total": 0,
      "order_total_before_round": 0,
      "order_total_rest": 0,
      "invoice_number": "invoice_number",
      "origin": "admin",
      "admin_url": "https://www.example.com/path/to/resource",
      "customer": {
        "email": "test@example.com",
        "phone": "phone",
        "code": "code",
        "customer_id": 0,
        "customer_pricelist_id": 0,
        "pricelist_name": "pricelist_name",
        "pricelist_percent": 0,
        "firstname_invoice": "firstname_invoice",
        "surname_invoice": "surname_invoice",
        "street_invoice": "street_invoice",
        "city_invoice": "city_invoice",
        "state_invoice": "state_invoice",
        "zip_invoice": "zip_invoice",
        "country_id_invoice": "country_id_invoice",
        "postal_yn": true,
        "firstname_postal": "firstname_postal",
        "surname_postal": "surname_postal",
        "street_postal": "street_postal",
        "city_postal": "city_postal",
        "state_postal": "state_postal",
        "zip_postal": "zip_postal",
        "country_id_postal": "country_id_postal",
        "company_postal": "company_postal",
        "company_yn": true,
        "company": "company",
        "ico": "ico",
        "dic": "dic",
        "vat_payer_yn": "vat_payer_yn",
        "customer_note": "customer_note",
        "agreements": [
          {
            "name": "name",
            "valid_to": "2026-04-28T13:57:48+02:00",
            "status": {}
          }
        ]
      },
      "products": [
        {
          "product_id": 0,
          "option_set_id": 0,
          "type": "product",
          "uuid": "uuid",
          "parent_uuid": "parent_uuid",
          "code": "code",
          "code_supplier": "code_supplier",
          "supplier": "supplier",
          "ean": "ean",
          "title": "title",
          "adult_yn": {},
          "unit": "unit",
          "length": "length",
          "length_unit": "length_unit",
          "quantity": 0,
          "price_per_unit": 0,
          "price_per_unit_with_vat": 0,
          "price_per_unit_without_vat": 0,
          "price": 0,
          "price_with_vat": 0,
          "price_without_vat": 0,
          "vat": 0,
          "buy_price": 0,
          "recycling_fee": 0,
          "weight": 0,
          "availability": "availability",
          "stock_position": "stock_position",
          "invoice_info": "invoice_info",
          "parameters": [
            {
              "name": "name",
              "value": "value"
            }
          ],
          "configurations": [
            {
              "name": "name",
              "type": "one_value",
              "values": [
                {
                  "value": "value",
                  "operation": "operation",
                  "price": 0
                }
              ]
            }
          ],
          "categories": [
            {
              "category_id": 0,
              "code": "code"
            }
          ],
          "image_url": "https://www.example.com/path/to/resource"
        }
      ],
      "discount_voucher": {
        "code": "code",
        "amount": 0,
        "type": "price",
        "discounts": [
          {
            "price": 0,
            "price_with_vat": 0,
            "price_without_vat": 0,
            "vat": 0
          }
        ]
      },
      "quantity_discount": {
        "amount": 0,
        "type": "price",
        "discounts": [
          {
            "price": 0,
            "price_with_vat": 0,
            "price_without_vat": 0,
            "vat": 0
          }
        ]
      },
      "loyalty_points": {
        "one_point_for": 0,
        "amount": 0,
        "discounts": [
          {
            "price": 0,
            "price_with_vat": 0,
            "price_without_vat": 0,
            "vat": 0
          }
        ]
      },
      "shipment": {
        "id": 0,
        "code": "code",
        "name": "name",
        "price": 0,
        "price_with_vat": 0,
        "price_without_vat": 0,
        "vat": 0,
        "affiliate_id": "affiliate_id",
        "affiliate_name": "affiliate_name",
        "type": "type",
        "packeta_carrier_id": "packeta_carrier_id"
      },
      "payment": {
        "id": 0,
        "code": "code",
        "name": "name",
        "payment_method": "payment_method",
        "price": 0,
        "price_with_vat": 0,
        "price_without_vat": 0,
        "vat": 0,
        "eet_yn": true,
        "type": "type"
      },
      "attachments": [
        {
          "id": 0,
          "name": "name",
          "url": "https://www.example.com/path/to/resource",
          "code": "code"
        }
      ],
      "metas": [
        {
          "key": "key",
          "type": "checkbox",
          "value": "value"
        }
      ]
    }
  ]
}

json

application/json

Objednávka v PDF

GET

/api/v2/orders/{order_number}/pdf

Vrací dokument objednávky ve formátu PDF.

Objednávka v PDF › path Parameters

order_number

string · required

číslo objednávky

Objednávka v PDF › Responses

200

string · binary

Nastavení eshopu Objednávky - historie

Seznam objednávek

GET

/api/v2/orders

Seznam objednávek je dostupný po jednotlivých stranách, výstup je omezený na 100 položek na stránku.

Seznam objednávek › query Parameters

order_numbers

QueryParameterArrayString

čísla objednávek oddělená středníkem ; nebo jako pole

creation_time_from

DateTime · date-time

vrátí objednávky vytvořené od tohoto data

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

creation_time_to

DateTime · date-time

vrátí objednávky vytvořené do tohoto data včetně

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

last_update_time_from

DateTime · date-time

vrátí objednávky změněné od tohoto data

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

paid_yn

boolean

pokud je true, vrátí zaplacené objednávky

delivered_yn

boolean

pokud je true, vrátí doručené objednávky

deleted_yn

boolean

pokud je true, vrátí smazané objednávky, pokud není uvedeno vrací pouze objednávky které nejsou smazané

status

string

stav objednávky. Pokud bude prázdný, vrátí objednávky, kde není zadaný žádný stav

status_id

string

ID stavu objednávky

status_ids

QueryParameterArrayInt

ID stavu objednávky oddělená středníkem ; nebo jako pole

language

Language

jazyková mutace, na které objednávka vznikla

kód jazyka dle ISO 639-1

email

string · email

email zákazníka na objednávce

phone

string

telefon zákazníka na objednávce, ve formátu MSISDN

external_order_number

string

číslo objednávky z externího systému

payment_type

PaymentType · enum

typ platby:

cash - hotově
cashOnDelivery - dobírka
command - převodem
moneybookers - skrill
paypal - PayPal
stripe - Stripe
payu - PayU
homecredit - Homecredit
computop - Computop
upgates - Upgates Pay
tatrapay - TatraPay
tatrapayplus - TatraPay+
tatracardpay - Tatra CardPay
comgate - ComGate
gopay - GoPay
fio - Fio
gpwebpay - GP webpay
cofidis - Cofidis
essox - Essox
twisto - Twisto
cashOnCashRegister - hotově na pokladně
cardOnCashRegister - kartou na pokladně
thepay - ThePay
custom - vlastní

Enum values:

cash

cashOnDelivery

command

moneybookers

paypal

stripe

payu

homecredit

shipment_type

ShipmentType · enum

typ dopravy:

ceskaPosta - Česká pošta
balikovna - Balíkovna
slovenskaPosta - Slovenská pošta
sps - SPS
ulozenka - Uloženka
zasilkovna - Zásilkovna
dpd - DPD
ppl - PPL
gls - GLS
wedo - WEDO
custom - Vlastní doprava
individual - Individuální

Enum values:

ceskaPosta

balikovna

slovenskaPosta

sps

zasilkovna

dpd

ppl

gls

page

integer

stránka

Default: 1

order_by

string · enum

řazení:

creation_time - seřadí podle času vytvoření
last_update_time - seřadí podle času změny

Enum values:

creation_time

last_update_time

order_dir

string · enum

směr řazení:

asc - vzestupně
desc - sestupně

Enum values:

asc

desc

Seznam objednávek › 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[]

pole objektů s objednávkami

Aktualizace objednávek

PUT

/api/v2/orders

Při změně stavu se posílají emaily a SMS (pokud jsou nějaké u stavu objednávky nastaveny) a pokud jsou nastaveny atributy send_emails_yn a send_sms_yn.

I když API vrátí HTTP 200 OK, neznamená to že se objednávka aktualizovala, musíte sledovat příznak updated_yn a chybové hlášky messages v odpovědi.

Aktualizace objednávek › Request Body

object[] · required

pole objektů s objednávkami

send_emails_yn

boolean

poslání emailu, který je navázáný na stav objednávky. Výchozí hodnota je true

send_sms_yn

boolean

poslání SMS, která je navázána na stav objednávky. Výchozí hodnota je true (SMS služba není standardně aktivní, více najdete v Nastavení SMS)

delete_missing_products_yn

boolean

pokud je true, smažou se u objednávky produkty které se v požadavku nepošlou. Výchozí hodnota je false

Aktualizace objednávek › Responses

200

object

pole objektů s objednávkami

Vytvoření objednávek

POST

/api/v2/orders

Při vytvoření objednávky se posílají emaily a SMS (pokud jsou nějaké u stavu objednávky nastaveny) a pokud jsou nastaveny atributy send_emails_yn a send_sms_yn.

Číslo objednávky (order_number) se bere vždy z číselné řady, pro poslání vlastního čísla slouží pole external_order_number.

I když API vrátí HTTP 200 OK, neznamená to že se objednávka založila, musíte sledovat příznak created_yn a chybové hlášky messages v odpovědi.

Vytvoření objednávek › Request Body

object[] · required

pole objektů s objednávkami

send_emails_yn

boolean

poslání emailu, který je navázáný na stav objednávky. Výchozí hodnota je true

send_sms_yn

boolean

poslání SMS, která je navázána na stav objednávky. Výchozí hodnota je true (SMS služba není standardně aktivní, více najdete v Nastavení SMS)

Vytvoření objednávek › Responses

200

object

pole objektů s objednávkami

Smazání objednávek

DELETE

/api/v2/orders

Smazání objednávek › query Parameters

order_number

string

číslo objednávky

order_numbers

QueryParameterArrayString

čísla objednávek oddělená středníkem ; nebo pole

complete_delete_yn

bool

true - objednávka se smaže nenávratně i se všemi dokumenty
false (výchozí) - označí se pouze jako smazaná. Taková objednávka je vidět v administraci v seznamu objednávek přes filtr Smazáno.

Smazání objednávek › Responses

200

object[]

Detail objednávky

GET

/api/v2/orders/{order_number}

Detail objednávky › path Parameters

order_number

string · required

číslo objednávky

Detail objednávky › 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[]

pole objektů s objednávkami