Dokümantasyon

REST API

Headless çekirdek üzerinde özel bir iade akışı oluşturun.

REST API, iadenin tüm yaşam döngüsünü sunar. Tüm yazma uç noktaları bir idempotency key kabul eder.

Bir iade oluşturun

http
POST /v1/portal/returns
Content-Type: application/json
Idempotency-Key: rt_2048_v1

{
  "order_id": "2048",
  "line": { "sku": "knit-navy-m" },
  "reason": "FIT_TOO_SMALL_SHOULDER",
  "resolution": "EXCHANGE",
  "exchange_size": "L"
}

Durumu ilerletin

İadeler bir durum makinesi boyunca ilerler: draft → submitted → approved → in_transit → received → graded → closed (rejected, flagged ve cancelled dallarıyla birlikte). Her geçiş, tek bir satıcı uç noktasıdır.

http
POST /v1/merchant/returns/:id/:event

# :event ∈ approve | reject | flag | unflag
#         ship | receive | grade | close

# fit signals are emitted at: received, graded, closed

Her yazma işlemi idempotent'tir ve her durum değişikliği HMAC imzalı bir webhook olarak yayınlanır; böylece ajanlar ve arka ofis araçları bir iadeyi baştan sona izleyebilir.