Getir — Siparişler

“Siparişler” verilerini okuyun. Sonuç, bu işlemin parametrelerine bağlıdır.

GET`/api/v1/orders/{order_id}`

Kimlik doğrulama: Bearer
En düşük plan: BASIC
Gerekli izinler: orders.order:read

İstek örneği

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))

Yanıt örneği 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"
  }
}

Nasıl çalışır

Koleksiyon; sipariş özetlerini ve numara, durum, ödeme durumu ve oluşturulma zamanına göre filtreleri sağlar.
Sipariş listesi ve ayrıntıları delivery.dates içerir. YYYY-MM-DD tarihleri planlanmıştır ve gönderimi doğrulamaz. Güncel tarihler önceliklidir; eski siparişler kayıtlı tahmini kullanır. Silinen veya bilinmeyen değerler null olur. Ayrıntılar tüm sipariş kalemlerini ve ürün görsellerini de içerir.

Geçerli durum tanımlayıcılarını /api/v1/order-statuses üzerinden alın.
Sipariş durumu ve ödeme durumu ayrı PATCH uç noktaları ve izinleri kullanır.
Kayıtlı ödeme durumunu değiştirmek karttan ücret çekmez veya ödeme sağlayıcısı üzerinden para iadesi yapmaz.

Güvenli yazma işlemleri

İzinler ve planlar

Sipariş · Toplamlar

Tutarlar ve vergi oranları, satır düzeltmeleri dahil kayıtlı siparişten gelir. Eksik geçmiş veriler null olur ve güncel katalog oranlarıyla değiştirilmez. Tutarlar ondalık metin olarak kalır.

Liste özetleri döndürür. Tam mali ayrıntıları dışa aktarmak için her sonuçta GET /api/v1/orders/{order_id} çağrısı yapın. GET tekrarları sınırlıdır ve Retry-After değerine uyar. Oluşturulma tarihine göre dışa aktarım sonraki düzeltmeleri eşitlemez.

tax_country_code · Vergi ülkesi · Kayıtlı sipariş verileri · ISO 3166-1 alpha-2; null.
lines[].unit_* · Bir birim · İndirimlerden önce; lines[].original_total_* · İndirimlerden önce; lines[].total_* · İndirimlerden sonra.
lines[].discount_* · İndirimler; manual_discount · Manuel indirim; percentage "10" = 10%.
delivery.net / tax / gross · İndirimlerden sonra; delivery.original_* · İndirimlerden önce; delivery.discount_* · İndirimler.
tax_rate: "0.23" = 23%; "0" ≠ null. Bilinmiyor: null; bilinen sıfır: 0.
totals · Toplamlar; tax_breakdown.groups · Vergi grupları; Dağıtılmamış vergi = order.tax − Σ groups.tax; ±.

payment.amount sipariş toplamıdır. Ödeme durumu ödenmiş, iade edilmiş veya kalan tutarları belirlemez.

Parametreler

Yol parametreleri

order_idDizeZorunlu

İlgili siparişin tanımlayıcısı.

Kısıtlamalar

pattern: "^[a-z0-9][a-z0-9_-]{0,62}$"

Örnek: "example"

Bu işlem JSON gövdesi kabul etmez.

Yanıtlar

Yanıt 200

Tam model: ApiResponse_OrderDetailData_

dataOrderDetailData Zorunlu

Başarılı yanıtın verileri.

Alanlar · data

Tam model: OrderDetailData

created_atDizeZorunlu

Oluşturulma zamanı.

format: "date-time"

customerCustomerData Zorunlu

Bu kaynak için kaydedilen müşteri bilgileri.

Alanlar · customer

Tam model: CustomerData

emailDizeZorunlu: E-posta adresi.
first_nameDize nullZorunlu: Ad.
last_nameDize nullZorunlu: Soyadı.
phoneDize nullZorunlu: Telefon numarası.

deliveryShippingDetailData Zorunlu

Teslimat yöntemi ve ilgili bilgiler.

Alanlar · delivery

Tam model: ShippingDetailData

amountMoneyData Zorunlu

JSON dizesi olarak kodlanan ondalık tutar; yalnızca izin verilen yerlerde null olabilir.

datesDeliveryDatesData Zorunlu

Gönderim ve teslimat tarihleri

discount_grossMoneyData Zorunlu

