İçeriğe atla
ShopentlyLearn

Veri şemaları: Siparişler

Veri şemaları: Siparişler. API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.

Veri şemaları

Teslimat adresi

AddressData · Şema · Veri şemaları: Siparişler
address_line_1Dize nullZorunlu

Birinci adres satırı.

address_line_2Dize nullZorunlu

Ek adres bilgileri.

cityDize nullZorunlu

Şehir veya yerleşim yeri.

country_codeDize nullZorunlu

Ülke kodu.

first_nameDize nullZorunlu

Ad.

house_numberDize nullZorunlu

Bina veya ev numarası.

last_nameDize nullZorunlu

Soyadı.

phoneDize nullZorunlu

Telefon numarası.

postal_codeDize nullZorunlu

Posta kodu.

regionDize nullZorunlu

İdari bölge.

streetDize nullZorunlu

Sokak adı.

Ek alanlar: Hayır

Listele — Siparişler — Yanıt

ApiResponse_list_OrderSummaryData__ · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.
dataDizi <OrderSummaryData > Zorunlu

Yanıt örneği · ApiResponse_list_OrderSummaryData__.

Örnek: [{"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"},"method_code":"shipping-old","method_name":"Historic carrier","pickup_point":null,"recipient_mode":"full_address"},"discount_amount":{"amount":"24.60","currency":"PLN","minor_units":2},"id":"order-0000","lifecycle_state":"placed","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},"prices_include_tax":true,"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_country_code":"PL","total":{"amount":"329.40","currency":"PLN","minor_units":2}}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Zorunlu

Yanıt üst verileri.

Örnek: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Ek alanlar: Hayır

Getir — Siparişler — Yanıt

ApiResponse_OrderDetailData_ · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.
dataOrderDetailData Zorunlu

Yanıt örneği · OrderDetailData.

