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.

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:
  • Extended support to enhance the capability for ShipmentByRateShop V2 API:
  • Shipping 360 APIs now support additionalAddresses for the following APIs:
  • 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:

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:

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.

  2. The deliveryCommitment object is now returned in the response for the following APIs:
    • Create Shipment (Domestic and International)
    • Multipiece Shipment
    • Multipiece Rates

    Example Response:

Copy
Copied
"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:
  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.

  2. 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.
  3. 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
  4. New version v1.3 of shipping 360 postman collection with updated examples and added services. Please refer Postman Collection
  5. A new Dashboard is now available in the Developer Portal to view and analyze API usage.
  6. ShipmentByRateShop added shipperId support for USPS.
  7. Batch Shipment added support for shipperId for USPS.
  8. 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.
  9. 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.
  10. 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:
  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.

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

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

4. Added a guide for Developer Partner 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.

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.

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

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.
  • Out of which, USPS and DHL Express are two major carriers added to API Carrier section:

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.

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

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.
  • It lists out the following carriers which are supported by SP360 APIs, and respective carriers’ details pages are added.

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.

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.