Tarifflo API reference

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

get/sort-sessions/{sortSessionId}

Where the upload stands

Requires the API key scope `filing`.

Auth:ApiKeyorBearer

Path parameters

sortSessionIdstringrequired

Responses

200Successful response

application/json

object

idstringrequired
namestringrequired
configurationIdstringrequired
lanestringrequired
One ofentryclassification
runsobject[]required
5 fields per item
- scopestringrequired
  One ofuploadentry
- refIdstringrequired
- runIdstringrequired
- statusstringrequired
  One ofrunningblockedcompletefailedcancelled
- stagesobject[]required
  8 fields per item
  keystringrequired
  statusstringrequired
  One ofpendingrunningfinalizingcomplete_with_openawaiting_gateheldcompletefailedblockedskipped
  totalnumberrequired
  completednumberrequired
  failednumberrequired
  parkednumberrequired
  awaitingInputnumberrequired
  creditsNeedednumber | nullrequired
countsobject | nullrequired
2 options
Any of
1.object
productsnumberrequired
classifiednumberrequired
withOriginnumberrequired
pricednumberrequired
comparednumberrequired
unpriceablenumberrequired
pendingApprovalnumberrequired
2.null
reportobject | object | object | nullrequired
2 options
Any of
1.object | object | object
One of
1.object
state"ready"required
runIdstringrequired
reportIdstringrequired
fileNamestringrequired
urlstringrequired
expiresInMinutesnumberrequired
2.object
state"building"required
runIdstringrequired
3.object
state"unavailable"required
reasonstringrequired
2.null

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

404Not found

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: NOT_FOUND
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

delete/sort-sessions/{sortSessionId}

Delete an upload and everything under it

Requires the API key scope `filing`.

Auth:ApiKeyorBearer

Path parameters

sortSessionIdstringrequired

Responses

200Successful response

application/json

object

deletedtruerequired

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

404Not found

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: NOT_FOUND
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

post/sort-sessions/{sortSessionId}/files

Add files to an upload: one signed PUT URL per file

Requires the API key scope `filing`.

Auth:ApiKeyorBearer

Path parameters

sortSessionIdstringrequired

Request body · required

application/json

object

entrySessionIdstring | null
filesobject[]required
min items 1max items 200
6 fields per item
- filenamestringrequired
  min length 1
- mimeTypestringrequired
  min length 1
- sizeintegerrequired
  ≥ 0≤ 104857600
- pathstring[]
  max items 50default: []
- contentHashstring
- declaredDoctype"product_sheet"

Responses

200Successful response

application/json

object

resultsobject[]required
6 fields per item
- packetIdstringrequired
- signedUrlstring | nullrequired
- filenamestringrequired
- pathstring[]required
- reusedbooleanrequired
- entryAttachmentstring | nullrequired
mintednumberrequired
reusednumberrequired
attributednumberrequired

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

post/sort-sessions/{sortSessionId}/files/confirm

Confirm the files whose PUT landed

Requires the API key scope `filing`.

Auth:ApiKeyorBearer

Path parameters

sortSessionIdstringrequired

Request body · required

application/json

object

packetIdsstring[]required
min items 1max items 200

Responses

200Successful response

application/json

object

confirmednumberrequired

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

post/sort-sessions/{sortSessionId}/start

Start, or re-drive, the upload's run

Requires the API key scope `filing`.

Auth:ApiKeyorBearer

Path parameters

sortSessionIdstringrequired

Responses

200Successful response

application/json

object

queuedCountnumberrequired
runIdstring | nullrequired

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

get/products/{productId}/classification

A product's rate facts and its printed-code comparison

Requires the API key scope `filing`.

Auth:ApiKeyorBearer

Path parameters

productIdstringrequired

Responses

200Successful response

application/json

object

factsobjectrequired
3 fields
- entryDatestring | nullrequired
- shipmentValuenumber | nullrequired
- sharesobjectrequired
  4 fields
  steelnumber
  aluminumnumber
  coppernumber
  usContentnumber
comparisonobject | nullrequired
2 options
Any of
1.object
product_idstringrequired
destinationstringrequired
originstring | nullrequired
original_codestringrequired
proposed_codestringrequired
original_ratenumber | nullrequired
proposed_ratenumber | nullrequired
delta_ptsnumber | nullrequired
customs_valuenumber | nullrequired
savingsnumber | nullrequired
risk_scorenumberrequired
riskstringrequired
risk_reasonsstring[]required
2.null
componentsobject[]required
13 fields per item
- product_idstringrequired
- destinationstringrequired
- originstring | nullrequired
- original_codestringrequired
- proposed_codestringrequired
- original_ratenumber | nullrequired
- proposed_ratenumber | nullrequired
- delta_ptsnumber | nullrequired
- customs_valuenumber | nullrequired
- savingsnumber | nullrequired
- risk_scorenumberrequired
- riskstringrequired
- risk_reasonsstring[]required

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

404Not found

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: NOT_FOUND
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

post/sort-sessions/{sortSessionId}/products

A page of the upload's products, filtered and sorted

Requires the API key scope `filing`.

Auth:ApiKeyorBearer

Path parameters

sortSessionIdstringrequired

Request body · required

application/json

object

startRowintegerrequired
≥ 0≤ 9007199254740991
endRowintegerrequired
≥ 1≤ 9007199254740991
statusstring
One ofPENDINGPROCESSINGAWAITING_INPUTPENDING_APPROVALAPPROVEDREJECTEDCOMPLETEDUPLOADEDFAILED
searchstring
min length 1max length 100
sortobject
2 fields
- columnstringrequired
  One ofnamedescriptionoriginhtsstatusupdatedAt
- directionstringrequired
  One ofascdesc

Responses

200Successful response

application/json

object

rowsobject[]required
11 fields per item
- idstringrequired
- namestringrequired
- descriptionstringrequired
- statusstringrequired
  One ofPENDINGPROCESSINGAWAITING_INPUTPENDING_APPROVALAPPROVEDREJECTEDCOMPLETEDUPLOADEDFAILED
- codestring | nullrequired
- originstring | nullrequired
- originalCodestring | nullrequired
- originalRatestring | nullrequired
- ratestring | nullrequired
- eccnstring | nullrequired
- updatedAtstringrequired
totalnumberrequired

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

get/sort-sessions/{sortSessionId}/questions

