Can
nal A
Auto
orizaadorr  

M ual GrraphQ
Manu QL 
Versão
o 2.0Outub
bro/2017 

 
 

 
 
 

DO
OCUMEN
NTAÇÕESS 
 
 
As docuumentações de toda as requisiçõess poderão seer acessadaas no Menu “Docs”, quee fica ao 
lado direito da tela. 
 
Obs.: Ass mesmas poderão ser acessadas ssomente após configuraações de Opperação (Exxemplos: 
Query ee Mutation).. 
 

 
Query: C
Consulta dee informação no banco. 
on: Alteraçãão/inclusão de informação no bancco. 
Mutatio
 
 
 
TESTESS DE REQQUISIÇÃO
O 
 
1.1 Do
ownload 
 
Os testes d
de requisiçãão deverão sser feitos via extensão “GraphIQL”” para o navvegador 
Googlee Chrome. O O download d do mesmo o pode ser feeito neste link: 
https:///chrome.gooogle.com//webstore/d detail/graph hiql‐
feen/m
mcbfdonlkfp pbfdpimkjilhhdneikhfklp
p. 
 

 
 
 

 
 
onfiguraçção do To
1.2 Co oken 
 
1. A
Ao abrir a extensão, clicar em “Serrvers”, depo
ois nas opçõ
ões do menu
u dropdown
n, 
c
conforme p print abaixo e selecionar “Post”. 
 

 
 
Adicionar a URL https:///ws.fidelizee.com.br/au
2. A utorizador_ddev/graphqql/public ao campo 
“
“Server URL L”. 
3. Clicar em “Q
C Queries”. 
4. No editor d
N e texto, adicionar a queery abaixo p
para retornaar o token: 
 
m
mutation cr reateToken {  
c
createToken n( 
l
login: "distr
ribuidortestee", 
p
password: " "$distr%%" 
)
) {  
  token  
}
}  
}
} 
 
5. Clicar no bo
C otão “Play” ppara executtar a query, conforme imagem abaaixo: 
 
6. Salvar o Tok
S ken que foi gerado, con nforme imaggem abaixo 
 

 
 
 

 
Exemplo
o de token 
 
eyJ0eXA
AiOiJKV1QiLCJhbGciOiJIIUzI1NiJ9.eyyJzdWIiOjEsImlhdCI6MTTUwODM1M MDI5NywiZX
ZXhwIjoxN
TA4NDMM2Njk3LCJqqdGkiOiJjcW
W5oOFVIU29 9ISVY3d2FlIn
n0.VAyNQxxVtb6uZHPU
UTnbj8VZoI‐
FehsO5kkri‐ouWoRA
ABw 
 
 
 
1.3 Accessando
o Requisições 
 
 
1. C
Clicar em “SServers”, deepois nas op
pções do meenu dropdow
wn, conform
me print abaaixo e 
s
selecionar “
“Post”. 
 

 
 
Adicionaar a URL htttps://ws.fidelize.com.b
br/autorizaddor_dev/graaphql ao cam
mpo “Serverr URL”. 
 
2. No campo “
N “Header Nam me”, adicionar “Authorrization” e, no campo ““Header Vallue”, 
a
adicionar “BBearer + esp paço + token”. 
3. Clicar em “Q
C Queries” e d dar F5. 
4. Clicar em “M
C Mutation” p para apareceer toda a do
ocumentaçãão da API, coonforme im
magem 
a
abaixo: 
 

 
 
 

 
 
1.3.1 Importan
nte Sobre a Docu
umentaçãão 
 
 PreOrder: R
P Resposta da requisição enviada. Essta respostaa será enviada a todas as 
r
requisiçõess enviadas àà Fidelize. 
 A os campos clicáveis, serrão mostrad
Ao clicar no dos todos oss campos qu
ue podem/d devem ser 
e
enviados (o brigatórios e não obriggatórios). 
 T
Todos os caampos que ssurgirem com um ponto o de exclam
mação, são o
obrigatórioss. 
 
 
DEFINIÇÃO
O DAS REEQUISIÇÕ
ÕES 
 
 
2.1 Daados da R
Requisiçãão “creattePreOrd
der” 
 
 

 
 
 

Requisiçção para criação de préé‐pedido na Fidelize. 
 
 
2.1.1 C
Campos 
 
