{"info":{"_postman_id":"5faf80cd-32ab-4646-8e39-6a344a916230","name":"SafePackage","description":"

SafePackage API v1.27

\n

Includes the main API spec (v1.27), PGA Data Supplement (v1.27), and Tracking Supplement (v1.17.3).

\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

Endpoint Index

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
EndpointMethodPath
Product ScreeningPOST/v1/product/screen
Package ScreeningPOST/v1/package/screen
Package Data Submission (TDP)POST/v1/package/submit
Duty CollectionPOST/v1/duty/pay
Shipment RegistrationPOST/v1/shipment/register
Section 321 Data SubmissionPOST/v1/customs/s321/shipment
Shipment VerificationPOST/v1/shipment/verify
Content AuditPOST/v1/package/audit
Package Tracking (new v1.27)GET/v1/tracking/package/{packageId}
Shipment Tracking (new v1.27)GET/v1/tracking/shipment/{shipmentId}
Platform ListGET/v1/platform
\n

What's New in v1.27

\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"SafePackage API v1.27","slug":"safepackage-api-v127"}],"owner":"1980603","collectionId":"5faf80cd-32ab-4646-8e39-6a344a916230","publishedId":"2sBYAyroUR","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-09-10T15:43:47.000Z"},"item":[{"name":"Product Screening","item":[{"name":"Screen Product","id":"3fd90617-bfb0-4ddd-833c-9bdef4422c40","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":"{{auth_secret_0euv}}"}],"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 { \"type\": \"ManufacturerId\", \"value\": \"MID123456789\" },\n { \"type\": \"ManufacturerName\", \"value\": \"Acme Electronics Co. Ltd.\" },\n { \"type\": \"ManufacturerAddress\", \"value\": \"123 Factory Road, Shenzhen, Guangdong, China\" }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.safepackage.com/v1/product/screen","description":"

Screen Product

\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
FieldTypeMaxDescription
skustring50Unique product listing identifier
platformIdstring20Marketplace platform identifier
sellerIdstring–Seller/store identifier
urlstring1000Public product listing URL
namestring300Full advertised product name (must match product page)
descriptionstring–Full advertised description (must match product page)
pricenumber–List price in USD
images[]base64 array–One or more images. JPEG recommended, min 640×480. Formats: JPEG, WEBP, PNG8, PNG24, GIF (non-animated)
htsstring10[NEW v1.27 — now required] Primary US HTS number, exactly 10 digits
originCountrystring–ISO-3 uppercase. Use CHN for China
destinationCountrystring–ISO-3 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
FieldTypeMaxDescription
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
FieldTypeDescription
categories[]string arrayStore categories or keywords
piecesnumberTotal number of pieces
eanstring (20)13-digit EAN or 12-digit UPC
normalizebooleanWhether product data needs normalizing
instructions[]object arraySpecial screening instructions (type required, value conditional)
attributes[]object arrayAdditional attributes. Types: 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
referencestringRequiredSafePackage product reference
codenumberRequired1 Accepted · 2 Rejected · 3 Inconclusive
statusstringRequiredAccepted, Rejected, or Inconclusive
reason.codestringConditionalThree-letter rejection reason code
reason.descriptionstringConditionalShort rejection reason description
\n

Rejection Reason Codes

\n

RMG RBT RDG – Transportation security · RHP – De-minimis · RIP – IP infringement · RIC – Copyright · RIT – Trademark · RIN – Patent · RCT RCR – Customs · RPA – USDA · RPW – FWS · RPT – DOT · RPD – FDA · RPS – CPSC · RPF – FCEN · RPE – ATF · RPL – Forced labor · RBD – Bad data

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{auth_secret_0euv}}"}]},"isInherited":true,"source":{"_postman_id":"5faf80cd-32ab-4646-8e39-6a344a916230","id":"5faf80cd-32ab-4646-8e39-6a344a916230","name":"SafePackage","type":"collection"}},"urlObject":{"path":["v1","product","screen"],"host":["https://api.safepackage.com"],"query":[],"variable":[]}},"response":[{"id":"c02b7f16-406b-4005-bdad-e922e1869072","name":"Accepted","originalRequest":{"method":"POST","header":[],"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":"3e6dc658-f816-402d-ab90-b47a95e8b077","name":"Rejected","originalRequest":{"method":"POST","header":[],"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":"94ef1c7e-e4c2-405c-ab89-67178e35bba8","name":"Inconclusive","originalRequest":{"method":"POST","header":[],"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":"3fd90617-bfb0-4ddd-833c-9bdef4422c40"}],"id":"d247015c-7dad-4473-8e5b-fe6ad1644aa9","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

v1.27 change: hts is now required (10-digit US HTS number).

\n

Result codes: 1 Accepted · 2 Rejected · 3 Inconclusive

\n","_postman_id":"d247015c-7dad-4473-8e5b-fe6ad1644aa9","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{auth_secret_0euv}}"}]},"isInherited":true,"source":{"_postman_id":"5faf80cd-32ab-4646-8e39-6a344a916230","id":"5faf80cd-32ab-4646-8e39-6a344a916230","name":"SafePackage","type":"collection"}}},{"name":"Package Screening","item":[{"name":"Screen Package","id":"866a8ad1-70b9-4909-885a-f602f8257758","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":"{{auth_secret_0euv}}"}],"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\": { \"value\": 1.2, \"unit\": \"K\" },\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\": { \"value\": 1.2, \"unit\": \"K\" },\n \"tariffStack\": [\n {\n \"hts\": \"8518300000\",\n \"value\": 49.99,\n \"indicators\": [\n { \"type\": \"SPI\", \"value\": \"CL\" }\n ],\n \"quantities\": [\n { \"unit\": \"NO\", \"quantity\": 1 }\n ]\n }\n ],\n \"pga\": [\n {\n \"agency\": \"FDA\",\n \"program\": {\n \"code\": \"DRU\",\n \"productCode\": \"ABC\",\n \"processingCode\": \"AC\",\n \"intendedUseCode\": \"081\"\n }\n }\n ],\n \"declarations\": {\n \"aluminum\": {\n \"primarySmeltCountry\": \"CHN\",\n \"secondarySmeltCountry\": \"CHN\",\n \"castCountry\": \"CHN\"\n },\n \"copper\": {\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.\",\n \"price\": 49.99,\n \"images\": [\"\"],\n \"originCountry\": \"CHN\",\n \"categories\": [\"Electronics\", \"Audio\"],\n \"pieces\": 1,\n \"ean\": \"0123456789012\",\n \"hts\": \"8518300000\",\n \"normalize\": false,\n \"instructions\": [],\n \"attributes\": [\n { \"type\": \"ManufacturerId\", \"value\": \"MID123456789\" },\n { \"type\": \"ManufacturerName\", \"value\": \"Acme Electronics Co. Ltd.\" },\n { \"type\": \"ManufacturerAddress\", \"value\": \"123 Factory Road, Shenzhen, Guangdong, China\" }\n ]\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.safepackage.com/v1/package/screen","description":"

Screen Package

\n

Top-Level 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
FieldTypeMaxDescription
externalIdstring–Package identifier in client's system
platformIdstring20Marketplace platform identifier
sellerIdstring50Seller/store identifier
exportCountrystring–ISO-3 export country. Use CHN for China
destinationCountrystring–ISO-3 destination country. Use USA for United States
houseBillNumberstring12Unique house bill number within a shipment
barcodestring–Package tracking barcode
weight.valuenumber–Gross weight value
weight.unitstring–K kg · L lb
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
\n

Top-Level 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
FieldTypeMaxDescription
invoiceNumberstring30Invoice number for entry filing
containerIdstring–Container barcode if package is in a separate container
chargesnumber–Total non-dutiable charges
\n

Top-Level 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
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
FieldTypeDescription
declaredValuenumberItem declared value in USD
declaredNamestring (300)Customs declaration name
originCountrystringISO-3 origin country
midstringManufacturer ID (MID)
weight.value / weight.unitnumber / stringItem weight (K or L)
tariffStack[]object arrayTariff declarations (hts 10-digit, value, quantities[] required per entry)
\n

products[].items[] 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
FieldTypeDescription
tariffStack[].indicators[]object arraySPI indicators (type, optional value)
pga[]object arrayPGA filing data — see PGA Reference folder
declarations.aluminumobjectprimarySmeltCountry [conditional], secondarySmeltCountry [conditional, relaxed in v1.27], castCountry [conditional, now string in v1.27]
declarations.copperobject[NEW v1.27] primarySmeltCountry, secondarySmeltCountry, castCountry (all conditional, all ISO-3 strings)
declarations.steelobjectmeltCountry [conditional], applicabilityCode [conditional]
\n

products[].product Required Fields

\n

sku, url, name, description, price, images[], originCountry, hts (required in v1.27 — 10 digits)

\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
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 shipping label — only when code = 1. Print SafePackage ® near the QR code
products[].referencestringRequiredSafePackage product reference
products[].skustringRequiredProduct SKU
products[].platformIdstringRequiredPlatform identifier
products[].codenumberRequired1 · 2 · 3
products[].statusstringRequiredPer-product result status
products[].reasonobjectConditionalcode and description when rejected
\n
","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{auth_secret_0euv}}"}]},"isInherited":true,"source":{"_postman_id":"5faf80cd-32ab-4646-8e39-6a344a916230","id":"5faf80cd-32ab-4646-8e39-6a344a916230","name":"SafePackage","type":"collection"}},"urlObject":{"path":["v1","package","screen"],"host":["https://api.safepackage.com"],"query":[],"variable":[]}},"response":[{"id":"92bd51f5-d0c5-48ad-82b1-a06974c20da3","name":"Accepted","originalRequest":{"method":"POST","header":[],"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":"034b58f8-3ce7-42bb-bdc9-e56ddcbf7fab","name":"Rejected","originalRequest":{"method":"POST","header":[],"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":"a4fc17e8-69af-469b-adc6-b0df0fcd025d","name":"Inconclusive","originalRequest":{"method":"POST","header":[],"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\": { \"code\": \"RBD\", \"description\": \"Bad or incomplete data\" }\n }\n ]\n}"},{"id":"6981c60a-6491-4a57-8bca-7bb49fa0260f","name":"Audit Required","originalRequest":{"method":"POST","header":[],"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":"866a8ad1-70b9-4909-885a-f602f8257758"}],"id":"c13c6281-3988-4467-9fd4-03976e38cee7","description":"

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

\n

Endpoint: POST /v1/package/screen

\n

v1.27 changes:

\n
    \n
  • products[].product.hts now required (10 digits)
    • \n
  • declarations.copper object added on line items
    • \n
  • declarations.aluminum.secondarySmeltCountry changed to conditional
    • \n
  • declarations.aluminum.castCountry type corrected to string
    • \n
\n

Result codes: 1 Accepted · 2 Rejected · 3 Inconclusive · 4 Audit Required

\n","_postman_id":"c13c6281-3988-4467-9fd4-03976e38cee7","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{auth_secret_0euv}}"}]},"isInherited":true,"source":{"_postman_id":"5faf80cd-32ab-4646-8e39-6a344a916230","id":"5faf80cd-32ab-4646-8e39-6a344a916230","name":"SafePackage","type":"collection"}}},{"name":"Package Data Submission (TDP)","item":[{"name":"Submit Package (TDP)","id":"9dc851c0-f9bf-414b-ab4a-988da0cc45cb","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":"{{auth_secret_0euv}}"}],"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\": { \"value\": 0.8, \"unit\": \"K\" },\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\": { \"value\": 0.4, \"unit\": \"K\" },\n \"tariffStack\": [\n {\n \"hts\": \"6912000000\",\n \"value\": 35.00,\n \"indicators\": [],\n \"quantities\": [\n { \"unit\": \"NO\", \"quantity\": 2 }\n ]\n }\n ],\n \"pga\": [\n {\n \"agency\": \"FDA\",\n \"program\": {\n \"code\": \"FOO\",\n \"productCode\": \"CER\",\n \"processingCode\": \"AC\",\n \"intendedUseCode\": \"081\"\n }\n }\n ],\n \"declarations\": {\n \"aluminum\": {\n \"primarySmeltCountry\": \"CHN\",\n \"secondarySmeltCountry\": \"CHN\",\n \"castCountry\": \"CHN\"\n },\n \"copper\": {\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

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

\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
FieldTypeMaxDescription
quantitynumber–Number of distinct SKUs on this line
declaredValuenumber–Line item total declared value in USD
declaredNamestring300Customs declaration name
originCountrystring–ISO-3 origin country
weight.value / weight.unitnumber / string–Item weight (K or L)
tariffStack[]object array–hts (10-digit), value, quantities[] required per entry
\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\n\n\n\n\n\n
FieldTypeMaxDescription
midstring20Manufacturer ID — required if entry filing is intended
pga[]object array–PGA data sets — see PGA Reference folder
declarations.aluminumobject–primarySmeltCountry [conditional], secondarySmeltCountry [conditional], castCountry [conditional, string ISO-3]
declarations.copperobject–[NEW v1.27] primarySmeltCountry, secondarySmeltCountry, castCountry (all conditional, ISO-3 strings)
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
FieldTypeMaxDescription
urlstring1000Product listing URL
skustring50Product SKU
\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":"{{auth_secret_0euv}}"}]},"isInherited":true,"source":{"_postman_id":"5faf80cd-32ab-4646-8e39-6a344a916230","id":"5faf80cd-32ab-4646-8e39-6a344a916230","name":"SafePackage","type":"collection"}},"urlObject":{"path":["v1","package","submit"],"host":["https://api.safepackage.com"],"query":[],"variable":[]}},"response":[{"id":"7fccbc63-fecd-4836-853a-a0bb70f47b18","name":"Success","originalRequest":{"method":"POST","header":[],"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":"9dc851c0-f9bf-414b-ab4a-988da0cc45cb"}],"id":"c890f959-841b-4331-96c1-41693953ef8a","description":"

Submit package data for customs manifesting/filing — Traditional Brokerage Process only.

\n

Endpoint: POST /v1/package/submit

\n

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

\n

v1.27 changes: declarations.copper added; aluminum.castCountry now string; aluminum.secondarySmeltCountry now conditional; obsolete group field removed.

\n","_postman_id":"c890f959-841b-4331-96c1-41693953ef8a","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{auth_secret_0euv}}"}]},"isInherited":true,"source":{"_postman_id":"5faf80cd-32ab-4646-8e39-6a344a916230","id":"5faf80cd-32ab-4646-8e39-6a344a916230","name":"SafePackage","type":"collection"}}},{"name":"Duty Collection","item":[{"name":"Pay Duties","id":"ba095929-c196-427f-9c8d-39d2f552c7e0","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":"{{auth_secret_0euv}}"}],"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

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 from screening/submission
barcodestringPackage tracking barcode from 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 carriers
totalDutynumberConditionalTotal duty and fees collected in USD
\n
","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{auth_secret_0euv}}"}]},"isInherited":true,"source":{"_postman_id":"5faf80cd-32ab-4646-8e39-6a344a916230","id":"5faf80cd-32ab-4646-8e39-6a344a916230","name":"SafePackage","type":"collection"}},"urlObject":{"path":["v1","duty","pay"],"host":["https://api.safepackage.com"],"query":[],"variable":[]}},"response":[{"id":"8d45ac96-1c91-43df-a540-954dd2e1ff4e","name":"Success – Duty Collected","originalRequest":{"method":"POST","header":[],"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":"142e773c-89f2-4ad4-b6ee-95ada189ecc0","name":"Success – No Duty Owed","originalRequest":{"method":"POST","header":[],"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":"ba095929-c196-427f-9c8d-39d2f552c7e0"}],"id":"367e503e-6352-4e26-875d-52c85b86b17e","description":"

Approve duty payment and obtain proof of payment.

\n

Endpoint: POST /v1/duty/pay

\n","_postman_id":"367e503e-6352-4e26-875d-52c85b86b17e","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{auth_secret_0euv}}"}]},"isInherited":true,"source":{"_postman_id":"5faf80cd-32ab-4646-8e39-6a344a916230","id":"5faf80cd-32ab-4646-8e39-6a344a916230","name":"SafePackage","type":"collection"}}},{"name":"Shipment Registration","item":[{"name":"Register Shipment","id":"4318e996-b62f-439a-b779-dd5b8d347bda","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":"{{auth_secret_0euv}}"}],"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 { \"type\": \"IMPORTER_NUMBER\", \"value\": \"123456789\" },\n { \"type\": \"DUNS\", \"value\": \"987654321\" }\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 { \"type\": \"DUNS\", \"value\": \"123456789\" }\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\": { \"value\": 50.0, \"unit\": \"K\" }\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

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
FieldTypeMaxDescription
externalIdstring–Shipment identifier in client's system
masterBill.prefixstring4Master bill prefix
masterBill.serialNumberstring11Master bill serial number
shipperobject–Shipper address (name, line1, city, state, postalCode, country required)
consigneeobject–Consignee address (same required sub-fields)
transportation.modestring–AIR or TRUCK
transportation.portOfEntrystring–3-letter airport code or CBP port code
transportation.carrierNamestring–Carrier name
transportation.carrierCodestring6IATA 2-character carrier code
transportation.lineNumberstring14Flight/voyage number
transportation.shippingDatestring–Shipping date
transportation.scheduledArrivalDatestring–Scheduled arrival date
packageIds[]string array–SafePackage package identifiers 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
FieldDescription
originatorCode (10)CBP originator code if required
invoiceNumber (30)Shipment invoice number
entryType (2)01, 11, 86, or P
importerIf different from consignee. Identifier types: DUNS, GLN, LEI, IMPORTER_NUMBER
transportation.portOfArrivalFirst arrival if different from entry (AIR)
transportation.portOfOriginRequired for AIR
transportation.portOfLadingRequired for TRUCK
transportation.firmsCode (6)Warehouse FIRMS code
transportation.terminalOperatorAir terminal operator
\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
FieldDescription
shipper.identifiers[]DUNS, GLN, LEI
consignee.identifiers[]DUNS, GLN, LEI
containers[]id and weight per container
\n

Response

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
shipmentIdstringSafePackage shipment identifier — use in subsequent endpoints
\n
","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{auth_secret_0euv}}"}]},"isInherited":true,"source":{"_postman_id":"5faf80cd-32ab-4646-8e39-6a344a916230","id":"5faf80cd-32ab-4646-8e39-6a344a916230","name":"SafePackage","type":"collection"}},"urlObject":{"path":["v1","shipment","register"],"host":["https://api.safepackage.com"],"query":[],"variable":[]}},"response":[{"id":"ea618f3c-912c-434a-9fa9-76abee2a2e89","name":"Success","originalRequest":{"method":"POST","header":[],"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":"4318e996-b62f-439a-b779-dd5b8d347bda"}],"id":"a96c7e4b-3cca-4a44-a084-74127754f7de","description":"

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

\n

Endpoint: POST /v1/shipment/register

\n","_postman_id":"a96c7e4b-3cca-4a44-a084-74127754f7de","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{auth_secret_0euv}}"}]},"isInherited":true,"source":{"_postman_id":"5faf80cd-32ab-4646-8e39-6a344a916230","id":"5faf80cd-32ab-4646-8e39-6a344a916230","name":"SafePackage","type":"collection"}}},{"name":"Customs Filing","item":[{"name":"Submit Section 321 Pilot Data","id":"51abef61-539f-4a71-adce-18855c00f7d0","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":"{{auth_secret_0euv}}"}],"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 S321 pilot data to customs for all packages in the shipment.

\n
    \n
  • Call once per shipment unless data has changed.
    • \n
  • Will not accept further requests until the previous operation completes.
    • \n
  • No response body 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
\n
","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{auth_secret_0euv}}"}]},"isInherited":true,"source":{"_postman_id":"5faf80cd-32ab-4646-8e39-6a344a916230","id":"5faf80cd-32ab-4646-8e39-6a344a916230","name":"SafePackage","type":"collection"}},"urlObject":{"path":["v1","customs","s321","shipment"],"host":["https://api.safepackage.com"],"query":[],"variable":[]}},"response":[{"id":"94e116eb-f9b1-427d-8065-20224b407395","name":"Success (No Body)","originalRequest":{"method":"POST","header":[],"url":"https://api.safepackage.com/v1/customs/s321/shipment"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"51abef61-539f-4a71-adce-18855c00f7d0"},{"name":"Verify Shipment","id":"5fd1caf1-82ea-4d2a-951d-7953c67d9670","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":"{{auth_secret_0euv}}"}],"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

Call after S321 data submission, at least 1 hour before departure.

\n

Required Fields

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
shipmentIdstringSafePackage shipment identifier
\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 · 2 Rejected
statusstringRequiredAccepted or Rejected
reason.codestringConditionalRejection reason code
reason.descriptionstringConditionalRejection reason description
document.typestringConditionalPNG, JPEG, or WEBM — only when code = 1
document.contentbase64 stringConditionalVerification document — print and present to CBP on request
\n
","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{auth_secret_0euv}}"}]},"isInherited":true,"source":{"_postman_id":"5faf80cd-32ab-4646-8e39-6a344a916230","id":"5faf80cd-32ab-4646-8e39-6a344a916230","name":"SafePackage","type":"collection"}},"urlObject":{"path":["v1","shipment","verify"],"host":["https://api.safepackage.com"],"query":[],"variable":[]}},"response":[{"id":"1261f416-113e-45a2-b15b-5f36144bbd0c","name":"Accepted","originalRequest":{"method":"POST","header":[],"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":"c7b0c417-c438-4937-8146-89155545fdeb","name":"Rejected","originalRequest":{"method":"POST","header":[],"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":"5fd1caf1-82ea-4d2a-951d-7953c67d9670"}],"id":"395ef165-3782-4c4b-8e1c-e8891d0f2000","description":"

Submit Section 321 pilot data and verify shipment compliance.

\n

Sequence: Submit S321 data → wait ≥ 1 hour before departure → Verify shipment

\n","_postman_id":"395ef165-3782-4c4b-8e1c-e8891d0f2000","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{auth_secret_0euv}}"}]},"isInherited":true,"source":{"_postman_id":"5faf80cd-32ab-4646-8e39-6a344a916230","id":"5faf80cd-32ab-4646-8e39-6a344a916230","name":"SafePackage","type":"collection"}}},{"name":"Content Audit","item":[{"name":"Submit Content Audit","id":"31ff8ce2-97f9-47fd-88c9-aa513f701371","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":"{{auth_secret_0euv}}"}],"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

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 arrayAt least two JPEG images per individual product, min 1024×768px. Must show contents in good lighting with visible brand name, logo, 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
FieldTypeMaxDescription
packageIdstring–SafePackage package identifier (recommended)
remarkstring100Brief description of additional 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":"{{auth_secret_0euv}}"}]},"isInherited":true,"source":{"_postman_id":"5faf80cd-32ab-4646-8e39-6a344a916230","id":"5faf80cd-32ab-4646-8e39-6a344a916230","name":"SafePackage","type":"collection"}},"urlObject":{"path":["v1","package","audit"],"host":["https://api.safepackage.com"],"query":[],"variable":[]}},"response":[{"id":"868f303a-fb0c-45c9-a411-37f2737fbf2c","name":"Passed","originalRequest":{"method":"POST","header":[],"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":"6bc8478e-5293-4638-8ee2-25ae961a0004","name":"Failed","originalRequest":{"method":"POST","header":[],"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":"fecd69cc-e9cb-4376-9817-49a68a7c36ce","name":"Pending","originalRequest":{"method":"POST","header":[],"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":"31ff8ce2-97f9-47fd-88c9-aa513f701371"}],"id":"98157ee6-d2f0-43e3-a747-5a3e2e359ee7","description":"

Submit physical audit images when package screening returns code 4 (Audit).

\n

Endpoint: POST /v1/package/audit

\n

Result codes: 1 Passed · 2 Failed · 3 Pending

\n","_postman_id":"98157ee6-d2f0-43e3-a747-5a3e2e359ee7","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{auth_secret_0euv}}"}]},"isInherited":true,"source":{"_postman_id":"5faf80cd-32ab-4646-8e39-6a344a916230","id":"5faf80cd-32ab-4646-8e39-6a344a916230","name":"SafePackage","type":"collection"}}},{"name":"Tracking (NEW v1.27)","item":[{"name":"Get Package Tracking – by packageId (route)","id":"3060b494-2c9f-4ad8-92ac-94ab5f55e0b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Accept-Encoding","value":"gzip, deflate"},{"key":"Authorization","value":"{{auth_secret_0euv}}"}],"url":"https://api.safepackage.com/v1/tracking/package/SP-PKG-00001234","description":"

Get Package Tracking

\n

Route Parameter

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypePresenceDescription
packageIdstringoptionalSafePackage package identifier
\n

Query Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypePresenceDescription
packageIdstringoptionalSafePackage package identifier (alternative to route param)
externalIdstringconditionalClient's external ID. Required if packageId not provided
formatstringoptionalFormat for additional tracking data elements
\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
FieldTypePresenceDescription
packageIdstringRequiredSafePackage package identifier
events[]arrayRequiredChronological event list
events[].typestringRequiredStandardized event type
events[].descriptionstringRequiredStandardized event description
events[].timestringRequiredISO 8601 event timestamp
events[].dataobjectOptionalAdditional event data (fields vary by type)
\n