The open questions as a sheet to fill in

Requires the API key scope `filing`.

Auth:ApiKeyorBearer

Path parameters

sortSessionIdstringrequired

Query parameters

timeZonestring
max length 64

Responses

200Successful response

application/json

object | null

Any of

1.object

urlstringrequired
fileNamestringrequired
questionsnumberrequired

2.null

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

404Not found

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: NOT_FOUND
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

post/sort-sessions/{sortSessionId}/answers

The questions sheet, filled in

Requires the API key scope `filing`.

Auth:ApiKeyorBearer

Path parameters

sortSessionIdstringrequired

Request body · required

application/json

object

fileBase64stringrequired
min length 1max length 30000000

Responses

200Successful response

application/json

object

answeredRowsnumberrequired
unmatchedRowsnumberrequired
answerednumberrequired
resumedJobsnumberrequired

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

Configuration

get/sort-sessions/{sortSessionId}/pipeline-configurations

List the configurations a sort session can pick

Requires the API key scope `filing`.

Auth:ApiKeyorBearer

Path parameters

sortSessionIdstringrequired

Responses

200Successful response

application/json

object

configurationsobject[]required
12 fields per item
- idstringrequired
- namestringrequired
- descriptionstringrequired
- isDefaultbooleanrequired
- lockedbooleanrequired
- isTemporarybooleanrequired
- generalobjectrequired
  6 fields
  requiredContentmap<string, boolean>required
  Keysfiled_baselineproduct_descriptionhts_codeline_valuequantitycountry_of_originentry_datetransport_eventimporter_identity
  unidentifiedDocumentsstringrequired
  One ofskipask
  filerIdstring | nullrequired
  reuseByHashmap<string, boolean>required
  Keysbeads_facts
  includeLiquidatedbooleanrequired
  filingobjectrequired
  2 fields
  savingsThresholdUsdnumberrequired
  ≥ 0
  dutyDecreasesOnlybooleanrequired
- jobsmap<string, object>required
  Keys 15 values
  sort_documentsagent_sortclassify_productsweb_searcheccncoospipgaadcvddutyreviewreportvalidateapproved_codesstage_filing
  1 field per value
  onbooleanrequired
- validationRulesmap<string, boolean>required
  Keys 42 values
  civ_ior_namedciv_us_consignee_for_foreign_iorciv_description_sufficientciv_country_of_originciv_quantityciv_set_components_reconcileciv_unit_and_total_valueciv_total_reconcilesciv_currencyciv_incoterms_or_chargesciv_value_adjustmentsciv_manufacturer_identifiedciv_documents_belonges_parties_match_cives_coo_matches_cives_country_of_export_matches_transportes_export_date_after_ladinges_hts_matches_cives_part_number_correctes_all_civ_hts_presentes_spi_supportedes_values_match_cives_quantities_match_cives_currency_and_exchange_ratees_adjustments_match_incotermses_assists_declaredes_commissions_declaredes_first_sale_supportedes_mid_is_actual_manufactureres_relationship_recordedes_article_set_reproducedes_set_origin_dominancees_set_component_quantitieses_ch99_consistentes_232_claim_matches_descriptiones_232_claim_contradictedes_fees_mpf_hmfes_lines_completees_port_of_lading_matches_transportes_gross_weight_matches_packinges_ior_number_matches_profilees_pga_evidence_present
- unsetValidationRulesstring[]requiredread-only
- billingobjectrequired
  1 field
  actionstringrequired
  One ofentry_preparedper_beadnone
- lanestringrequired
  One ofentryclassification
temporaryobject | nullrequired
2 options
Any of
1.object
idstringrequired
namestringrequired
descriptionstringrequired
isDefaultbooleanrequired
lockedbooleanrequired
isTemporarybooleanrequired
generalobjectrequired
6 fields
requiredContentmap<string, boolean>required
Keysfiled_baselineproduct_descriptionhts_codeline_valuequantitycountry_of_originentry_datetransport_eventimporter_identity
unidentifiedDocumentsstringrequired
One ofskipask
filerIdstring | nullrequired
reuseByHashmap<string, boolean>required
Keysbeads_facts
includeLiquidatedbooleanrequired
filingobjectrequired
2 fields
savingsThresholdUsdnumberrequired
≥ 0
dutyDecreasesOnlybooleanrequired
jobsmap<string, object>required
Keys 15 values
sort_documentsagent_sortclassify_productsweb_searcheccncoospipgaadcvddutyreviewreportvalidateapproved_codesstage_filing
1 field per value
onbooleanrequired
validationRulesmap<string, boolean>required
Keys 42 values
civ_ior_namedciv_us_consignee_for_foreign_iorciv_description_sufficientciv_country_of_originciv_quantityciv_set_components_reconcileciv_unit_and_total_valueciv_total_reconcilesciv_currencyciv_incoterms_or_chargesciv_value_adjustmentsciv_manufacturer_identifiedciv_documents_belonges_parties_match_cives_coo_matches_cives_country_of_export_matches_transportes_export_date_after_ladinges_hts_matches_cives_part_number_correctes_all_civ_hts_presentes_spi_supportedes_values_match_cives_quantities_match_cives_currency_and_exchange_ratees_adjustments_match_incotermses_assists_declaredes_commissions_declaredes_first_sale_supportedes_mid_is_actual_manufactureres_relationship_recordedes_article_set_reproducedes_set_origin_dominancees_set_component_quantitieses_ch99_consistentes_232_claim_matches_descriptiones_232_claim_contradictedes_fees_mpf_hmfes_lines_completees_port_of_lading_matches_transportes_gross_weight_matches_packinges_ior_number_matches_profilees_pga_evidence_present
unsetValidationRulesstring[]requiredread-only
billingobjectrequired
1 field
actionstringrequired
One ofentry_preparedper_beadnone
lanestringrequired
One ofentryclassification
2.null
selectedIdstring | nullrequired

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

404Not found

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: NOT_FOUND
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

get/pipeline-configurations

List the organization's pipeline configurations

Requires the API key scope `filing`.

Auth:ApiKeyorBearer

Responses

200Successful response

application/json

object[]

idstringrequired
namestringrequired
descriptionstringrequired
isDefaultbooleanrequired
lockedbooleanrequired
isTemporarybooleanrequired
generalobjectrequired
6 fields
- requiredContentmap<string, boolean>required
  Keysfiled_baselineproduct_descriptionhts_codeline_valuequantitycountry_of_originentry_datetransport_eventimporter_identity
