Схеми даних: Повернення, рекламації та обміни

Схеми даних: Повернення, рекламації та обміни. Поля, типи й обмеження даних, які 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"

Додаткові поля: Ні