Skip to main content
Developer Compliance1.0.0-beta.1

Pause or review supplier questionnaire delivery

Pauses a plan or applies a versioned review, revocation or closure to a case. Approval requires clean submitted evidence. The mutation, replay receipt and audit record commit together.

POST/api/v1/compliance/suppliers/{supplierId}/delivery/actions

Workspace automation for approved Dashio products. Each token is scoped to one Space and independently granted operations. Requests spend shared minute credits, and selected operation groups also share hourly quotas.

Required token scope is compliance:supplier-delivery:write. Scopes are independent.

This operation uses 3 credits from a shared budget of 60 credits per token and 300 per Space each UTC minute.

Run these examples on a trusted server with DASHIO_API_TOKEN configured. Use a private terminal when inspecting response data. Examples send one request with a bounded timeout and do not retry automatically.

Set DASHIO_IDEMPOTENCY_KEY to the persisted key for this logical write. Reuse it only for an identical retry.

Authentication

Dashio developer token (HTTP Bearer) API authentication guide

Path parameters

supplierIdstringRequired

Stable supplier record ID in the token’s Space, up to 200 characters. Encode it as one path segment.

Example"supplier-001"

Query parameters

None documented.

Header parameters

Idempotency-KeystringRequired

Use 16 to 128 ASCII letters, digits, underscores or hyphens. Reuse the same key for the same supplier and action when retrying.

Example"61d9263e-143b-4407-90fd-e3b54df67c96"

Request body

application/json · Required

Send one action as an application/json body of up to 32 KiB.

Pause the plan
Review the latest submission
Revoke the response link
Close the case

Responses

Headers on every response

X-Request-Idstring (uuid)Optional

Server-generated ID to include in a support request.

200

A committed action or an exact seven-day receipt replay.

Response headers

RateLimit-LimitintegerOptional

Per-token capacity in the reported gateway window, expressed in requests of this operation. A shared Space budget also applies. Present when the request reaches the authenticated gateway. Minimum: 1.

RateLimit-RemainingintegerOptional

Requests of this operation remaining under the current token, Space and applicable operation-group quotas. Present when the request reaches the authenticated gateway. Minimum: 0.

RateLimit-ResetintegerOptional

Unix timestamp in seconds when the reported gateway quota resets. Present when the request reaches the authenticated gateway. Minimum: 0.

Idempotency-ReplayedstringOptional

Present as true for an exact retry. Required value: "true".

application/json

Plan acknowledgement
Case acknowledgement

400

Invalid identifier, query, action or body.

application/json

statusCodeintegerRequired

Minimum: 400. Maximum: 599.

statusMessagestringOptional

A safe explanation suitable for display.

dataobjectRequired

No field description supplied.

401

Developer token is missing or invalid.

Response headers

WWW-AuthenticatestringOptional

Bearer authentication challenge. A rejected token can include the invalid_token error.

application/json

Uses the same response body schema as HTTP 400.

402

The operation requires an eligible Compliance entitlement.

application/json

Uses the same response body schema as HTTP 400.

403

The token lacks the required grant, or the plan does not permit the operation.

application/json

Uses the same response body schema as HTTP 400.

404

The API, Compliance, supplier, delivery case or clean evidence is unavailable.

application/json

Uses the same response body schema as HTTP 400.

408

The JSON body timed out.

application/json

Uses the same response body schema as HTTP 400.

409

The key was used for another request, the saved recipient changed, or the current case state or version prevents the action.

application/json

Uses the same response body schema as HTTP 400.

413

The JSON body exceeds 32 KiB.

application/json

Uses the same response body schema as HTTP 400.

415

Use an application/json body.

application/json

Uses the same response body schema as HTTP 400.

429

The Developer request budget or supplier delivery receipt limit is exhausted. Edge traffic limits can also return 429.

Response headers

RateLimit-LimitintegerOptional

Per-token capacity in the reported gateway window, expressed in requests of this operation. A shared Space budget also applies. Present when the request reaches the authenticated gateway. Minimum: 1.

RateLimit-RemainingintegerOptional

Requests of this operation remaining under the current token, Space and applicable operation-group quotas. Present when the request reaches the authenticated gateway. Minimum: 0.

RateLimit-ResetintegerOptional

Unix timestamp in seconds when the reported gateway quota resets. Present when the request reaches the authenticated gateway. Minimum: 0.

Retry-AfterintegerOptional

Seconds to wait before retrying, when the limiting policy supplies a retry time. Minimum: 1.

application/json

Uses the same response body schema as HTTP 400.

503

Supplier delivery is temporarily unavailable.

application/json

Uses the same response body schema as HTTP 400.

Was this helpful?