Datu shēmas: Atgriešana, reklamācijas un apmaiņa

Datu shēmas: Atgriešana, reklamācijas un apmaiņa. API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

Datu shēmas

Saraksts — Atgriešana, reklamācijas un apmaiņa — Atbilde

ApiResponse_list_RequestSummaryData__ · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

dataMasīvs <RequestSummaryData > Obligāts: Atbildes piemērs · ApiResponse_list_RequestSummaryData__.

Piemērs: [{"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 Obligāts: Atbildes metadati.

Piemērs: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Papildu lauki: Nē

Iegūt — Atgriešana, reklamācijas un apmaiņa — Atbilde

ApiResponse_RequestDetailData_ · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

dataRequestDetailData Obligāts: Atbildes piemērs · RequestDetailData.

Piemērs: {"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 Obligāts: Atbildes metadati.

Piemērs: {"request_id":"example"}

Papildu lauki: Nē

Atjaunināt · Atmaksas summa — Atgriešana, reklamācijas un apmaiņa — Pieprasījuma saturs

RefundAmountUpdate · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

amountVirkneObligāts

Decimāla summa JSON virknes formā; null tikai tad, ja atļauts.

minLength: 1maxLength: 64

Ierobežojumi

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

Piemērs: "0.00"

expected_versionVesels skaitlisObligāts

Pirms rakstīšanas nolasītā versija; neatbilstības gadījumā izmaiņa tiek noraidīta.

minimum: 0maximum: 9223372036854775807

Piemērs: 1

reasonVirkneNeobligāts

Reģistrētais izmaiņas iemesls.

maxLength: 500

Noklusējums: ""

Papildu lauki: Nē

Reģistrētā atmaksas informācija

RefundData · Shēma · Datu shēmas: Atgriešana, reklamācijas un apmaiņa

amountMoneyData nullObligāts

Decimāla summa JSON virknes formā; null tikai tad, ja atļauts.

Piemērs: {"amount":"0.00","currency":"PLN","minor_units":2}

completed_atVirkne nullObligāts

Pabeigšanas laiks.

Virkne:format: "date-time"

Piemērs: null

statusVirkneObligāts

Šai konkrētajai darbībai pieņemamais statuss.

Ierobežojumi

enum: ["pending", "completed"]

Piemērs: "pending"

updated_atVirkne nullObligāts

Pēdējās atjaunināšanas laiks.

Virkne:format: "date-time"

Piemērs: "2026-01-01T12:00:00Z"

versionVesels skaitlisObligāts

Resursa versija vienlaicīgu izmaiņu kontrolei.

Piemērs: 1

Papildu lauki: Nē

Iegūt — Atgriešana, reklamācijas un apmaiņa — Atbilde

RequestDetailData · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

created_atVirkneObligāts

Izveides laiks.

format: "date-time"

Piemērs: "2026-01-01T12:00:00Z"

customerRequestCustomerData Obligāts

Šim resursam saglabātā klienta informācija.

Piemērs: {"email":"customer@example.invalid","name":"Example"}

idVirkneObligāts

Resursa identifikators; saglabājiet to atgrieztajā formā. (RequestDetailData).

Piemērs: "example"

itemsMasīvs <RequestItemData > Obligāts

Resursā iekļautie vienumi.

Piemērs:

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

numberVirkneObligāts

Lietotājam paredzēts pasūtījuma vai pieteikuma numurs.

Piemērs: "example"

order_idVirkneObligāts

Saistītā pasūtījuma identifikators.

Piemērs: "example"

order_numberVirkneObligāts

Saistītā pasūtījuma numurs.

Piemērs: "example"

products_valueMoneyData Obligāts

Pasūtījuma produktu vērtība.

Piemērs: {"amount":"0.00","currency":"PLN","minor_units":2}

refundRefundData Obligāts

Reģistrētā atmaksas informācija.

Piemērs:

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

resolution_stateVirkneObligāts

Klienta pieteikuma atrisinājuma stāvoklis.

Ierobežojumi

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

Piemērs: "unknown"

statusRequestStatusData Obligāts

Šai konkrētajai darbībai pieņemamais statuss.

Piemērs: {"id":"example","locale":"en","name":"Example"}

typeRequestType Obligāts

Resursa tips.

Piemērs: "return"

updated_atVirkneObligāts

Pēdējās atjaunināšanas laiks.

format: "date-time"

Piemērs: "2026-01-01T12:00:00Z"

versionVesels skaitlisObligāts

Resursa versija vienlaicīgu izmaiņu kontrolei.

Piemērs: 1

Papildu lauki: Nē

Iegūt — Atgriešana, reklamācijas un apmaiņa — Atbilde

RequestItemData · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

idVirkneObligāts: Resursa identifikators; saglabājiet to atgrieztajā formā. (RequestItemData).

Piemērs: "example"
nameVirkneObligāts: Resursa nosaukums attiecīgajā kontekstā.

Piemērs: "Example"
order_line_idVirkne nullObligāts: Saistītās pasūtījuma rindas identifikators.

Piemērs: "example"
product_idVirkneObligāts: Produkta identifikators.

Piemērs: "example"
quantityVesels skaitlisObligāts: Vienību skaits.

Piemērs: 1
returned_quantityVesels skaitlisObligāts: Šajā rindā atgrieztais daudzums.

Piemērs: 1
skuVirkneObligāts: Krājumu uzskaites vienības kods.

Piemērs: "example"
totalMoneyData Obligāts: Kopējā summa.

Piemērs: {"amount":"0.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Obligāts: Vienas vienības cena.

Piemērs: {"amount":"0.00","currency":"PLN","minor_units":2}
variant_idVirkne nullObligāts: Produkta varianta identifikators.

Piemērs: "example"
variant_optionsMasīvs <shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData > Obligāts: Ar produktu vai momentuzņēmumu saistītās variantu opcijas.

Piemērs: [{"name":"Example","value":"example"}]

Papildu lauki: Nē

Šai konkrētajai darbībai pieņemamais statuss

RequestStatusData · Shēma · Datu shēmas: Atgriešana, reklamācijas un apmaiņa

idVirkneObligāts: Resursa identifikators; saglabājiet to atgrieztajā formā. (RequestStatusData).

Piemērs: "example"
localeVirkneObligāts: Šim pieprasījumam izvēlētā valoda.

Piemērs: "en"
nameVirkne nullObligāts: Resursa nosaukums attiecīgajā kontekstā.

Piemērs: "Example"

Papildu lauki: Nē

Saraksts · Statusi — Atgriešana, reklamācijas un apmaiņa — Atbilde

shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

codeVirkneObligāts: Stabils mašīnlasāms kods.

Piemērs: "example"
created_atVirkneObligāts: Izveides laiks.

format: "date-time"

Piemērs: "2026-01-01T12:00:00Z"
idVirkneObligāts: Resursa identifikators; saglabājiet to atgrieztajā formā. (shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData).

Piemērs: "example"
is_initialLoģiska vērtībaObligāts: Vai šis ir sākuma statuss.

Piemērs: false
localeVirkneObligāts: Šim pieprasījumam izvēlētā valoda.

Piemērs: "en"
nameVirkne nullObligāts: Resursa nosaukums attiecīgajā kontekstā.

Piemērs: "Example"
positionVesels skaitlisObligāts: Pozīcija sakārtotā kolekcijā.

Piemērs: 1
typeRequestType Obligāts: Resursa tips.

Piemērs: "return"

Papildu lauki: Nē

Saraksts · Statusi — Atgriešana, reklamācijas un apmaiņa — Atbilde

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2 · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

dataMasīvs <shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData > Obligāts: Atbildes piemērs · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2.

Piemērs: [{"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 Obligāts: Atbildes metadati.

Piemērs: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Papildu lauki: Nē

Atjaunināt · Statuss — Atgriešana, reklamācijas un apmaiņa — Pieprasījuma saturs

RequestStatusUpdate · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

expected_versionVesels skaitlisObligāts

Pirms rakstīšanas nolasītā versija; neatbilstības gadījumā izmaiņa tiek noraidīta.

minimum: 1maximum: 9223372036854775807

Piemērs: 1

status_idVirkneObligāts

No atbilstošās statusu vārdnīcas iegūts identifikators.

Ierobežojumi

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

Piemērs: "example"

Papildu lauki: Nē

Saraksts — Atgriešana, reklamācijas un apmaiņa — Atbilde

RequestSummaryData · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

created_atVirkneObligāts

Izveides laiks.

format: "date-time"

Piemērs: "2026-01-01T12:00:00Z"

customerRequestCustomerData Obligāts

Šim resursam saglabātā klienta informācija.

Piemērs: {"email":"customer@example.invalid","name":"Example"}

idVirkneObligāts

Resursa identifikators; saglabājiet to atgrieztajā formā. (RequestSummaryData).

Piemērs: "example"

numberVirkneObligāts

Lietotājam paredzēts pasūtījuma vai pieteikuma numurs.

Piemērs: "example"

order_idVirkneObligāts

Saistītā pasūtījuma identifikators.

Piemērs: "example"

order_numberVirkneObligāts

Saistītā pasūtījuma numurs.

Piemērs: "example"

products_valueMoneyData Obligāts

Pasūtījuma produktu vērtība.

Piemērs: {"amount":"0.00","currency":"PLN","minor_units":2}

refundRefundData Obligāts

Reģistrētā atmaksas informācija.

Piemērs:

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

resolution_stateVirkneObligāts

Klienta pieteikuma atrisinājuma stāvoklis.

Ierobežojumi

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

Piemērs: "unknown"

statusRequestStatusData Obligāts

Šai konkrētajai darbībai pieņemamais statuss.

Piemērs: {"id":"example","locale":"en","name":"Example"}

typeRequestType Obligāts

Resursa tips.

Piemērs: "return"

updated_atVirkneObligāts

Pēdējās atjaunināšanas laiks.

format: "date-time"

Piemērs: "2026-01-01T12:00:00Z"

versionVesels skaitlisObligāts

Resursa versija vienlaicīgu izmaiņu kontrolei.

Piemērs: 1

Papildu lauki: Nē

Resursa tips

RequestType · Shēma · Datu shēmas: Atgriešana, reklamācijas un apmaiņa

Virkne

Ierobežojumi

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

Papildu lauki: Jā

Ar produktu vai momentuzņēmumu saistītās variantu opcijas

shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData · Shēma · Datu shēmas: Atgriešana, reklamācijas un apmaiņa

nameVirkneObligāts: Resursa nosaukums attiecīgajā kontekstā.

Piemērs: "Example"
valueVirkneObligāts: Apkārtējā shēmā aprakstītā vērtība.

Piemērs: "example"

Papildu lauki: Nē