Przejdź do głównej zawartości

Wyszukaj obiekty po wartości pola

POST
/api/v3/AdditionalFields/Search
curl --request POST \
--url https://twoja-instancja-additional-fields-api.enterprise.sellrocket.pl/api/v3/AdditionalFields/Search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "ownerType": "example", "fieldValue": "example", "ownerIds": [ 1 ], "offset": 1, "limit": 1 }'

Zwraca identyfikatory obiektów (np. zamówień) spełniających filtry po wartościach pól dodatkowych, opcjonalnie zawężone do podanej listy ID. To operacja odczytu.


`ownerType` - Type of an object for which the all the fields should be searched. To check available OwnerTypes, check `GET /AdditionalFieldsOwners`
`fieldValue` - Value of the field
`orderIds` - List of order Ids to search through

Sample request
``` {instancja}-smerp-api.enterprise.sellrocket.pl/api/v2/Orders/{orderId}", "fieldValue": "t", "ownerIds": [201492, 205784], "offset": 0, "limit": 100 } ```
object
ownerType
string
nullable
fieldValue
string
nullable
ownerIds
Array<integer>
nullable
offset
integer format: int32
limit
integer format: int32
Examplegenerated
{
"ownerType": "example",
"fieldValue": "example",
"ownerIds": [
1
],
"offset": 1,
"limit": 1
}

Success

Typ treściapplication/json
object
list
Array<integer>
nullable
pageNumber
integer format: int32
total
integer format: int32
Examplegenerated
{
"list": [
1
],
"pageNumber": 1,
"total": 1
}

Bad Request

Typ treściapplication/json
object
error
string
nullable
Examplegenerated
{
"error": "example"
}

Server Error