Przejdź do głównej zawartości

Zaktualizuj zwrot

PUT
/api/v4/returns/{id}
curl --request PUT \
--url https://twoja-instancja-smerp-api.enterprise.sellrocket.pl/api/v4/returns/1 \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "payments": { "paymentName": "example", "payments": [ { "platformId": "example", "platformName": "example", "finishedAtUtc": "2026-04-15T12:00:00Z", "paymentAmount": { "currency": "example", "amount": 1 } } ] }, "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 } }, "buyer": { "email": "example", "username": "example", "phone": "example" }, "returnStatusId": 1, "additionalField1": "example", "additionalField2": "example", "packStationId": 1, "orderReturnAccountNumber": "example", "orderReturnIBan": "example", "orderReturnSwitft": "example", "sellerComments": [ "example" ], "fulfillmentStatus": 1, "orderId": 1, "lineItems": [ { "id": 1, "returnsReasonId": 1, "returnsPositionStatusId": 1, "platformId": "example", "product": { "id": 1, "warehouseId": "example", "platformId": "example", "name": "example", "code": "example", "ean": "example", "bundleId": "example", "storage": "example", "imageUrl": "example", "parentName": "example", "location": "example", "variantId": "example" }, "quantity": 1, "quantityPicked": 1, "quantityPacked": 1, "tax": { "symbol": "example", "rate": 1 }, "price": { "currency": "example", "unitPrice": 1 }, "originalCreatedAt": "2026-04-15T12:00:00Z", "additionalFields": [ { "fieldName": "example", "fieldType": "example", "fieldValue": "example", "additionalFieldDefinition": { "fieldName": "example", "fieldDisplayName": "example", "fieldType": "example", "predefinedValues": [ "example" ] } } ], "miniatures": { "originalImageUrl": "example", "selector": "example", "entityId": "example" }, "clientNote": "example" } ], "elasticFields": [ { "fieldName": "example", "fieldType": "example", "fieldValue": "example", "definition": { "fieldName": "example", "fieldDisplayName": "example", "fieldType": "example", "predefinedValues": [ "example" ] } } ], "referenceNumber": "example", "externalPackage": true, "buyerComment": "example", "userName": "example" }'

Odpowiednik setOrderReturnFields w BaseLinker. Operacja asynchroniczna – zwraca zadanie (job), którego wynik sprawdzisz w Zadaniach asynchronicznych.

id
wymagane
integer format: int64
Typ treściapplication/json
object
payments
object
paymentName
string
nullable
payments
Array<object>
nullable
object
platformId
string
nullable
platformName
string
nullable
finishedAtUtc
string format: date-time
nullable
paymentAmount
object
currency
string
nullable
amount
number format: double
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
buyer
object
email
string
nullable
username
string
nullable
phone
string
nullable
returnStatusId
integer format: int64
additionalField1
string
nullable
additionalField2
string
nullable
packStationId
integer format: int64
nullable
orderReturnAccountNumber
string
nullable
orderReturnIBan
string
nullable
orderReturnSwitft
string
nullable
sellerComments
Array<string>
nullable
fulfillmentStatus
integer format: int64
orderId
integer format: int64
nullable
lineItems
Array<object>
nullable
object
id
integer format: int64
nullable
returnsReasonId
integer format: int64
nullable
returnsPositionStatusId
integer format: int32
nullable
platformId
string
nullable
product
object
id
integer format: int64
nullable
warehouseId
string
nullable
platformId
string
nullable
name
string
nullable
code
string
nullable
ean
string
nullable
bundleId
string
nullable
storage
string
nullable
imageUrl
string
nullable
parentName
string
nullable
location
string
nullable
variantId
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
additionalFields
Array<object>
nullable
object
fieldName
string
nullable
fieldType
string
nullable
fieldValue
string
nullable
additionalFieldDefinition
object
fieldName
string
nullable
fieldDisplayName
string
nullable
fieldType
string
nullable
predefinedValues
Array<string>
nullable
miniatures
object
originalImageUrl
string
nullable
selector
string
nullable
entityId
string
nullable
clientNote
string
nullable
elasticFields
Array<object>
nullable
object
fieldName
string
nullable
fieldType
string
nullable
fieldValue
string
nullable
definition
object
fieldName
string
nullable
fieldDisplayName
string
nullable
fieldType
string
nullable
predefinedValues
Array<string>
nullable
referenceNumber
string
nullable
externalPackage
boolean
buyerComment
string
nullable <= 1024 characters
userName
string
nullable
Examplegenerated
{
"payments": {
"paymentName": "example",
"payments": [
{
"platformId": "example",
"platformName": "example",
"finishedAtUtc": "2026-04-15T12:00:00Z",
"paymentAmount": {
"currency": "example",
"amount": 1
}
}
]
},
"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
}
},
"buyer": {
"email": "example",
"username": "example",
"phone": "example"
},
"returnStatusId": 1,
"additionalField1": "example",
"additionalField2": "example",
"packStationId": 1,
"orderReturnAccountNumber": "example",
"orderReturnIBan": "example",
"orderReturnSwitft": "example",
"sellerComments": [
"example"
],
"fulfillmentStatus": 1,
"orderId": 1,
"lineItems": [
{
"id": 1,
"returnsReasonId": 1,
"returnsPositionStatusId": 1,
"platformId": "example",
"product": {
"id": 1,
"warehouseId": "example",
"platformId": "example",
"name": "example",
"code": "example",
"ean": "example",
"bundleId": "example",
"storage": "example",
"imageUrl": "example",
"parentName": "example",
"location": "example",
"variantId": "example"
},
"quantity": 1,
"quantityPicked": 1,
"quantityPacked": 1,
"tax": {
"symbol": "example",
"rate": 1
},
"price": {
"currency": "example",
"unitPrice": 1
},
"originalCreatedAt": "2026-04-15T12:00:00Z",
"additionalFields": [
{
"fieldName": "example",
"fieldType": "example",
"fieldValue": "example",
"additionalFieldDefinition": {
"fieldName": "example",
"fieldDisplayName": "example",
"fieldType": "example",
"predefinedValues": [
"example"
]
}
}
],
"miniatures": {
"originalImageUrl": "example",
"selector": "example",
"entityId": "example"
},
"clientNote": "example"
}
],
"elasticFields": [
{
"fieldName": "example",
"fieldType": "example",
"fieldValue": "example",
"definition": {
"fieldName": "example",
"fieldDisplayName": "example",
"fieldType": "example",
"predefinedValues": [
"example"
]
}
}
],
"referenceNumber": "example",
"externalPackage": true,
"buyerComment": "example",
"userName": "example"
}

Success

Typ treściapplication/json
object
id
integer format: int64
createdAt
string format: date-time
updatedAt
string format: date-time
payload
nullable
result
nullable
status
string
Dozwolone wartości: New InProgress Completed Failed
command
string
nullable
scope
string
nullable
scopeValue
string
nullable
silentMode
boolean
ajsChainId
string
nullable
ajsChainVisits
string
nullable
Example
{
"status": "New"
}