Преминете към съдържанието
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 endpoints и права.
  • Промяната на записания статус на плащане не таксува карта и не възстановява сума чрез платежен доставчик.

Безопасни записи

Права и планове

Поръчка · Общи суми

Сумите и ставките идват от запазената поръчка, включително корекциите на редове. Липсващите исторически данни са 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НизЗадължително

Идентификатор на пазара, върнат от endpoint за контекст.

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НизЗадължително

Код на пазара, върнат от endpoint за контекст.

market_idНизЗадължително

Идентификатор на пазара, върнат от endpoint за контекст.

paginationPagination Задължително

Метаданни за страниране с cursor.

request_idНизЗадължително

Идентификатор на искането; в метаданните на отговора идентифицира HTTP заявката.

minLength: 1maxLength: 100

ContextMeta

Пълен модел: ContextMeta

localeНизЗадължително

Език, избран за тази заявка.

market_codeНизЗадължително

Код на пазара, върнат от endpoint за контекст.

market_idНизЗадължително

Идентификатор на пазара, върнат от endpoint за контекст.

request_idНизЗадължително

Идентификатор на искането; в метаданните на отговора идентифицира HTTP заявката.

minLength: 1maxLength: 100

PageMeta

Пълен модел: PageMeta

paginationPagination Задължително

Метаданни за страниране с cursor.

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

Каталог на грешките · Научете повече