Glossary Guide

Welcome to the Glossary Guide, a comprehensive resource to help you understand and navigate through the world of shipping APIs and related terms. Whether you're a developer integrating shipping functionalities into your applications or a business owner seeking to optimize your shipping processes, this guide is here to provide clarity.

From Address Validation API to Webhooks, we've compiled a list of key terms and their descriptions to demystify the jargon associated with shipping and API integration. Learn about essential concepts like Authentication, Rate Limiting, and Response, and explore APIs such as Shipment API, and Tracking API.

Discover the meaning behind dimensional pricing, girth, manifest, and much more. Our concise definitions will help you grasp the core concepts and gain a solid foundation in the shipping API domain.

Whether you're a novice or an experienced professional, this glossary guide will be your go-to resource for understanding the terminology and functionality of shipping APIs. Let's dive in and unlock the power of seamless shipping integration!

Entity	Description
Address Validation API	An API that validates and standardizes addresses to ensure accuracy and compatibility with shipping systems. It can verify the existence and correctness of addresses, correct formatting errors, and provide suggestions for improvement.
API (Application Programming Interface)	A set of rules and protocols that allow different software applications to communicate and interact with each other.
Authentication	The process of verifying the identity of a user or application accessing an API. It typically involves providing credentials such as API keys, tokens, or OAuth tokens to authenticate and authorize access to specific API resources.
bearerAuth	Bearer authentication, also known as bearer token authentication, is a type of authentication scheme used in web applications. In this method, a bearer token is issued by the server upon successful authentication of the user. The token is then included in subsequent requests to the server to access protected resources. The bearer token serves as proof of the authenticated user's identity and authorization, allowing them to access the requested resources without needing to present additional credentials for each request.
Carrier	A shipping company or logistics provider that transports goods from one location to another.
Cross-Border Delivery Service	The PB Cross-Border Delivery Service (CBDS) ships both internationally and domestically and ensures parcels comply with international regulations.
Cubic Pricing	Rates based on parcel size and shipping distance instead of on parcel weight.
Delivery Line	The portion of the address that includes any of the following: street name, street number, apartment number, PO BOX, secondary address, urbanization name. This is also called the delivery address line.
Delivery Point	In the US Postal System, a delivery point is a specific set of digits between 00 and 99 assigned to every address.
Dimensional (DIM) Weight Pricing	Applies to parcels that are large and relatively light for their sizes. Rates are based on volume and a volumetric divisor.
Error Handling	The process of detecting and managing errors that occur during API interactions. API error responses typically include error codes, messages, and recommended actions to help developers diagnose and resolve issues.
Girth	"Girth is a parcel measurement calculated by the following equation: girth = 2 * ( height + width )"
Importation Costs	The duties and taxes charged at a destination country’s border. Importation costs might also include a disbursement fee.
Induction Postal Code	The postal code where a shipment or shipments are tendered to a carrier. This can be different from the Sender’s address.
Label API	An API that generates shipping labels or waybills for a given shipment. It typically includes information such as sender and recipient addresses, package details, and carrier-specific barcode or tracking information.
Last Line	The city, state, and postal code portion of an address.
Manifest	An end-of-day document that combines all the days shipments on a single form or electronic record, depending on the carrier.
Merchant	A shipper within the Pitney Bowes system. When you print a label through the APIs, you do so on behalf of a merchant.
QR code	A two-dimensional barcode used to print a shipping label.
Rate API	An API that allows users to retrieve shipping rates and charges for a specific carrier based on factors such as package weight, dimensions, origin, and destination.
Rate Limiting	A mechanism employed by APIs to restrict the number of API requests that can be made within a certain time frame. Rate limiting helps prevent abuse or overload of the API and ensures fair usage among different users.
Request	A call or message sent to an API endpoint by a client application, requesting a specific action or information.
RESTful API	An API that follows the principles of Representational State Transfer (REST) architectural style. RESTful APIs use standard HTTP methods (GET, POST, PUT, DELETE) to perform actions on resources identified by URLs (Uniform Resource Locators).
Response	The data or information returned by an API after processing a request. API responses may include status codes, headers, and the requested data in a structured format such as JSON or XML.
Sandbox or Test Environment	A simulated environment provided by shipping APIs for developers to test and experiment with API functionalities without affecting live or production data. It allows developers to ensure proper integration and functionality before deploying in a live environment.
SDK (Software Development Kit)	A collection of software tools, libraries, and documentation provided by API providers to assist developers in building applications that integrate with the API.
Shipment API	An API that provides functionality to create, manage, and retrieve shipment details. It may include features such as address validation, pickup scheduling, and customs documentation generation.
Shipping API	An API specifically designed to facilitate communication between software systems and shipping carriers or logistics providers for various shipping-related tasks.
Soft Pack	A flexible package that adheres and conforms to the item being packaged.
Tracking API	An API that enables users to track the status and location of a shipment in real-time by providing a tracking number or other unique identifier.
Transportation Cost	The international shipping charges and any accessorial charges.
Webhooks	A mechanism provided by APIs to send real-time notifications or data updates to a specified URL or endpoint. Webhooks are used to inform external systems about events or changes that occur within the shipping process, such as package delivery or tracking updates.