- unidentifiedDocumentsstringrequired
  One ofskipask
- filerIdstring | nullrequired
- reuseByHashmap<string, boolean>required
  Keysbeads_facts
- includeLiquidatedbooleanrequired
- filingobjectrequired
  2 fields
  savingsThresholdUsdnumberrequired
  ≥ 0
  dutyDecreasesOnlybooleanrequired
jobsmap<string, object>required
Keys 15 values
sort_documentsagent_sortclassify_productsweb_searcheccncoospipgaadcvddutyreviewreportvalidateapproved_codesstage_filing
1 field per value
- onbooleanrequired
validationRulesmap<string, boolean>required
Keys 42 values
civ_ior_namedciv_us_consignee_for_foreign_iorciv_description_sufficientciv_country_of_originciv_quantityciv_set_components_reconcileciv_unit_and_total_valueciv_total_reconcilesciv_currencyciv_incoterms_or_chargesciv_value_adjustmentsciv_manufacturer_identifiedciv_documents_belonges_parties_match_cives_coo_matches_cives_country_of_export_matches_transportes_export_date_after_ladinges_hts_matches_cives_part_number_correctes_all_civ_hts_presentes_spi_supportedes_values_match_cives_quantities_match_cives_currency_and_exchange_ratees_adjustments_match_incotermses_assists_declaredes_commissions_declaredes_first_sale_supportedes_mid_is_actual_manufactureres_relationship_recordedes_article_set_reproducedes_set_origin_dominancees_set_component_quantitieses_ch99_consistentes_232_claim_matches_descriptiones_232_claim_contradictedes_fees_mpf_hmfes_lines_completees_port_of_lading_matches_transportes_gross_weight_matches_packinges_ior_number_matches_profilees_pga_evidence_present
unsetValidationRulesstring[]requiredread-only
billingobjectrequired
1 field
- actionstringrequired
  One ofentry_preparedper_beadnone
lanestringrequired
One ofentryclassification

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

404Not found

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: NOT_FOUND
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

Rate report

post/sort-sessions/{sortSessionId}/rate-report

Build or fetch the upload's rate report at each product's origin on file

Requires the API key scope `tariff_rates`.

Auth:ApiKeyorBearer

Path parameters

sortSessionIdstringrequired
min length 1

Request body · required

application/json

object

restartboolean

Responses

200Successful response

application/json

object | object | object

One of

1.object

state"ready"required
runIdstringrequired
reportIdstringrequired
fileNamestringrequired
urlstringrequired
expiresInMinutesnumberrequired

2.object

state"building"required
runIdstringrequired

3.object

state"unavailable"required
reasonstringrequired

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

Entries

post/entries

File an entry summary

Validates, writes and submits a whole entry summary. CBP's answer arrives as an `entry.disposition` webhook. A repeat of an Idempotency-Key answers the first result with `Idempotent-Replayed: true`. Requires the API key scope `entries:write`.

Auth:ApiKeyorBearer

Headers

Idempotency-Keystringrequired
min length 1max length 255

Request body · required

application/json

object

entry__schema0required
The entry summary to file; its shape is documented at https://tarifflo.com/docs/v2.
webhookUrlstring
Where the `entry.disposition` webhook goes; defaults to the key environment's URL.

Responses

201Filed and submitted to CBP

application/json

object

efidstringrequired
entryNumbernumber
shortJobIdstringrequired
status"AWAITING_CBP"required

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

409The first request with this Idempotency-Key is still filing

application/json

error.PRECONDITION_FAILED

errorobjectrequired
7 fields
- codestringrequired
  example: CONFLICT
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

412No webhook URL for the key's environment

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: PRECONDITION_FAILED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

422The entry is not valid

application/json

error.UNPROCESSABLE_CONTENT

errorobjectrequired
7 fields
- codestringrequired
  example: UNPROCESSABLE_CONTENT
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

502Submitting to CBP failed

application/json

error.BAD_GATEWAY

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_GATEWAY
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

delete/entries/{efid}

Delete an entry

Requires the API key scope `entries:write`.

Auth:ApiKeyorBearer

Path parameters

efidstringrequired

Responses

200Successful response

application/json

object

idstringrequired
messagestringrequired
One ofSuccessfully deletedRequest to delete sent to CBP

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

404Not found

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: NOT_FOUND
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

get/entries/{efid}/responses

Get CBP's entry summary response for an entry

Requires the API key scope `filing`.

Auth:ApiKeyorBearer

Path parameters

efidstringrequired
min length 1

Responses

200Successful response

application/json

object

dispositionobject | nullrequired
2 options
Any of
1.object
groupReferenceobjectrequired
3 fields
dataTypestringrequired
contentstring
positionnumber
responseobjectrequired
8 fields
dispositionTypestring
severityCodestring
conditionCodestringrequired
descriptionstringrequired
filerCodestring
entryNumbernumber
entryVersionnumber
referenceNumberstring
2.null
conditionsobject[]required
2 fields per item
- referencePathobject[]required
  3 fields per item
  dataTypestringrequired
  contentstring
  positionnumber
- responsesobject[]required
  8 fields per item
  dispositionTypestring
  severityCodestring
  conditionCodestringrequired
  descriptionstringrequired
  filerCodestring
  entryNumbernumber
  entryVersionnumber
  referenceNumberstring
hasInternalErrorbooleanrequired

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

404Not found

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: NOT_FOUND
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

get/entries/{efid}/cargo-release

Get CBP's cargo release response for an entry

Requires the API key scope `filing`.

Auth:ApiKeyorBearer

Path parameters

efidstringrequired
min length 1

Responses

200Successful response

application/json

object | null

Any of

1.object

dispositionobjectrequired
3 fields
- messageTypeCodestringrequired
- statusstringrequired
  One ofDRAFTAWAITING CBPAPPROVEDDENIEDWARNINGINFOINTERNAL ERROR
- descriptionstringrequired
conditionGroupsobject[]required
2 fields per item
- referencePathobject[]required
  3 fields per item
  dataTypestringrequired
  contentstring
  positionnumber
