Segmentação

Permite a consulta de uma Segmentação a partir do seu ID, retornando documento e nome dos produtores.

Endpoint: GET /v2/segmentation/{id}

Path parameters

id	string	OBRIGATÓRIO	ID da segmentação

Tabelas de Campos da Resposta

1. Tabela Geral - Estrutura do Retorno

Chave	Formato	Descrição
data	Array [Object]	Lista de produtores da segmentação, contendo o documento e o nome
error	Boolean	Indica se houve erro na requisição (false = sem erro).
message_id	String	Identificador da mensagem de resposta da API.
metadata	Objeto	Metadados adicionais da resposta.

2. Tabela de produtores

A chave “data” retorna os produtores da segmentação.

Chave	Formato	Descrição
document	String	Número do documento do produtor (CPF/CNPJ).
name	String	Nome do produtor.

Exemplo de retorno para a solicitação acima:

{
  "data": [
    {
      "document": "03712345678",
      "name": "GUSTAVO RODRIGO SILVA"
    },
    {
      "document": "43712345678",
      "name": "JOSE MARIO"
    },
    {
      "document": "00712345678",
      "name": "TAKASHI RIBEIRO"
    },
    {
      "document": "00641669100",
      "name": "DOUGLAS ROBERTO"
    }
  ],
  "error": false,
  "message_id": "delivery_get_segmentation_owners_success",
  "metadata": {}
}

Tabelas de Campos da Resposta#

1. Tabela Geral - Estrutura do Retorno#

2. Tabela de produtores#

Tabelas de Campos da Resposta

1. Tabela Geral - Estrutura do Retorno

2. Tabela de produtores