Modele zgłoszeń klientów

Schematy zwrotów, reklamacji i wymian Shopently API. Poznaj pola zgłoszenia, statusy oraz struktury zmiany zapisanej kwoty zwrotu.

Schematy danych

Pobierz listę zgłoszeń klientów — Odpowiedź

ApiResponse_list_RequestSummaryData__ · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

dataTablica <RequestSummaryData > Wymagane: Przykład odpowiedzi · ApiResponse_list_RequestSummaryData__.

Przykład: [{"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 Wymagane: Metadane odpowiedzi.

Przykład: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Dodatkowe pola: Nie

Pobierz zgłoszenie klienta — Odpowiedź

ApiResponse_RequestDetailData_ · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

dataRequestDetailData Wymagane: Przykład odpowiedzi · RequestDetailData.

Przykład: {"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 Wymagane: Metadane odpowiedzi.

Przykład: {"request_id":"example"}

Dodatkowe pola: Nie

Zmień zapisaną kwotę zwrotu — Treść żądania

RefundAmountUpdate · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

amountTekstWymagane

Kwota dziesiętna zapisana jako tekst JSON; null tylko tam, gdzie jest dozwolony.

minLength: 1maxLength: 64

Ograniczenia

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

Przykład: "0.00"

expected_versionLiczba całkowitaWymagane

Wersja odczytana przed zapisem; niezgodność powoduje odrzucenie zmiany.

minimum: 0maximum: 9223372036854775807

Przykład: 1

reasonTekstOpcjonalne

Powód zapisany dla zmiany.

maxLength: 500

Wartość domyślna: ""

Dodatkowe pola: Nie

Zapisane informacje o zwrocie środków

RefundData · Schemat · Modele zgłoszeń klientów

amountMoneyData nullWymagane

Kwota dziesiętna zapisana jako tekst JSON; null tylko tam, gdzie jest dozwolony.

Przykład: {"amount":"0.00","currency":"PLN","minor_units":2}

completed_atTekst nullWymagane

Data i czas zakończenia.

Tekst:format: "date-time"

Przykład: null

statusTekstWymagane

Status obsługiwany przez daną operację.

Ograniczenia

enum: ["pending", "completed"]

Przykład: "pending"

updated_atTekst nullWymagane

Data i czas ostatniej aktualizacji.

Tekst:format: "date-time"

Przykład: "2026-01-01T12:00:00Z"

versionLiczba całkowitaWymagane

Wersja zasobu używana do kontroli współbieżności.

Przykład: 1

Dodatkowe pola: Nie

Pobierz zgłoszenie klienta — Odpowiedź

RequestDetailData · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

created_atTekstWymagane

Data i czas utworzenia.

format: "date-time"

Przykład: "2026-01-01T12:00:00Z"

customerRequestCustomerData Wymagane

Dane klienta zapisane dla tego zasobu.

Przykład: {"email":"customer@example.invalid","name":"Example"}

idTekstWymagane

Identyfikator zasobu; zachowaj wartość zwróconą przez API. (RequestDetailData).

Przykład: "example"

itemsTablica <RequestItemData > Wymagane

Pozycje zawarte w zasobie.

Przykład:

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

numberTekstWymagane

Numer zamówienia lub zgłoszenia widoczny dla użytkownika.

Przykład: "example"

order_idTekstWymagane

Identyfikator powiązanego zamówienia.

Przykład: "example"

order_numberTekstWymagane

Numer powiązanego zamówienia.

Przykład: "example"

products_valueMoneyData Wymagane

Wartość produktów w zamówieniu.

Przykład: {"amount":"0.00","currency":"PLN","minor_units":2}

refundRefundData Wymagane

Zapisane informacje o zwrocie środków.

Przykład:

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

resolution_stateTekstWymagane

Stan rozpatrzenia zgłoszenia klienta.

Ograniczenia

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

Przykład: "unknown"

statusRequestStatusData Wymagane

Status obsługiwany przez daną operację.

Przykład: {"id":"example","locale":"en","name":"Example"}

typeRequestType Wymagane

Typ zasobu.

Przykład: "return"

updated_atTekstWymagane

Data i czas ostatniej aktualizacji.

format: "date-time"

Przykład: "2026-01-01T12:00:00Z"

versionLiczba całkowitaWymagane

Wersja zasobu używana do kontroli współbieżności.

Przykład: 1

Dodatkowe pola: Nie

Pobierz zgłoszenie klienta — Odpowiedź

RequestItemData · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

idTekstWymagane: Identyfikator zasobu; zachowaj wartość zwróconą przez API. (RequestItemData).

Przykład: "example"
nameTekstWymagane: Nazwa zasobu we właściwym kontekście.

Przykład: "Example"
order_line_idTekst nullWymagane: Identyfikator powiązanej pozycji zamówienia.

Przykład: "example"
product_idTekstWymagane: Identyfikator produktu.

Przykład: "example"
quantityLiczba całkowitaWymagane: Liczba jednostek.

Przykład: 1
returned_quantityLiczba całkowitaWymagane: Ilość zwrócona dla tej pozycji.

Przykład: 1
skuTekstWymagane: Kod jednostki magazynowej SKU.

Przykład: "example"
totalMoneyData Wymagane: Łączna kwota.

Przykład: {"amount":"0.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Wymagane: Cena jednostkowa.

Przykład: {"amount":"0.00","currency":"PLN","minor_units":2}
variant_idTekst nullWymagane: Identyfikator wariantu produktu.

Przykład: "example"
variant_optionsTablica <shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData > Wymagane: Opcje wariantu powiązane z produktem lub zapisaną pozycją.

Przykład: [{"name":"Example","value":"example"}]

Dodatkowe pola: Nie

Status obsługiwany przez daną operację

RequestStatusData · Schemat · Modele zgłoszeń klientów

idTekstWymagane: Identyfikator zasobu; zachowaj wartość zwróconą przez API. (RequestStatusData).

Przykład: "example"
localeTekstWymagane: Język wybrany dla tego żądania.

Przykład: "en"
nameTekst nullWymagane: Nazwa zasobu we właściwym kontekście.

Przykład: "Example"

Dodatkowe pola: Nie

Pobierz statusy zgłoszeń — Odpowiedź

shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

codeTekstWymagane: Stały kod przeznaczony do przetwarzania przez integrację.

Przykład: "example"
created_atTekstWymagane: Data i czas utworzenia.

format: "date-time"

Przykład: "2026-01-01T12:00:00Z"
idTekstWymagane: Identyfikator zasobu; zachowaj wartość zwróconą przez API. (shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData).

Przykład: "example"
is_initialWartość logicznaWymagane: Czy jest to status początkowy.

Przykład: false
localeTekstWymagane: Język wybrany dla tego żądania.

Przykład: "en"
nameTekst nullWymagane: Nazwa zasobu we właściwym kontekście.

Przykład: "Example"
positionLiczba całkowitaWymagane: Pozycja w uporządkowanej kolekcji.

Przykład: 1
typeRequestType Wymagane: Typ zasobu.

Przykład: "return"

Dodatkowe pola: Nie

Pobierz statusy zgłoszeń — Odpowiedź

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2 · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

dataTablica <shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData > Wymagane: Przykład odpowiedzi · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2.

Przykład: [{"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 Wymagane: Metadane odpowiedzi.

Przykład: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Dodatkowe pola: Nie

Zmień status zgłoszenia — Treść żądania

RequestStatusUpdate · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

expected_versionLiczba całkowitaWymagane

Wersja odczytana przed zapisem; niezgodność powoduje odrzucenie zmiany.

minimum: 1maximum: 9223372036854775807

Przykład: 1

status_idTekstWymagane

Identyfikator pobrany z odpowiedniego słownika statusów.

Ograniczenia

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

Przykład: "example"

Dodatkowe pola: Nie

Pobierz listę zgłoszeń klientów — Odpowiedź

RequestSummaryData · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

created_atTekstWymagane

Data i czas utworzenia.

format: "date-time"

Przykład: "2026-01-01T12:00:00Z"

customerRequestCustomerData Wymagane

Dane klienta zapisane dla tego zasobu.

Przykład: {"email":"customer@example.invalid","name":"Example"}

idTekstWymagane

Identyfikator zasobu; zachowaj wartość zwróconą przez API. (RequestSummaryData).

Przykład: "example"

numberTekstWymagane

Numer zamówienia lub zgłoszenia widoczny dla użytkownika.

Przykład: "example"

order_idTekstWymagane

Identyfikator powiązanego zamówienia.

Przykład: "example"

order_numberTekstWymagane

Numer powiązanego zamówienia.

Przykład: "example"

products_valueMoneyData Wymagane

Wartość produktów w zamówieniu.

Przykład: {"amount":"0.00","currency":"PLN","minor_units":2}

refundRefundData Wymagane

Zapisane informacje o zwrocie środków.

Przykład:

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

resolution_stateTekstWymagane

Stan rozpatrzenia zgłoszenia klienta.

Ograniczenia

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

Przykład: "unknown"

statusRequestStatusData Wymagane

Status obsługiwany przez daną operację.

Przykład: {"id":"example","locale":"en","name":"Example"}

typeRequestType Wymagane

Typ zasobu.

Przykład: "return"

updated_atTekstWymagane

Data i czas ostatniej aktualizacji.

format: "date-time"

Przykład: "2026-01-01T12:00:00Z"

versionLiczba całkowitaWymagane

Wersja zasobu używana do kontroli współbieżności.

Przykład: 1

Dodatkowe pola: Nie

Typ zasobu

RequestType · Schemat · Modele zgłoszeń klientów

Tekst

Ograniczenia

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

Dodatkowe pola: Tak

Opcje wariantu powiązane z produktem lub zapisaną pozycją

shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData · Schemat · Modele zgłoszeń klientów

nameTekstWymagane: Nazwa zasobu we właściwym kontekście.

Przykład: "Example"
valueTekstWymagane: Wartość opisana przez otaczający schemat.

Przykład: "example"

Dodatkowe pola: Nie