Package Event Types

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescriptiondata
PICKED_UPPicked up from providerfrom: Provider ID
HANDED_OVERHanded to providerto: Provider ID
RECEIVEDReceived at locationlocationId
DEPARTEDDeparted locationlocationId
UNLINKEDRemoved from containercontainerId
LINKEDAdded to containercontainerId
MANIFEST_SUBMITTEDManifest submitted—
MANIFEST_FAILEDManifest failederrorCode
MANIFEST_CANCELLEDManifest cancelled—
ACAS_SUBMITTEDCargo screening submitted—
ACAS_FAILEDCargo screening failederrorCode
ACAS_CLEAREDCleared cargo screeningstatus
ACAS_HELDHeld for cargo screeningstatus
ACAS_HOLD_REMOVEDCargo screening hold removedstatus
ACAS_PENDINGCargo screening pendingstatus
ACAS_STATUSNew cargo screening statusstatus
S321_SUBMITTEDS321 data submitted—
S321_ACCEPTEDS321 data acceptedstatus
S321_FAILEDS321 submission failederrorCode
CLEAREDCleared customsstatus
HELDHeld by customsstatus
HOLD_REMOVEDHold removedstatus
SEIZEDSeized by customsstatus
STATUSNew customs statusstatus
\n
","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{auth_secret_0euv}}"}]},"isInherited":true,"source":{"_postman_id":"5faf80cd-32ab-4646-8e39-6a344a916230","id":"5faf80cd-32ab-4646-8e39-6a344a916230","name":"SafePackage","type":"collection"}},"urlObject":{"path":["v1","tracking","package","SP-PKG-00001234"],"host":["https://api.safepackage.com"],"query":[{"disabled":true,"description":{"content":"

Optional. Format for additional tracking data.

\n","type":"text/plain"},"key":"format","value":""}],"variable":[]}},"response":[{"id":"684d99ca-4ef5-4831-8166-d057f72ca778","name":"Success","originalRequest":{"method":"GET","header":[],"url":"https://api.safepackage.com/v1/tracking/package/SP-PKG-00001234"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"packageId\": \"SP-PKG-00001234\",\n \"events\": [\n {\n \"type\": \"RECEIVED\",\n \"description\": \"Package Received\",\n \"time\": \"2024-01-14T08:00:00Z\",\n \"data\": { \"locationId\": \"WAREHOUSE-SHZ-01\" }\n },\n {\n \"type\": \"LINKED\",\n \"description\": \"Package Linked\",\n \"time\": \"2024-01-14T08:30:00Z\",\n \"data\": { \"containerId\": \"CONT-BARCODE-001\" }\n },\n {\n \"type\": \"S321_SUBMITTED\",\n \"description\": \"Package S321 Submitted\",\n \"time\": \"2024-01-14T09:30:00Z\"\n },\n {\n \"type\": \"S321_ACCEPTED\",\n \"description\": \"Package S321 Accepted\",\n \"time\": \"2024-01-14T10:15:00Z\",\n \"data\": { \"status\": \"1A2\" }\n },\n {\n \"type\": \"CLEARED\",\n \"description\": \"Package Cleared\",\n \"time\": \"2024-01-15T14:20:00Z\",\n \"data\": { \"status\": \"CLR\" }\n }\n ]\n}"}],"_postman_id":"3060b494-2c9f-4ad8-92ac-94ab5f55e0b2"},{"name":"Get Package Tracking – by externalId (query param)","id":"9ec893ce-98c7-469d-a475-f196676c7a41","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Accept-Encoding","value":"gzip, deflate"},{"key":"Authorization","value":"{{auth_secret_0euv}}"}],"url":"https://api.safepackage.com/v1/tracking/package?externalId=PKG-EXT-001","description":"

Get Package Tracking (by externalId)

\n

Use externalId as a query parameter when the SafePackage packageId is not available.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{auth_secret_0euv}}"}]},"isInherited":true,"source":{"_postman_id":"5faf80cd-32ab-4646-8e39-6a344a916230","id":"5faf80cd-32ab-4646-8e39-6a344a916230","name":"SafePackage","type":"collection"}},"urlObject":{"path":["v1","tracking","package"],"host":["https://api.safepackage.com"],"query":[{"description":{"content":"

Required when packageId is not provided.

\n","type":"text/plain"},"key":"externalId","value":"PKG-EXT-001"},{"disabled":true,"key":"format","value":""}],"variable":[]}},"response":[],"_postman_id":"9ec893ce-98c7-469d-a475-f196676c7a41"},{"name":"Get Shipment Tracking – by shipmentId (route)","id":"309282dc-86df-497c-8e5a-3a5c3aba6d4c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Accept-Encoding","value":"gzip, deflate"},{"key":"Authorization","value":"{{auth_secret_0euv}}"}],"url":"https://api.safepackage.com/v1/tracking/shipment/SP-SHIP-00000123","description":"

Get Shipment Tracking

\n

Route Parameter

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypePresenceDescription
shipmentIdstringoptionalSafePackage shipment identifier
\n

Query Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypePresenceDescription
shipmentIdstringoptionalAlternative to route param
externalIdstringconditionalRequired if shipmentId not provided
formatstringoptionalFormat for additional tracking data
\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
FieldTypePresenceDescription
shipmentIdstringRequiredSafePackage shipment identifier
events[]arrayRequiredChronological event list
events[].typestringRequiredStandardized event type
events[].descriptionstringRequiredEvent description
events[].timestringRequiredISO 8601 event timestamp
events[].dataobjectOptionalAdditional event data
\n

Shipment Event Types

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescriptiondata
MASTER_HELDShipment held by customsstatus
MASTER_HOLD_REMOVEDShipment hold removedstatus
LOCAL_TRANSFER_AUTHORIZEDLocal transfer authorisedstatus
MASTER_STATUSNew customs statusstatus
PICKUP_REQUESTEDPickup requested—
\n
","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{auth_secret_0euv}}"}]},"isInherited":true,"source":{"_postman_id":"5faf80cd-32ab-4646-8e39-6a344a916230","id":"5faf80cd-32ab-4646-8e39-6a344a916230","name":"SafePackage","type":"collection"}},"urlObject":{"path":["v1","tracking","shipment","SP-SHIP-00000123"],"host":["https://api.safepackage.com"],"query":[{"disabled":true,"description":{"content":"

Optional. Format for additional tracking data.

