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
  • Activate integration
  • Authentication
    • Generate bearer token
  • API Rate Limiting
  • Sandbox vs Production account
  • Troubleshooting

🚧 USER GUIDES

  • Authorisation
    • Log in to SAPIENT
    • Change password
    • Reset password
    • Log out
    • Guidelines for choosing strong password
  • 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
    • Manifest history
  • Maintenance
    • Shipping account
      • Add Shipping Account
      • Edit shipping account
      • Delete shipping account
    • Shipping location
      • Add Shipping Location
      • Edit shipping location
      • Delete shipping location
    • Product
      • Add product
      • Edit product
      • Delete product
    • User
      • Add user
      • Edit user
      • Delete user
      • Role-based access to SAPIENT actions
    • 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
  • Windsor Framework: A new trade regulation between Great Britain and Northern Ireland
    • Windsor Framework FAQs

📊 Additional services guides

  • Additional services user guides
    • Webhooks
      • Set up tracking account
      • Set up tracking webhook connection
      • Track events and milestones
      • Webhook suspension
    • 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

🚚 carrier specific guides

  • Carrier specific user guides
    • 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
      • Internation arrival containers (A-Scan) flow
      • A-Scan FAQs
      • Combined label
    • Royal Mail
      • Set up Royal Mail online business account (OBA)
      • Add Royal Mail shipping account
      • Royal Mail sign-off
      • Add Royal Mail tracking account
      • BFPO shipments
      • Return shipments
      • Use pre-allocated tracking number
      • Use collection service
      • Set up PUDO data via SFTP
      • Use local collect shipment service
    • EVRi
      • Add EVRi shipping account
      • Add EVRi tracking account
    • YODEL
      • Add YODEL shipping account
      • Add YODEL tracking account
    • UPS (United Parcel Service)
      • Add UPS shipping account
      • Add UPS tracking account
    • DX Express
      • Add DX Express shipping account
      • Add DX Express tracking account
      • DX Rate Limiting
      • Obtain DX API credentials
      • DX Express sign-off
    • DX Freight
      • Add DX Freight shipping account
      • Add DX Freight tracking account
      • DX Freight sign-off

📖 glossary

  • Glossary

Archived release notes

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

Client Id and Child Clinet Id management

Updated 3 months ago


Welcome to SAPIENT Developers Hub