Jump to Content
Shipium API
GuidesRecipesAPI ReferenceChangelogDiscussions
Log InShipium API
Guides
Log In
GuidesRecipesAPI ReferenceChangelogDiscussions

GETTING started

  • Introduction
  • Get Started with Shipium
  • Your Shipium Account
    • Account Users and Roles
    • Log-In and Password
  • Authentication
    • API Key-Based Authentication
    • OAuth 2.0-Based Authentication
    • Create API Credentials
    • Use Your API Credentials with Postman
    • SSO for Your Shipium Account
      • Configure SSO with Okta
    • Certificate Authorities and Certificate Pinning

Shipium Console

  • Shipium Console Introduction
  • Console Configuration
  • Carrier Selection Configuration
    • Carrier Accounts
    • Carrier Service Methods
    • Carrier Limits
    • Label Settings
    • Package Sizes
    • Rate Tables
    • Surcharge Modifiers
    • Tenants
  • Fulfillment Contexts
    • Origins
    • Carrier Contracts
    • Label Configuration
    • Third Party Billing
    • Injection
    • Shipment Lanes
  • Print Labels
  • Reporting Applications
    • Export Shipment Data
    • Reporting Configuration
    • Reporting Content
    • Order-to-Deliver Reporting

shipium api Guidance

  • APIs Introduction
    • API Response Codes
  • Shipium's APIs
    • Address Validation API
    • Batch Label Creation API
    • Carrier and Method Selection API
    • Carrier and Method Selection & Shipment Label API
    • Configuration APIs
      • Origin Configuration API
      • Origin Schedule Configuration API
    • Delivery Promise APIs
      • Product View Delivery Promise API
      • Cart Checkout Delivery Promise API
    • Fulfillment Engine API
    • LTL (Less Than Truckload) APIs
      • LTL Shipment Cost API
      • LTL Shipment Cost Compare API
    • Packaging Planner API
    • Return Label API
    • Shipment Label API
    • Shipment Planning API
    • Shipment Tracking API
    • Shipment Tracking Registration API

Delivery promise

  • Delivery Promise
  • Shipment Planning
  • Time in Transit Estimations

fulfillment engine

  • Fulfillment Engine

Shipments & packaging

  • Address Validation
  • Packaging Planner

carrier network

  • Carrier Network
    • Amazon
    • AMPM
    • Canada Post
    • Cirro
    • DHL
    • Envoi
    • Estafeta
    • FedEx
    • Global-e
    • LaserShip
    • Paquetexpress
    • Uber Direct
    • UPS
    • USPS
  • Supported Carriers

carrier selection & Label service

  • Carrier and Method Selection & Shipment Labels
  • Carrier and Method Selection
    • Additional Days to Hold a Shipment
    • Bill a Third Party
    • Bound Printed Matter
    • Business Days of Transit
    • Cancel a Shipment
    • Carrier Failover
    • Carrier Selection Rules
    • Customs Info for Shipments
      • Broker & Importer of Record
    • Desired, Exact, & Guaranteed Delivery Dates
    • Evaluated Service Methods
    • Hazardous Materials
    • Hundredweight
    • Label to Dock Door Hours
    • LTL (Less Than Truckload) Shipments
    • Manifest Shipments
    • Multi-Parcel Shipments
    • Non-US Address Formats
    • Partial (Multi-Step) Shipments
    • Peak and Other Carrier Surcharges
    • Perishable Items
    • Reference Fields and Carrier Mappings
    • Schedule and Shipment Limits
      • Shipment Count Limits
      • Shipment Cost Limits
      • Carrier Schedule
      • Dynamic Shipment Count Limits
    • Ship Options
      • Configurable Ship Options
      • Shipium Default Ship Options
    • Special Processing Properties
    • Specify Carrier Service and Method
    • Specifying Payors
    • Tax Identification Number
  • Shipment Labels
    • Label Customization
      • Common Label Augmentations
    • Label Test Mode
    • Labels without Costing
    • Return Labels
    • Void a Label
  • Webhooks for Carrier Selection & Label Updates

track & trace

  • Track and Trace
  • Track Shipments
  • Track Non-Shipium Shipments
  • Use Webhooks for Tracking
  • Shipment File Transfers

simulation

  • Simulation

REPORTING & ANALYTICS

  • Reporting Product Overview
    • Delivery Speed Dashboards
    • Label Failovers Dashboards
    • Label Generation Dashboards
    • On-Time Performance Dashboards
    • Rate Shop Selections Dashboards
    • Selected vs. Evaluated Dashboards
    • Shipment Cost Breakdown Dashboards

Support

  • Contact Shipium Support
  • Shipium Service Status
  • Terms and Definitions
  • Troubleshooting Guide

Shipium Javascript Local API

  • Overview of Shipium Javascript Local API
  • Integration into Your Site
  • API Listing
  • Get a Delivery Estimate
  • Register a Customer Order

API Listing

Suggest Edits

Overview

The API is split on the basis of the sets of available APIs. There is a link below to each of the major JavaScript local API sections, each based on the corresponding Shipium feature that they help enable.

The APIs

  • Delivery Estimates - Get a Delivery Estimate
  • Registering Customer Orders - Register a Customer Order
  • Shipment Planning API - Shipment Planning API

Updated 5 months ago


  • Table of Contents
    • Overview
    • The APIs