Giter Site home page Giter Site logo

pitneybowes-shipping-api-csharp-openapi's Introduction

shippingapi - the C# library for the Shipping API

Shipping API Sample

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

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

Frameworks supported

FOSSA Status

  • .NET 4.0 or later
  • Windows Phone 7.1 (Mango)

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

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742

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 shippingapi.Api;
using shippingapi.Client;
using shippingapi.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 shippingapi.csproj

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

Getting Started

using System.Collections.Generic;
using System.Diagnostics;
using shippingapi.Api;
using shippingapi.Client;
using shippingapi.Model;

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

            Configuration.Default.BasePath = "https://shipping-api-sandbox.pitneybowes.com/shippingservices";
            // Configure OAuth2 access token for authorization: oAuth2ClientCredentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AddressValidationApi(Configuration.Default);
            var address = new Address(); // Address | Address object that needs to be validated.
            var xPBUnifiedErrorStructure = true;  // bool? | Set this to true to use the standard [error object](https://shipping.pitneybowes.com/reference/error-object.html#standard-error-object) if an error occurs. (optional)  (default to true)
            var minimalAddressValidation = true;  // bool? | When set to true, the complete address (delivery line and last line) is validated but only the last line (city, state, and postal code) would be changed by the validation check. (optional) 

            try
            {
                // Address validation
                Address result = apiInstance.VerifyAddress(address, xPBUnifiedErrorStructure, minimalAddressValidation);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling AddressValidationApi.VerifyAddress: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

Documentation for API Endpoints

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

Class Method HTTP request Description
AddressValidationApi VerifyAddress POST /v1/addresses/verify Address validation
AddressValidationApi VerifyAndSuggestAddress POST /v1/addresses/verify-suggest Address Suggestion
CarrierInfoApi GetCarrierFacilities POST /v1/carrier-facility Find Carrier Facilities
CarrierInfoApi GetCarrierLicenseAgreement GET /v1/carrier/license-agreements This operation retrieves a carrier's license agreement.
CarrierInfoApi GetCarrierServiceRules GET /v1/information/rules/rating-services Retrieves the rules governing the carrier's services.
CarrierInfoApi GetCarrierSupportedDestination GET /v1/countries This operation returns a list of supported destination countries to which the carrier offers international shipping services.
ContainerApi GetContainerizedParcelsLabels POST /v1/container-manifest Create Container Manifest Label
CrossBorderQuotesApi GetCrossBorderQuotes POST /v1/crossborder/checkout/quotes Cross-Border Quotes
CrossBorderQuotesApi PredictedHSCode POST /v1/crossborder/hs-classification/items Predicts the HS Code for a parcel
ManifestsApi CreateManifest POST /v1/manifests This operation creates an end-of-day manifest
ManifestsApi ReprintManifest GET /v1/manifests/{manifestId} reprintManifest
ManifestsApi RetryManifest GET /v1/manifests retryManifest
ParcelProtectionApi CancelParcelProtection POST /v1/parcel-protection/void Parcel Protection Coverage
ParcelProtectionApi GetParcelProtectionCoverage POST /v1/parcel-protection/create Parcel Protection Coverage
ParcelProtectionApi GetParcelProtectionQuote POST /v1/parcel-protection/quote Parcel Protection Quote
ParcelProtectionApi GetParcelProtectionReports GET /v1/parcel-protection/{developerId}/policies Parcel Protection Reports
PickupApi CancelPickup POST /v1/pickups/{pickupId}/cancel Cancel Pickup
PickupApi GetPickupschedule POST /v1/pickups/schedule Address validation
RateParcelsApi RateParcel POST /v1/rates Use this operation to rate a parcel before you print and purchase a shipment label. You can rate a parcel for multiple services and multiple parcel types with a single API request.
ShipmentApi CancelShipment DELETE /v1/shipments/{shipmentId} cancelShipment
ShipmentApi CreateShipmentLabel POST /v1/shipments This operation creates a shipment and purchases a shipment label.
ShipmentApi ReprintShipment GET /v1/shipments/{shipmentId} reprintShipment
ShipmentApi RetryShipment GET /v1/shipments retryShipment
TrackingApi AddTrackingEvents POST /v2/track/events getTrackingDetails
TrackingApi GetTrackingDetails GET /v1/tracking/{trackingNumber} getTrackingDetails
TransactionReportsApi GetTransactionReport GET /v4/ledger/developers/{developerId}/transactions/reports This operation retrieves all transactions for a specified period of time.

Documentation for Models

Documentation for Authorization

oAuth2ClientCredentials

  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes: N/A

License

FOSSA Status

pitneybowes-shipping-api-csharp-openapi's People

Contributors

am005si avatar fossabot avatar na003za avatar nex1dhu avatar singhamitaks avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.