Skip to content

Instantly share code, notes, and snippets.

@alexaugustobr

alexaugustobr/open-api.yml

Last active July 16, 2025 16:44
Show Gist options
  • Save alexaugustobr/d0ca20e3a8642abc227f41bbf19e6658 to your computer and use it in GitHub Desktop.
Save alexaugustobr/d0ca20e3a8642abc227f41bbf19e6658 to your computer and use it in GitHub Desktop.
Download ZIP
AlgaDelivery Open API
Raw
open-api.yml
openapi: 3.0.4
info:
title: Algadelivery Delivery Tracking and Courier Management API
description: API para rastreamento e gerenciamento de entregas e gestão de entregadores do sistema Algadelivery.
version: 1.0.0
servers:
- url: http://localhost:8080
- url: http://localhost:8081
tags:
- name: Couriers
- name: Deliveries
paths:
/api/v1/deliveries:
post:
tags:
- Deliveries
summary: Cria um rascunho de uma nova encomenda.
operationId: draftDelivery
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeliveryInput'
responses:
'200':
description: Rascunho da encomenda criado com sucesso.
content:
application/json:
schema:
$ref: '#/components/schemas/Delivery'
'400':
description: Requisição inválida (erros de validação).
get:
tags:
- Deliveries
summary: Lista todas as entregas com paginação.
operationId: findAllDeliveries
parameters:
- in: query
name: page
schema:
type: integer
format: int32
default: 0
description: Número da página (baseado em zero).
- in: query
name: size
schema:
type: integer
format: int32
default: 20
description: Número de elementos por página.
responses:
'200':
description: Lista de entregas paginada.
content:
application/json:
schema:
$ref: '#/components/schemas/PagedModelDelivery'
/api/v1/deliveries/{deliveryId}:
put:
tags:
- Deliveries
summary: Edita os detalhes de uma encomenda existente.
operationId: editDelivery
parameters:
- in: path
name: deliveryId
required: true
schema:
type: string
format: uuid
description: ID da encomenda a ser editada.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeliveryInput'
responses:
'200':
description: encomenda editada com sucesso.
content:
application/json:
schema:
$ref: '#/components/schemas/Delivery'
'400':
description: Requisição inválida (erros de validação ou encomenda não editável).
'404':
description: encomenda não encontrada.
get:
tags:
- Deliveries
summary: Busca uma encomenda pelo ID.
operationId: findDeliveryById
parameters:
- in: path
name: deliveryId
required: true
schema:
type: string
format: uuid
description: ID da encomenda a ser buscada.
responses:
'200':
description: encomenda encontrada.
content:
application/json:
schema:
$ref: '#/components/schemas/Delivery'
'404':
description: encomenda não encontrada.
/api/v1/deliveries/{deliveryId}/placement:
post:
tags:
- Deliveries
summary: Submete uma encomenda para processamento.
operationId: placeDelivery
parameters:
- in: path
name: deliveryId
required: true
schema:
type: string
format: uuid
description: ID da encomenda a ser submetida.
responses:
'204':
description: encomenda submetida com sucesso.
'400':
description: Requisição inválida
'404':
description: encomenda não encontrada.
/api/v1/deliveries/{deliveryId}/pickups:
post:
tags:
- Deliveries
summary: Registra a retirada de uma encomenda pelo entregador.
operationId: pickupDelivery
parameters:
- in: path
name: deliveryId
required: true
schema:
type: string
format: uuid
description: ID da encomenda a ser marcada como retirada.
responses:
'204':
description: encomenda marcada como retirada com sucesso.
'400':
description: Requisição inválida
'404':
description: encomenda não encontrada.
/api/v1/deliveries/{deliveryId}/completion:
post:
tags:
- Deliveries
summary: Registra a conclusão (entrega) de uma encomenda.
operationId: completeDelivery
parameters:
- in: path
name: deliveryId
required: true
schema:
type: string
format: uuid
description: ID da encomenda a ser marcada como concluída.
responses:
'204':
description: encomenda marcada como concluída com sucesso.
'400':
description: Requisição inválida
'404':
description: encomenda não encontrada.
/api/v1/couriers:
post:
tags:
- Couriers
summary: Cria um novo entregador.
operationId: createCourier
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CourierInput'
responses:
'201':
description: Entregador criado com sucesso.
content:
application/json:
schema:
$ref: '#/components/schemas/Courier'
'400':
description: Requisição inválida (erros de validação).
get:
tags:
- Couriers
summary: Lista todos os entregadores com paginação.
operationId: findAllCouriers
parameters:
- in: query
name: page
schema:
type: integer
format: int32
default: 0
description: Número da página (baseado em zero).
- in: query
name: size
schema:
type: integer
format: int32
default: 20
description: Número de elementos por página.
responses:
'200':
description: Lista de entregadores paginada.
content:
application/json:
schema:
$ref: '#/components/schemas/PagedModelCourier'
/api/v1/couriers/{courierId}:
get:
tags:
- Couriers
summary: Busca um entregador pelo ID.
operationId: findCourierById
parameters:
- in: path
name: courierId
required: true
schema:
type: string
format: uuid
description: ID do entregador a ser buscado.
responses:
'200':
description: Entregador encontrado.
content:
application/json:
schema:
$ref: '#/components/schemas/Courier'
'404':
description: Entregador não encontrado.
put:
tags:
- Couriers
summary: Atualiza os dados de um entregador existente.
operationId: updateCourier
parameters:
- in: path
name: courierId
required: true
schema:
type: string
format: uuid
description: ID do entregador a ser atualizado.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CourierInput'
responses:
'204':
description: Entregador atualizado com sucesso (No Content).
'400':
description: Requisição inválida (erros de validação).
'404':
description: Entregador não encontrado.
/api/v1/couriers/payout-calculation:
post:
tags:
- Couriers
summary: Calcula o valor de pagamento para um entregador com base na distância.
operationId: calculateCourierPayout
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CourierPayoutCalculateRequest'
responses:
'200':
description: Cálculo de pagamento realizado com sucesso.
content:
application/json:
schema:
$ref: '#/components/schemas/CourierPayoutModel'
'400':
description: Requisição inválida
components:
schemas:
DeliveryInput:
type: object
required:
- sender
- recipient
- items
properties:
sender:
$ref: '#/components/schemas/ContactPointInput'
recipient:
$ref: '#/components/schemas/ContactPointInput'
items:
type: array
minItems: 1
items:
$ref: '#/components/schemas/ItemInput'
ContactPointInput:
type: object
required:
- zipCode
- street
- number
- name
- phone
properties:
zipCode:
type: string
description: Código postal do ponto de contato.
example: "01001-000"
street:
type: string
description: Nome da rua.
example: "Rua da Consolação"
number:
type: string
description: Número do endereço.
example: "123"
complement:
type: string
nullable: true
description: Complemento do endereço.
example: "Apto 10"
name:
type: string
description: Nome do contato.
example: "João Silva"
phone:
type: string
description: Telefone do contato.
example: "11999998888"
ItemInput:
type: object
required:
- name
- quantity
properties:
name:
type: string
description: Nome do item.
example: "Livro de Java"
quantity:
type: integer
format: int32
minimum: 1
description: Quantidade do item.
example: 2
CourierIdInput:
type: object
required:
- courierId
properties:
courierId:
type: string
format: uuid
description: ID do entregador.
example: "a1b2c3d4-e5f6-7890-1234-567890abcdef"
Delivery:
type: object
properties:
id:
type: string
format: uuid
description: ID único da encomenda.
readOnly: true
example: "f0e1d2c3-b4a5-6789-0123-456789abcdef"
status:
$ref: '#/components/schemas/DeliveryStatus'
description: Status atual da encomenda.
courierId:
type: string
format: uuid
nullable: true
description: ID do entregador atribuído à encomenda.
example: "a1b2c3d4-e5f6-7890-1234-567890abcdef"
placedAt:
type: string
format: date-time
nullable: true
description: Data e hora em que a encomenda foi iniciada.
assignedAt:
type: string
format: date-time
nullable: true
description: Data e hora em que a encomenda foi atribuída a um entregador.
expectedDeliveryAt:
type: string
format: date-time
nullable: true
description: Data e hora estimada para a encomenda.
fulfilledAt:
type: string
format: date-time
nullable: true
description: Data e hora em que a encomenda foi concluída.
distanceFee:
type: number
format: float
description: Taxa de distância da encomenda.
example: 15.50
courierPayout:
type: number
format: float
description: Pagamento ao entregador.
example: 10.00
totalCost:
type: number
format: float
description: Custo total da encomenda.
example: 25.50
totalItems:
type: integer
format: int32
description: Número total de itens na encomenda.
example: 3
sender:
$ref: '#/components/schemas/ContactPoint'
recipient:
$ref: '#/components/schemas/ContactPoint'
items:
type: array
items:
$ref: '#/components/schemas/Item'
ContactPoint:
type: object
properties:
zipCode:
type: string
description: Código postal do ponto de contato.
example: "01001-000"
street:
type: string
description: Nome da rua.
example: "Rua da Consolação"
number:
type: string
description: Número do endereço.
example: "123"
complement:
type: string
nullable: true
description: Complemento do endereço.
example: "Apto 10"
name:
type: string
description: Nome do contato.
example: "João Silva"
phone:
type: string
description: Telefone do contato.
example: "11999998888"
Item:
type: object
properties:
id:
type: string
format: uuid
description: ID único do item.
readOnly: true
example: "c1d2e3f4-a5b6-7890-1234-567890abcdef"
name:
type: string
description: Nome do item.
example: "Teclado Mecânico"
quantity:
type: integer
format: int32
description: Quantidade do item.
example: 1
DeliveryStatus:
type: string
enum:
- DRAFT
- WAITING_FOR_ASSIGNMENT
- WAITING_FOR_COURIER
- IN_TRANSIT_TO_RECIPIENT
- DELIVERED
description: Status possíveis de uma encomenda.
PagedModelDelivery:
type: object
properties:
content:
type: array
items:
$ref: '#/components/schemas/Delivery'
pageable:
type: object
properties:
pageNumber:
type: integer
pageSize:
type: integer
offset:
type: integer
paged:
type: boolean
unpaged:
type: boolean
sort:
type: object
properties:
empty:
type: boolean
sorted:
type: boolean
unsorted:
type: boolean
last:
type: boolean
totalPages:
type: integer
totalElements:
type: integer
size:
type: integer
number:
type: integer
sort:
type: object
properties:
empty:
type: boolean
sorted:
type: boolean
unsorted:
type: boolean
first:
type: boolean
numberOfElements:
type: integer
empty:
type: boolean
CourierInput:
type: object
required:
- name
- phone
properties:
name:
type: string
description: Nome do entregador.
example: "Maria Entregadora"
phone:
type: string
description: Telefone do entregador.
example: "11987654321"
CourierPayoutCalculateRequest:
type: object
properties:
distanceInKm:
type: number
format: double
description: Distância em quilômetros para o cálculo do pagamento.
example: 10.5
CourierPayoutModel:
type: object
properties:
payoutFee:
type: number
format: float
description: Valor do pagamento calculado.
example: 25.00
Courier:
type: object
properties:
id:
type: string
format: uuid
description: ID único do entregador.
readOnly: true
example: "1a2b3c4d-5e6f-7890-abcd-ef1234567890"
name:
type: string
description: Nome do entregador.
example: "João Entregador"
phone:
type: string
description: Telefone do entregador.
example: "11998877665"
fulfilledDeliveriesQuantity:
type: integer
format: int32
description: Quantidade de entregas concluídas pelo entregador.
example: 50
pendingDeliveriesQuantity:
type: integer
format: int32
description: Quantidade de entregas pendentes atribuídas ao entregador.
example: 3
pendingDeliveries:
type: array
items:
$ref: '#/components/schemas/AssignedDelivery'
description: Lista de entregas pendentes atribuídas ao entregador.
lastFulfilledDeliveryAt:
type: string
format: date-time
nullable: true
description: Data e hora da última encomenda concluída pelo entregador.
AssignedDelivery:
type: object
properties:
id:
type: string
format: uuid
description: ID da encomenda atribuída (que é o deliveryId).
example: "f0e1d2c3-b4a5-6789-0123-456789abcdef"
assignedAt:
type: string
format: date-time
description: Data e hora em que a encomenda foi atribuída.
amountOwned:
type: number
format: float
description: Valor a ser pago ao entregador por esta encomenda.
example: 12.50
PagedModelCourier:
type: object
properties:
content:
type: array
items:
$ref: '#/components/schemas/Courier'
pageable:
type: object
properties:
pageNumber:
type: integer
pageSize:
type: integer
offset:
type: integer
paged:
type: boolean
unpaged:
type: boolean
sort:
type: object
properties:
empty:
type: boolean
sorted:
type: boolean
unsorted:
type: boolean
last:
type: boolean
totalPages:
type: integer
totalElements:
type: integer
size:
type: integer
number:
type: integer
sort:
type: object
properties:
empty:
type: boolean
sorted:
type: boolean
unsorted:
type: boolean
first:
type: boolean
numberOfElements:
type: integer
empty:
type: boolean
Raw
postman-collection.yml
{
"info": {
"_postman_id": "98da72e4-71ac-46f1-9489-5e2d6bcbf634",
"name": "Algadelivery Delivery Tracking and Courier Management API",
"description": "API para rastreamento e gerenciamento de encomendas e gestão de entregadores do sistema Algadelivery.",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"_exporter_id": "4405010"
},
"item": [
{
"name": "api",
"item": [
{
"name": "v1",
"item": [
{
"name": "deliveries",
"item": [
{
"name": "{deliveryId}",
"item": [
{
"name": "placement",
"item": [
{
"name": "Submete uma encomenda para processamento.",
"request": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/v1/deliveries/:deliveryId/placement",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"deliveries",
":deliveryId",
"placement"
],
"variable": [
{
"key": "deliveryId",
"value": "d09567df-10a0-4032-bb44-549ee9bc53b3",
"description": "(Required) ID da encomenda a ser submetida."
}
]
}
},
"response": [
{
"name": "encomenda submetida com sucesso.",
"originalRequest": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/v1/deliveries/:deliveryId/submission",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"deliveries",
":deliveryId",
"submission"
],
"variable": [
{
"key": "deliveryId"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Requisição inválida",
"originalRequest": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/v1/deliveries/:deliveryId/submission",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"deliveries",
":deliveryId",
"submission"
],
"variable": [
{
"key": "deliveryId"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "encomenda não encontrada.",
"originalRequest": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/v1/deliveries/:deliveryId/submission",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"deliveries",
":deliveryId",
"submission"
],
"variable": [
{
"key": "deliveryId"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
}
]
}
]
},
{
"name": "pickups",
"item": [
{
"name": "Registra a retirada de uma encomenda pelo entregador.",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"courierId\": \"981d0657-deed-4ed3-8440-8a40f4b6bd34\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/deliveries/:deliveryId/pickups",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"deliveries",
":deliveryId",
"pickups"
],
"variable": [
{
"key": "deliveryId",
"value": "d09567df-10a0-4032-bb44-549ee9bc53b3",
"description": "(Required) ID da encomenda a ser marcada como retirada."
}
]
}
},
"response": [
{
"name": "encomenda marcada como retirada com sucesso.",
"originalRequest": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/v1/deliveries/:deliveryId/pickups",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"deliveries",
":deliveryId",
"pickups"
],
"variable": [
{
"key": "deliveryId"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Requisição inválida",
"originalRequest": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/v1/deliveries/:deliveryId/pickups",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"deliveries",
":deliveryId",
"pickups"
],
"variable": [
{
"key": "deliveryId"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "encomenda não encontrada.",
"originalRequest": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/v1/deliveries/:deliveryId/pickups",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"deliveries",
":deliveryId",
"pickups"
],
"variable": [
{
"key": "deliveryId"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
}
]
}
]
},
{
"name": "completion",
"item": [
{
"name": "Registra a conclusão de uma encomenda.",
"request": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/v1/deliveries/:deliveryId/completion",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"deliveries",
":deliveryId",
"completion"
],
"variable": [
{
"key": "deliveryId",
"value": "d09567df-10a0-4032-bb44-549ee9bc53b3",
"description": "(Required) ID da encomenda a ser marcada como concluída."
}
]
}
},
"response": [
{
"name": "encomenda marcada como concluída com sucesso.",
"originalRequest": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/v1/deliveries/:deliveryId/completion",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"deliveries",
":deliveryId",
"completion"
],
"variable": [
{
"key": "deliveryId"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Requisição inválida",
"originalRequest": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/v1/deliveries/:deliveryId/completion",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"deliveries",
":deliveryId",
"completion"
],
"variable": [
{
"key": "deliveryId"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "encomenda não encontrada.",
"originalRequest": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/v1/deliveries/:deliveryId/completion",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"deliveries",
":deliveryId",
"completion"
],
"variable": [
{
"key": "deliveryId"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
}
]
}
]
},
{
"name": "Edita os detalhes de uma encomenda existente.",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"sender\": {\n \"zipCode\": \"01001-000\",\n \"street\": \"Rua da Consolação\",\n \"number\": \"123\",\n \"name\": \"João Silva\",\n \"phone\": \"11999998888\",\n \"complement\": \"Apto 10\"\n },\n \"recipient\": {\n \"zipCode\": \"01001-000\",\n \"street\": \"Rua da Consolação\",\n \"number\": \"123\",\n \"name\": \"João Silva\",\n \"phone\": \"11999998888\",\n \"complement\": \"Apto 10\"\n },\n \"items\": [\n {\n \"name\": \"Livro de Spring\",\n \"quantity\": 2\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/deliveries/:deliveryId",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"deliveries",
":deliveryId"
],
"variable": [
{
"key": "deliveryId",
"value": "ec20207c-a227-481c-a97f-3b24f5199069",
"description": "(Required) ID da encomenda a ser editada."
}
]
}
},
"response": [
{
"name": "encomenda editada com sucesso.",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"sender\": {\n \"zipCode\": \"01001-000\",\n \"street\": \"Rua da Consolação\",\n \"number\": \"123\",\n \"name\": \"João Silva\",\n \"phone\": \"11999998888\",\n \"complement\": \"Apto 10\"\n },\n \"recipient\": {\n \"zipCode\": \"01001-000\",\n \"street\": \"Rua da Consolação\",\n \"number\": \"123\",\n \"name\": \"João Silva\",\n \"phone\": \"11999998888\",\n \"complement\": \"Apto 10\"\n },\n \"items\": [\n {\n \"name\": \"Livro de Java\",\n \"quantity\": 2\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/deliveries/:deliveryId",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"deliveries",
":deliveryId"
],
"variable": [
{
"key": "deliveryId"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"id\": \"f0e1d2c3-b4a5-6789-0123-456789abcdef\",\n \"status\": \"WAITING_FOR_ASSIGNMENT\",\n \"courierId\": \"a1b2c3d4-e5f6-7890-1234-567890abcdef\",\n \"placedAt\": \"1988-02-16T12:12:25.780Z\",\n \"assignedAt\": \"1989-07-02T07:32:08.059Z\",\n \"expectedDeliveryAt\": \"1959-08-16T01:07:42.137Z\",\n \"fulfilledAt\": \"1976-11-13T23:51:58.263Z\",\n \"distanceFee\": 15.5,\n \"courierPayout\": 10,\n \"totalCost\": 25.5,\n \"totalItems\": 3,\n \"sender\": {\n \"zipCode\": \"01001-000\",\n \"street\": \"Rua da Consolação\",\n \"number\": \"123\",\n \"complement\": \"Apto 10\",\n \"name\": \"João Silva\",\n \"phone\": \"11999998888\"\n },\n \"recipient\": {\n \"zipCode\": \"01001-000\",\n \"street\": \"Rua da Consolação\",\n \"number\": \"123\",\n \"complement\": \"Apto 10\",\n \"name\": \"João Silva\",\n \"phone\": \"11999998888\"\n },\n \"items\": [\n {\n \"id\": \"c1d2e3f4-a5b6-7890-1234-567890abcdef\",\n \"name\": \"Teclado Mecânico\",\n \"quantity\": 1\n },\n {\n \"id\": \"c1d2e3f4-a5b6-7890-1234-567890abcdef\",\n \"name\": \"Teclado Mecânico\",\n \"quantity\": 1\n }\n ]\n}"
},
{
"name": "Requisição inválida (erros de validação ou encomenda não editável).",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"sender\": {\n \"zipCode\": \"01001-000\",\n \"street\": \"Rua da Consolação\",\n \"number\": \"123\",\n \"name\": \"João Silva\",\n \"phone\": \"11999998888\",\n \"complement\": \"Apto 10\"\n },\n \"recipient\": {\n \"zipCode\": \"01001-000\",\n \"street\": \"Rua da Consolação\",\n \"number\": \"123\",\n \"name\": \"João Silva\",\n \"phone\": \"11999998888\",\n \"complement\": \"Apto 10\"\n },\n \"items\": [\n {\n \"name\": \"Livro de Java\",\n \"quantity\": 2\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/deliveries/:deliveryId",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"deliveries",
":deliveryId"
],
"variable": [
{
"key": "deliveryId"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "encomenda não encontrada.",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"sender\": {\n \"zipCode\": \"01001-000\",\n \"street\": \"Rua da Consolação\",\n \"number\": \"123\",\n \"name\": \"João Silva\",\n \"phone\": \"11999998888\",\n \"complement\": \"Apto 10\"\n },\n \"recipient\": {\n \"zipCode\": \"01001-000\",\n \"street\": \"Rua da Consolação\",\n \"number\": \"123\",\n \"name\": \"João Silva\",\n \"phone\": \"11999998888\",\n \"complement\": \"Apto 10\"\n },\n \"items\": [\n {\n \"name\": \"Livro de Java\",\n \"quantity\": 2\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/deliveries/:deliveryId",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"deliveries",
":deliveryId"
],
"variable": [
{
"key": "deliveryId"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
}
]
},
{
"name": "Busca uma encomenda pelo ID.",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/deliveries/:deliveryId",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"deliveries",
":deliveryId"
],
"variable": [
{
"key": "deliveryId",
"value": "ec20207c-a227-481c-a97f-3b24f5199069",
"description": "(Required) ID da encomenda a ser buscada."
}
]
}
},
"response": [
{
"name": "encomenda encontrada.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/deliveries/:deliveryId",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"deliveries",
":deliveryId"
],
"variable": [
{
"key": "deliveryId"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"id\": \"f0e1d2c3-b4a5-6789-0123-456789abcdef\",\n \"status\": \"WAITING_FOR_ASSIGNMENT\",\n \"courierId\": \"a1b2c3d4-e5f6-7890-1234-567890abcdef\",\n \"placedAt\": \"1988-02-16T12:12:25.780Z\",\n \"assignedAt\": \"1989-07-02T07:32:08.059Z\",\n \"expectedDeliveryAt\": \"1959-08-16T01:07:42.137Z\",\n \"fulfilledAt\": \"1976-11-13T23:51:58.263Z\",\n \"distanceFee\": 15.5,\n \"courierPayout\": 10,\n \"totalCost\": 25.5,\n \"totalItems\": 3,\n \"sender\": {\n \"zipCode\": \"01001-000\",\n \"street\": \"Rua da Consolação\",\n \"number\": \"123\",\n \"complement\": \"Apto 10\",\n \"name\": \"João Silva\",\n \"phone\": \"11999998888\"\n },\n \"recipient\": {\n \"zipCode\": \"01001-000\",\n \"street\": \"Rua da Consolação\",\n \"number\": \"123\",\n \"complement\": \"Apto 10\",\n \"name\": \"João Silva\",\n \"phone\": \"11999998888\"\n },\n \"items\": [\n {\n \"id\": \"c1d2e3f4-a5b6-7890-1234-567890abcdef\",\n \"name\": \"Teclado Mecânico\",\n \"quantity\": 1\n },\n {\n \"id\": \"c1d2e3f4-a5b6-7890-1234-567890abcdef\",\n \"name\": \"Teclado Mecânico\",\n \"quantity\": 1\n }\n ]\n}"
},
{
"name": "encomenda não encontrada.",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/v1/deliveries/:deliveryId",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"deliveries",
":deliveryId"
],
"variable": [
{
"key": "deliveryId"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
}
]
}
]
},
{
"name": "Cria um rascunho de uma nova encomenda.",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"sender\": {\n \"zipCode\": \"01001-000\",\n \"street\": \"Rua da Consolação\",\n \"number\": \"123\",\n \"name\": \"João Silva\",\n \"phone\": \"11999998888\",\n \"complement\": \"Apto 10\"\n },\n \"recipient\": {\n \"zipCode\": \"01001-000\",\n \"street\": \"Rua da Consolação\",\n \"number\": \"123\",\n \"name\": \"João Silva\",\n \"phone\": \"11999998888\",\n \"complement\": \"Apto 10\"\n },\n \"items\": [\n {\n \"name\": \"Livro de Java\",\n \"quantity\": 2\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/deliveries",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"deliveries"
]
}
},
"response": [
{
"name": "Rascunho da encomenda criado com sucesso.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"sender\": {\n \"zipCode\": \"01001-000\",\n \"street\": \"Rua da Consolação\",\n \"number\": \"123\",\n \"name\": \"João Silva\",\n \"phone\": \"11999998888\",\n \"complement\": \"Apto 10\"\n },\n \"recipient\": {\n \"zipCode\": \"01001-000\",\n \"street\": \"Rua da Consolação\",\n \"number\": \"123\",\n \"name\": \"João Silva\",\n \"phone\": \"11999998888\",\n \"complement\": \"Apto 10\"\n },\n \"items\": [\n {\n \"name\": \"Livro de Java\",\n \"quantity\": 2\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/deliveries",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"deliveries"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"id\": \"f0e1d2c3-b4a5-6789-0123-456789abcdef\",\n \"status\": \"WAITING_FOR_ASSIGNMENT\",\n \"courierId\": \"a1b2c3d4-e5f6-7890-1234-567890abcdef\",\n \"placedAt\": \"1988-02-16T12:12:25.780Z\",\n \"assignedAt\": \"1989-07-02T07:32:08.059Z\",\n \"expectedDeliveryAt\": \"1959-08-16T01:07:42.137Z\",\n \"fulfilledAt\": \"1976-11-13T23:51:58.263Z\",\n \"distanceFee\": 15.5,\n \"courierPayout\": 10,\n \"totalCost\": 25.5,\n \"totalItems\": 3,\n \"sender\": {\n \"zipCode\": \"01001-000\",\n \"street\": \"Rua da Consolação\",\n \"number\": \"123\",\n \"complement\": \"Apto 10\",\n \"name\": \"João Silva\",\n \"phone\": \"11999998888\"\n },\n \"recipient\": {\n \"zipCode\": \"01001-000\",\n \"street\": \"Rua da Consolação\",\n \"number\": \"123\",\n \"complement\": \"Apto 10\",\n \"name\": \"João Silva\",\n \"phone\": \"11999998888\"\n },\n \"items\": [\n {\n \"id\": \"c1d2e3f4-a5b6-7890-1234-567890abcdef\",\n \"name\": \"Teclado Mecânico\",\n \"quantity\": 1\n },\n {\n \"id\": \"c1d2e3f4-a5b6-7890-1234-567890abcdef\",\n \"name\": \"Teclado Mecânico\",\n \"quantity\": 1\n }\n ]\n}"
},
{
"name": "Requisição inválida (erros de validação).",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"sender\": {\n \"zipCode\": \"01001-000\",\n \"street\": \"Rua da Consolação\",\n \"number\": \"123\",\n \"name\": \"João Silva\",\n \"phone\": \"11999998888\",\n \"complement\": \"Apto 10\"\n },\n \"recipient\": {\n \"zipCode\": \"01001-000\",\n \"street\": \"Rua da Consolação\",\n \"number\": \"123\",\n \"name\": \"João Silva\",\n \"phone\": \"11999998888\",\n \"complement\": \"Apto 10\"\n },\n \"items\": [\n {\n \"name\": \"Livro de Java\",\n \"quantity\": 2\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/deliveries",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"deliveries"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
}
]
},
{
"name": "Lista todas as encomendas com paginação.",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/deliveries?size=1&page=0",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"deliveries"
],
"query": [
{
"key": "sort",
"value": "aute veniam quis",
"description": "Critérios de ordenação",
"disabled": true
},
{
"key": "sort",
"value": "culpa qui",
"description": "Critérios de ordenação",
"disabled": true
},
{
"key": "size",
"value": "1"
},
{
"key": "page",
"value": "0"
}
]
}
},
"response": [
{
"name": "Lista de encomendas paginada.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/deliveries?page=0&size=20&sort=culpa qui",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"deliveries"
],
"query": [
{
"key": "page",
"value": "0",
"description": "Número da página (baseado em zero)."
},
{
"key": "size",
"value": "20",
"description": "Número de elementos por página."
},
{
"key": "sort",
"value": "culpa qui",
"description": "Critérios de ordenação"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"content\": [\n {\n \"id\": \"f0e1d2c3-b4a5-6789-0123-456789abcdef\",\n \"status\": \"WAITING_FOR_ASSIGNMENT\",\n \"courierId\": \"a1b2c3d4-e5f6-7890-1234-567890abcdef\",\n \"placedAt\": \"2010-07-27T02:38:08.058Z\",\n \"assignedAt\": \"1994-01-27T02:09:19.730Z\",\n \"expectedDeliveryAt\": \"1999-10-20T18:14:37.561Z\",\n \"fulfilledAt\": \"1953-12-09T22:03:23.664Z\",\n \"distanceFee\": 15.5,\n \"courierPayout\": 10,\n \"totalCost\": 25.5,\n \"totalItems\": 3,\n \"sender\": {\n \"zipCode\": \"01001-000\",\n \"street\": \"Rua da Consolação\",\n \"number\": \"123\",\n \"complement\": \"Apto 10\",\n \"name\": \"João Silva\",\n \"phone\": \"11999998888\"\n },\n \"recipient\": {\n \"zipCode\": \"01001-000\",\n \"street\": \"Rua da Consolação\",\n \"number\": \"123\",\n \"complement\": \"Apto 10\",\n \"name\": \"João Silva\",\n \"phone\": \"11999998888\"\n },\n \"items\": [\n {\n \"id\": \"c1d2e3f4-a5b6-7890-1234-567890abcdef\",\n \"name\": \"Teclado Mecânico\",\n \"quantity\": 1\n },\n {\n \"id\": \"c1d2e3f4-a5b6-7890-1234-567890abcdef\",\n \"name\": \"Teclado Mecânico\",\n \"quantity\": 1\n }\n ]\n },\n {\n \"id\": \"f0e1d2c3-b4a5-6789-0123-456789abcdef\",\n \"status\": \"DELIVERED\",\n \"courierId\": \"a1b2c3d4-e5f6-7890-1234-567890abcdef\",\n \"placedAt\": \"1966-03-21T12:58:33.952Z\",\n \"assignedAt\": \"1961-04-11T14:16:44.932Z\",\n \"expectedDeliveryAt\": \"1974-08-06T14:48:58.961Z\",\n \"fulfilledAt\": \"1998-04-08T22:29:37.650Z\",\n \"distanceFee\": 15.5,\n \"courierPayout\": 10,\n \"totalCost\": 25.5,\n \"totalItems\": 3,\n \"sender\": {\n \"zipCode\": \"01001-000\",\n \"street\": \"Rua da Consolação\",\n \"number\": \"123\",\n \"complement\": \"Apto 10\",\n \"name\": \"João Silva\",\n \"phone\": \"11999998888\"\n },\n \"recipient\": {\n \"zipCode\": \"01001-000\",\n \"street\": \"Rua da Consolação\",\n \"number\": \"123\",\n \"complement\": \"Apto 10\",\n \"name\": \"João Silva\",\n \"phone\": \"11999998888\"\n },\n \"items\": [\n {\n \"id\": \"c1d2e3f4-a5b6-7890-1234-567890abcdef\",\n \"name\": \"Teclado Mecânico\",\n \"quantity\": 1\n },\n {\n \"id\": \"c1d2e3f4-a5b6-7890-1234-567890abcdef\",\n \"name\": \"Teclado Mecânico\",\n \"quantity\": 1\n }\n ]\n }\n ],\n \"pageable\": {\n \"pageNumber\": -86074830,\n \"pageSize\": 21387188,\n \"offset\": -23638368,\n \"paged\": true,\n \"unpaged\": true,\n \"sort\": {\n \"empty\": true,\n \"sorted\": true,\n \"unsorted\": true\n }\n },\n \"last\": true,\n \"totalPages\": -52039601,\n \"totalElements\": -69959347,\n \"size\": 12629516,\n \"number\": 54034248,\n \"sort\": {\n \"empty\": false,\n \"sorted\": false,\n \"unsorted\": true\n },\n \"first\": false,\n \"numberOfElements\": 55601584,\n \"empty\": false\n}"
}
]
}
]
},
{
"name": "couriers",
"item": [
{
"name": "{courierId}",
"item": [
{
"name": "Busca um entregador pelo ID.",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/couriers/:courierId",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"couriers",
":courierId"
],
"variable": [
{
"key": "courierId",
"value": "27dfb79f-6bba-4812-bb20-11cbfa50d40e",
"description": "(Required) ID do entregador a ser buscado."
}
]
}
},
"response": [
{
"name": "Entregador encontrado.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/couriers/:courierId",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"couriers",
":courierId"
],
"variable": [
{
"key": "courierId"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"id\": \"1a2b3c4d-5e6f-7890-abcd-ef1234567890\",\n \"name\": \"João Entregador\",\n \"phone\": \"11998877665\",\n \"fulfilledDeliveriesQuantity\": 50,\n \"pendingDeliveriesQuantity\": 3,\n \"pendingDeliveries\": [\n {\n \"id\": \"f0e1d2c3-b4a5-6789-0123-456789abcdef\",\n \"assignedAt\": \"1983-07-13T00:23:12.714Z\",\n \"amountOwned\": 12.5\n },\n {\n \"id\": \"f0e1d2c3-b4a5-6789-0123-456789abcdef\",\n \"assignedAt\": \"1952-02-11T09:27:57.294Z\",\n \"amountOwned\": 12.5\n }\n ],\n \"lastFulfilledDeliveryAt\": \"1952-08-14T23:17:51.805Z\"\n}"
},
{
"name": "Entregador não encontrado.",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/v1/couriers/:courierId",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"couriers",
":courierId"
],
"variable": [
{
"key": "courierId"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
}
]
},
{
"name": "Atualiza os dados de um entregador existente.",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Maria Silva\",\n \"phone\": \"11987654321\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/couriers/:courierId",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"couriers",
":courierId"
],
"variable": [
{
"key": "courierId",
"value": "56d70dd1-0bc5-425c-9fad-a91831188098",
"description": "(Required) ID do entregador a ser atualizado."
}
]
}
},
"response": [
{
"name": "Entregador atualizado com sucesso (No Content).",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Maria Entregadora\",\n \"phone\": \"11987654321\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/couriers/:courierId",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"couriers",
":courierId"
],
"variable": [
{
"key": "courierId"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Requisição inválida (erros de validação).",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Maria Entregadora\",\n \"phone\": \"11987654321\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/couriers/:courierId",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"couriers",
":courierId"
],
"variable": [
{
"key": "courierId"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Entregador não encontrado.",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Maria Entregadora\",\n \"phone\": \"11987654321\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/couriers/:courierId",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"couriers",
":courierId"
],
"variable": [
{
"key": "courierId"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
}
]
}
]
},
{
"name": "payout-calculation",
"item": [
{
"name": "Calcula o valor de pagamento para um entregador com base na distância.",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"distanceInKm\": 5.5\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/couriers/payout-calculation",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"couriers",
"payout-calculation"
]
}
},
"response": [
{
"name": "Cálculo de pagamento realizado com sucesso.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"distanceInKm\": 10.5\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/couriers/payout-calculation",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"couriers",
"payout-calculation"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"payoutFee\": 25\n}"
},
{
"name": "Requisição inválida",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"distanceInKm\": 10.5\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/couriers/payout-calculation",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"couriers",
"payout-calculation"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
}
]
}
]
},
{
"name": "Cria um novo entregador.",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Maria Entregadora\",\n \"phone\": \"11987654321\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/couriers",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"couriers"
]
}
},
"response": [
{
"name": "Entregador criado com sucesso.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Maria Entregadora\",\n \"phone\": \"11987654321\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/couriers",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"couriers"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"id\": \"1a2b3c4d-5e6f-7890-abcd-ef1234567890\",\n \"name\": \"João Entregador\",\n \"phone\": \"11998877665\",\n \"fulfilledDeliveriesQuantity\": 50,\n \"pendingDeliveriesQuantity\": 3,\n \"pendingDeliveries\": [\n {\n \"id\": \"f0e1d2c3-b4a5-6789-0123-456789abcdef\",\n \"assignedAt\": \"1983-07-13T00:23:12.714Z\",\n \"amountOwned\": 12.5\n },\n {\n \"id\": \"f0e1d2c3-b4a5-6789-0123-456789abcdef\",\n \"assignedAt\": \"1952-02-11T09:27:57.294Z\",\n \"amountOwned\": 12.5\n }\n ],\n \"lastFulfilledDeliveryAt\": \"1952-08-14T23:17:51.805Z\"\n}"
},
{
"name": "Requisição inválida (erros de validação).",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Maria Entregadora\",\n \"phone\": \"11987654321\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/couriers",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"couriers"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
}
]
},
{
"name": "Lista todos os entregadores com paginação.",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/couriers",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"couriers"
],
"query": [
{
"key": "page",
"value": "0",
"description": "Número da página (baseado em zero).",
"disabled": true
},
{
"key": "size",
"value": "20",
"description": "Número de elementos por página.",
"disabled": true
},
{
"key": "sort",
"value": "aute veniam quis",
"description": "Critérios de ordenação",
"disabled": true
},
{
"key": "sort",
"value": "culpa qui",
"description": "Critérios de ordenação",
"disabled": true
}
]
}
},
"response": [
{
"name": "Lista de entregadores paginada.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/couriers?page=0&size=20&sort=culpa qui",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"couriers"
],
"query": [
{
"key": "page",
"value": "0",
"description": "Número da página (baseado em zero)."
},
{
"key": "size",
"value": "20",
"description": "Número de elementos por página."
},
{
"key": "sort",
"value": "culpa qui",
"description": "Critérios de ordenação"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"content\": [\n {\n \"id\": \"1a2b3c4d-5e6f-7890-abcd-ef1234567890\",\n \"name\": \"João Entregador\",\n \"phone\": \"11998877665\",\n \"fulfilledDeliveriesQuantity\": 50,\n \"pendingDeliveriesQuantity\": 3,\n \"pendingDeliveries\": [\n {\n \"id\": \"f0e1d2c3-b4a5-6789-0123-456789abcdef\",\n \"assignedAt\": \"1996-09-29T16:44:56.225Z\",\n \"amountOwned\": 12.5\n },\n {\n \"id\": \"f0e1d2c3-b4a5-6789-0123-456789abcdef\",\n \"assignedAt\": \"1948-11-16T23:34:14.882Z\",\n \"amountOwned\": 12.5\n }\n ],\n \"lastFulfilledDeliveryAt\": \"2002-11-19T10:47:39.791Z\"\n },\n {\n \"id\": \"1a2b3c4d-5e6f-7890-abcd-ef1234567890\",\n \"name\": \"João Entregador\",\n \"phone\": \"11998877665\",\n \"fulfilledDeliveriesQuantity\": 50,\n \"pendingDeliveriesQuantity\": 3,\n \"pendingDeliveries\": [\n {\n \"id\": \"f0e1d2c3-b4a5-6789-0123-456789abcdef\",\n \"assignedAt\": \"1945-07-07T15:22:46.568Z\",\n \"amountOwned\": 12.5\n },\n {\n \"id\": \"f0e1d2c3-b4a5-6789-0123-456789abcdef\",\n \"assignedAt\": \"1960-05-04T19:55:03.800Z\",\n \"amountOwned\": 12.5\n }\n ],\n \"lastFulfilledDeliveryAt\": \"2017-06-23T15:43:00.391Z\"\n }\n ],\n \"pageable\": {\n \"pageNumber\": 73079307,\n \"pageSize\": -20710188,\n \"offset\": -82612552,\n \"paged\": true,\n \"unpaged\": true,\n \"sort\": {\n \"empty\": false,\n \"sorted\": true,\n \"unsorted\": true\n }\n },\n \"last\": false,\n \"totalPages\": -89725460,\n \"totalElements\": -69945148,\n \"size\": -57715129,\n \"number\": -42327619,\n \"sort\": {\n \"empty\": false,\n \"sorted\": true,\n \"unsorted\": false\n },\n \"first\": false,\n \"numberOfElements\": 75418831,\n \"empty\": false\n}"
}
]
}
]
}
]
}
]
}
],
"variable": [
{
"key": "baseUrl",
"value": "http://localhost:8080"
}
]
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment