Skip to content

PitneyBowes/pitneybowes-360api-shipping-csharp

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
.openapi-generator
.openapi-generator
 
 
api
api
 
 
docs
docs
 
 
src
src
 
 
.gitignore
.gitignore
 
 
.openapi-generator-ignore
.openapi-generator-ignore
 
 
README.md
README.md
 
 
appveyor.yml
appveyor.yml
 
 
com.pitneybowes.api360.sln
com.pitneybowes.api360.sln
 
 
git_push.sh
git_push.sh
 
 

Repository files navigation

C# library for the API 360 Shipping APIs

Introduction

The Shipping APIs include a variety of operations that allow users to manage and track their shipping requests.

Some of the key API operations available in the Shipping API includes:

Shipment API

Operation Description
Get Carriers This operation fetches all onboarded carriers. Typically, user will use this service to get list of onboarded carriers and supported properties for those carriers.
Get Countries This operation fetches list of supported destination countries for a provided carrier and origin country.
Get Services This operation fetches a list of supported services for a carrier with respect to specific origin and destination country.
Get ParcelTypes This operation fetches ParcelTypes based on carrier, origin and destination country.
Get Special Services This operation fetches Special Services for a given carrier, service, origin and destination country.
Get Carrier Accounts This operation retrieves onboarded Carriers with their Carrier Account Ids which uniquely identify multiple accounts of same carrier.
Rate Shop and Get Single Rate This API contains 2 operations, rate shop and single rate. Rate shop will fetch rates for all carrier services based on the given addresses (From and To), weight, and dimension for given parcelType. Single rate will get rate for specific service and special service (if requested) based on the given addresses (From and To), weight, and dimension, parcelType and serviceId with or without specialServices. Single rate will be used mainly to a rate a shipment before creating shipment.
Create Shipment This operation creates a new Shipment or Shipment Label. This is for both Domestic and International.
Get All Shipments This operation fetches all created Shipments.
Get Shipment by Id Retrieves single shipment using Shipment Id.
Reprint Shipment This operation reprints Shipment by the shipmentId. It retrieves an existing shipping label to reprint. The API sends the shipmentId returned by the original Created Shipment request. Use this only if the shipping label in the Create Shipment response was spoilt or lost.
Cancel Shipment This operation cancels previously created shipment.

This C# SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • SDK version: 1.0.0
  • Generator version: 7.7.0
  • Build package: org.openapitools.codegen.languages.CSharpClientCodegen

Frameworks supported

Dependencies

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742. NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See RestSharp#1406.

Installation

Run the following command to generate the DLL

  • [Mac/Linux] /bin/sh build.sh
  • [Windows] build.bat

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using com.pitneybowes.api360.Api;
using com.pitneybowes.api360.Client;
using com.pitneybowes.api360.Model;

Packaging

A .nuspec is included with the project. You can follow the Nuget quickstart to create and publish packages.

This .nuspec uses placeholders from the .csproj, so build the .csproj directly:

nuget pack -Build -OutputDirectory out com.pitneybowes.api360.csproj

Then, publish to a local feed or other host and consume the new package via Nuget as usual.

Usage

To use the API client with a HTTP proxy, setup a System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

Getting Started

using System.Collections.Generic;
using System.Diagnostics;
using com.pitneybowes.api360.Api;
using com.pitneybowes.api360.Client;
using com.pitneybowes.api360.Model;

