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

Overview

  • Introduction
  • Which Shipium APIs Should I Use?
  • Getting Started with Shipium
  • Authentication
    • Creating API Credentials
    • API Key-Based Authentication
    • OAuth 2.0-Based Authentication
    • Using Your API Credentials with Postman

Delivery Experience REST API

  • Which Delivery Experience Flow Should I Use?
  • Delivery Experience Flow: Using Delivery Estimates
    • Product View (Delivery Estimate-Based)
    • Order (Delivery Estimate-Based)
    • Shipment (Delivery Estimate-Based)
    • Delivery (Estimate-Based)
  • Delivery Experience Flow: Order-Based
    • Order (Order-Based)
    • Shipment (Order-Based)
    • Delivery (Order-Based)

Shipium Tracking API

  • Shipium Tracking API Overview
  • Carrier Tracking Search API Details
  • Tracking Non-Shipium Shipments

Shipium Subscription Timing API

  • Subscription Timing API Overview
  • Subscription Timing API Details

Shipium Package Sizing

  • Package Sizing Flow
  • Package Sizing Audit

Shipium Carrier Selection

  • Carrier and Method Selection Flow
  • List of canonical carrierId and carrierServiceMethodId values
  • About Reference Fields and Carrier Mappings

Shipium Carrier Label Service

  • Carrier Shipment Label Flow
    • Carrier Shipment Label Custom Label Augmentations
  • Carrier and Method Selection with Label Single Call
  • Voiding a Specific Label
  • Shipium Carrier Return Label Service
  • Carrier Failover
  • Shipment Ship Option Overview
  • Hazardous Materials Support
  • Shipment Special Processing Properties
  • Fulfillment Context
  • Desired Delivery Date
  • Specifying Carrier Service and Method
  • Understanding Carrier Selection Label Test Mode
  • Customs Info API Example & Definitions

Shipium Console Application

  • Before You Begin
  • Introduction to Common Shipium Terms
  • Log-in and Password Reset
  • Shipium Console Overview
    • Shipium Console Sidebar
    • Shipium Console Top Navigation
    • Shipium Console Body
  • Shipium Reporting Applications
    • Shipium Reporting Configuration
    • Shipium Reporting Content
    • Shipium Order-to-Deliver Reporting
    • Shipium Configuration
  • Managing Users and Roles
  • Shipium Basic Configuration
    • Shipium Carrier Selection Configuration
    • Shipium Carrier Selection: Adding a Carrier Account
    • Shipium Carrier Selection: Adding a Carrier Service Method
    • Shipium Carrier Selection: Adding a Rate Table
    • Shipium Carrier Selection: Setting Surcharge Modifiers
    • Shipium Carrier Selection: Label Configuration
    • Shipium Carrier Selection: Adding Label Augmentations
    • Shipium Carrier Selection: Configuring Package Sizes
  • Shipium Carrier Selection Applications
  • Shipium Carrier Selection - Carrier Limits
    • Shipium Carrier Limits - Basics
    • Shipium Carrier Limits - Setting Limits
  • Shipium Service Status
  • Printing from the Shipium Console Application

Shipium Javascript Local API

  • Overview of Shipium Javascript Local API
  • Integration into Your Site
  • API Listing
  • Getting a Delivery Estimate
  • Registering a Customer Order
  • Subscription Timing API

Terminology guide

  • Common Terms and Definitions

Support

  • Contacting Shipium Support
  • Troubleshooting guide
Powered by 

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 - Getting a Delivery Estimate
  • Registering Customer Orders - Registering a Customer Order
  • Subscription Timing API - Subscription Timing API

Updated about 1 year ago

  • Table of Contents
      • Overview
    • The APIs