grouped d_order_co ode: Código Fidelize de Pedido Agrupado. 
client_id on: CNPJ do PDV. 
dentificatio
wholesaaler: CNPJ d da filial do D
Distribuidor.. 
client_ccode: Código o Interno do o PDV. 
comercial_conditio on: Código d da Condição o Comercial (informado o pela Indússtria). Esta ccondição 
estará ccadastrada nna Fidelize. 
productts: Deverá cconter os campos abaixxo: 
ean: Código EAN do o produto. 
ordered d_quantity: Quantidadee pedida. 
 
Observaação:Em tod da as requissições, o usuuário deveráá realizar um
ma consultaa do pré‐ped dido 
criado. SSendo assimm, é obrigatório o envio o do campo “grouped__order_codee”. Caso a reequisição 
seja envviada sem este campo, a requisição o não será vválida. 
 
O usuárrio poderá d definir quaiss campos retornarão no o “PreOrderr” enviando o os mesmoss 
conformme destacad do no lado eesquerdo daa imagem ab baixo. Ao seer enviada aa requisição,, a 
respostaa será mosttrada ao lado direito daa tela (tamb bém conform me destacad do): 
 
 

 
 
 
2.2 Daados da R
Respostaa da requ
uisição “ccreatePreeOrder” 
 
 

 
 
 

Quando o for enviadaa a requisiçãão createPrreOrder, serrá dada a reesposta PreO
Order 
Clicar em
m PreOrderrao lado direeito da tela para aparecer toda a d documentaçção da API, conforme 
imagem m abaixo: 
 

 
Observaação 1: A reesposta PreO Orderserá d dada a todass as requisiçções envidas à Fidelize.. 
Observaação 2: Com mo a URL do o endpoint éé de uma área de testess, os dados das resposttas são 
fixos, po
ois o objetivvo deste maanual é orien
ntar o distribuidor a co
onfigurar seuu sistema paara se 
comuniccar com a Fidelize via A API. 
 
2.3 Daados da R
Requisiçãão “updaateOrderrResponsse” 
 
Requisiçção para envio do retorrno de pedido à Fidelize. 
 
Observaação: Como o o envio das requisiçõees foi explicado na prim
meira requissição (acimaa), 
“createPreOrder”, na definição das próxim mas requisições, iremo os utilizar so
omente as im
magens. 
 
 

 
 
 

 
2.4 Daados da R
Requisiçãão “updaateOrderrInvoice”” 
 
Requisiçção para envio da nota do pedido à Fidelize.
 
 

 
 
 
2.5 Daados da R
Requisiçãão “send
dOrderCaancellatio
on” 
 
Requisiçção para envio da nota do pedido à Fidelize.
 
Observaação:A requuisição de caancelamentto deve ser eenviada com
m o Código Fidelize de Pedido 
Agrupaddo (grouped d_order_co produto do pedido quee deve ser cancelado, o
ode) e cada p ou seja, o 
cancelamento do p pedido podee ser parcial ou total. Os produtos que não forrem cancelaados não 
devem cconstar nesse arquivo. 
 

 
 
 

 
 
 
2.6 Daados da R
Requisiçãão “send
dOrderDe
evolution
n” 
 
Requisiçção para envio da nota do pedido à Fidelize.
 
Observaação: A requ devolução deve ser envviada com o Código Fideelize de Ped
uisição de d dido 
Agrupaddo (grouped d_order_coode) e cada p produto do pedido quee foi devolviido, ou seja,, a 
devoluçção do pediddo pode serr parcial ou total. Os produtos que não foram devolvidos,, não 
devem cconstar nesse arquivo. 
 
 

 
 
 
EEXEMPLO
OS DE REEQUISIÇÃ
ÃO 
 
 3.1 crreatePreOrder 
 
 

 
 
 

