CorreiosAPI

Default

authApiV1EncomendasPost

Cria uma nova encomenda


/auth/api/v1/encomendas

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json"\
"http://localhost:3000/auth/api/v1/encomendas"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        EncomendaInput body = ; // EncomendaInput | 
        try {
            apiInstance.authApiV1EncomendasPost(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#authApiV1EncomendasPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        EncomendaInput body = ; // EncomendaInput | 
        try {
            apiInstance.authApiV1EncomendasPost(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#authApiV1EncomendasPost");
            e.printStackTrace();
        }
    }
}
EncomendaInput *body = ; // 

DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Cria uma nova encomenda
[apiInstance authApiV1EncomendasPostWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CorreiosApi = require('correios_api');

var api = new CorreiosApi.DefaultApi()
var body = ; // {{EncomendaInput}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.authApiV1EncomendasPost(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class authApiV1EncomendasPostExample
    {
        public void main()
        {

            var apiInstance = new DefaultApi();
            var body = new EncomendaInput(); // EncomendaInput | 

            try
            {
                // Cria uma nova encomenda
                apiInstance.authApiV1EncomendasPost(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.authApiV1EncomendasPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDefaultApi();
$body = ; // EncomendaInput | 

try {
    $api_instance->authApiV1EncomendasPost($body);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->authApiV1EncomendasPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $body = WWW::SwaggerClient::Object::EncomendaInput->new(); # EncomendaInput | 

eval { 
    $api_instance->authApiV1EncomendasPost(body => $body);
};
if ($@) {
    warn "Exception when calling DefaultApi->authApiV1EncomendasPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
body =  # EncomendaInput | 

try: 
    # Cria uma nova encomenda
    api_instance.auth_api_v1_encomendas_post(body)
except ApiException as e:
    print("Exception when calling DefaultApi->authApiV1EncomendasPost: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Created


getApiV1EncomendasGet

Lista todas as encomendas


/get/api/v1/encomendas

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://localhost:3000/get/api/v1/encomendas"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        try {
            array[Encomenda] result = apiInstance.getApiV1EncomendasGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getApiV1EncomendasGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            array[Encomenda] result = apiInstance.getApiV1EncomendasGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getApiV1EncomendasGet");
            e.printStackTrace();
        }
    }
}

DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Lista todas as encomendas
[apiInstance getApiV1EncomendasGetWithCompletionHandler: 
              ^(array[Encomenda] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CorreiosApi = require('correios_api');

var api = new CorreiosApi.DefaultApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getApiV1EncomendasGet(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getApiV1EncomendasGetExample
    {
        public void main()
        {

            var apiInstance = new DefaultApi();

            try
            {
                // Lista todas as encomendas
                array[Encomenda] result = apiInstance.getApiV1EncomendasGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getApiV1EncomendasGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDefaultApi();

try {
    $result = $api_instance->getApiV1EncomendasGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getApiV1EncomendasGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

my $api_instance = WWW::SwaggerClient::DefaultApi->new();

eval { 
    my $result = $api_instance->getApiV1EncomendasGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->getApiV1EncomendasGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()

try: 
    # Lista todas as encomendas
    api_response = api_instance.get_api_v1_encomendas_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->getApiV1EncomendasGet: %s\n" % e)

Parameters

Responses

Status: 200 - OK


searchApiV1EncomendasEntreguesGet

Lista todas as encomendas entregues


/search/api/v1/encomendas/entregues

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://localhost:3000/search/api/v1/encomendas/entregues"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        try {
            array[Encomenda] result = apiInstance.searchApiV1EncomendasEntreguesGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#searchApiV1EncomendasEntreguesGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            array[Encomenda] result = apiInstance.searchApiV1EncomendasEntreguesGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#searchApiV1EncomendasEntreguesGet");
            e.printStackTrace();
        }
    }
}

DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Lista todas as encomendas entregues
[apiInstance searchApiV1EncomendasEntreguesGetWithCompletionHandler: 
              ^(array[Encomenda] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CorreiosApi = require('correios_api');

var api = new CorreiosApi.DefaultApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchApiV1EncomendasEntreguesGet(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class searchApiV1EncomendasEntreguesGetExample
    {
        public void main()
        {

            var apiInstance = new DefaultApi();

            try
            {
                // Lista todas as encomendas entregues
                array[Encomenda] result = apiInstance.searchApiV1EncomendasEntreguesGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.searchApiV1EncomendasEntreguesGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDefaultApi();

try {
    $result = $api_instance->searchApiV1EncomendasEntreguesGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->searchApiV1EncomendasEntreguesGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

my $api_instance = WWW::SwaggerClient::DefaultApi->new();

eval { 
    my $result = $api_instance->searchApiV1EncomendasEntreguesGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->searchApiV1EncomendasEntreguesGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()

try: 
    # Lista todas as encomendas entregues
    api_response = api_instance.search_api_v1_encomendas_entregues_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->searchApiV1EncomendasEntreguesGet: %s\n" % e)

Parameters

Responses

Status: 200 - OK


searchApiV1EncomendasNomeProprietarioGet

Lista todas as encomendas de um proprietário específico


/search/api/v1/encomendas/{nome_proprietario}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://localhost:3000/search/api/v1/encomendas/{nome_proprietario}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        String nomeProprietario = nomeProprietario_example; // String | 
        try {
            array[Encomenda] result = apiInstance.searchApiV1EncomendasNomeProprietarioGet(nomeProprietario);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#searchApiV1EncomendasNomeProprietarioGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String nomeProprietario = nomeProprietario_example; // String | 
        try {
            array[Encomenda] result = apiInstance.searchApiV1EncomendasNomeProprietarioGet(nomeProprietario);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#searchApiV1EncomendasNomeProprietarioGet");
            e.printStackTrace();
        }
    }
}
String *nomeProprietario = nomeProprietario_example; // 

DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Lista todas as encomendas de um proprietário específico
[apiInstance searchApiV1EncomendasNomeProprietarioGetWith:nomeProprietario
              completionHandler: ^(array[Encomenda] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CorreiosApi = require('correios_api');

var api = new CorreiosApi.DefaultApi()
var nomeProprietario = nomeProprietario_example; // {{String}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchApiV1EncomendasNomeProprietarioGet(nomeProprietario, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class searchApiV1EncomendasNomeProprietarioGetExample
    {
        public void main()
        {

            var apiInstance = new DefaultApi();
            var nomeProprietario = nomeProprietario_example;  // String | 

            try
            {
                // Lista todas as encomendas de um proprietário específico
                array[Encomenda] result = apiInstance.searchApiV1EncomendasNomeProprietarioGet(nomeProprietario);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.searchApiV1EncomendasNomeProprietarioGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDefaultApi();
$nomeProprietario = nomeProprietario_example; // String | 

try {
    $result = $api_instance->searchApiV1EncomendasNomeProprietarioGet($nomeProprietario);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->searchApiV1EncomendasNomeProprietarioGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $nomeProprietario = nomeProprietario_example; # String | 

eval { 
    my $result = $api_instance->searchApiV1EncomendasNomeProprietarioGet(nomeProprietario => $nomeProprietario);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->searchApiV1EncomendasNomeProprietarioGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
nomeProprietario = nomeProprietario_example # String | 

try: 
    # Lista todas as encomendas de um proprietário específico
    api_response = api_instance.search_api_v1_encomendas_nome_proprietario_get(nomeProprietario)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->searchApiV1EncomendasNomeProprietarioGet: %s\n" % e)

Parameters

Path parameters
Name Description
nome_proprietario*
String
Required

Responses

Status: 200 - OK


searchApiV1EncomendasVindoGet

Lista todas as encomendas a caminho


/search/api/v1/encomendas/vindo

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://localhost:3000/search/api/v1/encomendas/vindo"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        try {
            array[Encomenda] result = apiInstance.searchApiV1EncomendasVindoGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#searchApiV1EncomendasVindoGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            array[Encomenda] result = apiInstance.searchApiV1EncomendasVindoGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#searchApiV1EncomendasVindoGet");
            e.printStackTrace();
        }
    }
}

DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Lista todas as encomendas a caminho
[apiInstance searchApiV1EncomendasVindoGetWithCompletionHandler: 
              ^(array[Encomenda] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CorreiosApi = require('correios_api');

var api = new CorreiosApi.DefaultApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchApiV1EncomendasVindoGet(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class searchApiV1EncomendasVindoGetExample
    {
        public void main()
        {

            var apiInstance = new DefaultApi();

            try
            {
                // Lista todas as encomendas a caminho
                array[Encomenda] result = apiInstance.searchApiV1EncomendasVindoGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.searchApiV1EncomendasVindoGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDefaultApi();

try {
    $result = $api_instance->searchApiV1EncomendasVindoGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->searchApiV1EncomendasVindoGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

my $api_instance = WWW::SwaggerClient::DefaultApi->new();

eval { 
    my $result = $api_instance->searchApiV1EncomendasVindoGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->searchApiV1EncomendasVindoGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()

try: 
    # Lista todas as encomendas a caminho
    api_response = api_instance.search_api_v1_encomendas_vindo_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->searchApiV1EncomendasVindoGet: %s\n" % e)

Parameters

Responses

Status: 200 - OK


updateApiV1EncomendasIdPut

Atualiza o status de uma encomenda


/update/api/v1/encomendas/{id}

Usage and SDK Samples

curl -X PUT\
-H "Content-Type: application/json"\
"http://localhost:3000/update/api/v1/encomendas/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        StatusInput body = ; // StatusInput | 
        String id = id_example; // String | 
        try {
            apiInstance.updateApiV1EncomendasIdPut(body, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#updateApiV1EncomendasIdPut");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        StatusInput body = ; // StatusInput | 
        String id = id_example; // String | 
        try {
            apiInstance.updateApiV1EncomendasIdPut(body, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#updateApiV1EncomendasIdPut");
            e.printStackTrace();
        }
    }
}
StatusInput *body = ; // 
String *id = id_example; // 

DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Atualiza o status de uma encomenda
[apiInstance updateApiV1EncomendasIdPutWith:body
    id:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CorreiosApi = require('correios_api');

var api = new CorreiosApi.DefaultApi()
var body = ; // {{StatusInput}} 
var id = id_example; // {{String}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateApiV1EncomendasIdPut(bodyid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateApiV1EncomendasIdPutExample
    {
        public void main()
        {

            var apiInstance = new DefaultApi();
            var body = new StatusInput(); // StatusInput | 
            var id = id_example;  // String | 

            try
            {
                // Atualiza o status de uma encomenda
                apiInstance.updateApiV1EncomendasIdPut(body, id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.updateApiV1EncomendasIdPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDefaultApi();
$body = ; // StatusInput | 
$id = id_example; // String | 

try {
    $api_instance->updateApiV1EncomendasIdPut($body, $id);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->updateApiV1EncomendasIdPut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $body = WWW::SwaggerClient::Object::StatusInput->new(); # StatusInput | 
my $id = id_example; # String | 

eval { 
    $api_instance->updateApiV1EncomendasIdPut(body => $body, id => $id);
};
if ($@) {
    warn "Exception when calling DefaultApi->updateApiV1EncomendasIdPut: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
body =  # StatusInput | 
id = id_example # String | 

try: 
    # Atualiza o status de uma encomenda
    api_instance.update_api_v1_encomendas_id_put(body, id)
except ApiException as e:
    print("Exception when calling DefaultApi->updateApiV1EncomendasIdPut: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK