Skip to content

docs: document line hold type #314

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
matt-t49 wants to merge 1 commit into
base: main
Choose a base branch
from
+16 −1
Open

docs: document line hold type #314

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion docs/api-docs/in-depth-guides/holds-and-fees.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,14 +106,15 @@ When a hold is cleared, the object is removed from the array entirely. There is
| Hold name | Description | Who resolves it |
|-----------|-------------|-----------------|
| `freight` | Carrier freight charges unpaid | Shipping line or freight forwarder |
| `line` | Carrier or steamship-line release pending | Shipping line |
| `customs` | CBP hold — docs, exam, or inspection | Licensed customs broker |
| `USDA` | USDA phytosanitary inspection | Customs broker or USDA compliance team |
| `VACIS` | Non-intrusive X-ray / gamma-ray scan | Customs broker |
| `TMF` | Terminal management fee (pier pass) | Pay terminal directly |
| `other` | Unmapped hold — check `description` | Terminal or broker |

<Note>
Hold names are case-sensitive. `USDA`, `VACIS`, and `TMF` are uppercase. `freight`, `customs`, and `other` are lowercase. Match values exactly in your code.
Hold names are case-sensitive. `USDA`, `VACIS`, and `TMF` are uppercase. `freight`, `line`, `customs`, and `other` are lowercase. Match values exactly in your code.
</Note>

<AccordionGroup>
Expand All @@ -131,6 +132,20 @@ Hold names are case-sensitive. `USDA`, `VACIS`, and `TMF` are uppercase. `freigh
**Who resolves it:** Contact the shipping line or your freight forwarder to confirm payment status.
</Accordion>

<Accordion title="line — Carrier release pending">
The terminal has not received or confirmed the ocean carrier's release for the container. Terminals may describe this as a line hold, bill of lading hold, carrier hold, or steamship-line release pending. This is distinct from a `freight` hold and does not by itself indicate unpaid freight charges.

```json
{
"name": "line",
"status": "hold",
"description": "LINE HOLD"
}
```

**Who resolves it:** Contact the shipping line to confirm that it has issued the container or bill of lading release to the terminal.
</Accordion>

<Accordion title="customs — CBP hold">
US Customs and Border Protection (CBP) has placed a hold. This can occur due to documentation issues, a random examination, or a targeted inspection. The container cannot be released until CBP clears it.

Expand Down
Loading