Brüt tutar · İndirimler; Bilinmiyor: null; bilinen sıfır: 0.

discount_netMoneyData nullZorunlu

Net tutar · İndirimler; Bilinmiyor: null; bilinen sıfır: 0.

discount_taxMoneyData nullZorunlu

Vergi tutarı · İndirimler; Bilinmiyor: null; bilinen sıfır: 0.

discountsDizi <OrderDeliveryDiscountData > nullZorunlu

İndirimler

grossMoneyData Zorunlu

Brüt tutar · İndirimlerden sonra; Bilinmiyor: null; bilinen sıfır: 0.

method_codeDize nullZorunlu

Teslimat veya ödeme yöntemi kodu.

method_nameDize nullZorunlu

Teslimat veya ödeme yöntemi adı.

netMoneyData nullZorunlu

Net tutar · İndirimlerden sonra; Bilinmiyor: null; bilinen sıfır: 0.

original_grossMoneyData Zorunlu

Brüt tutar · Teslimat · İndirimlerden önce; Bilinmiyor: null; bilinen sıfır: 0.

original_netMoneyData nullZorunlu

Net tutar · Teslimat · İndirimlerden önce; Bilinmiyor: null; bilinen sıfır: 0.

original_taxMoneyData nullZorunlu

Vergi tutarı · Teslimat · İndirimlerden önce; Bilinmiyor: null; bilinen sıfır: 0.

pickup_pointDeliveryPickupPointData nullZorunlu

Teslim alma noktası

recipient_modeDizeZorunlu

İzin verilen değerlerle tanımlanan veri yapısı çeşidi.

Kısıtlamalar

enum: ["full_address", "pickup_contact"]

taxMoneyData nullZorunlu

Vergi bilgileri.

tax_category_idDize nullZorunlu

Vergi kategorisi tanımlayıcısı.

tax_category_nameDize nullZorunlu

Vergi kategorisinin kayıtlı adı; null.

tax_rateDize nullZorunlu

tax_rate · Kayıtlı sipariş verileri: "0.23" = 23%; "0" ≠ null.

discount_amountMoneyData Zorunlu

JSON dizesi olarak kodlanan ondalık tutar; yalnızca izin verilen yerlerde null olabilir.

Alanlar · discount_amount

Tam model: MoneyData

amountDizeZorunlu

JSON dizesi olarak kodlanan ondalık tutar; yalnızca izin verilen yerlerde null olabilir.

currencyDizeZorunlu

Tutarın para birimi kodu.

Kısıtlamalar

pattern: "^[A-Z]{3}$"

minor_unitsTam sayıZorunlu

Para biriminin kullandığı ondalık basamak sayısı.

minimum: 0maximum: 4

discountsDizi <OrderDiscountData > Zorunlu

İndirimler

Alanlar · discounts

OrderDiscountData

Tam model: OrderDiscountData

idDizeZorunlu

Kaynak tanımlayıcısı; döndürüldüğü biçimi koruyun.

invoiceInvoiceData nullZorunlu

Fatura bilgileri.

Alanlar · invoice

InvoiceData

Tam model: InvoiceData

null

invoice_requestedMantıksal değerZorunlu

Fatura istenip istenmediği.

lifecycle_stateOrderLifecycleState Zorunlu

İş yaşam döngüsü durumu.

linesDizi <OrderLineData > Zorunlu

Sipariş satırlarının anlık görüntüleri.

Alanlar · lines

OrderLineData

Tam model: OrderLineData

localeDizeZorunlu

Bu istek için seçilen dil.

market_idDizeZorunlu

Bağlam uç noktasının döndürdüğü pazar tanımlayıcısı.

numberDizeZorunlu

Kullanıcıya gösterilen sipariş veya talep numarası.

paymentPaymentData Zorunlu

Sipariş için kaydedilen ödeme ayrıntıları.

Alanlar · payment

Tam model: PaymentData

amountMoneyData Zorunlu

JSON dizesi olarak kodlanan ondalık tutar; yalnızca izin verilen yerlerde null olabilir.

environmentDizeZorunlu

Kayda eklenen ortam bilgileri.

Kısıtlamalar

enum: ["live", "sandbox"]

method_codeDize nullZorunlu

Teslimat veya ödeme yöntemi kodu.

method_nameDize nullZorunlu

Teslimat veya ödeme yöntemi adı.

