Customs ISF

Endpoints relating to Customs ISF objects

Create or update an ISF.

Create an ISF to be attached to a shipment, or update an existing ISF

Request
Request Body schema: application/json
required
_object
string

Type of the object

object

The actual Inbound ISF data

required
object (IsfHeader)

Context related to an Importer Security Filing

object (IsfShipmentInformation)

Shipment information

required
Array of objects (IsfShipmentBillNumbers)

List of bill numbers associated with the shipment

required
Array of objects (IsfReferenceIdentifier)

List of additional identifiers associated with this ISF

required
Array of objects (IsfEntity)

List of entities associated with this ISF

Array of objects (IsfHarmonizedTariffSchedule)

Note that this also exists on the Entity message

object (IsfFrobShipmentInformation)

FROB Shipment Information

Responses
200

Success

Response Schema: application/json
_object
string
self
string
version
integer
data
object
400

Bad Request

404

Not Found

409

Already Exists Error

500

Internal Server Error

501

Not Implemented Error

post/customs_document/isf
Request samples
application/json
{
  • "_object": "/customs_document/isf",
  • "data": {
    • "header": {
      • "isf_submission_type": "SUBMISSION_TYPE_ISF_10",
      • "shipment_type": "SHIPMENT_TYPE_STANDARD_OR_REGULAR_FILINGS",
      • "action_code": "ACTION_ADD",
      • "employer_identification_number": "12-340000654",
      • "mode_of_transport": "MODE_OF_TRANSPORT_VESSEL_NON_CONTAINER",
      • "scac": "ABCD",
      • "bond_holder": "12-340000654",
      • "bond_activity_code": "BOND_ACTIVITY_IMPORTER_OR_BROKER",
      • "bond_type": "BOND_TYPE_CONTINUOUS"
      },
    • "shipment_bill_numbers": [
      • {
        }
      ],
    • "reference_identifiers": [
      • {
        }
      ],
    • "entities": [
      • {
        }
      ]
    }
}
Response samples
application/json

Success

{}
➔ Next to Invoices