GuiStracini.Mandae 8.0.457

dotnet add package GuiStracini.Mandae --version 8.0.457
NuGet\Install-Package GuiStracini.Mandae -Version 8.0.457
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.457" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add GuiStracini.Mandae --version 8.0.457
#r "nuget: GuiStracini.Mandae, 8.0.457"
#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.457

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

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.457 38 5/15/2024
8.0.442 72 4/29/2024
8.0.439 65 4/29/2024
8.0.434 62 4/29/2024
8.0.427 65 4/29/2024
8.0.418 79 4/22/2024
8.0.415 57 4/22/2024
8.0.410 76 4/22/2024
8.0.403 102 4/15/2024
8.0.400 94 4/15/2024
8.0.395 94 4/15/2024
8.0.388 86 4/15/2024
8.0.379 112 4/8/2024
8.0.376 98 4/8/2024
8.0.371 106 4/8/2024
8.0.364 119 4/1/2024
8.0.361 142 3/25/2024
8.0.358 131 3/25/2024
8.0.353 155 3/18/2024
8.0.350 156 3/18/2024
8.0.345 188 3/11/2024
8.0.342 245 2/26/2024
8.0.339 236 2/26/2024
8.0.334 231 2/26/2024
8.0.327 235 2/26/2024
8.0.318 260 2/19/2024
8.0.310 252 2/19/2024
8.0.303 259 2/19/2024
8.0.294 267 2/14/2024
8.0.288 279 2/12/2024
8.0.285 308 2/5/2024
8.0.282 295 2/5/2024
8.0.277 315 1/30/2024
8.0.272 319 1/29/2024
8.0.269 312 1/29/2024
8.0.264 312 1/29/2024
8.0.254 340 1/22/2024
8.0.251 324 1/22/2024
8.0.246 324 1/22/2024
8.0.239 332 1/22/2024
8.0.230 361 1/16/2024
8.0.227 353 1/16/2024
8.0.222 357 1/15/2024
8.0.215 385 1/8/2024
8.0.212 378 1/8/2024
8.0.207 432 12/25/2023
8.0.204 415 12/25/2023
8.0.199 414 12/25/2023
8.0.192 419 12/25/2023
8.0.183 434 12/18/2023
8.0.178 424 12/18/2023
8.0.166 424 12/14/2023
8.0.157 429 12/12/2023
8.0.154 425 12/12/2023
8.0.149 428 12/12/2023
8.0.142 425 12/11/2023
8.0.137 429 12/11/2023
8.0.134 421 12/11/2023
8.0.114 451 12/8/2023
8.0.111 437 12/8/2023
8.0.108 456 12/8/2023
8.0.105 434 12/8/2023
8.0.96 430 12/8/2023
8.0.85 462 12/8/2023
8.0.59 629 11/14/2023
8.0.54 468 11/14/2023
8.0.49 447 11/13/2023
8.0.44 440 11/13/2023
8.0.37 486 11/9/2023
8.0.32 484 11/7/2023
8.0.27 465 11/6/2023
8.0.24 528 10/30/2023
8.0.21 480 10/30/2023
8.0.18 476 10/30/2023
8.0.13 525 10/22/2023
7.1.346 527 10/9/2023
7.1.343 504 10/9/2023
7.1.338 527 10/9/2023
7.1.335 514 10/9/2023
7.1.330 522 10/9/2023
7.1.323 527 10/7/2023
7.1.313 545 9/25/2023
7.1.308 549 9/24/2023
7.1.305 543 9/24/2023
7.1.298 551 9/23/2023
7.1.294 577 9/13/2023
7.1.287 587 9/13/2023
7.1.284 559 9/12/2023
7.1.281 560 9/12/2023
7.1.271 729 8/28/2023
7.1.263 798 8/14/2023
7.1.260 639 8/13/2023
7.1.227 635 8/13/2023
7.1.220 852 7/29/2023
7.1.218 710 7/29/2023
7.1.204 701 7/28/2023
7.1.200 721 7/25/2023
7.1.197 718 7/25/2023
7.1.190 775 7/19/2023
7.1.182 685 7/19/2023
7.1.157 923 6/27/2023
7.1.150 726 6/26/2023
7.1.145 788 6/19/2023
7.1.138 745 6/19/2023
7.1.135 716 6/19/2023
7.1.126 710 6/18/2023
7.1.107 891 6/6/2023
7.1.104 714 6/6/2023
7.1.95 724 6/6/2023
7.1.75 780 6/5/2023
7.1.17 1,140 5/4/2023
7.1.16 710 5/2/2023
7.1.15 789 4/28/2023
7.1.10 753 4/21/2023
7.1.8 766 4/21/2023
7.1.2 925 4/10/2023
7.0.101 753 4/8/2023
7.0.97 794 4/4/2023
7.0.92 889 4/3/2023
7.0.86 812 4/3/2023
7.0.64 869 3/26/2023
7.0.59 805 3/26/2023
7.0.43 819 3/22/2023
7.0.36 916 2/4/2023
7.0.31 980 1/24/2023
7.0.28 874 1/24/2023
7.0.25 881 1/24/2023
7.0.13 871 1/23/2023
7.0.8 844 1/23/2023
6.0.46 1,147 1/16/2023
6.0.43 892 1/16/2023
6.0.31 900 1/9/2023
6.0.30 919 12/25/2022
6.0.29 843 12/25/2022
6.0.17 1,817 4/24/2020
6.0.13 1,125 4/24/2020
6.0.12 1,128 4/18/2020
6.0.11 1,124 4/18/2020
6.0.10 1,143 4/18/2020
6.0.9 1,151 4/18/2020
6.0.8 1,213 9/24/2019
6.0.5 1,221 9/24/2019
5.0.37 1,254 6/18/2019
4.0.33 1,284 2/23/2019
4.0.30 1,225 2/23/2019
4.0.28 1,260 2/23/2019
4.0.27 1,326 2/14/2019
4.0.26 1,296 2/14/2019
4.0.25 1,306 2/14/2019
4.0.24 1,297 2/12/2019
4.0.23 1,298 1/29/2019
3.1.20 1,398 12/5/2018
3.1.17 1,459 9/8/2018
3.1.16 1,516 9/8/2018
3.1.15 1,406 9/8/2018
3.1.14 1,407 9/7/2018
3.1.13 1,404 9/7/2018
3.1.12 1,445 9/7/2018
3.1.11 1,483 8/23/2018
3.1.10 1,461 8/22/2018
3.1.8 1,430 8/16/2018
3.1.6 1,520 8/1/2018
3.1.5 1,430 8/1/2018
3.1.4 1,504 7/27/2018
3.1.3 1,473 7/27/2018
3.1.2 1,482 7/27/2018
3.1.1 1,452 7/26/2018
2.0.5 1,454 7/19/2018
2.0.4 1,647 5/24/2018
2.0.3 1,574 5/24/2018
2.0.1 1,623 5/9/2018
1.4.8 1,582 4/18/2018
1.4.7 1,540 4/18/2018
1.4.5 1,704 1/9/2018
1.4.1 1,668 1/9/2018
1.3.25 1,607 1/9/2018
1.3.19 1,659 12/20/2017
1.3.18 1,521 12/18/2017
1.3.17 1,607 12/15/2017
1.3.16 1,622 12/15/2017
1.3.14 1,631 12/15/2017
1.3.9 1,663 12/15/2017
1.3.8 1,639 12/15/2017
1.3.7 1,659 12/15/2017
1.3.5 1,644 12/15/2017
1.3.4 1,714 12/15/2017
1.3.3 1,670 12/15/2017
1.3.2 1,585 12/15/2017
1.3.1 1,561 11/30/2017
1.2.36 1,488 11/30/2017
1.2.34 1,548 11/29/2017
1.2.33 1,537 11/29/2017
1.2.31 1,521 11/29/2017
1.2.29 1,511 10/5/2017
1.2.28 1,521 10/4/2017
1.2.26 1,562 10/3/2017
1.2.25 1,532 10/3/2017
1.2.24 1,650 10/3/2017

Upgrade to .NET Standard 2.0 and 2.1