Terms and Definitions
Learn definitions for Shipium's common terminology.
About Shipum terms and definitions
This section explains common terms used in our documentation, and also some of the common OAuth terminology we use. OAuth is an authentication protocol that allows users to approve one application interacting with another on their behalf without having to use a password.
Common Shipium terms
This table explains some common terms used throughout our documentation.
| Term | Definition |
|---|---|
| Application Programming Interface (API) | A software interface that enables two or more computer programs to communicate with each other |
| Business Days of Transit (BDOT) | The number of business days (excluding weekends and holidays) used to calculate an estimated delivery date. BDOT is specified in API calls to determine how many transit days a shipment is allowed before the system selects a carrier that meets the window. See Time in Transit Estimations. |
| Carrier Selection | The Shipium service that evaluates available carrier service methods and selects the best option for a shipment based on cost, delivery time, ship option, carrier rules, and fulfillment context configuration. Carrier Selection can be called to return a carrier recommendation only, or to return a carrier recommendation and generate a shipping label in a single API call. See Carrier and Method Selection. |
| Customer or Subscriber Customer | One of your organization's customers (a customer of one of Shipium's partners); for instance, when you provide an estimated delivery date for a product on your website, you're displaying this information to your customer. |
| Delivery Estimate or Estimated Delivery Date (EDD) | The date when a shipment is expected to be delivered to your organization's customer, calculated by Shipium's Delivery Promise service using a hierarchy of time in transit (TNT) sources. See Delivery Promise. |
| Delivery Estimate ID | ID that is returned as part of the response from Carrier Selection. This ID is used to track a given product view through to order, shipment, and delivery. |
| Delivery Promise | A Shipium service that calculates an estimated delivery date (EDD) for a shipment before it is created. Delivery Promise is typically called at the product detail page or cart checkout stage to display delivery estimates to customers, and uses a hierarchy of TNT sources — Shipium ML models, partner overrides, and carrier defaults — to generate estimates. See Time in Transit Estimations. |
| Desired Delivery Date (DDD) | The date by which an organization specifies a shipment must be delivered. When included in a carrier selection API call, Shipium filters for carrier service methods that can meet the required delivery window. See Desired, Exact, and Guaranteed Delivery Dates. |
| Electronic Export Information (EEI) | A filing required by U.S. Customs and Border Protection for certain export shipments. When required, EEI can be filed directly through Shipium or via the Automated Export System (AES). See Customs Info for Shipments. |
| Emergency Response Info Provider (ERIP) | A company that provides 24-hour emergency contact services for hazardous materials shipments, as required by certain carriers. ERIP contact details can be included in the emergencyResponseInfo object in your shipment request. See Hazardous Materials. |
| Exact Delivery Date (ExDD) | Specifying an exact delivery date results in selection of the carrier service method that will meet the DDD included in your request exactly, without constraints around cost upgrades. |
| Fulfillment Center (FC) | A warehouse from which your stock is shipped |
| Fulfillment Context | Your organization may have different carrier accounts or other behavior changes within a single fulfillment center — for example, multiple carrier accounts to simplify accounting if you ship on your own behalf and for 3PL customers. The Fulfillment Context groups these configurations so that the appropriate carrier accounts, rate tables, label augmentations, and other settings are applied to each API call. See Configure | Fulfillment Contexts. |
| Injection Site | A physical carrier sort center where line-haul trucks deliver shipments from a fulfillment center for final-mile carrier pickup. Using an injection site reduces carrier zones and decreases transit times by moving packages closer to their destination before the carrier takes possession. See Injection. |
| Limited Quantity (LQ) | A hazardous materials (hazmat) classification covering small quantities of dangerous goods packaged in accordance with specific regulatory exemptions. Limited quantity shipments require less documentation than fully regulated hazmat shipments but are generally restricted to ground-only transport. Indicated on packages with a diamond-shaped LQ symbol. See Hazardous Materials. |
| Order Management System (OMS) | Utilized for order entry and processing |
| Origin | A fulfillment location configured in the Shipium platform. Each origin is associated with carrier contracts, carrier schedules, and rate tables that determine which carriers and service methods are available for shipments departing from that location. See Origins. |
| Packaging Planner | Selects optimal packaging for your shipments |
| Pack Application | The Shipium Pack Application (Pack App) enables you to ship packages from your pack stations within your warehouse management system. |
| Partner | An organization that has Delivery Promise, Fulfillment Engine, Carrier Selection, Label Service, and/or Track and Trace services contracted with Shipium |
| Shipium Console | Our platform via which account requirements and preferences are set up and network configurations are managed |
| Shipment Detail Page (SDP) | The view in the Shipium Console that displays the complete history of a single shipment — from the initial API request through final delivery — including status timeline, raw JSON request and response, label management options, and carrier selection details. Accessible by selecting any shipment ID or tracking number in the Console. See Delivery Reporting | Shipment Search. |
| Shipment Lane | Shipium supports configuration of shipment lanes to help you manage which package goes onto which trailer on the same calendar day for the same carrier service method. |
| Ship Option | A high-level description of a type of shipping that has been shown to your customer; this generally describes a shipping time that your customer has been told to expect, such as "Standard" or "Next Day". |
| Tenant | A customer on whose behalf your organization provides shipping services |
| Third Party Logistics (3PL) | Shared/externally managed warehouse location or company |
| Time in Transit (TNT) | The number of days a shipment is estimated to spend in transit from the point of shipping to delivery. Shipium calculates TNT using ML models, partner overrides, or carrier defaults, applied in a configurable hierarchy. See Time in Transit Estimations. |
| Track and Trace | A Shipium service that retrieves the current status and full event history for one or more shipments using carrier-provided tracking IDs. Shipium normalizes tracking data from multiple carriers into consistent status categories. See Track and Trace. |
| Transportation Management System (TMS) | A software system utilized to manage physical goods transport logistics |
| Warehouse Management System (WMS) | Utilized for inventory visibility and supply chain operations |
| Zebra Programming Language (ZPL) | A programming language used to generate shipping labels for Zebra thermal printers. ZPL is the standard label format in warehouse environments and is one of the label output formats Shipium supports alongside PDF and PNG. |
OAuth terminology
For convenience, some common OAuth terminology is briefly outlined below. Definitions below come from oauth.net. For more details, please see Oauth 2.0 Servers.
OAuth term | Definition |
|---|---|
Access Token | The element that applications use to make API requests on behalf of a user; the access token represents the authorization of a specific application to access specific parts of a user’s data. |
Authorization Server | The resource server hosts the protected user accounts. The authorization server verifies the identity of the user, then issues access tokens to the application. |
Client | The application that wants to access the user’s account; before it may do so, it must be authorized by the user, and the authorization must be validated by the API. |
Client Credentials | Applications themselves have to be authenticated and have their own credentials (e.g., username and password). This is to stop third parties from gaining access. |
Grant Type | This is used to tell the Authorization server the type of workflow it will run to verify the credentials. Password and refresh_token, respectively, are used to get a new token or refresh one that has already been released. |
Refresh Token | The Refresh Token grant type is used by clients to exchange a refresh token for an access token when the access token has expired. This allows clients to continue to have a valid access token without further interaction with the user. Note: For programmatic access, refresh tokens are not used and a new token must be retrieved. |
Resource Owner/User | The user who authorizes an application to access their account; the application’s access to the user’s account is limited to the scope of the authorization granted (e.g., read or write access). |
Resource Server | The resource server handles authenticated requests after the application has obtained an access token. |
Token Store | Tokens that have been released may be used across many systems. They are stored in a central easy-to-look-up location, or Token Store, behind the scenes of an API. |
User Credentials | The actual username and password entered by the user |
Resources
Your Shipium team member is available to help along the way. However, you might find these other resources helpful:
Updated 10 days ago
