Схеми на данните: Връщания, рекламации и замени

Схеми на данните: Връщания, рекламации и замени. Полета, типове и ограничения на данните, приемани или връщани от API.

Схеми на данните

Списък — Връщания, рекламации и замени — Отговор

ApiResponse_list_RequestSummaryData__ · Полета, типове и ограничения на данните, приемани или връщани от API.

dataМасив <RequestSummaryData > Задължително: Примерен отговор · ApiResponse_list_RequestSummaryData__.

Пример: [{"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 Задължително: Метаданни на отговора.

Пример: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Допълнителни полета: Не

Получаване — Връщания, рекламации и замени — Отговор

ApiResponse_RequestDetailData_ · Полета, типове и ограничения на данните, приемани или връщани от API.

dataRequestDetailData Задължително: Примерен отговор · RequestDetailData.

Пример: {"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 Задължително: Метаданни на отговора.

Пример: {"request_id":"example"}

Допълнителни полета: Не

Промяна · Сума за възстановяване — Връщания, рекламации и замени — Тяло на заявката

RefundAmountUpdate · Полета, типове и ограничения на данните, приемани или връщани от API.

amountНизЗадължително

Десетична сума, кодирана като JSON низ; null само когато е позволено.

minLength: 1maxLength: 64

Ограничения

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

Пример: "0.00"

expected_versionЦяло числоЗадължително

Версията, прочетена преди записа; несъответствие отхвърля актуализацията.

minimum: 0maximum: 9223372036854775807

Пример: 1

reasonНизНезадължително

Записана причина за промяната.

maxLength: 500

По подразбиране: ""

Допълнителни полета: Не

Записана информация за възстановяване на сума

RefundData · Схема · Схеми на данните: Връщания, рекламации и замени

amountMoneyData nullЗадължително

Десетична сума, кодирана като JSON низ; null само когато е позволено.

Пример: {"amount":"0.00","currency":"PLN","minor_units":2}

completed_atНиз nullЗадължително

Време на приключване.

Низ:format: "date-time"

Пример: null

statusНизЗадължително

Статус, приеман от тази конкретна операция.

Ограничения

enum: ["pending", "completed"]

Пример: "pending"

updated_atНиз nullЗадължително

Време на последната актуализация.

Низ:format: "date-time"

Пример: "2026-01-01T12:00:00Z"

versionЦяло числоЗадължително

Версия на ресурса за контрол на едновременни записи.

Пример: 1

Допълнителни полета: Не

Получаване — Връщания, рекламации и замени — Отговор

RequestDetailData · Полета, типове и ограничения на данните, приемани или връщани от API.

created_atНизЗадължително

Време на създаване.

format: "date-time"

Пример: "2026-01-01T12:00:00Z"

customerRequestCustomerData Задължително

Клиентски данни, записани за този ресурс.

Пример: {"email":"customer@example.invalid","name":"Example"}

idНизЗадължително

Идентификатор на ресурса; запазете го във върнатия вид. (RequestDetailData).

Пример: "example"

itemsМасив <RequestItemData > Задължително

Елементи, включени в ресурса.

Пример:

[{"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_valueMoneyData Задължително

Стойност на продуктите в поръчката.

Пример: {"amount":"0.00","currency":"PLN","minor_units":2}

refundRefundData Задължително

Записана информация за възстановяване на сума.

Пример:

{"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НизЗадължително

Състояние на разрешаване на клиентското искане.

Ограничения

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

Пример: "unknown"

statusRequestStatusData Задължително

Статус, приеман от тази конкретна операция.

Пример: {"id":"example","locale":"en","name":"Example"}

typeRequestType Задължително

Тип на ресурса.

Пример: "return"

updated_atНизЗадължително

Време на последната актуализация.

format: "date-time"

Пример: "2026-01-01T12:00:00Z"

versionЦяло числоЗадължително

Версия на ресурса за контрол на едновременни записи.

Пример: 1

Допълнителни полета: Не

Получаване — Връщания, рекламации и замени — Отговор

RequestItemData · Полета, типове и ограничения на данните, приемани или връщани от API.

idНизЗадължително: Идентификатор на ресурса; запазете го във върнатия вид. (RequestItemData).

Пример: "example"
nameНизЗадължително: Име на ресурса в съответния контекст.

Пример: "Example"
order_line_idНиз nullЗадължително: Идентификатор на свързания ред от поръчката.

Пример: "example"
product_idНизЗадължително: Идентификатор на продукта.

Пример: "example"
quantityЦяло числоЗадължително: Брой единици.

Пример: 1
returned_quantityЦяло числоЗадължително: Върнато количество за този ред.

Пример: 1
skuНизЗадължително: Код на складовата единица.

Пример: "example"
totalMoneyData Задължително: Обща сума.

Пример: {"amount":"0.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Задължително: Цена за една единица.

Пример: {"amount":"0.00","currency":"PLN","minor_units":2}
variant_idНиз nullЗадължително: Идентификатор на продуктовия вариант.

Пример: "example"
variant_optionsМасив <shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData > Задължително: Опции на варианта, свързани с продукта или снимката на състоянието.

Пример: [{"name":"Example","value":"example"}]

Допълнителни полета: Не

Статус, приеман от тази конкретна операция

RequestStatusData · Схема · Схеми на данните: Връщания, рекламации и замени

idНизЗадължително: Идентификатор на ресурса; запазете го във върнатия вид. (RequestStatusData).

Пример: "example"
localeНизЗадължително: Език, избран за тази заявка.

Пример: "en"
nameНиз nullЗадължително: Име на ресурса в съответния контекст.

Пример: "Example"

Допълнителни полета: Не

Списък · Статуси — Връщания, рекламации и замени — Отговор

shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData · Полета, типове и ограничения на данните, приемани или връщани от API.

codeНизЗадължително: Устойчив машинночетим код.

Пример: "example"
created_atНизЗадължително: Време на създаване.

format: "date-time"

Пример: "2026-01-01T12:00:00Z"
idНизЗадължително: Идентификатор на ресурса; запазете го във върнатия вид. (shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData).

Пример: "example"
is_initialБулева стойностЗадължително: Дали това е началният статус.

Пример: false
localeНизЗадължително: Език, избран за тази заявка.

Пример: "en"
nameНиз nullЗадължително: Име на ресурса в съответния контекст.

Пример: "Example"
positionЦяло числоЗадължително: Позиция в подредената колекция.

Пример: 1
typeRequestType Задължително: Тип на ресурса.

Пример: "return"

Допълнителни полета: Не

Списък · Статуси — Връщания, рекламации и замени — Отговор

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2 · Полета, типове и ограничения на данните, приемани или връщани от API.

dataМасив <shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData > Задължително: Примерен отговор · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2.

Пример: [{"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 Задължително: Метаданни на отговора.

Пример: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Допълнителни полета: Не

Промяна · Статус — Връщания, рекламации и замени — Тяло на заявката

RequestStatusUpdate · Полета, типове и ограничения на данните, приемани или връщани от API.

expected_versionЦяло числоЗадължително

Версията, прочетена преди записа; несъответствие отхвърля актуализацията.

minimum: 1maximum: 9223372036854775807

Пример: 1

status_idНизЗадължително

Идентификатор от съответния справочник на статусите.

Ограничения

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

Пример: "example"

Допълнителни полета: Не

Списък — Връщания, рекламации и замени — Отговор

RequestSummaryData · Полета, типове и ограничения на данните, приемани или връщани от API.

created_atНизЗадължително

Време на създаване.

format: "date-time"

Пример: "2026-01-01T12:00:00Z"

customerRequestCustomerData Задължително

Клиентски данни, записани за този ресурс.

Пример: {"email":"customer@example.invalid","name":"Example"}

idНизЗадължително

Идентификатор на ресурса; запазете го във върнатия вид. (RequestSummaryData).

Пример: "example"

numberНизЗадължително

Номер на поръчката или искането, предназначен за потребителя.

Пример: "example"

order_idНизЗадължително

Идентификатор на свързаната поръчка.

Пример: "example"

order_numberНизЗадължително

Номер на свързаната поръчка.

Пример: "example"

products_valueMoneyData Задължително

Стойност на продуктите в поръчката.

Пример: {"amount":"0.00","currency":"PLN","minor_units":2}

refundRefundData Задължително

Записана информация за възстановяване на сума.

Пример:

{"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НизЗадължително

Състояние на разрешаване на клиентското искане.

Ограничения

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

Пример: "unknown"

statusRequestStatusData Задължително

Статус, приеман от тази конкретна операция.

Пример: {"id":"example","locale":"en","name":"Example"}

typeRequestType Задължително

Тип на ресурса.

Пример: "return"

updated_atНизЗадължително

Време на последната актуализация.

format: "date-time"

Пример: "2026-01-01T12:00:00Z"

versionЦяло числоЗадължително

Версия на ресурса за контрол на едновременни записи.

Пример: 1

Допълнителни полета: Не

Тип на ресурса

RequestType · Схема · Схеми на данните: Връщания, рекламации и замени

Низ

Ограничения

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

Допълнителни полета: Да

Опции на варианта, свързани с продукта или снимката на състоянието

shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData · Схема · Схеми на данните: Връщания, рекламации и замени

nameНизЗадължително: Име на ресурса в съответния контекст.

Пример: "Example"
valueНизЗадължително: Стойност, описана от околната схема.

Пример: "example"

Допълнителни полета: Не