⚙️
CELETUS - API Docs
  • Introdução
  • Quick Start
  • Reference
    • API Reference
      • Sales
      • Products
Powered by GitBook
On this page
  • Listando todas as vendas
  • Listar todos
  • Buscando uma venda por código
  • Buscar venda por Id
  1. Reference
  2. API Reference

Sales

API de consulta das vendas

Listando todas as vendas

Listar todos

GET https://api.celetus.com/api/sales

Listar todas as vendas da conta

Query Parameters

Name
Type
Description

rowsPerPage*

int

Quantidade de registros por pagina

pageNumber*

int

Numero da pagina

status

string

status da venda peding | processing | canceled | failed | paid

startDate

datetime

Data inicio da busca

enddate

datetime

Data final da busa

{
  "items": [
    {
      "id": "string",
      "totalCheckout": 0,
      "status": "string",
      "totalProducts": 0,
      "totalFrete": 0,
      "discount": 0,
      "createdAt": "2023-11-10T09:41:47.559Z",
      "updatedAt": "2023-11-10T09:41:47.559Z",
      "customer": {
        "id": "string",
        "name": "string",
        "document": "string",
        "email": "string",
        "phone": "string",
        "address": "string",
        "number": "string",
        "zipCode": "string",
        "complement": "string",
        "neighborhood": "string",
        "city": "string",
        "state": "string",
        "country": "string"
      },
      "products": [
        {
          "quantity": 0,
          "unitaryValue": 0,
          "name": "string",
          "id": "string"
        }
      ]
    }
  ],
  "page": 0,
  "total": 0,
  "rowsPerPage": 0,
  "totalPages": 0,
  "info": "string",
  "hasBackPage": true,
  "hasNextPage": true,
  "isLastPage": true
}

Buscando uma venda por código

Buscar venda por Id

GET https://api.celetus.com/api/sales/{id}

Listar todas as vendas da conta

{
  "id": "string",
  "totalCheckout": 0,
  "status": "string",
  "totalProducts": 0,
  "totalFrete": 0,
  "discount": 0,
  "createdAt": "2023-11-10T09:45:43.263Z",
  "updatedAt": "2023-11-10T09:45:43.263Z",
  "customer": {
    "id": "string",
    "name": "string",
    "document": "string",
    "email": "string",
    "phone": "string",
    "address": "string",
    "number": "string",
    "zipCode": "string",
    "complement": "string",
    "neighborhood": "string",
    "city": "string",
    "state": "string",
    "country": "string"
  },
  "products": [
    {
      "quantity": 0,
      "unitaryValue": 0,
      "name": "string",
      "id": "string"
    }
  ]
}

PreviousAPI ReferenceNextProducts

Last updated 11 months ago