# Shipping 360 API Releases

Highlights
Unleash the true power of our Shipping APIs! These APIs provide an extensive range of operations, empowering users to effortlessly manage and track their shipping requests.

## MAY, 13, 2026: Upcoming Release v1.0.47

1. **Purolator and CPC Pickup Support**
Expands support for pickup scheduling for Purolator and CPC carriers. Updates the [Schedule Pickup API](/openapi/shipping/pickups/schedulepickup) to support these carriers.
2. **Ruleset: Exclude Support and ShipOption Mapping to Ship Via Code**
  - Adds exclude capability to Ruleset-based shipment creation and rating.
  - Updates Ruleset flows to map `shipOption` to Ship Via Code in the [Create Shipment](/openapi/shipping/shipment/createshipmentv2) (by RuleSet) request payload. Ship Via Code is configured as part of the automation rule.
3. **LocationId: Customer Location Support**
Enhances LocationId handling by supporting a customer-defined `customerLocationId` in addition to the system-generated LocationId created during developer onboarding. If a customerLocationId is not provided, the system assigns a default LocationId. In responses, both identifiers are returned; if a customer-defined value is not set, both fields return the same system-generated LocationId. Supports customerLocationId in Shipment V2, Rate V2, and Print APIs.
4. **CustomsProduct: API Standardization**
Standardizes naming by updating attribute  `customProductId` to `customsProductId`. Updates include [Customs Product APIs](/openapi/customproduct) and Order [Create](/openapi/ordermanagement/order/createorder)/Update(/openapi/ordermanagement/order/partialupdateorderbyid) request payloads.
5. **New Carrier: Intelcom**
Refer to the [Carrier Catalog](/docs/shipping/carriers/carrier-catalog) for carrier capabilities and integration details.
6. **Search Packages: Custom Header Mapping Support (Receiving Flow)**
Introduces a new [API](/openapi/receiving/packages/searchpackages) to retrieve package records in the receiving flow with custom header mapping. Supports defining package field names as keys and user-defined header labels as values in the request, enabling response data to be displayed with customized column names.


## APRIL, 22, 2026: Release v1.0.46

1. **Alternate Return Address Handling**
  - Fetches [alternate return address](/openapi/shipping/shipment/createshipmentv2) from Location and returns it in the response. The resolved alternate return address is included in the shipment workflow.
  - [Get Loaction API](/openapi/location/location-management/getlocations) now returns alternate return address when it is configured at the location level during developer account onboarding.
2. **Location Header Support for Manifest API**
Supports the `X-PB-LocationId` header during [manifest close](/openapi/manifest/manifest/createmanifest) and applies defined account resolution logic. This API determines when to use `carrier` and when `carrierAccountId` is required based on the location context and carrier account configuration.
3. **Get All Shipments: Returns All Uploaded Documents**
[Get All Shipments API](/openapi/shipping/shipment/getallshipments) response now returns all documents uploaded for a shipment.


## APRIL, 01, 2026: Release v1.0.45

1. **Improved structure accross APIs (OMS, Custom Product, Create Shipment)**


Item attributes such as `itemId`, `weight`, and `weightUnit` are now consistently supported across [Customs Product APIs](/openapi/customproduct/customs-product/addcustomsproduct), [OMS APIs](/openapi/ordermanagement/order/createorder) and [Shipment (Create Shipment v2) APIs](/openapi/shipping/shipment/createshipmentv2).

- Customs Product APIs generates a `customProductId` based on item attributes including `itemId`, `weight`, `weightUnit` and others. This `customProductId` can be referenced in **OMS APIs**, eliminating the need to redefine item details. **Shipment APIs** now support the same `customs.items` structure along with `orderNumber`.
- `Weight` and `weightUnit` handling have been standardized across **OMS**, **Shipment** and **Customs Product** APIs. This ensures consistent interpretation of weight data across order creation, product definition, and shipment execution.


1. **Ship Via Code Standardization (Previously Custom Carrier Code)**


- **Custom Carrier Code API** endpoints are updated and renamed to [Ship Via Code APIs](/openapi/shipviacode)
- Object `byCustomCarrierCode` is renamed to `byShipViaCode` in **Create Shipment APIs**
- Supported consistently across Order (OMS) and Shipment APIs


1. **Carrier Payment Fields Support in OMS APIs**


`carrierPayments` array is now supported in **OMS APIs**. Developers can define billing options such as *third-party billing*, *bill recipient*, and *freight collect*, during order creation. It eliminates the need for manual intervention at the warehouse level and supports fully automated fulfillment workflows.

1. **Return Label Support**


Return label generation support is now extended for **Purolator** and **CPC** carriers' shipments. This enables developers to generate return labels through the existing shipment workflow.

1. **Address Autocomplete and Verification Added to Developer Onboarding Signup Page**


The developer onboarding signup page now supports address autocomplete and address verification.

- As users enter address details, autocomplete suggestions are displayed based on the entered keywords.
- If an entered address is invalid or incorrect, verified address suggestions are provided for selection.


1. **BPOD File Date Format Fix**


Standardized date format (**YYYY-MM-DD**) for [BPOD file downloads](/openapi/shipping/shipment/downloadbpodfiles) using date range filters.

1. **New Carrier Documentation**


Documentation is now available for the following carriers:

- [TForce Mile](/docs/shipping/carriers/overview/tforce)


Refer to the [Carrier Catalog](/docs/shipping/carriers/carrier-catalog) for carrier capabilities and integration details.

1. **Postman Collection Updates**


The [Postman collection](/docs/resources/postman) is updated to include:

- OMS API updates
- Ship Via Code endpoint changes
- Updated Create Shipment support using shipViaCode
- Custom Product API updates


1. **Documentation Update**


Order Management APIs now reorganized and moved out of the Shipping API bucket into a separate OMS API category effective.

