Перейти до вмісту
ShopentlyLearn
Українська

Отримати — Замовлення

Отримайте дані з «Замовлення». Результат залежить від параметрів цієї операції.

GET/api/v1/orders/{order_id}

Автентифікація
Bearer
Доступно починаючи з
BASIC
Потрібні дозволи
orders.order:read

Приклади коду

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

cURL

: "${SHOPENTLY_SHOP_URL:?}"

curl --disable --globoff --fail-with-body --silent --show-error \
  --proto '=https' --connect-timeout 5 --max-time 30 \
  --request GET \
  --header "Authorization: Bearer ${SHOPENTLY_ACCESS_TOKEN:?}" \
  --url "${SHOPENTLY_SHOP_URL%/}"/api/v1/orders/example

PHP

<?php
declare(strict_types=1);

$baseUrl = rtrim(getenv('SHOPENTLY_SHOP_URL') ?: '', '/');
$origin = parse_url($baseUrl);
if (!$origin || ($origin['scheme'] ?? '') !== 'https' || empty($origin['host']) ||
    isset($origin['user'], $origin['pass']) || isset($origin['user']) || isset($origin['path']) ||
    isset($origin['query']) || isset($origin['fragment'])) {
    throw new RuntimeException('SHOPENTLY_SHOP_URL must be an HTTPS origin');
}
$credential = getenv('SHOPENTLY_ACCESS_TOKEN') ?: '';
if ($credential === '' || strpbrk($credential, "\r\n") !== false) {
    throw new RuntimeException('Invalid credential');
}
$headers = [];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/orders/example');
curl_setopt_array($handle, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_FOLLOWLOCATION => false,
    CURLOPT_PROTOCOLS => CURLPROTO_HTTPS,
    CURLOPT_SSL_VERIFYPEER => true,
    CURLOPT_SSL_VERIFYHOST => 2,
    CURLOPT_CONNECTTIMEOUT => 5,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HEADERFUNCTION => static function ($handle, string $line) use (&$responseHeaders): int {
        if (str_contains($line, ':')) {
            [$name, $value] = explode(':', $line, 2);
            $responseHeaders[strtolower(trim($name))] = trim($value);
        }
        return strlen($line);
    },
]);
$raw = curl_exec($handle);
$status = curl_getinfo($handle, CURLINFO_RESPONSE_CODE);
$error = curl_error($handle);
curl_close($handle);
if ($raw === false) {
    throw new RuntimeException('Transport error: ' . $error);
}
if ($status < 200 || $status >= 300) {
    throw new RuntimeException('HTTP ' . $status . '; request_id=' .
        ($responseHeaders['x-request-id'] ?? '') . '; retry_after=' . ($responseHeaders['retry-after'] ?? ''));
}
$result = $raw === '' ? null : json_decode($raw, true, 512, JSON_THROW_ON_ERROR | JSON_BIGINT_AS_STRING);
echo json_encode($result, JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE), PHP_EOL;

Python

from contextlib import ExitStack
import json
import os
from urllib.parse import urlsplit

import requests  # python -m pip install requests

base_url = os.environ["SHOPENTLY_SHOP_URL"].rstrip("/")
origin = urlsplit(base_url)
if origin.scheme != "https" or not origin.hostname or origin.username or origin.password or origin.path or origin.query or origin.fragment:
    raise ValueError("SHOPENTLY_SHOP_URL must be an HTTPS origin")
credential = os.environ['SHOPENTLY_ACCESS_TOKEN']
if not credential or "\r" in credential or "\n" in credential:
    raise ValueError("Invalid credential")
headers = {}
headers["Authorization"] = 'Bearer' + " " + credential
body = None
if body is not None:
    headers["Content-Type"] = "application/json"

