Representante

Consulta Representante

get

/venda/v1/representante

API para integração de representante. 1- Devido a limitação do Swagger na quantidade de caracters que podem ser retornadas, foram criados os campos abaixo para limitar a quantidade de registros quando necessário. O erro retornado quando o limite de caracteres é ultrapassado é "413 - request entity too large".

Autorizações

OAuth2clientCredentialsObrigatório

Token URL:

Parâmetros de consulta

limitinteger · int32 · mín: 1 · máx: 100Opcional

Quantidade máxima de items retornados.

Default: 20

offsetinteger · int32Opcional

Quantidade de items para ignorar antes de retornar resultado.

Default: 0

qstringOpcional

O filtro é permitido apenas pelos atributos do objeto principal.

Esta seção descreve e fornece exemplos de filtragem em consultas em tabelas e exibições habilitadas para REST.

A filtragem é o processo de limitar um recurso de coleção usando uma definição de filtro dinâmico por solicitação em vários recursos de página, em que cada página contém um subconjunto de itens encontrados na coleção completa. A filtragem permite a passagem eficiente de grandes coleções.

Para filtrar em uma consulta, inclua o parâmetro q=FilterObject, onde FilterObject é um objeto JSON que representa a seleção e classificação customizadas a serem aplicadas ao recurso. Por exemplo, suponha o seguinte recurso:

https://api.systextil.com

A consulta a seguir inclui um filtro que restringe a coluna NOME_CLIENTE a "SYSTEXTIL":

https://api.systextil.com/comercial/v1/clientes?q={"nome_cliente":"JOHN"}

Gramática FilterObject

FilterObject { orderby , asof, wmembers }

orderby
  "$orderby": {orderByMembers}
 
orderByMembers
    orderByProperty
    orderByProperty , orderByMembers
 
orderByProperty
    columnName : sortingValue
 
sortingValue
  "ASC"
  "DESC"
  "-1"
  "1"
   -1
   1
   
asof
  "$asof": date
  "$asof": "datechars"
  "$asof": scn
  "$asof": +int
 
wmembers
    wpair
    wpair , wmembers
 
wpair
    columnProperty
    complexOperatorProperty
 
columnProperty
    columnName : string
    columnName : number
    columnName : date
    columnName : simpleOperatorObject
columnName : complexOperatorObject
    columnName : [complexValues]
 
columnName
  "\p{Alpha}[[\p{Alpha}]]([[\p{Alnum}]#$_])*$"
 
complexOperatorProperty
    complexKey : [complexValues]
    complexKey : simpleOperatorObject 
 
complexKey
  "$and"
  "$or"
 
complexValues
    complexValue , complexValues
 
complexValue
    simpleOperatorObject
    complexOperatorObject
    columnObject
 
columnObject
    {columnProperty}
 
simpleOperatorObject
    {simpleOperatorProperty}
 
complexOperatorObject
    {complexOperatorProperty}
 
simpleOperatorProperty
   "$eq" : string | number | date
   "$ne" : string | number | date
   "$lt" :  number | date
   "$lte" : number | date
   "$gt" : number | date
   "$gte" : number | date
   "$instr" : string 
   "$ninstr" : string
   "$like" : string
   "$null" : null
   "$notnull" : null
   "$between" : betweenValue
 
betweenValue
    [null , betweenNotNull]
    [betweenNotNull , null]
    [betweenRegular , betweenRegular]
 
betweenNotNull
    number
    date
    
betweenRegular
    string
    number
    date

Definições de tipo de dados incluem o seguinte:

string 
       JSONString
number
       JSONNumber
date
       {"$date":"datechars"}
scn
       {"$scn": +int}

where

Datechars é um formato de data RFC3339 em UTC (Z)
        
 
JSONString
          ""
          " chars "
chars
         char
         char chars
char
         any-Unicode-character except-"-or-\-or-control-character
          \"
          \\
           \/
          \b
          \f
          \n
          \r
          \t
          \u four-hex-digits
 
 
JSONNumber
    int
    int frac
    int exp
    int frac exp
int
    digit
    digit1-9 digits 
    - digit
    - digit1-9 digits
frac
    . digits
exp
    e digits
digits
    digit
    digit digits
e
    e
    e+
    e-
    E
    E+
    E-

O FilterObject deve ser codificado de acordo com a Seção 2.1 do RFC3986

Exemplos

A seguir estão exemplos de operadores em especificações de FilterObject.

ORDER BY property ($orderby)

Order by with literals

{
"$orderby": {"SALARY":  "ASC","ENAME":"DESC"}
}

Order by with numbers

```json

{ "$orderby": {"SALARY": -1,"ENAME": 1} }

 
y ($asof)
 
### With SCN (Implicit)
```json 
{
  "$asof": 1273919
}

With SCN (Explicit)

{
  "$asof": {"$scn": "1273919"}
}

With Date (Implicit)

{
  "$asof": "2014-06-30T00:00:00Z"
}

