Skemi tad-data: Ritorni, ilmenti u skambji

Skemi tad-data: Ritorni, ilmenti u skambji. L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

Skemi tad-data

Elenka — Ritorni, ilmenti u skambji — Risposta

ApiResponse_list_RequestSummaryData__ · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

dataArray <RequestSummaryData > Obbligatorju: Eżempju ta’ tweġiba · ApiResponse_list_RequestSummaryData__.

Eżempju: [{"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 Obbligatorju: Metadata tat-tweġiba.

Eżempju: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Oqsma addizzjonali: Le

Ikseb — Ritorni, ilmenti u skambji — Risposta

ApiResponse_RequestDetailData_ · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

dataRequestDetailData Obbligatorju: Eżempju ta’ tweġiba · RequestDetailData.

Eżempju: {"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 Obbligatorju: Metadata tat-tweġiba.

Eżempju: {"request_id":"example"}

Oqsma addizzjonali: Le

Aġġorna · Ammont tar-rifużjoni — Ritorni, ilmenti u skambji — Kontenut tat-talba

RefundAmountUpdate · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

amountStringObbligatorju

Ammont deċimali kkodifikat bħala string JSON; null biss fejn permess.

minLength: 1maxLength: 64

Restrizzjonijiet

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

Eżempju: "0.00"

expected_versionNumru sħiħObbligatorju

Verżjoni li nqrat qabel il-kitba; nuqqas ta’ qbil jirrifjuta l-aġġornament.

minimum: 0maximum: 9223372036854775807

Eżempju: 1

reasonStringMhux obbligatorju

Raġuni rreġistrata għall-bidla.

maxLength: 500

Valur predefinit: ""

Oqsma addizzjonali: Le

Informazzjoni tar-rifużjoni rreġistrata

RefundData · Skema · Skemi tad-data: Ritorni, ilmenti u skambji

amountMoneyData nullObbligatorju

Ammont deċimali kkodifikat bħala string JSON; null biss fejn permess.

Eżempju: {"amount":"0.00","currency":"PLN","minor_units":2}

completed_atString nullObbligatorju

Ħin tat-tlestija.

String:format: "date-time"

Eżempju: null

statusStringObbligatorju

Status aċċettat minn din l-operazzjoni speċifika.

Restrizzjonijiet

enum: ["pending", "completed"]

Eżempju: "pending"

updated_atString nullObbligatorju

Ħin tal-aktar aġġornament reċenti.

String:format: "date-time"

Eżempju: "2026-01-01T12:00:00Z"

versionNumru sħiħObbligatorju

Verżjoni tar-riżorsa għall-kontroll tal-konkorrenza.

Eżempju: 1

Oqsma addizzjonali: Le

Ikseb — Ritorni, ilmenti u skambji — Risposta

RequestDetailData · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

created_atStringObbligatorju

Ħin tal-ħolqien.

format: "date-time"

Eżempju: "2026-01-01T12:00:00Z"

customerRequestCustomerData Obbligatorju

Informazzjoni tal-klijent irreġistrata għal din ir-riżorsa.

Eżempju: {"email":"customer@example.invalid","name":"Example"}

idStringObbligatorju

Identifikatur tar-riżorsa; żommu kif mogħti. (RequestDetailData).

Eżempju: "example"

itemsArray <RequestItemData > Obbligatorju

Oġġetti inklużi fir-riżorsa.

Eżempju:

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

numberStringObbligatorju

Numru tal-ordni jew tat-talba muri lill-bniedem.

Eżempju: "example"

order_idStringObbligatorju

Identifikatur tal-ordni relatata.

Eżempju: "example"

order_numberStringObbligatorju

Numru tal-ordni relatata.

Eżempju: "example"

products_valueMoneyData Obbligatorju

Valur tal-prodotti fl-ordni.

Eżempju: {"amount":"0.00","currency":"PLN","minor_units":2}

refundRefundData Obbligatorju

Informazzjoni tar-rifużjoni rreġistrata.

Eżempju:

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

resolution_stateStringObbligatorju

Stat tar-riżoluzzjoni ta’ talba tal-klijent.

Restrizzjonijiet

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

Eżempju: "unknown"

statusRequestStatusData Obbligatorju

Status aċċettat minn din l-operazzjoni speċifika.

Eżempju: {"id":"example","locale":"en","name":"Example"}

typeRequestType Obbligatorju

Tip ta’ riżorsa.

Eżempju: "return"

updated_atStringObbligatorju

Ħin tal-aktar aġġornament reċenti.

format: "date-time"

Eżempju: "2026-01-01T12:00:00Z"

versionNumru sħiħObbligatorju

Verżjoni tar-riżorsa għall-kontroll tal-konkorrenza.

Eżempju: 1

Oqsma addizzjonali: Le

Ikseb — Ritorni, ilmenti u skambji — Risposta

RequestItemData · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

idStringObbligatorju: Identifikatur tar-riżorsa; żommu kif mogħti. (RequestItemData).

Eżempju: "example"
nameStringObbligatorju: Isem tar-riżorsa fil-kuntest rilevanti.

Eżempju: "Example"
order_line_idString nullObbligatorju: Identifikatur tal-linja tal-ordni relatata.

Eżempju: "example"
product_idStringObbligatorju: Identifikatur tal-prodott.

Eżempju: "example"
quantityNumru sħiħObbligatorju: Numru ta’ unitajiet.

Eżempju: 1
returned_quantityNumru sħiħObbligatorju: Kwantità rritornata għal din il-linja.

Eżempju: 1
skuStringObbligatorju: Kodiċi tal-unità ta’ ġestjoni tal-istokk.

Eżempju: "example"
totalMoneyData Obbligatorju: Ammont totali.

Eżempju: {"amount":"0.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Obbligatorju: Prezz għal unità waħda.

Eżempju: {"amount":"0.00","currency":"PLN","minor_units":2}
variant_idString nullObbligatorju: Identifikatur tal-varjant tal-prodott.

Eżempju: "example"
variant_optionsArray <shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData > Obbligatorju: Għażliet tal-varjanti assoċjati mal-prodott jew mal-kopja tad-data f’ħin speċifiku.

Eżempju: [{"name":"Example","value":"example"}]

Oqsma addizzjonali: Le

Status aċċettat minn din l-operazzjoni speċifika

RequestStatusData · Skema · Skemi tad-data: Ritorni, ilmenti u skambji

idStringObbligatorju: Identifikatur tar-riżorsa; żommu kif mogħti. (RequestStatusData).

Eżempju: "example"
localeStringObbligatorju: Lingwa magħżula għal din it-talba.

Eżempju: "en"
nameString nullObbligatorju: Isem tar-riżorsa fil-kuntest rilevanti.

Eżempju: "Example"

Oqsma addizzjonali: Le

Elenka · Stati — Ritorni, ilmenti u skambji — Risposta

shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

codeStringObbligatorju: Kodiċi stabbli li jista’ jinqara minn magna.

Eżempju: "example"
created_atStringObbligatorju: Ħin tal-ħolqien.

format: "date-time"

Eżempju: "2026-01-01T12:00:00Z"
idStringObbligatorju: Identifikatur tar-riżorsa; żommu kif mogħti. (shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData).

Eżempju: "example"
is_initialBooleanObbligatorju: Jekk dan huwiex l-istatus inizjali.

Eżempju: false
localeStringObbligatorju: Lingwa magħżula għal din it-talba.

Eżempju: "en"
nameString nullObbligatorju: Isem tar-riżorsa fil-kuntest rilevanti.

Eżempju: "Example"
positionNumru sħiħObbligatorju: Pożizzjoni fil-kollezzjoni ordnata.

Eżempju: 1
typeRequestType Obbligatorju: Tip ta’ riżorsa.

Eżempju: "return"

Oqsma addizzjonali: Le

Elenka · Stati — Ritorni, ilmenti u skambji — Risposta

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2 · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

dataArray <shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData > Obbligatorju: Eżempju ta’ tweġiba · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2.

Eżempju: [{"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 Obbligatorju: Metadata tat-tweġiba.

Eżempju: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Oqsma addizzjonali: Le

Aġġorna · Stat — Ritorni, ilmenti u skambji — Kontenut tat-talba

RequestStatusUpdate · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

expected_versionNumru sħiħObbligatorju

Verżjoni li nqrat qabel il-kitba; nuqqas ta’ qbil jirrifjuta l-aġġornament.

minimum: 1maximum: 9223372036854775807

Eżempju: 1

status_idStringObbligatorju

Identifikatur miksub mid-dizzjunarju tal-istatus rilevanti.

Restrizzjonijiet

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

Eżempju: "example"

Oqsma addizzjonali: Le

Elenka — Ritorni, ilmenti u skambji — Risposta

RequestSummaryData · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

created_atStringObbligatorju

Ħin tal-ħolqien.

format: "date-time"

Eżempju: "2026-01-01T12:00:00Z"

customerRequestCustomerData Obbligatorju

Informazzjoni tal-klijent irreġistrata għal din ir-riżorsa.

Eżempju: {"email":"customer@example.invalid","name":"Example"}

idStringObbligatorju

Identifikatur tar-riżorsa; żommu kif mogħti. (RequestSummaryData).

Eżempju: "example"

numberStringObbligatorju

Numru tal-ordni jew tat-talba muri lill-bniedem.

Eżempju: "example"

order_idStringObbligatorju

Identifikatur tal-ordni relatata.

Eżempju: "example"

order_numberStringObbligatorju

Numru tal-ordni relatata.

Eżempju: "example"

products_valueMoneyData Obbligatorju

Valur tal-prodotti fl-ordni.

Eżempju: {"amount":"0.00","currency":"PLN","minor_units":2}

refundRefundData Obbligatorju

Informazzjoni tar-rifużjoni rreġistrata.

Eżempju:

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

resolution_stateStringObbligatorju

Stat tar-riżoluzzjoni ta’ talba tal-klijent.

Restrizzjonijiet

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

Eżempju: "unknown"

statusRequestStatusData Obbligatorju

Status aċċettat minn din l-operazzjoni speċifika.

Eżempju: {"id":"example","locale":"en","name":"Example"}

typeRequestType Obbligatorju

Tip ta’ riżorsa.

Eżempju: "return"

updated_atStringObbligatorju

Ħin tal-aktar aġġornament reċenti.

format: "date-time"

Eżempju: "2026-01-01T12:00:00Z"

versionNumru sħiħObbligatorju

Verżjoni tar-riżorsa għall-kontroll tal-konkorrenza.

Eżempju: 1

Oqsma addizzjonali: Le

Tip ta’ riżorsa

RequestType · Skema · Skemi tad-data: Ritorni, ilmenti u skambji

String

Restrizzjonijiet

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

Oqsma addizzjonali: Iva

Għażliet tal-varjanti assoċjati mal-prodott jew mal-kopja tad-data f’ħin speċifiku

shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData · Skema · Skemi tad-data: Ritorni, ilmenti u skambji

nameStringObbligatorju: Isem tar-riżorsa fil-kuntest rilevanti.

Eżempju: "Example"
valueStringObbligatorju: Valur deskritt mill-iskema ta’ madwaru.

Eżempju: "example"

Oqsma addizzjonali: Le