Giter VIP home page Giter VIP logo

shipengine-csharp's Introduction

ShipEngine.ApiClient - the C# library for the ShipEngine

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

This C# SDK is automatically generated by the Swagger Codegen project:

  • API version: v1
  • SDK version: 1.0.0
  • Build package: io.swagger.codegen.languages.CSharpClientCodegen

Frameworks supported

  • .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 ShipEngine.ApiClient.Api;
using ShipEngine.ApiClient.Client;
using ShipEngine.ApiClient.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 ShipEngine.ApiClient.csproj

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

Getting Started

using System;
using System.Diagnostics;
using ShipEngine.ApiClient.Api;
using ShipEngine.ApiClient.Client;
using ShipEngine.ApiClient.Model;

namespace Example
{
    public class Example
    {
        public void main()
        {

            // Configure API key authorization: api-key
            Configuration.Default.ApiKey.Add("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api-key", "Bearer");

            var apiInstance = new AddressValidationApi();
            var addresses = new List<AddressDTO>(); // List<AddressDTO> | 
            var apiKey = apiKey_example;  // string | API Key (default to jHpriMLAiP0f8PszTUn37t4D3+q2lW/G+eaMgGAupBY)

            try
            {
                List<AddressValidationResponseDTO> result = apiInstance.AddressValidationValidateAddresses(addresses, apiKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AddressValidationApi.AddressValidationValidateAddresses: " + e.Message );
            }

        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://api.shipengine.com

Class Method HTTP request Description
AddressValidationApi AddressValidationValidateAddresses POST /v1/addresses/validate
BatchesApi BatchesAddToBatch POST /v1/batches/{batch_id}/add
BatchesApi BatchesCreate POST /v1/batches
BatchesApi BatchesGet GET /v1/batches/{batch_id}
BatchesApi BatchesGetByExternalId GET /v1/batches/external_batch_id/{external_batch_id}
BatchesApi BatchesList GET /v1/batches
BatchesApi BatchesListErrors GET /v1/batches/{batch_id}/errors
BatchesApi BatchesProcess POST /v1/batches/{batch_id}/process/labels
BatchesApi BatchesRemoveFromBatch POST /v1/batches/{batch_id}/remove
CarrierAccountsApi AccessWorldwideAccountCarrierConnectAccount POST /v1/connections/carriers/access_worldwide
CarrierAccountsApi AccessWorldwideAccountCarrierDisconnectAccount DELETE /v1/connections/carriers/access_worldwide/{carrier_id}
CarrierAccountsApi ApcAccountCarrierConnectAccount POST /v1/connections/carriers/apc
CarrierAccountsApi ApcAccountCarrierDisconnectAccount DELETE /v1/connections/carriers/apc/{carrier_id}
CarrierAccountsApi AsendiaAccountCarrierConnectAccount POST /v1/connections/carriers/asendia
CarrierAccountsApi AsendiaAccountCarrierDisconnectAccount DELETE /v1/connections/carriers/asendia/{carrier_id}
CarrierAccountsApi DHLECommerceAccountCarrierConnectAccount POST /v1/connections/carriers/dhl_ecommerce
CarrierAccountsApi DHLECommerceAccountCarrierDisconnectAccount DELETE /v1/connections/carriers/dhl_ecommerce/{carrier_id}
CarrierAccountsApi DHLExpressAccountCarrierConnectAccount POST /v1/connections/carriers/dhl_express
CarrierAccountsApi DHLExpressAccountCarrierDisconnectAccount DELETE /v1/connections/carriers/dhl_express/{carrier_id}
CarrierAccountsApi DHLExpressAccountCarrierGetSettings GET /v1/connections/carriers/dhl_express/{carrier_id}/settings
CarrierAccountsApi DHLExpressAccountCarrierUpdateSettings PUT /v1/connections/carriers/dhl_express/{carrier_id}/settings
CarrierAccountsApi DHLExpressCaAccountCarrierConnectAccount POST /v1/connections/carriers/dhl_express_ca
CarrierAccountsApi DHLExpressCaAccountCarrierDisconnectAccount DELETE /v1/connections/carriers/dhl_express_ca/{carrier_id}
CarrierAccountsApi DhlExpressUkAccountCarrierConnectAccount POST /v1/connections/carriers/dhl_express_uk
CarrierAccountsApi DhlExpressUkAccountCarrierDisconnectAccount DELETE /v1/connections/carriers/dhl_express_uk/{carrier_id}
CarrierAccountsApi DpdAccountCarrierConnectAccount POST /v1/connections/carriers/dpd
CarrierAccountsApi DpdAccountCarrierDisconnectAccount DELETE /v1/connections/carriers/dpd/{carrier_id}
CarrierAccountsApi EndiciaAccountCarrierConnectAccount POST /v1/connections/carriers/endicia
CarrierAccountsApi EndiciaAccountCarrierDisconnectAccount DELETE /v1/connections/carriers/endicia/{carrier_id}
CarrierAccountsApi FedExAccountCarrierConnectAccount POST /v1/connections/carriers/fedex
CarrierAccountsApi FedExAccountCarrierDisconnectAccount DELETE /v1/connections/carriers/fedex/{carrier_id}
CarrierAccountsApi FedExAccountCarrierGetSettings GET /v1/connections/carriers/fedex/{carrier_id}/settings
CarrierAccountsApi FedExAccountCarrierUpdateSettings PUT /v1/connections/carriers/fedex/{carrier_id}/settings
CarrierAccountsApi FedExUkAccountCarrierConnectAccount POST /v1/connections/carriers/fedex_uk
CarrierAccountsApi FedExUkAccountCarrierDisconnectAccount DELETE /v1/connections/carriers/fedex_uk/{carrier_id}
CarrierAccountsApi FirstMileAccountCarrierConnectAccount POST /v1/connections/carriers/firstmile
CarrierAccountsApi FirstMileAccountCarrierDisconnectAccount DELETE /v1/connections/carriers/firstmile/{carrier_id}
CarrierAccountsApi GlobegisticsAccountCarrierConnectAccount POST /v1/connections/carriers/globegistics
CarrierAccountsApi GlobegisticsAccountCarrierDisconnectAccount DELETE /v1/connections/carriers/globegistics/{carrier_id}
CarrierAccountsApi ImexAccountCarrierConnectAccount POST /v1/connections/carriers/imex
CarrierAccountsApi ImexAccountCarrierDisconnectAccount DELETE /v1/connections/carriers/imex/{carrier_id}
CarrierAccountsApi NewgisticsAccountCarrierConnectAccount POST /v1/connections/carriers/newgistics
CarrierAccountsApi NewgisticsAccountCarrierDisconnectAccount DELETE /v1/connections/carriers/newgistics/{carrier_id}
CarrierAccountsApi NewgisticsAccountCarrierUpdateSettings PUT /v1/connections/carriers/newgistics/{carrier_id}/settings
CarrierAccountsApi OnTracAccountCarrierConnectAccount POST /v1/connections/carriers/ontrac
CarrierAccountsApi OnTracAccountCarrierDisconnectAccount DELETE /v1/connections/carriers/ontrac/{carrier_id}
CarrierAccountsApi PurolatorAccountCarrierConnectAccount POST /v1/connections/carriers/purolator_canada
CarrierAccountsApi PurolatorAccountCarrierDisconnectAccount DELETE /v1/connections/carriers/purolator_canada/{carrier_id}
CarrierAccountsApi RoyalMailAccountCarrierConnectAccount POST /v1/connections/carriers/royal_mail
CarrierAccountsApi RoyalMailAccountCarrierDisconnectAccount DELETE /v1/connections/carriers/royal_mail/{carrier_id}
CarrierAccountsApi RrDonnelleyAccountCarrierConnectAccount POST /v1/connections/carriers/rr_donnelley
CarrierAccountsApi RrDonnelleyAccountCarrierDisconnectAccount DELETE /v1/connections/carriers/rr_donnelley/{carrier_id}
CarrierAccountsApi StampsAccountCarrierConnectAccount POST /v1/connections/carriers/stamps_com
CarrierAccountsApi StampsAccountCarrierDisconnectAccount DELETE /v1/connections/carriers/stamps_com/{carrier_id}
CarrierAccountsApi StampsAccountCarrierGetAccountUrl PUT /v1/connections/carriers/stamps_com/{carrier_id}/request_account_url
CarrierAccountsApi UPSAccountCarrierConnectAccount POST /v1/connections/carriers/ups
CarrierAccountsApi UPSAccountCarrierDisconnectAccount DELETE /v1/connections/carriers/ups/{carrier_id}
CarrierAccountsApi UPSAccountCarrierGetSettings GET /v1/connections/carriers/ups/{carrier_id}/settings
CarrierAccountsApi UPSAccountCarrierUpdateSettings PUT /v1/connections/carriers/ups/{carrier_id}/settings
CarriersApi CarriersAddFunds PUT /v1/carriers/{carrier_id}/add_funds
CarriersApi CarriersGet GET /v1/carriers/{carrier_id}
CarriersApi CarriersGetOptions GET /v1/carriers/{carrier_id}/options
CarriersApi CarriersList GET /v1/carriers
CarriersApi CarriersListPackages GET /v1/carriers/{carrier_id}/packages
CarriersApi CarriersListServices GET /v1/carriers/{carrier_id}/services
EnvironmentApi EnvironmentCreateWebhook POST /v1/environment/webhooks
EnvironmentApi EnvironmentDeleteWebhook DELETE /v1/environment/webhooks/{webhook_id}
EnvironmentApi EnvironmentGetWebhookById GET /v1/environment/webhooks/{webhook_id}
EnvironmentApi EnvironmentUpdateWebhook PUT /v1/environment/webhooks/{webhook_id}
EnvironmentApi EnvironmentWebhooks GET /v1/environment/webhooks
EnvironmentApi EnvironmentWhoami GET /v1/environment/whoami
InsuranceApi InsuranceAddFunds PATCH /v1/insurance/shipsurance/add_funds
InsuranceApi InsuranceGetBalance GET /v1/insurance/shipsurance/balance
LabelsApi LabelsGet GET /v1/labels/{label_id}
LabelsApi LabelsList GET /v1/labels
LabelsApi LabelsPurchaseLabel POST /v1/labels
LabelsApi LabelsPurchaseLabelWithRate POST /v1/labels/rates/{rate_id}
LabelsApi LabelsPurchaseLabelWithShipment POST /v1/labels/shipment/{shipment_id}
LabelsApi LabelsTrack GET /v1/labels/{label_id}/track
LabelsApi LabelsVoidLabel PUT /v1/labels/{label_id}/void
ManifestsApi ManifestsCreate POST /v1/manifests
ManifestsApi ManifestsGet GET /v1/manifests/{manifest_id}
ManifestsApi ManifestsList GET /v1/manifests
MarketplaceAccountsApi AmazonAccountConnect POST /v-beta/connections/marketplaces/amazon
MarketplaceAccountsApi AmazonAccountDeactivate PUT /v-beta/connections/marketplaces/amazon/{store_id}/deactivate
MarketplaceAccountsApi AmazonAccountReactivate PUT /v-beta/connections/marketplaces/amazon/{store_id}/reactivate
MarketplaceAccountsApi AmazonAccountTest GET /v-beta/connections/marketplaces/amazon/{store_id}/test
MarketplaceAccountsApi AmazonAccountUpdateSettings GET /v-beta/connections/marketplaces/amazon/{store_id}/settings
MarketplaceAccountsApi AmazonCaAccountConnect POST /v-beta/connections/marketplaces/amazon_ca
MarketplaceAccountsApi AmazonCaAccountDeactivate PUT /v-beta/connections/marketplaces/amazon_ca/{store_id}/deactivate
MarketplaceAccountsApi AmazonCaAccountReactivate PUT /v-beta/connections/marketplaces/amazon_ca/{store_id}/reactivate
MarketplaceAccountsApi AmazonCaAccountTest GET /v-beta/connections/marketplaces/amazon_ca/{store_id}/test
MarketplaceAccountsApi AmazonCaAccountUpdateSettings GET /v-beta/connections/marketplaces/amazon_ca/{store_id}/settings
MarketplaceAccountsApi BrightpearlAccountConnect POST /v-beta/connections/marketplaces/brightpearl
MarketplaceAccountsApi BrightpearlAccountDeactivate PUT /v-beta/connections/marketplaces/brightpearl/{store_id}/deactivate
MarketplaceAccountsApi BrightpearlAccountReactivate PUT /v-beta/connections/marketplaces/brightpearl/{store_id}/reactivate
MarketplaceAccountsApi BrightpearlAccountTest GET /v-beta/connections/marketplaces/brightpearl/{store_id}/test
MarketplaceAccountsApi BrightpearlAccountUpdateSettings PUT /v-beta/connections/marketplaces/brightpearl/{store_id}/settings
MarketplaceAccountsApi ChannelAdvisorAccountConnect POST /v-beta/connections/marketplaces/channeladvisor
MarketplaceAccountsApi ChannelAdvisorAccountDeactivate PUT /v-beta/connections/marketplaces/channeladvisor/{store_id}/deactivate
MarketplaceAccountsApi ChannelAdvisorAccountReactivate PUT /v-beta/connections/marketplaces/channeladvisor/{store_id}/reactivate
MarketplaceAccountsApi ChannelAdvisorAccountTest GET /v-beta/connections/marketplaces/channeladvisor/{store_id}/test
MarketplaceAccountsApi ChannelAdvisorAccountUpdateSettings PUT /v-beta/connections/marketplaces/channeladvisor/{store_id}/settings
MarketplaceAccountsApi EbayAccountConnectAccessToken POST /v-beta/connections/marketplaces/ebay/access_token
MarketplaceAccountsApi EbayAccountDeactivate PUT /v-beta/connections/marketplaces/ebay/{store_id}/deactivate
MarketplaceAccountsApi EbayAccountReactivate PUT /v-beta/connections/marketplaces/ebay/{store_id}/reactivate
MarketplaceAccountsApi EbayAccountTest GET /v-beta/connections/marketplaces/ebay/{store_id}/test
MarketplaceAccountsApi EbayAccountUpdateSettings PUT /v-beta/connections/marketplaces/ebay/{store_id}/settings
MarketplaceAccountsApi EtsyAccountConnect POST /v-beta/connections/marketplaces/etsy/access_token
MarketplaceAccountsApi EtsyAccountDeactivate PUT /v-beta/connections/marketplaces/etsy/{store_id}/deactivate
MarketplaceAccountsApi EtsyAccountReactivate PUT /v-beta/connections/marketplaces/etsy/{store_id}/reactivate
MarketplaceAccountsApi EtsyAccountTest GET /v-beta/connections/marketplaces/etsy/{store_id}/test
MarketplaceAccountsApi EtsyAccountUpdateSettings PUT /v-beta/connections/marketplaces/etsy/{store_id}/settings
MarketplaceAccountsApi MagentoAccountConnect POST /v-beta/connections/marketplaces/magento
MarketplaceAccountsApi MagentoAccountDeactivate PUT /v-beta/connections/marketplaces/magento/{store_id}/deactivate
MarketplaceAccountsApi MagentoAccountReactivate PUT /v-beta/connections/marketplaces/magento/{store_id}/reactivate
MarketplaceAccountsApi MagentoAccountTest GET /v-beta/connections/marketplaces/magento/{store_id}/test
MarketplaceAccountsApi MagentoAccountUpdateSettings PUT /v-beta/connections/marketplaces/magento/{store_id}/settings
MarketplaceAccountsApi ShopifyAccountConnectAccessToken POST /v-beta/connections/marketplaces/shopify/access_token
MarketplaceAccountsApi ShopifyAccountDeactivate PUT /v-beta/connections/marketplaces/shopify/{store_id}/deactivate
MarketplaceAccountsApi ShopifyAccountReactivate PUT /v-beta/connections/marketplaces/shopify/{store_id}/reactivate
MarketplaceAccountsApi ShopifyAccountTest GET /v-beta/connections/marketplaces/shopify/{store_id}/test
MarketplaceAccountsApi ShopifyAccountUpdateSettings PUT /v-beta/connections/marketplaces/shopify/{store_id}/settings
MarketplaceAccountsApi ThreeDCartAccountConnect POST /v-beta/connections/marketplaces/threedcart/access_token
MarketplaceAccountsApi ThreeDCartAccountDeactivate PUT /v-beta/connections/marketplaces/threedcart/{store_id}/deactivate
MarketplaceAccountsApi ThreeDCartAccountReactivate PUT /v-beta/connections/marketplaces/threedcart/{store_id}/reactivate
MarketplaceAccountsApi ThreeDCartAccountTest GET /v-beta/connections/marketplaces/threedcart/{store_id}/test
MarketplaceAccountsApi ThreeDCartAccountUpdateSettings PUT /v-beta/connections/marketplaces/threedcart/{store_id}/settings
NLPApi NLPRecognizeAddress PUT /v1/addresses/recognize Identifies address-related entities (name, line1, line2, city, postal code, etc.) in unstructured text
NLPApi NLPRecognizeShipment PUT /v1/shipments/recognize Identifies shipment-related entities (names, address parts, package dimensions, weight, insurance options, etc.) in unstructured text
PackagesApi PackagesCreate POST /v1/packages
PackagesApi PackagesDelete DELETE /v1/packages/{package_id}
PackagesApi PackagesGet GET /v1/packages/{package_id}
PackagesApi PackagesList GET /v1/packages
PackagesApi PackagesUpdate PUT /v1/packages/{package_id}
RatesApi RatesEstimate POST /v1/rates/estimate
RatesApi RatesGet GET /v1/rates/{rate_id}
RatesApi RatesRateShipment POST /v1/rates
RatesApi RatesRateShipmentsAsync POST /v1/rates/bulk
ShipmentsApi ShipmentsAddTag POST /v1/shipments/{shipment_id}/tags/{tag}
ShipmentsApi ShipmentsCancel PUT /v1/shipments/{shipment_id}/cancel
ShipmentsApi ShipmentsCreateShipments POST /v1/shipments
ShipmentsApi ShipmentsGet GET /v1/shipments/{shipment_id}
ShipmentsApi ShipmentsGetByExternalId GET /v1/shipments/external_shipment_id/{external_shipment_id}
ShipmentsApi ShipmentsGetRatesForShipment GET /v1/shipments/{shipment_id}/rates
ShipmentsApi ShipmentsList GET /v1/shipments
ShipmentsApi ShipmentsListErrors GET /v1/shipments/{shipment_id}/errors
ShipmentsApi ShipmentsRemoveTag DELETE /v1/shipments/{shipment_id}/tags/{tag}
ShipmentsApi ShipmentsUpdateShipment PUT /v1/shipments/{shipment_id}
TagsApi TagsAddTag POST /v1/tags/{tag_name}
TagsApi TagsDelete DELETE /v1/tags/{tag_name}
TagsApi TagsListTags GET /v1/tags
TagsApi TagsUpdateTag PUT /v1/tags/{tag_name}/{new_name}
TrackingApi TrackingStartTracking POST /v1/tracking/start
TrackingApi TrackingStopTracking POST /v1/tracking/stop
TrackingApi TrackingTrack GET /v1/tracking
WarehousesApi WarehousesCreate POST /v1/warehouses
WarehousesApi WarehousesDelete DELETE /v1/warehouses/{warehouse_id}
WarehousesApi WarehousesGet GET /v1/warehouses/{warehouse_id}
WarehousesApi WarehousesList GET /v1/warehouses
WarehousesApi WarehousesUpdate PUT /v1/warehouses/{warehouse_id}

Documentation for Models

Documentation for Authorization

api-key

  • Type: API key
  • API key parameter name: api-key
  • Location: HTTP header

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.