SuspendItemsRequest is a JSON Structure definition published by Otter, describing 3 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-structure/public-api-suspend-items-request-structure.json",
"name": "SuspendItemsRequest",
"description": "SuspendItemsRequest schema from Public API (Otter Public API).",
"type": "object",
"properties": {
"entityIds": {
"type": "array",
"description": "Entity IDs to suspend. These should be the IDs as you represent them in your system.",
"example": [
"9cc4bb5e-bc97-40d9-af28-c02ef1483610"
],
"items": {
"type": "string",
"description": "Entity IDs to suspend.",
"example": "[\"9cc4bb5e-bc97-40d9-af28-c02ef1483610\",\"9929290d-31eb-425d-8732-17c4074ac75e\"]"
}
},
"note": {
"type": "string",
"description": "The reason you are suspending the items.",
"example": "Out of item"
},
"status": {
"$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-suspension-status-schema.json"
}
},
"required": [
"entityIds",
"note",
"status"
]
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.