GuiStracini.Mandae 8.0.460

There is a newer version of this package available.
See the version list below for details.
dotnet add package GuiStracini.Mandae --version 8.0.460
NuGet\Install-Package GuiStracini.Mandae -Version 8.0.460
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="GuiStracini.Mandae" Version="8.0.460" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add GuiStracini.Mandae --version 8.0.460
#r "nuget: GuiStracini.Mandae, 8.0.460"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install GuiStracini.Mandae as a Cake Addin
#addin nuget:?package=GuiStracini.Mandae&version=8.0.460

// Install GuiStracini.Mandae as a Cake Tool
#tool nuget:?package=GuiStracini.Mandae&version=8.0.460

Mandaê SDK .NET

The (unofficial) Mandaê API client for .NET Framework projects.

Para a versão em português, por favor siga me.

GitHub license Time tracker GitHub issues by-label

Mandae logo

This is an unofficial client for the Mandaê API V2


CI/CD

Build status Last commit Tests Coverage Code Smells LoC
Build status GitHub last commit AppVeyor tests (branch) Coverage Code Smells Lines of Code

Code Quality (main branch)

Codacy Badge Codacy Badge

codecov CodeFactor

Maintainability Test Coverage

Quality Gate Status Maintainability Rating

Technical Debt Duplicated Lines (%)

Reliability Rating Security Rating

Bugs Vulnerabilities

DeepSource


Installation

Github Releases

GitHub last release Github All Releases

Download the latest zip file from the Release page.

Nuget package manager

Package Version Downloads
GuiStracini.Mandae GuiStracini.Mandae NuGet Version GuiStracini.Mandae NuGet Downloads

Features

This client supports the following operations/features of the API:

  1. Get rates for a delivery (postal code and package dimensions)
  2. Schedule a collect (register a collect in the customer distribution centre with one or more packages. Each package can have one or more items/SKU)
  3. Get tracking data of a shipment (Get all tracking data available from one package - tracking code is set by the customer or provided by webhook)
  4. WebHooks schema ready (The webhooks models, ready for implementation)
  5. Experimental Querying orders (API V1 - non-public API)
  6. Experimental Querying occurrences (API V1 - non-public API). Issue #1 GitHub labels
  7. Experimental Querying reverses (API V1 - non-public API). Issue #2 GitHub labels
  8. Experimental Request reverse (API V1 - non-public API). Issue #3 GitHub labels

Usage

Setup the MandaeClient

Initializes a new instance of MandaeClient class.

Example:

//Request your API token to ti@mandae.com.br 
//Each environment has its own API token!
var apiToken = "my API token";

//Call the constructor with the API token and the API environment (SANDBOX | PRODUCTION).
//var client = new MandaeClient(apiToken); //<= Environment.SANDBOX is the default environment.
var client = new MandaeClient(apiToken, Environment.PRODUCTION);

Get rates for a package/delivery

Get the rates (Rápido & Econômico) values and delivery time for a specified postal code and package dimensions.

Example:

//The MandaeClient
var client = new MandaeClient("my API token");

//The RatesModel
var delivery = new RatesModel {
    PostalCode = "22041080",
    ...
}
var rates = client.GetRates(delivery);
var fast = rates.ShippingServices.Single(s => s.Name == "Rápido");
var economic = rates.ShippingServices.Single(s => s.Name == "Econômico");
var option = ShippingService.ECONOMICO;
if(fast.Price < economic.Price)
    option = ShippingService.RAPIDO;

//The OrderModel (order collect request model)
var order = new OrderModel { ... };
order.Items = new [] {
    new NewItem 
    {
        ....
        ShippingService = option
    }
};
var order = client.RegisterOrderCollectRequest(order);

Schedule a collect request

Schedule a collect request (pickup in a distribution center/origin location).

Inform which type of Vehicle, when, which rate (Rapido | Economico) and the order items (a.k.a packages or clients orders).

Each package means an order/volume, that can have one or more items (SKUs).

Example:

//The MandaeClient
var client = new MandaeClient("my API token");

//The OrderModel (order collect request model)
var order = new OrderModel { ... };
order.Items = new [] {
    new NewItem 
    {
        ....
        ShippingService = option
    }
};

//Makes the request
var order = client.RegisterOrderCollectRequest(order);
**
//order.Id is the id for further use (maybe cancel the request ?)

Get tracking of a package

Example:

//The MandaeClient
var client = new MandaeClient("my API token");

//The tracking identifier (Generated by the Mandae or sent by the order collection request
var trackingId = "MyCompany-00001";
var tracking = client.GetTracking(tracking);
//tracking.CarrierName;
//tracking.CarrierCode;
//tracking.Events;

