Mark the container as shipped

Method POST https://<client-api-host>/api/v3.1/containers/{crid}/unlock

Set shipped on the container. It has no effect on the messages: publication happens at encoding time and does not depend on shipment. Idempotent.

Authorization

Required scope containers:unlock

Use Authorization: Bearer liv_<prefix>_<secret>. The key must belong to a platform served by the V3 pipeline; otherwise every route answers 403 PLATFORM_NOT_V3.

Parameters

Name	In	Type	Required	Constraints	Description
`crid`	Path	`string`	Required		Your business reference of the container.

Responses

200 application/json Schema V31UnlockResponse

Container marked as shipped.

401 application/json Schema V31ErrorEnvelope

Authentication failed or missing bearer token.

json 401

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Missing API key"
  }
}

403 application/json Schema V31ErrorEnvelope

Authenticated but not allowed: missing scope (FORBIDDEN), invalid platform constraints (INVALID_PLATFORM_CONSTRAINTS) or a platform not served by API v3.1 (PLATFORM_NOT_V3).

json 403

{
  "error": {
    "code": "PLATFORM_NOT_V3",
    "message": "Platform is not served by API v3.1"
  }
}

404 application/json Schema V31ErrorEnvelope

Container not found for this crid on the platform of the key.

json 404

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Container not found"
  }
}

429 application/json Schema V31ErrorEnvelope

Rate limit exceeded.

json 429

{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Too many requests"
  }
}

500 application/json Schema V31ErrorEnvelope

Unexpected server error.

json 500

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal error"
  }
}