\n","type":"text/plain"},"key":"format","value":""}],"variable":[]}},"response":[{"id":"648981db-f5b8-4474-b506-e5329ff1d5a1","name":"Success","originalRequest":{"method":"GET","header":[],"url":"https://api.safepackage.com/v1/tracking/shipment/SP-SHIP-00000123"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"shipmentId\": \"SP-SHIP-00000123\",\n \"events\": [\n {\n \"type\": \"PICKUP_REQUESTED\",\n \"description\": \"Shipment Pickup Requested\",\n \"time\": \"2024-01-13T14:00:00Z\"\n },\n {\n \"type\": \"MASTER_STATUS\",\n \"description\": \"Shipment Customs Status\",\n \"time\": \"2024-01-15T09:00:00Z\",\n \"data\": { \"status\": \"1C4\" }\n },\n {\n \"type\": \"LOCAL_TRANSFER_AUTHORIZED\",\n \"description\": \"Shipment Local Transfer Authorized\",\n \"time\": \"2024-01-15T11:30:00Z\",\n \"data\": { \"status\": \"1C4\" }\n }\n ]\n}"}],"_postman_id":"309282dc-86df-497c-8e5a-3a5c3aba6d4c"},{"name":"Get Shipment Tracking – by externalId (query param)","id":"88736046-43bd-4c13-9bc3-1b0a2141024d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Accept-Encoding","value":"gzip, deflate"},{"key":"Authorization","value":"{{auth_secret_0euv}}"}],"url":"https://api.safepackage.com/v1/tracking/shipment?externalId=PKG-EXT-001","description":"

Get Shipment Tracking (by externalId)

\n

Use externalId as a query parameter when the SafePackage shipmentId is not available.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{auth_secret_0euv}}"}]},"isInherited":true,"source":{"_postman_id":"5faf80cd-32ab-4646-8e39-6a344a916230","id":"5faf80cd-32ab-4646-8e39-6a344a916230","name":"SafePackage","type":"collection"}},"urlObject":{"path":["v1","tracking","shipment"],"host":["https://api.safepackage.com"],"query":[{"description":{"content":"

Required when shipmentId is not provided.

\n","type":"text/plain"},"key":"externalId","value":"PKG-EXT-001"},{"disabled":true,"key":"format","value":""}],"variable":[]}},"response":[],"_postman_id":"88736046-43bd-4c13-9bc3-1b0a2141024d"}],"id":"8a44cd2f-a7a3-4938-adb8-5c00fe177df0","description":"

Package and shipment tracking endpoints introduced in the Tracking Supplement v1.17.3.

\n

Endpoints:

\n
    \n
  • GET /v1/tracking/package/{packageId} — Package event history
    • \n
  • GET /v1/tracking/shipment/{shipmentId} — Shipment event history
    • \n
\n

Both support lookup by SafePackage ID (route or query param) or by externalId (query param).

\n","_postman_id":"8a44cd2f-a7a3-4938-adb8-5c00fe177df0","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{auth_secret_0euv}}"}]},"isInherited":true,"source":{"_postman_id":"5faf80cd-32ab-4646-8e39-6a344a916230","id":"5faf80cd-32ab-4646-8e39-6a344a916230","name":"SafePackage","type":"collection"}}},{"name":"PGA Reference (NEW v1.27)","item":[{"name":"PGA Schema – APHIS APL (Lacey Act)","id":"924d4830-f792-4093-90e8-6d4207ed190e","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":"{{auth_secret_0euv}}"}],"body":{"mode":"raw","raw":"{\n \"externalId\": \"PKG-PGA-APHIS-001\",\n \"platformId\": \"AMAZON\",\n \"sellerId\": \"seller-store-001\",\n \"exportCountry\": \"CHN\",\n \"destinationCountry\": \"USA\",\n \"houseBillNumber\": \"HB000000010\",\n \"barcode\": \"9400111899223397667400\",\n \"weight\": { \"value\": 2.0, \"unit\": \"K\" },\n \"from\": { \"name\": \"Wood Products Co.\", \"line1\": \"1 Forest Rd\", \"city\": \"Guangzhou\", \"state\": \"Guangdong\", \"postalCode\": \"510000\", \"country\": \"CHN\" },\n \"to\": { \"name\": \"Jane Doe\", \"line1\": \"100 Oak Ave\", \"city\": \"Portland\", \"state\": \"OR\", \"postalCode\": \"97201\", \"country\": \"USA\" },\n \"products\": [\n {\n \"quantity\": 1,\n \"items\": [\n {\n \"declaredValue\": 75.00,\n \"declaredName\": \"Wooden Picture Frame\",\n \"originCountry\": \"CHN\",\n \"mid\": \"MID111222333\",\n \"weight\": { \"value\": 2.0, \"unit\": \"K\" },\n \"tariffStack\": [\n {\n \"hts\": \"4414000000\",\n \"value\": 75.00,\n \"quantities\": [ { \"unit\": \"NO\", \"quantity\": 1 } ]\n }\n ],\n \"pga\": [\n {\n \"agency\": \"APHIS\",\n \"program\": {\n \"code\": \"APL\",\n \"entities\": [\n {\n \"name\": \"Wood Products Co. Ltd.\",\n \"email\": \"compliance@woodproducts.com\",\n \"phone\": \"+86-20-1234-5678\"\n }\n ],\n \"products\": [\n {\n \"codeQualifier\": \"HTS\",\n \"codeNumber\": \"4414000000\",\n \"elements\": [\n {\n \"name\": \"Oak\",\n \"species\": \"Quercus robur\",\n \"genus\": \"Quercus\",\n \"quantity\": 1.5,\n \"unit\": \"KG\",\n \"country\": \"CN\"\n }\n ]\n }\n ],\n \"certifications\": [\n {\n \"entityRoleCode\": \"IM\",\n \"declarationCode\": \"AP6\",\n \"date\": \"2024-01-14\"\n }\n ]\n }\n }\n ]\n }\n ],\n \"product\": {\n \"sku\": \"SKU-WOOD-001\",\n \"url\": \"https://www.example.com/product/wood001\",\n \"name\": \"Wooden Picture Frame\",\n \"description\": \"Handcrafted oak picture frame.\",\n \"price\": 75.00,\n \"images\": [\"\"],\n \"originCountry\": \"CHN\",\n \"hts\": \"4414000000\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.safepackage.com/v1/package/screen","description":"

APHIS – APL (Lacey Act)

\n

Required for products containing plant materials.

\n

pga[] Schema

\n
agency: \"APHIS\"  [required]\nprogram.code: \"APL\"  [required]\nprogram.entities[]  [required]\n  .name  [conditional]\n  .email  [conditional]\n  .phone  [conditional]\nprogram.products[]  [required]\n  .codeQualifier  [conditional]\n  .codeNumber  [conditional]\n  .elements[]  [optional]\n    .name  [conditional]\n    .species  [conditional]\n    .genus  [conditional]\n    .quantity  [conditional]\n    .unit  [conditional]  -- CE unit\n    .country  [conditional]  -- ISO-2\nprogram.certifications[]  [optional]\n  .entityRoleCode  [optional]  -- e.g. \"IM\"\n  .declarationCode  [optional]  -- e.g. \"AP6\"\n  .date  [conditional]\n
","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{auth_secret_0euv}}"}]},"isInherited":true,"source":{"_postman_id":"5faf80cd-32ab-4646-8e39-6a344a916230","id":"5faf80cd-32ab-4646-8e39-6a344a916230","name":"SafePackage","type":"collection"}},"urlObject":{"path":["v1","package","screen"],"host":["https://api.safepackage.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"924d4830-f792-4093-90e8-6d4207ed190e"},{"name":"PGA Schema – FDA (All Programs)","id":"e3800e91-5230-4ec6-abc6-e1db8f9dbc32","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":"{{auth_secret_0euv}}"}],"body":{"mode":"raw","raw":"{\n \"externalId\": \"PKG-PGA-FDA-001\",\n \"platformId\": \"AMAZON\",\n \"sellerId\": \"seller-store-001\",\n \"exportCountry\": \"CHN\",\n \"destinationCountry\": \"USA\",\n \"houseBillNumber\": \"HB000000011\",\n \"barcode\": \"9400111899223397667401\",\n \"weight\": { \"value\": 0.5, \"unit\": \"K\" },\n \"from\": { \"name\": \"Food Exporter Co.\", \"line1\": \"5 Harbor Rd\", \"city\": \"Shanghai\", \"state\": \"Shanghai\", \"postalCode\": \"200000\", \"country\": \"CHN\" },\n \"to\": { \"name\": \"Mike Jones\", \"line1\": \"200 Elm St\", \"city\": \"Austin\", \"state\": \"TX\", \"postalCode\": \"78701\", \"country\": \"USA\" },\n \"products\": [\n {\n \"quantity\": 2,\n \"items\": [\n {\n \"declaredValue\": 20.00,\n \"declaredName\": \"Green Tea Bags\",\n \"originCountry\": \"CHN\",\n \"mid\": \"MID444555666\",\n \"weight\": { \"value\": 0.5, \"unit\": \"K\" },\n \"tariffStack\": [\n {\n \"hts\": \"0902100000\",\n \"value\": 20.00,\n \"quantities\": [ { \"unit\": \"KG\", \"quantity\": 0.5 } ]\n }\n ],\n \"pga\": [\n {\n \"agency\": \"FDA\",\n \"program\": {\n \"code\": \"FOO\",\n \"productCode\": \"GTE\",\n \"processingCode\": \"AC\",\n \"intendedUseCode\": \"081\",\n \"arrival\": \"2024-01-15\"\n }\n }\n ]\n }\n ],\n \"product\": {\n \"sku\": \"SKU-TEA-001\",\n \"url\": \"https://www.example.com/product/tea001\",\n \"name\": \"Premium Green Tea Bags 100pk\",\n \"description\": \"Premium green tea bags from China.\",\n \"price\": 20.00,\n \"images\": [\"\"],\n \"originCountry\": \"CHN\",\n \"hts\": \"0902100000\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.safepackage.com/v1/package/screen","description":"

