https://github.com/xxgicoxx/correst
REST Web Service for track Correios objects.
https://github.com/xxgicoxx/correst
correios correst rest webservice
Last synced: 3 months ago
JSON representation
REST Web Service for track Correios objects.
- Host: GitHub
- URL: https://github.com/xxgicoxx/correst
- Owner: xxgicoxx
- License: mit
- Archived: true
- Created: 2019-12-12T03:54:27.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-05-08T19:58:32.000Z (over 2 years ago)
- Last Synced: 2025-07-14T20:42:08.918Z (3 months ago)
- Topics: correios, correst, rest, webservice
- Language: JavaScript
- Homepage:
- Size: 43.9 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Correst
REST Web Service for track Correios objects.
# Features
* Track Correios objects
# Prerequisites
* [Node.js](https://nodejs.org/en/)
# Running
### 1. Configure
````
# Web Service
Create and configure .env file like .env.example.
````
### 2. Run
````
# Install dependencies
npm install
# Start
npm start
````
# Example
````
curl --location --request GET 'http://localhost:3000/track/PX547037143BR'
````
# Response example
```json
{
"code": "QJ852965722BR",
"events": [
{
"event": "Objeto entregue ao destinatário",
"date": "10/01/2022",
"hour": "08:53",
"location": "Unidade de Distribuição - Pato Branco / PR"
},
{
"event": "Objeto em trânsito - por favor aguarde",
"date": "06/01/2022",
"hour": "09:43",
"origin": "Agência dos Correios - Sao Bernardo Do Campo / SP",
"destination": "Unidade de Tratamento - Cajamar / SP"
},
{
"event": "Objeto postado",
"date": "05/01/2022",
"hour": "15:47",
"location": "Agência dos Correios - Sao Bernardo Do Campo / SP"
}
]
}
```
# Built With
* [Node.js](https://nodejs.org/en/)
# Authors
* [xxgicoxx](https://github.com/xxgicoxx)