К содержанию
TelegaFirst

Для AI-агентов: markdown этой страницы — /docs/api-op-deleteorderstatus.mdиндекс документации — /llms.txt

deleteOrderStatus

Обновлено

POST /api/v1/tools/statuses/delete

Soft-delete an order status by tenant sequence

Авторизация и права

Scopes: ALL. Auth alternatives: OR; scopes внутри альтернативы: ALL.

ПолеЗначение
security.0.hubApiKey[]
security.1.hubBearer[]
securitySchemes.hubApiKey.in"header"
securitySchemes.hubApiKey.name"X-Api-Key"
securitySchemes.hubApiKey.type"apiKey"
securitySchemes.hubBearer.scheme"bearer"
securitySchemes.hubBearer.type"http"
x-required-scopes["statuses:write"]

Параметры запроса

ПолеЗначение
0.in"header"
0.name"Idempotency-Key"
0.requiredtrue
0.schema0.schema

Тело запроса

ПолеЗначение
content.application/json.schemaStatusDeleteRequest
requiredtrue

Ответы

ПолеЗначение
201.content.application/json.schemaOrderStatusDeleteResult
201.description"Deleted; missing or already deleted status succeeds too. System status deletion conflicts."
201.headers.X-Bot-Username.description"Active tenant public bot username, when available"
201.headers.X-Bot-Username.schema201.headers.X-Bot-Username.schema
201.headers.X-Client-Slug.description"Active tenant public slug, when available"
201.headers.X-Client-Slug.schema201.headers.X-Client-Slug.schema
201.headers.X-RateLimit-Limit.description"Computed request budget"
201.headers.X-RateLimit-Limit.schema201.headers.X-RateLimit-Limit.schema
201.headers.X-RateLimit-Remaining.description"Remaining budget or unknown"
201.headers.X-RateLimit-Remaining.schema201.headers.X-RateLimit-Remaining.schema
201.headers.X-RateLimit-Reset.description"Budget reset Unix timestamp"
201.headers.X-RateLimit-Reset.schema201.headers.X-RateLimit-Reset.schema

Ошибки

ПолеЗначение
400.content.application/problem+json.schemaProblemDetails
400.description"Invalid strict request body, or missing Idempotency-Key on POST with a body"
401.content.application/problem+json.schemaProblemDetails
401.description"Missing, invalid or mismatched API-key transports; surface-session JWT is not an alternative"
403.content.application/problem+json.schemaProblemDetails
403.description"Required statuses scope, live credential access or resource policy refused"
409.content.application/problem+json.schemaProblemDetails
409.description"An idempotent command is processing, or a protected status conflicts with this operation"
413.content.application/problem+json.schemaProblemDetails
413.description"Per-tool payload or item-count cap exceeded"
422.content.application/problem+json.schemaProblemDetails
422.description"Idempotency-Key was reused with a different request body"
429.content.application/problem+json.schemaProblemDetails
429.description"Rate limit exceeded or unavailable; fail closed"
429.headers.Retry-After.description"Seconds before retry when supplied by the limiter"
429.headers.Retry-After.schema429.headers.Retry-After.schema

Дополнительные условия

ПолеЗначение
operationId"deleteOrderStatus"
summary"Soft-delete an order status by tenant sequence"
tags["statuses"]