- responsesobject[]required
  6 fields per item
  messageTypeCodestringrequired
  messageIdentifierCodestringrequired
  narrativeMessagestringrequired
  actionDatestring
  actionTimestring
  releaseDatestring

2.null

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

404Not found

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: NOT_FOUND
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

get/entries/{efid}/isf

Get CBP's ISF response for an entry

Requires the API key scope `filing`.

Auth:ApiKeyorBearer

Path parameters

efidstringrequired
min length 1

Responses

200Successful response

application/json

object | null

Any of

1.object

dispositionobjectrequired
4 fields
- messageTypeCodestringrequired
- statusstringrequired
  One ofDRAFTAWAITING CBPAPPROVEDDENIEDWARNINGINTERNAL ERROR
- descriptionstringrequired
- isfTransactionNumberstring
conditionGroupsobject[]required
2 fields per item
- referencePathobject[]required
  3 fields per item
  dataTypestringrequired
  contentstring
  positionnumber
- responsesobject[]required
  3 fields per item
  messageTypeCodestringrequired
  messageIdentifierCodestringrequired
  narrativeMessagestringrequired

2.null

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

404Not found

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: NOT_FOUND
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

get/entries/{efid}/batch-errors

List CBP batch rejects against an entry

Requires the API key scope `filing`.

Auth:ApiKeyorBearer

Path parameters

efidstringrequired
min length 1

Responses

200Successful response

application/json

object[]

idstringrequired
shortJobIdstringrequired
appIdCodestring
conditionsobject[]required
7 fields per item
- idstringrequired
- severityCodestringrequired
- conditionCodestringrequired
- narrativeTextstringrequired
- referenceTypestring
- referenceOccurrencenumber
- referenceTextstring
receivedAtstringrequired

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

404Not found

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: NOT_FOUND
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

get/entries/{efid}/notifications

List CBP status notifications for an entry

Requires the API key scope `filing`.

Auth:ApiKeyorBearer

Path parameters

efidstringrequired
min length 1

Responses

200Successful response

application/json

object[]

idstringrequired
entryNumberstringrequired
filerCodestringrequired
receivedAtstringrequired
dispositionTypeCodestringrequired
notificationReasonCodestringrequired
dateOfActionstring
lineItemIdentifierstringrequired
remarksTextstringrequired
cbpUserstringrequired
telephoneNumberstringrequired
telephoneExtensionNumberstringrequired
actionIdentificationNumberstringrequired
quotaLinesobject[]required
8 fields per item
- idstringrequired
- lineItemIdentifierstringrequired
- statusCodestringrequired
- statusDescriptionstringrequired
- requestedQuantitynumber
- requestedUomstringrequired
- reservedQuantitynumber
- reservedUomstringrequired
pgaStatusesobject[]required
10 fields per item
- idstringrequired
- agencyCodestringrequired
- programCodestringrequired
- entryLevelStatusCodestringrequired
- entryLevelStatusMessagestringrequired
- lineLevelStatusCodestringrequired
- statusReasonCodestringrequired
- lineRangestring
- actionAtstring
- commentsstring[]required

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

404Not found

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: NOT_FOUND
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

post/entries/{efid}/importer

Set or clear an entry's importer

Requires the API key scope `entries:write`.

Auth:ApiKeyorBearer

Path parameters

efidstringrequired
min length 1

Request body · required

application/json

object

importerIdstring | nullrequired

Responses

200Successful response

application/json

any

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

get/entries/{versionId}/versions

List every version of an entry

Requires the API key scope `filing`.

Auth:ApiKeyorBearer

Path parameters

versionIdstringrequired
min length 1

Responses

200Successful response

application/json

object[]

idstringrequired
versionIdstringrequired
headerIdstring
organizationIdstringrequired
entryNumbernumber
submittedAtstring
importerNamestring
totalValuenumber
totalDutynumber
productsnumber
statusstringrequired
One of 18 values
DRAFTAWAITING CBPAPPROVEDDENIEDWARNINGPGA WARNINGINFOINTERNAL ERRORUNKNOWNCBP CONTROLLEDDOCUMENTS REQUESTEDDOCUMENTS RECEIVEDINACTIVATEDCANCELLEDPSC REVERTEDTIB DENIEDPGA UPDATELIQUIDATED
numActionItemsnumberrequired
typestring
brokerReferenceNumberstring
internalNamestring
cbpSourcedboolean
isLatestboolean

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

404Not found

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: NOT_FOUND
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

post/entries/{efid}/copies

Create a new entry from an existing one

Requires the API key scope `entries:write`.

Auth:ApiKeyorBearer

Path parameters

efidstringrequired
min length 1

Responses

200Successful response

application/json

object

shippingobjectrequired
1 field
- idstringrequired

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

post/entries/{efid}/drafts

Open a new draft version of an entry

Requires the API key scope `entries:write`.

Auth:ApiKeyorBearer

Path parameters

efidstringrequired
min length 1

Responses

200Successful response

application/json

object

efidstringrequired

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

Audit

post/audit/uploads

Get an audit upload URL

A presigned PUT URL for one document. PUT the bytes, then start a run with the returned `fileId`. Requires the API key scope `audit`.

Auth:ApiKeyorBearer

Request body · required

application/json

object

filenamestringrequired
PDF, Excel, Word, CSV or an image; the type is checked again from the bytes.
min length 1max length 500
mimeTypestringrequired
min length 1max length 200

Responses

200Successful response

application/json

object

fileIdstringrequired
Pass it in `fileIds` when starting the run.
uploadUrlstringrequired
PUT the file's bytes here, with the declared `mimeType` as Content-Type.
expiresInSecondsnumberrequired

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

post/audit/uploads/bulk

Get many audit upload URLs

Presigned PUT URLs for up to 50 documents; one unsupported file type refuses the whole call. Requires the API key scope `audit`.

Auth:ApiKeyorBearer

Request body · required

application/json

object

filesobject[]required
min items 1max items 50
2 fields per item
- filenamestringrequired
  PDF, Excel, Word, CSV or an image; the type is checked again from the bytes.
  min length 1max length 500
- mimeTypestringrequired
  min length 1max length 200

Responses

200Successful response

application/json

object

uploadsobject[]required
3 fields per item
- fileIdstringrequired
  Pass it in `fileIds` when starting the run.
- uploadUrlstringrequired
  PUT the file's bytes here, with the declared `mimeType` as Content-Type.
