Scheme de date: Retururi, reclamații și schimburi

dataTablou <RequestSummaryData > Obligatoriu

Exemplu de răspuns · ApiResponse_list_RequestSummaryData__.

Exemplu: [{"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 Obligatoriu

Metadatele răspunsului.

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

Câmpuri suplimentare: Nu

dataRequestDetailData Obligatoriu

Exemplu de răspuns · RequestDetailData.

Exemplu: {"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 Obligatoriu

Metadatele răspunsului.

Exemplu: {"request_id":"example"}

Câmpuri suplimentare: Nu

amountȘir de caractereObligatoriu

Sumă zecimală codificată ca șir JSON; null numai unde este permis.

minLength: 1maxLength: 64

Restricții

pattern

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

Exemplu: "0.00"

expected_versionNumăr întregObligatoriu

Versiunea citită înainte de scriere; o neconcordanță respinge actualizarea.

minimum: 0maximum: 9223372036854775807

Exemplu: 1

reasonȘir de caractereOpțional

Motivul înregistrat pentru modificare.

maxLength: 500

Valoare implicită: ""

Câmpuri suplimentare: Nu

amountMoneyData | nullObligatoriu

Sumă zecimală codificată ca șir JSON; null numai unde este permis.

Exemplu: {"amount":"0.00","currency":"PLN","minor_units":2}

completed_atȘir de caractere | nullObligatoriu

Momentul finalizării.

Șir de caractere:format: "date-time"

Exemplu: null

statusȘir de caractereObligatoriu

Starea acceptată de această operație specifică.

Restricții

enum

["pending", "completed"]

Exemplu: "pending"

updated_atȘir de caractere | nullObligatoriu

Momentul celei mai recente actualizări.

Șir de caractere:format: "date-time"

Exemplu: "2026-01-01T12:00:00Z"

versionNumăr întregObligatoriu

Versiunea resursei folosită pentru controlul concurenței.

Exemplu: 1

Câmpuri suplimentare: Nu

created_atȘir de caractereObligatoriu

Momentul creării.

format: "date-time"

Exemplu: "2026-01-01T12:00:00Z"

customerRequestCustomerData Obligatoriu

Datele clientului înregistrate pentru această resursă.

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

idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată. (RequestDetailData).

Exemplu: "example"

itemsTablou <RequestItemData > Obligatoriu

Elementele incluse în resursă.

Exemplu: [{"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Șir de caractereObligatoriu

Numărul comenzii sau al solicitării, destinat utilizatorilor.

Exemplu: "example"

order_idȘir de caractereObligatoriu

Identificatorul comenzii asociate.

Exemplu: "example"

order_numberȘir de caractereObligatoriu

Numărul comenzii asociate.

Exemplu: "example"

products_valueMoneyData Obligatoriu

Valoarea produselor din comandă.

Exemplu: {"amount":"0.00","currency":"PLN","minor_units":2}

refundRefundData Obligatoriu

Informațiile de rambursare înregistrate.

Exemplu: {"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Șir de caractereObligatoriu

Starea de soluționare a unei solicitări a clientului.

Restricții

enum

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

Exemplu: "unknown"

statusRequestStatusData Obligatoriu

Starea acceptată de această operație specifică.

Exemplu: {"id":"example","locale":"en","name":"Example"}

typeRequestType Obligatoriu

Tipul resursei.

Exemplu: "return"

updated_atȘir de caractereObligatoriu

Momentul celei mai recente actualizări.

format: "date-time"

Exemplu: "2026-01-01T12:00:00Z"

versionNumăr întregObligatoriu

Versiunea resursei folosită pentru controlul concurenței.

Exemplu: 1

Câmpuri suplimentare: Nu

idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată. (RequestItemData).

Exemplu: "example"

nameȘir de caractereObligatoriu

Numele resursei în contextul relevant.

Exemplu: "Example"

order_line_idȘir de caractere | nullObligatoriu

Identificatorul poziției asociate din comandă.

Exemplu: "example"

product_idȘir de caractereObligatoriu

Identificatorul produsului.

Exemplu: "example"

quantityNumăr întregObligatoriu

Numărul de unități.

Exemplu: 1

returned_quantityNumăr întregObligatoriu

Cantitatea returnată pentru această poziție.

Exemplu: 1

skuȘir de caractereObligatoriu

Codul unității de stoc.

Exemplu: "example"

totalMoneyData Obligatoriu

Suma totală.

Exemplu: {"amount":"0.00","currency":"PLN","minor_units":2}

unit_priceMoneyData Obligatoriu

Prețul pentru o unitate.

Exemplu: {"amount":"0.00","currency":"PLN","minor_units":2}

variant_idȘir de caractere | nullObligatoriu

Identificatorul variantei de produs.

Exemplu: "example"

variant_optionsTablou <shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData > Obligatoriu

Opțiunile de variantă asociate produsului sau datelor sale păstrate.

Exemplu: [{"name":"Example","value":"example"}]

Câmpuri suplimentare: Nu

idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată. (RequestStatusData).

Exemplu: "example"

localeȘir de caractereObligatoriu

Limba selectată pentru această cerere.

Exemplu: "en"

nameȘir de caractere | nullObligatoriu

Numele resursei în contextul relevant.

Exemplu: "Example"

Câmpuri suplimentare: Nu

codeȘir de caractereObligatoriu

Cod stabil, destinat prelucrării automate.

Exemplu: "example"

created_atȘir de caractereObligatoriu

Momentul creării.

format: "date-time"

Exemplu: "2026-01-01T12:00:00Z"

idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată. (shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData).

Exemplu: "example"

is_initialValoare booleanăObligatoriu

Indică dacă aceasta este starea inițială.

Exemplu: false

localeȘir de caractereObligatoriu

Limba selectată pentru această cerere.

Exemplu: "en"

nameȘir de caractere | nullObligatoriu

Numele resursei în contextul relevant.

Exemplu: "Example"

positionNumăr întregObligatoriu

Poziția în colecția ordonată.

Exemplu: 1

typeRequestType Obligatoriu

Tipul resursei.

Exemplu: "return"

Câmpuri suplimentare: Nu

dataTablou <shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData > Obligatoriu

Exemplu de răspuns · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2.

Exemplu: [{"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 Obligatoriu

Metadatele răspunsului.

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

Câmpuri suplimentare: Nu

expected_versionNumăr întregObligatoriu

Versiunea citită înainte de scriere; o neconcordanță respinge actualizarea.

minimum: 1maximum: 9223372036854775807

Exemplu: 1

status_idȘir de caractereObligatoriu

Identificator obținut din dicționarul de stări corespunzător.

Restricții

pattern

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

Exemplu: "example"

Câmpuri suplimentare: Nu

created_atȘir de caractereObligatoriu

Momentul creării.

format: "date-time"

Exemplu: "2026-01-01T12:00:00Z"

customerRequestCustomerData Obligatoriu

Datele clientului înregistrate pentru această resursă.

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

idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată. (RequestSummaryData).

Exemplu: "example"

numberȘir de caractereObligatoriu

Numărul comenzii sau al solicitării, destinat utilizatorilor.

Exemplu: "example"

order_idȘir de caractereObligatoriu

Identificatorul comenzii asociate.

Exemplu: "example"

order_numberȘir de caractereObligatoriu

Numărul comenzii asociate.

Exemplu: "example"

products_valueMoneyData Obligatoriu

Valoarea produselor din comandă.

Exemplu: {"amount":"0.00","currency":"PLN","minor_units":2}

refundRefundData Obligatoriu

Informațiile de rambursare înregistrate.

Exemplu: {"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Șir de caractereObligatoriu

Starea de soluționare a unei solicitări a clientului.

Restricții

enum

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

Exemplu: "unknown"

statusRequestStatusData Obligatoriu

Starea acceptată de această operație specifică.

Exemplu: {"id":"example","locale":"en","name":"Example"}

typeRequestType Obligatoriu

Tipul resursei.

Exemplu: "return"

updated_atȘir de caractereObligatoriu

Momentul celei mai recente actualizări.

format: "date-time"

Exemplu: "2026-01-01T12:00:00Z"

versionNumăr întregObligatoriu

Versiunea resursei folosită pentru controlul concurenței.

Exemplu: 1

Câmpuri suplimentare: Nu

Câmpuri suplimentare: Da

nameȘir de caractereObligatoriu

Numele resursei în contextul relevant.

Exemplu: "Example"

valueȘir de caractereObligatoriu

Valoarea descrisă de schema în care apare.

Exemplu: "example"

Câmpuri suplimentare: Nu