mutatioon createPreeOrder { 
createPreOrder( 
client_iddentification: "1", 
  wholessaler: "234", 
client_ccode: "1234", 
commercial_condittion: "asdass", 
  produccts: [ 
    { 
ean: "788910003155 50", 
ordered d_quantity: 3 
    } 
  ] 
) { 
  groupeed_order_co ode 
} 
} 
 
 
3.2 up
pdateOrd
derRespo
onse 
 
 
mutatio on updateOrrderResponse{ 
updateO OrderRespo onse( 
  client__code:1,  
  date_time_processsing:"18/05 5/2017", 
  groupeed_order_co ode:4, 
order_m motive: ORDDER_SUCCESSSFULLY_AC CCEPTED, 
productts:[ 
    { 
      ean:"1234", 
      response_quanttity:1, 
      perccent_discount:0.5, 
      unit__discount_p
price:10.00,, 
      unit__net_price:10.00, 
productt_motive:PR RODUCT_SU UCCESSFULLLY_ACCEPTEED, 
monitorred_producct_flag:"F", 
      wholesaler_mottive:"000", 
      industry_order__code:"1234 456", 
industryy_abbreviattion:"SAN" 
    } 
  ], 
  total_vvalue:10.00,, 
 

 
 
 

  discount_value:10
0.00 
) 
{ 
  groupeed_order_co
ode 
} 
} 
 
 
3.3 up
pdateOrd
derInvoicce 
 
 
mutatioon updateOrrderInvoice { 
updateO OrderInvoice( 
client_ccode: "134" 
date_timme_processsing: "2017‐‐05‐01 10:03 3:10" 
invoice__issue_datee: "2017‐03‐‐09" 
  wholessaler: "7147
7610800010 01" 
  groupeed_order_co ode: 1 
invoice__number: 39 984 
base_caalculation_iccms_tax_su ubstitution: 10.23 
base_caalculation_iccms: 6.89 
danfe_kkey: "A9490 0" 
invoice__value: 180.39 
invoice__discount_vvalue: 38.100 
icms_vaalue_transfeerred: 40.277 
productts_total_value: 185.39 
invoice__products: [[ 
    { 
ean: "788916273140 05" 
invoice__quantity: 1
10 
percentt_discount: 1.87 
unit_disscount_price: 2.30 
unit_net_price: 10..38 
base_caalculation_iccms: 5.30 
base_caalculation_iccms_tax_su ubstitution: 4.23 
percentt_icms_aliquuot: 1.39 
percentt_ipi_aliquot: 1.23 
icms_vaalue: 5.00 
st_valuee: 1.39 
icms_traansferred_vvalue: 3.98  
cfop: 100.55 
tax_subbstitution_flag: "O" 
 

 
 
 

positivee_list_identiifier: "P" 
productt_deadline: 90 
productt_classification: 2 
dcb: "ab bcd" 
transferr_value: 5.44 
productt_total_valu ue: 10.93 
productt_total_valu ue_charges:  19.10 
tax_stattus_code: "D" 
percentt_financial_d discount: 100.18 
percentt_unit_finan ncial_discou
unt: 7.58 
      typee: "M" 
industryy_order_cod de: "1234566" 
industryy_abbreviattion: "RB" 
    } 
  ] 
invoice__aliquots: [{{ 
percentt_aliquot_icms: 1.39 
base_caalculation_iccms: 4.30 
icms_to otal_value: 6
60.38 
  }] 
invoice__billets: [{ 
    numb ber: "C1234DBF" 
due_datte: "2017‐03‐08" 
    value: 149.30 
issue_date: "2017‐0 03‐09" 
plot_value: 44.38 
antecipaated_discou unt: 10.39 
percentt_interest_p per_day: 1.000 
percentt_financial_d discount: 1..37 
    lot: 3..39 
bank_co ode: "A3984 4" 
bank_aggency: "013 3" 
current__account_n number: "24 487‐1" 
financiaal_discount__total_valuee: 10.39 
  }] 
icms_to otal_value_wwithheld: 3.34 
icms_to otal_value: 4
4.45 
volume__quantity: 1 10 
) { 
  groupeed_order_co ode 
} 
} 
 
 

 
 
 

 
3.4 seendOrderrCancellaation 
 
 
mutatioon sendOrdeerCancellatiion{ 
sendOrd derCancellation( 
  groupeed_order_co ode: 1 
  produccts: [ 
  { 
ean: "29942849248"" 
industryy_abbreviattion: "SAN" 
} 
] 
 
) { 
  groupeed_order_co ode 
} 
} 
 
 
3.5 seendOrderrDevoluttion 
 
mutatioon sendOrdeerDevolutioon{ 
sendOrd derDevolutiion( 
  groupeed_order_co ode: 1 
  produccts: [ 
  { 
ean: "29942849248"" 
refundeed_quantity: 3 
industryy_abbreviattion: "SAN" 
  } 
  { 
ean: "49914824985"" 
refundeed_quantity: 5 
industryy_abbreviattion: "MED" 
} 
] 
 
) { 
  groupeed_order_co ode 
} 
}