BypassAddressValidation:

bypassAddressValidation is an optional parameter used during shipment creation to skip the address validation process. When enabled, the system does not validate the provided address fields. This feature is useful for scenarios where address validation might not be necessary or if the addresses are guaranteed to be accurate by the user. Possible values are:

fromAddress
toAddress
fromAndToAddress

Copy

Copied

{
  "bypassAddressValidation": "toAddress"
}

AlternateReturnAddress:

altReturnAddress is an optional parameter used to specify an alternate return address that is different from the sender's address (fromAddress). This is useful when a package shipped from Location_A to Location_B needs to be returned to Location_C. The alternate return address will be printed on the shipping label and for V2 Create shipment it is supported by FedEx, UPS, and Purolator.

Copy

Copied

{
  "altReturnAddress": {
    "addressLine1": "27 Waterview Dr",
    "addressLine2": "near abc street",
    "addressLine3": "near xyz street",
    "company": "PB",
    "email": "testuser@gmail.com",
    "cityTown": "Shelton",
    "countryCode": "CA",
    "name": "Paul Wright",
    "phone": "203-555-1213",
    "postalCode": "06484",
    "stateProvince": "CT"
  }
}

Carrier Payments:

carrierPayments is an optional parameter used to specify payment details when one or more shipment costs need to be charged to a third-party account. This field is supported by carriers such as FedEx, UPS, DHL Express, CPC, and Purolator. Each payment entry defines the responsible party and the type of charge being billed. Supported Roles for party:

BILL_RECEIVER: The receiver is responsible for the charge.
BILL_SENDER: The sender is responsible for the charge.
BILL_THIRD_PARTY: A third-party account is responsible for the charge.
BILL_RECEIVER_CONTRACT: The receiver is responsible for the charge under a contract.

Supported Charge Types:

TRANSPORTATION_CHARGES: Costs related to the transportation of the shipment.
DUTIES_AND_TAXES: Costs related to duties and taxes.
ALL_CHARGES: All shipment-related costs, including transportation and duties.

Copy

Copied

{
  "carrierPayments": [
    {
      "accountNumber": "123456789",
      "countryCode": "US",
      "party": "BILL_THIRD_PARTY",
      "postalCode": "30305",
      "typeOfCharge": "TRANSPORTATION_CHARGES"
    }
  ]
}

DeliveryCommitment:

The deliveryCommitment object contains detailed information about the estimated delivery timeline, including any guarantees or commitments provided by the carrier. It is included in the response for specific APIs.

Copy

Copied

{
  "deliveryCommitment": {
    "additionalDetails": "Thu, Nov 14 by 6:00 PM",
    "estimatedDeliveryDateTime": "2024-11-14 18:00:00.000",
    "guarantee": "FULL",
    "maxEstimatedNumberOfDays": "2",
    "minEstimatedNumberOfDays": "2"
  }
}

Third Party Address

The thirdPartyAddress object specifies a location associated with a shipment that is neither the sender's (fromAddress) nor the receiver's (toAddress) address. It is used for routing shipments through an intermediary location, such as a warehouse, processing center, or designated third-party logistics facility. This address is required specifically for LaserShip-supported shipments when such intermediary handling is needed.

Purpose of ThirdPartyAddress:

Warehouse Returns: Direct returns to a third-party warehouse instead of the sender's address.
Billing Operations: Specify a location for managing payment responsibilities or third-party billing.
Logistics Processing: Route shipments through a processing or consolidation center.

Copy

Copied

{
  "thirdPartyAddress": {
    "addressLine1": "2270 US HIGHWAY 130",
    "addressLine2": "near abc street",
    "addressLine3": "near xyz street",
    "company": "PB",
    "email": "testuser@email.com",
    "cityTown": "DAYTON",
    "countryCode": "US",
    "name": "Warehouse Manager",
    "phone": "732-443-1007",
    "postalCode": "08810-1411",
    "stateProvince": "NJ"
  }
}