Veri şemaları: İadeler, şikâyetler ve değişimler

Veri şemaları: İadeler, şikâyetler ve değişimler. API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.

Veri şemaları

Listele — İadeler, şikâyetler ve değişimler — Yanıt

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

dataDizi <RequestSummaryData > Zorunlu: Yanıt örneği · ApiResponse_list_RequestSummaryData__.

Örnek: [{"created_at":"2026-01-01T12:00:00Z","customer":{"email":"customer@example.invalid","name":"Example"},"id":"example","number":"example","order_id":"example","order_number":"example","products_value":{"amount":"0.00","currency":"PLN","minor_units":2},"refund":{"amount":{"amount":"0.00","currency":"PLN","minor_units":2},"completed_at":null,"status":"pending","updated_at":"2026-01-01T12:00:00Z","version":1},"resolution_state":"unknown","status":{"id":"example","locale":"en","name":"Example"},"type":"return","updated_at":"2026-01-01T12:00:00Z","version":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

Getir — İadeler, şikâyetler ve değişimler — Yanıt

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

dataRequestDetailData Zorunlu: Yanıt örneği · RequestDetailData.

Örnek: {"created_at":"2026-01-01T12:00:00Z","customer":{"email":"customer@example.invalid","name":"Example"},"id":"example","items":[{"id":"example","name":"Example","order_line_id":"example","product_id":"example","quantity":1,"returned_quantity":1,"sku":"example","total":{"amount":"0.00","currency":"PLN","minor_units":2},"unit_price":{"amount":"0.00","currency":"PLN","minor_units":2},"variant_id":"example","variant_options":[{"name":"Example","value":"example"}]}],"number":"example","order_id":"example","order_number":"example","products_value":{"amount":"0.00","currency":"PLN","minor_units":2},"refund":{"amount":{"amount":"0.00","currency":"PLN","minor_units":2},"completed_at":null,"status":"pending","updated_at":"2026-01-01T12:00:00Z","version":1},"resolution_state":"unknown","status":{"id":"example","locale":"en","name":"Example"},"type":"return","updated_at":"2026-01-01T12:00:00Z","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Zorunlu: Yanıt üst verileri.

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

Ek alanlar: Hayır

Güncelle · İade tutarı — İadeler, şikâyetler ve değişimler — İstek gövdesi

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

amountDizeZorunlu

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

minLength: 1maxLength: 64

Kısıtlamalar

pattern: "^[+-]?(?:[0-9]+(?:\\.[0-9]+)?|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?$"

Örnek: "0.00"

expected_versionTam sayıZorunlu

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

minimum: 0maximum: 9223372036854775807

Örnek: 1

reasonDizeİsteğe bağlı

Değişiklik için kaydedilen neden.

maxLength: 500

Varsayılan: ""

Ek alanlar: Hayır

Kaydedilen geri ödeme bilgileri

RefundData · Şema · Veri şemaları: İadeler, şikâyetler ve değişimler

amountMoneyData nullZorunlu

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

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

completed_atDize nullZorunlu

Tamamlanma zamanı.

Dize:format: "date-time"

Örnek: null

statusDizeZorunlu

Bu işlemin kabul ettiği durum.

Kısıtlamalar

enum: ["pending", "completed"]

Örnek: "pending"

updated_atDize nullZorunlu

Son güncelleme zamanı.

Dize:format: "date-time"

Örnek: "2026-01-01T12:00:00Z"

versionTam sayıZorunlu

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

Örnek: 1

Ek alanlar: Hayır

Getir — İadeler, şikâyetler ve değişimler — Yanıt

RequestDetailData · 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"

customerRequestCustomerData Zorunlu

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

Örnek: {"email":"customer@example.invalid","name":"Example"}

idDizeZorunlu

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

Örnek: "example"

itemsDizi <RequestItemData > Zorunlu

Kaynakta bulunan öğeler.

Örnek:

[{"id":"example","name":"Example","order_line_id":"example","product_id":"example","quantity":1,"returned_quantity":1,"sku":"example","total":{"amount":"0.00","currency":"PLN","minor_units":2},"unit_price":{"amount":"0.00","currency":"PLN","minor_units":2},"variant_id":"example","variant_options":[{"name":"Example","value":"example"}]}]

numberDizeZorunlu

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

Örnek: "example"

order_idDizeZorunlu

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

Örnek: "example"

order_numberDizeZorunlu

İlgili siparişin numarası.

Örnek: "example"

products_valueMoneyData Zorunlu

Siparişteki ürünlerin değeri.

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

refundRefundData Zorunlu

Kaydedilen geri ödeme bilgileri.

Örnek:

{"amount":{"amount":"0.00","currency":"PLN","minor_units":2},"completed_at":null,"status":"pending","updated_at":"2026-01-01T12:00:00Z","version":1}

resolution_stateDizeZorunlu

Müşteri talebinin çözüm durumu.

Kısıtlamalar

enum: ["unknown", "open", "completed", "rejected", "cancelled"]

Örnek: "unknown"

statusRequestStatusData Zorunlu

Bu işlemin kabul ettiği durum.

Örnek: {"id":"example","locale":"en","name":"Example"}

typeRequestType Zorunlu

Kaynak türü.

Örnek: "return"

updated_atDizeZorunlu

Son güncelleme zamanı.

format: "date-time"

Örnek: "2026-01-01T12:00:00Z"

versionTam sayıZorunlu

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

Örnek: 1

Ek alanlar: Hayır

Getir — İadeler, şikâyetler ve değişimler — Yanıt

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

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

Örnek: "example"
nameDizeZorunlu: İlgili bağlamdaki kaynak adı.

Örnek: "Example"
order_line_idDize nullZorunlu: İlgili sipariş satırının tanımlayıcısı.

Örnek: "example"
product_idDizeZorunlu: Ürün tanımlayıcısı.

Örnek: "example"
quantityTam sayıZorunlu: Birim sayısı.

Örnek: 1
returned_quantityTam sayıZorunlu: Bu satır için iade edilen miktar.

Örnek: 1
skuDizeZorunlu: Stok tutma birimi kodu.

Örnek: "example"
totalMoneyData Zorunlu: Toplam tutar.

Örnek: {"amount":"0.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Zorunlu: Bir birimin fiyatı.

Örnek: {"amount":"0.00","currency":"PLN","minor_units":2}
variant_idDize nullZorunlu: Ürün varyantı tanımlayıcısı.

Örnek: "example"
variant_optionsDizi <shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData > Zorunlu: Ürün veya anlık görüntüyle ilişkili varyant seçenekleri.

Örnek: [{"name":"Example","value":"example"}]

Ek alanlar: Hayır

Bu işlemin kabul ettiği durum

RequestStatusData · Şema · Veri şemaları: İadeler, şikâyetler ve değişimler

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

Örnek: "example"
localeDizeZorunlu: Bu istek için seçilen dil.

Örnek: "en"
nameDize nullZorunlu: İlgili bağlamdaki kaynak adı.

Örnek: "Example"

Ek alanlar: Hayır

Listele · Durumlar — İadeler, şikâyetler ve değişimler — Yanıt

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

codeDizeZorunlu: Makine tarafından okunabilir, sabit kod.

Örnek: "example"
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__returns__adapters__public_http__requests__schemas__StatusDefinitionData).

Örnek: "example"
is_initialMantıksal değerZorunlu: Bu durumun başlangıç durumu olup olmadığı.

Örnek: false
localeDizeZorunlu: Bu istek için seçilen dil.

Örnek: "en"
nameDize nullZorunlu: İlgili bağlamdaki kaynak adı.

Örnek: "Example"
positionTam sayıZorunlu: Sıralı koleksiyondaki konum.

Örnek: 1
typeRequestType Zorunlu: Kaynak türü.

Örnek: "return"

Ek alanlar: Hayır

Listele · Durumlar — İadeler, şikâyetler ve değişimler — Yanıt

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

dataDizi <shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData > Zorunlu: Yanıt örneği · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2.

Örnek: [{"code":"example","created_at":"2026-01-01T12:00:00Z","id":"example","is_initial":false,"locale":"en","name":"Example","position":1,"type":"return"}]
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 — İadeler, şikâyetler ve değişimler — İstek gövdesi

RequestStatusUpdate · 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 — İadeler, şikâyetler ve değişimler — Yanıt

RequestSummaryData · 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"

customerRequestCustomerData Zorunlu

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

Örnek: {"email":"customer@example.invalid","name":"Example"}

idDizeZorunlu

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

Örnek: "example"

numberDizeZorunlu

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

Örnek: "example"

order_idDizeZorunlu

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

Örnek: "example"

order_numberDizeZorunlu

İlgili siparişin numarası.

Örnek: "example"

products_valueMoneyData Zorunlu

Siparişteki ürünlerin değeri.

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

refundRefundData Zorunlu

Kaydedilen geri ödeme bilgileri.

Örnek:

{"amount":{"amount":"0.00","currency":"PLN","minor_units":2},"completed_at":null,"status":"pending","updated_at":"2026-01-01T12:00:00Z","version":1}

resolution_stateDizeZorunlu

Müşteri talebinin çözüm durumu.

Kısıtlamalar

enum: ["unknown", "open", "completed", "rejected", "cancelled"]

Örnek: "unknown"

statusRequestStatusData Zorunlu

Bu işlemin kabul ettiği durum.

Örnek: {"id":"example","locale":"en","name":"Example"}

typeRequestType Zorunlu

Kaynak türü.

Örnek: "return"

updated_atDizeZorunlu

Son güncelleme zamanı.

format: "date-time"

Örnek: "2026-01-01T12:00:00Z"

versionTam sayıZorunlu

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

Örnek: 1

Ek alanlar: Hayır

Kaynak türü

RequestType · Şema · Veri şemaları: İadeler, şikâyetler ve değişimler

Dize

Kısıtlamalar

enum: ["return", "exchange", "complaint"]

Ek alanlar: Evet

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

shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData · Şema · Veri şemaları: İadeler, şikâyetler ve değişimler

nameDizeZorunlu: İlgili bağlamdaki kaynak adı.

Örnek: "Example"
valueDizeZorunlu: İçinde bulunduğu şemanın tanımladığı değer.

Örnek: "example"

Ek alanlar: Hayır