Querying orders (API V1 - Search) EXPERIMENTAL/NON-PUBLIC API

For the V1 you'll need to use the e-mail/password combination of the Mandaê panel to log in V1 API.

Example:

//The MandaeClient
var client = new MandaeClient("V2 API token");
client.ConfigureV1Authentication("myEmail@example.com", "password");
var trackingCode = "XYZ000001";//The tracking code of some order
var result = client.Search(SearchMethod.TRACKING_CODE, trackingCode);
if(result.Total == 1)
    Console.WriteLine(result.Orders.Single().SituationDescription);    

Release notes

  • Release v6.0.0 and higher DEPRECATED methods: Get Latest Order
  • Release v5.0.0 and higher DEPRECATED methods: Large Request, Cancel Request, Cancel Item Request
  • Release v3.0.0 and higher changes the V1 authentication method. Now use your e-mail/password of the Mandaê panel to log in to the V1 API.
  • Release v1.4.1 and higher also includes an experimental (non-public) V1 endpoint for search/querying orders (the same interface as available through the Mandaê administration panel).

Warning

The API V1 is not officially public, so there is no warranty that it will still be working


Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
8.0.501 59 6/19/2024
8.0.500 66 6/18/2024
8.0.498 65 6/18/2024
8.0.492 70 6/3/2024
8.0.489 66 6/3/2024
8.0.484 62 5/28/2024
8.0.481 71 5/28/2024
8.0.476 81 5/28/2024
8.0.469 70 5/28/2024
8.0.460 53 5/20/2024
8.0.457 52 5/15/2024
8.0.442 75 4/29/2024
8.0.439 68 4/29/2024
8.0.434 65 4/29/2024
8.0.427 68 4/29/2024
8.0.418 80 4/22/2024
8.0.415 58 4/22/2024
8.0.410 77 4/22/2024
8.0.403 103 4/15/2024
8.0.400 95 4/15/2024
8.0.395 95 4/15/2024
8.0.388 87 4/15/2024
8.0.379 113 4/8/2024
8.0.376 100 4/8/2024
8.0.371 107 4/8/2024
8.0.364 120 4/1/2024
8.0.361 145 3/25/2024
8.0.358 132 3/25/2024
8.0.353 158 3/18/2024
8.0.350 157 3/18/2024
8.0.345 189 3/11/2024
8.0.342 246 2/26/2024
8.0.339 237 2/26/2024
8.0.334 232 2/26/2024
8.0.327 236 2/26/2024
8.0.318 261 2/19/2024
8.0.310 253 2/19/2024
8.0.303 260 2/19/2024
8.0.294 269 2/14/2024
8.0.288 280 2/12/2024
8.0.285 309 2/5/2024
8.0.282 296 2/5/2024
8.0.277 316 1/30/2024
8.0.272 322 1/29/2024
8.0.269 313 1/29/2024
8.0.264 313 1/29/2024
8.0.254 341 1/22/2024
8.0.251 325 1/22/2024
8.0.246 325 1/22/2024
8.0.239 333 1/22/2024
8.0.230 362 1/16/2024
8.0.227 354 1/16/2024
8.0.222 358 1/15/2024
8.0.215 386 1/8/2024
8.0.212 379 1/8/2024
8.0.207 434 12/25/2023
8.0.204 416 12/25/2023
8.0.199 415 12/25/2023
8.0.192 420 12/25/2023
8.0.183 435 12/18/2023
8.0.178 425 12/18/2023
8.0.166 425 12/14/2023
8.0.157 430 12/12/2023
8.0.154 426 12/12/2023
8.0.149 429 12/12/2023
8.0.142 426 12/11/2023
8.0.137 430 12/11/2023
8.0.134 422 12/11/2023
8.0.114 452 12/8/2023
8.0.111 438 12/8/2023
8.0.108 457 12/8/2023
8.0.105 435 12/8/2023
8.0.96 431 12/8/2023
8.0.85 463 12/8/2023
8.0.59 655 11/14/2023
8.0.54 469 11/14/2023
8.0.49 448 11/13/2023
8.0.44 441 11/13/2023
8.0.37 487 11/9/2023
8.0.32 485 11/7/2023
8.0.27 466 11/6/2023
8.0.24 529 10/30/2023
8.0.21 481 10/30/2023
8.0.18 477 10/30/2023
8.0.13 526 10/22/2023
7.1.346 528 10/9/2023
7.1.343 505 10/9/2023
7.1.338 528 10/9/2023
7.1.335 515 10/9/2023
7.1.330 523 10/9/2023
7.1.323 528 10/7/2023
7.1.313 546 9/25/2023
7.1.308 550 9/24/2023
7.1.305 544 9/24/2023
7.1.298 552 9/23/2023
7.1.294 578 9/13/2023
7.1.287 590 9/13/2023
7.1.284 560 9/12/2023
7.1.281 561 9/12/2023
7.1.271 730 8/28/2023
7.1.263 799 8/14/2023
7.1.260 640 8/13/2023
7.1.227 636 8/13/2023
7.1.220 853 7/29/2023
7.1.218 711 7/29/2023
7.1.204 702 7/28/2023
7.1.200 722 7/25/2023
7.1.197 719 7/25/2023
7.1.190 776 7/19/2023
7.1.182 686 7/19/2023
7.1.157 924 6/27/2023
7.1.150 727 6/26/2023
7.1.145 789 6/19/2023
7.1.138 746 6/19/2023
7.1.135 717 6/19/2023
7.1.126 711 6/18/2023
7.1.107 892 6/6/2023
7.1.104 715 6/6/2023
7.1.95 725 6/6/2023
7.1.75 781 6/5/2023
7.1.17 1,143 5/4/2023
7.1.16 711 5/2/2023
7.1.15 790 4/28/2023
7.1.10 754 4/21/2023
7.1.8 767 4/21/2023
7.1.2 926 4/10/2023
7.0.101 754 4/8/2023
7.0.97 795 4/4/2023
7.0.92 890 4/3/2023
7.0.86 813 4/3/2023
7.0.64 870 3/26/2023
7.0.59 806 3/26/2023
7.0.43 820 3/22/2023
7.0.36 917 2/4/2023
7.0.31 981 1/24/2023
7.0.28 875 1/24/2023
7.0.25 882 1/24/2023
7.0.13 872 1/23/2023
7.0.8 845 1/23/2023
6.0.46 1,148 1/16/2023
6.0.43 893 1/16/2023
6.0.31 901 1/9/2023
6.0.30 920 12/25/2022
6.0.29 844 12/25/2022
6.0.17 1,820 4/24/2020
6.0.13 1,126 4/24/2020
6.0.12 1,129 4/18/2020
6.0.11 1,125 4/18/2020
6.0.10 1,144 4/18/2020
6.0.9 1,152 4/18/2020
6.0.8 1,214 9/24/2019
6.0.5 1,222 9/24/2019
5.0.37 1,258 6/18/2019
4.0.33 1,285 2/23/2019
4.0.30 1,226 2/23/2019
4.0.28 1,261 2/23/2019
4.0.27 1,329 2/14/2019
4.0.26 1,297 2/14/2019
4.0.25 1,307 2/14/2019
4.0.24 1,298 2/12/2019
4.0.23 1,299 1/29/2019
3.1.20 1,399 12/5/2018
3.1.17 1,460 9/8/2018
3.1.16 1,517 9/8/2018
3.1.15 1,407 9/8/2018
3.1.14 1,408 9/7/2018
3.1.13 1,405 9/7/2018
3.1.12 1,446 9/7/2018
3.1.11 1,484 8/23/2018
3.1.10 1,462 8/22/2018
3.1.8 1,431 8/16/2018
3.1.6 1,523 8/1/2018
3.1.5 1,431 8/1/2018
3.1.4 1,505 7/27/2018
3.1.3 1,474 7/27/2018
3.1.2 1,483 7/27/2018
3.1.1 1,453 7/26/2018
2.0.5 1,455 7/19/2018
2.0.4 1,650 5/24/2018
2.0.3 1,575 5/24/2018
2.0.1 1,625 5/9/2018
1.4.8 1,583 4/18/2018
1.4.7 1,541 4/18/2018
1.4.5 1,705 1/9/2018
1.4.1 1,669 1/9/2018
1.3.25 1,608 1/9/2018
1.3.19 1,660 12/20/2017
1.3.18 1,522 12/18/2017
1.3.17 1,609 12/15/2017
1.3.16 1,623 12/15/2017
1.3.14 1,632 12/15/2017
1.3.9 1,664 12/15/2017
1.3.8 1,640 12/15/2017
1.3.7 1,660 12/15/2017
1.3.5 1,645 12/15/2017
1.3.4 1,717 12/15/2017
1.3.3 1,671 12/15/2017
1.3.2 1,586 12/15/2017
1.3.1 1,562 11/30/2017
1.2.36 1,489 11/30/2017
1.2.34 1,549 11/29/2017
1.2.33 1,538 11/29/2017
1.2.31 1,522 11/29/2017
1.2.29 1,513 10/5/2017
1.2.28 1,522 10/4/2017
1.2.26 1,563 10/3/2017
1.2.25 1,533 10/3/2017
1.2.24 1,651 10/3/2017

Upgrade to .NET Standard 2.0 and 2.1