GuiStracini.Mandae 8.0.560

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

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

Mandaê SDK .NET

🇧🇷🚚 Mandaê API .NET client wrapper

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.629 49 9/3/2024
8.0.623 60 8/29/2024
8.0.616 60 8/29/2024
8.0.613 69 8/29/2024
8.0.606 60 8/28/2024
8.0.599 74 8/27/2024
8.0.594 77 8/26/2024
8.0.591 70 8/26/2024
8.0.586 72 8/26/2024
8.0.581 65 8/26/2024
8.0.566 76 8/19/2024
8.0.563 65 8/12/2024
8.0.560 50 7/29/2024
8.0.557 75 7/22/2024
8.0.549 72 7/16/2024
8.0.546 72 7/16/2024
8.0.541 70 7/16/2024
8.0.532 73 7/16/2024
8.0.529 71 7/16/2024
8.0.501 98 6/19/2024
8.0.500 95 6/18/2024
8.0.498 94 6/18/2024
8.0.492 80 6/3/2024
8.0.489 75 6/3/2024
8.0.484 70 5/28/2024
8.0.481 79 5/28/2024
8.0.476 90 5/28/2024
8.0.469 79 5/28/2024
8.0.460 61 5/20/2024
8.0.457 59 5/15/2024
8.0.442 81 4/29/2024
8.0.439 75 4/29/2024
8.0.434 71 4/29/2024
8.0.427 72 4/29/2024
8.0.418 87 4/22/2024
8.0.415 64 4/22/2024
8.0.410 83 4/22/2024
8.0.403 110 4/15/2024
8.0.400 102 4/15/2024
8.0.395 102 4/15/2024
8.0.388 92 4/15/2024
8.0.379 121 4/8/2024
8.0.376 104 4/8/2024
8.0.371 114 4/8/2024
8.0.364 126 4/1/2024
8.0.361 152 3/25/2024
8.0.358 138 3/25/2024
8.0.353 164 3/18/2024
8.0.350 163 3/18/2024
8.0.345 200 3/11/2024
8.0.342 254 2/26/2024
8.0.339 244 2/26/2024
8.0.334 241 2/26/2024
8.0.327 243 2/26/2024
8.0.318 270 2/19/2024
8.0.310 262 2/19/2024
8.0.303 271 2/19/2024
8.0.294 275 2/14/2024
8.0.288 289 2/12/2024
8.0.285 320 2/5/2024
8.0.282 305 2/5/2024
8.0.277 324 1/30/2024
8.0.272 329 1/29/2024
8.0.269 319 1/29/2024
8.0.264 319 1/29/2024
8.0.254 362 1/22/2024
8.0.251 331 1/22/2024
8.0.246 331 1/22/2024
8.0.239 339 1/22/2024
8.0.230 369 1/16/2024
8.0.227 362 1/16/2024
8.0.222 364 1/15/2024
8.0.215 392 1/8/2024
8.0.212 386 1/8/2024
8.0.207 439 12/25/2023
8.0.204 421 12/25/2023
8.0.199 421 12/25/2023
8.0.192 425 12/25/2023
8.0.183 440 12/18/2023
8.0.178 430 12/18/2023
8.0.166 432 12/14/2023
8.0.157 435 12/12/2023
8.0.154 431 12/12/2023
8.0.149 434 12/12/2023
8.0.142 432 12/11/2023
8.0.137 436 12/11/2023
8.0.134 427 12/11/2023
8.0.114 457 12/8/2023
8.0.111 443 12/8/2023
8.0.108 462 12/8/2023
8.0.105 440 12/8/2023
8.0.96 436 12/8/2023
8.0.85 468 12/8/2023
8.0.59 1,259 11/14/2023
8.0.54 476 11/14/2023
8.0.49 455 11/13/2023
8.0.44 449 11/13/2023
8.0.37 495 11/9/2023
8.0.32 492 11/7/2023
8.0.27 473 11/6/2023
8.0.24 536 10/30/2023
8.0.21 488 10/30/2023
8.0.18 485 10/30/2023
8.0.13 533 10/22/2023
7.1.346 536 10/9/2023
7.1.343 514 10/9/2023
7.1.338 537 10/9/2023
7.1.335 523 10/9/2023
7.1.330 534 10/9/2023
7.1.323 536 10/7/2023
7.1.313 553 9/25/2023
7.1.308 557 9/24/2023
7.1.305 552 9/24/2023
7.1.298 559 9/23/2023
7.1.294 585 9/13/2023
7.1.287 597 9/13/2023
7.1.284 567 9/12/2023
7.1.281 568 9/12/2023
7.1.271 736 8/28/2023
7.1.263 804 8/14/2023
7.1.260 645 8/13/2023
7.1.227 643 8/13/2023
7.1.220 858 7/29/2023
7.1.218 718 7/29/2023
7.1.204 708 7/28/2023
7.1.200 729 7/25/2023
7.1.197 727 7/25/2023
7.1.190 782 7/19/2023
7.1.182 692 7/19/2023
7.1.157 931 6/27/2023
7.1.150 733 6/26/2023
7.1.145 795 6/19/2023
7.1.138 754 6/19/2023
7.1.135 723 6/19/2023
7.1.126 718 6/18/2023
7.1.107 899 6/6/2023
7.1.104 721 6/6/2023
7.1.95 731 6/6/2023
7.1.75 787 6/5/2023
7.1.17 1,148 5/4/2023
7.1.16 718 5/2/2023
7.1.15 797 4/28/2023
7.1.10 763 4/21/2023
7.1.8 774 4/21/2023
7.1.2 936 4/10/2023
7.0.101 763 4/8/2023
7.0.97 802 4/4/2023
7.0.92 897 4/3/2023
7.0.86 821 4/3/2023
7.0.64 875 3/26/2023
7.0.59 811 3/26/2023
7.0.43 826 3/22/2023
7.0.36 923 2/4/2023
7.0.31 986 1/24/2023
7.0.28 880 1/24/2023
7.0.25 888 1/24/2023
7.0.13 878 1/23/2023
7.0.8 851 1/23/2023
6.0.46 1,154 1/16/2023
6.0.43 899 1/16/2023
6.0.31 907 1/9/2023
6.0.30 927 12/25/2022
6.0.29 850 12/25/2022
6.0.17 1,824 4/24/2020
6.0.13 1,130 4/24/2020
6.0.12 1,133 4/18/2020
6.0.11 1,129 4/18/2020
6.0.10 1,148 4/18/2020
6.0.9 1,155 4/18/2020
6.0.8 1,219 9/24/2019
6.0.5 1,229 9/24/2019
5.0.37 1,264 6/18/2019
4.0.33 1,290 2/23/2019
4.0.30 1,232 2/23/2019
4.0.28 1,266 2/23/2019
4.0.27 1,336 2/14/2019
4.0.26 1,303 2/14/2019
4.0.25 1,314 2/14/2019
4.0.24 1,303 2/12/2019
4.0.23 1,304 1/29/2019
3.1.20 1,406 12/5/2018
3.1.17 1,466 9/8/2018
3.1.16 1,524 9/8/2018
3.1.15 1,415 9/8/2018
3.1.14 1,415 9/7/2018
3.1.13 1,420 9/7/2018
3.1.12 1,452 9/7/2018
3.1.11 1,492 8/23/2018
3.1.10 1,484 8/22/2018
3.1.8 1,439 8/16/2018
3.1.6 1,527 8/1/2018
3.1.5 1,437 8/1/2018
3.1.4 1,511 7/27/2018
3.1.3 1,478 7/27/2018
3.1.2 1,489 7/27/2018
3.1.1 1,458 7/26/2018
2.0.5 1,458 7/19/2018
2.0.4 1,655 5/24/2018
2.0.3 1,581 5/24/2018
2.0.1 1,631 5/9/2018
1.4.8 1,586 4/18/2018
1.4.7 1,545 4/18/2018
1.4.5 1,710 1/9/2018
1.4.1 1,672 1/9/2018
1.3.25 1,612 1/9/2018
1.3.19 1,664 12/20/2017
1.3.18 1,528 12/18/2017
1.3.17 1,612 12/15/2017
1.3.16 1,627 12/15/2017
1.3.14 1,635 12/15/2017
1.3.9 1,668 12/15/2017
1.3.8 1,644 12/15/2017
1.3.7 1,667 12/15/2017
1.3.5 1,650 12/15/2017
1.3.4 1,722 12/15/2017
1.3.3 1,677 12/15/2017
1.3.2 1,589 12/15/2017
1.3.1 1,568 11/30/2017
1.2.36 1,493 11/30/2017
1.2.34 1,552 11/29/2017
1.2.33 1,541 11/29/2017
1.2.31 1,527 11/29/2017
1.2.29 1,516 10/5/2017
1.2.28 1,525 10/4/2017
1.2.26 1,567 10/3/2017
1.2.25 1,539 10/3/2017
1.2.24 1,655 10/3/2017

Upgrade to .NET Standard 2.0 and 2.1