Shippo 4.0.0-beta.1

Shippo

<div align="left"> <a href="https://speakeasyapi.dev/"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a> <a href="https://opensource.org/licenses/MIT"> <img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" /> </a> </div>

SDK Installation

Nuget

dotnet add package Shippo

SDK Example Usage

Example

using Shippo;
using Shippo.Models.Components;
using Shippo.Models.Requests;

var sdk = new ShippoSDK(
    apiKeyHeader: "<YOUR_API_KEY_HERE>",
    shippoApiVersion: "2018-02-08");

var res = await sdk.Addresses.ListAsync(
    page: 1,
    results: 5,
    shippoApiVersion: "2018-02-08");

// handle response

Available Resources and Operations

Addresses

• List - List all addresses
• Create - Create a new address
• Get - Retrieve an address
• Validate - Validate an address

Batches

• Create - Create a batch
• Get - Retrieve a batch
• AddShipments - Add shipments to a batch
• Purchase - Purchase a batch
• RemoveShipments - Remove shipments from a batch

CarrierAccounts

• List - List all carrier accounts
• Create - Create a new carrier account
• Get - Retrieve a carrier account
• Update - Update a carrier account
• InitiateOauth2Signin - Connect an existing carrier account using OAuth 2.0
• Register - Add a Shippo carrier account
• GetRegistrationStatus - Get Carrier Registration status

CustomsDeclarations

• List - List all customs declarations
• Create - Create a new customs declaration
• Get - Retrieve a customs declaration

CustomsItems

• List - List all customs items
• Create - Create a new customs item
• Get - Retrieve a customs item

RatesAtCheckout

• Create - Generate a live rates request
• GetDefaultParcelTemplate - Show current default parcel template
• UpdateDefaultParcelTemplate - Update default parcel template
• DeleteDefaultParcelTemplate - Clear current default parcel template

Manifests

• List - List all manifests
• Create - Create a new manifest
• Get - Retrieve a manifest

Orders

• List - List all orders
• Create - Create a new order
• Get - Retrieve an order

CarrierParcelTemplates

• List - List all carrier parcel templates
• Get - Retrieve a carrier parcel templates

Parcels

• List - List all parcels
• Create - Create a new parcel
• Get - Retrieve an existing parcel

Pickups

• Create - Create a pickup

Rates

• Get - Retrieve a rate
• ListShipmentRates - Retrieve shipment rates
• ListShipmentRatesByCurrencyCode - Retrieve shipment rates in currency

Refunds

• Create - Create a refund
• List - List all refunds
• Get - Retrieve a refund

ServiceGroups

• List - List all service groups
• Create - Create a new service group
• Update - Update an existing service group
• Delete - Delete a service group

Shipments

• List - List all shipments
• Create - Create a new shipment
• Get - Retrieve a shipment

TrackingStatus

• Create - Register a tracking webhook
• Get - Get a tracking status

Transactions

• List - List all shipping labels
• Create - Create a shipping label
• Get - Retrieve a shipping label

UserParcelTemplates

• List - List all user parcel templates
• Create - Create a new user parcel template
• Delete - Delete a user parcel template
• Get - Retrieves a user parcel template
• Update - Update an existing user parcel template

ShippoAccounts

• List - List all Shippo Accounts
• Create - Create a Shippo Account
• Get - Retrieve a Shippo Account
• Update - Update a Shippo Account

Global Parameters

Global Parameters

A parameter is configured globally. This parameter may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.

For example, you can set SHIPPO-API-VERSION to "2018-02-08" at SDK initialization and then you do not have to pass the same value on calls to operations like List. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.

Available Globals

The following global parameter is available.

Example

using Shippo;
using Shippo.Models.Components;
using Shippo.Models.Requests;

var sdk = new ShippoSDK(
    apiKeyHeader: "<YOUR_API_KEY_HERE>",
    shippoApiVersion: "2018-02-08");

var res = await sdk.Addresses.ListAsync(
    page: 1,
    results: 5,
    shippoApiVersion: "2018-02-08");

// handle response

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or thow an exception. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate type.

Example

using Shippo;
using Shippo.Models.Components;
using System;
using Shippo.Models.Errors;
using Shippo.Models.Requests;

var sdk = new ShippoSDK(
    apiKeyHeader: "<YOUR_API_KEY_HERE>",
    shippoApiVersion: "2018-02-08");

InitiateOauth2SigninRequest req = new InitiateOauth2SigninRequest() {
    CarrierAccountObjectId = "<value>",
    RedirectUri = "http://fine-cummerbund.biz",
};

try
{
    var res = await sdk.CarrierAccounts.InitiateOauth2SigninAsync(req);
    // handle response
}
catch (Exception ex)
{
    if (ex is InitiateOauth2SigninResponseBody)
    {
        // handle exception
    }
    else if (ex is InitiateOauth2SigninCarrierAccountsResponseBody)
    {
        // handle exception
    }
    else if (ex is InitiateOauth2SigninCarrierAccountsResponseResponseBody)
    {
        // handle exception
    }
    else if (ex is Shippo.Models.Errors.SDKException)
    {
        // handle exception
    }
}

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the serverIndex: number optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the serverUrl: str optional parameter when initializing the SDK client instance. For example:

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

To authenticate with the API the APIKeyHeader parameter must be set when initializing the SDK client instance. For example:

using Shippo;
using Shippo.Models.Components;
using Shippo.Models.Requests;

var sdk = new ShippoSDK(
    apiKeyHeader: "<YOUR_API_KEY_HERE>",
    shippoApiVersion: "2018-02-08");

var res = await sdk.Addresses.ListAsync(
    page: 1,
    results: 5,
    shippoApiVersion: "2018-02-08");

// handle response

Development

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

SDK Created by Speakeasy