Create saved search
Changed onCreate a new saved search configuration in your organization. The saved search can be used to quickly apply predefined search criteria, sorting, and display preferences.
The saved search will be owned by the authenticated user unless otherwise specified.
Request
- Base URL: https://api.mvmnt.io/v1
- URL: https://api.mvmnt.io/v1/saved-searches
- Auth: HTTP bearer
Request body
Example request
{
"name": "Active Shipments - West Coast",
"preferenceType": "SHIPMENT",
"jsonValue": {
"searchCriteria": {
"filters": [
{
"field": "status",
"searchCriteria": {
"operator": "ONE_OF",
"values": [
"ACTIVE",
"PENDING"
]
}
}
]
},
"sorting": [
{
"id": "createdAt",
"desc": true
}
]
},
"isPublic": true
}Response
Saved search created successfully
Example response
{
"object": "SAVED_SEARCH",
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Active Shipments - West Coast",
"preferenceType": "SHIPMENT",
"jsonValue": {
"searchCriteria": {
"filters": [
{
"field": "status",
"searchCriteria": {
"operator": "ONE_OF",
"values": [
"ACTIVE",
"PENDING"
]
}
}
]
},
"sorting": [
{
"id": "createdAt",
"desc": true
}
],
"columnVisibility": {
"status": true,
"createdAt": true
},
"columnOrder": [
"id",
"status",
"createdAt"
]
},
"isPublic": true,
"ownedByUser": "550e8400-e29b-41d4-a716-446655440001",
"createdAt": "2025-01-15T10:00:00Z",
"updatedAt": "2025-01-15T14:30:00Z"
}Changes
- breaking
the response's body type changed from
objectto no type for status - breaking
removed the required property
from the response with the status - breaking
removed the required property
from the response with the status - breaking
removed the required property
from the response with the status - breaking
removed the required property
from the response with the status - breaking
removed the required property
from the response with the status - breaking
removed the required property
from the response with the status - breaking
removed the required property
from the response with the status - breaking
removed the required property
from the response with the status - breaking
removed the required property
from the response with the status - warning
the optional response header
X-RateLimit-Resetremoved for the status429 - info
added
subschema #2to the response bodyallOflist for the response status - info
media type
application/jsonwas changed to a more specific media typeapplication/problem+jsonfor the response status - info
media type
application/jsonwas changed to a more specific media typeapplication/problem+jsonfor the response status - info
media type
application/jsonwas changed to a more specific media typeapplication/problem+jsonfor the response status - info
media type
application/jsonwas changed to a more specific media typeapplication/problem+jsonfor the response status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status
- breaking
- warning
added the new
AP_CREDIT_MEMOenum value to the////response property for the response status - warning
added the new
AR_CREDIT_MEMOenum value to the////response property for the response status - warning
added the new
CARRIER_FACTORenum value to the////response property for the response status - warning
added the new
COMMISSION_PAYMENTenum value to the////response property for the response status - info
added the new
AP_CREDIT_MEMOenum value to the request property//// - info
added the new
AR_CREDIT_MEMOenum value to the request property//// - info
added the new
CARRIER_FACTORenum value to the request property//// - info
added the new
COMMISSION_PAYMENTenum value to the request property////
- warning