- expiresInSecondsnumberrequired

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

post/audit/runs

Start a pre-audit run

Files the uploaded documents under a fresh audit request and runs the pre-audit (ingest, classification, rate and savings). Answers 202 with the run id; the result is delivered as a `pre_audit.completed` webhook to the key environment's URL (or `Tarifflo-Webhook-Url`) and pollable at GET /audit/runs/{jobId}. `config: "post"` (PSC) is not available yet. Requires the API key scope `audit`.

Auth:ApiKeyorBearer

Headers

Idempotency-Keystring
Repeats of the same request with the same key answer the first result (72 hours) with `Idempotent-Replayed: true`.
max length 255

Request body · required

application/json

object

configstringrequired
One ofprepost
fileIdsstring[]required
min items 1max items 50
clientNamestring
The audit client to file under (default "API Intake").
min length 1max length 200
requestNamestring
min length 1max length 200
destinationCountriesstring[]
Markets to rate for (default US).
dryRunboolean
Price the request at the organization's card and reserve nothing; answers 200 with the estimate.

Responses

202Queued (or, for `dryRun`, priced with 200)

application/json

object | object

Any of

1.object

jobIdstringrequired
The run id: poll GET /audit/runs/{jobId}.
creditsobject
What the job has reserved, used and refunded so far, in credits.
4 fields
- actionstring | nullrequired
- reservednumberrequired
- usednumberrequired
- refundednumberrequired
status"queued"required
config"pre"required
filesQueuednumberrequired
messagestringrequired

2.object

dryRuntruerequired
estimatedCreditsnumberrequired
linesobject[]required
3 fields per item
- actionstringrequired
  One of 16 values
  rate_lookupadcvd_screenpga_applicabilitycode_classifiedexport_controlorigin_determinationentry_filedentry_prepareddocument_ocrdocument_extractdocument_sortproduct_enrichentry_reviewrationale_documentaudit_parsedata_export
- unitsnumberrequired
- creditsnumberrequired
balancenumberrequired
unitstringrequired
One oftokencredit
notestring

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

402Not enough credits

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: PAYMENT_REQUIRED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

409The first request with this Idempotency-Key is still filing

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: CONFLICT
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

501`config: "post"` is not available yet

application/json

error.NOT_IMPLEMENTED

errorobjectrequired
7 fields
- codestringrequired
  example: NOT_IMPLEMENTED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

get/audit/runs/{jobId}

Get a pre-audit run

The run's status; once complete, `data` is the `pre_audit.completed` webhook's `data`. Requires the API key scope `audit`.

Auth:ApiKeyorBearer

Path parameters

jobIdstringrequired

Responses

200Successful response

application/json

object | object | object

Any of

1.object

jobIdstringrequired
creditsobjectrequired
What the job has reserved, used and refunded so far, in credits.
4 fields
- actionstring | nullrequired
- reservednumberrequired
- usednumberrequired
- refundednumberrequired
status"failed"required
errorobjectrequired
2 fields
- code"RUN_FAILED"required
- messagestringrequired

2.object

jobIdstringrequired
creditsobjectrequired
What the job has reserved, used and refunded so far, in credits.
4 fields
- actionstring | nullrequired
- reservednumberrequired
- usednumberrequired
- refundednumberrequired
statusstringrequired
One ofqueuedprocessingblocked
stagesCompletenumberrequired
stagesTotalnumberrequired
creditsNeedednumber
Credits the run waits for (`blocked` only).
purchaseUrlstring
Where to add credits (`blocked` only).

3.object

jobIdstringrequired
creditsobjectrequired
What the job has reserved, used and refunded so far, in credits.
4 fields
- actionstring | nullrequired
- reservednumberrequired
- usednumberrequired
- refundednumberrequired
status"complete"required
eventstringrequired
The webhook event that delivered the same `data`.
data__schema2required
The run's result, exactly the webhook's `data`.

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

404Not found

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: NOT_FOUND
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

Billing

get/pricing

Get the price list

Credits per unit for every billable action at list price. Public: needs no key.

Responses

200Successful response

application/json

object

creditCentsnumberrequired
What one credit costs, in US cents.
actionsobject[]required
5 fields per item
- actionstringrequired
  One of 16 values
  rate_lookupadcvd_screenpga_applicabilitycode_classifiedexport_controlorigin_determinationentry_filedentry_prepareddocument_ocrdocument_extractdocument_sortproduct_enrichentry_reviewrationale_documentaudit_parsedata_export
- unitstringrequired
- creditsnumberrequired
- listCreditsnumberrequired
- usdnumberrequired

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

404Not found

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: NOT_FOUND
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

get/credits

Get the credit balance

The organization's balance, the current cycle's allowance and what each action consumed this cycle. Any valid API key.

Auth:ApiKeyorBearer

Responses

200Successful response

application/json

object

unitstringrequired
Always "credit": every amount here is presented in credits, whatever the ledger counts in.
One oftokencredit
balancenumberrequired
reservednumberrequired
Held by running work.
usednumberrequired
floornumberrequired
currentCycleobject | nullrequired
2 options
Any of
1.object
startstringrequired
endstring | nullrequired
allowancenumberrequired
consumednumberrequired
2.null
perActionobject[]required
3 fields per item
- actionstringrequired
- unitsnumberrequired
- creditsnumberrequired

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

get/usage

Get settled usage

Settled usage between `from` and `to` (ISO dates; default the last 30 days, at most a year), grouped by action, key, user or run. Any valid API key.

Auth:ApiKeyorBearer

Query parameters

groupBystring
One ofactionkeyuserrun
fromstring
tostring
limitstring

Responses

200Successful response

application/json

object

fromstringrequired
tostringrequired
groupBystringrequired
One ofactionkeyuserrun
unitstringrequired
Always "credit": every amount here is presented in credits, whatever the ledger counts in.
One oftokencredit
rowsobject[]required
4 fields per item
- keystring | nullrequired
- unitsnumberrequired
- creditsnumberrequired
- listCreditsnumberrequired

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

Classification

post/classifications/batch

Classify many products

Bulk HTS classification of `items` (inline) or `inputKey` (an uploaded JSONL file). Answers 202 with the batch id; the results are delivered to the key environment's webhook URL (or `Tarifflo-Webhook-Url`) and pollable at GET /classifications/batch/{batchId}. Requires the API key scope `classifications`.

