{"info":{"_postman_id":"ff3b65ad-034d-4f2c-94b9-aa17a115ea3f","name":"SafePackage","description":"

SafePackage API

\n

V 1.26.5

\n

General API Information

\n\n

Environments

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
EnvironmentBase URL
Productionhttps://api.safepackage.com
Developmenthttps://sandbox.safepackage.com
\n

Required Headers

\n\n

Support

\n

For questions or access requests, contact the SafePackage team.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"SafePackage API","slug":"safepackage-api"}],"owner":"1980603","collectionId":"ff3b65ad-034d-4f2c-94b9-aa17a115ea3f","publishedId":"2sBXiokUpG","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-04-01T20:08:38.000Z"},"item":[{"name":"Product Screening","item":[{"name":"Screen Product","id":"f49e29d9-aeed-4103-814a-6e9bd66ac7a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Accept-Encoding","value":"gzip, deflate"},{"key":"Authorization","value":"ApiKey YOUR_ACCESS_KEY"}],"body":{"mode":"raw","raw":"{\n \"sku\": \"SKU-12345\",\n \"platformId\": \"AMAZON\",\n \"sellerId\": \"seller-store-001\",\n \"url\": \"https://www.example.com/product/12345\",\n \"name\": \"Wireless Bluetooth Headphones\",\n \"description\": \"Premium wireless headphones with active noise cancellation, 30-hour battery life, and foldable design. Includes carrying case and USB-C charging cable.\",\n \"declaredName\": \"Wireless Audio Headset\",\n \"price\": 49.99,\n \"images\": [\n \"\",\n \"\"\n ],\n \"categories\": [\"Electronics\", \"Audio\", \"Headphones\"],\n \"pieces\": 1,\n \"ean\": \"0123456789012\",\n \"hts\": \"8518300000\",\n \"normalize\": false,\n \"originCountry\": \"CHN\",\n \"destinationCountry\": \"USA\",\n \"instructions\": [\n {\n \"type\": \"INSTRUCTION_TYPE\",\n \"value\": \"instruction_value\"\n }\n ],\n \"attributes\": [\n {\n \"type\": \"ManufacturerId\",\n \"value\": \"MID123456789\"\n },\n {\n \"type\": \"ManufacturerName\",\n \"value\": \"Acme Electronics Co. Ltd.\"\n },\n {\n \"type\": \"ManufacturerAddress\",\n \"value\": \"123 Factory Road, Shenzhen, Guangdong, China\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.safepackage.com/v1/product/screen","description":"

Screen Product

\n

Determines the customs compliance status of a product and whether it can be imported into the U.S.

\n

Required Fields

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeMax LengthDescription
skustring50Unique product listing identifier on the platform
platformIdstring20Marketplace platform identifier – use Platform endpoint to get valid values
sellerIdstring–Seller or store identifier on the platform
urlstring1000Working public URL to the product page
namestring300Full advertised product name – must match the product page
descriptionstring–Full advertised product description – must match the product page
pricenumber–List price in USD as shown on the product page
images[]base64 string array–One or more product images (JPEG recommended, min 640×480px). Accepted formats: JPEG, WEBP, PNG8, PNG24, GIF (non-animated)
originCountrystring–ISO-3 country code (uppercase). Use CHN for China
destinationCountrystring–ISO-3 country code (uppercase). Use USA for United States
\n

Conditional Fields

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeMax LengthDescription
declaredNamestring300Customs declaration name if different from name
\n

Optional Fields

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeMax LengthDescription
categories[]string array–Store categories or keywords associated with the product
piecesnumber–Total number of product pieces if applicable
eanstring2013-digit EAN or 12-digit UPC
htsstring10US HTS number, at least 6 digits
normalizeboolean–Whether the product data needs to be normalized
instructions[]object array–Special screening instructions (type required, value conditional)
attributes[]object array–Additional product attributes. Allowed type values: ManufacturerId, ManufacturerName, ManufacturerAddress
\n

Response Fields

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypePresenceDescription
referencestringRequiredUnique SafePackage product reference
codenumberRequiredResult code: 1 Accepted, 2 Rejected, 3 Inconclusive
statusstringRequiredAccepted, Rejected, or Inconclusive
reason.codestringConditionalThree-letter rejection reason code (e.g. RIT, RIP)
reason.descriptionstringConditionalShort rejection reason phrase
\n

Rejection Reason Codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
CodeDescription
RMGTransportation security violation
RBTTransportation security violation
RDGTransportation security violation
RHPDe-minimis value violation
RIPIntellectual property infringement
RICCopyright infringement
RITTrademark infringement
RINPatent infringement
RCTCustoms regulations violation
RPAUSDA violation
RPWFWS violation
RPTDOT violation
RPDFDA violation
RPSCPSC violation
RPFFCEN violation
RPEATF violation
RPLForced labor violation
RCRCustoms regulations violation
RBDBad or incomplete data
\n
","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ff3b65ad-034d-4f2c-94b9-aa17a115ea3f","id":"ff3b65ad-034d-4f2c-94b9-aa17a115ea3f","name":"SafePackage","type":"collection"}},"urlObject":{"path":["v1","product","screen"],"host":["https://api.safepackage.com"],"query":[],"variable":[]}},"response":[{"id":"c2a87ec0-e7fa-47f7-a2f6-b5f74bfa7ed5","name":"Accepted","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Accept-Encoding","value":"gzip, deflate"},{"key":"Authorization","value":"ApiKey YOUR_ACCESS_KEY"}],"body":{"mode":"raw","raw":"{\n \"sku\": \"SKU-12345\",\n \"platformId\": \"AMAZON\",\n \"sellerId\": \"seller-store-001\",\n \"url\": \"https://www.example.com/product/12345\",\n \"name\": \"Wireless Bluetooth Headphones\",\n \"description\": \"Premium wireless headphones with active noise cancellation, 30-hour battery life, and foldable design.\",\n \"price\": 49.99,\n \"images\": [\"\"],\n \"originCountry\": \"CHN\",\n \"destinationCountry\": \"USA\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.safepackage.com/v1/product/screen"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"reference\": \"SP-REF-00123456\",\n \"code\": 1,\n \"status\": \"Accepted\"\n}"},{"id":"903754b0-4a5f-427c-8701-2dd2d6170fe1","name":"Rejected","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Accept-Encoding","value":"gzip, deflate"},{"key":"Authorization","value":"ApiKey YOUR_ACCESS_KEY"}],"body":{"mode":"raw","raw":"{\n \"sku\": \"SKU-12345\",\n \"platformId\": \"AMAZON\",\n \"sellerId\": \"seller-store-001\",\n \"url\": \"https://www.example.com/product/12345\",\n \"name\": \"Wireless Bluetooth Headphones\",\n \"description\": \"Premium wireless headphones with active noise cancellation, 30-hour battery life, and foldable design.\",\n \"price\": 49.99,\n \"images\": [\"\"],\n \"originCountry\": \"CHN\",\n \"destinationCountry\": \"USA\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.safepackage.com/v1/product/screen"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"reference\": \"SP-REF-00123457\",\n \"code\": 2,\n \"status\": \"Rejected\",\n \"reason\": {\n \"code\": \"RIT\",\n \"description\": \"Trademark Infringement\"\n }\n}"},{"id":"b105d16c-99b8-4029-aa41-d75216e0bf49","name":"Inconclusive","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Accept-Encoding","value":"gzip, deflate"},{"key":"Authorization","value":"ApiKey YOUR_ACCESS_KEY"}],"body":{"mode":"raw","raw":"{\n \"sku\": \"SKU-12345\",\n \"platformId\": \"AMAZON\",\n \"sellerId\": \"seller-store-001\",\n \"url\": \"https://www.example.com/product/12345\",\n \"name\": \"Wireless Bluetooth Headphones\",\n \"description\": \"Premium wireless headphones with active noise cancellation, 30-hour battery life, and foldable design.\",\n \"price\": 49.99,\n \"images\": [\"\"],\n \"originCountry\": \"CHN\",\n \"destinationCountry\": \"USA\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.safepackage.com/v1/product/screen"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"reference\": \"SP-REF-00123458\",\n \"code\": 3,\n \"status\": \"Inconclusive\",\n \"reason\": {\n \"code\": \"RBD\",\n \"description\": \"Bad or incomplete data\"\n }\n}"}],"_postman_id":"f49e29d9-aeed-4103-814a-6e9bd66ac7a7"}],"id":"1b90a811-484b-41c3-b69f-2a1c8b11911f","description":"

Determine the customs compliance status of a product and whether it can be imported into the U.S.

\n

Endpoint: POST /v1/product/screen

\n

Result Codes:

\n
    \n
  • 1 – Accepted: product is compliant and can be shipped
    • \n
  • 2 – Rejected: product is most likely a violation, do not ship
    • \n
  • 3 – Inconclusive: potentially violative, do not ship until proven otherwise
    • \n
\n","_postman_id":"1b90a811-484b-41c3-b69f-2a1c8b11911f","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ff3b65ad-034d-4f2c-94b9-aa17a115ea3f","id":"ff3b65ad-034d-4f2c-94b9-aa17a115ea3f","name":"SafePackage","type":"collection"}}},{"name":"Package Screening","item":[{"name":"Screen Package","id":"e236f4e3-8769-4828-bb68-d7b186d8209a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Accept-Encoding","value":"gzip, deflate"},{"key":"Authorization","value":"ApiKey YOUR_ACCESS_KEY"}],"body":{"mode":"raw","raw":"{\n \"externalId\": \"PKG-EXT-001\",\n \"platformId\": \"AMAZON\",\n \"sellerId\": \"seller-store-001\",\n \"exportCountry\": \"CHN\",\n \"destinationCountry\": \"USA\",\n \"houseBillNumber\": \"HB000000001\",\n \"barcode\": \"9400111899223397667318\",\n \"invoiceNumber\": \"INV-2024-001\",\n \"containerId\": \"CONT-BARCODE-001\",\n \"group\": {\n \"id\": \"GROUP-001\",\n \"ordinal\": 1\n },\n \"carrierId\": \"usps\",\n \"weight\": {\n \"value\": 1.2,\n \"unit\": \"K\"\n },\n \"declaredValue\": 49.99,\n \"charges\": 0.00,\n \"from\": {\n \"name\": \"Shenzhen Supplier Co.\",\n \"line1\": \"123 Factory Road\",\n \"line2\": \"Building A\",\n \"city\": \"Shenzhen\",\n \"state\": \"Guangdong\",\n \"postalCode\": \"518000\",\n \"country\": \"CHN\",\n \"phone\": \"+86-755-1234-5678\",\n \"email\": \"export@supplier.com\"\n },\n \"to\": {\n \"name\": \"John Smith\",\n \"line1\": \"456 Main Street\",\n \"line2\": \"Apt 7B\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"postalCode\": \"10001\",\n \"country\": \"USA\",\n \"phone\": \"+1-212-555-0100\",\n \"email\": \"jsmith@email.com\"\n },\n \"products\": [\n {\n \"quantity\": 1,\n \"items\": [\n {\n \"declaredValue\": 49.99,\n \"declaredName\": \"Wireless Audio Headset\",\n \"originCountry\": \"CHN\",\n \"mid\": \"MID123456789\",\n \"weight\": {\n \"value\": 1.2,\n \"unit\": \"K\"\n },\n \"tariffStack\": [\n {\n \"hts\": \"8518300000\",\n \"value\": 49.99,\n \"indicators\": [\n {\n \"type\": \"SPI\",\n \"value\": \"CL\"\n }\n ],\n \"quantities\": [\n {\n \"unit\": \"NO\",\n \"quantity\": 1\n }\n ]\n }\n ],\n \"pga\": [\n {\n \"agency\": \"FDA\",\n \"program\": {\n \"code\": \"DRU\"\n }\n }\n ],\n \"declarations\": {\n \"aluminum\": {\n \"primarySmeltCountry\": \"CHN\",\n \"secondarySmeltCountry\": \"CHN\",\n \"castCountry\": \"CHN\"\n },\n \"steel\": {\n \"meltCountry\": \"CHN\",\n \"applicabilityCode\": \"N\"\n }\n }\n }\n ],\n \"product\": {\n \"sku\": \"SKU-12345\",\n \"url\": \"https://www.example.com/product/12345\",\n \"name\": \"Wireless Bluetooth Headphones\",\n \"description\": \"Premium wireless headphones with active noise cancellation, 30-hour battery life, and foldable design.\",\n \"price\": 49.99,\n \"images\": [\n \"\"\n ],\n \"originCountry\": \"CHN\",\n \"categories\": [\"Electronics\", \"Audio\"],\n \"pieces\": 1,\n \"ean\": \"0123456789012\",\n \"hts\": \"8518300000\",\n \"normalize\": false,\n \"instructions\": [\n {\n \"type\": \"INSTRUCTION_TYPE\",\n \"value\": \"instruction_value\"\n }\n ],\n \"attributes\": [\n {\n \"type\": \"ManufacturerId\",\n \"value\": \"MID123456789\"\n },\n {\n \"type\": \"ManufacturerName\",\n \"value\": \"Acme Electronics Co. Ltd.\"\n },\n {\n \"type\": \"ManufacturerAddress\",\n \"value\": \"123 Factory Road, Shenzhen, Guangdong, China\"\n }\n ]\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.safepackage.com/v1/package/screen","description":"

Screen Package

\n

Initiates the package compliance verification process. Screens each product within the package.

\n

Required Fields

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeMax LengthDescription
externalIdstring–Package identifier in the client's system
platformIdstring20Marketplace platform identifier
sellerIdstring50Seller or store identifier
exportCountrystring–ISO-3 export country code. Use CHN for China
destinationCountrystring–ISO-3 destination country code. Use USA for United States
houseBillNumberstring12House bill number – must be unique within a single shipment
barcodestring–Package tracking barcode on the shipping label
weight.valuenumber–Package gross weight value
weight.unitstring–K for kilograms, L for pounds
fromobject–Shipper address (name, line1, city, state, postalCode, country required)
toobject–Consignee address (name, line1, city, state, postalCode, country required)
products[]object array–At least one product quantifier object
\n

Conditional Fields

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
invoiceNumberstring (30)Invoice number for entry filing
containerIdstringContainer barcode if package is in a separate container
chargesnumberTotal non-dutiable charges
\n

Optional Fields

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
group.idstring (50)Filing group identifier for consolidation
group.ordinalnumberPackage sort order within the group
carrierIdstringLast-mile carrier: usps, ups, fedex, dhl
declaredValuenumberPackage total declared value in USD
\n

products[].items[] Required Fields

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
declaredValuenumberItem declared value in USD
declaredNamestring (300)Item name for customs declaration
originCountrystringISO-3 country code of item origin
midstringManufacturer identifier (MID)
weight.valuenumberItem weight value
weight.unitstringK kilograms, L pounds
tariffStack[]object arrayTariff declaration entries
\n

tariffStack[] Required Fields

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
htsstring10-digit US HTS number
valuenumberDeclared tariff value
quantities[]object arrayCensus quantity reporting (unit and quantity)
\n

tariffStack[] Conditional Fields

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
indicators[]object arraySpecial program indicators (type e.g. SPI, value e.g. CL)
\n

Line Item Conditional Fields

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
pga[]object arrayPGA filing data sets. Each entry requires agency (e.g. FDA) and program.code (e.g. DRU)
declarations.aluminumobjectAluminum reporting: primarySmeltCountry, secondarySmeltCountry, castCountry
declarations.steelobjectSteel reporting: meltCountry, applicabilityCode
\n

Response Fields

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypePresenceDescription
packageIdstringRequiredSafePackage package identifier
externalIdstringRequiredClient's external package identifier
codenumberRequired1 Accepted, 2 Rejected, 3 Inconclusive, 4 Audit
statusstringRequiredAccepted, Rejected, Inconclusive, or Audit
labelQrCodestringConditionalQR code data for the shipping label – only returned when code is 1. The trademark SafePackage ® must be printed near the QR code
products[]object arrayRequiredPer-product screening results
products[].referencestringRequiredSafePackage product reference
products[].skustringRequiredProduct SKU
products[].platformIdstringRequiredPlatform identifier
products[].codenumberRequiredProduct result code: 1, 2, or 3
products[].statusstringRequiredProduct result status
products[].reasonobjectConditionalRejection reason with code and description
\n
","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ff3b65ad-034d-4f2c-94b9-aa17a115ea3f","id":"ff3b65ad-034d-4f2c-94b9-aa17a115ea3f","name":"SafePackage","type":"collection"}},"urlObject":{"path":["v1","package","screen"],"host":["https://api.safepackage.com"],"query":[],"variable":[]}},"response":[{"id":"b70fcbe5-9880-4043-9aa3-b28b90e5be38","name":"Accepted","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Accept-Encoding","value":"gzip, deflate"},{"key":"Authorization","value":"ApiKey YOUR_ACCESS_KEY"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"https://api.safepackage.com/v1/package/screen"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"packageId\": \"SP-PKG-00001234\",\n \"externalId\": \"PKG-EXT-001\",\n \"code\": 1,\n \"status\": \"Accepted\",\n \"labelQrCode\": \"SPQR:SP-PKG-00001234:ABCDEF1234567890\",\n \"products\": [\n {\n \"reference\": \"SP-REF-00123456\",\n \"sku\": \"SKU-12345\",\n \"platformId\": \"AMAZON\",\n \"code\": 1,\n \"status\": \"Accepted\"\n }\n ]\n}"},{"id":"d6054931-37d5-4c1e-9ad5-7f0db475d937","name":"Rejected","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Accept-Encoding","value":"gzip, deflate"},{"key":"Authorization","value":"ApiKey YOUR_ACCESS_KEY"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"https://api.safepackage.com/v1/package/screen"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"packageId\": \"SP-PKG-00001235\",\n \"externalId\": \"PKG-EXT-002\",\n \"code\": 2,\n \"status\": \"Rejected\",\n \"products\": [\n {\n \"reference\": \"SP-REF-00123457\",\n \"sku\": \"SKU-99999\",\n \"platformId\": \"AMAZON\",\n \"code\": 2,\n \"status\": \"Rejected\",\n \"reason\": {\n \"code\": \"RIP\",\n \"description\": \"Intellectual property infringement\"\n }\n }\n ]\n}"},{"id":"4723d99c-fe28-4985-ace8-9e11b10c0647","name":"Inconclusive","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Accept-Encoding","value":"gzip, deflate"},{"key":"Authorization","value":"ApiKey YOUR_ACCESS_KEY"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"https://api.safepackage.com/v1/package/screen"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"packageId\": \"SP-PKG-00001236\",\n \"externalId\": \"PKG-EXT-003\",\n \"code\": 3,\n \"status\": \"Inconclusive\",\n \"products\": [\n {\n \"reference\": \"SP-REF-00123459\",\n \"sku\": \"SKU-11111\",\n \"platformId\": \"AMAZON\",\n \"code\": 3,\n \"status\": \"Inconclusive\",\n \"reason\": {\n \"code\": \"RBD\",\n \"description\": \"Bad or incomplete data\"\n }\n }\n ]\n}"},{"id":"56e988a8-1c3e-4069-8a06-e5e13485ba93","name":"Audit Required","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Accept-Encoding","value":"gzip, deflate"},{"key":"Authorization","value":"ApiKey YOUR_ACCESS_KEY"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"https://api.safepackage.com/v1/package/screen"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"packageId\": \"SP-PKG-00001237\",\n \"externalId\": \"PKG-EXT-004\",\n \"code\": 4,\n \"status\": \"Audit\",\n \"products\": [\n {\n \"reference\": \"SP-REF-00123460\",\n \"sku\": \"SKU-55555\",\n \"platformId\": \"AMAZON\",\n \"code\": 1,\n \"status\": \"Accepted\"\n }\n ]\n}"}],"_postman_id":"e236f4e3-8769-4828-bb68-d7b186d8209a"}],"id":"5c006e48-110a-4e25-9062-e5cbff286a13","description":"

Initiate the package compliance verification process. Screens each product within the package and returns a customs compliance status.

\n

Endpoint: POST /v1/package/screen

\n

Result Codes:

\n
    \n
  • 1 – Accepted
    • \n
  • 2 – Rejected
    • \n
  • 3 – Inconclusive
    • \n
  • 4 – Audit: package requires content audit – call the Content Audit endpoint to continue
    • \n
\n","_postman_id":"5c006e48-110a-4e25-9062-e5cbff286a13","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ff3b65ad-034d-4f2c-94b9-aa17a115ea3f","id":"ff3b65ad-034d-4f2c-94b9-aa17a115ea3f","name":"SafePackage","type":"collection"}}},{"name":"Package Data Submission","item":[{"name":"Submit Package (TDP)","id":"82c842a5-9f28-46ca-b9ec-e1af704c3025","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Accept-Encoding","value":"gzip, deflate"},{"key":"Authorization","value":"ApiKey YOUR_ACCESS_KEY"}],"body":{"mode":"raw","raw":"{\n \"externalId\": \"PKG-EXT-TDP-001\",\n \"platformId\": \"AMAZON\",\n \"sellerId\": \"seller-store-001\",\n \"exportCountry\": \"CHN\",\n \"destinationCountry\": \"USA\",\n \"houseBillNumber\": \"HB000000002\",\n \"barcode\": \"9400111899223397667319\",\n \"invoiceNumber\": \"INV-2024-002\",\n \"containerId\": \"CONT-BARCODE-001\",\n \"group\": {\n \"id\": \"GROUP-001\",\n \"ordinal\": 1\n },\n \"carrierId\": \"usps\",\n \"weight\": {\n \"value\": 0.8,\n \"unit\": \"K\"\n },\n \"declaredValue\": 35.00,\n \"charges\": 0.00,\n \"from\": {\n \"name\": \"Shenzhen Supplier Co.\",\n \"line1\": \"123 Factory Road\",\n \"line2\": \"Building A\",\n \"city\": \"Shenzhen\",\n \"state\": \"Guangdong\",\n \"postalCode\": \"518000\",\n \"country\": \"CHN\",\n \"phone\": \"+86-755-1234-5678\",\n \"email\": \"export@supplier.com\"\n },\n \"to\": {\n \"name\": \"Jane Doe\",\n \"line1\": \"789 Oak Avenue\",\n \"line2\": \"Suite 100\",\n \"city\": \"Chicago\",\n \"state\": \"IL\",\n \"postalCode\": \"60601\",\n \"country\": \"USA\",\n \"phone\": \"+1-312-555-0200\",\n \"email\": \"jdoe@email.com\"\n },\n \"products\": [\n {\n \"quantity\": 2,\n \"declaredValue\": 35.00,\n \"declaredName\": \"Ceramic Coffee Mug\",\n \"originCountry\": \"CHN\",\n \"mid\": \"MID987654321\",\n \"url\": \"https://www.example.com/product/67890\",\n \"sku\": \"SKU-67890\",\n \"weight\": {\n \"value\": 0.4,\n \"unit\": \"K\"\n },\n \"tariffStack\": [\n {\n \"hts\": \"6912000000\",\n \"value\": 35.00,\n \"indicators\": [],\n \"quantities\": [\n {\n \"unit\": \"NO\",\n \"quantity\": 2\n }\n ]\n }\n ],\n \"pga\": [\n {\n \"agency\": \"FDA\",\n \"program\": {\n \"code\": \"DRU\"\n }\n }\n ],\n \"declarations\": {\n \"aluminum\": {\n \"primarySmeltCountry\": \"CHN\",\n \"secondarySmeltCountry\": \"CHN\",\n \"castCountry\": \"CHN\"\n },\n \"steel\": {\n \"meltCountry\": \"CHN\",\n \"applicabilityCode\": \"N\"\n }\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.safepackage.com/v1/package/submit","description":"

Submit Package (Traditional Brokerage Process)

\n

Submits package data for customs manifesting/filing.

\n

⚠️ Do NOT call this endpoint if the package was already screened via /v1/package/screen.

\n

Required Fields

\n

Same top-level fields as Package Screening: externalId, platformId, sellerId, exportCountry, destinationCountry, houseBillNumber, barcode, weight, from, to, products[].

\n

products[] Required Fields

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeMax LengthDescription
quantitynumber–Number of distinct SKUs on this line
declaredValuenumber–Line item total value for customs declaration (USD)
declaredNamestring300Item name for customs declaration
originCountrystring–ISO-3 origin country code
weight.valuenumber–Item gross weight value
weight.unitstring–K kilograms, L pounds
tariffStack[]object array–Tariff declaration entries (hts, value, quantities[] required)
\n

products[] Conditional Fields

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeMax LengthDescription
midstring20Manufacturer identifier – required if entry filing is intended
pga[]object array–PGA filing data sets (agency, program.code required per entry)
declarations.aluminumobject–primarySmeltCountry (conditional), secondarySmeltCountry, castCountry
declarations.steelobject–meltCountry (conditional), applicabilityCode (conditional)
\n

products[] Optional Fields

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeMax LengthDescription
urlstring1000Product listing URL – multiple lines may share the same URL
skustring50Product SKU – multiple lines may share the same SKU
\n

tariffStack[] Conditional Fields

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
indicators[]object arraySpecial program indicators (type, optional value)
\n

Response Fields

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypePresenceDescription
packageIdstringRequiredSafePackage package identifier
externalIdstringRequiredClient's external package identifier
\n
","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ff3b65ad-034d-4f2c-94b9-aa17a115ea3f","id":"ff3b65ad-034d-4f2c-94b9-aa17a115ea3f","name":"SafePackage","type":"collection"}},"urlObject":{"path":["v1","package","submit"],"host":["https://api.safepackage.com"],"query":[],"variable":[]}},"response":[{"id":"162380ea-3499-4faa-a3be-5fad490841ec","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Accept-Encoding","value":"gzip, deflate"},{"key":"Authorization","value":"ApiKey YOUR_ACCESS_KEY"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"https://api.safepackage.com/v1/package/submit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"packageId\": \"SP-PKG-00001238\",\n \"externalId\": \"PKG-EXT-TDP-001\"\n}"}],"_postman_id":"82c842a5-9f28-46ca-b9ec-e1af704c3025"}],"id":"9e03f777-74d6-4ea3-b6da-b6df03c1eb99","description":"

Submit package data to SafePackage for customs manifesting and/or filing as part of the Traditional Brokerage Process (TDP).

\n

Endpoint: POST /v1/package/submit

\n

⚠️ Do NOT call this endpoint if the package has already been screened via /v1/package/screen.

\n

Unlike package screening, products use a flat line-item structure with no nested product object. No compliance screening is performed — data is submitted directly for customs filing.

\n","_postman_id":"9e03f777-74d6-4ea3-b6da-b6df03c1eb99","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ff3b65ad-034d-4f2c-94b9-aa17a115ea3f","id":"ff3b65ad-034d-4f2c-94b9-aa17a115ea3f","name":"SafePackage","type":"collection"}}},{"name":"Duty Collection","item":[{"name":"Pay Duties","id":"dd213d5f-3edc-4070-b57f-c5f7de12b814","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Accept-Encoding","value":"gzip, deflate"},{"key":"Authorization","value":"ApiKey YOUR_ACCESS_KEY"}],"body":{"mode":"raw","raw":"{\n \"packageId\": \"SP-PKG-00001234\",\n \"barcode\": \"9400111899223397667318\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.safepackage.com/v1/duty/pay","description":"

Pay Duties

\n

Approves payment of all applicable duties and customs fees for a package and returns proof of payment.

\n

Required Fields

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
packageIdstringSafePackage package identifier returned by the screening or submission endpoint
barcodestringPackage tracking barcode printed on the shipping label
\n

Response Fields

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypePresenceDescription
packageIdstringRequiredSafePackage package identifier
externalIdstringRequiredClient's external package identifier
ddpnstringConditionalDestination Duty Paid Number – proof of payment for use with carriers
totalDutynumberConditionalTotal duty and customs fees collected (USD) – present only when duty was collected
\n
","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ff3b65ad-034d-4f2c-94b9-aa17a115ea3f","id":"ff3b65ad-034d-4f2c-94b9-aa17a115ea3f","name":"SafePackage","type":"collection"}},"urlObject":{"path":["v1","duty","pay"],"host":["https://api.safepackage.com"],"query":[],"variable":[]}},"response":[{"id":"5368933f-ab9b-456a-900c-5cdc4647c034","name":"Success – Duty Collected","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Accept-Encoding","value":"gzip, deflate"},{"key":"Authorization","value":"ApiKey YOUR_ACCESS_KEY"}],"body":{"mode":"raw","raw":"{\n \"packageId\": \"SP-PKG-00001234\",\n \"barcode\": \"9400111899223397667318\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.safepackage.com/v1/duty/pay"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"packageId\": \"SP-PKG-00001234\",\n \"externalId\": \"PKG-EXT-001\",\n \"ddpn\": \"DDP-2024-000123456\",\n \"totalDuty\": 4.99\n}"},{"id":"4b20d024-e444-45b0-b091-0c46a5e18e74","name":"Success – No Duty Owed","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Accept-Encoding","value":"gzip, deflate"},{"key":"Authorization","value":"ApiKey YOUR_ACCESS_KEY"}],"body":{"mode":"raw","raw":"{\n \"packageId\": \"SP-PKG-00001234\",\n \"barcode\": \"9400111899223397667318\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.safepackage.com/v1/duty/pay"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"packageId\": \"SP-PKG-00001239\",\n \"externalId\": \"PKG-EXT-005\"\n}"}],"_postman_id":"dd213d5f-3edc-4070-b57f-c5f7de12b814"}],"id":"a8a1aeb8-6345-45ef-9e79-3bac5b2866ea","description":"

Approve payment of all applicable duties and customs fees for a package and obtain proof of payment.

\n

Endpoint: POST /v1/duty/pay

\n","_postman_id":"a8a1aeb8-6345-45ef-9e79-3bac5b2866ea","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ff3b65ad-034d-4f2c-94b9-aa17a115ea3f","id":"ff3b65ad-034d-4f2c-94b9-aa17a115ea3f","name":"SafePackage","type":"collection"}}},{"name":"Shipment Registration","item":[{"name":"Register Shipment","id":"652a9ace-b2a5-454e-827c-43b3a44ca370","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Accept-Encoding","value":"gzip, deflate"},{"key":"Authorization","value":"ApiKey YOUR_ACCESS_KEY"}],"body":{"mode":"raw","raw":"{\n \"externalId\": \"SHIP-EXT-001\",\n \"masterBill\": {\n \"prefix\": \"AWBL\",\n \"serialNumber\": \"12345678901\"\n },\n \"originatorCode\": \"ORIG001\",\n \"invoiceNumber\": \"SHIP-INV-001\",\n \"entryType\": \"86\",\n \"importer\": {\n \"name\": \"US Import Corp\",\n \"line1\": \"100 Import Plaza\",\n \"line2\": \"Suite 500\",\n \"city\": \"Los Angeles\",\n \"state\": \"CA\",\n \"postalCode\": \"90001\",\n \"country\": \"USA\",\n \"phone\": \"+1-310-555-0300\",\n \"email\": \"import@uscorp.com\",\n \"identifiers\": [\n {\n \"type\": \"IMPORTER_NUMBER\",\n \"value\": \"123456789\"\n },\n {\n \"type\": \"DUNS\",\n \"value\": \"987654321\"\n }\n ]\n },\n \"shipper\": {\n \"name\": \"Shenzhen Export Co. Ltd.\",\n \"line1\": \"999 Export Boulevard\",\n \"city\": \"Shenzhen\",\n \"state\": \"Guangdong\",\n \"postalCode\": \"518100\",\n \"country\": \"CHN\",\n \"identifiers\": [\n {\n \"type\": \"DUNS\",\n \"value\": \"123456789\"\n }\n ]\n },\n \"consignee\": {\n \"name\": \"US Receiving Warehouse\",\n \"line1\": \"200 Logistics Drive\",\n \"city\": \"Los Angeles\",\n \"state\": \"CA\",\n \"postalCode\": \"90002\",\n \"country\": \"USA\"\n },\n \"transportation\": {\n \"mode\": \"AIR\",\n \"portOfEntry\": \"LAX\",\n \"portOfArrival\": \"LAX\",\n \"portOfOrigin\": \"PVG\",\n \"carrierName\": \"China Eastern Airlines\",\n \"carrierCode\": \"MU\",\n \"lineNumber\": \"MU583\",\n \"firmsCode\": \"A123\",\n \"shippingDate\": \"2024-01-14\",\n \"scheduledArrivalDate\": \"2024-01-15\",\n \"terminalOperator\": \"LAXTERM01\"\n },\n \"containers\": [\n {\n \"id\": \"CONT-BARCODE-001\",\n \"weight\": {\n \"value\": 50.0,\n \"unit\": \"K\"\n }\n }\n ],\n \"packageIds\": [\n \"SP-PKG-00001234\",\n \"SP-PKG-00001235\",\n \"SP-PKG-00001238\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.safepackage.com/v1/shipment/register","description":"

Register Shipment

\n

Provides shipment (consolidation) information prior to or at the time of manifest/entry filing.

\n

Required Fields

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeMax LengthDescription
externalIdstring–Shipment identifier in the client's system
masterBill.prefixstring4Master bill of lading number prefix
masterBill.serialNumberstring11Master bill serial number
shipperobject–Consolidation shipper address (name, line1, city, state, postalCode, country required)
consigneeobject–Shipment consignee address (name, line1, city, state, postalCode, country required)
transportation.modestring–AIR or TRUCK
transportation.portOfEntrystring–3-letter airport code or CBP port code
transportation.carrierNamestring–Transportation carrier name
transportation.carrierCodestring6IATA carrier code (2 characters)
transportation.lineNumberstring14Flight or voyage line number
transportation.shippingDatestring–Date of shipping
transportation.scheduledArrivalDatestring–Scheduled arrival date
packageIds[]string array–SafePackage package identifiers consolidated in this shipment
\n

Conditional Fields

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
originatorCodestring (10)CBP originator/filler code if required by the clearance process
invoiceNumberstring (30)Shipment invoice number
entryTypestring (2)Customs entry type: 01, 11, 86, or P (postal)
importerobjectImporter address if different from consignee. Accepted identifier types: DUNS, GLN, LEI, IMPORTER_NUMBER
transportation.portOfArrivalstringPort of first arrival if different from port of entry (AIR)
transportation.portOfOriginstringForeign airport of departure – required for AIR mode
transportation.portOfLadingstringPort of lading – required for TRUCK mode
transportation.firmsCodestring (6)Warehouse FIRMS code if required by the clearance process
transportation.terminalOperatorstringCargo terminal operator code for air shipments
\n

Optional Fields

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
shipper.identifiers[]object arrayShipper global identifiers. Accepted types: DUNS, GLN, LEI
consignee.identifiers[]object arrayConsignee identifiers. Accepted types: DUNS, GLN, LEI
containers[]object arrayContainer info – each entry requires id and weight (value + unit)
\n

Response Fields

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypePresenceDescription
shipmentIdstringRequiredUnique SafePackage shipment identifier – used in subsequent endpoints
\n
","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ff3b65ad-034d-4f2c-94b9-aa17a115ea3f","id":"ff3b65ad-034d-4f2c-94b9-aa17a115ea3f","name":"SafePackage","type":"collection"}},"urlObject":{"path":["v1","shipment","register"],"host":["https://api.safepackage.com"],"query":[],"variable":[]}},"response":[{"id":"62c032aa-14a0-4314-8bc0-e6bfca32f7a8","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Accept-Encoding","value":"gzip, deflate"},{"key":"Authorization","value":"ApiKey YOUR_ACCESS_KEY"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"https://api.safepackage.com/v1/shipment/register"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"shipmentId\": \"SP-SHIP-00000123\"\n}"}],"_postman_id":"652a9ace-b2a5-454e-827c-43b3a44ca370"}],"id":"16310e15-928a-4351-983a-1ab0f536b1a9","description":"

Register a shipment (consolidation) — a logical grouping of packages sharing common shipper, consignee, and transportation information — prior to or at the time of manifest/entry filing.

\n

Endpoint: POST /v1/shipment/register

\n","_postman_id":"16310e15-928a-4351-983a-1ab0f536b1a9","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ff3b65ad-034d-4f2c-94b9-aa17a115ea3f","id":"ff3b65ad-034d-4f2c-94b9-aa17a115ea3f","name":"SafePackage","type":"collection"}}},{"name":"Customs Filing","item":[{"name":"Submit Section 321 Pilot Data","id":"a743eccd-c62a-4059-a710-59532f8221e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Accept-Encoding","value":"gzip, deflate"},{"key":"Authorization","value":"ApiKey YOUR_ACCESS_KEY"}],"body":{"mode":"raw","raw":"{\n \"shipmentId\": \"SP-SHIP-00000123\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.safepackage.com/v1/customs/s321/shipment","description":"

Submit Section 321 Pilot Data

\n

Submits Section 321 pilot data to customs for all packages in the shipment.

\n

Important Notes

\n
    \n
  • Generally only needs to be called once per shipment unless shipment or package data has changed between calls.
    • \n
  • Will not accept further requests for the same shipment until the previous operation is complete.
    • \n
  • No response body is returned.
    • \n
\n

Required Fields

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
shipmentIdstringSafePackage shipment identifier returned by the Register Shipment endpoint
\n
","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ff3b65ad-034d-4f2c-94b9-aa17a115ea3f","id":"ff3b65ad-034d-4f2c-94b9-aa17a115ea3f","name":"SafePackage","type":"collection"}},"urlObject":{"path":["v1","customs","s321","shipment"],"host":["https://api.safepackage.com"],"query":[],"variable":[]}},"response":[{"id":"64981458-c558-40eb-a4c1-78bd3c03413f","name":"Success (No Body)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Accept-Encoding","value":"gzip, deflate"},{"key":"Authorization","value":"ApiKey YOUR_ACCESS_KEY"}],"body":{"mode":"raw","raw":"{\n \"shipmentId\": \"SP-SHIP-00000123\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.safepackage.com/v1/customs/s321/shipment"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"a743eccd-c62a-4059-a710-59532f8221e1"},{"name":"Verify Shipment","id":"342338ce-fb94-4e7c-9d3f-9dbdbd47d8b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Accept-Encoding","value":"gzip, deflate"},{"key":"Authorization","value":"ApiKey YOUR_ACCESS_KEY"}],"body":{"mode":"raw","raw":"{\n \"shipmentId\": \"SP-SHIP-00000123\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.safepackage.com/v1/shipment/verify","description":"

Verify Shipment

\n

Verifies that the inbound shipment meets all criteria for associated customs clearance benefits.

\n

When to Call

\n
    \n
  • Call after Section 321 Pilot Data has been submitted.
    • \n
  • Call at least one hour before departure from the origin.
    • \n
\n

Required Fields

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
shipmentIdstringSafePackage shipment identifier returned by the Register Shipment endpoint
\n

Response Fields

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypePresenceDescription
shipmentIdstringRequiredSafePackage shipment identifier
codenumberRequired1 Accepted (entire shipment compliant), 2 Rejected (not compliant)
statusstringRequiredAccepted or Rejected
reason.codestringConditionalThree-letter rejection reason code
reason.descriptionstringConditionalShort rejection reason phrase
document.typestringConditionalVerification document type: PNG, JPEG, or WEBM
document.contentbase64 stringConditionalBase64-encoded document content – returned only when code is 1. Must be printed and presented to CBP personnel on request
\n
","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ff3b65ad-034d-4f2c-94b9-aa17a115ea3f","id":"ff3b65ad-034d-4f2c-94b9-aa17a115ea3f","name":"SafePackage","type":"collection"}},"urlObject":{"path":["v1","shipment","verify"],"host":["https://api.safepackage.com"],"query":[],"variable":[]}},"response":[{"id":"ee6a99d1-c275-457e-90c8-04a8520322a9","name":"Accepted","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Accept-Encoding","value":"gzip, deflate"},{"key":"Authorization","value":"ApiKey YOUR_ACCESS_KEY"}],"body":{"mode":"raw","raw":"{\n \"shipmentId\": \"SP-SHIP-00000123\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.safepackage.com/v1/shipment/verify"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"shipmentId\": \"SP-SHIP-00000123\",\n \"code\": 1,\n \"status\": \"Accepted\",\n \"document\": {\n \"type\": \"PNG\",\n \"content\": \"\"\n }\n}"},{"id":"a2f0c368-4bb1-49be-ac18-c796406993e7","name":"Rejected","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Accept-Encoding","value":"gzip, deflate"},{"key":"Authorization","value":"ApiKey YOUR_ACCESS_KEY"}],"body":{"mode":"raw","raw":"{\n \"shipmentId\": \"SP-SHIP-00000123\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.safepackage.com/v1/shipment/verify"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"shipmentId\": \"SP-SHIP-00000124\",\n \"code\": 2,\n \"status\": \"Rejected\",\n \"reason\": {\n \"code\": \"RCT\",\n \"description\": \"Customs regulations violation\"\n }\n}"}],"_postman_id":"342338ce-fb94-4e7c-9d3f-9dbdbd47d8b0"}],"id":"88c1b7ce-7000-4547-9194-2910cbf9db6f","description":"

Submit Section 321 pilot data and verify shipment compliance.

\n

Typical sequence:

\n
    \n
  1. Call POST /v1/customs/s321/shipment to submit pilot data
    2. \n
  2. Wait at least one hour before departure
    3. \n
  3. Call POST /v1/shipment/verify to verify compliance and obtain the CBP document
    4. \n
\n","_postman_id":"88c1b7ce-7000-4547-9194-2910cbf9db6f","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ff3b65ad-034d-4f2c-94b9-aa17a115ea3f","id":"ff3b65ad-034d-4f2c-94b9-aa17a115ea3f","name":"SafePackage","type":"collection"}}},{"name":"Content Audit","item":[{"name":"Submit Content Audit","id":"54d440c5-075c-42aa-8141-318f0508bac5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Accept-Encoding","value":"gzip, deflate"},{"key":"Authorization","value":"ApiKey YOUR_ACCESS_KEY"}],"body":{"mode":"raw","raw":"{\n \"packageId\": \"SP-PKG-00001237\",\n \"externalId\": \"PKG-EXT-004\",\n \"images\": [\n \"\",\n \"\"\n ],\n \"remark\": \"Package opened and contents inspected. All items match declaration.\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.safepackage.com/v1/package/audit","description":"

Submit Content Audit

\n

Submits images taken during a physical content audit. Required when package screening returns code 4 (Audit).

\n

Required Fields

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
externalIdstringClient's external package identifier
images[]base64 string arrayAt least two JPEG images per individual product, minimum 1024×768px. Images must: (1) clearly show package contents in good lighting, and (2) have a visible brand name, logo, and/or product declaration
\n

Optional Fields

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeMax LengthDescription
packageIdstring–SafePackage package identifier (recommended when available)
remarkstring100Brief description of additional content audit findings
\n

Response Fields

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypePresenceDescription
packageIdstringRequiredSafePackage package identifier
externalIdstringRequiredClient's external package identifier
codenumberRequired1 Passed, 2 Failed, 3 Pending
statusstringRequiredPassed, Failed, or Pending
\n
","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ff3b65ad-034d-4f2c-94b9-aa17a115ea3f","id":"ff3b65ad-034d-4f2c-94b9-aa17a115ea3f","name":"SafePackage","type":"collection"}},"urlObject":{"path":["v1","package","audit"],"host":["https://api.safepackage.com"],"query":[],"variable":[]}},"response":[{"id":"7c8ceaf1-dc30-4bf6-95b9-f61bc97e332d","name":"Passed","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Accept-Encoding","value":"gzip, deflate"},{"key":"Authorization","value":"ApiKey YOUR_ACCESS_KEY"}],"body":{"mode":"raw","raw":"{\n \"packageId\": \"SP-PKG-00001237\",\n \"externalId\": \"PKG-EXT-004\",\n \"images\": [\"\", \"\"],\n \"remark\": \"All items match declaration.\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.safepackage.com/v1/package/audit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"packageId\": \"SP-PKG-00001237\",\n \"externalId\": \"PKG-EXT-004\",\n \"code\": 1,\n \"status\": \"Passed\"\n}"},{"id":"023da6a9-855c-48fe-bbbd-9c0ce020ac85","name":"Failed","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Accept-Encoding","value":"gzip, deflate"},{"key":"Authorization","value":"ApiKey YOUR_ACCESS_KEY"}],"body":{"mode":"raw","raw":"{\n \"packageId\": \"SP-PKG-00001240\",\n \"externalId\": \"PKG-EXT-007\",\n \"images\": [\"\", \"\"],\n \"remark\": \"Contents do not match declaration.\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.safepackage.com/v1/package/audit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"packageId\": \"SP-PKG-00001240\",\n \"externalId\": \"PKG-EXT-007\",\n \"code\": 2,\n \"status\": \"Failed\"\n}"},{"id":"8c86739b-ca4c-42c1-8965-28a9e52b5f7d","name":"Pending","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Accept-Encoding","value":"gzip, deflate"},{"key":"Authorization","value":"ApiKey YOUR_ACCESS_KEY"}],"body":{"mode":"raw","raw":"{\n \"packageId\": \"SP-PKG-00001241\",\n \"externalId\": \"PKG-EXT-008\",\n \"images\": [\"\", \"\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.safepackage.com/v1/package/audit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"packageId\": \"SP-PKG-00001241\",\n \"externalId\": \"PKG-EXT-008\",\n \"code\": 3,\n \"status\": \"Pending\"\n}"}],"_postman_id":"54d440c5-075c-42aa-8141-318f0508bac5"}],"id":"f62dfd74-4457-49cc-ba08-824305d81689","description":"

Submit additional package information via images taken during a physical content audit.

\n

Endpoint: POST /v1/package/audit

\n

This endpoint is required when a Package Screening response returns result code 4 (Audit).

\n

Result Codes:

\n
    \n
  • 1 – Passed: audit successful, package accepted
    • \n
  • 2 – Failed: package failed audit, must be returned
    • \n
  • 3 – Pending: audit incomplete, hold package until resolved
    • \n
\n","_postman_id":"f62dfd74-4457-49cc-ba08-824305d81689","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ff3b65ad-034d-4f2c-94b9-aa17a115ea3f","id":"ff3b65ad-034d-4f2c-94b9-aa17a115ea3f","name":"SafePackage","type":"collection"}}},{"name":"Platform","item":[{"name":"Get Platforms","id":"9b5b4e27-6cf2-4a5f-a4ec-4e36c4245cf7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Accept-Encoding","value":"gzip, deflate"},{"key":"Authorization","value":"ApiKey YOUR_ACCESS_KEY"}],"url":"https://api.safepackage.com/v1/platform","description":"

Get Platforms

\n

Retrieves a list of all e-commerce platforms registered in the API.

\n

Use the returned id values as the platformId field in all screening and submission endpoints.

\n

Response Fields

\n

Returns an array of platform objects.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypePresenceDescription
idstringRequiredPlatform identifier – use as platformId in requests
urlstringRequiredPlatform homepage URL
\n
","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ff3b65ad-034d-4f2c-94b9-aa17a115ea3f","id":"ff3b65ad-034d-4f2c-94b9-aa17a115ea3f","name":"SafePackage","type":"collection"}},"urlObject":{"path":["v1","platform"],"host":["https://api.safepackage.com"],"query":[],"variable":[]}},"response":[{"id":"2393f0bb-a8f5-4109-b741-1b8d64ffa6fd","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Accept-Encoding","value":"gzip, deflate"},{"key":"Authorization","value":"ApiKey YOUR_ACCESS_KEY"}],"url":"https://api.safepackage.com/v1/platform"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"AMAZON\",\n \"url\": \"https://www.amazon.com\"\n },\n {\n \"id\": \"EBAY\",\n \"url\": \"https://www.ebay.com\"\n },\n {\n \"id\": \"ALIEXPRESS\",\n \"url\": \"https://www.aliexpress.com\"\n },\n {\n \"id\": \"SHEIN\",\n \"url\": \"https://www.shein.com\"\n },\n {\n \"id\": \"TEMU\",\n \"url\": \"https://www.temu.com\"\n }\n]"}],"_postman_id":"9b5b4e27-6cf2-4a5f-a4ec-4e36c4245cf7"}],"id":"f1d911a8-5a9c-4735-90eb-8fb032ce46c1","description":"

Retrieve all e-commerce platforms registered in the API.

\n

Endpoint: GET /v1/platform

\n

Use the returned id values as the platformId field in all screening and submission endpoints.

\n","_postman_id":"f1d911a8-5a9c-4735-90eb-8fb032ce46c1","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ff3b65ad-034d-4f2c-94b9-aa17a115ea3f","id":"ff3b65ad-034d-4f2c-94b9-aa17a115ea3f","name":"SafePackage","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]}},"variable":[{"key":"base_url","value":"https://api.safepackage.com","description":"Base URL - switch to https://sandbox.safepackage.com for development"},{"key":"api_key","value":"YOUR_ACCESS_KEY","description":"Your SafePackage API key"}]}