Przejdź do głównej zawartości

Pobierz listę zwrotów

GET
/api/v4/returns
curl --request GET \
--url https://twoja-instancja-smerp-api.enterprise.sellrocket.pl/api/v4/returns \
--header 'Authorization: Bearer <token>'

Stronicowana lista zwrotów z filtrami. Odpowiednik getOrderReturns w BaseLinker.

Offset
integer format: int32

Offset (liczba pominiętych wyników)

Limit
integer format: int32

Limit (maksymalna liczba wyników)

SearchOperator
string
Dozwolone wartości: AND OR

Operator wyszukiwania (AND/OR)

ReturnStatusId
integer format: int32

Zwrot statusu (ID statusu zwrotu)

ReturnId
integer format: int64

ID zwrotu

OrderId
integer format: int64

ID zamówienia pierwotnego

CreatedDateFrom
string format: date-time

Data utworzenia: zakres od

CreatedDateTo
string format: date-time

Data utworzenia: zakres do

StatusUpdatedFrom
string format: date-time

Data w statusie: zakres od

StatusUpdatedTo
string format: date-time

Data w statusie: zakres do

RecipientFirstName
string

Imię

RecipientLastName
string

Nazwisko

BuyerEmail
string

Adres e-mail

BuyerPhone
string

Numer telefonu kupującego

BuyerUsername
string

Nazwa użytkownika kupującego

RecipientPhone
string

Numer telefonu odbiorcy

TotalPriceFrom
number format: double

Łączna cena: zakres od

TotalPriceTo
number format: double

Łączna cena: zakres do

ReturnType
string
Dozwolone wartości: Any Full Partial

Typ zwrotu, możliwe wartości: “Any”, “Full”, “Partial”

ProductName
string

Nazwa produktu

ProductSku
string

SKU produktu (code)

ProductEan
string

EAN produktu

SourcePlatformReturnId
string

ID zwrotu platformy źródłowej

RecipientCompanyName
string

Nazwa firmy odbiorcy

ShipmentsTrackingNumberIsContainedIn
string

Numer przesyłki (odwrócony filtr, shipmentNumber musi się zawierać w podanej wartości)

ShipmentsTrackingNumber
string

Numer przesyłki

ReturnStatusIdPriorityFilter
integer format: int64

ID statusu zamówienia, używany jest przed wszystkimi innymi filtrami niezależnie od operatora

ReturnIdFrom
integer format: int64

ID zwrotu: zakres od (włącznie)

ReturnIdTo
integer format: int64

ID zwrotu: zakres do (włącznie)

ConnectionId
integer format: int64

ID połączenia (SourceConnectionId)

ConnectionType
string

Typ połączenia (PlatformName)

OrderBy
string
Dozwolone wartości: Id CreatedAt StatusUpdatedAt TotalPrice RecipientFirstName RecipientLastName RecipientPhone RecipientCompanyName BuyerEmail BuyerPhone BuyerUsername ConnectionId ConnectionType

Pole sortowania (domyślnie Id)

OrderByType
string
Dozwolone wartości: Ascending Descending

Kierunek sortowania (Ascending/Descending, domyślnie Ascending)

IncludeElasticFields
boolean

Czy dołączyć pola elastyczne zwrotu (domyślnie false)

IncludeLineItemsElasticFields
boolean

Czy dołączyć pola elastyczne pozycji zwrotu (domyślnie false)

AdditionalFieldsFilters

Filtry pól elastycznych zwrotu w postaci AdditionalFieldsFilters[nazwa pola]=wartość (wartość pola musi zawierać podany tekst, bez rozróżniania wielkości liter)

object
key
additional properties
string

Success