Auth:ApiKeyorBearer

Headers

Idempotency-Keystring
Repeats of the same request with the same key answer the first result (72 hours) with `Idempotent-Replayed: true`.
max length 255

Request body · required

application/json

object

itemsobject[]
Up to 10000 rows inline; `id` is echoed back on each result.
max items 10000
2 fields per item
- idstring
- textstringrequired
  min length 1
inputKeystring
A JSONL file of {id?,text} rows, from POST /classifications/batch/upload-url.
dryRunboolean
Price the request at the organization's card and reserve nothing; answers 200 with the estimate.

Responses

202Queued (or, for `dryRun`, priced with 200)

application/json

object | object

Any of

1.object

jobIdstringrequired
The batch id: poll GET /classifications/batch/{batchId}.
creditsobjectrequired
What the job has reserved, used and refunded so far, in credits.
4 fields
- actionstring | nullrequired
- reservednumberrequired
- usednumberrequired
- refundednumberrequired
status"queued"required
itemsQueuednumberrequired
messagestringrequired

2.object

dryRuntruerequired
estimatedCreditsnumberrequired
linesobject[]required
3 fields per item
- actionstringrequired
  One of 16 values
  rate_lookupadcvd_screenpga_applicabilitycode_classifiedexport_controlorigin_determinationentry_filedentry_prepareddocument_ocrdocument_extractdocument_sortproduct_enrichentry_reviewrationale_documentaudit_parsedata_export
- unitsnumberrequired
- creditsnumberrequired
balancenumberrequired
unitstringrequired
One oftokencredit
notestring

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

402Not enough credits

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: PAYMENT_REQUIRED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

409The first request with this Idempotency-Key is still filing

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: CONFLICT
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

413The file or the row count is over the limit

application/json

error.PAYLOAD_TOO_LARGE

errorobjectrequired
7 fields
- codestringrequired
  example: PAYLOAD_TOO_LARGE
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

post/classifications/batch/upload-url

Get a batch upload URL

A presigned PUT URL (valid 900 seconds) for a JSONL file of {id?,text} rows. PUT the file, then start the batch with the returned `inputKey`. Requires the API key scope `classifications`.

Auth:ApiKeyorBearer

Request body · required

application/json

object

filenamestringrequired
min length 1max length 256

Responses

200Successful response

application/json

object

uploadUrlstringrequired
inputKeystringrequired
expiresInSecondsnumberrequired

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

get/classifications/batch/{batchId}

Get a classification batch

The batch's status and one page (1000 rows, `page` from 0) of its results once it completes. Requires the API key scope `classifications`.

Auth:ApiKeyorBearer

Path parameters

batchIdstringrequired

Query parameters

pagestring

Responses

200Successful response

application/json

object

batchIdstringrequired
creditsobjectrequired
What the job has reserved, used and refunded so far, in credits.
4 fields
- actionstring | nullrequired
- reservednumberrequired
- usednumberrequired
- refundednumberrequired
statusstringrequired
statestringrequired
SUBMITTED, RUNNING, COMPLETED or FAILED; results appear once COMPLETED.
expectedCountnumberrequired
shardsSettlednumberrequired
expectedShardsnumberrequired
pagenumberrequired
pageSizenumberrequired
resultsobject[]required
5 fields per item
- idstringrequired
- hts10string | nullrequired
- confidencenumber | nullrequired
- chosenModelstring | nullrequired
- top5__schema2required
  The top alternatives the classifier weighed.

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

404Not found

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: NOT_FOUND
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

Export control

post/export-control

Determine export-control codes

