Jump to Content
Sapient Developers Hub
HomeDocumentationAPI RecipesAPI ReferencesRelease Notes
Log InSapient Developers Hub
Documentation
Log In
HomeDocumentationAPI RecipesAPI ReferencesRelease Notes
All
Pages
Start typing to search…

🏁 GET STARTED

  • Welcome to SAPIENT Developers Hub
    • Getting Started with SAPIENT API
  • Activate integration
  • Authentication
    • Generate bearer token
  • API Rate Limiting
  • Sandbox vs Production account
  • Troubleshooting

🚧 USER GUIDES

  • System user guides
  • Authorisation
    • Log in to SAPIENT
    • Change password
    • Reset password
    • Log out
    • Guidelines for choosing strong password
    • Role-based access to SAPIENT actions
  • Interaction with SAPIENT UI
    • Application header
    • Top toolbar
    • Side navigation panel
    • Contents panel
    • Table
    • Pagination bar
    • Search and filter bar
  • Dashboard
  • Search shipments
  • Shipment processing
    • Cancel shipment
    • Recall shipment
    • Hold shipment
    • Release shipment
    • Manifest shipment
    • View manifest history
  • Maintenance
    • Shipping account
      • Add Shipping Account
      • Edit shipping account
      • Delete shipping account
    • Shipping location
      • Add Shipping Location
      • Edit shipping location
      • Link shipping location to existing shipping account
      • Delete shipping location
    • Product
      • Add product
      • Edit product
      • Delete product
    • User
      • Add user
      • Edit user
      • Delete user
    • Address book
      • Add address
      • Edit address
      • Delete address
    • Customs settings
      • Add pre-registration number
      • Add VAT and EORI number
      • Add signature and logo
    • API
      • Create API Credentials
    • Integrations

📦 Shipment creation and manifesting workflows

  • Shipment creation and manifesting
    • Create shipments with Allocate action
    • Create shipments with Create action
    • Create shipment with Process action
    • Defer shipments
    • Manifest shipments in a container
    • Manifest shipments by picked status
    • Manifest shipments asychronously
  • Windsor Framework: A new trade regulation between Great Britain and Northern Ireland
    • Windsor Framework FAQs

WEBHOOK USER GUIDES

  • Webhooks
    • Add tracking account
    • Set up tracking webhook connection
    • Track events and milestones
    • Set up manifest webhook
    • Handle webhook suspension

HURRICANE COMMERCE SERVICES USWR GUIDES

  • Hurricane commerce services
    • Configure Hurricane commerce service
    • Commodity code validations
    • Quoted landed cost
    • Prohibited and restricted items
    • Prohibited and restricted export codes
    • Prohibited and restricted import codes
    • Denied parties

SAPIENT CARRIER INTEGRATION GUIDES

  • SAPIENT carrier integration GUIDES
  • Royal Mail
    • Set up Royal Mail online business account (OBA)
    • Add Royal Mail shipping account
    • Royal Mail OBA account validation and sign-off
    • Add Royal Mail tracking account
    • BFPO shipments
    • Return shipments
    • Use pre-allocated tracking number
    • Use collection service
    • Use PUDO service
    • Generate hazmat (ID8000) label for Class 9 hazardous goods
    • Royal Mail validation rules
    • Royal Mail Parcel Force services
    • Royal Mail import service
      • API development requirements for Sandbox
      • Import requirements for Commercial Clearance customers
      • Import requirements for Freight 2 Post customers
      • Field requirements for Freight 2 Post customers
      • Sandbox Test Pack for Royal Mail import service
      • Switch account to production
      • Set up International Arrival Containers
      • International Arrival Containers (A-Scan) flow
      • A-Scan FAQs
      • Combined label + CN22
  • An Post
    • Add An Post shipping account
    • Add An Post tracking account
    • Add barcode range to An Post shipping account
  • DPD Netherlands (NL)
    • Add DPD NL shipping account
    • Add DPD NL tracking account
  • DPD UK
    • Add DPD UK shipping account
    • Add DPD UK tracking account
  • DX Express
    • Add DX Express shipping account
    • DX Express sign-off
    • Add DX Express tracking account
    • DX Rate Limiting
    • Obtain DX API credentials
  • DX Freight
    • Add DX Freight shipping account
    • DX Freight sign-off
    • Add DX Freight tracking account
  • EVRi
    • Add EVRi shipping account
    • Add child client department to parent shipping account
    • Add EVRi tracking account
  • FedEx
    • Add FedEx shipping account
    • Specify shipping account details
    • Confirm FedEx end user license agreement
    • Specify shipping address details (MFA stage 1)
    • Initiate Multi-factor authentication process (MFA stage 2)
    • Edit FedEx shipping account
    • Configure ETD for FedEx shipping account
    • Add FedEx tracking account
  • InPost
    • Add InPost shipping account
    • InPost PUDO service
    • InPost sign-off
    • Add InPost tracking account
  • The Delivery Group
    • Add The Delivery Group shipping account
    • The Delivery Group sign-off
    • Add The Delivery Group tracking account
  • UPS (United Parcel Service)
    • Add UPS shipping account
    • Add UPS tracking account
  • YODEL
    • Add YODEL shipping account
    • Add YODEL tracking account

📖 glossary

  • Glossary

Archived release notes

  • SAPIENT archived release notes
    • 2024 release notes
    • 2023 release notes
    • 2025 release notes

SAPIENT archived release notes

In this section, you can view the release notes that have been previously deployed on Readme.

  • 2025 release notes
  • 2024 release notes
  • 2023 release notes

Updated 6 months ago


What’s Next
  • Latest release notes