https://github.com/janssenr/sendcloudapi.net

A C#/.net wrapper for the SendCloud API
https://github.com/janssenr/sendcloudapi.net

Last synced: 8 days ago
JSON representation

A C#/.net wrapper for the SendCloud API

• Host: GitHub
• URL: https://github.com/janssenr/sendcloudapi.net
• Owner: janssenr
• License: mit
• Created: 2018-03-01T12:00:52.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2024-03-25T19:21:11.000Z (10 months ago)
• Last Synced: 2024-04-28T03:14:44.462Z (9 months ago)
• Language: C#
• Homepage:
• Size: 107 KB
• Stars: 6
• Watchers: 4
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# SendCloudApi.Net

An unofficial client for the SendCloud API. More info about SendCloud on http://sendcloud.nl. Below are some examples on the usage of this client.

Full docs of the SendCloud API can be found on https://api.sendcloud.dev/docs/sendcloud-public-api/getting-started

[![GitHub license](https://img.shields.io/badge/license-MIT-green.svg)](https://raw.githubusercontent.com/janssenr/SendCloudApi.Net/master/LICENSE)

[![Twitter URL](https://img.shields.io/badge/twitter-follow-1da1f2.svg)](https://twitter.com/janssenr)

[![Donate](https://img.shields.io/badge/%24-donate-ff00ff.svg)](https://www.paypal.me/janssenr)

## Installation

This project can easily be installed through NuGet.

```

Install-Package SendCloudApi

```

## Set-up connection

Prepare the client for connecting to SendCloud with your API key, API secret and Sendcloud Partner id (optional)

```C#

var client = new SendCloudApi.Net.SendCloudApi("apikey", "apisecret", "partnerid")

```

## Get all parcels

Returns an array of Parcel objects

```C#

var parcels = await client.Parcels.Get();

```

## Get a single parcel

Returns a Parcel object

```C#

var parcel = await client.Parcels.Get(2342);

```

## Create a new parcel

```C#

var parcel = new CreateParcel

{

	Name = "John Smith",

	CompanyName = "ACME",

	Address = "Wellingtonstreet 25",

	City = "Wellington",

	PostalCode = "3423 DD",

	Country = "NL",

	RequestLabel = true,

	ShippingMethod = 1, // Shipping method, get possibilities from client.ShippingMethods.Get()

	OrderNumber = "ORDER2014-52321",

};

var response = await client.Parcels.Create(parcel);

```

## Retrieve a PDF label

```C#

var url = "https://panel.sendcloud.sc/api/v2/labels/normal_printer/{id}";

var label = await client.Label.Download(url);

File.WriteAllBytes("{path}", label);

```

## Exceptions

Actions to the API may cause an Exception to be thrown in case something went wrong

```C#

try

{

	var response = await client.Parcels.Create(parcel);

}

catch (SendCloudException e)

{

	throw new Exception(e.Message);

}

```