paid_atDize nullZorunlu

Ödemenin ödendi olarak işaretlendiği tarih ve saat.

Dize:format: "date-time"

statusOrderPaymentStatus Zorunlu

Bu işlemin kabul ettiği durum.

updated_atDizeZorunlu

Son güncelleme zamanı.

format: "date-time"

versionTam sayıZorunlu

Eşzamanlılık denetiminde kullanılan kaynak sürümü.

pickup_pointPickupPointData nullZorunlu

Teslim alma noktası

Alanlar · pickup_point

PickupPointData

Tam model: PickupPointData

null

prices_include_taxMantıksal değerZorunlu

Listelenen fiyatların vergi içerip içermediği.

shipping_addressAddressData nullZorunlu

Teslimat adresi.

Alanlar · shipping_address

AddressData

Tam model: AddressData

null

shipping_discount_amountMoneyData Zorunlu

JSON dizesi olarak kodlanan ondalık tutar; yalnızca izin verilen yerlerde null olabilir.

Alanlar · shipping_discount_amount

Tam model: MoneyData

amountDizeZorunlu

JSON dizesi olarak kodlanan ondalık tutar; yalnızca izin verilen yerlerde null olabilir.

currencyDizeZorunlu

Tutarın para birimi kodu.

Kısıtlamalar

pattern: "^[A-Z]{3}$"

minor_unitsTam sayıZorunlu

Para biriminin kullandığı ondalık basamak sayısı.

minimum: 0maximum: 4

statusOrderStatusData Zorunlu

Bu işlemin kabul ettiği durum.

Alanlar · status

Tam model: OrderStatusData

idDizeZorunlu: Kaynak tanımlayıcısı; döndürüldüğü biçimi koruyun.
nameDizeZorunlu: İlgili bağlamdaki kaynak adı.
updated_atDizeZorunlu: Son güncelleme zamanı.
format: "date-time"
versionTam sayıZorunlu: Eşzamanlılık denetiminde kullanılan kaynak sürümü.

subtotalMoneyData Zorunlu

Yanıtta gösterilen ek bileşenlerden önceki tutar.

Alanlar · subtotal

Tam model: MoneyData

amountDizeZorunlu

JSON dizesi olarak kodlanan ondalık tutar; yalnızca izin verilen yerlerde null olabilir.

currencyDizeZorunlu

Tutarın para birimi kodu.

Kısıtlamalar

pattern: "^[A-Z]{3}$"

minor_unitsTam sayıZorunlu

Para biriminin kullandığı ondalık basamak sayısı.

minimum: 0maximum: 4

taxMoneyData Zorunlu

Vergi bilgileri.

Alanlar · tax

Tam model: MoneyData

amountDizeZorunlu

JSON dizesi olarak kodlanan ondalık tutar; yalnızca izin verilen yerlerde null olabilir.

currencyDizeZorunlu

Tutarın para birimi kodu.

Kısıtlamalar

pattern: "^[A-Z]{3}$"

minor_unitsTam sayıZorunlu

Para biriminin kullandığı ondalık basamak sayısı.

minimum: 0maximum: 4

tax_breakdownOrderTaxBreakdownData Zorunlu

Vergi grupları · source + tax_rate; unallocated_tax.

Alanlar · tax_breakdown

Tam model: OrderTaxBreakdownData

groupsDizi <OrderTaxGroupData > Zorunlu: Vergi grupları · source + tax_rate; Bilinmiyor: null; bilinen sıfır: 0.
unallocated_taxMoneyData Zorunlu: Dağıtılmamış vergi = order.tax − Σ groups.tax; ±.

tax_country_codeDize nullZorunlu

Vergi ülkesi · Kayıtlı sipariş verileri · ISO 3166-1 alpha-2; null.

totalMoneyData Zorunlu

Toplam tutar.

Alanlar · total

Tam model: MoneyData

amountDizeZorunlu

JSON dizesi olarak kodlanan ondalık tutar; yalnızca izin verilen yerlerde null olabilir.

currencyDizeZorunlu

Tutarın para birimi kodu.

Kısıtlamalar

pattern: "^[A-Z]{3}$"

minor_unitsTam sayıZorunlu

Para biriminin kullandığı ondalık basamak sayısı.

minimum: 0maximum: 4

totalsOrderTotalsData Zorunlu