With Date (Explicit)

{
  "$asof": {"$date": "2014-06-30T00:00:00Z"}
}

EQUALS operator ($eq)

(Implicit and explicit equality supported._

Implicit (Support String and Dates too)

{
 "SALARY": 1000
}

Explicit

{
 "SALARY": {"$eq": 1000}
}

Strings

{
 "ENAME": {"$eq":"SMITH"}
}

Dates

{
  "HIREDATE": {"$date": "1981-11-17T08:00:00Z"}
}

NOT EQUALS operator ($ne)

Number

{
 "SALARY": {"$ne": 1000}
}

String

```json

{ "ENAME": {"$ne":"SMITH"} }

 
#### Dates
  ```json
{
  "HIREDATE": {"$ne": {"$date":"1981-11-17T08:00:00Z"}}
}

LESS THAN operator ($lt)

(Supports dates and numbers only)

Numbers

```json

{ "SALARY": {"$lt": 10000} }

 
#### Dates
  ```json
{
  "SALARY": {"$lt": {"$date":"1999-12-17T08:00:00Z"}}
}

LESS THAN OR EQUALS operator ($lte)

(Supports dates and numbers only)

Numbers

```json

{ "SALARY": {"$lte": 10000} }


#### Dates
  ```json
{
  "HIREDATE": {"$lte": {"$date":"1999-12-17T08:00:00Z"}}
}

GREATER THAN operator ($gt)

(Supports dates and numbers only)

Numbers

```json

{ "SALARY": {"$gt": 10000} }

 
#### Dates
  ```json
{
  "SALARY": {"$gt": {"$date":"1999-12-17T08:00:00Z"}}
}

GREATER THAN OR EQUALS operator ($gte)

(Supports dates and numbers only)

Numbers

{
  "SALARY": {"$gte": 10000}
}

Dates

{
  "HIREDATE": {"$gte": {"$date":"1999-12-17T08:00:00Z"}}
}

In string operator ($instr)

(Supports strings only) ```json { "ENAME": {"$instr":"MC"} }

 
#### Not in string operator ($ninstr)
(Supports strings only)
  ```json
{
  "ENAME": {"$ninstr":"MC"}
}

####LIKE operator ($like) (Supports strings. Eescape character not supported to try to match expressions with _ or % characters.) ```json { "ENAME": {"$like":"AX%"} }

 
#### BETWEEN operator ($between)
(Supports string, dates, and numbers)
 
#### Numbers
```json
{
  "SALARY": {"$between": [1000,2000]}
}

Dates

```json

{ "SALARY": {"$between": [{"$date":"1989-12-17T08:00:00Z"},{"$date":"1999-12-17T08:00:00Z"}]} }

 
#### Strings
```json
{
  "ENAME": {"$between": ["A","C"]}
}

Null Ranges ($lte equivalent)

(Supported by numbers and dates only)

{
 "SALARY": {"$between": [null,2000]}
}

Null Ranges ($gte equivalent)

(Supported by numbers and dates only)

{
 "SALARY": {"$between": [1000,null]}
}

NULL operator ($null)

{
  "ENAME": {"$null": null}
}

NOT NULL operator ($notnull)

{
  "ENAME": {"$notnull": null}
}

AND operator ($and)

(Supports all operators, including $and and $or)

Column context delegation

(Operators inside $and will use the closest context defined in the JSON tree.)

{
 "SALARY": {"$and": [{"$gt": 1000},{"$lt":4000}]}
}

Column context override

(Example: salary greater than 1000 and name like S%)

{
  "SALARY": {"$and": [{"$gt": 1000},{"ENAME": {"$like":"S%"}} ] }
}

Implicit and in columns

{
  "SALARY": [{"$gt": 1000},{"$lt":4000}] 
}

High order AND

(All first columns and or high order operators -- $and and $ors -- defined at the first level of the JSON will be joined and an implicit AND) (Example: Salary greater than 1000 and name starts with S or T)

{
  "SALARY": {"$gt": 1000}, 
  "ENAME": {"$or": [{"$like":"S%"}, {"$like":"T%"}]} 
}

Invalid expression (operators $lt and $gt lack column context)

{
   "$and": [{"$lt": 5000},{"$gt": 1000}]
}

Valid alternatives for the previous invalid expression

{
   "$and": [{"SALARY": {"$lt": 5000}}, {"SALARY": {"$gt": 1000}}]
}

{
   "SALARY": [{"$lt": 5000},{"$gt": 1000}]
}
 
{
   "SALARY": {"$and": [{"$lt": 5000},{"$gt": 1000}]}
}

OR operator ($or)

(Supports all operators including $and and $or)

Column context delegation

(Operators inside $or will use the closest context defined in the JSON tree)

{
  "ENAME": {"$or": [{"$eq":"SMITH"},{"$eq":"KING"}]}
}

Column context override

(Example: name starts with S or salary greater than 1000)

{
  "SALARY": {"$or": [{"$gt": 1000},{"ENAME": {"$like":"S%"}} ] }
}

Respostas

200

Sucesso.

application/json

codigo_representantenumber · máx: 5Obrigatório

Código do representante

Example: 1212

cnpj_9_representantenumber · máx: 9Obrigatório

CNPJ 9 do representante

Example: 30701253

cnpj_4_representantenumber · máx: 4Obrigatório

CNPJ 4 do representante

Example: 1

cnpj_2_representantenumber · máx: 2Obrigatório

CNPJ 2 do representante

Example: 53

ie_representantestring · máx: 14Obrigatório

Inscrição Estadual do representante

Example: SC

nome_representantestring · máx: 40Obrigatório

Nome do representante

Example: LUANA

nome_fantasia_representantestring · máx: 40Opcional

Nome fantasia do representante

Example: LUANA

cep_representantenumber · máx: 8Obrigatório

Cep da cidade do representante

Example: 89255250

endereco_representantestring · máx: 60Obrigatório

Endereço do representante

Example: RUA CARLOS SCHULZ

bairro_representantestring · máx: 20Obrigatório

Bairro do representante

Example: CZERNIEWICZ

cidade_representante_idnumber · máx: 5Opcional

Código da Cidade do Representante

Example: 4548

cidade_representante_descricaostring · máx: 25Opcional

Nome da cidade

Example: JARAGUA DO SUL

codigo_Ibge_representantenumber · máx: 7Opcional

Código do IBGE da cidade

Example: 4208906

estado_representantestring · máx: 2Opcional

Nome do Estado

Example: SC

caixa_postal_representantestring · máx: 5Opcional

Caixa postal

ddd_telefone_representantenumber · máx: 4Opcional

DDD do telefone do representante

Example: 47

telefone_representantenumber · máx: 8Opcional

Telefone do representante

Example: 33711904

ddd_celular_representantenumber · máx: 4Opcional

DDD do celular do representante

Example: 47

celular_representantenumber · máx: 9Opcional

Celular do representante

Example: 33711904

fax_representantenumber · máx: 8Opcional

Fax do representante

Example: 0

email_representantestring · máx: 100Opcional

E-mail do representante

Example: [email protected]

codigo_empresa_representantenumber · máx: 3Opcional

Código da empresa do representante

Example: 1

tipo_representantenumber · máx: 1Opcional

'Identificação do tipo de representante: (1) - Micro (2) - Autônomo (3) - Jurídica (4) - Administrador (5) - Vendedor'

Example: 2

banco_representante_idnumber · máx: 3Opcional

Código do banco do representante

Example: 33

banco_representante_descricaostring · máx: 15Opcional

Descrição do banco do representante

Example: SANTANDER

codigo_agencia_representantestring · máx: 15Opcional

Agência que o representante possui conta

Example: 1539

conta_corrente_representantestring · máx: 15Opcional

Conta corrente do representante

Example: 1005543-4

codigo_contabil_representantenumber · máx: 6Opcional

Código contábil do representante

Example: 0

core_representantestring · máx: 7Opcional

Core do representante

Example: F

envia_mala_clientestring · máx: 5Opcional

'Envia mala direta: True ou False'

Example: true

percentual_ir_representantenumber · máx: 6Opcional

Percentual de IR federal para cálculo no pagto de comissões

Example: 0

valor_minimo_impostonumber · máx: 10Opcional

Valor mínimo de imposto de renda do representante

Example: 0

percentual_comissaonumber · máx: 5Opcional

Percentual de comissão da venda

Example: 5

percentual_comissao_faturamentonumber · máx: 7Opcional

Percentual de comissão no faturamento

Example: 0

percentual_comissao_baixanumber · máx: 7Opcional

Percentual de comissão de baixa do representante

Example: 100

percentual_indenizacao_representantenumber · máx: 5Opcional

Percentual de indenização antecipado para o representante

Example: 0

codigo_adminstrador_representantenumber · máx: 5Opcional

Quando se tratar de Representante, informe o código do respectivo administrador

Example: 200

situacao_representantenumber · máx: 1Opcional

'Situação do representante: (1) - Ativo (2) - Inativo'

Example: 1

tipo_produto_representante_idnumber · máx: 2Opcional

Tipo de produto do representante

Example: 1

tipo_produto_representante_descricaostring · máx: 25Opcional

Descrição do tipo de produto do representante

Example: VENDEDOR

envia_email_representantenumber · máx: 1Opcional

'Envia e-mail representante: (0) - Não envia nada
(1) - Envia DANFE
(2) - Envia Romaneio
(3) - Envia DANFE e Romaneio.'

Example: 0

cargo_representante_idnumber · máx: 4Opcional

Cargo do representante

Example: 0

cargo_representante_descricaostring · máx: 30Opcional

Descrição do cargo do representante

Example: Teste

loja_fvstring · máx: 5Opcional

'Informe: True - Quando o cadastro desse representante representa uma loja no força de vendas
False - Caso contrário'

Example: true

isento_analisestring · máx: 5Opcional

Representante isento de analise (0) - false ou (1) - true

Example: true

data_atualizacao_apistring · date-timeOpcional

Data de atualização da API.

Example: 2023-11-24T11:12:47ZPattern: ^\d{4}-[01]\d-[0123]\dT[012]\d:[0-5]\d:[0-5]\d(.\d+)?(Z|([-+][012]\d:[0-5]\d))$

401

Não autorizado.

application/json

500

Erro de formatação/json/erro do lado do servidor.

application/json

get

/venda/v1/representante

GET /venda/v1/representante HTTP/1.1
Host: qa-api-cliente.systextilapps.com.br/
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "codigo_representante": 1212,
  "cnpj_9_representante": 30701253,
  "cnpj_4_representante": 1,
  "cnpj_2_representante": 53,
  "ie_representante": "SC",
  "nome_representante": "LUANA",
  "nome_fantasia_representante": "LUANA",
  "cep_representante": 89255250,
  "endereco_representante": "RUA CARLOS SCHULZ",
  "bairro_representante": "CZERNIEWICZ",
  "cidade_representante_id": 4548,
  "cidade_representante_descricao": "JARAGUA DO SUL",
  "codigo_Ibge_representante": 4208906,
  "estado_representante": "SC",
  "caixa_postal_representante": null,
  "ddd_telefone_representante": 47,
  "telefone_representante": 33711904,
  "ddd_celular_representante": 47,
  "celular_representante": 33711904,
  "fax_representante": 0,
  "email_representante": "[email protected]",
  "codigo_empresa_representante": 1,
  "tipo_representante": 2,
  "banco_representante_id": 33,
  "banco_representante_descricao": "SANTANDER",
  "codigo_agencia_representante": 1539,
  "conta_corrente_representante": "1005543-4",
  "codigo_contabil_representante": 0,
  "core_representante": "F",
  "envia_mala_cliente": "true",
  "percentual_ir_representante": 0,
  "valor_minimo_imposto": 0,
  "percentual_comissao": 5,
  "percentual_comissao_faturamento": 0,
  "percentual_comissao_baixa": 100,
  "percentual_indenizacao_representante": 0,
  "codigo_adminstrador_representante": 200,
  "situacao_representante": 1,
  "tipo_produto_representante_id": 1,
  "tipo_produto_representante_descricao": "VENDEDOR",
  "envia_email_representante": 0,
  "cargo_representante_id": 0,
  "cargo_representante_descricao": "Teste",
  "loja_fv": true,
  "isento_analise": "true",
  "data_atualizacao_api": "2023-11-24T11:12:47Z",
  "outras_representacoes": [],
  "marcas": [],
  "tipo_comissao": [],
  "sub_regioes": [],
  "informacao_pessoal": {
    "cpf_9_pessoal": 538997509,
    "cpf_2_pessoal": 0,
    "identidade_pessoal": 34534534343543,
    "nome_pessoal": "CLAUDIO DA SILVA",
    "data_nascimento": "2000-11-01T00:00:00",
    "email_pessoal": "[email protected]",
    "nome_conjuge": "MARIA DO ROSARIO",
    "observacao_pessoal": "Teste",
    "cep_pessoal": 89251650,
    "endereco_pessoal": "Rua Teste",
    "numero_pessoal": 1234,
    "complemento_pessoal": "Casa",
    "bairro_pessoal": "Centro",
    "cidade_pessoal_id": 4548,
    "cidade_pessoal_descricao": "JARAGUA DO SUL",
    "codigo_Ibge_pessoal": 4208906,
    "estado_pessoal": "SC",
    "pais_pessoal": 1
  }
}

Cadastro Representante

post

/venda/v1/representante

API para integração de POST de Representante.

(*) - Campos obrigatórios/campos chave: cnpj_9_representante, cnpj_4_representante, cnpj_2_representante, ie_representante, nome_representante, cep_representante, endereco_representante, bairro_representante

Autorizações

OAuth2clientCredentialsObrigatório

Token URL:

Parâmetros de consulta

syncbooleanOpcional

Informa se a integração é assíncrona (false) ou síncrona (true).

Corpo

Respostas

201

Sucesso na inclusão.

application/json

400

Erro em validação de negócio.

application/json

401

Não autorizado.

application/json

406

Requisição não aceita, mais de um item em request.

application/json

409

Requisição não aceita, envio já cadastrado.

application/json

500

Erro de formatação/json/erro do lado do servidor.

application/json

post

/venda/v1/representante

POST /venda/v1/representante HTTP/1.1
Host: qa-api-cliente.systextilapps.com.br/
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2138

{
  "items": [
    {
      "codigo_representante": 1212,
      "cnpj_9_representante": 30701253,
      "cnpj_4_representante": 1,
      "cnpj_2_representante": 53,
      "ie_representante": "SC",
      "nome_representante": "LUANA",
      "nome_fantasia_representante": "LUANA",
      "cep_representante": 89255250,
      "endereco_representante": "RUA CARLOS SCHULZ",
      "bairro_representante": "CZERNIEWICZ",
      "cidade_representante_id": 4548,
      "cidade_representante_descricao": "JARAGUA DO SUL",
      "codigo_Ibge_representante": 4208906,
      "estado_representante": "SC",
      "caixa_postal_representante": null,
      "ddd_telefone_representante": 47,
      "telefone_representante": 33711904,
      "ddd_celular_representante": 47,
      "celular_representante": 33711904,
      "fax_representante": 0,
      "email_representante": "[email protected]",
      "codigo_empresa_representante": 1,
      "tipo_representante": 2,
      "banco_representante_id": 33,
      "banco_representante_descricao": "SANTANDER",
      "codigo_agencia_representante": 1539,
      "conta_corrente_representante": "1005543-4",
      "codigo_contabil_representante": 0,
      "core_representante": "F",
      "envia_mala_cliente": "true",
      "percentual_ir_representante": 0,
      "valor_minimo_imposto": 0,
      "percentual_comissao": 5,
      "percentual_comissao_faturamento": 0,
      "percentual_comissao_baixa": 100,
      "percentual_indenizacao_representante": 0,
      "codigo_adminstrador_representante": 200,
      "situacao_representante": 1,
      "tipo_produto_representante_id": 1,
      "tipo_produto_representante_descricao": "VENDEDOR",
      "envia_email_representante": 0,
      "cargo_representante_id": 0,
      "cargo_representante_descricao": "Teste",
      "loja_fv": true,
      "isento_analise": "true",
      "data_atualizacao_api": "2023-11-24T11:12:47Z",
      "outras_representacoes": [],
      "marcas": [],
      "tipo_comissao": [],
      "sub_regioes": [],
      "informacao_pessoal": {
        "cpf_9_pessoal": 538997509,
        "cpf_2_pessoal": 0,
        "identidade_pessoal": 34534534343543,
        "nome_pessoal": "CLAUDIO DA SILVA",
        "data_nascimento": "2000-11-01T00:00:00",
        "email_pessoal": "[email protected]",
        "nome_conjuge": "MARIA DO ROSARIO",
        "observacao_pessoal": "Teste",
        "cep_pessoal": 89251650,
        "endereco_pessoal": "Rua Teste",
        "numero_pessoal": 1234,
        "complemento_pessoal": "Casa",
        "bairro_pessoal": "Centro",
        "cidade_pessoal_id": 4548,
        "cidade_pessoal_descricao": "JARAGUA DO SUL",
        "codigo_Ibge_pessoal": 4208906,
        "estado_pessoal": "SC",
        "pais_pessoal": 1
      }
    }
  ]
}

{
  "data_hora_response": "2023-08-31T10:20:11.981250",
  "id": "0438e762aae55aa7e06364010a0a3117"
}

Alteração Representante

put

/venda/v1/representante

API para integração de PUT de Representante.

(*) - Campos obrigatórios/campos chave: codigo_representante, cnpj_9_representante, cnpj_4_representante, cnpj_2_representante, tipo_comissao_representante

Autorizações

OAuth2clientCredentialsObrigatório

Token URL:

Parâmetros de consulta

syncbooleanOpcional

Informa se a integração é assíncrona (false) ou síncrona (true).

Corpo

Respostas

200

Sucesso.

application/json

data_hora_responsestring · date-timeOpcionalExample: 2023-08-31T10:20:11.981250Pattern: ^\d{4}-[01]\d-[0123]\dT[012]\d:[0-5]\d:[0-5]\d(.\d+)?(Z|([-+][012]\d:[0-5]\d))$

idstringOpcionalExample: 0438e762aae55aa7e06364010a0a3117

401

Não autorizado.

application/json

406

Requisição não aceita, mais de um item em request.

application/json

408

Erro de validação em envio registro não existe para atualização.

application/json

409

Erro de validação em envio novo.

application/json

500

Erro de formatação/json/erro do lado do servidor.

application/json

put

/venda/v1/representante

PUT /venda/v1/representante HTTP/1.1
Host: qa-api-cliente.systextilapps.com.br/
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2138

{
  "items": [
    {
      "codigo_representante": 1212,
      "cnpj_9_representante": 30701253,
      "cnpj_4_representante": 1,
      "cnpj_2_representante": 53,
      "ie_representante": "SC",
      "nome_representante": "LUANA",
      "nome_fantasia_representante": "LUANA",
      "cep_representante": 89255250,
      "endereco_representante": "RUA CARLOS SCHULZ",
      "bairro_representante": "CZERNIEWICZ",
      "cidade_representante_id": 4548,
      "cidade_representante_descricao": "JARAGUA DO SUL",
      "codigo_Ibge_representante": 4208906,
      "estado_representante": "SC",
      "caixa_postal_representante": null,
      "ddd_telefone_representante": 47,
      "telefone_representante": 33711904,
      "ddd_celular_representante": 47,
      "celular_representante": 33711904,
      "fax_representante": 0,
      "email_representante": "[email protected]",
      "codigo_empresa_representante": 1,
      "tipo_representante": 2,
      "banco_representante_id": 33,
      "banco_representante_descricao": "SANTANDER",
      "codigo_agencia_representante": 1539,
      "conta_corrente_representante": "1005543-4",
      "codigo_contabil_representante": 0,
      "core_representante": "F",
      "envia_mala_cliente": "true",
      "percentual_ir_representante": 0,
      "valor_minimo_imposto": 0,
      "percentual_comissao": 5,
      "percentual_comissao_faturamento": 0,
      "percentual_comissao_baixa": 100,
      "percentual_indenizacao_representante": 0,
      "codigo_adminstrador_representante": 200,
      "situacao_representante": 1,
      "tipo_produto_representante_id": 1,
      "tipo_produto_representante_descricao": "VENDEDOR",
      "envia_email_representante": 0,
      "cargo_representante_id": 0,
      "cargo_representante_descricao": "Teste",
      "loja_fv": true,
      "isento_analise": "true",
      "data_atualizacao_api": "2023-11-24T11:12:47Z",
      "outras_representacoes": [],
      "marcas": [],
      "tipo_comissao": [],
      "sub_regioes": [],
      "informacao_pessoal": {
        "cpf_9_pessoal": 538997509,
        "cpf_2_pessoal": 0,
        "identidade_pessoal": 34534534343543,
        "nome_pessoal": "CLAUDIO DA SILVA",
        "data_nascimento": "2000-11-01T00:00:00",
        "email_pessoal": "[email protected]",
        "nome_conjuge": "MARIA DO ROSARIO",
        "observacao_pessoal": "Teste",
        "cep_pessoal": 89251650,
        "endereco_pessoal": "Rua Teste",
        "numero_pessoal": 1234,
        "complemento_pessoal": "Casa",
        "bairro_pessoal": "Centro",
        "cidade_pessoal_id": 4548,
        "cidade_pessoal_descricao": "JARAGUA DO SUL",
        "codigo_Ibge_pessoal": 4208906,
        "estado_pessoal": "SC",
        "pais_pessoal": 1
      }
    }
  ]
}

{
  "data_hora_response": "2023-08-31T10:20:11.981250",
  "id": "0438e762aae55aa7e06364010a0a3117"
}

Exclusão Representante

delete

/venda/v1/representante

API para integração de exclusão de Representante.

Autorizações

OAuth2clientCredentialsObrigatório

Token URL:

Parâmetros de consulta

qstringOpcional

O filtro é permitido apenas pelos atributos do objeto principal.

Esta seção descreve e fornece exemplos de filtragem em consultas em tabelas e exibições habilitadas para REST.

https://api.systextil.com

A consulta a seguir inclui um filtro que restringe a coluna NOME_CLIENTE a "SYSTEXTIL":

https://api.systextil.com/comercial/v1/clientes?q={"nome_cliente":"JOHN"}

Gramática FilterObject

FilterObject { orderby , asof, wmembers }

orderby
  "$orderby": {orderByMembers}
 
orderByMembers
    orderByProperty
    orderByProperty , orderByMembers
 
orderByProperty
    columnName : sortingValue
 
sortingValue
  "ASC"
  "DESC"
  "-1"
  "1"
   -1
   1
   
asof
  "$asof": date
  "$asof": "datechars"
  "$asof": scn
  "$asof": +int
 
wmembers
    wpair
    wpair , wmembers
 
wpair
    columnProperty
    complexOperatorProperty
 
columnProperty
    columnName : string
    columnName : number
    columnName : date
    columnName : simpleOperatorObject
columnName : complexOperatorObject
    columnName : [complexValues]
 
columnName
  "\p{Alpha}[[\p{Alpha}]]([[\p{Alnum}]#$_])*$"
 
complexOperatorProperty
    complexKey : [complexValues]
    complexKey : simpleOperatorObject 
 
complexKey
  "$and"
  "$or"
 
complexValues
    complexValue , complexValues
 
complexValue
    simpleOperatorObject
    complexOperatorObject
    columnObject
 
columnObject
    {columnProperty}
 
simpleOperatorObject
    {simpleOperatorProperty}
 
complexOperatorObject
    {complexOperatorProperty}
 
simpleOperatorProperty
   "$eq" : string | number | date
   "$ne" : string | number | date
   "$lt" :  number | date
   "$lte" : number | date
   "$gt" : number | date
   "$gte" : number | date
   "$instr" : string 
   "$ninstr" : string
   "$like" : string
   "$null" : null
   "$notnull" : null
   "$between" : betweenValue
 
betweenValue
    [null , betweenNotNull]
    [betweenNotNull , null]
    [betweenRegular , betweenRegular]
 
betweenNotNull
    number
    date
    
betweenRegular
    string
    number
    date

Definições de tipo de dados incluem o seguinte:

string 
       JSONString
number
       JSONNumber
date
       {"$date":"datechars"}
scn
       {"$scn": +int}

where

Datechars é um formato de data RFC3339 em UTC (Z)
        
 
JSONString
          ""
          " chars "
chars
         char
         char chars
char
         any-Unicode-character except-"-or-\-or-control-character
          \"
          \\
           \/
          \b
          \f
          \n
          \r
          \t
          \u four-hex-digits
 
 
JSONNumber
    int
    int frac
    int exp
    int frac exp
int
    digit
    digit1-9 digits 
    - digit
    - digit1-9 digits
frac
    . digits
exp
    e digits
digits
    digit
    digit digits
e
    e
    e+
    e-
    E
    E+
    E-

O FilterObject deve ser codificado de acordo com a Seção 2.1 do RFC3986

Exemplos

A seguir estão exemplos de operadores em especificações de FilterObject.

ORDER BY property ($orderby)

Order by with literals

{
"$orderby": {"SALARY":  "ASC","ENAME":"DESC"}
}

Order by with numbers

```json

{ "$orderby": {"SALARY": -1,"ENAME": 1} }

 
y ($asof)
 
### With SCN (Implicit)
```json 
{
  "$asof": 1273919
}

With SCN (Explicit)

{
  "$asof": {"$scn": "1273919"}
}

With Date (Implicit)

{
  "$asof": "2014-06-30T00:00:00Z"
}

With Date (Explicit)

{
  "$asof": {"$date": "2014-06-30T00:00:00Z"}
}

EQUALS operator ($eq)

(Implicit and explicit equality supported._

Implicit (Support String and Dates too)

{
 "SALARY": 1000
}

Explicit

{
 "SALARY": {"$eq": 1000}
}

Strings

{
 "ENAME": {"$eq":"SMITH"}
}

Dates

{
  "HIREDATE": {"$date": "1981-11-17T08:00:00Z"}
}

NOT EQUALS operator ($ne)

Number

{
 "SALARY": {"$ne": 1000}
}

String

```json

{ "ENAME": {"$ne":"SMITH"} }

 
#### Dates
  ```json
{
  "HIREDATE": {"$ne": {"$date":"1981-11-17T08:00:00Z"}}
}

LESS THAN operator ($lt)

(Supports dates and numbers only)

Numbers

```json

{ "SALARY": {"$lt": 10000} }

 
#### Dates
  ```json
{
  "SALARY": {"$lt": {"$date":"1999-12-17T08:00:00Z"}}
}

LESS THAN OR EQUALS operator ($lte)

(Supports dates and numbers only)

Numbers

```json

{ "SALARY": {"$lte": 10000} }


#### Dates
  ```json
{
  "HIREDATE": {"$lte": {"$date":"1999-12-17T08:00:00Z"}}
}

GREATER THAN operator ($gt)

(Supports dates and numbers only)

Numbers

```json

{ "SALARY": {"$gt": 10000} }

 
#### Dates
  ```json
{
  "SALARY": {"$gt": {"$date":"1999-12-17T08:00:00Z"}}
}

GREATER THAN OR EQUALS operator ($gte)

(Supports dates and numbers only)

Numbers

{
  "SALARY": {"$gte": 10000}
}

Dates

{
  "HIREDATE": {"$gte": {"$date":"1999-12-17T08:00:00Z"}}
}

In string operator ($instr)

(Supports strings only) ```json { "ENAME": {"$instr":"MC"} }

 
#### Not in string operator ($ninstr)
(Supports strings only)
  ```json
{
  "ENAME": {"$ninstr":"MC"}
}

####LIKE operator ($like) (Supports strings. Eescape character not supported to try to match expressions with _ or % characters.) ```json { "ENAME": {"$like":"AX%"} }

 
#### BETWEEN operator ($between)
(Supports string, dates, and numbers)
 
#### Numbers
```json
{
  "SALARY": {"$between": [1000,2000]}
}

Dates

```json

{ "SALARY": {"$between": [{"$date":"1989-12-17T08:00:00Z"},{"$date":"1999-12-17T08:00:00Z"}]} }

 
#### Strings
```json
{
  "ENAME": {"$between": ["A","C"]}
}

Null Ranges ($lte equivalent)

(Supported by numbers and dates only)

{
 "SALARY": {"$between": [null,2000]}
}

Null Ranges ($gte equivalent)

(Supported by numbers and dates only)

{
 "SALARY": {"$between": [1000,null]}
}

NULL operator ($null)

{
  "ENAME": {"$null": null}
}

NOT NULL operator ($notnull)

{
  "ENAME": {"$notnull": null}
}

AND operator ($and)

(Supports all operators, including $and and $or)

Column context delegation

(Operators inside $and will use the closest context defined in the JSON tree.)

{
 "SALARY": {"$and": [{"$gt": 1000},{"$lt":4000}]}
}

Column context override

(Example: salary greater than 1000 and name like S%)

{
  "SALARY": {"$and": [{"$gt": 1000},{"ENAME": {"$like":"S%"}} ] }
}

Implicit and in columns

{
  "SALARY": [{"$gt": 1000},{"$lt":4000}] 
}

High order AND

{
  "SALARY": {"$gt": 1000}, 
  "ENAME": {"$or": [{"$like":"S%"}, {"$like":"T%"}]} 
}

Invalid expression (operators $lt and $gt lack column context)

{
   "$and": [{"$lt": 5000},{"$gt": 1000}]
}

Valid alternatives for the previous invalid expression

{
   "$and": [{"SALARY": {"$lt": 5000}}, {"SALARY": {"$gt": 1000}}]
}

{
   "SALARY": [{"$lt": 5000},{"$gt": 1000}]
}
 
{
   "SALARY": {"$and": [{"$lt": 5000},{"$gt": 1000}]}
}

OR operator ($or)

(Supports all operators including $and and $or)

Column context delegation

(Operators inside $or will use the closest context defined in the JSON tree)

{
  "ENAME": {"$or": [{"$eq":"SMITH"},{"$eq":"KING"}]}
}

Column context override

(Example: name starts with S or salary greater than 1000)

{
  "SALARY": {"$or": [{"$gt": 1000},{"ENAME": {"$like":"S%"}} ] }
}

Respostas

200

Sucesso.

application/json

data_hora_responsestring · date-timeOpcionalExample: 2023-08-31T10:20:11.981250Pattern: ^\d{4}-[01]\d-[0123]\dT[012]\d:[0-5]\d:[0-5]\d(.\d+)?(Z|([-+][012]\d:[0-5]\d))$

idstringOpcionalExample: 0438e762aae55aa7e06364010a0a3117

401

Não autorizado.

application/json

406

Requisição não aceita, mais de um item em request.

application/json

408

Erro de validação em envio registro não existe para atualização.

application/json

409

Erro de validação em envio novo.

application/json

500

Erro de formatação/json/erro do lado do servidor.

application/json

delete

/venda/v1/representante

DELETE /venda/v1/representante HTTP/1.1
Host: qa-api-cliente.systextilapps.com.br/
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "data_hora_response": "2023-08-31T10:20:11.981250",
  "id": "0438e762aae55aa7e06364010a0a3117"
}

AnteriorTabela Preço Venda PróximoPedido Venda

Atualizado há 25 dias

Isto foi útil?

hashtagConsulta Representante

Gramática FilterObject

Exemplos

ORDER BY property ($orderby)

Order by with numbers

With SCN (Explicit)

With Date (Implicit)

With Date (Explicit)

EQUALS operator ($eq)

Strings

Dates

NOT EQUALS operator ($ne)

Number

String

LESS THAN operator ($lt)

Numbers

LESS THAN OR EQUALS operator ($lte)

Numbers

GREATER THAN operator ($gt)

Numbers

GREATER THAN OR EQUALS operator ($gte)

Numbers

Dates

In string operator ($instr)

Dates

Null Ranges ($lte equivalent)

Null Ranges ($gte equivalent)

NULL operator ($null)

NOT NULL operator ($notnull)

AND operator ($and)

Column context delegation

Column context override

High order AND

Invalid expression (operators $lt and $gt lack column context)

Valid alternatives for the previous invalid expression

OR operator ($or)

Column context delegation

Column context override

hashtagCadastro Representante

hashtagAPI para integração de POST de Representante.

hashtagAlteração Representante

hashtagAPI para integração de PUT de Representante.

hashtagExclusão Representante

hashtagAPI para integração de exclusão de Representante.

Gramática FilterObject

Exemplos

ORDER BY property ($orderby)

Order by with numbers

With SCN (Explicit)

With Date (Implicit)

With Date (Explicit)

EQUALS operator ($eq)

Strings

Dates

NOT EQUALS operator ($ne)

Number

String

LESS THAN operator ($lt)

Numbers

LESS THAN OR EQUALS operator ($lte)

Numbers

GREATER THAN operator ($gt)

Numbers

GREATER THAN OR EQUALS operator ($gte)

Numbers

Dates

In string operator ($instr)

Dates

Null Ranges ($lte equivalent)

Null Ranges ($gte equivalent)

NULL operator ($null)

NOT NULL operator ($notnull)

AND operator ($and)

Column context delegation

Column context override

High order AND

Invalid expression (operators $lt and $gt lack column context)

Valid alternatives for the previous invalid expression

OR operator ($or)

Column context delegation

Consulta Representante

Cadastro Representante

API para integração de POST de Representante.

Alteração Representante

API para integração de PUT de Representante.

Exclusão Representante

API para integração de exclusão de Representante.