GuiStracini.Mandae 8.0.492

There is a newer version of this package available.
See the version list below for details.
dotnet add package GuiStracini.Mandae --version 8.0.492                
NuGet\Install-Package GuiStracini.Mandae -Version 8.0.492                
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.492" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add GuiStracini.Mandae --version 8.0.492                
#r "nuget: GuiStracini.Mandae, 8.0.492"                
#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.492

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

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.549 53 7/16/2024
8.0.546 54 7/16/2024
8.0.541 54 7/16/2024
8.0.532 56 7/16/2024
8.0.529 55 7/16/2024
8.0.501 97 6/19/2024
8.0.500 94 6/18/2024
8.0.498 93 6/18/2024
8.0.492 79 6/3/2024
8.0.489 74 6/3/2024
8.0.484 68 5/28/2024
8.0.481 77 5/28/2024
8.0.476 88 5/28/2024
8.0.469 76 5/28/2024
8.0.460 59 5/20/2024
8.0.457 57 5/15/2024
8.0.442 80 4/29/2024
8.0.439 74 4/29/2024
8.0.434 70 4/29/2024
8.0.427 71 4/29/2024
8.0.418 85 4/22/2024
8.0.415 62 4/22/2024
8.0.410 81 4/22/2024
8.0.403 107 4/15/2024
8.0.400 100 4/15/2024
8.0.395 102 4/15/2024
8.0.388 91 4/15/2024
8.0.379 119 4/8/2024
8.0.376 102 4/8/2024
8.0.371 112 4/8/2024
8.0.364 124 4/1/2024
8.0.361 149 3/25/2024
8.0.358 136 3/25/2024
8.0.353 162 3/18/2024
8.0.350 161 3/18/2024
8.0.345 198 3/11/2024
8.0.342 253 2/26/2024
8.0.339 243 2/26/2024
8.0.334 240 2/26/2024
8.0.327 242 2/26/2024
8.0.318 269 2/19/2024
8.0.310 261 2/19/2024
8.0.303 268 2/19/2024
8.0.294 274 2/14/2024
8.0.288 288 2/12/2024
8.0.285 316 2/5/2024
8.0.282 304 2/5/2024
8.0.277 322 1/30/2024
8.0.272 328 1/29/2024
8.0.269 318 1/29/2024
8.0.264 318 1/29/2024
8.0.254 346 1/22/2024
8.0.251 330 1/22/2024
8.0.246 330 1/22/2024
8.0.239 338 1/22/2024
8.0.230 368 1/16/2024
8.0.227 361 1/16/2024
8.0.222 363 1/15/2024
8.0.215 391 1/8/2024
8.0.212 384 1/8/2024
8.0.207 437 12/25/2023
8.0.204 419 12/25/2023
8.0.199 419 12/25/2023
8.0.192 422 12/25/2023
8.0.183 436 12/18/2023
8.0.178 426 12/18/2023
8.0.166 426 12/14/2023
8.0.157 431 12/12/2023
8.0.154 427 12/12/2023
8.0.149 430 12/12/2023
8.0.142 427 12/11/2023
8.0.137 431 12/11/2023
8.0.134 423 12/11/2023
8.0.114 453 12/8/2023
8.0.111 439 12/8/2023
8.0.108 458 12/8/2023
8.0.105 436 12/8/2023
8.0.96 432 12/8/2023
8.0.85 464 12/8/2023
8.0.59 1,103 11/14/2023
8.0.54 470 11/14/2023
8.0.49 449 11/13/2023
8.0.44 443 11/13/2023
8.0.37 489 11/9/2023
8.0.32 486 11/7/2023
8.0.27 467 11/6/2023
8.0.24 530 10/30/2023
8.0.21 482 10/30/2023
8.0.18 479 10/30/2023
8.0.13 527 10/22/2023
7.1.346 530 10/9/2023
7.1.343 508 10/9/2023
7.1.338 531 10/9/2023
7.1.335 517 10/9/2023
7.1.330 528 10/9/2023
7.1.323 530 10/7/2023
7.1.313 548 9/25/2023
7.1.308 552 9/24/2023
7.1.305 547 9/24/2023
7.1.298 554 9/23/2023
7.1.294 580 9/13/2023
7.1.287 592 9/13/2023
7.1.284 562 9/12/2023
7.1.281 563 9/12/2023
7.1.271 732 8/28/2023
7.1.263 801 8/14/2023
7.1.260 642 8/13/2023
7.1.227 640 8/13/2023
7.1.220 854 7/29/2023
7.1.218 714 7/29/2023
7.1.204 704 7/28/2023
7.1.200 725 7/25/2023
7.1.197 723 7/25/2023
7.1.190 778 7/19/2023
7.1.182 688 7/19/2023
7.1.157 927 6/27/2023
7.1.150 729 6/26/2023
7.1.145 791 6/19/2023
7.1.138 750 6/19/2023
7.1.135 719 6/19/2023
7.1.126 714 6/18/2023
7.1.107 895 6/6/2023
7.1.104 717 6/6/2023
7.1.95 727 6/6/2023
7.1.75 783 6/5/2023
7.1.17 1,145 5/4/2023
7.1.16 715 5/2/2023
7.1.15 793 4/28/2023
7.1.10 758 4/21/2023
7.1.8 769 4/21/2023
7.1.2 931 4/10/2023
7.0.101 758 4/8/2023
7.0.97 797 4/4/2023
7.0.92 892 4/3/2023
7.0.86 816 4/3/2023
7.0.64 872 3/26/2023
7.0.59 808 3/26/2023
7.0.43 824 3/22/2023
7.0.36 919 2/4/2023
7.0.31 983 1/24/2023
7.0.28 877 1/24/2023
7.0.25 885 1/24/2023
7.0.13 875 1/23/2023
7.0.8 848 1/23/2023
6.0.46 1,151 1/16/2023
6.0.43 896 1/16/2023
6.0.31 903 1/9/2023
6.0.30 923 12/25/2022
6.0.29 846 12/25/2022
6.0.17 1,822 4/24/2020
6.0.13 1,128 4/24/2020
6.0.12 1,131 4/18/2020
6.0.11 1,127 4/18/2020
6.0.10 1,146 4/18/2020
6.0.9 1,153 4/18/2020
6.0.8 1,216 9/24/2019
6.0.5 1,226 9/24/2019
5.0.37 1,261 6/18/2019
4.0.33 1,287 2/23/2019
4.0.30 1,229 2/23/2019
4.0.28 1,263 2/23/2019
4.0.27 1,331 2/14/2019
4.0.26 1,299 2/14/2019
4.0.25 1,309 2/14/2019
4.0.24 1,300 2/12/2019
4.0.23 1,301 1/29/2019
3.1.20 1,401 12/5/2018
3.1.17 1,462 9/8/2018
3.1.16 1,520 9/8/2018
3.1.15 1,411 9/8/2018
3.1.14 1,410 9/7/2018
3.1.13 1,411 9/7/2018
3.1.12 1,448 9/7/2018
3.1.11 1,486 8/23/2018
3.1.10 1,464 8/22/2018
3.1.8 1,434 8/16/2018
3.1.6 1,526 8/1/2018
3.1.5 1,436 8/1/2018
3.1.4 1,510 7/27/2018
3.1.3 1,477 7/27/2018
3.1.2 1,487 7/27/2018
3.1.1 1,457 7/26/2018
2.0.5 1,457 7/19/2018
2.0.4 1,652 5/24/2018
2.0.3 1,580 5/24/2018
2.0.1 1,630 5/9/2018
1.4.8 1,585 4/18/2018
1.4.7 1,544 4/18/2018
1.4.5 1,709 1/9/2018
1.4.1 1,671 1/9/2018
1.3.25 1,611 1/9/2018
1.3.19 1,662 12/20/2017
1.3.18 1,526 12/18/2017
1.3.17 1,611 12/15/2017
1.3.16 1,626 12/15/2017
1.3.14 1,634 12/15/2017
1.3.9 1,667 12/15/2017
1.3.8 1,643 12/15/2017
1.3.7 1,666 12/15/2017
1.3.5 1,648 12/15/2017
1.3.4 1,720 12/15/2017
1.3.3 1,676 12/15/2017
1.3.2 1,588 12/15/2017
1.3.1 1,567 11/30/2017
1.2.36 1,492 11/30/2017
1.2.34 1,551 11/29/2017
1.2.33 1,540 11/29/2017
1.2.31 1,526 11/29/2017
1.2.29 1,515 10/5/2017
1.2.28 1,524 10/4/2017
1.2.26 1,566 10/3/2017
1.2.25 1,537 10/3/2017
1.2.24 1,654 10/3/2017

Upgrade to .NET Standard 2.0 and 2.1