Veri şemaları
Teslimat adresi
AddressData · Şema · Veri şemaları: Siparişler
address_line_1Dize nullZorunluBirinci adres satırı.
address_line_2Dize nullZorunluEk adres bilgileri.
cityDize nullZorunluŞehir veya yerleşim yeri.
country_codeDize nullZorunluÜlke kodu.
first_nameDize nullZorunluAd.
house_numberDize nullZorunluBina veya ev numarası.
last_nameDize nullZorunluSoyadı.
phoneDize nullZorunluTelefon numarası.
postal_codeDize nullZorunluPosta kodu.
regionDize nullZorunluİdari bölge.
streetDize nullZorunluSokak 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> ZorunluYanıt örneği · ApiResponse_list_OrderSummaryData__.
metaContextPageMetaContextMetaPageMetaRequestMetaZorunluYanıt üst verileri.
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ı.
dataOrderDetailDataZorunluYanıt örneği · OrderDetailData.
metaContextPageMetaContextMetaPageMetaRequestMetaZorunluYanıt üst verileri.
Ek alanlar: Hayır
Bu kaynak için kaydedilen müşteri bilgileri
CustomerData · Şema · Veri şemaları: Siparişler
emailDizeZorunluE-posta adresi.
first_nameDize nullZorunluAd.
last_nameDize nullZorunluSoyadı.
phoneDize nullZorunluTelefon numarası.
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 nullZorunluGönderim saat dilimi (IANA; null).
estimated_delivery_fromDize nullZorunluTahmini teslimat başlangıcı (YYYY-MM-DD; null).
Dize:format:"date"estimated_delivery_toDize nullZorunluTahmini teslimat bitişi (YYYY-MM-DD; null).
Dize:format:"date"planned_dispatch_onDize nullZorunluPlanlanan gönderim tarihi (YYYY-MM-DD; null).
Dize:format:"date"
Ek alanlar: Hayır
DeliveryPickupPointData
DeliveryPickupPointData · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.
addressPickupPointAddressDataZorunluTeslimat adresi.
codeDizeZorunluMakine tarafından okunabilir, sabit kod.
Kısıtlamalar
pattern"^[A-Za-z0-9_-]{1,63}$"
coordinatesPickupPointCoordinatesDatanullZorunluİçinde bulunduğu şemanın tanımladığı değer.
country_codeDizeZorunluÜlke kodu.
Kısıtlamalar
pattern"^[A-Z]{2}$"
environmentDizeZorunluKayda 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 nullZorunluSeçilen dilde açıklama.
Dize:maxLength:1000nameDizeZorunluİlgili bağlamdaki kaynak adı.
minLength:1maxLength:160opening_hoursDize nullZorunluOpening hours
Dize:maxLength:500operatorDizeZorunluİlgili bağlamdaki kaynak adı.
minLength:1maxLength:63verified_atDizeZorunluSon güncelleme zamanı.
format:"date-time"
Ek alanlar: Hayır
Fatura bilgileri
InvoiceData · Şema · Veri şemaları: Siparişler
address_line_1Dize nullZorunluBirinci adres satırı.
address_line_2Dize nullZorunluEk adres bilgileri.
cityDize nullZorunluŞehir veya yerleşim yeri.
company_nameDize nullZorunluŞirket adı.
country_codeDize nullZorunluÜlke kodu.
house_numberDize nullZorunluBina veya ev numarası.
postal_codeDize nullZorunluPosta kodu.
regionDize nullZorunluİdari bölge.
streetDize nullZorunluSokak adı.
tax_identifierDize nullZorunluVergi kimlik numarası.
tax_schemeDize nullZorunluVergi 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.
grossMoneyDataZorunluBrüt tutar · İndirimlerden sonra; Bilinmiyor: null; bilinen sıfır: 0.
netMoneyDatanullZorunluNet tutar · İndirimlerden sonra; Bilinmiyor: null; bilinen sıfır: 0.
taxMoneyDatanullZorunluVergi tutarı · İndirimlerden sonra; Bilinmiyor: null; bilinen sıfır: 0.
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.
amountMoneyDataZorunluBrüt tutar · Teslimat · İndirimler.
campaign_idDizeZorunluKaynak tanımlayıcısı; döndürüldüğü biçimi koruyun.
codeDize nullZorunluMakine tarafından okunabilir, sabit kod.
kindDizeZorunluİzin verilen değerlerle tanımlanan veri yapısı çeşidi.
Kısıtlamalar
enum["coupon", "promotion"]
nameDizeZorunluİlgili bağlamdaki kaynak adı.
sequenceTam sayı nullZorunluSıralı koleksiyondaki konum.
versionTam sayıZorunluEşzamanlılık denetiminde kullanılan kaynak sürümü.
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_atDizeZorunluOluşturulma zamanı.
format:"date-time"customerCustomerDataZorunluBu kaynak için kaydedilen müşteri bilgileri.
deliveryShippingDetailDataZorunluTeslimat yöntemi ve ilgili bilgiler.
discount_amountMoneyDataZorunluJSON dizesi olarak kodlanan ondalık tutar; yalnızca izin verilen yerlerde null olabilir.
discountsDizi <OrderDiscountData> Zorunluİndirimler
idDizeZorunluKaynak tanımlayıcısı; döndürüldüğü biçimi koruyun. (OrderDetailData).
invoiceInvoiceDatanullZorunluFatura bilgileri.
invoice_requestedMantıksal değerZorunluFatura istenip istenmediği.
lifecycle_stateOrderLifecycleStateZorunluİş yaşam döngüsü durumu.
linesDizi <OrderLineData> ZorunluSipariş satırlarının anlık görüntüleri.
localeDizeZorunluBu istek için seçilen dil.
market_idDizeZorunluBağlam uç noktasının döndürdüğü pazar tanımlayıcısı.
numberDizeZorunluKullanıcıya gösterilen sipariş veya talep numarası.
paymentPaymentDataZorunluSipariş için kaydedilen ödeme ayrıntıları.
pickup_pointPickupPointDatanullZorunluTeslim alma noktası
prices_include_taxMantıksal değerZorunluListelenen fiyatların vergi içerip içermediği.
shipping_addressAddressDatanullZorunluTeslimat adresi.
shipping_discount_amountMoneyDataZorunluJSON dizesi olarak kodlanan ondalık tutar; yalnızca izin verilen yerlerde null olabilir.
statusOrderStatusDataZorunluBu işlemin kabul ettiği durum.
subtotalMoneyDataZorunluYanıtta gösterilen ek bileşenlerden önceki tutar.
taxMoneyDataZorunluVergi bilgileri.
tax_breakdownOrderTaxBreakdownDataZorunluVergi grupları · source + tax_rate; unallocated_tax.
tax_country_codeDize nullZorunluVergi ülkesi · Kayıtlı sipariş verileri · ISO 3166-1 alpha-2; null.
totalMoneyDataZorunluToplam tutar.
totalsOrderTotalsDataZorunluToplamlar · net / tax / gross; İndirimlerden önce / İndirimlerden sonra.
Ek alanlar: Hayır
Görselin üst verileri ve URL'si
OrderImageData · Şema · Veri şemaları: Siparişler
altDize nullZorunluGörselin alternatif metni.
sourceDizeİsteğe bağlıKaydedilen etkinliğin kaynağı.
const:"current_catalog"urlDizeZorunluKaynak URL'si.
Ek alanlar: Hayır
İş yaşam döngüsü durumu
OrderLifecycleState · Şema · Veri şemaları: Siparişler
DizeKı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_amountMoneyDataZorunluJSON dizesi olarak kodlanan ondalık tutar; yalnızca izin verilen yerlerde null olabilir.
discount_grossMoneyDataZorunluBrüt tutar · İndirimler; Bilinmiyor: null; bilinen sıfır: 0.
discount_netMoneyDatanullZorunluNet tutar · İndirimler; Bilinmiyor: null; bilinen sıfır: 0.
discount_taxMoneyDatanullZorunluVergi tutarı · İndirimler; Bilinmiyor: null; bilinen sıfır: 0.
discountsDizi <OrderDiscountData> Zorunluİndirimler · net / tax / gross.
identifiersNesneEk alanlar: DizeZorunluÜrün tanımlama kodları.
imageOrderImageDatanullZorunluGörselin üst verileri ve URL'si.
line_idDizeZorunluSipariş satırının sabit kimliği.
manual_discountOrderManualDiscountDatanullZorunluManuel indirim; null.
nameDizeZorunluİlgili bağlamdaki kaynak adı.
original_totalMoneyDataZorunluToplam tutar.
original_total_grossMoneyDataZorunluBrüt tutar · Ürünler · İndirimlerden önce; Bilinmiyor: null; bilinen sıfır: 0.
original_total_netMoneyDatanullZorunluNet tutar · Ürünler · İndirimlerden önce; Bilinmiyor: null; bilinen sıfır: 0.
original_total_taxMoneyDatanullZorunluVergi tutarı · Ürünler · İndirimlerden önce; Bilinmiyor: null; bilinen sıfır: 0.
positionTam sayıZorunluSıralı koleksiyondaki konum.
product_idDizeZorunluÜrün tanımlayıcısı.
quantityTam sayıZorunluBirim sayısı.
skuDizeZorunluStok tutma birimi kodu.
taxMoneyDatanullZorunluVergi tutarı · Bir birim · Kayıtlı sipariş verileri; tax ≠ unit_tax; Bilinmiyor: null; bilinen sıfır: 0.
tax_category_idDize nullZorunluVergi kategorisi kimliği · Kayıtlı sipariş verileri; null.
tax_category_nameDize nullZorunluVergi kategorisinin kayıtlı adı; null.
tax_rateDize nullZorunlutax_rate · Kayıtlı sipariş verileri: "0.23" = 23%; "0" ≠ null.
totalMoneyDataZorunluToplam tutar.
total_grossMoneyDataZorunluBrüt tutar · Ürünler · İndirimlerden sonra; Bilinmiyor: null; bilinen sıfır: 0.
total_netMoneyDatanullZorunluNet tutar · Ürünler · İndirimlerden sonra; Bilinmiyor: null; bilinen sıfır: 0.
total_taxMoneyDatanullZorunluVergi tutarı · Ürünler · İndirimlerden sonra · Kayıtlı sipariş verileri; Bilinmiyor: null; bilinen sıfır: 0.
unit_grossMoneyDataZorunluBrüt tutar · Bir birim · İndirimlerden önce; Bilinmiyor: null; bilinen sıfır: 0.
unit_netMoneyDatanullZorunluNet tutar · Bir birim · İndirimlerden önce; Bilinmiyor: null; bilinen sıfır: 0.
unit_priceMoneyDataZorunluBir birimin fiyatı.
unit_taxMoneyDatanullZorunluVergi tutarı · Bir birim · İndirimlerden önce; Bilinmiyor: null; bilinen sıfır: 0.
variant_idDize nullZorunluÜrün varyantı tanımlayıcısı.
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.
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.
amountMoneyDataZorunluBrüt tutar · Manuel indirim · Kayıtlı sipariş verileri.
kindDizeZorunluİndirim türü: percentage / fixed.
Kısıtlamalar
enum["percentage", "fixed"]
valueDizeZorunluYapılandırılmış değer: percentage "10" = 10%; fixed = Brüt tutar.
Ek alanlar: Hayır
Bu işlemin kabul ettiği durum
OrderPaymentStatus · Şema · Veri şemaları: Siparişler
DizeKısıtlamalar
enum["unpaid", "paid", "failed", "refunded"]
Ek alanlar: Evet
Bu işlemin kabul ettiği durum
OrderStatusData · Şema · Veri şemaları: Siparişler
idDizeZorunluKaynak tanımlayıcısı; döndürüldüğü biçimi koruyun. (OrderStatusData).
nameDizeZorunluİlgili bağlamdaki kaynak adı.
updated_atDizeZorunluSon güncelleme zamanı.
format:"date-time"versionTam sayıZorunluEşzamanlılık denetiminde kullanılan kaynak sürümü.
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_atDizeZorunluOluşturulma zamanı.
format:"date-time"idDizeZorunluKaynak tanımlayıcısı; döndürüldüğü biçimi koruyun. (shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData).
is_initialMantıksal değerZorunluBu durumun başlangıç durumu olup olmadığı.
nameDizeZorunluİlgili bağlamdaki kaynak adı.
positionTam sayıZorunluSıralı koleksiyondaki konum.
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> ZorunluYanıt örneği · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1.
metaContextPageMetaContextMetaPageMetaRequestMetaZorunluYanıt üst verileri.
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ıZorunluYazmadan önce okunan sürüm; uyuşmazlık güncellemenin reddedilmesine yol açar.
minimum:1maximum:9223372036854775807status_idDizeZorunluİlgili durum sözlüğünden alınan tanımlayıcı.
Kısıtlamalar
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
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_atDizeZorunluOluşturulma zamanı.
format:"date-time"customerCustomerDataZorunluBu kaynak için kaydedilen müşteri bilgileri.
deliveryShippingDataZorunluTeslimat yöntemi ve ilgili bilgiler.
discount_amountMoneyDataZorunluJSON dizesi olarak kodlanan ondalık tutar; yalnızca izin verilen yerlerde null olabilir.
idDizeZorunluKaynak tanımlayıcısı; döndürüldüğü biçimi koruyun. (OrderSummaryData).
lifecycle_stateOrderLifecycleStateZorunluİş yaşam döngüsü durumu.
localeDizeZorunluBu istek için seçilen dil.
market_idDizeZorunluBağlam uç noktasının döndürdüğü pazar tanımlayıcısı.
numberDizeZorunluKullanıcıya gösterilen sipariş veya talep numarası.
paymentPaymentDataZorunluSipariş için kaydedilen ödeme ayrıntıları.
prices_include_taxMantıksal değerZorunluListelenen fiyatların vergi içerip içermediği.
shipping_discount_amountMoneyDataZorunluJSON dizesi olarak kodlanan ondalık tutar; yalnızca izin verilen yerlerde null olabilir.
statusOrderStatusDataZorunluBu işlemin kabul ettiği durum.
subtotalMoneyDataZorunluYanıtta gösterilen ek bileşenlerden önceki tutar.
taxMoneyDataZorunluVergi bilgileri.
tax_country_codeDize nullZorunluVergi ülkesi · Kayıtlı sipariş verileri · ISO 3166-1 alpha-2; null.
totalMoneyDataZorunluToplam tutar.
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> ZorunluVergi grupları · source + tax_rate; Bilinmiyor: null; bilinen sıfır: 0.
unallocated_taxMoneyDataZorunluDağıtılmamış vergi = order.tax − Σ groups.tax; ±.
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.
grossMoneyDataZorunluBrüt tutar · İndirimlerden sonra; Bilinmiyor: null; bilinen sıfır: 0.
netMoneyDatanullZorunluNet tutar · İndirimlerden sonra; Bilinmiyor: null; bilinen sıfır: 0.
sourceDizeZorunluKaynak: products (Ürünler), shipping (Teslimat).
Kısıtlamalar
enum["products", "shipping"]
taxMoneyDatanullZorunluVergi tutarı · İndirimlerden sonra; Bilinmiyor: null; bilinen sıfır: 0.
tax_rateDize nullZorunlutax_rate · Kayıtlı sipariş verileri: "0.23" = 23%; "0" ≠ null.
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_discountsOrderAmountBreakdownDataZorunluSipariş · İndirimlerden önce · net / tax / gross.
discountsOrderAmountBreakdownDataZorunluİndirimler · net / tax / gross.
orderOrderAmountBreakdownDataZorunluSipariş · İndirimlerden sonra · net / tax / gross.
product_discountsOrderAmountBreakdownDataZorunluÜrünler · İndirimler · net / tax / gross.
productsOrderAmountBreakdownDataZorunluÜrünler · İndirimlerden sonra · net / tax / gross.
products_before_discountsOrderAmountBreakdownDataZorunluÜrünler · İndirimlerden önce · net / tax / gross.
shippingOrderAmountBreakdownDataZorunluTeslimat · İndirimlerden sonra · net / tax / gross.
shipping_before_discountsOrderAmountBreakdownDataZorunluTeslimat · İndirimlerden önce · net / tax / gross.
shipping_discountsOrderAmountBreakdownDataZorunluTeslimat · İndirimler · net / tax / gross.
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ı.
amountMoneyDataZorunluBrüt tutar · Ürünler · İndirimler.
campaign_idDizeZorunluKaynak tanımlayıcısı; döndürüldüğü biçimi koruyun.
codeDize nullZorunluMakine tarafından okunabilir, sabit kod.
kindDizeZorunluİzin verilen değerlerle tanımlanan veri yapısı çeşidi.
Kısıtlamalar
enum["coupon", "promotion"]
nameDizeZorunluİlgili bağlamdaki kaynak adı.
sequenceTam sayı nullİsteğe bağlıUygulama sırası; null.
shipping_amountMoneyDatanullİsteğe bağlıBrüt tutar · Teslimat · İndirimler; null.
versionTam sayıZorunluEşzamanlılık denetiminde kullanılan kaynak sürümü.
Ek alanlar: Hayır
Sipariş için kaydedilen ödeme ayrıntıları
PaymentData · Şema · Veri şemaları: Siparişler
amountMoneyDataZorunlupayment.amount sipariş toplamıdır. Ödeme durumu ödenmiş, iade edilmiş veya kalan tutarları belirlemez.
environmentDizeZorunluKayda eklenen ortam bilgileri.
Kısıtlamalar
enum["live", "sandbox"]
method_codeDize nullZorunluTeslimat veya ödeme yöntemi kodu.
method_nameDize nullZorunluTeslimat veya ödeme yöntemi adı.
paid_atDize nullZorunluÖdemenin ödendi olarak işaretlendiği tarih ve saat.
Dize:format:"date-time"statusOrderPaymentStatusZorunluBu işlemin kabul ettiği durum.
updated_atDizeZorunluSon güncelleme zamanı.
format:"date-time"versionTam sayıZorunluEşzamanlılık denetiminde kullanılan kaynak sürümü.
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ıZorunluYazmadan önce okunan sürüm; uyuşmazlık güncellemenin reddedilmesine yol açar.
minimum:0maximum:9223372036854775807reasonDizeZorunluDeğişiklik için kaydedilen neden.
minLength:1maxLength:500statusPaymentStatusZorunluBu işlemin kabul ettiği durum.
Ek alanlar: Hayır
Bu işlemin kabul ettiği durum
PaymentStatus · Şema · Veri şemaları: Siparişler
DizeKı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_1DizeZorunluBirinci adres satırı.
minLength:1maxLength:240cityDizeZorunluŞehir veya yerleşim yeri.
minLength:1maxLength:160postal_codeDizeZorunluPosta 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ıZorunluWGS84 φ (°)
minimum:-90.0maximum:90.0longitudeSayıZorunluWGS84 λ (°)
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_line1DizeZorunluBirinci adres satırı.
cityDizeZorunluŞehir veya yerleşim yeri.
codeDizeZorunluMakine 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ı nullZorunluWGS84 φ (°)
location_descriptionDize nullZorunluSeçilen dilde açıklama.
longitudeSayı nullZorunluWGS84 λ (°)
nameDizeZorunluİlgili bağlamdaki kaynak adı.
opening_hoursDize nullZorunluOpening hours
operatorDizeZorunluİlgili bağlamdaki kaynak adı.
postal_codeDizeZorunluPosta kodu.
Ek alanlar: Hayır
PickupPointSummaryData
PickupPointSummaryData · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.
codeDizeZorunluMakine 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}$"
environmentDizeZorunluKayda 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
emailDizeZorunluE-posta adresi.
nameDizeZorunluİlgili bağlamdaki kaynak adı.
Ek alanlar: Hayır
Teslimat yöntemi ve ilgili bilgiler
ShippingData · Şema · Veri şemaları: Siparişler
amountMoneyDataZorunluSiparişte MoneyData olarak kaydedilen vergi dahil kargo tutarı. Sonraki vergi değişiklikleri bu geçmiş tutarı değiştirmez.
datesDeliveryDatesDataZorunluGö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.
method_codeDize nullZorunluTeslimat veya ödeme yöntemi kodu.
method_nameDize nullZorunluTeslimat veya ödeme yöntemi adı.
pickup_pointPickupPointSummaryDatanullZorunluTeslim alma noktası
recipient_modeDizeZorunluİzin verilen değerlerle tanımlanan veri yapısı çeşidi.
Kısıtlamalar
enum["full_address", "pickup_contact"]
Ek alanlar: Hayır
ShippingDetailData
ShippingDetailData · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.
amountMoneyDataZorunluSiparişte MoneyData olarak kaydedilen vergi dahil kargo tutarı. Sonraki vergi değişiklikleri bu geçmiş tutarı değiştirmez.
datesDeliveryDatesDataZorunluGö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.
discount_grossMoneyDataZorunluBrüt tutar · İndirimler; Bilinmiyor: null; bilinen sıfır: 0.
discount_netMoneyDatanullZorunluNet tutar · İndirimler; Bilinmiyor: null; bilinen sıfır: 0.
discount_taxMoneyDatanullZorunluVergi tutarı · İndirimler; Bilinmiyor: null; bilinen sıfır: 0.
discountsDizi <OrderDeliveryDiscountData> nullZorunluTeslimat · İndirimler; []: 0; null: Bilinmiyor: null; bilinen sıfır: 0.
grossMoneyDataZorunluBrüt tutar · İndirimlerden sonra; Bilinmiyor: null; bilinen sıfır: 0.
method_codeDize nullZorunluTeslimat veya ödeme yöntemi kodu.
method_nameDize nullZorunluTeslimat veya ödeme yöntemi adı.
netMoneyDatanullZorunluNet tutar · İndirimlerden sonra; Bilinmiyor: null; bilinen sıfır: 0.
original_grossMoneyDataZorunluBrüt tutar · Teslimat · İndirimlerden önce; Bilinmiyor: null; bilinen sıfır: 0.
original_netMoneyDatanullZorunluNet tutar · Teslimat · İndirimlerden önce; Bilinmiyor: null; bilinen sıfır: 0.
original_taxMoneyDatanullZorunluVergi tutarı · Teslimat · İndirimlerden önce; Bilinmiyor: null; bilinen sıfır: 0.
pickup_pointDeliveryPickupPointDatanullZorunluTeslim alma noktası
recipient_modeDizeZorunluİzin verilen değerlerle tanımlanan veri yapısı çeşidi.
Kısıtlamalar
enum["full_address", "pickup_contact"]
taxMoneyDatanullZorunluVergi tutarı · İndirimlerden sonra; Bilinmiyor: null; bilinen sıfır: 0.
tax_category_idDize nullZorunluVergi kategorisi kimliği · Kayıtlı sipariş verileri; null.
tax_category_nameDize nullZorunluVergi kategorisinin kayıtlı adı; null.
tax_rateDize nullZorunlutax_rate · Kayıtlı sipariş verileri: "0.23" = 23%; "0" ≠ null.
Ek alanlar: Hayır