Andmeskeemid: Tagastused, kaebused ja vahetused

Andmeskeemid: Tagastused, kaebused ja vahetused. API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

Andmeskeemid

Loend — Tagastused, kaebused ja vahetused — Vastus

ApiResponse_list_RequestSummaryData__ · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

dataMassiiv <RequestSummaryData > Kohustuslik: Vastuse näide · ApiResponse_list_RequestSummaryData__.

Näide: [{"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 Kohustuslik: Vastuse metaandmed.

Näide: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Lisaväljad: Ei

Hangi — Tagastused, kaebused ja vahetused — Vastus

ApiResponse_RequestDetailData_ · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

dataRequestDetailData Kohustuslik: Vastuse näide · RequestDetailData.

Näide: {"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 Kohustuslik: Vastuse metaandmed.

Näide: {"request_id":"example"}

Lisaväljad: Ei

Muuda · Tagasimakse summa — Tagastused, kaebused ja vahetused — Päringu sisu

RefundAmountUpdate · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

amountStringKohustuslik

JSON-stringina kodeeritud kümnendsumma; null ainult lubatud juhtudel.

minLength: 1maxLength: 64

Piirangud

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

Näide: "0.00"

expected_versionTäisarvKohustuslik

Enne muutmist loetud versioon; erinevuse korral lükatakse muudatus tagasi.

minimum: 0maximum: 9223372036854775807

Näide: 1

reasonStringValikuline

Muudatuse juurde salvestatud põhjus.

maxLength: 500

Vaikeväärtus: ""

Lisaväljad: Ei

Salvestatud tagastusteave

RefundData · Skeem · Andmeskeemid: Tagastused, kaebused ja vahetused

amountMoneyData nullKohustuslik

JSON-stringina kodeeritud kümnendsumma; null ainult lubatud juhtudel.

Näide: {"amount":"0.00","currency":"PLN","minor_units":2}

completed_atString nullKohustuslik

Lõpetamise aeg.

String:format: "date-time"

Näide: null

statusStringKohustuslik

Selle konkreetse toimingu lubatud olek.

Piirangud

enum: ["pending", "completed"]

Näide: "pending"

updated_atString nullKohustuslik

Viimase uuendamise aeg.

String:format: "date-time"

Näide: "2026-01-01T12:00:00Z"

versionTäisarvKohustuslik

Ressursi versioon samaaegsuse kontrolliks.

Näide: 1

Lisaväljad: Ei

Hangi — Tagastused, kaebused ja vahetused — Vastus

RequestDetailData · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

created_atStringKohustuslik

Loomise aeg.

format: "date-time"

Näide: "2026-01-01T12:00:00Z"

customerRequestCustomerData Kohustuslik

Selle ressursi juurde salvestatud klienditeave.

Näide: {"email":"customer@example.invalid","name":"Example"}

idStringKohustuslik

Ressursi identifikaator; säilita see tagastatud kujul. (RequestDetailData).

Näide: "example"

itemsMassiiv <RequestItemData > Kohustuslik

Ressursis sisalduvad kirjed.

Näide:

[{"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"}]}]

numberStringKohustuslik

Kasutajale mõeldud tellimuse või pöördumise number.

Näide: "example"

order_idStringKohustuslik

Seotud tellimuse identifikaator.

Näide: "example"

order_numberStringKohustuslik

Seotud tellimuse number.

Näide: "example"

products_valueMoneyData Kohustuslik

Tellimuse toodete väärtus.

Näide: {"amount":"0.00","currency":"PLN","minor_units":2}

refundRefundData Kohustuslik

Salvestatud tagastusteave.

Näide:

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

resolution_stateStringKohustuslik

Kliendipöördumise lahendamise olek.

Piirangud

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

Näide: "unknown"

statusRequestStatusData Kohustuslik

Selle konkreetse toimingu lubatud olek.

Näide: {"id":"example","locale":"en","name":"Example"}

typeRequestType Kohustuslik

Ressursi tüüp.

Näide: "return"

updated_atStringKohustuslik

Viimase uuendamise aeg.

format: "date-time"

Näide: "2026-01-01T12:00:00Z"

versionTäisarvKohustuslik

Ressursi versioon samaaegsuse kontrolliks.

Näide: 1

Lisaväljad: Ei

Hangi — Tagastused, kaebused ja vahetused — Vastus

RequestItemData · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

idStringKohustuslik: Ressursi identifikaator; säilita see tagastatud kujul. (RequestItemData).

Näide: "example"
nameStringKohustuslik: Ressursi nimi vastavas kontekstis.

Näide: "Example"
order_line_idString nullKohustuslik: Seotud tellimusrea identifikaator.

Näide: "example"
product_idStringKohustuslik: Toote identifikaator.

Näide: "example"
quantityTäisarvKohustuslik: Ühikute arv.

Näide: 1
returned_quantityTäisarvKohustuslik: Selle rea tagastatud kogus.

Näide: 1
skuStringKohustuslik: Laoarvestusühiku kood.

Näide: "example"
totalMoneyData Kohustuslik: Kogusumma.

Näide: {"amount":"0.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Kohustuslik: Ühe ühiku hind.

Näide: {"amount":"0.00","currency":"PLN","minor_units":2}
variant_idString nullKohustuslik: Tootevariandi identifikaator.

Näide: "example"
variant_optionsMassiiv <shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData > Kohustuslik: Toote või hetktõmmisega seotud variandivalikud.

Näide: [{"name":"Example","value":"example"}]

Lisaväljad: Ei

Selle konkreetse toimingu lubatud olek

RequestStatusData · Skeem · Andmeskeemid: Tagastused, kaebused ja vahetused

idStringKohustuslik: Ressursi identifikaator; säilita see tagastatud kujul. (RequestStatusData).

Näide: "example"
localeStringKohustuslik: Selle päringu jaoks valitud keel.

Näide: "en"
nameString nullKohustuslik: Ressursi nimi vastavas kontekstis.

Näide: "Example"

Lisaväljad: Ei

Loend · Olekud — Tagastused, kaebused ja vahetused — Vastus

shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

codeStringKohustuslik: Püsiv masinloetav kood.

Näide: "example"
created_atStringKohustuslik: Loomise aeg.

format: "date-time"

Näide: "2026-01-01T12:00:00Z"
idStringKohustuslik: Ressursi identifikaator; säilita see tagastatud kujul. (shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData).

Näide: "example"
is_initialTõeväärtusKohustuslik: Kas see on algolek.

Näide: false
localeStringKohustuslik: Selle päringu jaoks valitud keel.

Näide: "en"
nameString nullKohustuslik: Ressursi nimi vastavas kontekstis.

Näide: "Example"
positionTäisarvKohustuslik: Asukoht järjestatud kogumis.

Näide: 1
typeRequestType Kohustuslik: Ressursi tüüp.

Näide: "return"

Lisaväljad: Ei

Loend · Olekud — Tagastused, kaebused ja vahetused — Vastus

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2 · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

dataMassiiv <shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData > Kohustuslik: Vastuse näide · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2.

Näide: [{"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 Kohustuslik: Vastuse metaandmed.

Näide: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Lisaväljad: Ei

Muuda · Olek — Tagastused, kaebused ja vahetused — Päringu sisu

RequestStatusUpdate · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

expected_versionTäisarvKohustuslik

Enne muutmist loetud versioon; erinevuse korral lükatakse muudatus tagasi.

minimum: 1maximum: 9223372036854775807

Näide: 1

status_idStringKohustuslik

Vastavast olekusõnastikust saadud identifikaator.

Piirangud

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

Näide: "example"

Lisaväljad: Ei

Loend — Tagastused, kaebused ja vahetused — Vastus

RequestSummaryData · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

created_atStringKohustuslik

Loomise aeg.

format: "date-time"

Näide: "2026-01-01T12:00:00Z"

customerRequestCustomerData Kohustuslik

Selle ressursi juurde salvestatud klienditeave.

Näide: {"email":"customer@example.invalid","name":"Example"}

idStringKohustuslik

Ressursi identifikaator; säilita see tagastatud kujul. (RequestSummaryData).

Näide: "example"

numberStringKohustuslik

Kasutajale mõeldud tellimuse või pöördumise number.

Näide: "example"

order_idStringKohustuslik

Seotud tellimuse identifikaator.

Näide: "example"

order_numberStringKohustuslik

Seotud tellimuse number.

Näide: "example"

products_valueMoneyData Kohustuslik

Tellimuse toodete väärtus.

Näide: {"amount":"0.00","currency":"PLN","minor_units":2}

refundRefundData Kohustuslik

Salvestatud tagastusteave.

Näide:

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

resolution_stateStringKohustuslik

Kliendipöördumise lahendamise olek.

Piirangud

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

Näide: "unknown"

statusRequestStatusData Kohustuslik

Selle konkreetse toimingu lubatud olek.

Näide: {"id":"example","locale":"en","name":"Example"}

typeRequestType Kohustuslik

Ressursi tüüp.

Näide: "return"

updated_atStringKohustuslik

Viimase uuendamise aeg.

format: "date-time"

Näide: "2026-01-01T12:00:00Z"

versionTäisarvKohustuslik

Ressursi versioon samaaegsuse kontrolliks.

Näide: 1

Lisaväljad: Ei

Ressursi tüüp

RequestType · Skeem · Andmeskeemid: Tagastused, kaebused ja vahetused

String

Piirangud

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

Lisaväljad: Jah

Toote või hetktõmmisega seotud variandivalikud

shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData · Skeem · Andmeskeemid: Tagastused, kaebused ja vahetused

nameStringKohustuslik: Ressursi nimi vastavas kontekstis.

Näide: "Example"
valueStringKohustuslik: Ümbritsevas skeemis kirjeldatud väärtus.

Näide: "example"

Lisaväljad: Ei