Typ treściapplication/json
object
list
Array<object>
nullable
object
id
integer format: int64
connectionId
string
nullable
connectionType
string
nullable
sourcePlatformAccountId
string
nullable
sourcePlatformOrderId
string
nullable
sourcePlatformReturnId
string
nullable
platformDateAddedUtc
string format: date-time
payments
object
paymentName
string
nullable
payments
Array<object>
nullable
object
id
integer format: int64
platformId
string
nullable
platformName
string
nullable
finishedAtUtc
string format: date-time
nullable
currency
string
nullable
amount
number format: double
buyer
object
email
string
nullable
username
string
nullable
phone
string
nullable
delivery
object
recipient
object
username
string
nullable
firstName
string
nullable
lastName
string
nullable
companyName
string
nullable
phone
string
nullable
address
object
apartmentNo
string
nullable
houseNo
string
nullable
street
string
nullable
city
string
nullable
postCode
string
nullable
state
string
nullable
countryCode
string
nullable
cost
object
currency
string
nullable
amount
number format: double
summary
object
totalToPay
object
currency
string
nullable
amount
number format: double
returnStatusId
integer format: int64
nullable
status
object
id
integer format: int64
from
string format: date-time
additionalField1
string
nullable
additionalField2
string
nullable
additionalFields
Array<object>
nullable
object
objectId
integer format: int64
ownerType
string
nullable
definitionId
integer format: int64
nullable
fieldType
string
nullable
fieldName
string
nullable
fieldDisplayName
string
nullable
fieldValue
string
nullable
packStationId
integer format: int64
nullable
orderReturnAccountNumber
string
nullable
orderReturnIBan
string
nullable
orderReturnSwitft
string
nullable
fulfillmentStatus
integer format: int32
lineItems
Array<object>
nullable
object
product
object
id
integer format: int64
nullable
warehouseId
string
nullable
platformId
string
nullable
name
string
nullable
code
string
nullable
ean
string
nullable
imageUrl
string
nullable
bundleId
string
nullable
storage
string
nullable
parentName
string
nullable
variantId
string
nullable
location
string
nullable
platformId
string
nullable
quantity
number format: double
quantityPicked
number format: double
nullable
quantityPacked
number format: double
nullable
tax
object
symbol
string
nullable
rate
number format: double
price
object
currency
string
nullable
unitPrice
number format: double
originalCreatedAt
string format: date-time
nullable
returnsReasonId
integer format: int64
returnsPositionStatusId
integer format: int64
additionalFields
Array<object>
nullable
object
objectId
integer format: int64
ownerType
string
nullable
definitionId
integer format: int64
nullable
fieldType
string
nullable
fieldName
string
nullable
fieldDisplayName
string
nullable
fieldValue
string
nullable
miniatures
object
originalImageUrl
string
nullable
selector
string
nullable
entityId
string
nullable
clientNote
string
nullable
orderId
integer format: int64
nullable
isComplete
boolean
shipments
Array<object>
nullable
object
id
integer format: int64
nullable
shipmentId
string
nullable
dateAddedUtc
string format: date-time
nullable
courierCode
string
nullable
trackingNumber
string
nullable
externalCarrierTrackingNumber
string
nullable
status
string
nullable
connectionId
string
nullable
courierConnectionType
string
nullable
courierService
string
nullable
trackingUrl
string
nullable
courierTransport
Array<string>
nullable
deliveryMethodPlatformId
string
nullable
shippingDate
string format: date
nullable
isReturn
boolean
nullable
connection
object
id
integer format: int64
name
string
nullable
connectionType
string
nullable
externalSourceType
string
nullable
externalSourceTypeName
string
nullable
externalSourceId
string
nullable
isConfigured
boolean
isSystemTool
boolean
positionInDefinition
object
position
integer format: int64
createdAt
string format: date-time
courierPickup
boolean
referenceNumber
string
nullable
externalPackage
boolean
buyerComment
string
nullable
pageNumber
integer format: int32
total
integer format: int32
Examplegenerated
{
"list": [
{
"id": 1,
"connectionId": "example",
"connectionType": "example",
"sourcePlatformAccountId": "example",
"sourcePlatformOrderId": "example",
"sourcePlatformReturnId": "example",
"platformDateAddedUtc": "2026-04-15T12:00:00Z",
"payments": {
"paymentName": "example",
"payments": [
{
"id": 1,
"platformId": "example",
"platformName": "example",
"finishedAtUtc": "2026-04-15T12:00:00Z",
"currency": "example",
"amount": 1
}
]
},
"buyer": {
"email": "example",
"username": "example",
"phone": "example"
},
"delivery": {
"recipient": {
"username": "example",
"firstName": "example",
"lastName": "example",
"companyName": "example",
"phone": "example",
"address": {
"apartmentNo": "example",
"houseNo": "example",
"street": "example",
"city": "example",
"postCode": "example",
"state": "example",
"countryCode": "example"
}
},
"cost": {
"currency": "example",
"amount": 1
}
},
"summary": {
"totalToPay": {
"currency": "example",
"amount": 1
}
},
"returnStatusId": 1,
"status": {
"id": 1,
"from": "2026-04-15T12:00:00Z"
},
"additionalField1": "example",
"additionalField2": "example",
"additionalFields": [
{
"objectId": 1,
"ownerType": "example",
"definitionId": 1,
"fieldType": "example",
"fieldName": "example",
"fieldDisplayName": "example",
"fieldValue": "example"
}
],
"packStationId": 1,
"orderReturnAccountNumber": "example",
"orderReturnIBan": "example",
"orderReturnSwitft": "example",
"fulfillmentStatus": 1,
"lineItems": [
{
"product": {
"id": 1,
"warehouseId": "example",
"platformId": "example",
"name": "example",
"code": "example",
"ean": "example",
"imageUrl": "example",
"bundleId": "example",
"storage": "example",
"parentName": "example",
"variantId": "example",
"location": "example"
},
"platformId": "example",
"quantity": 1,
"quantityPicked": 1,
"quantityPacked": 1,
"tax": {
"symbol": "example",
"rate": 1
},
"price": {
"currency": "example",
"unitPrice": 1
},
"originalCreatedAt": "2026-04-15T12:00:00Z",
"returnsReasonId": 1,
"returnsPositionStatusId": 1,
"additionalFields": [
{
"objectId": 1,
"ownerType": "example",
"definitionId": 1,
"fieldType": "example",
"fieldName": "example",
"fieldDisplayName": "example",
"fieldValue": "example"
}
],
"miniatures": {
"originalImageUrl": "example",
"selector": "example",
"entityId": "example"
},
"clientNote": "example"
}
],
"orderId": 1,
"isComplete": true,
"shipments": [
{
"id": 1,
"shipmentId": "example",
"dateAddedUtc": "2026-04-15T12:00:00Z",
"courierCode": "example",
"trackingNumber": "example",
"externalCarrierTrackingNumber": "example",
"status": "example",
"connectionId": "example",
"courierConnectionType": "example",
"courierService": "example",
"trackingUrl": "example",
"courierTransport": [
"example"
],
"deliveryMethodPlatformId": "example",
"shippingDate": "2026-04-15",
"isReturn": true,
"connection": {
"id": 1,
"name": "example",
"connectionType": "example",
"externalSourceType": "example",
"externalSourceTypeName": "example",
"externalSourceId": "example",
"isConfigured": true,
"isSystemTool": true,
"positionInDefinition": {
"position": 1
},
"createdAt": "2026-04-15T12:00:00Z"
},
"courierPickup": true
}
],
"referenceNumber": "example",
"externalPackage": true,
"buyerComment": "example"
}
],
"pageNumber": 1,
"total": 1
}