ECCN (or a foreign jurisdiction's control code) for up to 50 products. Answers 202 with the run id; the result is delivered as an `export_control.completed` webhook to the key environment's URL (or `Tarifflo-Webhook-Url`) and pollable at GET /export-control/{jobId}. Requires the API key scope `eccn`.

Auth:ApiKeyorBearer

Headers

Idempotency-Keystring
Repeats of the same request with the same key answer the first result (72 hours) with `Idempotent-Replayed: true`.
max length 255

Request body · required

application/json

object

productsobject[]required
min items 1max items 50
5 fields per item
- idstring
  Your correlation id, echoed back on the result line.
  max length 200
- namestring
  max length 500
- descriptionstringrequired
  min length 3max length 5000
- originstringrequired
  Country of origin, ISO-3166 alpha-2.
  pattern: ^[A-Z]{2}$
- contextstring
  Anything else the determination should weigh.
  max length 5000
dryRunboolean
Price the request at the organization's card and reserve nothing; answers 200 with the estimate.

Responses

202Queued (or, for `dryRun`, priced with 200)

application/json

object | object

Any of

1.object

jobIdstringrequired
The run id: poll GET /export-control/{jobId}.
creditsobjectrequired
What the job has reserved, used and refunded so far, in credits.
4 fields
- actionstring | nullrequired
- reservednumberrequired
- usednumberrequired
- refundednumberrequired
status"queued"required
productsQueuednumberrequired
messagestringrequired

2.object

dryRuntruerequired
estimatedCreditsnumberrequired
linesobject[]required
3 fields per item
- actionstringrequired
  One of 16 values
  rate_lookupadcvd_screenpga_applicabilitycode_classifiedexport_controlorigin_determinationentry_filedentry_prepareddocument_ocrdocument_extractdocument_sortproduct_enrichentry_reviewrationale_documentaudit_parsedata_export
- unitsnumberrequired
- creditsnumberrequired
balancenumberrequired
unitstringrequired
One oftokencredit
notestring

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

402Not enough credits

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: PAYMENT_REQUIRED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

409The first request with this Idempotency-Key is still filing

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: CONFLICT
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

get/export-control/{jobId}

Get an export-control run

The run's status; once complete, `data` is the `export_control.completed` webhook's `data`. Requires the API key scope `eccn`.

Auth:ApiKeyorBearer

Path parameters

jobIdstringrequired

Responses

200Successful response

application/json

object | object | object

Any of

1.object

jobIdstringrequired
creditsobjectrequired
What the job has reserved, used and refunded so far, in credits.
4 fields
- actionstring | nullrequired
- reservednumberrequired
- usednumberrequired
- refundednumberrequired
status"failed"required
errorobjectrequired
2 fields
- code"RUN_FAILED"required
- messagestringrequired

2.object

jobIdstringrequired
creditsobjectrequired
What the job has reserved, used and refunded so far, in credits.
4 fields
- actionstring | nullrequired
- reservednumberrequired
- usednumberrequired
- refundednumberrequired
statusstringrequired
One ofqueuedprocessingblocked
stagesCompletenumberrequired
stagesTotalnumberrequired
creditsNeedednumber
Credits the run waits for (`blocked` only).
purchaseUrlstring
Where to add credits (`blocked` only).

3.object

jobIdstringrequired
creditsobjectrequired
What the job has reserved, used and refunded so far, in credits.
4 fields
- actionstring | nullrequired
- reservednumberrequired
- usednumberrequired
- refundednumberrequired
status"complete"required
eventstringrequired
The webhook event that delivered the same `data`.
data__schema2required
The run's result, exactly the webhook's `data`.

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

404Not found

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: NOT_FOUND
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

Origin

post/origin

Determine country of origin

Rules-of-origin determinations (non-preferential, marking, FTA-preferential) for up to 5 goods from their bill of materials. Answers 202 with the run id; a run takes minutes. The result is delivered as an `origin.completed` webhook to the key environment's URL (or `Tarifflo-Webhook-Url`) and pollable at GET /origin/{jobId}. Requires the API key scope `origin`.

Auth:ApiKeyorBearer

Headers

Idempotency-Keystring
Repeats of the same request with the same key answer the first result (72 hours) with `Idempotent-Replayed: true`.
max length 255

Request body · required

application/json

object

jobsobject[]required
min items 1max items 5
10 fields per item
- idstring
  Your correlation id, echoed back on the result line.
  max length 200
- import_intostring
  The importing country (default US).
  pattern: ^[A-Za-z]{2}$
- finished_goodobjectrequired
  4 fields
  descriptionstringrequired
  min length 3max length 5000
  htsstring
  max length 20
  value_usdnumber
  ex_works_price_usdnumber
- country_of_finished_productionstringrequired
  pattern: ^[A-Za-z]{2}$
- claimed_country_of_originstring
  pattern: ^[A-Za-z]{2}$
- processingstring
  What is done in the country of finished production.
  max length 10000
- bomobject[]required
  min items 1max items 200
  4 fields per item
  itemstringrequired
  max length 500
  htsstring
  max length 20
  originstringrequired
  pattern: ^[A-Za-z]{2}$
  value_usdnumber
- automotivemap<string, __schema1>
- fungible_inventorymap<string, __schema1>
- qualitystring
  "ship" (default, the full ensemble) or "screen" (one draft, about half the cost).
  One ofshipscreen
dryRunboolean
Price the request at the organization's card and reserve nothing; answers 200 with the estimate.

Responses

202Queued (or, for `dryRun`, priced with 200)

application/json

object | object

Any of

1.object

jobIdstringrequired
The run id: poll GET /origin/{jobId}.
creditsobjectrequired
What the job has reserved, used and refunded so far, in credits.
4 fields
- actionstring | nullrequired
- reservednumberrequired
- usednumberrequired
- refundednumberrequired
status"queued"required
jobsQueuednumberrequired
messagestringrequired

2.object

dryRuntruerequired
estimatedCreditsnumberrequired
linesobject[]required
3 fields per item
- actionstringrequired
  One of 16 values
  rate_lookupadcvd_screenpga_applicabilitycode_classifiedexport_controlorigin_determinationentry_filedentry_prepareddocument_ocrdocument_extractdocument_sortproduct_enrichentry_reviewrationale_documentaudit_parsedata_export
- unitsnumberrequired
- creditsnumberrequired
balancenumberrequired
unitstringrequired
One oftokencredit
notestring

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

402Not enough credits

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: PAYMENT_REQUIRED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

409The first request with this Idempotency-Key is still filing

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: CONFLICT
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

get/origin/{jobId}

Get an origin run

The run's status; once complete, `data` is the `origin.completed` webhook's `data`. Requires the API key scope `origin`.

Auth:ApiKeyorBearer

Path parameters

jobIdstringrequired

Responses

200Successful response

application/json

object | object | object

Any of

1.object

jobIdstringrequired
creditsobjectrequired
What the job has reserved, used and refunded so far, in credits.
4 fields
- actionstring | nullrequired
- reservednumberrequired
- usednumberrequired
- refundednumberrequired
status"failed"required
errorobjectrequired
2 fields
- code"RUN_FAILED"required
- messagestringrequired

2.object

jobIdstringrequired
creditsobjectrequired
What the job has reserved, used and refunded so far, in credits.
4 fields
- actionstring | nullrequired
- reservednumberrequired
- usednumberrequired
- refundednumberrequired
statusstringrequired
One ofqueuedprocessingblocked
stagesCompletenumberrequired
stagesTotalnumberrequired
creditsNeedednumber
Credits the run waits for (`blocked` only).
purchaseUrlstring
Where to add credits (`blocked` only).

3.object

jobIdstringrequired
creditsobjectrequired
What the job has reserved, used and refunded so far, in credits.
4 fields
- actionstring | nullrequired
- reservednumberrequired
- usednumberrequired
- refundednumberrequired
status"complete"required
eventstringrequired
The webhook event that delivered the same `data`.
data__schema2required
The run's result, exactly the webhook's `data`.

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

404Not found

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: NOT_FOUND
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

CBP queries

post/cbp-queries/adcvd-rates

Query CBP AD/CVD cases

Requires the API key scope `filing`.

Auth:ApiKeyorBearer

Request body · required

application/json

object

midstring
htsCodestring
caseNumberstring
countryCodestring
companyCaseStatusstring
customDatestring
certificationScenariostring

Responses

200Successful response

application/json

object

shortJobIdstringrequired

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

post/cbp-queries/manufacturer

Query CBP for a manufacturer (MID)

Requires the API key scope `filing`.

Auth:ApiKeyorBearer

Request body · required

application/json

object

manufacturerIdstring
documentIdstring
dedupeKeystring

Responses

200Successful response

application/json

object

shortJobIdstringrequired

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

post/cbp-queries/census-warnings

Query CBP census warnings for entries

Requires the API key scope `filing`.

Auth:ApiKeyorBearer

Request body · required

application/json

object

blockHeaderParamsobjectrequired
3 fields
- processingPortCodestring
- processingFilerCodestring
- appIdCodestringrequired
  One of 35 values
  AEEQSECQREDENEHAHBADAHCWCJCBECFTFZGEKITPSFWPQP$IMACAAAMOQAPESUTERMFQFI
requestedFromDatestring
requestedToDatestring
entryNumbersstring[]required

Responses

200Successful response

application/json

object

shortJobIdstringrequired

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

post/cbp-queries/currency-conversion

Query CBP currency conversion

Requires the API key scope `filing`.

Auth:ApiKeyorBearer

Request body · required

application/json

object

blockHeaderParamsobjectrequired
1 field
- appIdCodestringrequired
  One of 35 values
  AEEQSECQREDENEHAHBADAHCWCJCBECFTFZGEKITPSFWPQP$IMACAAAMOQAPESUTERMFQFI
countryCodestringrequired
min length 2max length 2
currencyCodestringrequired
min length 3max length 3
exchangeRateDatestringrequired
foreignAmountnumberrequired
> 0

Responses

200Successful response

application/json

object

shortJobIdstringrequired

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

post/cbp-queries/quota-rates

Query CBP quota status

Requires the API key scope `filing`.

Auth:ApiKeyorBearer

Request body · required

application/json

object

queriesobject[]required
min items 1max items 99
3 fields per item
- queryIdstringrequired
  min length 1
- secondTariffNumberstring
- countryCodestringrequired
  min length 1
certificationScenariostring

Responses

200Successful response

application/json

object

shortJobIdstringrequired

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

post/cbp-queries/entry-summary

Query CBP entry summaries

Requires the API key scope `filing`.

Auth:ApiKeyorBearer

Request body · required

application/json

object

queryTypestringrequired
One ofJ1J2
includeDetailboolean
entriesobject[]
2 fields per item
- filerCodestringrequired
  min length 3max length 3
- entryNumberstringrequired
  min length 1max length 8
criteriaQueryTypeCodestring
One ofAIIDOCRCNPSCLIQNLQEES
requestedFromDateTimestring
pattern: ^\d{2}\d{2}\d{2}\d{2}\d{2}\d{2}(AM|PM)$
requestedToDateTimestring
pattern: ^\d{2}\d{2}\d{2}\d{2}\d{2}\d{2}(AM|PM)$
entrySummariesFlag"Y"
ftaReconSummariesFlag"Y"
otherReconSummariesFlag"Y"
drawbackSummariesFlag"Y"
dutyDeferralSummariesFlag"Y"
collectionBillInfoCodestring
One of123456
certificationScenariostring

Responses

200Successful response

application/json

object

shortJobIdstringrequired

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

post/cbp-queries/importer-bond

Query CBP importer and bond records

Requires the API key scope `filing`.

Auth:ApiKeyorBearer

Request body · required

application/json

object

importerOfRecordstringrequired
min length 1
importerProfileIdstring

Responses

200Successful response

application/json

object

shortJobIdstringrequired

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

post/cbp-queries/mid

Ask CBP to generate a manufacturer ID

Requires the API key scope `filing`.

Auth:ApiKeyorBearer

Request body · required

application/json

object

legalNamestringrequired
addressstringrequired
cityNamestringrequired
countryCodestringrequired
postalCodestringrequired
documentIdstring

Responses

200Successful response

application/json

object

shortJobIdstringrequired

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

Parties

get/importer-profiles

List the organization's importer profiles

Requires the API key scope `filing`.

Auth:ApiKeyorBearer

Responses

200Successful response

application/json

object[]

idstringrequired
importerNamestring
importerOfRecordstring
statusstringrequired
One ofDRAFTAWAITING CBPAPPROVEDDENIEDCBP INACTIVECBP VOIDED

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

404Not found

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: NOT_FOUND
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

get/filers/{id}

Get one of the organization's filers

Requires the API key scope `filing`.

Auth:ApiKeyorBearer

Path parameters

idstringrequired

Responses

200Successful response

application/json

object

namestring
filerCodestring
portCodestring
startingEntryNumbernumber
checkDigitOffsetnumber
nationalPermitboolean
isBrokerboolean
brokerLicenseNumberstring
qualifyingBrokerNamestring
disPocNamestring
disPocEmailstring
disPocPhonestring
idstring

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

404Not found

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: NOT_FOUND
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

get/filers

List the organization's filers

Requires the API key scope `filing`.

Auth:ApiKeyorBearer

Responses

200Successful response

application/json

object[]

idstringrequired
namestring
filerCodestring
portCodestring
isBrokerboolean
statusstringrequired
One ofINCOMPLETECOMPLETED

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

404Not found

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: NOT_FOUND
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

get/trade-parties/manufacturers

List the organization's manufacturers

Requires the API key scope `filing`.

Auth:ApiKeyorBearer

Responses

200Successful response

application/json

object[]

idstringrequired
legalNamestring
countryCodestringrequired

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

404Not found

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: NOT_FOUND
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: INTERNAL_SERVER_ERROR
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

post/trade-parties/search

Page through the organization's trade parties

Requires the API key scope `filing`.

Auth:ApiKeyorBearer

Request body · required

application/json

object

startRownumberrequired
endRownumberrequired
searchTextstring

Responses

200Successful response

application/json

object

rowDataobject[]required
6 fields per item
- idstringrequired
- legalNamestringrequired
- phonestringrequired
- addressstringrequired
- errorstring
- individualContactsobject[]
  4 fields per item
  namestring
  phonestring
  emailstring
  rolestring
rowCountnumberrequired

400Invalid input data

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: BAD_REQUEST
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

401Authorization not provided

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: UNAUTHORIZED
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

403Insufficient access

application/json

errorobjectrequired
7 fields
- codestringrequired
  example: FORBIDDEN
- messagestringrequired
- issuesobject[]
  Input validation issues (400 only)
  3 fields per item
  codestring
  messagestringrequired
  pathany[]
- errorsobject[]
  Entry validation errors, by path in the request's `entry`
  2 fields per item
  pathstringrequired
  example: lineItems[3].tariffRows[0].htsNumber
  messagestringrequired
- efidstring
  The entry the request wrote before it failed
- fieldstring
  The field CBP now requires or rejects (`cbp_requirement` only)
- effectiveDatestring
  When that CBP rule takes effect (`cbp_requirement` only)

500Internal server error

application/json