## March, 11, 2026: Release v1.0.44

**1. ERR Single-Piece Coversheet: Configurable Output via outputType**

The [Create ERR](/openapi/shipping/shipment/createerrcoversheet) API now supports configurable output types, allowing users to control which ERR artifacts are returned in the API response.
A new `type` parameter has been introduced with the following values:

- **COVERSHEET**: Returns coversheet output (backward compatible).
- **BARCODE.STAMP**: Returns separate outputs for the ERR barcode and ERR stamp.
- **ALL**: Returns three outputs:
  - coversheet (Content Type: URL, Format: PDF)
  - ERR barcode (Content Type: BASE64, Format: GIF)
  - ERR stamp (Content Type: URL, Format: GIF)


**2.Get All Shipments API: Location-Based Filtering**

The [Get All Shipments](/openapi/shipping/shipment/getallshipments) API now supports filtering shipments based on the `locationId` associated with the shipment.

- When the `X-PB-LocationId` header is provided, the API returns only those shipments associated with the specified location.
- If the header is not provided, the API returns shipments across all locations (default behavior).
- Get All Shipment API now return `carrierAccountId` in response.


**3. Get Carrier Accounts API: Location-Based Filtering**

The [Get Carrier Accounts](/openapi/shipping/shipment/getcarrieraccount) API now supports filtering carrier accounts based on the `locationId`.

- When the `X-PB-LocationId` header is provided, the API returns only those carrier accounts onboarded with the specified location.
- If the header is not provided, the API returns all carrier accounts associated with the developer account (default behavior).


**4. Upload Multiple Documents in a Single Request**

The [Upload Electronic Trade Document](/openapi/shipping/electronic-trade-document/uploadetd) API now supports uploading multiple shipment documents in a single request.

**5. Customs Line Items Enabled for Domestic Shipments (V2)**

[The Create Shipment (V2)](/openapi/shipping/shipment/createshipmentv2) API now supports customs line items for domestic shipments. International information can now be specified for domestic shipments where required.

**6. New Carriers Documentation**

- [GLS](/docs/shipping/carriers/overview/gls)


> Please refer to the [Carrier Catalog](/docs/shipping/carriers/carrier-catalog) section for more details on these carriers.


**7. Address Autocomplete and Verification Added to Merchant Onboarding Signup Page**

The merchant onboarding signup page now supports address autocomplete and address verification.

- As users enter address details, autocomplete suggestions are displayed based on the entered keywords.
- If an entered address is invalid or incorrect, verified address suggestions are provided for selection.


## February, 18, 2026: Release v1.0.43

**1.FedEx and UPS PB-Rated Carrier Support**

API users (Developers/Merchants) who sign up under the new Standalone Free plan can now use FedEx and UPS as PB-rated carriers.

**2.Convert Single Payer PAYG to Post pay**

Single-payer Pay-As-You-Go accounts can now be converted into Post pay accounts.

**3.Get All Shipments API Response Expanded**

The [Get All Shipments](/openapi/shipping/shipment/getallshipments) API now returns more details, including package contents, special services, reference numbers, and order identifiers where available.

**4.Denied Party Screening API Path Update**

The [Denied Party Screening](/openapi/crossborderdeliveryservices/denied-party-screening/deniedpartyscreening) (DPS) API endpoint has been updated to use lowercase naming instead of camel case for consistency and standardization.

**5. New Carriers Documentation**

1. [ADDISON LEE](/docs/shipping/carriers/overview/addisonlee)


> Please refer to the [Carrier Catalog](/docs/shipping/carriers/carrier-catalog) section for more details on these carriers.


## January 28, 2026: Release v1.0.42

**1. Postman Collection Updates**

- The existing [Postman collection](/docs/resources/postman) is updated to include:
  - Order Management System (OMS) APIs
  - Denied Party Screening (DPS) API
- A [new Postman collection](/docs/resources/postman#shipping-360-postman-collection-canada-region) is added for all APIs supported on the Canada infrastructure.
**2. API Support for Canada Region**


Our APIs are now extended to the Canada region. All API endpoints that support Canadian carriers are available on the Canada infrastructure. API behavior, including request and response structures, remains consistent across all supported regions

**3. Denied Party Screening (DPS) API**

A new Cross-Border [Denied Party Screening (DPS) API](/openapi/crossborderdeliveryservices/denied-party-screening) endpoint is now available to screen buyers and sellers against embargoed or sanctioned parties based on country-level regulations.

**4. Order Management System (OMS) APIs**

New [Order Management System (OMS) APIs](/openapi/ordermanagement/order/createorder) capabilities are now available as API services to support end-to-end order lifecycle management, including cross-channel order creation.

**5. Enhanced Custom Product APIs**

The [Custom Product APIs](/openapi/customproduct/customs-product/addcustomsproduct) are updated to support additional fields, including product SKU (`itemId`) and extended product details.

**6. Sandbox Credit Card & Individual Ledger Support**

Clients can now add a credit card in the Sandbox environment and use payment features such as auto-refill without manual intervention. Each Sandbox account is provisioned with an individual ledger.

**7. Get All Shipments API Documentation Update**

The existing [Get All Shipments API](/openapi/shipping/shipment/getallshipments) has been enhanced with additional filters. Previously documented separately as the Shipment Transaction Report, these capabilities are now consolidated under the Get All Shipments API, and the documentation has been updated accordingly.

## January 07, 2026: Release v1.0.41

**1. Postman Collection Updates**

[Postman collection](/docs/resources/postman) has been updated to include:

- Get Individual Merchant API


**2. Get Individual Merchant API**

The existing Get Partner API has been revamped and renamed as [Get Individual Merchant](/openapi/merchants/partners/getpartner), and the endpoint has been changed.

**3. Developers and Merchants to Have Multiple Users for the PB 360 Portal**

Developers and Merchants can now create and manage multiple users under a single subscription for the PB 360 portal.

- Developers can create up to 9,999 users.
- Merchants can create up to 999 users.


> Each user can log in with assigned access permissions.


**4. Published Carrier Rates for UPS**

The `publishedTotalCarrierCharge` field is now returned in the API responses for the following operations:

- V1 Shipment
- V2 Shipment
- Multipiece Shipment
- V2 Rate API


This displays both the standard (published) rate and the discounted rate applied to the shipment.

## December 10, 2025: Release v1.0.40

**1. Add Validation for Whitelisted Capabilities per Carrier**

The APIs (Create Shipment, Rate, and Multipiece) now validate shipments based on the whitelisted capabilities (services, parcels, and special services) set for carriers at the subscription or account level.

**2. Postman Collection Updates**

Postman collection has been updated to include:

- Department APIs
- New Parcel Point API endpoints
- Find Carrier Facilities


**3. New Parcel Point API Endpoints**

The following new API operations are now exposed:

- Get Locker Bank by ID: Retrieves detailed information for the specified locker bank.
- Get Reservations by Contact ID: Returns all active reservations for the specified contact within a locker bank.
- Get Reservation by Tracking Number: Retrieves reservation details for a parcel using its tracking number.
- Add or Update Deposit: Records or updates deposit information for a locker unit after a parcel has been placed inside.
- Update Reservation: Updates reservation details, including expiry time or parcel list, for the specified locker unit.


**4. Find Carrier Facilities**

Introduced a new Find Carrier Facilities that locates Post Offices and other carrier-operated facilities.

**5. Return Transaction Details in Shipment History**

Return charges are now visible in Shipment History. Actual charges appear as **Actual Return Charge**, and pending amounts show as **Charges Pending**.
**Note:** Actual return shipment charge will be applied after confirmation from the carrier.

1. **Cost Account: User-Level Assignment Support**


The Add Cost Account API now supports assigning cost accounts at **Enterprise**, **Division**, and **Location** levels. A new `advanceOption` parameter has been added to enable entity-based permission control.


```js
"advanceOption": {
        "permission": {
            "permissionByEntity": "L",
            "permissionByValue": [
                "zLwdWnZ7LyVWknO"
            ]
        }
    }
```

**7. Address Book APIs**

Address Book APIs have been moved under the shared folder in the documentation.

## November 21, 2025: Release v1.0.39

**1. Added Support for Legacy (SPE) System Codes in Create Shipment V2**

The Create Shipment V2 API now supports legacy (SPE) system codes. This update ensures backward compatibility for clients using SPE system references while creating shipments. The Create Shipment API processes legacy system codes without requiring any change in request structure.

**2. Maintain Label Sort Order in Bulk Import Shipments and ERR Batches**

The Get Batch Shipment Status and [Get Batch Shipment Details APIs now return responses in the same order as the import file. Also, the PDF file generated with labels follows the same order as in the import file.

**3. Display Proof of Delivery Tab for ERR Shipments**

API-only users can now view the Proof of Delivery tab in the UI for better ERR shipment visibility.

## November 06, 2025: Release v1.0.38

**1. Postman Collection Update**

Postman Collection has been updated with the following new APIs:

- Custom Product APIs
- Get Merchant(s) for a developer APIs


**2. New API Endpoints Exposed**

- **Customs Product**: Introduces CRUD APIs to create and manage reusable customs products. shipment APIs can reference these customs products to prefill customs item fields (HS code, origin, unit price, weight, quantity).
- **Get all merchants for a developer:** Exposes new endpoint to retrieve all partners (merchants and knownshippers) for a given developer. The response includes merchant profile, status, developerPartnerId and subCarrierIds (individual merchants only) and ShipperID.


**3. PAUG fallback for Single-Payer FedEx/UPS**

If PostPay isn't configured, payments route via Payments Finale Service (Enterprise + ShipAccel API).

**4. APV (Adjustment) Breakdown in UI**

Users can now see the **Original Cost**, **Adjustment Amount(s)**, and **Total Adjusted Cost** separately.

## October 15, 2025: Release v1.0.37

**1. Postman CollectionUpdate**

Postman Collection has been updated with the Service/Parcel/Special Service Management at Subscription Level API.

**2. New API Endpoint Exposed**

- Service/Parcel/Special Service Management at Subscription Level: Allows whitelisting of Service, Parcel Type, and Special Service at the Subscription Level.


**3. Custom Carrier Code Support in Rate calls**

The Rate Shipment V2 API now supports the use of Custom Carrier Codes. When rating shipment, users can provide the predefined `customCarrierCode` instead of standard carrier identifiers.

**4. 3% Credit Card Processing Fee:**

3% processing fee now applies to all credit card payments; the UI displays this fee for developers and merchants.

## October 1, 2025: Release v1.0.36

**1. Implementation of PITNETWORKS Account for CPC**

Enables configuration and use of PITNETWORKS account type under CPC for API360 clients.

**2. Refund & Adjustments for PB Discounted Carriers (Single Payer - POSTPAY)**

Enables APIs to process, track, and reconcile refund/adjustment requests for shipments where PB provides discounted rates.

## September 18, 2025: Release v1.0.35

**1. Postman Collection Update**

Postman Collection has been updated with the following APIs:

- International Address Validation
- Pickup Availability
- Enable Services, Parcels and Special Service (Carrier Update)
- Importers of Record
- Account Code
- Company Code
- Custom Codes


**3. New API Endpoints Exposed**

- **International Address Validation**: Users can now validates international shipping addresses against postal and carrier standards to improve delivery accuracy.
- **Pickup Availability**: Check carrier pickup availability for a given location and date to support efficient scheduling.
- **Enable-Disable Services, Parcels and Special Service**: Users can now enable or disable carrier's services, parcel types, and special services at the carrier account level. Once disabled any specific at carrier account level, will not return in the response for use.
- **Importer of Record**: Users can now set a default importer of record for an organization to streamline cross-border shipping.
- **Generate Account Code & Company Code**: This API generates unique account and company codes for shipping metadata.
- **Manage custom Codes**: We've introduced support for custom codes that can be generated for a specific combination of carrier, service, parcel, and special services.
  - Users can generate and manage these custom codes through the new API.
  - Once created, the custom code can be used directly in Shipment APIs, eliminating the need to repeatedly enter carrier/service/parcel/special service details manually.


**4. Custom Carrier Code Support**

The Create Shipment V2 API now supports the use of Custom Carrier Codes. When creating shipments, users can provide the predefined `customCarrierCode` instead of standard carrier identifiers.

**5. Shipment Metadata: Account & Company Codes**

The Create Shipment V2 API now accepts **Account Code** and **Company Code** as metadata fields.

**6. Shipment options for CPC (CA to US Shipment)**

For CPC Canada to US shipments, accept declarationId as a shipment option when `X_ACCESS_KEY` is not configured for the CPC carrier.

## September 03, 2025: Release v1.0.34

**1. Documentation Update**

**Webhook APIs** have been moved under the Tracking APIs folder in the documentation.

**2. Postman CollectionUpdate**

Postman Collection has been updated with the following APIs:

- RateGroup Management
- Transaction Reports


**3. New API Endpoints Exposed**

- **Generate Transaction Reports**: Generate detailed reports of Funds, Stamps, and Shipment-related transactions within a specified date range.


**4. Manage Rate Groups in Developer Portal**

The **Carrier Page** now displays a Rate Groups tab, enabling API clients to view and manage rate group configurations directly in the Developer Portal.

**5. Self-Registration for SAPI Subscriptions in API360**

**SAPI subscriptions** can now sign up as developers in the **API360 platform**.

## August 20, 2025: Release v1.0.33

1. **Company Logo and Signature**


Users can now set their **company logo** and authorized **signature** within their subscription settings. These will automatically appear on all generated commercial invoices. Read *How to upload Company Logo and Signature*

1. **Deliver By Functionality in Rate V2**


The Rate V2 API now supports the **Deliver By** functionality. When a `deliverBy` date is specified in the request, the API returns rate quotes with delivery commitments on or before specified date.

## August 06, 2025: Release v1.0.32

**Parcel Point APIs**

1. A new collection of Parcel Point APIs has been introduced to support smart locker workflows.
These APIs enable:


- Reservation of Pitney Bowes smart locker units
- Release of reserved locker units


1. An updated Postman collection is now available, including the newly released Parcel Point APIs for easier testing and integration.


**Published Carrier Rates for FedEx**

1. The `publishedTotalCarrierCharge` field is now returned in the API responses for the following operations:


- V1 Shipment
- V2 Shipment
- Multipiece Shipment
- Rate API


This displays both the standard (published) rate and the discounted rate applied to the shipment.

**V2 shipment endpoints set as default in documentation**

1. V2 endpoints of the following APIs are now set as the default endpoints in our documentation:


- Create Shipment
- Rate Shipment
- Cancel Shipment
- Reprint Shipment


V1 endpoints have been moved under the Legacy Endpoints section for backward reference.

## July 24, 2025: Release v1.0.31

**Carrier Enhancement: RoyalMail (RMG)**

1. **Enabling Business-to-Business (B2B) Shipments**


The RMG carrier now supports B2B shipments, enabling smoother logistics operations and improved compliance handling between businesses.

> Compliance: RMG shipments are now fully compliant with the Windsor Agreement, ensuring that cross-border trade meets all regulatory and customs requirements outlined in the agreement.


**Rate Shipment V2 Enhancements**
2. **Rate Shop Across Carriers:** Returns rates from all carriers in the current subscription.
3. **Rate Shop for a Single Carrier:** Returns all available rates from a specific carrier by providing the `byCarrier` parameter.
4. **Single Rate by Service ID:** Returns a specific rate by providing both `byCarrier` and `serviceId` parameters.

## July 10, 2025: Release v1.0.30

**PB Discount Rate Carrier Entitlement on Eligibility**

1. API users now have the option to select PB Discounted Rate carriers through the Single Payer feature, which includes end-of-day settlement capabilities. This option is available on the Carrier screen.
However, this feature is currently restricted and can only be enabled with assistance from Customer Support, based on eligibility criteria.


**USPS Rate Change Effective July 13, 2025**

1. USPS will implement price and structure changes effective July 13, 2025. Read USPS Rate Change Updates for details.


**Manifest Now Supports Tracking Number-Based Generation**

1. USPS 3877 Manifest Forms can now be generated by tracking numbers, enabling manifest creation for selected USPS shipments without waiting for end-of-day processing.
2. End-of-day Manifest Forms can now be generated by tracking numbers and shipper ID.


**Corrected locationId assignment based on carrier country**

1. Fixed an issue where Canada shipments were created with a US locationId. Now, locationId aligns with the carrier's country in v1 Create Shipment.


**Tax Details Now Returned for Canada Carriers**

1. The create shipment API (V1 & V2) response now returns totalTaxAmount and baseChargeTaxes  for Canada carriers.


## June 26, 2025: Release v1.0.29

**Electronic Trade Document (ETD) support Extended to V2 Create Shipment API**

1. Electronic Trade Documents (ETDs) can now be used in the V2 Create Shipment API. Upload the document using the Upload ETD API and reference the signed S3 URL in the **customsDocuments** object of the shipment request.


**Special Services Support in V2 Create Shipment API**

1. The specialServices array is now documented for the V2 Create Shipment API. Special services can be defined using either a `specialServiceId` or by specifying individual service objects.


## June 11, 2025: Release v1.0.28

**USPS Enhancements**

1. **USPS Auto-refill** can now be triggered in:
  - Batch Shipment flow
  - ERR Label / CoverSheet batch flow


**IMB Labels with USPS FCM - LETTER, FLAT, IRRPKG, NMLETTER**

1. Extended support for USPS package types LETTER, FLAT, IRRPKG, and NMLETTER with service ID FCM. Labels are generated in doc_size 6x4 and available in PDF, PNG, or ZPL2 formats. This applies to both v1 and v2 Create Shipment APIs.


**Electronic Trade Document (ETD) upload and reference in international shipments**

1. Users can now upload trade documents (e.g., invoices, certificates) via API and reference them using the `customsDocuments` object, streamline the need for physical document attachment.
2. Updated postman collection with Electronic Trade Document Upload API.


**V2 Rate Shipment API Enhancements**

1. V2 Rate Shipment API now returns a single rate based on the specified carrier, rate group, or ruleset.


**Performance Optimization**

1. ptimized cache handling to improve performance.


Optimized cache handling to improve performance.

## May 29, 2025: Release v1.0.27

**Address Autocomplete API**

1. Introducing a new Address Autocomplete API that delivers real-time, unit-level address suggestions. This API aligns with the current UI implementation and supports global address entry and validation.


**Postman Collection**

1. We have updated postman collection with Cross Border APIs and Address Autocomplete API..


**Performance Optimization**

1. Optimizing the cache to adhere to carrier rules regarding package dimensions and weight.
2. A new version **1.11.25.1** of **device Hub** has been updated.


## May 14, 2025: Release v1.0.26

**View Shipment History**

1. A new filter has been introduced on the **View Shipment History** page to retrieve international shipments only.
2. Resolved an internal server error that occurred when viewing shipment history in the **Client Portal**.


**API Enhancements**

1. Billing Weight is now included in the response of the following APIs:
  - Get Shipment by ID
  - Rate Shipment v1
2. Shipment Options are now returned in the response of the **Reprint Multipiece Shipment** API.
3. Alternate Return Address is now returned in the response of:
  - Get Shipment by ID
  - Get All Shipments
4. Booking Confirmation field has been added to the response of the **Get Shipment by ID** API.


**Perfomance Optimization**

1. Optimized cache usage for API workflows to improve performance and reduce redundant data processing.


**Cross-Border API Availability**

1. Shipping 360 APIs have now exposed the following **Cross-Border APIs** to support international shipping and compliance workflows:
  - HS Classification API
Returns the **harmonized system (HS) code** for an item based on its description and destination country or countries.
  - Restriction API
Retrieves import/export **restrictions** and regulatory requirements for the specified destination country or countries.
  - Landed Cost Quote API
Calculates the total **landed cost**, including duties, taxes, and fees, for the specified destination country or countries.


## April 30, 2025: Release v1.0.25

1. The bookingConfirmationNumber field is now supported in the `shipmentOptions` object for the FedEx carrier.
Applies to the following APIs:
  - CreateShipmentV1
  - CreateShipmentV2
  - Multipiece Shipment
  - Batch Shipment


- Applicable to both domestic and international shipments.


1. The **Batch Shipment API** now supports:
  - Alternate return addresses
  - billingWeight


- Applicable to both domestic and international shipments.


1. The Developer view under the Merchant section in the Admin Portal now displays:
  - **Carrier Name**
  - **Carrier Account ID**
2. **Webhook configuration** now supports multiple authentication methods:
  - API Key
  - Basic Authentication
  - OAuth 2.0 (new)
3. The new version (v1.4) of the Shipping 360 Postman collection has been updated to include Receiving APIs, Address Book APIs, and Custom Fields APIs. Please refer to the updated [Postman collection.
4. The termsOfSale field is now supported within the `customsInfo` object to define delivery and payment terms for international shipments.


## April 16, 2025: Release v1.0.24

- The Developer View under the Merchant Section now displays the **carrier** and **carrierAccountId** associated with an individual merchant.
- For a multi-piece shipment, the developer can now split the label at the parcel level by specifying a parameter splitContent.
- The Auto-refill capability is enhanced and can now be triggered for USPS ERR Single Cover Sheet.
- Shipping API 360 now returns billingWeight under `shipmentOptions` in the following endpoints:
  - Create Shipment V1
  - Create Shipment V2
  - Create Multipiece (shipment-level)
- Extended support to enhance the capability for ShipmentByRateShop V2 API:
  - soldToAddress
  - USPS military Mail Shipments APO/FPO/DPO
  - Special Services object
- Shipping 360 APIs now support additionalAddresses for the following APIs:
  - Create Shipment V1
  - Create Shipment V2
  - Create Multipiece Shipment
- Extending Support for FedEx Carrier Notifications Special Services.
- Fixed an issue where the Create Shipment API for UPS international shipments returned an error when using the **4x6_75** PDF document size. It now correctly supports both **8x11** and **4x6_75** as valid PDF sizes.
- Fixed an issue where **parcel-level references** provided in parcelShipmentOptions were not printed on UPS multipiece shipment labels. The label now prints parcel-specific data as expected.


## April 03, 2025: Release v1.0.23

1. **Developer and Merchant sign-up** processes now enforce acceptance of **Terms and Conditions** before registration, for compliance and legal acknowledgment at the time of onboarding.
2. The tax identification fields taxId and taxIdType are now supported in the `fromAddress`, `toAddress`, and `soldToAddress` objects across these APIs:
  - Create Shipment v1
  - Create Shipment v2
  - Create Multipiece Shipment
  - Create Batch Shipment


> These identifiers are now validated and printed on invoice documents for international shipments.


1. 360 Shipping APIs now support USPS Military Mail Shipments.
2. 360 Shipping APIs now support the AES ITN number submitted in the `EELPFC` field within the Customs Info object for international shipments.


## March 24, 2025: Release v1.0.22

- Added support for **Parcel-Level References** using the parcelShipmentOptions object in Create Multipiece Shipment API:
>   - References defined at the parcel level are printed only on the corresponding parcel label.
>   - If both shipment-level and parcel-level references are provided, parcel-level values take precedence.
>   - If references are provided only at the shipment level, they are printed on all parcel labels.
>   - For parcels without parcel-level references, shipment-level references are used.
- Fixed an issue where special service details were not passed to GCS in the rate call. The rate call now functions as expected.


## March 19, 2025: Release v1.0.21

- Company name can now exceed **30 characters** with carrier-specific validation.
- **Unified return label flow in 360API** to enhance support for **FedEx and UPS return shipments**.
- **Added hyperlinks** to **MetaData Services, Packages, and Special Services** for all carriers to easily access their descriptions.
- **ERR Batch API** now supports all available **shippingReferences** fields:
  - reference1
  - reference2
  - reference3
  - reference4
  - shipperReference
  - transportationReference
  - shipperNotes
- Fixed an issue where **Company Name and Email Address** were not printed on **shipping labels**.
- Multipiece shipment now supports Alternate Return Address for both Domestic and International shipments.
- Added support for **Induction Postal Code** in **Create ERR Single Coversheet API**.
- Merchants and developers can now enable **Auto Refill** on their accounts.


## March 6, 2025: Release v1.0.20

- Throttling is now applied in the **sandbox environment** with limits on API call rate and burst capacity:
  - **Per API Limit**: Maximum **2 requests per second** per developer.
  - **Daily Quota**: Maximum **1000 API calls** across all APIs per developer.
  - **Throttling configuration** can be enabled via the **Admin Console**.
- Added **USPS reference field support** V2 Create Shipment API.
- Fixed **Merchant Client UI rendering** issue in Developer Portal.
- New developers can now **onboard with all supported carriers**.
- Updated **validation in V2** (Name can now exceed 30 characters with carrier-specific validation).
- Fixed **Get Balance Wallet API** issue where zero wallet balance was not returned..
- Enhanced Multipiece ZPL format with improved ZPL handling
- **Reverted Order Management/connectors APIs** from Doc Portal.


## February 20 , 2025: Release v1.0.19

- Multipiece international shipments now support ZPL format for shipping labels.
- A new collection of Custom Fields APIs has been introduced to support the retrieval of custom attributes defined on the platform.
- A new collection of Inbound Site APIs has been added to the Receiving APIs for the management of inbound package locations.
- A new collection of Address Book APIs has been introduced for contact management.
- The issue causing errors in LaserShip Rate Calls has been resolved.


## February 07, 2025: Release v1.0.18

1. **QR Code Labels for USPS Shipments**
Pitney Bowes users can now generate QR Code labels for USPS shipments using Shipping APIs.
  - Set the document type to `QR_CODE`, file format to `GIF`, and `contentType` to `URL` or `Base64`.
  - This feature works for both outbound and return labels in V1 and V2 Create Shipment APIs.
2. **Doc Tab Object in Create Shipment V1 API**
The Doc Tab object is now supported in the Create Shipment V1 API for labels.
  - This feature allows additional information to be printed on the label's additional space.
3. **Content-Type Field in Create Multipiece Shipment API**
The `Content-Type` field has been added to the Create Multipiece Shipment API.
4. **USPS-Specific Details in Address Validation and Suggest Service**
The Address Validation and Address Suggest Service now provides additional USPS-specific details in the response:
  - **carrierRoute:** The last four characters of the USPS domestic carrier route code, representing the area served by a specific USPS mail carrier.
  - **deliveryPoint:** A 2-digit USPS domestic delivery point.
5. Client UI Dashboard issue is resolved, and the dashboard is now visible.


## January 22, 2025: Release v1.0.17

1. **New carrier:**


- LaserShip


> Please refer to the Carrier Catalog section for more details on these carriers.


1. Added info tip on enrolling for **ACH** (Automated Clearing House) as a payment method, providing users with clear guidance for setup and usage.
2. A new collection of Receiving APIs has been added to manage and process packages in the receiving system.
3. **Merchant tab** and **Dashboard** are now available in the Admin Console.


- The **Merchant** tab displays details of merchants associated with a developer.
- The **Dashboard** provides an overview of API usage and related metrics.


1. You can now print an **Alternate Return Address** on the label that is different from the origin address of the parcel. The alternate return address is supported by FedEx, UPS, and Purolator.
2. The destination zone is now returned in the response for the following APIs:
  - CreateShipmentV1
  - CreateShipmentV2
  - V2 Rate
  - RateShop
  - Reprint Shipment
  - Reprint Shipment V2
3. The documentation now reflects updated business logic for the following APIs:
  - Create Manifest
  - Create Shipment V2 API


## January 8, 2025: Release v1.0.16

1. **New Carriers**
  - **RMG**
  - **OnTrac**
  - **Roadie**


> Please refer to the Carrier Catalog section for more details on these carriers.


1. The `deliveryCommitment` object is now returned in the response for the following APIs:
  - Create Shipment (Domestic and International)
  - Multipiece Shipment
  - Multipiece Rates
**Example Response:**



```json
"deliveryCommitment": {
        "additionalDetails": "By end of Day",
        "estimatedDeliveryDateTime": "2024-12-16 18:00:00.000",
        "guarantee": "NONE",
        "maxEstimatedNumberOfDays": "2",
        "minEstimatedNumberOfDays": "2"
    }
```

1. Multipiece Shipments now support the ZPL2 format with label sizes `Doc_4 x 6` and `Doc_8.5 x 11` and file format `BASE64` for `ZPL2` files.
2. Extend support for Carrier Payment object in Multiple Shipment workflows


> Carrier Payments enable charging one or more shipment costs to a designated third-party account, providing flexibility in billing arrangements._


1. Rebranded **Shipping 360 API** to **Shipping API** for consistency and brand visibility across all platforms.
2. **Enhanced Documentation for Business Logic**
The documentation now reflects business logic for the following APIs:


- Signature Image ERR
- Cancel Shipment
- Reprint Shipment
- Address Validate
- Multipiece Shipment
- Cost Account
- End-to-end Webhook setup


1. **Create Shipment V2**: Added support and validation of `shipperId` for USPS.
2. **Create Bulk Shipments**: Added support for `inductionPostalCode` in Batch shipment.
3. Implemented fully automated deployment for API documentation.
4. Resolves display issues with the **Donut Chart** and **API Usage Graph** in the Dashboard tab of the Developer Portal. The Dashboard now presents distribution and API usage metrics clearly.
5. Fixed an issue where custom messages were not being printed on the **ERR coversheet**. Custom messages are now successfully printed as intended.
6. Enhanced the database to store additional data.
7. **Code Optimization**: Optimized the UI for


- Developer Portal
- Merchant Portal


## December 11, 2024: Release v1.0.15

1. **ShipmentByRateShop**: developers can now create International Shipments.
2. **New carriers**:
  - DPD
  - AppleExpress


> Please refer carrier catalog section for more details on these carriers.


1. We have introduced a new **Merchant Shipments** filter for Developer Partners in the Shipment & Postage History section on the portal. For this developers must enter the subscriptionId in the search bar to access transaction records for specific merchant.


> Note: The **subscriptionId** can be obtained from the Merchant section in the developer view.


1. **Carrier Payments**: Enables charging one or more shipment costs to a designated third-party account to provide flexibility in billing arrangements.
  - `carrierPayments` is now supported for both domestic and International Create Shipment.
2. **Induction Postal Code**: The postal code where the shipment is tendered to the carrier. If an induction postal code is specified in the `fromAddress`, it will be used for rate calculations and determining manifest eligibility instead of the standard postal code. If not specified, the postal code from the `fromAddress` will be used.
`inductionPostalCode` is now supported for:
  - Create Manifest
  - Get Single Rate
  - Get Rate Shop
  - Create Shipment
3. New version v1.3 of shipping 360 postman collection with updated examples and added services. Please refer Postman Collection
4. A new Dashboard  is now available in the Developer Portal to view and analyze API usage.
5. **ShipmentByRateShop** added `shipperId` support for USPS.
6. **Batch Shipment** added support for `shipperId` for USPS.
7. All supported **Label Formats** and **Doc Sizes** for carriers are now displayed in a structured tabular format for better accessibility. Please refer carrier catlog section.
8. **Create Return label shipment** API by Pitney Bowes is being deprecated and will no longer be supported. However, clients can continue to use the **Create Shipment API** to generate return labels.
9. **Code Optimization**:
  - Developer Portal
  - Merchant Portal
  - Carrier Integration API's for Label Creation
  - Carrier Integration API's for Getting Rates


## November 13, 2024: Release v1.0.14

1. Expose a new API to create Single ERR coversheet.
2. Supports third-party billing for Carrier Payments. Adds support for third-party billing on shipments via the `carrierPayments` object, enabling designation of third-party accounts for specific charges.
3. A new endpoint has been added to retrieve rate shop without generating labels.
4. Enables all carriers (US only) for standalone Developers and provides default access for their Merchants.
5. Carriers (US only) entitled to a Developer should be entitled all Individual Merchants .
6. Displays merchant transaction history in the Developer's view.
7. Support For ByPassAddress Validation for CreateShipment V2, Batch and Multipiece APIs.
8. Enables support for an alternate return address in the Create Shipment v2 API. Users can set a different return location from the main sender address.
9. Adds support for ACH Payment Method Validation for both Developers and Merchants
10. Enables Developers to print USPS Form 3877, the Firm Mailing Book for Accountable Mail, through the API interface. This form consolidates multiple mail pieces with Extra Services, such as Certified Mail and Priority Mail Express, eliminating the need for individual mailing receipts. Previously, printing was limited to the UI only.
11. Published **.Net SDK**.


## October 23, 2024: Release v1.0.13

1. Partner Onboard Invitation API and invite partner UI attributes are now fully synchronized to ensure consistent functionality.
2. Introduced a self-serve Developer Signup page within the Developer Portal for easier developers onboarding.
3. Added support for `minimalAddressValidation` in Create Shipment V1 and V2 APIs.
4. Added support for `inductionPostalCode` in Create Shipment V1 and V2 APIs.
5. Added support for `PDF`, `ZPL2`, `PNG`, and `GIF` label formats, with content types as `URL` (for PDF, GIF) and `BASE64` (for ZPL2, PNG, GIF) in Create Shipment V1 and V2 APIs. For more information, visit carrier catalog.
6. Improved error handling for `ERR Bulk Shipments` to ensure errors are returned during batch processing in case of exceptions.
7. Ensured ledger refunds are not processed if SP Create Shipment fails after USPS label creation.
8. Improved manifest functionality to successfully create scan forms for USPS international transactions.
9. Added the Company Name in the merchant info section under the Merchant Tab and enabled it as a search option.
10. Released **Python SDK** for 360 API Shipping, compatible with **Python 3.7+**, installable via `pip` or `Setuptools`.


## October 18, 2024: Release v1.0.12

1. Extended support for shipping label printing in `ZPL2` format, along with the existing `ZPL` and `PDF` formats.
2. Added support for `4"x8"` label size for international shipments.
3. Published **Connectors APIs** in the API documentation.
4. Added support for `bypassAddressValidation` as an optional field in shipment options for following APIs:


- Create shipment
- Create Multipiece Shipment
- Create Bulk Shipment
- Create Return Label Shipment


1. Added Support for `shipperId` in shipment options for these APIs:


- Register Known Shipper
- Create Shipment
- Get All Shipment
- Get Shipment by ID
- Get Known Shipper
- Reprint Shipment
- Create Return Label


* Note: Multipiece Shipment and Bulk Shipment will support `shipperId` soon.


## October 4, 2024: Release v1.0.11

#### Released Shipping 360 SDKs for API Integration

Introduced official SDKs for Go, TypeScript, and Java to facilitate integration with the Shipping 360 APIs.

1. **Compatibility & Installation:**


- **Go SDK**: Install using `go get` .
- **TypeScript SDK**: Available via `npm`.
- **Java SDK**: Compatible with `Maven` and `Gradle`.


1. **Authentication:**


- Supports Bearer token authentication. Requires a developer account to generate the `Client ID` and `Secret` for API access.


1. **Environment Support:**


- All SDKs support both sandbox and production environments. Users can switch environments using configuration settings within each SDK.


1. **Key Features:**


- Includes built-in methods for operations like address validation, shipment creation, rate shopping, and batch processing.
- Supports both domestic and international shipping services.


## September 27, 2024: Release v1.0.10

#### 1. Merchant onboard invitation API to onboard individual merchants as partners has been enabled for our API clients.

- Create Onboard Invitation


#### 2. Known Shipper CRUD APIs to register, update, retrieve, delete, and activate/deactivate known shippers have been enabled.

- Register Known Shipper
- Update Known Shipper
- Get Known Shipper
- Delete Known Shipper
- Activate/Deactivate Known Shipper


#### 3. Updated Get Batch Status and Get Batch Shipment Details APIs to include `parcelTrackingNumber` in their response schema.

- For more details, please visit:
  - Get Batch Status
  - Get Batch Shipment Detail


#### 4. Added a guide for Developer Partner onboarding.

- Developer Partners Onboarding


#### 5. Replace static metadata with dynamic metadata across all the carriers.

## September 25, 2024 Release v1.0.9

- Added a feature to handle the return address swap on the API side, following a request to the Pitney Bowes Global Carrier System (GCS) subsystem to stop swapping addresses for return labels across all carriers.
- Added support for `ByPass Address Validation` in Label Creation within APIs360.
- Introduced support for importer/buyer `Sold To` address fields in the 360 API.
- Resolved cache issues for the `Get Parcel` and `Get Services` APIs.


## August 23, 2024 Release v1.0.8

- Updated code for performance optimization of the Create Shipment V1 API.
- Introduce Get `All Defaults` API


## July 10, 2024 Release v1.0.7

- Implemented functionality to default the `Parcel Type` as `Parcel ID` when the client does not provide a `Parcel ID` in the request.
- Enable Auto-refill for API Clients
- Enable Support for FedEx Ground Economy Returns
- Implement S3 private access for 360 API's


## June 26, 2024: Release v1.0.6

#### 1. ERR API has been enabled for our API clients who use USPS carrier for shipping.

- Create Bulk ERR Shipments
- Import Bulk ERR Shipments
- Signature Image ERR as POD
- Download BPOD files
- Cancel Stamps ERR


#### 2. Enhancement done to the API 'ShipmentByRateShop'

- Customized services are added to ShipmentByCarrier, ShipmentByRateGroup, and ShipmentByRuleSet, which provides carrier specific special services and their options.
  - Delivery Confirmation
  - Handling
  - Insurance
- For more details, please visit: CreateShipment


## June 13, 2024: Release v1.0.5

#### 1. API spec updates for `minimalAddressValidation` added in below APIs.

- Address Validate
- Create Shipment
- Create Return Shipment


#### 2. API spec updates for `ZPL2` format support added in below APIs.

- Create Shipment
- Create Return Shipment


## May 29, 2024: Release v1.0.4

#### 1. API documentation for carriers supporting shipping

- Added new carriers under 'Carrier Catalog' page and their details pages to 360 API Portal.
  - Carrier Catalog
- Out of which, USPS and DHL Express are two major carriers added to API Carrier section:
  - USPS
  - DHL Express


## May 15, 2024: Release v1.0.3

#### 1. API Documentation for Carriers supporting Tracking

- A new page **Tracking** page is added to the 360 API Portal. It presents an overview of SP360 APIs supported carriers which have Tracking capabilities. It lists out all carriers supporting Tracking functionality, which API consumers can refer before using Tracking APIs.


## March 20, 2024: Release v1.0.2

#### 1. ShipmentByRateShop APIs are added, as part of client-specific requirement.

- Create Shipment By RateShop
- Reprint Shipment By RateShop
- Cancel Shipment By RateShop


#### 2. Print Document APIs are added, as part of client-specific requirement.

- Print Document
- Printer Mapping
- Get Printer Mapping
- Delete Printer Mapping
- Job Status


#### 3. Carrier Documentation which supports Shipping APIs:

- A new section **Carrier Catalog** is added to 360 API Portal. It displays the capabilities and features of each carrier which API consumers can refer before using Shipping APIs.
  - Carrier Catalog
- It lists out the following carriers which are supported by SP360 APIs, and respective carriers’ details pages are added.
  - FedEx
  - UPS
  - Purolator
  - CPC
  - GoFor


## February 22, 2024: Release v1.0.1

#### USPS Rate Change

The USPS has proposed new prices for Competitive and Market Dominant products and made structural changes. Here is the link for more details: USPS® postage rate change overview | Pitney Bowes

## January 24, 2024: Release v1.0.0

Introducing PitneyBowes 360 API Portal, where some of the key API operations are added as initial part of Shipping APIs, which includes the following API sections:

1. Address APIs
2. Shipment APIs
3. Manifest APIs
4. Batch APIs


For more information, view Shipping APIs.

alert
header
strong
Support

In case of any queries or concerns or if you need any assistance while using our APIs, please do not hesitate to reach out to our support team.