FDA – All Programs (BIO, COS, DEV, DRU, FOO, RAD, TOB, VME)

\n

The same pga[] schema applies to all FDA program codes.

\n

pga[] Schema

\n
agency: \"FDA\"  [required]\nprogram.code  [required]\n  Allowed: \"BIO\", \"COS\", \"DEV\", \"DRU\", \"FOO\", \"RAD\", \"TOB\", \"VME\"\nprogram.productCode  [conditional]  -- FDA product code\nprogram.processingCode  [conditional]  -- FDA processing code\nprogram.intendedUseCode  [conditional]  -- FDA intended use code\nprogram.arrival  [conditional]  -- ISO 8601 arrival date\n
","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{auth_secret_0euv}}"}]},"isInherited":true,"source":{"_postman_id":"5faf80cd-32ab-4646-8e39-6a344a916230","id":"5faf80cd-32ab-4646-8e39-6a344a916230","name":"SafePackage","type":"collection"}},"urlObject":{"path":["v1","package","screen"],"host":["https://api.safepackage.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e3800e91-5230-4ec6-abc6-e1db8f9dbc32"},{"name":"PGA Schema – CPSC CPS (Product Safety)","id":"63554fd7-96f7-4455-929a-68fe498aeac8","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":"{{auth_secret_0euv}}"}],"body":{"mode":"raw","raw":"{\n \"externalId\": \"PKG-PGA-CPSC-001\",\n \"platformId\": \"AMAZON\",\n \"sellerId\": \"seller-store-001\",\n \"exportCountry\": \"CHN\",\n \"destinationCountry\": \"USA\",\n \"houseBillNumber\": \"HB000000012\",\n \"barcode\": \"9400111899223397667402\",\n \"weight\": { \"value\": 0.8, \"unit\": \"K\" },\n \"from\": { \"name\": \"Toy Factory Co.\", \"line1\": \"10 Toy Lane\", \"city\": \"Dongguan\", \"state\": \"Guangdong\", \"postalCode\": \"523000\", \"country\": \"CHN\" },\n \"to\": { \"name\": \"Sarah Lee\", \"line1\": \"50 Maple Dr\", \"city\": \"Seattle\", \"state\": \"WA\", \"postalCode\": \"98101\", \"country\": \"USA\" },\n \"products\": [\n {\n \"quantity\": 1,\n \"items\": [\n {\n \"declaredValue\": 35.00,\n \"declaredName\": \"Plastic Building Blocks Set\",\n \"originCountry\": \"CHN\",\n \"mid\": \"MID777888999\",\n \"weight\": { \"value\": 0.8, \"unit\": \"K\" },\n \"tariffStack\": [\n {\n \"hts\": \"9503000090\",\n \"value\": 35.00,\n \"quantities\": [ { \"unit\": \"NO\", \"quantity\": 1 } ]\n }\n ],\n \"pga\": [\n {\n \"agency\": \"CPSC\",\n \"program\": {\n \"code\": \"CPS\",\n \"commercialDescription\": \"Plastic interlocking building block toy set for children aged 3+\",\n \"disclaim\": \"A\",\n \"intendedUseCode\": \"010.001\"\n }\n }\n ]\n }\n ],\n \"product\": {\n \"sku\": \"SKU-TOY-001\",\n \"url\": \"https://www.example.com/product/toy001\",\n \"name\": \"Plastic Building Blocks 200pc\",\n \"description\": \"Colourful interlocking building blocks.\",\n \"price\": 35.00,\n \"images\": [\"\"],\n \"originCountry\": \"CHN\",\n \"hts\": \"9503000090\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.safepackage.com/v1/package/screen","description":"

