# /korea_customs/codes

`POST /api/korea_customs/codes`

Price: 5 credits

Code lists the Korea Customs Service trade query accepts — partner countries, head customs offices, ports and airports, and export or import transaction types, each with its Korean name

## How to use it

Look up a value before filtering trades with it: port_code, customs_office_code and transaction_type_code are only accepted as the codes listed here, and an unlisted value comes back as an empty result rather than an error. Country codes are ISO 3166-1 alpha-2, plus a few the source adds for international bodies (Z1 for the IMF, for example), and the names are Korean, so search the keyword in Korean when matching by name.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `kind` (string, required) — Which of the code lists the trades filters accept to return (one of: "country", "customs_office", "port", "transaction_type")
- `flow` (string) — For kind=transaction_type, which direction's list to return — the source keeps separate export and import transaction types (default: "export"; one of: "export", "import")
- `keyword` (string, nullable) — Keep only entries whose name or code contains this text (minLength: 1)
- `count` (integer, required) — Max number of codes to return (min: 1)

## Response

### 200 — Successful Response

- `@type` (string) (default: "KoreaCustomsCode")
- `record_key` (string, required)
- `code` (string, required)
- `name` (string, required)
- `kind` (string, required) (one of: "country", "customs_office", "port", "transaction_type")
- `flow` (string, nullable) (one of: "export", "import")

## Errors

### 422 — Validation Error

The request body did not validate

What to do: Check the fields against this schema. A URN with the wrong prefix is the most common cause.

- `detail` (array)
  - `loc` (array, required)
  - `msg` (string, required)
  - `type` (string, required)
  - `input` (any)
  - `ctx` (object)

### 408

The request ran past its time limit

What to do: Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.

### 412

The entity was not found, or a precondition failed

What to do: Retrying will not help: either the entity does not exist, or the input points at a different one.

### 429

Too many requests: a rate limit or a usage window is exhausted

What to do: When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.

### 500

Something broke on our side

What to do: Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.

### 529

Rate limit reached, or the endpoint is overloaded

What to do: Wait at least 30 seconds, then retry.

## Response envelope

Success: Array of objects (may be empty if no results)

Error: Error may coexist with partial results if it occurs mid-execution. Check X-Error header and status code.

Every response carries these headers:

- `X-Error` — Error message text (present only on error)
- `X-Request-ID` — Unique request identifier
- `X-Execution-Time` — Execution time in seconds
- `X-Result-Count` — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
- `X-Total-Available-Results` — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
- `X-Warning` — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
- `X-Retry-After` — Seconds to wait before retrying. Present only on 429.