Páginas filhas
  • DT - Criação de endpoint para consulta de pré venda


01. SITUAÇÃO/REQUISITO

Continuando com o desenvolvimento da API Transaction, surgiu a necessidade da criação da consulta das transações de pré venda existentes no banco.

02. SOLUÇÃO

Foi criado o seguinte endpoint:

  • transaction/v2/search-pre-sale

Esse endpoint possui como entrada os seguintes valores:

  • personDocument - CPF do cliente
  • sellerId - Código do vendedor
  • orderNumber - Número da Comanda
  • checkout - Identificador único GUID
  • companyDocument, transactionNumber, transactionDate - Chave da transação(documento da empresa, número e data da transação)
    • No caso da chave da transação, não deve ser permitido filtrar apenas por documento de empresa ou data da transação

Nenhum dos filtros é obrigatório, mas não é possível fazer a requisição sem informar filtros. Além disso, como já citado nos valores de entrada, não será possível filtrar somente por data da transação ou documento da empresa, visto que a pesquisa com apenas esses um desses dois filtros retorna muita informação.

Assim como nos endpoints das outras APIs v2, é necessário o uso do token v2 para autenticação.


{
  "companyDocument": "string",
  "transactionNumber": 0,
  "transactionDate": "2020-03-20",
  "personDocument": "string",
  "sellerId": 0,
  "orderNumber": 0,
  "checkout": "string"
}
{
  "success": true,
  "data": [
    {
      "companyId": 1,
      "number": 6,
      "date": "2020-03-16T00:00:00",
      "personDocument": "11122233344",
      "operationId": 6595,
      "paymentTermsId": 1,
      "settlementCompanyId": 1,
      "companyGroupId": 1,
      "situationType": 1,
      "originType": "1",
      "addressSequential": 1,
      "sellerId": 10,
      "operationType": "S",
      "discountPercentage": null,
      "transactionValue": null,
      "discountValue": null,
      "totalValue": null,
      "additionalTransactionInfo": {
        "preSaleNumber": 57,
        "orderNumber": 2,
        "checkout": "2afcc542-93fe-4bf5-9ad8-ec5dc66b7187"
      },
      "items": [
        {
          "number": 1,
          "companyGroupId": 1,
          "productCode": "123456",
          "productId": 118252,
          "productDescription": "ITEM3 CAMISA 151611 RSA UN",
          "settlementCompanyId": 1,
          "specieId": null,
          "sellerId": 10,
          "grossTotalValue": 100,
          "discountTotalValue": 10,
          "discountItemValue": 0,
          "netTotalValue": 95,
          "requestedQuantity": 1,
          "satisfiedQuantity": 0,
          "balance": 1,
          "unitaryGrossTotalValue": 100,
          "unitaryDiscountTotalValue": 10,
          "unitaryDiscounItemValue": 0,
          "unitaryNetTotalValue": 95,
          "discountPercentage": 0.1
        }
      ]
    }
  ]
}