QP (In-Bond) module page - how it works, an interactive test form, and the
endpoint reference, all in one place. Set your tenant API Key in the Setup
block below; every request sends the ApiKey header. See
All Forms for the combined surface or Home for the module index.
How it works
QP / In-Bond (QP301) end to end.
QP (In-Bond)
QP is the in-bond (QP301) movement filing: an in-bond header plus
multi-row repeaters for conveyances, bills of lading and parties. header.customer_code is the only
required field.
Submit posts to POST /api/Qp/Submit. reference_no defaults to NEW (legacy
assigns the real reference at insert); the response carries the submission_id. Customer / carrier /
port fields resolve your master + reference data live. Deeply nested container / harmonized / marks detail is not
exposed in this form - post the full JSON for those.
Setup
API key + base URL used by every request below.
Credentials
Leave Base URL blank to call this same server with relative paths (the
normal case). Set it (e.g. https://asci-api.asciofmiami.com) to point the forms
at another host. Every request below sends the ApiKey header.
Sent on every create / submit POST. Click Generate for a fresh one, or a new one is auto-generated per submit if blank.
Test form
Interactive form - POSTs to the API and shows the JSON response + HTTP status.
Maps to POST /api/Qp/Submit. Full field-by-field QP (In-Bond / QP301)
data-entry form with the in-bond header, plus multi-row
repeaters for conveyances, bills of lading and
parties. header.customer_code is the only required field.
reference_no defaults to NEW - the real reference is
auto-assigned by legacy at insert time. The customer / carrier / port lookups resolve your
master + reference data live. (Deeply nested container/harmonized/marks detail is not exposed
here; post the full JSON body for those.)
Calls GET /api/Qp/Status/{id}.
Endpoints
QP endpoint family (api/Qp). Full request schema below.
QP endpoints
| Method | Path | Purpose |
|---|---|---|
| POST | /api/Qp/Submit | Submit a QP / in-bond document. Returns submission_id. |
| POST | /api/Qp/{submissionId}/Transmit | Transmit a built QP to CBP. |
| GET | /api/Qp | List QP submissions. |
| GET | /api/Qp/{submissionId} | Fetch one submission. |
| GET | /api/Qp/Status/{submissionId} | Lifecycle status (used by the form's Check Status button). |
| GET | /api/Qp/{submissionId}/Detail | Full typed detail. |
Schema
Request body for POST /api/Qp/Submit. Field shape mirrors the legacy outbound JSON (IPJSONQP). Envelope: { "document": { … } }. Numeric *_date fields are Julian; string dates as noted.
document (root)
| Field | Type | Req? | Max | Description |
|---|---|---|---|---|
reference_no | string | Yes | 15 | Reference number. Send NEW to auto-generate. |
metadata | object | No | — | Client-supplied key/value bag (string→string, ≤50 entries), echoed on status / webhooks. |
header | object | Yes | - | In-bond header (see below). |
conveyances | array | No | - | Conveyance rows (see below). |
bills_of_lading | array | No | - | BL rows, each with nested containers + additional_references (see below). |
parties | array | No | - | Party rows (see below). |
all_additional_references | array | No | - | Document-level additional references (same shape as the per-BL refs). |
abi_status | array | No | - | ABI status rows (lifecycle; see below). |
| Field | Type | Req? | Max | Description |
|---|---|---|---|---|
in_bond_no | string | No | 12 | In-bond number. |
in_bond_type | string | No | 2 | In-bond type. |
internal_date | string | No | 7 | Internal date (Julian). |
previous_in_bond_no | string | No | 12 | Previous in-bond number. |
initiation_port_code | string | No | 4 | Initiation port code. |
ftz_indicator | string | No | 1 | FTZ indicator. |
customer_code | string | Yes | 6 | Customer code. |
air_in_bond_pedimento | string | No | 1 | Air in-bond / pedimento indicator. |
scac_firms_indicator | string | No | 1 | SCAC / FIRMS indicator. |
mode_of_transport | string | No | 3 | Mode of transport. |
inward_indicator | string | No | 1 | Inward indicator. |
first_delivering_trucking | string | No | 4 | First delivering / trucking carrier. |
ibec_code | string | No | 4 | IBEC code. |
vessel_supplies_indicator | string | No | 1 | Vessel-supplies indicator. |
in_bond_value | number | No | - | In-bond value. |
num_conveyances | number | No | - | Number of conveyances. |
previous_in_bond_date | number | No | - | Previous in-bond date (Julian). |
carrier_code | string | No | 4 | Carrier code. |
carrier_irs | string | No | 12 | Carrier IRS number. |
us_port_of_destination | string | No | 4 | US port of destination. |
foreign_port_of_destination | string | No | 5 | Foreign port of destination. |
canada_mexico_non_seaport | string | No | 1 | Canada/Mexico non-seaport indicator. |
operator_code | string | No | 2 | Operator code. |
printed_indicator | string | No | 1 | Printed indicator. |
bta_indicator | string | No | 1 | BTA indicator. |
go_number | string | No | 12 | G.O. number. |
previous_in_bond_type | string | No | 2 | Previous in-bond type. |
previous_in_bond_port | string | No | 4 | Previous in-bond port. |
log_number | string | No | 11 | Log number. |
comments | array<string> | No | - | Free-text comment lines. |
| Code | Label |
|---|---|
10 | Vessel, non-container |
11 | Vessel, container |
20 | Rail, non-container |
21 | Rail, container |
30 | Truck, non-container |
31 | Truck, container |
32 | Auto |
33 | Pedestrian |
40 | Air, non-container |
41 | Air, container |
60 | Passenger, hand-carried |
70 | Fixed Transport Installations (pipeline / powerhouse) |
Values accepted by header.mode_of_transport. Labels follow CBP CATAIR Appendix B.
| Field | Type | Max | Description |
|---|---|---|---|
seq_no | string | 2 | Sequence number. |
importing_carrier | string | 4 | Importing carrier. |
country_of_carrier | string | 2 | Country of carrier. |
transportation_mode | string | 2 | Transportation mode. |
vessel_code | string | 7 | Vessel code. |
conveyance_name | string | 23 | Conveyance name. |
voyage_flight_trip_no | string | 5 | Voyage / flight / trip number. |
location_of_goods | string | 4 | Location of goods. |
port_of_unlading | string | 4 | Port of unlading. |
export_country | string | 2 | Export country. |
via | string | 12 | Via. |
num_bls | number | - | Number of bills of lading. |
est_date_of_arrival | number | - | Estimated date of arrival (Julian). |
export_date | number | - | Export date (Julian). |
| Field | Type | Max | Description |
|---|---|---|---|
conveyance_no | string | 2 | Owning conveyance number. |
bl_line | string | 4 | BL line. |
awb_bl_no | string | 16 | AWB / BL number. |
house_awb_bl_no | string | 12 | House AWB / BL number. |
foreign_port_of_lading | string | 5 | Foreign port of lading. |
qty_unit / weight_unit / measurement_unit | string | 5 / 2 / 2 | Quantity, weight, measurement units. |
canada_mexico_non_seaport | string | 1 | Canada/Mexico non-seaport indicator. |
place_of_receipt | string | 17 | Place of receipt. |
sub_house_awb_bl_no | string | 12 | Sub-house AWB / BL number. |
foreign_shipper_code / consignee_code / notify_party_code | string | 6 | Party codes. |
secondary_notify_1…_4 | string | 9 | Secondary notify parties. |
quantity / weight / measurement | number | - | Quantity, weight, measurement. |
num_containers | number | - | Number of containers. |
sailing_date | number | - | Sailing date (Julian). |
exporting_conveyance | string | 23 | Exporting conveyance. |
log_book_reference | string | 6 | Log-book reference. |
warehouse_entry_balance | string | 8 | Warehouse entry balance. |
in_bond_via | string | 70 | In-bond via. |
containers | array | - | Nested containers (see below). |
additional_references | array | - | Per-BL additional references (see additional-reference shape below). |
| Field | Type | Max | Description |
|---|---|---|---|
container_line | string | 3 | Container line. |
container_number | string | 14 | Container number. |
seal_number_1 / seal_number_2 | string | 15 | Seal numbers. |
equipment_code | string | 2 | Equipment code. |
harmonized_lines | array | - | HTS lines: item_line, seq, harmonized_tariff(10), weight_unit, more_indicator, item_from_hts, value, weight, rate, duty (numbers) , item_code(20). |
pieces_descriptions | array | - | Pieces: item_line, seq, pieces(number), description(45), more_indicator, manifest_unit_code. |
marks_numbers | array | - | Marks: item_line, seq, marks_and_numbers(45), more_indicator. |
hazardous_materials | array | - | Hazmat: item_line, seq, hazmat_code, class, qualifier, description, contact_name_phone, flashpoint_temperature, flashpoint_unit, negative_indicator, description_instructions(+_2), classification(+_2), more_indicator. |
| Field | Type | Max | Description |
|---|---|---|---|
conveyance_no / bl_line | string | 2 / 4 | Owning conveyance / BL line. |
record_type | string | 1 | Record / party type. |
name | string | 32 | Party name. |
address_line_1…_3 | string | 30 | Address lines. |
phone | string | 10 | Phone. |
party_code | string | 6 | Party code. |
| Field | Type | Max | Description |
|---|---|---|---|
conveyance_no / bl_line | string | 2 / 4 | Owning conveyance / BL line. |
seq | string | 2 | Sequence. |
qualifier | string | 3 | Reference qualifier. |
description | string | 30 | Reference value / description. |
| Field | Type | Description |
|---|---|---|
in_bond_no / awb_bl_no / container | string | Keys for the status row. |
in_bond_status / arrival_status / export_status / transfer_status / diversion_status | string (1) | Per-event status codes, each with a paired *_date and *_time (numbers). |
port_of_unlading / port_of_arrival / port_of_exportation / new_port_of_arrival / port_of_entry | string (4) | Associated ports. |
carrier_assuming_liability | string (4) | Carrier assuming liability. |
entry_number / entry_type | string | Entry number (15) and type (2). |
location_of_goods | string (4) | Location of goods. |
disposition_code / disposition_date / disposition_time | string / number | Disposition code (3) plus date / time. |