CPSC – CPS (Product Safety)

\n

Required for consumer products regulated by the CPSC.

\n

pga[] Schema

\n
agency: \"CPSC\"  [required]\nprogram.code: \"CPS\"  [required]\nprogram.commercialDescription  [required, max 70 chars]\nprogram.disclaim  [conditional]  -- \"A\", \"B\", or omit\n  Required if agencyProcessingCode is not provided\nprogram.intendedUseCode  [conditional]  -- format \"000.000\"\nprogram.intendedUseDescription  [conditional]\n  Required if intendedUseCode = \"980.000\"\nprogram.agencyProcessingCode  [conditional]  -- \"REF\" or omit\n  Required if disclaim is not provided\nprogram.productId  [conditional]  -- Required if agencyProcessingCode = \"REF\"\nprogram.versionId  [conditional]  -- Required if agencyProcessingCode = \"REF\"\nprogram.certifierId  [conditional]  -- Required if agencyProcessingCode = \"REF\"\n

Rule: Either disclaim OR agencyProcessingCode must be provided — not both, not neither.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{auth_secret_0euv}}"}]},"isInherited":true,"source":{"_postman_id":"5faf80cd-32ab-4646-8e39-6a344a916230","id":"5faf80cd-32ab-4646-8e39-6a344a916230","name":"SafePackage","type":"collection"}},"urlObject":{"path":["v1","package","screen"],"host":["https://api.safepackage.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"63554fd7-96f7-4455-929a-68fe498aeac8"}],"id":"4f539b26-311b-4198-bd53-4f28f82670dc","description":"

PGA (Partner Government Agency) data reference — new in v1.27 via the PGA Data Supplement.

\n

These requests show example pga[] payloads for each supported program. The pga[] array is placed as a sibling of tariffStack[] on each line item.

\n

Supported PGA Agencies

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
CodeAgency
APHISAnimal and Plant Health Inspection Service
FDAFood and Drug Administration
CPSCConsumer Product Safety Commission
FSISFood Safety and Inspection Service
NHTSANational Highway Traffic Safety Administration
NMFSNational Marine Fisheries Service
ATFBureau of Alcohol, Tobacco, Firearms and Explosives
EPAEnvironmental Protection Agency
TTBAlcohol and Tobacco Tax and Trade Bureau
AMSAgricultural Marketing Service (USDA)
FWSFish & Wildlife Service
DEADrug Enforcement Administration
\n

Programs with Full Data Element Schemas

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
AgencyCodeDescription
APHISAPLLacey Act
FDABIOBiologics
FDACOSCosmetics
FDADEVMedical Devices
FDADRUDrugs
FDAFOOFoods
FDARADRadiation Emitting Products
FDATOBTobacco
FDAVMEVeterinary Drugs
CPSCCPSProduct Safety
\n
","_postman_id":"4f539b26-311b-4198-bd53-4f28f82670dc","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{auth_secret_0euv}}"}]},"isInherited":true,"source":{"_postman_id":"5faf80cd-32ab-4646-8e39-6a344a916230","id":"5faf80cd-32ab-4646-8e39-6a344a916230","name":"SafePackage","type":"collection"}}},{"name":"Platform","item":[{"name":"Get Platforms","id":"97dca7ac-a6f3-4e47-b3bb-d72abacffc07","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Accept-Encoding","value":"gzip, deflate"},{"key":"Authorization","value":"{{auth_secret_0euv}}"}],"url":"https://api.safepackage.com/v1/platform","description":"

Get Platforms

\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
FieldTypeDescription
idstringPlatform identifier — use as platformId in requests
urlstringPlatform homepage URL
\n
","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{auth_secret_0euv}}"}]},"isInherited":true,"source":{"_postman_id":"5faf80cd-32ab-4646-8e39-6a344a916230","id":"5faf80cd-32ab-4646-8e39-6a344a916230","name":"SafePackage","type":"collection"}},"urlObject":{"path":["v1","platform"],"host":["https://api.safepackage.com"],"query":[],"variable":[]}},"response":[{"id":"5d730297-338e-4bc0-b476-1c27fd9b4f6f","name":"Success","originalRequest":{"method":"GET","header":[],"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 { \"id\": \"AMAZON\", \"url\": \"https://www.amazon.com\" },\n { \"id\": \"EBAY\", \"url\": \"https://www.ebay.com\" },\n { \"id\": \"ALIEXPRESS\", \"url\": \"https://www.aliexpress.com\" },\n { \"id\": \"SHEIN\", \"url\": \"https://www.shein.com\" },\n { \"id\": \"TEMU\", \"url\": \"https://www.temu.com\" }\n]"}],"_postman_id":"97dca7ac-a6f3-4e47-b3bb-d72abacffc07"}],"id":"f350bdce-5054-4791-b06e-72d18766bc5e","description":"

Retrieve all registered e-commerce platforms.

\n

Endpoint: GET /v1/platform

\n

Use returned id values as platformId in all screening and submission requests.

\n","_postman_id":"f350bdce-5054-4791-b06e-72d18766bc5e","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{auth_secret_0euv}}"}]},"isInherited":true,"source":{"_postman_id":"5faf80cd-32ab-4646-8e39-6a344a916230","id":"5faf80cd-32ab-4646-8e39-6a344a916230","name":"SafePackage","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{auth_secret_0euv}}"}]}},"variable":[{"key":"base_url","value":"https://api.safepackage.com","description":"Switch to https://sandbox.safepackage.com for development"},{"key":"api_key","value":"YOUR_ACCESS_KEY"},{"key":"packageId","value":"SP-PKG-00001234","description":"Replace with a real SafePackage package ID"},{"key":"shipmentId","value":"SP-SHIP-00000123","description":"Replace with a real SafePackage shipment ID"},{"key":"externalId","value":"PKG-EXT-001","description":"Replace with your external ID"},{"key":"auth_secret_0euv","secret":true,"source":{"provider":"postman","postman":{"type":"cloud","secretId":"2703ce3e-4d75-4d16-ac44-f55cd6b27473","vaultId":"5d5933de-cc3c-4502-aaf4-e84353e984b9"}}}]}