Toplamlar · net / tax / gross; İndirimlerden önce / İndirimlerden sonra.

Alanlar · totals

Tam model: OrderTotalsData

before_discountsOrderAmountBreakdownData Zorunlu: Sipariş · İndirimlerden önce · net / tax / gross.
discountsOrderAmountBreakdownData Zorunlu: İndirimler
orderOrderAmountBreakdownData Zorunlu: Sipariş · İndirimlerden sonra · net / tax / gross.
product_discountsOrderAmountBreakdownData Zorunlu: Ürünler · İndirimler · net / tax / gross.
productsOrderAmountBreakdownData Zorunlu: Ürünler · İndirimlerden sonra · net / tax / gross.
products_before_discountsOrderAmountBreakdownData Zorunlu: Ürünler · İndirimlerden önce · net / tax / gross.
shippingOrderAmountBreakdownData Zorunlu: Teslimat · İndirimlerden sonra · net / tax / gross.
shipping_before_discountsOrderAmountBreakdownData Zorunlu: Teslimat · İndirimlerden önce · net / tax / gross.
shipping_discountsOrderAmountBreakdownData Zorunlu: Teslimat · İndirimler · net / tax / gross.

metaContextPageMeta ContextMeta PageMeta RequestMeta Zorunlu

Yanıt üst verileri.

Alanlar · meta

ContextPageMeta

Tam model: ContextPageMeta

localeDizeZorunlu: Bu istek için seçilen dil.
market_codeDizeZorunlu: Bağlam uç noktasının döndürdüğü pazar kodu.
market_idDizeZorunlu: Bağlam uç noktasının döndürdüğü pazar tanımlayıcısı.
paginationPagination Zorunlu: İmleç tabanlı sayfalamanın üst verileri.
request_idDizeZorunlu: Talep tanımlayıcısı; yanıt üst verilerinde HTTP isteğini tanımlar.
minLength: 1maxLength: 100

ContextMeta

Tam model: ContextMeta

localeDizeZorunlu: Bu istek için seçilen dil.
market_codeDizeZorunlu: Bağlam uç noktasının döndürdüğü pazar kodu.
market_idDizeZorunlu: Bağlam uç noktasının döndürdüğü pazar tanımlayıcısı.
request_idDizeZorunlu: Talep tanımlayıcısı; yanıt üst verilerinde HTTP isteğini tanımlar.
minLength: 1maxLength: 100

PageMeta

Tam model: PageMeta

paginationPagination Zorunlu: İmleç tabanlı sayfalamanın üst verileri.
request_idDizeZorunlu: Talep tanımlayıcısı; yanıt üst verilerinde HTTP isteğini tanımlar.
minLength: 1maxLength: 100

RequestMeta

Tam model: RequestMeta

request_idDizeZorunlu: Talep tanımlayıcısı; yanıt üst verilerinde HTTP isteğini tanımlar.
minLength: 1maxLength: 100

Yanıt örneği

HTTP durumu

200: Başarılı yanıt Şema
400: Geçersiz istek
401: Kimlik doğrulaması gerekli
403: İzin reddedildi
404: Kaynak bulunamadı
409: Sürüm çakışması
422: Doğrulama başarısız
429: İstek sınırı aşıldı

Diğer HTTP durumları (7)

405: Yönteme izin verilmiyor
413: İstek çok büyük
415: Desteklenmeyen biçim
500: Sunucu hatası
502: API ağ geçidi hatası
503: Hizmet kullanılamıyor
504: Zaman aşımı

Hata kataloğu: ErrorResponse

Başlıklar

401

WWW-AuthenticateDizeİsteğe bağlı: Sunucunun gerektirdiği kimlik doğrulama şeması.

405

AllowDizeİsteğe bağlı: Bu kaynağın desteklediği HTTP yöntemleri.

429, 503

Retry-AfterTam sayıİsteğe bağlı: Yeniden denemeden önce saniye cinsinden en kısa bekleme süresi.

minimum: 0

Hata kataloğu · Daha fazla bilgi

GET/api/v1/orders/{order_id}

Kod örnekleri

İstek örneği

cURL

PHP

Python

Yanıt örneği 200

Nasıl çalışır

Sipariş · Toplamlar

Parametreler

Yol parametreleri

Yanıtlar

Yanıt 200

HTTP durumu

GET`/api/v1/orders/{order_id}`