Örnek: {"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}}}}
metaContextPageMeta ContextMeta PageMeta RequestMeta Zorunlu

Yanıt üst verileri.

Örnek: {"request_id":"example-request"}

Ek alanlar: Hayır

Bu kaynak için kaydedilen müşteri bilgileri

CustomerData · Şema · Veri şemaları: Siparişler
emailDizeZorunlu

E-posta adresi.

Örnek: "customer@example.invalid"
first_nameDize nullZorunlu

Ad.

Örnek: "Example"
last_nameDize nullZorunlu

Soyadı.

Örnek: "Example"
phoneDize nullZorunlu

Telefon numarası.

Örnek: null

Ek alanlar: Hayır

Gönderim ve teslimat tarihleri

DeliveryDatesData · 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.
dispatch_timezoneDize nullZorunlu

Gönderim saat dilimi (IANA; null).

Örnek: "Europe/Warsaw"
estimated_delivery_fromDize nullZorunlu

Tahmini teslimat başlangıcı (YYYY-MM-DD; null).

Dize:format: "date"
Örnek: "2026-10-20"
estimated_delivery_toDize nullZorunlu

Tahmini teslimat bitişi (YYYY-MM-DD; null).

Dize:format: "date"
Örnek: "2026-10-21"
planned_dispatch_onDize nullZorunlu

Planlanan gönderim tarihi (YYYY-MM-DD; null).

Dize:format: "date"
Örnek: "2026-10-19"

Ek alanlar: Hayır

DeliveryPickupPointData

DeliveryPickupPointData · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.
addressPickupPointAddressData Zorunlu

Teslimat adresi.

codeDizeZorunlu

Makine tarafından okunabilir, sabit kod.

Kısıtlamalar
pattern
"^[A-Za-z0-9_-]{1,63}$"
coordinatesPickupPointCoordinatesData nullZorunlu

İçinde bulunduğu şemanın tanımladığı değer.

country_codeDizeZorunlu

Ülke kodu.

Kısıtlamalar
pattern
"^[A-Z]{2}$"
environmentDizeZorunlu

Kayda eklenen ortam bilgileri.

Kısıtlamalar
enum
["live", "sandbox"]
kindDizeZorunlu

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

Kısıtlamalar
enum
["locker", "pickup_point"]
location_descriptionDize nullZorunlu

Seçilen dilde açıklama.

Dize:maxLength: 1000
nameDizeZorunlu

İlgili bağlamdaki kaynak adı.

minLength: 1maxLength: 160
opening_hoursDize nullZorunlu

Opening hours

Dize:maxLength: 500
operatorDizeZorunlu

İlgili bağlamdaki kaynak adı.

minLength: 1maxLength: 63
verified_atDizeZorunlu

Son güncelleme zamanı.

format: "date-time"

Ek alanlar: Hayır

Fatura bilgileri

InvoiceData · Şema · Veri şemaları: Siparişler
address_line_1Dize nullZorunlu

Birinci adres satırı.

address_line_2Dize nullZorunlu

Ek adres bilgileri.

cityDize nullZorunlu

Şehir veya yerleşim yeri.

company_nameDize nullZorunlu

Şirket adı.

country_codeDize nullZorunlu

Ülke kodu.

house_numberDize nullZorunlu

Bina veya ev numarası.

postal_codeDize nullZorunlu

Posta kodu.

regionDize nullZorunlu

İdari bölge.

streetDize nullZorunlu

Sokak adı.

tax_identifierDize nullZorunlu

Vergi kimlik numarası.

tax_schemeDize nullZorunlu

Vergi hesaplama yöntemi.

Ek alanlar: Hayır

Net tutar / Vergi tutarı / Brüt tutar

OrderAmountBreakdownData · 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.
grossMoneyData Zorunlu

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

Örnek: {"amount":"378.60","currency":"PLN","minor_units":2}
netMoneyData nullZorunlu

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

Örnek: {"amount":"320.00","currency":"PLN","minor_units":2}
taxMoneyData nullZorunlu

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

Örnek: {"amount":"58.60","currency":"PLN","minor_units":2}

Ek alanlar: Hayır

Teslimat · İndirimler

OrderDeliveryDiscountData · 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.
amountMoneyData Zorunlu

Brüt tutar · Teslimat · İndirimler.

Örnek: {"amount":"24.60","currency":"PLN","minor_units":2}
campaign_idDizeZorunlu

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

Örnek: "saved-coupon"
codeDize nullZorunlu

Makine tarafından okunabilir, sabit kod.

Örnek: "SAVE"
kindDizeZorunlu

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

Kısıtlamalar
enum
["coupon", "promotion"]
Örnek: "coupon"
nameDizeZorunlu

İlgili bağlamdaki kaynak adı.

Örnek: "Saved coupon"
sequenceTam sayı nullZorunlu

Sıralı koleksiyondaki konum.

Örnek: 1
versionTam sayıZorunlu

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

Örnek: 3

Ek alanlar: Hayır

Getir — Siparişler — Yanıt

OrderDetailData · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.
created_atDizeZorunlu

Oluşturulma zamanı.

format: "date-time"
Örnek: "2026-10-19T10:00:00Z"
customerCustomerData Zorunlu

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

Örnek: {"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null}
deliveryShippingDetailData Zorunlu

Teslimat yöntemi ve ilgili bilgiler.

Örnek: {"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_amountMoneyData Zorunlu

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

Örnek: {"amount":"24.60","currency":"PLN","minor_units":2}
discountsDizi <OrderDiscountData > Zorunlu

İndirimler

Örnek: [{"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}]
idDizeZorunlu

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

Örnek: "order-0000"
invoiceInvoiceData nullZorunlu

Fatura bilgileri.

Örnek: null
invoice_requestedMantıksal değerZorunlu

Fatura istenip istenmediği.

Örnek: false
lifecycle_stateOrderLifecycleState Zorunlu

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

Örnek: "placed"
linesDizi <OrderLineData > Zorunlu

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

Örnek: [{"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":[]}]
localeDizeZorunlu

Bu istek için seçilen dil.

Örnek: "pl"
market_idDizeZorunlu

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

Örnek: "market-pl"
numberDizeZorunlu

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

Örnek: "0001"
paymentPaymentData Zorunlu

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

Örnek: {"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_pointPickupPointData nullZorunlu

Teslim alma noktası

Örnek: null
prices_include_taxMantıksal değerZorunlu

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

Örnek: true
shipping_addressAddressData nullZorunlu

Teslimat adresi.

Örnek: null
shipping_discount_amountMoneyData Zorunlu

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

Örnek: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData Zorunlu

Bu işlemin kabul ettiği durum.

Örnek: {"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1}
subtotalMoneyData Zorunlu

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

Örnek: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData Zorunlu

Vergi bilgileri.

Örnek: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_breakdownOrderTaxBreakdownData Zorunlu

Vergi grupları · source + tax_rate; unallocated_tax.

Örnek: {"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_codeDize nullZorunlu

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

Örnek: "PL"
totalMoneyData Zorunlu

Toplam tutar.

Örnek: {"amount":"329.40","currency":"PLN","minor_units":2}
totalsOrderTotalsData Zorunlu

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

Örnek: {"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}}}

Ek alanlar: Hayır

Görselin üst verileri ve URL'si

OrderImageData · Şema · Veri şemaları: Siparişler
altDize nullZorunlu

Görselin alternatif metni.

sourceDizeİsteğe bağlı

Kaydedilen etkinliğin kaynağı.

const: "current_catalog"
Varsayılan: "current_catalog"
urlDizeZorunlu

Kaynak URL'si.

Ek alanlar: Hayır

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

OrderLifecycleState · Şema · Veri şemaları: Siparişler
Dize
Kısıtlamalar
enum
["placed", "cancelled", "fulfilled", "returned"]

Ek alanlar: Evet

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

OrderLineData · Şema · Veri şemaları: Siparişler
discount_amountMoneyData Zorunlu

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

Örnek: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_grossMoneyData Zorunlu

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

Örnek: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_netMoneyData nullZorunlu

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

Örnek: {"amount":"20.00","currency":"PLN","minor_units":2}
discount_taxMoneyData nullZorunlu

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

Örnek: {"amount":"4.60","currency":"PLN","minor_units":2}
discountsDizi <OrderDiscountData > Zorunlu

İndirimler · net / tax / gross.

Örnek: [{"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}]
identifiersNesneEk alanlar: DizeZorunlu

Ürün tanımlama kodları.

Örnek: {}
imageOrderImageData nullZorunlu

Görselin üst verileri ve URL'si.

Örnek: null
line_idDizeZorunlu

Sipariş satırının sabit kimliği.

Örnek: "saved-line-a"
manual_discountOrderManualDiscountData nullZorunlu

Manuel indirim; null.

Örnek: {"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"kind":"fixed","value":"12.30"}
nameDizeZorunlu

İlgili bağlamdaki kaynak adı.

Örnek: "Saved A"
original_totalMoneyData Zorunlu

Toplam tutar.

Örnek: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_grossMoneyData Zorunlu

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

Örnek: {"amount":"246.00","currency":"PLN","minor_units":2}
original_total_netMoneyData nullZorunlu

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

Örnek: {"amount":"200.00","currency":"PLN","minor_units":2}
original_total_taxMoneyData nullZorunlu

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

Örnek: {"amount":"46.00","currency":"PLN","minor_units":2}
positionTam sayıZorunlu

Sıralı koleksiyondaki konum.

Örnek: 1
product_idDizeZorunlu

Ürün tanımlayıcısı.

Örnek: "product-api"
quantityTam sayıZorunlu

Birim sayısı.

Örnek: 2
skuDizeZorunlu

Stok tutma birimi kodu.

Örnek: "A"
taxMoneyData nullZorunlu

Vergi tutarı · Bir birim · Kayıtlı sipariş verileri; tax ≠ unit_tax; Bilinmiyor: null; bilinen sıfır: 0.

Örnek: {"amount":"20.70","currency":"PLN","minor_units":2}
tax_category_idDize nullZorunlu

Vergi kategorisi kimliği · Kayıtlı sipariş verileri; null.

Örnek: "standard"
tax_category_nameDize nullZorunlu

Vergi kategorisinin kayıtlı adı; null.

Örnek: "VAT 23%"
tax_rateDize nullZorunlu

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

Örnek: "0.23"
totalMoneyData Zorunlu

Toplam tutar.

Örnek: {"amount":"221.40","currency":"PLN","minor_units":2}
total_grossMoneyData Zorunlu

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

Örnek: {"amount":"221.40","currency":"PLN","minor_units":2}
total_netMoneyData nullZorunlu

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

Örnek: {"amount":"180.00","currency":"PLN","minor_units":2}
total_taxMoneyData nullZorunlu

Vergi tutarı · Ürünler · İndirimlerden sonra · Kayıtlı sipariş verileri; Bilinmiyor: null; bilinen sıfır: 0.

Örnek: {"amount":"41.40","currency":"PLN","minor_units":2}
unit_grossMoneyData Zorunlu

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

Örnek: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_netMoneyData nullZorunlu

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

Örnek: {"amount":"100.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Zorunlu

Bir birimin fiyatı.

Örnek: {"amount":"123.00","currency":"PLN","minor_units":2}
unit_taxMoneyData nullZorunlu

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

Örnek: {"amount":"23.00","currency":"PLN","minor_units":2}
variant_idDize nullZorunlu

Ürün varyantı tanımlayıcısı.

Örnek: null
variant_optionsDizi <shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData > Zorunlu

Ürün veya anlık görüntüyle ilişkili varyant seçenekleri.

Örnek: []

Ek alanlar: Hayır

Manuel indirim

OrderManualDiscountData · 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.
amountMoneyData Zorunlu

Brüt tutar · Manuel indirim · Kayıtlı sipariş verileri.

Örnek: {"amount":"12.30","currency":"PLN","minor_units":2}
kindDizeZorunlu

İndirim türü: percentage / fixed.

Kısıtlamalar
enum
["percentage", "fixed"]
Örnek: "fixed"
valueDizeZorunlu

Yapılandırılmış değer: percentage "10" = 10%; fixed = Brüt tutar.

Örnek: "12.30"

Ek alanlar: Hayır

Bu işlemin kabul ettiği durum

OrderPaymentStatus · Şema · Veri şemaları: Siparişler
Dize
Kısıtlamalar
enum
["unpaid", "paid", "failed", "refunded"]

Ek alanlar: Evet

Bu işlemin kabul ettiği durum

OrderStatusData · Şema · Veri şemaları: Siparişler
idDizeZorunlu

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

Örnek: "status-0"
nameDizeZorunlu

İlgili bağlamdaki kaynak adı.

Örnek: "Status 0"
updated_atDizeZorunlu

Son güncelleme zamanı.

format: "date-time"
Örnek: "2026-10-19T10:00:00Z"
versionTam sayıZorunlu

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

Örnek: 1

Ek alanlar: Hayır

Listele · Durumlar — Siparişler — Yanıt

shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.
created_atDizeZorunlu

Oluşturulma zamanı.

format: "date-time"
Örnek: "2026-01-01T12:00:00Z"
idDizeZorunlu

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

Örnek: "example"
is_initialMantıksal değerZorunlu

Bu durumun başlangıç durumu olup olmadığı.

Örnek: false
nameDizeZorunlu

İlgili bağlamdaki kaynak adı.

Örnek: "Example"
positionTam sayıZorunlu

Sıralı koleksiyondaki konum.

Örnek: 1

Ek alanlar: Hayır

Listele · Durumlar — Siparişler — Yanıt

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1 · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.
dataDizi <shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData > Zorunlu

Yanıt örneği · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1.

Örnek: [{"created_at":"2026-01-01T12:00:00Z","id":"example","is_initial":false,"name":"Example","position":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Zorunlu

Yanıt üst verileri.

Örnek: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Ek alanlar: Hayır

Güncelle · Durum — Siparişler — İstek gövdesi

OrderStatusUpdate · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.
expected_versionTam sayıZorunlu

Yazmadan önce okunan sürüm; uyuşmazlık güncellemenin reddedilmesine yol açar.

minimum: 1maximum: 9223372036854775807
Örnek: 1
status_idDizeZorunlu

İlgili durum sözlüğünden alınan tanımlayıcı.

Kısıtlamalar
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Örnek: "example"

Ek alanlar: Hayır

Listele — Siparişler — Yanıt

OrderSummaryData · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.
created_atDizeZorunlu

Oluşturulma zamanı.

format: "date-time"
Örnek: "2026-10-19T10:00:00Z"
customerCustomerData Zorunlu

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

Örnek: {"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null}
deliveryShippingData Zorunlu

Teslimat yöntemi ve ilgili bilgiler.

Örnek: {"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"},"method_code":"shipping-old","method_name":"Historic carrier","pickup_point":null,"recipient_mode":"full_address"}
discount_amountMoneyData Zorunlu

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

Örnek: {"amount":"24.60","currency":"PLN","minor_units":2}
idDizeZorunlu

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

Örnek: "order-0000"
lifecycle_stateOrderLifecycleState Zorunlu

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

Örnek: "placed"
localeDizeZorunlu

Bu istek için seçilen dil.

Örnek: "pl"
market_idDizeZorunlu

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

Örnek: "market-pl"
numberDizeZorunlu

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

Örnek: "0001"
paymentPaymentData Zorunlu

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

Örnek: {"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}
prices_include_taxMantıksal değerZorunlu

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

Örnek: true
shipping_discount_amountMoneyData Zorunlu

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

Örnek: {"amount":"24.60","currency":"PLN","minor_units":2}
statusOrderStatusData Zorunlu

Bu işlemin kabul ettiği durum.

Örnek: {"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1}
subtotalMoneyData Zorunlu

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

Örnek: {"amount":"329.40","currency":"PLN","minor_units":2}
taxMoneyData Zorunlu

Vergi bilgileri.

Örnek: {"amount":"49.40","currency":"PLN","minor_units":2}
tax_country_codeDize nullZorunlu

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

Örnek: "PL"
totalMoneyData Zorunlu

Toplam tutar.

Örnek: {"amount":"329.40","currency":"PLN","minor_units":2}

Ek alanlar: Hayır

Sipariş · Vergi grupları

OrderTaxBreakdownData · 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.
groupsDizi <OrderTaxGroupData > Zorunlu

Vergi grupları · source + tax_rate; Bilinmiyor: null; bilinen sıfır: 0.

Örnek: [{"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_taxMoneyData Zorunlu

Dağıtılmamış vergi = order.tax − Σ groups.tax; ±.

Örnek: {"amount":"0.00","currency":"PLN","minor_units":2}

Ek alanlar: Hayır

Vergi grupları

OrderTaxGroupData · 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.
grossMoneyData Zorunlu

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

Örnek: {"amount":"221.40","currency":"PLN","minor_units":2}
netMoneyData nullZorunlu

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

Örnek: {"amount":"180.00","currency":"PLN","minor_units":2}
sourceDizeZorunlu

Kaynak: products (Ürünler), shipping (Teslimat).

Kısıtlamalar
enum
["products", "shipping"]
Örnek: "products"
taxMoneyData nullZorunlu

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

Örnek: {"amount":"41.40","currency":"PLN","minor_units":2}
tax_rateDize nullZorunlu

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

Örnek: "0.23"

Ek alanlar: Hayır

Sipariş · Toplamlar

OrderTotalsData · 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.
before_discountsOrderAmountBreakdownData Zorunlu

Sipariş · İndirimlerden önce · net / tax / gross.

Örnek: {"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}}
discountsOrderAmountBreakdownData Zorunlu

İndirimler · net / tax / gross.

Örnek: {"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}}
orderOrderAmountBreakdownData Zorunlu

Sipariş · İndirimlerden sonra · net / tax / gross.

Örnek: {"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_discountsOrderAmountBreakdownData Zorunlu

Ürünler · İndirimler · net / tax / gross.

Örnek: {"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}}
productsOrderAmountBreakdownData Zorunlu

Ürünler · İndirimlerden sonra · net / tax / gross.

Örnek: {"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_discountsOrderAmountBreakdownData Zorunlu

Ürünler · İndirimlerden önce · net / tax / gross.

Örnek: {"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}}
shippingOrderAmountBreakdownData Zorunlu

Teslimat · İndirimlerden sonra · net / tax / gross.

Örnek: {"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_discountsOrderAmountBreakdownData Zorunlu

Teslimat · İndirimlerden önce · net / tax / gross.

Örnek: {"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_discountsOrderAmountBreakdownData Zorunlu

Teslimat · İndirimler · net / tax / gross.

Örnek: {"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}}

Ek alanlar: Hayır

Ürün veya anlık görüntüyle ilişkili varyant seçenekleri

shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData · Şema · Veri şemaları: Siparişler
nameDizeZorunlu

İlgili bağlamdaki kaynak adı.

valueDizeZorunlu

İçinde bulunduğu şemanın tanımladığı değer.

Ek alanlar: Hayır

OrderDiscountData

OrderDiscountData · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.
amountMoneyData Zorunlu

Brüt tutar · Ürünler · İndirimler.

Örnek: {"amount":"12.30","currency":"PLN","minor_units":2}
campaign_idDizeZorunlu

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

Örnek: "saved-coupon"
codeDize nullZorunlu

Makine tarafından okunabilir, sabit kod.

Örnek: "SAVE"
kindDizeZorunlu

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

Kısıtlamalar
enum
["coupon", "promotion"]
Örnek: "coupon"
nameDizeZorunlu

İlgili bağlamdaki kaynak adı.

Örnek: "Saved coupon"
sequenceTam sayı nullİsteğe bağlı

Uygulama sırası; null.

Örnek: 1
shipping_amountMoneyData nullİsteğe bağlı

Brüt tutar · Teslimat · İndirimler; null.

Örnek: {"amount":"24.60","currency":"PLN","minor_units":2}
versionTam sayıZorunlu

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

Örnek: 3

Ek alanlar: Hayır

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

PaymentData · Şema · Veri şemaları: Siparişler
amountMoneyData Zorunlu

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

Örnek: {"amount":"329.40","currency":"PLN","minor_units":2}
environmentDizeZorunlu

Kayda eklenen ortam bilgileri.

Kısıtlamalar
enum
["live", "sandbox"]
Örnek: "live"
method_codeDize nullZorunlu

Teslimat veya ödeme yöntemi kodu.

Örnek: "payment-old"
method_nameDize nullZorunlu

Teslimat veya ödeme yöntemi adı.

Örnek: "Historic method"
paid_atDize nullZorunlu

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

Dize:format: "date-time"
Örnek: null
statusOrderPaymentStatus Zorunlu

Bu işlemin kabul ettiği durum.

Örnek: "unpaid"
updated_atDizeZorunlu

Son güncelleme zamanı.

format: "date-time"
Örnek: "2026-10-19T10:00:00Z"
versionTam sayıZorunlu

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

Örnek: 0

Ek alanlar: Hayır

Güncelle · Ödeme durumu — Siparişler — İstek gövdesi

PaymentStatusUpdate · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.
expected_versionTam sayıZorunlu

Yazmadan önce okunan sürüm; uyuşmazlık güncellemenin reddedilmesine yol açar.

minimum: 0maximum: 9223372036854775807
Örnek: 1
reasonDizeZorunlu

Değişiklik için kaydedilen neden.

minLength: 1maxLength: 500
Örnek: "Example"
statusPaymentStatus Zorunlu

Bu işlemin kabul ettiği durum.

Örnek: "paid"

Ek alanlar: Hayır

Bu işlemin kabul ettiği durum

PaymentStatus · Şema · Veri şemaları: Siparişler
Dize
Kısıtlamalar
enum
["unpaid", "paid", "failed", "refunded"]

Ek alanlar: Evet

PickupPointAddressData

PickupPointAddressData · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.
address_line_1DizeZorunlu

Birinci adres satırı.

minLength: 1maxLength: 240
cityDizeZorunlu

Şehir veya yerleşim yeri.

minLength: 1maxLength: 160
postal_codeDizeZorunlu

Posta kodu.

minLength: 1maxLength: 32

Ek alanlar: Hayır

PickupPointCoordinatesData

PickupPointCoordinatesData · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.
latitudeSayıZorunlu

WGS84 φ (°)

minimum: -90.0maximum: 90.0
longitudeSayıZorunlu

WGS84 λ (°)

minimum: -180.0maximum: 180.0

Ek alanlar: Hayır

PickupPointData

PickupPointData · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.
address_line1DizeZorunlu

Birinci adres satırı.

cityDizeZorunlu

Şehir veya yerleşim yeri.

codeDizeZorunlu

Makine tarafından okunabilir, sabit kod.

country_codeDizeZorunlu

Ülke kodu.

kindDizeZorunlu

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

Kısıtlamalar
enum
["locker", "pickup_point"]
latitudeSayı nullZorunlu

WGS84 φ (°)

location_descriptionDize nullZorunlu

Seçilen dilde açıklama.

longitudeSayı nullZorunlu

WGS84 λ (°)

nameDizeZorunlu

İlgili bağlamdaki kaynak adı.

opening_hoursDize nullZorunlu

Opening hours

operatorDizeZorunlu

İlgili bağlamdaki kaynak adı.

postal_codeDizeZorunlu

Posta kodu.

Ek alanlar: Hayır

PickupPointSummaryData

PickupPointSummaryData · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.
codeDizeZorunlu

Makine tarafından okunabilir, sabit kod.

Kısıtlamalar
pattern
"^[A-Za-z0-9_-]{1,63}$"
country_codeDizeZorunlu

Ülke kodu.

Kısıtlamalar
pattern
"^[A-Z]{2}$"
environmentDizeZorunlu

Kayda eklenen ortam bilgileri.

Kısıtlamalar
enum
["live", "sandbox"]
kindDizeZorunlu

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

Kısıtlamalar
enum
["locker", "pickup_point"]
operatorDizeZorunlu

İlgili bağlamdaki kaynak adı.

minLength: 1maxLength: 63

Ek alanlar: Hayır

Bu kaynak için kaydedilen müşteri bilgileri

RequestCustomerData · Şema · Veri şemaları: Siparişler
emailDizeZorunlu

E-posta adresi.

Örnek: "customer@example.invalid"
nameDizeZorunlu

İlgili bağlamdaki kaynak adı.

Örnek: "Example"

Ek alanlar: Hayır

Teslimat yöntemi ve ilgili bilgiler

ShippingData · Şema · Veri şemaları: Siparişler
amountMoneyData Zorunlu

Siparişte MoneyData olarak kaydedilen vergi dahil kargo tutarı. Sonraki vergi değişiklikleri bu geçmiş tutarı değiştirmez.

Örnek: {"amount":"0.00","currency":"PLN","minor_units":2}
datesDeliveryDatesData Zorunlu

Gönderim ve teslimat tarihleri. 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.

Örnek: {"dispatch_timezone":"Europe/Warsaw","estimated_delivery_from":"2026-10-20","estimated_delivery_to":"2026-10-21","planned_dispatch_on":"2026-10-19"}
method_codeDize nullZorunlu

Teslimat veya ödeme yöntemi kodu.

Örnek: "shipping-old"
method_nameDize nullZorunlu

Teslimat veya ödeme yöntemi adı.

Örnek: "Historic carrier"
pickup_pointPickupPointSummaryData nullZorunlu

Teslim alma noktası

Örnek: null
recipient_modeDizeZorunlu

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

Kısıtlamalar
enum
["full_address", "pickup_contact"]
Örnek: "full_address"

Ek alanlar: Hayır

ShippingDetailData

ShippingDetailData · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.
amountMoneyData Zorunlu

Siparişte MoneyData olarak kaydedilen vergi dahil kargo tutarı. Sonraki vergi değişiklikleri bu geçmiş tutarı değiştirmez.

Örnek: {"amount":"0.00","currency":"PLN","minor_units":2}
datesDeliveryDatesData Zorunlu

Gönderim ve teslimat tarihleri. 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.

Örnek: {"dispatch_timezone":"Europe/Warsaw","estimated_delivery_from":"2026-10-20","estimated_delivery_to":"2026-10-21","planned_dispatch_on":"2026-10-19"}
discount_grossMoneyData Zorunlu

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

Örnek: {"amount":"24.60","currency":"PLN","minor_units":2}
discount_netMoneyData nullZorunlu

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

Örnek: {"amount":"20.00","currency":"PLN","minor_units":2}
discount_taxMoneyData nullZorunlu

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

Örnek: {"amount":"4.60","currency":"PLN","minor_units":2}
discountsDizi <OrderDeliveryDiscountData > nullZorunlu

Teslimat · İndirimler; []: 0; null: Bilinmiyor: null; bilinen sıfır: 0.

Örnek: [{"amount":{"amount":"24.60","currency":"PLN","minor_units":2},"campaign_id":"saved-coupon","code":"SAVE","kind":"coupon","name":"Saved coupon","sequence":1,"version":3}]
grossMoneyData Zorunlu

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

Örnek: {"amount":"0.00","currency":"PLN","minor_units":2}
method_codeDize nullZorunlu

Teslimat veya ödeme yöntemi kodu.

Örnek: "shipping-old"
method_nameDize nullZorunlu

Teslimat veya ödeme yöntemi adı.

Örnek: "Historic carrier"
netMoneyData nullZorunlu

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

Örnek: {"amount":"0.00","currency":"PLN","minor_units":2}
original_grossMoneyData Zorunlu

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

Örnek: {"amount":"24.60","currency":"PLN","minor_units":2}
original_netMoneyData nullZorunlu

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

Örnek: {"amount":"20.00","currency":"PLN","minor_units":2}
original_taxMoneyData nullZorunlu

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

Örnek: {"amount":"4.60","currency":"PLN","minor_units":2}
pickup_pointDeliveryPickupPointData nullZorunlu

Teslim alma noktası

Örnek: null
recipient_modeDizeZorunlu

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

Kısıtlamalar
enum
["full_address", "pickup_contact"]
Örnek: "full_address"
taxMoneyData nullZorunlu

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

Örnek: {"amount":"0.00","currency":"PLN","minor_units":2}
tax_category_idDize nullZorunlu

Vergi kategorisi kimliği · Kayıtlı sipariş verileri; null.

Örnek: "standard"
tax_category_nameDize nullZorunlu

Vergi kategorisinin kayıtlı adı; null.

Örnek: "VAT 23%"
tax_rateDize nullZorunlu

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

Örnek: "0.23"

Ek alanlar: Hayır