Archive Container

Production

https://api.polestar-production.com

PUT

/purpletrac/v1/containers/{id}

Archive a screened container.

Refer to Container Screening to see how to use this endpoint in a container screening workflow.

Request

Authorization

API Key

Add parameter in query

api_key

Example:

api_key: ********************

API Key

Add parameter in query

username

Example:

username: ********************

Path Params

Query Params

Responses

🟢200OK

application/json

The container was archived. Its container_phase becomes ARCHIVE, visible on the next read.

Bodyapplication/json

🟠401Unauthorized

🟠403Forbidden

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://api.polestar-production.com/purpletrac/v1/containers/?username=undefined&api_key=%3Capi-key%3E'

Response Example

200 - Archived

{
    "container_screen_id": "e32a3293-b081-4bb6-bd36-436ca204165",
    "scac": "CMDU",
    "container_number": "TGBU6795701",
    "container_reference": "User defined reference field",
    "creation_date": "2023-07-19T11:06:51.482652516Z"
}

Modified at 2026-09-18 08:35:54

Get all Container Screening Results

Get a single Container screening result