with ExitStack() as stack:
    session = stack.enter_context(requests.Session())
    files = None
    if False:
        image = stack.enter_context(open(os.environ["SHOPENTLY_IMAGE_FILE"], "rb"))
        if os.fstat(image.fileno()).st_size > 5242880:
            raise ValueError("Image exceeds 5 MiB")
        files = {"file": ("article.png", image, "image/png")}
    response = session.request(
        'GET', base_url + '/api/v1/orders/example', headers=headers,
        data=body.encode("utf-8") if body is not None else None, files=files,
        timeout=(5, 30), allow_redirects=False,
    )
    if not 200 <= response.status_code < 300:
        raise RuntimeError(f"HTTP {response.status_code}; request_id={response.headers.get('X-Request-ID', '')}; retry_after={response.headers.get('Retry-After', '')}")
    if False:
        if response.headers.get("Content-Type") != "image/webp" or len(response.content) > 5242880:
            raise ValueError("Unexpected image response")
        with open(os.environ["SHOPENTLY_OUTPUT_FILE"], "xb") as output:
            output.write(response.content)
    else:
        result = response.json() if response.content else None
        print(json.dumps(result, ensure_ascii=False, indent=2))

Приклад відповіді 200

JSON
{
  "data": {
    "created_at": "2026-10-19T10:00:00Z",
    "customer": {
      "email": "customer@example.invalid",
      "first_name": "Example",
      "last_name": "Example",
      "phone": null
    },
    "delivery": {
      "amount": {
        "amount": "0.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "dates": {
        "dispatch_timezone": "Europe/Warsaw",
        "estimated_delivery_from": "2026-10-20",
        "estimated_delivery_to": "2026-10-21",
        "planned_dispatch_on": "2026-10-19"
      },
      "discount_gross": {
        "amount": "24.60",
        "currency": "PLN",
        "minor_units": 2
      },
      "discount_net": {
        "amount": "20.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "discount_tax": {
        "amount": "4.60",
        "currency": "PLN",
        "minor_units": 2
      },
      "discounts": [
        {
          "amount": {
            "amount": "24.60",
            "currency": "PLN",
            "minor_units": 2
          },
          "campaign_id": "saved-coupon",
          "code": "SAVE",
          "kind": "coupon",
          "name": "Saved coupon",
          "sequence": 1,
          "version": 3
        }
      ],
      "gross": {
        "amount": "0.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "method_code": "shipping-old",
      "method_name": "Historic carrier",
      "net": {
        "amount": "0.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "original_gross": {
        "amount": "24.60",
        "currency": "PLN",
        "minor_units": 2
      },
      "original_net": {
        "amount": "20.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "original_tax": {
        "amount": "4.60",
        "currency": "PLN",
        "minor_units": 2
      },
      "pickup_point": null,
      "recipient_mode": "full_address",
      "tax": {
        "amount": "0.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "tax_category_id": "standard",
      "tax_category_name": "VAT 23%",
      "tax_rate": "0.23"
    },
    "discount_amount": {
      "amount": "24.60",
      "currency": "PLN",
      "minor_units": 2
    },
    "discounts": [
      {
        "amount": {
          "amount": "12.30",
          "currency": "PLN",
          "minor_units": 2
        },
        "campaign_id": "saved-coupon",
        "code": "SAVE",
        "kind": "coupon",
        "name": "Saved coupon",
        "sequence": 1,
        "shipping_amount": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "version": 3
      }
    ],
    "id": "order-0000",
    "invoice": null,
    "invoice_requested": false,
    "lifecycle_state": "placed",
    "lines": [
      {
        "discount_amount": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_gross": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_net": {
          "amount": "20.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_tax": {
          "amount": "4.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "discounts": [
          {
            "amount": {
              "amount": "12.30",
              "currency": "PLN",
              "minor_units": 2
            },
            "campaign_id": "saved-coupon",
            "code": "SAVE",
            "kind": "coupon",
            "name": "Saved coupon",
            "sequence": 1,
            "shipping_amount": null,
            "version": 3
          }
        ],
        "identifiers": {},
        "image": null,
        "line_id": "saved-line-a",
        "manual_discount": {
          "amount": {
            "amount": "12.30",
            "currency": "PLN",
            "minor_units": 2
          },
          "kind": "fixed",
          "value": "12.30"
        },
        "name": "Saved A",
        "original_total": {
          "amount": "246.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_gross": {
          "amount": "246.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_net": {
          "amount": "200.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_tax": {
          "amount": "46.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "position": 1,
        "product_id": "product-api",
        "quantity": 2,
        "sku": "A",
        "tax": {
          "amount": "20.70",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax_category_id": "standard",
        "tax_category_name": "VAT 23%",
        "tax_rate": "0.23",
        "total": {
          "amount": "221.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_gross": {
          "amount": "221.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_net": {
          "amount": "180.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_tax": {
          "amount": "41.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_gross": {
          "amount": "123.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_net": {
          "amount": "100.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_price": {
          "amount": "123.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_tax": {
          "amount": "23.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "variant_id": null,
        "variant_options": []
      },
      {
        "discount_amount": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_gross": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_net": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_tax": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discounts": [],
        "identifiers": {},
        "image": null,
        "line_id": "b548a171-c331-505f-98f8-db3a06070998",
        "manual_discount": null,
        "name": "Saved B",
        "original_total": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_gross": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_net": {
          "amount": "100.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_tax": {
          "amount": "8.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "position": 2,
        "product_id": "deleted-product",
        "quantity": 1,
        "sku": "B",
        "tax": null,
        "tax_category_id": "reduced",
        "tax_category_name": "VAT 8%",
        "tax_rate": "0.08",
        "total": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_gross": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_net": {
          "amount": "100.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_tax": {
          "amount": "8.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_gross": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_net": {
          "amount": "100.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_price": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_tax": {
          "amount": "8.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "variant_id": null,
        "variant_options": []
      }
    ],
    "locale": "pl",
    "market_id": "market-pl",
    "number": "0001",
    "payment": {
      "amount": {
        "amount": "329.40",
        "currency": "PLN",
        "minor_units": 2
      },
      "environment": "live",
      "method_code": "payment-old",
      "method_name": "Historic method",
      "paid_at": null,
      "status": "unpaid",
      "updated_at": "2026-10-19T10:00:00Z",
      "version": 0
    },
    "pickup_point": null,
    "prices_include_tax": true,
    "shipping_address": null,
    "shipping_discount_amount": {
      "amount": "24.60",
      "currency": "PLN",
      "minor_units": 2
    },
    "status": {
      "id": "status-0",
      "name": "Status 0",
      "updated_at": "2026-10-19T10:00:00Z",
      "version": 1
    },
    "subtotal": {
      "amount": "329.40",
      "currency": "PLN",
      "minor_units": 2
    },
    "tax": {
      "amount": "49.40",
      "currency": "PLN",
      "minor_units": 2
    },
    "tax_breakdown": {
      "groups": [
        {
          "gross": {
            "amount": "221.40",
            "currency": "PLN",
            "minor_units": 2
          },
          "net": {
            "amount": "180.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "source": "products",
          "tax": {
            "amount": "41.40",
            "currency": "PLN",
            "minor_units": 2
          },
          "tax_rate": "0.23"
        },
        {
          "gross": {
            "amount": "108.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "net": {
            "amount": "100.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "source": "products",
          "tax": {
            "amount": "8.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "tax_rate": "0.08"
        },
        {
          "gross": {
            "amount": "0.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "net": {
            "amount": "0.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "source": "shipping",
          "tax": {
            "amount": "0.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "tax_rate": "0.23"
        }
      ],
      "unallocated_tax": {
        "amount": "0.00",
        "currency": "PLN",
        "minor_units": 2
      }
    },
    "tax_country_code": "PL",
    "total": {
      "amount": "329.40",
      "currency": "PLN",
      "minor_units": 2
    },
    "totals": {
      "before_discounts": {
        "gross": {
          "amount": "378.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "320.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "58.60",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "discounts": {
        "gross": {
          "amount": "49.20",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "40.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "9.20",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "order": {
        "gross": {
          "amount": "329.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "280.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "49.40",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "product_discounts": {
        "gross": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "20.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "4.60",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "products": {
        "gross": {
          "amount": "329.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "280.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "49.40",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "products_before_discounts": {
        "gross": {
          "amount": "354.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "300.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "54.00",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "shipping": {
        "gross": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "shipping_before_discounts": {
        "gross": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "20.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "4.60",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "shipping_discounts": {
        "gross": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "20.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "4.60",
          "currency": "PLN",
          "minor_units": 2
        }
      }
    }
  },
  "meta": {
    "request_id": "example-request"
  }
}

Як це працює

  • Список містить зведення замовлень і фільтри за номером, статусом, статусом оплати та часом створення.
  • Список і деталі замовлення містять delivery.dates. Заплановані дати YYYY-MM-DD не підтверджують відправлення. Поточні дати мають пріоритет; для старих замовлень використовується збережена оцінка. Очищені або невідомі значення — null. Деталі також містять усі позиції та зображення товарів.
  • Отримуйте допустимі ідентифікатори статусів через /api/v1/order-statuses.
  • Статус замовлення й статус оплати мають окремі кінцеві точки PATCH та дозволи.
  • Зміна записаного статусу оплати не списує кошти з картки й не виконує повернення через платіжного провайдера.

Безпечний запис

Дозволи й тарифи

Замовлення · Підсумки

Суми й ставки походять зі збереженого замовлення, включно з виправленнями позицій. Відсутні історичні дані мають значення null і не замінюються поточними ставками каталогу. Суми залишаються десятковими рядками.

Список повертає підсумки. Для кожного результату отримайте GET /api/v1/orders/{order_id}, щоб експортувати повні фінансові дані. Повторні GET обмежені та враховують Retry-After. Експорт за датою створення не синхронізує пізніші виправлення.

  • tax_country_code · Країна оподаткування · Збережені дані замовлення · ISO 3166-1 alpha-2; null.
  • lines[].unit_* · Одна одиниця · До знижок; lines[].original_total_* · До знижок; lines[].total_* · Після знижок.
  • lines[].discount_* · Знижки; manual_discount · Ручна знижка; percentage "10" = 10%.
  • delivery.net / tax / gross · Після знижок; delivery.original_* · До знижок; delivery.discount_* · Знижки.
  • tax_rate: "0.23" = 23%; "0" ≠ null. Невідомо: null; відомий нуль: 0.
  • totals · Підсумки; tax_breakdown.groups · Податкові групи; Нерозподілений податок = order.tax − Σ groups.tax; ±.

payment.amount — загальна сума замовлення. Статус оплати не визначає сплачені, повернуті чи несплачені суми.

Параметри

Параметри шляху

order_idРядокОбов’язкове

Ідентифікатор пов’язаного замовлення.

Обмеження
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Приклад: "example"

Ця операція не приймає тіло JSON.

Відповіді

Відповідь 200

Повна модель: ApiResponse_OrderDetailData_

dataOrderDetailData Обов’язкове

Дані успішної відповіді.

Поля · data

Повна модель: OrderDetailData

created_atРядокОбов’язкове

Час створення.

format: "date-time"
customerCustomerData Обов’язкове

Відомості про клієнта, записані для цього ресурсу.

Поля · customer

Повна модель: CustomerData

emailРядокОбов’язкове

Адреса електронної пошти.

first_nameРядок nullОбов’язкове

Ім’я.

last_nameРядок nullОбов’язкове

Прізвище.

phoneРядок nullОбов’язкове

Номер телефону.

deliveryShippingDetailData Обов’язкове

Спосіб доставки та пов’язані відомості.

Поля · delivery

Повна модель: ShippingDetailData

amountMoneyData Обов’язкове

Десяткова сума у вигляді рядка JSON; null лише там, де це дозволено.

datesDeliveryDatesData Обов’язкове

Дати відправлення й доставки

discount_grossMoneyData Обов’язкове

Сума з податком · Знижки; Невідомо: null; відомий нуль: 0.

discount_netMoneyData nullОбов’язкове

Сума без податку · Знижки; Невідомо: null; відомий нуль: 0.

discount_taxMoneyData nullОбов’язкове

Сума податку · Знижки; Невідомо: null; відомий нуль: 0.

discountsМасив <OrderDeliveryDiscountData > nullОбов’язкове

Знижки

grossMoneyData Обов’язкове

Сума з податком · Після знижок; Невідомо: null; відомий нуль: 0.

method_codeРядок nullОбов’язкове

Код способу доставки або оплати.

method_nameРядок nullОбов’язкове

Назва способу доставки або оплати.

netMoneyData nullОбов’язкове

Сума без податку · Після знижок; Невідомо: null; відомий нуль: 0.

original_grossMoneyData Обов’язкове

Сума з податком · Доставка · До знижок; Невідомо: null; відомий нуль: 0.

original_netMoneyData nullОбов’язкове

Сума без податку · Доставка · До знижок; Невідомо: null; відомий нуль: 0.

original_taxMoneyData nullОбов’язкове

Сума податку · Доставка · До знижок; Невідомо: null; відомий нуль: 0.

pickup_pointDeliveryPickupPointData nullОбов’язкове

Пункт отримання

recipient_modeРядокОбов’язкове

Різновид структури даних, визначений допустимими значеннями.

Обмеження
enum
["full_address", "pickup_contact"]
taxMoneyData nullОбов’язкове

Відомості про податок.

tax_category_idРядок nullОбов’язкове

Ідентифікатор податкової категорії.

tax_category_nameРядок nullОбов’язкове

Збережена назва податкової категорії; null.

tax_rateРядок nullОбов’язкове

tax_rate · Збережені дані замовлення: "0.23" = 23%; "0" ≠ null.

discount_amountMoneyData Обов’язкове

Десяткова сума у вигляді рядка JSON; null лише там, де це дозволено.

Поля · discount_amount

Повна модель: MoneyData

amountРядокОбов’язкове

Десяткова сума у вигляді рядка JSON; null лише там, де це дозволено.

currencyРядокОбов’язкове

Код валюти суми.

Обмеження
pattern
"^[A-Z]{3}$"
minor_unitsЦіле числоОбов’язкове

Кількість десяткових знаків валюти.

minimum: 0maximum: 4
discountsМасив <OrderDiscountData > Обов’язкове

Знижки

Поля · discounts

OrderDiscountData

Повна модель: OrderDiscountData

idРядокОбов’язкове

Ідентифікатор ресурсу; зберігайте його в отриманому вигляді.

invoiceInvoiceData nullОбов’язкове

Відомості для рахунка-фактури.

Поля · invoice

InvoiceData

Повна модель: InvoiceData

null

invoice_requestedЛогічне значенняОбов’язкове

Чи було запитано рахунок-фактуру.

lifecycle_stateOrderLifecycleState Обов’язкове

Стан бізнесового життєвого циклу.

linesМасив <OrderLineData > Обов’язкове

Збережені знімки позицій замовлення.

Поля · lines

OrderLineData

Повна модель: OrderLineData

localeРядокОбов’язкове

Мова, вибрана для цього запиту.

market_idРядокОбов’язкове

Ідентифікатор ринку, повернутий кінцевою точкою контексту.

numberРядокОбов’язкове

Зрозумілий користувачу номер замовлення або звернення.

paymentPaymentData Обов’язкове

Відомості про оплату, записані для замовлення.

Поля · payment

Повна модель: PaymentData

amountMoneyData Обов’язкове

Десяткова сума у вигляді рядка JSON; null лише там, де це дозволено.

environmentРядокОбов’язкове

Відомості про середовище, додані до запису.

Обмеження
enum
["live", "sandbox"]
method_codeРядок nullОбов’язкове

Код способу доставки або оплати.

method_nameРядок nullОбов’язкове

Назва способу доставки або оплати.

paid_atРядок nullОбов’язкове

Дата й час позначення оплати як сплаченої.

Рядок:format: "date-time"
statusOrderPaymentStatus Обов’язкове

Статус, допустимий для цієї конкретної операції.

updated_atРядокОбов’язкове

Час останнього оновлення.

format: "date-time"
versionЦіле числоОбов’язкове

Версія ресурсу для контролю одночасних змін.

pickup_pointPickupPointData nullОбов’язкове

Пункт отримання

Поля · pickup_point

PickupPointData

Повна модель: PickupPointData

null

prices_include_taxЛогічне значенняОбов’язкове

Чи включають наведені ціни податок.

shipping_addressAddressData nullОбов’язкове

Адреса доставки.

Поля · shipping_address

AddressData

Повна модель: AddressData

null

shipping_discount_amountMoneyData Обов’язкове

Десяткова сума у вигляді рядка JSON; null лише там, де це дозволено.

Поля · shipping_discount_amount

Повна модель: MoneyData

amountРядокОбов’язкове

Десяткова сума у вигляді рядка JSON; null лише там, де це дозволено.

currencyРядокОбов’язкове

Код валюти суми.

Обмеження
pattern
"^[A-Z]{3}$"
minor_unitsЦіле числоОбов’язкове

Кількість десяткових знаків валюти.

minimum: 0maximum: 4
statusOrderStatusData Обов’язкове

Статус, допустимий для цієї конкретної операції.

Поля · status

Повна модель: OrderStatusData

idРядокОбов’язкове

Ідентифікатор ресурсу; зберігайте його в отриманому вигляді.

nameРядокОбов’язкове

Назва ресурсу у відповідному контексті.

updated_atРядокОбов’язкове

Час останнього оновлення.

format: "date-time"
versionЦіле числоОбов’язкове

Версія ресурсу для контролю одночасних змін.

subtotalMoneyData Обов’язкове

Сума до додавання інших складових, наведених у відповіді.

Поля · subtotal

Повна модель: MoneyData

amountРядокОбов’язкове

Десяткова сума у вигляді рядка JSON; null лише там, де це дозволено.

currencyРядокОбов’язкове

Код валюти суми.

Обмеження
pattern
"^[A-Z]{3}$"
minor_unitsЦіле числоОбов’язкове

Кількість десяткових знаків валюти.

minimum: 0maximum: 4
taxMoneyData Обов’язкове

Відомості про податок.

Поля · tax

Повна модель: MoneyData

amountРядокОбов’язкове

Десяткова сума у вигляді рядка JSON; null лише там, де це дозволено.

currencyРядокОбов’язкове

Код валюти суми.

Обмеження
pattern
"^[A-Z]{3}$"
minor_unitsЦіле числоОбов’язкове

Кількість десяткових знаків валюти.

minimum: 0maximum: 4
tax_breakdownOrderTaxBreakdownData Обов’язкове

Податкові групи · source + tax_rate; unallocated_tax.

Поля · tax_breakdown

Повна модель: OrderTaxBreakdownData

groupsМасив <OrderTaxGroupData > Обов’язкове

Податкові групи · source + tax_rate; Невідомо: null; відомий нуль: 0.

unallocated_taxMoneyData Обов’язкове

Нерозподілений податок = order.tax − Σ groups.tax; ±.

tax_country_codeРядок nullОбов’язкове

Країна оподаткування · Збережені дані замовлення · ISO 3166-1 alpha-2; null.

totalMoneyData Обов’язкове

Загальна сума.

Поля · total

Повна модель: MoneyData

amountРядокОбов’язкове

Десяткова сума у вигляді рядка JSON; null лише там, де це дозволено.

currencyРядокОбов’язкове

Код валюти суми.

Обмеження
pattern
"^[A-Z]{3}$"
minor_unitsЦіле числоОбов’язкове

Кількість десяткових знаків валюти.

minimum: 0maximum: 4
totalsOrderTotalsData Обов’язкове

Підсумки · net / tax / gross; До знижок / Після знижок.

Поля · totals

Повна модель: OrderTotalsData

before_discountsOrderAmountBreakdownData Обов’язкове

Замовлення · До знижок · net / tax / gross.

discountsOrderAmountBreakdownData Обов’язкове

Знижки

orderOrderAmountBreakdownData Обов’язкове

Замовлення · Після знижок · net / tax / gross.

product_discountsOrderAmountBreakdownData Обов’язкове

Товари · Знижки · net / tax / gross.

productsOrderAmountBreakdownData Обов’язкове

Товари · Після знижок · net / tax / gross.

products_before_discountsOrderAmountBreakdownData Обов’язкове

Товари · До знижок · net / tax / gross.

shippingOrderAmountBreakdownData Обов’язкове

Доставка · Після знижок · net / tax / gross.

shipping_before_discountsOrderAmountBreakdownData Обов’язкове

Доставка · До знижок · net / tax / gross.

shipping_discountsOrderAmountBreakdownData Обов’язкове

Доставка · Знижки · net / tax / gross.

metaContextPageMeta ContextMeta PageMeta RequestMeta Обов’язкове

Метадані відповіді.

Поля · meta

ContextPageMeta

Повна модель: ContextPageMeta

localeРядокОбов’язкове

Мова, вибрана для цього запиту.

market_codeРядокОбов’язкове

Код ринку, повернутий кінцевою точкою контексту.

market_idРядокОбов’язкове

Ідентифікатор ринку, повернутий кінцевою точкою контексту.

paginationPagination Обов’язкове

Метадані пагінації за курсором.

request_idРядокОбов’язкове

Ідентифікатор звернення; у метаданих відповіді ідентифікує запит HTTP.

minLength: 1maxLength: 100

ContextMeta

Повна модель: ContextMeta

localeРядокОбов’язкове

Мова, вибрана для цього запиту.

market_codeРядокОбов’язкове

Код ринку, повернутий кінцевою точкою контексту.

market_idРядокОбов’язкове

Ідентифікатор ринку, повернутий кінцевою точкою контексту.

request_idРядокОбов’язкове

Ідентифікатор звернення; у метаданих відповіді ідентифікує запит HTTP.

minLength: 1maxLength: 100

PageMeta

Повна модель: PageMeta

paginationPagination Обов’язкове

Метадані пагінації за курсором.

request_idРядокОбов’язкове

Ідентифікатор звернення; у метаданих відповіді ідентифікує запит HTTP.

minLength: 1maxLength: 100

RequestMeta

Повна модель: RequestMeta

request_idРядокОбов’язкове

Ідентифікатор звернення; у метаданих відповіді ідентифікує запит HTTP.

minLength: 1maxLength: 100
Приклад відповіді

Статус HTTP

200
Успішна відповідь Схема
400
Некоректний запит
401
Потрібна автентифікація
403
Доступ заборонено
404
Ресурс не знайдено
409
Конфлікт версій
422
Помилка валідації
429
Перевищено ліміт запитів
Інші статуси HTTP (7)
405
Метод не дозволено
413
Завеликий запит
415
Непідтримуваний формат
500
Помилка сервера
502
Помилка шлюзу API
503
Сервіс недоступний
504
Перевищено час очікування

Каталог помилок: ErrorResponse

Заголовки

401

WWW-AuthenticateРядокНеобов’язкове

Схема автентифікації, потрібна серверу.

405

AllowРядокНеобов’язкове

Методи HTTP, підтримувані цим ресурсом.

429, 503

Retry-AfterЦіле числоНеобов’язкове

Мінімальна затримка перед повтором у секундах.

minimum: 0

Каталог помилок · Докладніше