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
- .NET Core >=1.0
- .NET Framework >=4.6
- Mono/Xamarin >=vNext
- RestSharp - 106.13.0 or later
- Json.NET - 13.0.2 or later
- JsonSubTypes - 1.8.0 or later
- System.ComponentModel.Annotations - 5.0.0 or later
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.
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;
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;
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);
}
}
}
}
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 |
- Model.Account200Response
- Model.Account401Response
- Model.AccountBalanceGet200Response
- Model.BookkeepingIntegration
- Model.BookkeepingIntegrationsGet404Response
- Model.Carrier
- Model.CarriersGet422Response
- Model.CloseWaybillRequest
- Model.Country
- Model.CreateDraftShipmentRequest
- Model.CreateFulfillmentRequest
- Model.CreateFulfillmentRequestFulfillmentLinesInner
- Model.CreateItemRequest
- Model.CreatePickupRequestRequest
- Model.CreatePickupRequestRequestPickupAddress
- Model.CreateQuoteListRequest
- Model.CreateQuoteRequest
- Model.CreateQuoteResponse
- Model.CreateSalesOrderRequest
- Model.CreateShipmentAdvanced
- Model.CreateShipmentQuoteResponse
- Model.CreateShipmentQuoteResponseCarrierPrice
- Model.CreateShipmentRequest
- Model.CreateShipmentRequestCarrierInsurance
- Model.CreateShipmentRequestCod
- Model.CreateShipmentRequestDfm
- Model.CreateShipmentRequestSimple
- Model.CreateShipmentRequestSimpleWithServicePoint
- Model.CreateShipmentRequestSimpleWithServicePointServicePoint
- Model.CreateWaybillRequest
- Model.CreateWaybillRequestDelivery
- Model.CreateWaybillRequestLoading
- Model.CreateWaybillRequestPackagesInner
- Model.CreateWaybillRequestReceiver
- Model.CreateWaybillRequestSender
- Model.CustomsGood
- Model.CustomsRequest
- Model.DangerousGood
- Model.DeclaredValue
- Model.Document
- Model.DraftShipment
- Model.Fulfillment
- Model.FulfillmentCreated
- Model.FulfillmentCreatedFulfillmentLinesInner
- Model.FulfillmentFulfillmentLinesInner
- Model.GoodsLine
- Model.Item
- Model.Label
- Model.Labels
- Model.OrderLine
- Model.OrderLineRequest
- Model.OrderLineUpdate
- Model.PackageType
- Model.PackingSlip
- Model.PackingSlipData
- Model.PalletExchange
- Model.Parcel
- Model.ParcelAdvanced
- Model.ParcelSimple
- Model.PaymentDetails
- Model.PaymentDetailsRequest
- Model.PaymentGateway
- Model.PaymentRequest
- Model.PickList
- Model.PickListData
- Model.PickUp
- Model.PickupRequest
- Model.PickupRequestNoShipments
- Model.PickupRequestPickupAddress
- Model.PickupRequestShipmentsInner
- Model.PrintAt
- Model.PrintJob
- Model.PrintJobBatch
- Model.PrintJobBatchPrintJobsInner
- Model.PrintJobs200Response
- Model.PrintJobsPost200Response
- Model.Printer
- Model.ProcessSalesOrderBarcode
- Model.ProformaInvoice
- Model.QrCode
- Model.QrCode2
- Model.QuoteReceiver
- Model.QuoteSender
- Model.Receiver
- Model.ReceiverRequest
- Model.RequiredShippingProductService
- Model.ReturnPortal
- Model.SalesOrder
- Model.SalesOrderBillTo
- Model.SalesOrderBillToRequest
- Model.SalesOrderPackaging
- Model.SalesOrderShipTo
- Model.SalesOrderShipToRequest
- Model.SendLabel
- Model.Sender
- Model.SenderRequest
- Model.ServicePoint
- Model.ServicePointInShipmentRequest
- Model.ServicePointSimple
- Model.Shipment
- Model.ShipmentBillTo
- Model.ShipmentBillToRequest
- Model.ShipmentCancelled
- Model.ShipmentCarrierInsurance
- Model.ShipmentPickUpRequest
- Model.ShipmentReceiver
- Model.ShipmentReturnToRequest
- Model.ShipmentSender
- Model.ShipmentServicePoint
- Model.ShipmentTemplate
- Model.ShipmentTemplateReceiver
- Model.ShipmentTemplateSender
- Model.ShippingProduct
- Model.ShippingProductCustomerNumbersInner
- Model.ShippingProductService
- Model.SimpleCustoms
- Model.StaffAccount
- Model.UpdateItemRequest
- Model.UpdateSalesOrderNote
- Model.UpdateSalesOrderRequest
- Model.Waybill
- Model.WaybillDelivery
- Model.WaybillLoading
- Model.WaybillNoBase64
- Model.WaybillNoBase64Loading
- Model.WaybillNoBase64Receiver
- Model.WaybillNoBase64Sender
- Model.WaybillNoBase64Shipment
- Model.WaybillReceiver
- Model.WaybillSender
- Model.WaybillShipment
- Model.Webhook
- Model.WebhookCreate
- Model.WeightInterval
Authentication schemes defined for the API:
- Type: HTTP basic authentication