Endpoint GET /branches/transferDate/{date} - Pesquisa por Data alteração (data_para_transferencia)

GET /branches/transferDate/{date}

Descrição

O endpoint GET /branches/transferDate/{date} é utilizado para pesquisar filiais com base na data de alteração (data_para_transferencia). Esse serviço retorna informações detalhadas das filiais que tiveram alguma atualização na data especificada.

Parâmetros

Parâmetros na URL

  • date (obrigatório): Data de alteração (data_para_transferencia) no formato date-time.

Parâmetros na Query

  • page_size (opcional): Quantidade de registros por página.
  • current_page (opcional): Página corrente.
  • customView (opcional): Indica o objeto para query. Os valores possíveis são:
    • 0 -> Filiais
    • 1 -> W_FILIAIS_OMS_SAPI

Respostas

Sucesso (200)


Json
{
  "Pagination": {
    "TotalCount": 0,
    "PageSize": 0,
    "CurrentPage": 0
  },
  "Items": [
    {
      "id": "string",
      "name": "string",
      "type": "string",
      "address": {
        "address1": "string",
        "address2": "string",
        "city": "string",
        "country": "string",
        "firstName": "string",
        "lastName": "string",
        "neighbourhood": "string",
        "number": "string",
        "state": "string",
        "telephone": {
          "countryCode": "string",
          "number": "string"
        },
        "zip": "string"
      },
      "documents": [
        {
          "type": "string",
          "number": "string"
        }
      ],
      "zip": "string",
      "transferDate": "2024-07-22T12:20:59.370Z"
    }
  ]
}

Essa resposta indica que a pesquisa foi bem-sucedida e retorna os dados das filiais correspondentes.

Não autorizado (401)

Indica que a requisição não foi autorizada. Certifique-se de que você possui as credenciais adequadas para acessar este endpoint.

Erro Interno (500)


Json
{
  "erro": "string",
  "stackTrace": "string"
}
 

Indica que ocorreu um erro interno no servidor durante o processamento da requisição. O campo erro fornece uma descrição do erro, e stackTrace pode conter informações adicionais para diagnóstico.

Exemplo do Swagger: