Duomenų schemos: Grąžinimai, skundai ir keitimai

Duomenų schemos: Grąžinimai, skundai ir keitimai. API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

Duomenų schemos

Sąrašas — Grąžinimai, skundai ir keitimai — Atsakymas

ApiResponse_list_RequestSummaryData__ · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

dataMasyvas <RequestSummaryData > Privalomas: Atsakymo pavyzdys · ApiResponse_list_RequestSummaryData__.

Pavyzdys: [{"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 Privalomas: Atsakymo metaduomenys.

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

Papildomi laukai: Ne

Gauti — Grąžinimai, skundai ir keitimai — Atsakymas

ApiResponse_RequestDetailData_ · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

dataRequestDetailData Privalomas: Atsakymo pavyzdys · RequestDetailData.

Pavyzdys: {"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 Privalomas: Atsakymo metaduomenys.

Pavyzdys: {"request_id":"example"}

Papildomi laukai: Ne

Atnaujinti · Grąžinama suma — Grąžinimai, skundai ir keitimai — Užklausos turinys

RefundAmountUpdate · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

amountEilutėPrivalomas

Dešimtainė suma, užkoduota JSON eilute; null tik ten, kur leidžiama.

minLength: 1maxLength: 64

Apribojimai

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

Pavyzdys: "0.00"

expected_versionSveikasis skaičiusPrivalomas

Prieš įrašant perskaityta versija; neatitikimas atmeta pakeitimą.

minimum: 0maximum: 9223372036854775807

Pavyzdys: 1

reasonEilutėNeprivalomas

Užregistruota pakeitimo priežastis.

maxLength: 500

Numatytoji reikšmė: ""

Papildomi laukai: Ne

Užregistruota grąžinimo informacija

RefundData · Schema · Duomenų schemos: Grąžinimai, skundai ir keitimai

amountMoneyData nullPrivalomas

Dešimtainė suma, užkoduota JSON eilute; null tik ten, kur leidžiama.

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

completed_atEilutė nullPrivalomas

Užbaigimo laikas.

Eilutė:format: "date-time"

Pavyzdys: null

statusEilutėPrivalomas

Šios konkrečios operacijos priimama būsena.

Apribojimai

enum: ["pending", "completed"]

Pavyzdys: "pending"

updated_atEilutė nullPrivalomas

Paskutinio atnaujinimo laikas.

Eilutė:format: "date-time"

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

versionSveikasis skaičiusPrivalomas

Ištekliaus versija lygiagrečių pakeitimų kontrolei.

Pavyzdys: 1

Papildomi laukai: Ne

Gauti — Grąžinimai, skundai ir keitimai — Atsakymas

RequestDetailData · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

created_atEilutėPrivalomas

Sukūrimo laikas.

format: "date-time"

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

customerRequestCustomerData Privalomas

Šiam ištekliui užregistruota kliento informacija.

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

idEilutėPrivalomas

Ištekliaus identifikatorius; išsaugokite grąžintą išraišką. (RequestDetailData).

Pavyzdys: "example"

itemsMasyvas <RequestItemData > Privalomas

Į išteklių įtraukti elementai.

Pavyzdys:

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

numberEilutėPrivalomas

Žmogui rodomas užsakymo arba prašymo numeris.

Pavyzdys: "example"

order_idEilutėPrivalomas

Susijusio užsakymo identifikatorius.

Pavyzdys: "example"

order_numberEilutėPrivalomas

Susijusio užsakymo numeris.

Pavyzdys: "example"

products_valueMoneyData Privalomas

Užsakymo produktų vertė.

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

refundRefundData Privalomas

Užregistruota grąžinimo informacija.

Pavyzdys:

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

resolution_stateEilutėPrivalomas

Kliento prašymo sprendimo būsena.

Apribojimai

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

Pavyzdys: "unknown"

statusRequestStatusData Privalomas

Šios konkrečios operacijos priimama būsena.

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

typeRequestType Privalomas

Ištekliaus tipas.

Pavyzdys: "return"

updated_atEilutėPrivalomas

Paskutinio atnaujinimo laikas.

format: "date-time"

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

versionSveikasis skaičiusPrivalomas

Ištekliaus versija lygiagrečių pakeitimų kontrolei.

Pavyzdys: 1

Papildomi laukai: Ne

Gauti — Grąžinimai, skundai ir keitimai — Atsakymas

RequestItemData · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

idEilutėPrivalomas: Ištekliaus identifikatorius; išsaugokite grąžintą išraišką. (RequestItemData).

Pavyzdys: "example"
nameEilutėPrivalomas: Ištekliaus pavadinimas atitinkamame kontekste.

Pavyzdys: "Example"
order_line_idEilutė nullPrivalomas: Susijusios užsakymo eilutės identifikatorius.

Pavyzdys: "example"
product_idEilutėPrivalomas: Produkto identifikatorius.

Pavyzdys: "example"
quantitySveikasis skaičiusPrivalomas: Vienetų skaičius.

Pavyzdys: 1
returned_quantitySveikasis skaičiusPrivalomas: Grąžintas šios eilutės kiekis.

Pavyzdys: 1
skuEilutėPrivalomas: Atsargų apskaitos vieneto kodas.

Pavyzdys: "example"
totalMoneyData Privalomas: Bendra suma.

Pavyzdys: {"amount":"0.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Privalomas: Vieneto kaina.

Pavyzdys: {"amount":"0.00","currency":"PLN","minor_units":2}
variant_idEilutė nullPrivalomas: Produkto varianto identifikatorius.

Pavyzdys: "example"
variant_optionsMasyvas <shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData > Privalomas: Su produktu arba momentine kopija susijusios varianto parinktys.

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

Papildomi laukai: Ne

Šios konkrečios operacijos priimama būsena

RequestStatusData · Schema · Duomenų schemos: Grąžinimai, skundai ir keitimai

idEilutėPrivalomas: Ištekliaus identifikatorius; išsaugokite grąžintą išraišką. (RequestStatusData).

Pavyzdys: "example"
localeEilutėPrivalomas: Šiai užklausai pasirinkta kalba.

Pavyzdys: "en"
nameEilutė nullPrivalomas: Ištekliaus pavadinimas atitinkamame kontekste.

Pavyzdys: "Example"

Papildomi laukai: Ne

Sąrašas · Būsenos — Grąžinimai, skundai ir keitimai — Atsakymas

shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

codeEilutėPrivalomas: Stabilus kompiuterio skaitomas kodas.

Pavyzdys: "example"
created_atEilutėPrivalomas: Sukūrimo laikas.

format: "date-time"

Pavyzdys: "2026-01-01T12:00:00Z"
idEilutėPrivalomas: Ištekliaus identifikatorius; išsaugokite grąžintą išraišką. (shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData).

Pavyzdys: "example"
is_initialLoginė reikšmėPrivalomas: Ar tai pradinė būsena.

Pavyzdys: false
localeEilutėPrivalomas: Šiai užklausai pasirinkta kalba.

Pavyzdys: "en"
nameEilutė nullPrivalomas: Ištekliaus pavadinimas atitinkamame kontekste.

Pavyzdys: "Example"
positionSveikasis skaičiusPrivalomas: Pozicija surikiuotame rinkinyje.

Pavyzdys: 1
typeRequestType Privalomas: Ištekliaus tipas.

Pavyzdys: "return"

Papildomi laukai: Ne

Sąrašas · Būsenos — Grąžinimai, skundai ir keitimai — Atsakymas

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2 · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

dataMasyvas <shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData > Privalomas: Atsakymo pavyzdys · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2.

Pavyzdys: [{"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 Privalomas: Atsakymo metaduomenys.

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

Papildomi laukai: Ne

Atnaujinti · Būsena — Grąžinimai, skundai ir keitimai — Užklausos turinys

RequestStatusUpdate · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

expected_versionSveikasis skaičiusPrivalomas

Prieš įrašant perskaityta versija; neatitikimas atmeta pakeitimą.

minimum: 1maximum: 9223372036854775807

Pavyzdys: 1

status_idEilutėPrivalomas

Iš atitinkamo būsenų žinyno gautas identifikatorius.

Apribojimai

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

Pavyzdys: "example"

Papildomi laukai: Ne

Sąrašas — Grąžinimai, skundai ir keitimai — Atsakymas

RequestSummaryData · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

created_atEilutėPrivalomas

Sukūrimo laikas.

format: "date-time"

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

customerRequestCustomerData Privalomas

Šiam ištekliui užregistruota kliento informacija.

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

idEilutėPrivalomas

Ištekliaus identifikatorius; išsaugokite grąžintą išraišką. (RequestSummaryData).

Pavyzdys: "example"

numberEilutėPrivalomas

Žmogui rodomas užsakymo arba prašymo numeris.

Pavyzdys: "example"

order_idEilutėPrivalomas

Susijusio užsakymo identifikatorius.

Pavyzdys: "example"

order_numberEilutėPrivalomas

Susijusio užsakymo numeris.

Pavyzdys: "example"

products_valueMoneyData Privalomas

Užsakymo produktų vertė.

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

refundRefundData Privalomas

Užregistruota grąžinimo informacija.

Pavyzdys:

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

resolution_stateEilutėPrivalomas

Kliento prašymo sprendimo būsena.

Apribojimai

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

Pavyzdys: "unknown"

statusRequestStatusData Privalomas

Šios konkrečios operacijos priimama būsena.

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

typeRequestType Privalomas

Ištekliaus tipas.

Pavyzdys: "return"

updated_atEilutėPrivalomas

Paskutinio atnaujinimo laikas.

format: "date-time"

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

versionSveikasis skaičiusPrivalomas

Ištekliaus versija lygiagrečių pakeitimų kontrolei.

Pavyzdys: 1

Papildomi laukai: Ne

Ištekliaus tipas

RequestType · Schema · Duomenų schemos: Grąžinimai, skundai ir keitimai

Eilutė

Apribojimai

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

Papildomi laukai: Taip

Su produktu arba momentine kopija susijusios varianto parinktys

shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData · Schema · Duomenų schemos: Grąžinimai, skundai ir keitimai

nameEilutėPrivalomas: Ištekliaus pavadinimas atitinkamame kontekste.

Pavyzdys: "Example"
valueEilutėPrivalomas: Aplinkine schema aprašyta reikšmė.

Pavyzdys: "example"

Papildomi laukai: Ne