Skip to content

DumbSolutions/ShipmondoApi.Dotnet

BranchesTags

Repository files navigation

ShipmondoApi.Dotnet - the C# library for the Shipmondo API

A unofficial thirdparty library for shipmondo api for dotnet

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

  • API version: 3
  • SDK version: 1.0.3
  • Build package: org.openapitools.codegen.languages.CSharpNetCoreClientCodegen

Frameworks supported

  • .NET Core >=1.0
  • .NET Framework >=4.6
  • Mono/Xamarin >=vNext

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

Generate the DLL using your preferred tool (e.g. dotnet build)

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

using ShipmondoApi.Dotnet.Api;
using ShipmondoApi.Dotnet.Client;
using ShipmondoApi.Dotnet.Model;

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 ShipmondoApi.Dotnet.Api;
using ShipmondoApi.Dotnet.Client;
using ShipmondoApi.Dotnet.Model;

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

            Configuration config = new Configuration();
            config.BasePath = "https://app.shipmondo.com/api/public/v3";
            // Configure HTTP basic authorization: basicAuth
            config.Username = "YOUR_USERNAME";
            config.Password = "YOUR_PASSWORD";

            var apiInstance = new AccountApi(config);

            try
            {
                // Retrieve account infomation
                Account200Response result = apiInstance.Account();
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling AccountApi.Account: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://app.shipmondo.com/api/public/v3

Class Method HTTP request Description
AccountApi Account GET /account/ Retrieve account infomation
AccountApi AccountBalanceGet GET /account/balance Retrieve balance
AccountApi PaymentRequestsGet GET /account/payment_requests List all payment requests
BookkeepingIntegrationsApi BookkeepingIntegrationGet GET /bookkeeping_integrations/{id} Retrieve a bookkeeping integration
BookkeepingIntegrationsApi BookkeepingIntegrationsGet GET /bookkeeping_integrations List all bookkeeping integrations
CarriersProductsServicesApi CarriersGet GET /carriers List available carriers
CarriersProductsServicesApi PackageTypesGet GET /package_types List all package types
CarriersProductsServicesApi ProductsGet GET /products List all products
DocumentsApi EndOfDayGet GET /documents/end_of_day Retrieve an End of Day list
DocumentsApi WaybillGet GET /documents/waybill Retrieve a waybill
DraftShipmentsApi DraftShipmentDelete DELETE /draft_shipments/{id} Archive a draft shipment
DraftShipmentsApi DraftShipmentGet GET /draft_shipments/{id} Retrieve a draft shipment
DraftShipmentsApi DraftShipmentPut PUT /draft_shipments/{id} Update a draft shipment
DraftShipmentsApi DraftShipmentsGet GET /draft_shipments List all draft shipments
DraftShipmentsApi DraftShipmentsPost POST /draft_shipments Create a draft shipment
ItemsApi ItemCreate POST /items Create an item
ItemsApi ItemGet GET /items/{id} Retrieve an item
ItemsApi ItemUpdate PUT /items/{id} Update an item
ItemsApi ItemsGet GET /items List all items
LabelsApi LabelsGet GET /labels Retrieve labels for multiple shipments
LabelsApi ShipmentLabels GET /shipments/{id}/labels Retrieve labels of a shipment
PaymentGatewaysApi PaymentGatewayGet GET /payment_gateways/{id} Retrieve a payment gateway
PaymentGatewaysApi PaymentGatewaysGet GET /payment_gateways List all payment gateways
PickupRequestsApi PickupRequestsGet GET /pickup_requests List all pickup requests
PickupRequestsApi PickupRequestsPost POST /pickup_requests Create a pickup request
PickupRequestsApi PickupRequestsShow GET /pickup_requests/{id} Retrieve a pickup request
PrintClientApi PrintJobs POST /print_jobs Create a print job
PrintClientApi PrintJobsPost POST /print_jobs/batch Create a print job batch
PrintClientApi PrintersGet GET /printers List all printers
QuotesApi QuotesListPost POST /quotes/list List available quotes for a shipment
QuotesApi QuotesPost POST /quotes Create a shipment quote
ReturnPortalsApi ReturnPortalGet GET /return_portals/{id} Retrieve a return portal
ReturnPortalsApi ReturnPortalsGet GET /return_portals List all return portals
ReturnPortalsApi ReturnPortalsShipmentsGet GET /return_portals/{id}/shipments List all shipments for a return portal
SalesOrdersApi FulfillmentGet GET /fulfillments/{id} Retrieve a fulfillment
SalesOrdersApi FulfillmentPost POST /sales_orders/{id}/fulfillments Create a fulfillment
SalesOrdersApi PackingSlipGet GET /packing_slips Retrieve packing slips
SalesOrdersApi PickListGet GET /pick_lists Retrieve pick lists
SalesOrdersApi SalesOrderBarcode POST /sales_orders/barcode Process a barcode
SalesOrdersApi SalesOrderCapture POST /sales_orders/{id}/capture Capture payment
SalesOrdersApi SalesOrderCreateShipment POST /sales_orders/{id}/create_shipment Create a shipment
SalesOrdersApi SalesOrderFulfillmentsGet GET /sales_orders/{id}/fulfillments List fulfillments
SalesOrdersApi SalesOrderGet GET /sales_orders/{id} Retrieve a sales order
SalesOrdersApi SalesOrderPackagingGet GET /sales_order_packagings/{id} Retrieve a packaging
SalesOrdersApi SalesOrderPackagingsGet GET /sales_order_packagings List all packagings
SalesOrdersApi SalesOrderPackingSlips GET /sales_orders/{id}/packing_slips Retrieve a packing slip
SalesOrdersApi SalesOrderPickList GET /sales_orders/{id}/pick_list Retrieve a pick list
SalesOrdersApi SalesOrderPut PUT /sales_orders/{id} Update a sales order
SalesOrdersApi SalesOrderUpdateNote PUT /sales_orders/{id}/order_note Update a sales order note
SalesOrdersApi SalesOrdersGet GET /sales_orders List all sales orders
SalesOrdersApi SalesOrdersPost POST /sales_orders Create a sales order
ServicePointsApi PickupPointsGet GET /pickup_points List pickup points
ShipmentTemplatesApi ShipmentTemplateGet GET /shipment_templates/{id} Retrieve a shipment template
ShipmentTemplatesApi ShipmentTemplatesGet GET /shipment_templates List all shipment templates
ShipmentsApi ProformaInvoicesGet GET /shipments/{id}/proforma_invoices Retrieve a proforma invoice
ShipmentsApi ShipmentCancelAtCarrier PUT /shipments/{id}/cancel_at_carrier Cancel a shipment
ShipmentsApi ShipmentGet GET /shipments/{id} Retrieve a shipment
ShipmentsApi ShipmentWaybillGet GET /shipments/{id}/waybills Retrieve waybill for a shipment
ShipmentsApi ShipmentsGet GET /shipments List all shipments
ShipmentsApi ShipmentsPost POST /shipments Create a shipment
ShipmentsApi ShipmentsQrCodeGet GET /shipments/{id}/qr_code Fetch qr codes for a shipment
ShipmentsApi ShipmentsQuotePost POST /shipments/quote Create a shipment quote
StaffAccountsApi StaffAccountGet GET /staff_accounts/{id} Retrieve a single staff account
StaffAccountsApi StaffAccountsGet GET /staff_accounts List all staff accounts
WaybillsApi WaybillsClose PUT /waybills/{id}/close Close an open waybill
WaybillsApi WaybillsGet GET /waybills List all waybills
WaybillsApi WaybillsPost POST /waybills Create a waybill
WaybillsApi WaybillsShow GET /waybills/{id} Retrieve a waybill
WebhooksApi WebhookCreate POST /webhooks Create a webhook
WebhooksApi WebhookDelete DELETE /webhooks/{id} Delete a webhook
WebhooksApi WebhookGet GET /webhooks/{id} Retrieve a webhook
WebhooksApi WebhookUpdate PUT /webhooks/{id} Update a webhook
WebhooksApi WebhooksGet GET /webhooks List all webhooks

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

basicAuth

  • Type: HTTP basic authentication

About

A unofficial thirdparty library for shipmondo api for dotnet

www.nuget.org/packages/ShipmondoApi.Dotnet

Topics

api rest-api shipment shipmondo

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases 4

v1.0.3 Latest
Jun 22, 2023
+ 3 releases

Packages

No packages published

Languages