namespace Example
{
    public class Example
    {
        public static void Main()
        {

            Configuration config = new Configuration();
            config.BasePath = "https://api-sandbox.sendpro360.pitneybowes.com/shipping";
            // Configure Bearer token for authorization: bearerAuth
            config.AccessToken = "YOUR_BEARER_TOKEN";

            var apiInstance = new AddressApi(config);
            var addressSuggestRequest = new AddressSuggestRequest(); // AddressSuggestRequest | 

            try
            {
                // Address Suggest
                AddressSuggestResponse result = apiInstance.AddressSuggest(addressSuggestRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling AddressApi.AddressSuggest: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://api-sandbox.sendpro360.pitneybowes.com/shipping

Class Method HTTP request Description
AddressApi AddressSuggest POST /api/v1/address/suggest Address Suggest
AddressApi AddressValidate POST /api/v1/address/verify Address Validate
BatchApi BulkImportAPI POST /api/v1/shipments/importUrl Bulk Import Shipments
BatchApi BulkImportAPIERR POST /api/v1/err/shipments/importUrl Bulk Import Shipments ERR
BatchApi CreateBulkShipmentsAPI POST /api/v1/bulkShipments Create Bulk Shipments
BatchApi CreateBulkShipmentsAPIERR POST /api/v1/err/bulkShipments Create Bulk Shipments ERR
BatchApi GetBatchStatusAPI GET /api/v1/shipments/batch/{batchId}/status Get Batch Status
BatchApi GetShipmentDetailsForBatchAPI GET /api/v1/shipments/batch/{batchId}/shipments Get Batch Shipment Details
BatchApi ProcessBatchAPI POST /api/v1/shipments/batch/{batchId}/process Process Batch
BatchApi VoidShippingLabel POST /api/v1/shipments/batch/{batchId}/void Void Batch Shipping Labels
DefaultsApi CreateDefaults POST /api/v1/defaults Create Defaults
DefaultsApi DeleteDefaultsById DELETE /api/v1/defaults/{defaultID} Delete Defaults by ID
DefaultsApi GetAllDefaults GET /api/v1/defaults Get All Defaults
DefaultsApi GetDefaultsById GET /api/v1/defaults/{defaultID} Get Defaults By ID
DefaultsApi PutDefaultsById PUT /api/v1/defaults/{defaultID} Update Defaults
ManifestApi CreateManifest POST /api/v1/manifests Create Manifest
ManifestApi ReprintManifest POST /api/v1/manifests/reprint Reprint manifest
MultipieceApi MultipieceRates POST /api/v1/multipiece/rates Multipiece Rateshop and Rates
MultipieceApi MultipieceShipment POST /api/v1/multipiece/shipments Multipiece Shipment
MultipieceApi MultipieceShipmentCancel PUT /api/v1/multipiece/shipments/{shipmentId}/cancel Cancel Multipiece Shipment
MultipieceApi MultipieceShipmentReprint GET /api/v1/multipiece/shipments/{shipmentId}/reprint Reprint Multipiece Shipment
PickupsApi CancelPickups PUT /api/v1/pickups/cancel Cancel Pickups
PickupsApi CancelledPickupDocument POST /api/v1/pickups/document Cancelled Pickup Document
PickupsApi GetPickupDocument GET /api/v1/pickups/{pickupId}/document Get Pickup Document
PickupsApi GetPickups GET /api/v1/pickups Get Pickups
PickupsApi SchedulePickup POST /api/v1/pickups Schedule Pickup
PrintApi DeletePrinterMapping DELETE /api/v1/printer/mapping Delete Printer mapping
PrintApi GetPrinterMapping GET /api/v1/printer/mapping Get Printer mapping
PrintApi JobStatus GET /api/v1/jobs/{jobId} Job status
PrintApi PrintDocument POST /api/v1/document/print Print Document
PrintApi PrinterMapping POST /api/v1/printer/mapping Printer mapping
ShipmentApi CancelShipmentById PUT /api/v1/shipments/{shipmentId}/cancel Cancel Shipment
ShipmentApi CancelStampsERR POST /api/v1/err/stamps/void Cancel Stamps ERR
ShipmentApi CreateReturnLabel POST /api/v1/shipments/{shipmentId}/return Create Return label shipment
ShipmentApi CreateShipment POST /api/v1/shipments Create Shipment
ShipmentApi DownloadBpodFiles POST /api/v1/err/shipments/bpod Download BPOD Files
ShipmentApi GetAllShipments GET /api/v1/shipments Get All Shipments
ShipmentApi GetCarrierAccounts GET /api/v1/carrierAccounts Get Carrier Accounts
ShipmentApi GetCarriers GET /api/v1/carriers Get Carriers
ShipmentApi GetCountries GET /api/v1/countries Get Countries
ShipmentApi GetParcelTypes GET /api/v1/parcelTypes Get Parcel Types
ShipmentApi GetRates POST /api/v1/rates Rate Shop and Get Single Rate
ShipmentApi GetServices GET /api/v1/services Get Services
ShipmentApi GetSignatureImageERR GET /api/v1/err/shipments/{shipmentId}/signaturefile Signature Image ERR
ShipmentApi GetSpecialServices GET /api/v1/specialServices Get Special Services
ShipmentApi ReprintShipmentById GET /api/v1/shipments/{shipmentId}/reprint Reprint Shipment
ShipmentApi ShipmentById GET /api/v1/shipments/{shipmentId} Get Shipment by Id
ShipmentByRateShopApi CancelShipmentByIdV2 POST /api/v2/shipments/cancel Cancel Shipment
ShipmentByRateShopApi CreateShipmentV2 POST /api/v2/shipments Create Shipment
ShipmentByRateShopApi ReprintShipmentByIdV2 POST /api/v2/shipments/reprint Reprint Shipment

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

bearerAuth

  • Type: Bearer Authentication

About

API 360 shipping SDK

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages