API de Integração E-Zoop Documentação de uso

Transcrição

1 API de Integraçã E-Zp Dcumentaçã de us Data de Atualizaçã: 10/06/2015

2 Índice 1. Intrduçã Características... 2 Cadastr de características... 2 Exclusã de características... 4 Listagem de características Categrias... 8 Cadastr de categrias... 8 Exclusã de categrias Listagem de categrias Tabelas de preç Cadastr de tabelas de preçs Exclusã de tabelas de preçs Listagem de tabelas de preçs Galeria de Imagens Uplad de Imagem Renmear Imagem Apagar Imagem Enviada Listagem de Imagens Grades de prduts Cadastr de grades Exclusã de grades Listagem de grades Prduts Cadastr de prduts Cadastr de lista de prduts Alteraçã de estque de prduts pr id Alteraçã de estque de prduts pr SKU Inativaçã de prduts pr id Inativaçã de prduts pr SKU Reativaçã de prduts pr id... 54

3 Reativaçã de prduts pr SKU Exclusã de prduts pr id Exclusã de prduts pr SKU Cnsulta de prdut pr id Cnsulta de prdut pr SKU Variações Cadastr de Variações Exclusã de Variações Cnsulta de Variaçã pr id Grups Cadastr de grups Exclusã de grups Listagem de grups Clientes Cadastr de clientes Cadastr de endereçs de clientes Cnsulta de cliente pr id Cnsulta de clientes pr filtr Etapas Cadastr de etapas Exclusã de etapas Listagem de etapas Pedids Cnsulta de pedid pr id Listagem de pedids pr filtr Atualizaçã de andament de pedid Uplad de arquivs de NFe Cancelament de pedids Reativaçã de pedids Ativaçã de integraçã de pedid Destaques

4 Cadastr de destaques Exclusã de destaques Serviçs de entrega Listagem de serviçs de entrega Pendências de Integraçã Listagem de pendências de integraçã Infrmar cnclusã de pendência de integraçã

5 1 1. Intrduçã A API de integraçã tem cm bjetiv permitir que as infrmações das ljas virtuais criadas na platafrma de cmérci eletrônic da Alterdata pssam ser btidas e incluídas de frma autmatizada cm sftwares de retaguarda cm pr exempl, Sistemas de gestã empresarial (ERPs), sistemas de autmaçã cmercial, etc. Para utilizar estes recurss a cnta de sua lja virtual deve estar habilitada para utilizaçã da API de integraçã. Se sua cnta ainda nã pssuir este recurs, cntate nss setr cmercial para atualizar sua assinatura. O padrã de trca de mensagens adtad é REST. Este padrã utiliza as perações d prtcl HTTP (Pst, Get, Put e Delete) para receber e dispnibilizar s dads. O frmat de cnsum e respsta de tds s métds da API de integraçã é JSON. Além diss, tda vez que a API de integraçã fr cnsumida, devem ser enviads na requisiçã HTTP s cabeçalhs URL e Tken. URL: endereç da sua lja virtual (Ex: ljadcarls.cm.br u ljadcarls.ezp.cm.br) Tken: sua chave de acess à API de integraçã esta chave será dispnibilizada quand sua assinatura pssuir acess as recurss de integraçã.

6 2 2. Características As características de prduts fram criadas para dar definiçã as prduts. N mment d cadastr ds prduts pderems infrmar as suas características e s seus respectivs valres para cada uma delas. Pr exempl, um prdut Televisã Led 3D 42 plegadas define a característica Tip cm valr Led. Os valres estabelecids na vinculaçã de características as prduts pderã ser usads psterirmente para cmpr filtrs na lja virtual. Cadastr de características Para cadastrar uma característica devem ser seguids s seguintes passs. URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/caracteristicas/salvar Métd: POST Parâmetr: caracteristica, atualizarapenasdadsinfrmads O parâmetr atualizarapenasdadsinfrmads indica a sistema se s dads devem ser atualizads cm exatamente s dads enviads inclusive se frem enviads dads em branc u se se serã atualizads apenas s dads que fram infrmads, u seja, que estiver em branc nã será atualizad. O valr padrã neste parâmetr é S cas nã seja infrmad. Infrme S para indicar que devem ser atualizads apenas s camps que fram infrmads. Infrme N para indicar que tds s camps serã alterads independentemente de nã serem infrmads, u infrmads em branc. Exempl de cnsum

7 3 Retrn: O id da característica cadastrada u atualizada cas a prpriedade Id tenha sid enviada cm valr diferente de 0. Descriminaçã ds camps Camp Especificaçã Descriçã Id Int Infrme 0 para cadastrar uma nva característica, u Id da característica que deseja atualizar cadastr. (Ex: 5). Descrica String Infrme a descriçã da característica que está manipuland. Tip Int Este camp determina tip da característica que está send manipulada. Cas nã seja enviad nenhum ds valres abaix, a característica assumirá tip Text. As pções sã: 1 - Text : determina que a definiçã de valres para a característica é através de um camp de text abert. 2 - CaixaSeleca : assim, para definir um valr para esta característica é apresentad um checkbx que indicará se prdut tem u nã esta característica. 3 - ListaDeItens : neste cas será exibida uma lista de pções n mment da definiçã d valr desta característica. Deve ser selecinada uma das pções.

8 4 Filtr Opces Nullable<Bl> Array de strings Infrma se esta característica pde ser usada, u nã, para criaçã de filtrs de navegaçã na lja virtual. Obs: Este camp pde pssuir valr nul u valres bleans. Cas a característica seja d tip lista, aqui devem ser infrmadas as pções que usuári terá para selecinar n valr desta característica quand fr definida em um prdut. Exclusã de características Para excluir uma característica devem ser seguids s passs abaix. Fique atent a usar este recurs, pis a exclusã de uma característica implica na exclusã de sua definiçã em tds s prduts que pssuírem valr para tal. URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/caracteristicas/excluir/{id} Métd: GET Parâmetr: id Exempl de cnsum Retrn: nenhum Descriminaçã ds camps Camp Especificaçã Descriçã Id Int É identificadr da característica que será remvida da base de dads da lja virtual.

9 5 Listagem de características Este recurs serve para que seja btida a listagem de características cadastradas na lja virtual. Seu bjetiv é permitir que cas cliente já esteja perand a lja virtual sem integraçã, n mment de iniciar us da integraçã pssa vincular as características já existentes n site cm entidades crrespndentes n sistema de retaguarda, evitand duplicidade de infrmações. URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/caracteristicas/listar Métd: GET Parâmetr: Exempl de cnsum Retrn: a listagem de tdas as características cadastradas n seu banc de dads. Descriminaçã ds camps Camp Especificaçã Descriçã Descrica String Infrma a descriçã da característica que está manipuland. Filtr Nullable<Bl> Infrma se esta característica pde ser usada, u nã, para criaçã de filtrs de navegaçã na lja virtual. Obs: Este camp pde pssuir valr nul u valres bleans. Id Int É identificadr da característica da base de dads da lja virtual. Opces Array de String Cas a característica seja d tip lista, aqui sã infrmadas as pções que usuári pderá selecinar n valr desta característica quand fr definida em um prdut.

10 6 Tip Int Este camp infrma tip da característica listada. As pções pssíveis sã: 1 - Text : determina que a definiçã de valres para a característica é através de um camp de text abert. 2 - CaixaSeleca : assim, para definir um valr para esta característica é apresentad um checkbx que indicará se prdut tem u nã esta característica. 3 - ListaDeItens : neste cas será exibida uma lista de pções n mment da definiçã d valr desta característica. Deve ser esclhida uma das pções. Exempl de retrn

11 7

12 8 3. Categrias As categrias de prduts, que também pdems chamar de departaments u ljas, servem para determinar qual a natureza de um prdut (Ex: Eletrônics). N cadastr ds prduts terems que infrmar a qual categria prdut pertence. Pr exempl, um prdut Televisã Led 3D 42 plegadas pertence à categria Televisres. As categrias também serã úteis n cadastr de banners para definir em qual categria s banners serã exibids n cas de cadastr de banners para exibiçã em categrias e nã na página principal. Cadastr de categrias Para cadastrar uma categria devem ser seguids s seguintes passs. URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/categrias/salvar Métd: POST Parâmetrs: categria, pcaatualizacasubcategrias, cmprtamentcaracteristicascategriapai, atualizarapenasdadsinfrmads O parâmetr pcaatualizacasubcategrias é um inteir que indica que açã será executada em relaçã às características das subcategrias. Deverá ser infrmad n mment de uma ediçã, cas nã seja infrmad, a pçã padrã será a de nã mdificar as características das subcategrias. Pde-se infrmar n parâmetr as seguintes pções: 0 NaMdificar (Nã realizará mdificações nas características das subcategrias); 1 Unir (Adicinará as características da categria a ser salva nas subcategrias); 2 ReplicarMdificaces (Fará, na listagem de características das subcategrias, as mesmas mdificações, u seja, inclusões e remções, feitas na listagem de características da categria a ser salva); 3 Sbreescrever (Substituirá as características das subcategrias cm as características da categria a ser salva).

13 9 O parâmetr cmprtamentcaracteristicascategriapai é um inteir que indica que açã será executada para as características da categria pai em relaçã às características da categria manipulada. Cas nã seja infrmad, a pçã padrã será a de nã mdificar as características da categria manipulada. Pde-se infrmar n parâmetr as seguintes pções: 0 Descnsiderar (Nã realizará mdificações nas características da categria manipulada); 1 Unir (Unirá as características da categria pai às características da categria manipulada); 2 Substituir (Substituirá as características da categria manipulada pelas características da categria pai). O parâmetr atualizarapenasdadsinfrmads indica a sistema se s dads devem ser atualizads cm exatamente s dads enviads inclusive se frem enviads dads em branc u se se serã atualizads apenas s dads que fram infrmads, u seja, que estiver em branc nã será atualizad. O valr padrã neste parâmetr é S cas nã seja infrmad. Infrme S para indicar que devem ser atualizads apenas s camps que fram infrmads. Infrme N para indicar que tds s camps serã alterads independentemente de nã serem infrmads, u infrmads em branc. Exempl de cnsum

14 10 Retrn: O id da categria cadastrada u atualizada cas a prpriedade Id tenha sid enviada cm valr diferente de 0. Descriminaçã ds camps Camp Especificaçã Descriçã Id Int Infrme 0 para cadastrar uma nva categria, u Id da categria que deseja atualizar cadastr. (Ex: 5). Descrica String Infrme a descriçã da categria que está manipuland. Menu IdCategriaPai Nullable<Bl> Nullable<Int> Indica se esta categria cmpõe s menus principais da lja virtual. Obs: Este camp pde pssuir valr nul u valres bleans. Cas nã seja enviad, será atribuíd valr false a ele. O identificadr da categria pai desta, indicand que esta categria que está send criada u atualizada é uma subcategria da categria cm identificadr infrmad neste camp. Obs: Este camp pde pssuir valr nul u valres inteirs. Caracteristicas Array de Int Aqui vai a listagem ds identificadres das características que serã vinculadas a categria que estams manipuland. Estas características deverã ser especificadas n mment d cadastr de um prdut na categria que será salva. Exclusã de categrias Para excluir uma categria devem ser seguids s passs abaix. Fique atent a usar este recurs, pis a exclusã de uma categria pde fazer cm que s prduts que estavam alcads nesta categria fiquem sem categria e nã apareçam na lja virtual.

15 11 URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/categrias/excluir Métd: POST Parâmetrs: id e idnvacategria Exempl de cnsum Retrn: nenhum Descriminaçã ds camps Camp Especificaçã Descriçã id idnvacategria Int Int É identificadr da categria que será remvida da base de dads da lja virtual. É identificadr da categria para qual serã migrads s prduts da categria que será excluída. N cas d valr deste camp ser enviad 0, s prduts da categria a ser excluída ficarã sem categria após a exclusã. Listagem de categrias Este recurs serve para que seja btida a listagem de categrias cadastradas na lja virtual. Seu bjetiv é permitir que cas cliente já esteja perand a lja virtual sem integraçã, n mment de iniciar us da integraçã, pssa vincular as categrias já existentes em sua lja cm entidades crrespndentes n sistema de retaguarda, evitand duplicidade de infrmações.

16 12 URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/categrias/listar Métd: GET Parâmetr: Exempl de cnsum Retrn: a listagem de tdas as categrias cadastradas n seu banc de dads. Descriminaçã ds camps Camp Especificaçã Descriçã Id Int É identificadr da categria na base de dads da lja virtual. Descrica String Infrma a descriçã da categria. Menu IdCategriaPai Nullable<Bl> Nullable<Int> Indica se esta categria cmpõe s menus principais da lja virtual. Obs: Este camp pde pssuir valr nul u valres bleans. O identificadr da categria pai desta, indicand que esta categria que está send criada u atualizada é uma subcategria da categria cm identificadr infrmad neste camp. Obs: Este camp pde pssuir valr nul u valres inteirs. Caracteristicas Array de Int Aqui fica a listagem ds identificadres das características que estã vinculadas a categria. Estas características serã especificadas n mment d cadastr de um prdut na categria. Exempl de retrn

17 13

18 14 4. Tabelas de preç O cadastr de tabelas de preç serve para prgramar preçs para s prduts. Cada uma delas deve ter um períd de vigência. Assim, neste períd serã exibids s preçs definids ns prduts para esta tabela de preçs. Para definir preç de um prdut em uma tabela de preçs, n mment d cadastr de prduts serã infrmads a tabela de preçs e valr daquele prdut na tabela de preçs em questã. Cas prdut nã tenha preç definid para uma tabela de preçs, quand ela entrar em vigência, preç exibid será preç padrã d prdut. É imprtante saber que preç da tabela de preçs u preç padrã d prdut só serã exibids se huver estque d prdut. Cadastr de tabelas de preçs Para cadastrar uma tabela de preçs devem ser seguids s seguintes passs. URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/tabelasprec/salvar Métd: POST Parâmetr: tabela, atualizarapenasdadsinfrmads O parâmetr atualizarapenasdadsinfrmads indica a sistema se s dads devem ser atualizads cm exatamente s dads enviads inclusive se frem enviads dads em branc u se se serã atualizads apenas s dads que fram infrmads, u seja, que estiver em branc nã será atualizad. O valr padrã neste parâmetr é S cas nã seja infrmad. Infrme S para indicar que devem ser atualizads apenas s camps que fram infrmads. Infrme N para indicar que tds s camps serã alterads independentemente de nã serem infrmads, u infrmads em branc.

19 15 Exempl de cnsum Retrn: O id da tabela de preçs cadastrada u atualizada cas a prpriedade Id tenha sid enviada cm valr diferente de 0. Descriminaçã ds camps Camp Especificaçã Descriçã Id Int Infrme 0 para cadastrar uma nva tabela de preçs, u Id da tabela que deseja atualizar cadastr. (Ex: 5). Descrica String Infrme a descriçã da tabela de preçs que está manipuland. DataInicial DataFinal String String A data que iniciará períd de vigência da tabela de preçs. O frmat deve ser DD/MM/AAAA (Ex: 01/12/2020) A data que determina fim d períd de vigência da tabela de preçs. O frmat deve ser DD/MM/AAAA (Ex: 31/12/2020)

20 16 Exclusã de tabelas de preçs Para excluir uma tabela de preçs devem ser seguids s passs abaix. Fique atent a usar este recurs, pis a exclusã de uma tabela de preçs fará cm que s prduts cm definiçã de preç na tabela em questã percam estes vínculs. Se prdut pssuir definiçã de preç em utras tabelas de preçs estes vínculs nã serã perdids. URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/tabelasprec/excluir/{id} Métd: GET Parâmetr: id Exempl de cnsum Retrn: nenhum Descriminaçã ds camps Camp Especificaçã Descriçã Id Int É identificadr da tabela de preçs que será remvida da base de dads da lja virtual. Listagem de tabelas de preçs Este recurs serve para que seja btida a listagem de tabelas de preçs cadastradas na lja virtual. Seu bjetiv é permitir que cas cliente já esteja perand a lja virtual sem integraçã, n mment de iniciar us da integraçã, pssa vincular as tabelas já existentes em sua lja cm entidades crrespndentes n sistema de retaguarda, evitand duplicidade de infrmações.

21 17 URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/tabelasprec/listar Métd: GET Parâmetr: Exempl de cnsum Retrn: a listagem de tdas as tabelas cadastradas n seu banc de dads. Descriminaçã ds camps Camp Especificaçã Descriçã Id Int É identificadr da tabela na base de dads da lja virtual. Descrica String Infrma a descriçã da tabela de preçs que está manipuland. DataInicial String A data que iniciará períd de vigência da tabela de preçs. O frmat é DD/MM/AAAA (Ex: 01/12/2020) DataFinal String A data que determina fim d períd de vigência da tabela de preçs. O frmat é DD/MM/AAAA (Ex: 31/12/2020) Exempl de retrn

22 18

23 19 5. Galeria de Imagens Na base de dads das ljas virtuais é mantid um repsitóri das imagens enviadas, para que uma imagem pssa ser usada em diverss cadastrs sem a necessidade de se cadastrar uma cópia desta imagem para ser usada nvamente. As imagens da galeria sã utilizadas em: prduts, banners, aparência e pções de grade. Para integraçã, este recurs será mais utilizad para cadastr de imagens de prduts e pções de grade. Uplad de imagens Para realizar uplad de uma imagem devem ser seguids s passs citads abaix. Este métd deve ser usad antes d cadastr de prduts, para que s arquivs gerads pel cnsum deste pnt de integraçã sejam enviads n cntrat n mment d cadastr u atualizaçã de um prdut. URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/imagens/uplad Métd: POST Parâmetr: data O parâmetr data é um stream que cntém arquiv que está send enviad. Cabeçalh Para a peraçã de Uplad, além ds cabeçalhs URL e Tken, deve ser infrmad também: FileName cntend nme d arquiv. LcalImagem cntend um inteir que crrespnde à utilizaçã da imagem, pdend ser: 0 Prdut 1 Banner de Tp 2 Banner de Lateral

24 20 3 Aparência 4 Grade Exempl de cnsum (C#)

25 21 Retrn: A imagem que fi cadastrada e salva na base de dads. Descriminaçã ds camps Camp Especificaçã Descriçã

26 22 data Stream Este camp dependerá da linguagem em que fr implementada a integraçã, n C# ele é um array de bytes. Renmear Imagem Para alterar nme de imagem enviada devem ser seguids s passs abaix. Se nme pertencer a utra imagem cm utra finalidade(lcal) nã haverá prblema, prém se nme pertencer a utra imagem cm mesm lcal, nã será pssível renmear a imagem. Ainda que seja infrmada uma extensã diferente a renmear uma imagem, sistema usará apenas nv nme d arquiv e irá descnsiderar a nva extensã, mantend a extensã riginal d arquiv. URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/imagens/renmear Métd: POST Parâmetr: arquiv, nvnme, lcal Exempl de cnsum Retrn: A imagem atualizada cm nv nme. Descriminaçã ds camps Camp Especificaçã Descriçã

27 23 arquiv String O nme atual d arquiv da imagem. nvnme String O nv nme d arquiv da imagem. Um inteir que define a finalidade da imagem. Pdend ser: 0 Prdut; 1 Banner de Tp; lcal Int 2 Banner de Lateral; 3 Aparência; 4 Grade. Exclusã de imagens enviadas Para remver uma imagem, ela nã pde estar em us e devem ser seguids s passs definids abaix. URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/imagens/apagar Métd: POST Parâmetr: arquiv, lcal Exempl de cnsum Retrn: nenhum Descriminaçã ds camps

28 24 Camp Especificaçã Descriçã arquiv lcal String Int É nme d arquiv gerad sem a extensã. Assim, a API de integraçã irá apagar s arquivs gerads a partir desse nme. É lcal da pasta d arquiv que reflete na sua utilizaçã, pdend ser: 0 - Prdut 1 - Banner de Tp 2 Banner de Lateral 3 Aparência 4 Grade Listagem de imagens Este recurs serve para que seja btida a listagem de imagens cadastradas na lja virtual. Seu bjetiv é permitir que cas cliente já esteja perand a lja virtual sem integraçã, n mment de iniciar us da integraçã, pssa vincular as imagens já existentes em sua lja cm entidades crrespndentes n sistema de retaguarda, evitand duplicidade de infrmações. URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/imagens/listar Métd: GET Parâmetr: Exempl de cnsum Retrn: a listagem de tdas as imagens cadastradas n seu banc de dads.

29 25 Descriminaçã ds camps Camp Especificaçã Descriçã Id Int É identificadr da imagem na base de dads da lja virtual. Altura Decimal Infrma a altura da imagem. Arquiv String O nme d arquiv da imagem. Largura String Infrma a largura da imagem. Lcal Int Um inteir que define a finalidade (lcalizaçã) da imagem. Pdend ser: 0 Prdut; 1 Banner de Tp; 2 Banner de Lateral; 3 Aparência; 4 Grade. URL String A url cm caminh cmplet da imagem. Exempl de retrn

30 26

31 27 6. Grades de Prduts O cadastr de grades de prduts serve para que psterirmente sejam cadastrads prduts cm variações. Grades pdem ser utilizadas pr inúmers prduts cm variações, pr exempl, dis prduts que pssuem variações de cr e/u tamanh. A cadastrar um prdut cm variaçã, usuári deverá infrmar em quais grades prdut varia (Ex.: Gêner, Tamanh e Cr). Na lja virtual quand cliente visualizar uma das variações verá também na mesma página as utras pções de variaçã daquele prdut. Cadastr de Grades de prduts Para cadastrar uma grade devem ser seguids s passs citads abaix. URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/grades/salvar Métd: POST Parâmetr: grade, atualizarapenasdadsinfrmads O parâmetr atualizarapenasdadsinfrmads indica a sistema se s dads devem ser atualizads cm exatamente s dads enviads inclusive se frem enviads dads em branc u se se serã atualizads apenas s dads que fram infrmads, u seja, que estiver em branc nã será atualizad. O valr padrã neste parâmetr é S cas nã seja infrmad. Infrme S para indicar que devem ser atualizads apenas s camps que fram infrmads. Infrme N para indicar que tds s camps serã alterads independentemente de nã serem infrmads, u infrmads em branc.

32 28 Exempl de cnsum

33 29 Retrn: A grade de prduts cadastrada u atualizada cas a prpriedade Id tenha sid enviada cm valr diferente de 0. Discriminaçã ds camps Camp Especificaçã Descriçã Id Int Infrme 0 para cadastrar uma nva grade, u Id da grade que deseja atualizar cadastr. (Ex: 5). Nme String É nme u descriçã da grade de prduts. NmeExibica String É text que será exibid cm nme/descriçã da grade na lja virtual. É a array de pções da grade de prduts (Ex.: Grade: Cr, Opções: Azul, Pret e Branc). Camps: Opces Array de OpcaGrade Id: É identificadr da pçã. Imagem: A imagem que representa a pçã de grade e será exibida na lja virtual. (Ex.: Cas a grade seja Cr e as pções Azul e Preta, este camp pderia armazenar uma imagem cm uma representaçã das cres azul u preta). Valr: O valr da pçã de grade (Se nã fr infrmada uma imagem, este será text exibid na lja virtual). Ordem: A rdem da pçã de grade em relaçã às utras. Deve ser infrmad um valr únic para cada

34 30 pçã. Um inteir que infrma cm as pções da grade serã apresentadas Pdend ser: FrmaExibica Int 0 - Text; 1 - Retangular; (Uma imagem cm frmat retangular). 2 - Circular; (Uma imagem cm frmat circular). Exclusã de Grades de prduts Para remver uma grade de prduts, nenhum prdut pde estar vinculad a ela e devem ser seguids s passs abaix. URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/grades/excluir/{id} Métd: GET Parâmetr: id Exempl de cnsum Retrn: nenhum Descriminaçã ds camps Camp Especificaçã Descriçã Id Int É identificadr da grade que será remvida da base de dads da lja virtual.

35 31 Listagem de Grades de prduts Este recurs serve para que seja btida a listagem de grades cadastradas na lja virtual. Seu bjetiv é permitir que cas cliente já esteja perand a lja virtual sem integraçã, n mment de iniciar us da integraçã, pssa vincular as grades já existentes em sua lja cm entidades crrespndentes n sistema de retaguarda, evitand duplicidade de infrmações. URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/grades/listar Métd: GET Parâmetr: id Exempl de cnsum Retrn: A lista de grades de prduts cadastradas na base de dads. Descriminaçã ds camps Camp Especificaçã Descriçã Id int É identificadr da grade na base de dads. Nme String É nme u descriçã da grade de prduts. NmeExibica String É text que será exibid cm nme da grade na lja virtual. É a array de pções da grade de prduts. (Ex.: Grade: Cr, Opções: Azul, Pret e Branc). Opces Array de Opces Camps: Id: É identificadr da pçã. Imagem: A imagem que representa a pçã de grade e será exibida na lja virtual.

36 32 FrmaExibica Int Valr: O valr da pçã de grade (Se nã fr infrmada uma imagem, este será text exibid na lja virtual). Ordem: A rdem da pçã de grade em relaçã às utras. Um inteir que infrma cm as pções da grade serã apresentadas Pdend ser: 0 Text; 1 Retangular; (Uma imagem cm frmat retangular). 2 Circular; (Uma imagem cm frmat circular). Exempl de retrn

37 33

38 34

39 35 7. Prduts Este recurs permite que sejam cadastrads e mantids prduts na base de dads de sua lja virtual. Os prduts irã utilizar a mairia das infrmações já definidas aqui anterirmente. Eles também serã usads n cadastr de destaques, que define quais prduts sã exibids na primeira página da lja virtual. Existem dis tips de prduts, prdut simples e prdut cm variações. Prduts cm variações sã prduts que pssuem grade, pr exempl, uma camiseta que tem as variações de tamanh e cr. Cadastr de prduts Para cadastrar um prdut devem ser seguids s seguintes passs. URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/prduts/salvar Métd: POST Parâmetrs: prdut, sbrescreverfts e atualizarapenasdadsinfrmads Prduts cm variaçã devem infrmar s camps Variaces e Grades n parâmetr Prdut. O parâmetr sbrescreverfts indica se sistema irá sbrescrever as fts existentes pel que está send enviad n prdut u se serã smadas as fts já existentes n prdut que está send salv. O valr padrã neste parâmetr é N cas nã seja infrmad. Infrme S para indicar que as fts serã sbrescritas pelas enviadas. Infrme N para indicar que as fts enviadas serã acrescentadas às fts já existentes n prdut. O parâmetr atualizarapenasdadsinfrmads indica a sistema se s dads devem ser atualizads cm exatamente s dads enviads inclusive se frem enviads dads em branc u se se serã atualizads apenas s dads que fram infrmads, u seja, que estiver em branc nã será atualizad. O valr padrã neste parâmetr é S cas nã seja infrmad. Infrme S para indicar que devem ser atualizads apenas s camps que fram infrmads.

40 36 Infrme N para indicar que tds s camps serã alterads independentemente de nã serem infrmads, u infrmads em branc. Exempl de cnsum para salvar prduts simples

41 37

42 38 Exempl de cnsum para salvar prduts cm variaçã

43 39

44 40

45 41

46 42

47 43 Retrn: O id d prdut cadastrad u atualizad, cas a prpriedade Id tenha sid enviada cm valr diferente de 0. Descriminaçã ds camps Camp Especificaçã Descriçã Ativ Id Bl Int Indica se prdut está ativ u nã. Infrme true para prduts ativs e false para prduts inativs. Infrme 0 para cadastrar um nv prdut, u Id d prdut que deseja atualizar cadastr. (Ex: 5). Nme String Infrme nme d prdut que está manipuland. Descrica String Infrme a descriçã detalhada d prdut que está manipuland. Categria Cntrat de Categria A categria d prdut. SKU String Infrme códig únic d prdut que está send manipulad. URL Frmat Altura Largura String Int Decimal Decimal Este camp é a URL amigável deste prdut na lja virtual. Ela é usada para melhrar a indexaçã da lja virtual em mecanisms de busca (Ggle, Bing, etc) É frmat da embalagem d prdut quand fr despachad. Esta infrmaçã é usada pels crreis para realizar cálcul de frete. As infrmações válidas sã: 1: Frmat caixa/pacte 2: Frmat rl/prisma 3: Envelpe Infrme aqui, em centímetrs, a altura da embalagem de envi d prdut. Infrme aqui, em centímetrs, a largura da embalagem de envi d prdut. Cmpriment Decimal Infrme aqui, em centímetrs, cmpriment da embalagem de

48 44 Diametr Decimal envi d prdut. Infrme aqui, em centímetrs, diâmetr da embalagem de envi d prdut. Integrad Bl Indica se prdut fi cadastrad através da integraçã. Pes flat Infrme aqui, em quilgramas, pes brut da embalagem de envi d prdut. Prec Decimal Neste camp é infrmad preç padrã d prdut. Quantidade Int Aqui deve ser infrmada a quantidade em estque d prdut. Precs Caracteristicas Fts Array de Precs Array de Características Array de Fts Aqui é infrmada uma array cm a definiçã de preçs. Em cada bjet deve ser infrmad Id d preç, a tabela de preçs vinculada neste preç (Pdem ser infrmads tds s camps u apenas camp Id que é utilizad pela API de integraçã) e valr d prdut neste víncul. Obs.: Para prduts cm variaçã, este camp deve vir nas variações. Cas seja infrmad n prdut base, seu valr será replicad nas variações e será remvid d prdut base. Aqui é infrmada uma array cm a definiçã de valres para as características d prdut. Em cada bjet deve ser infrmad Id da definiçã da característica, a característica vinculada neste vincul (Pdem ser infrmads tds s camps u apenas camp Id que é utilizad pela API de integraçã) e valr, u descriçã, que prdut pssui para esta característica. Obs.: Para prduts cm variaçã, este camp deve vir nas variações. Cas seja infrmad n prdut base, seu valr será replicad nas variações e será remvid d prdut base. Neste camp fica a array cm as fts d prdut. Estas fts sã enviadas através d métd de uplad de imagens para galeria que é explicad na seçã Galeria de imagens. Devem ser infrmadas as

49 45 imagens, e qual delas é a ft principal. Grades* Array de Grades Neste camp fica a array cm as grades d prdut. Estas grades sã cadastradas previamente. Cnsulte a seçã Grades de prduts para mais infrmações sbre grades e pções. Variaces* Array de Variaces Neste camp fica a array cm as variações d prdut. Um prdut variad pssui uma dentre as diversas pções de uma grade. (Ex.: Grade: Cr, Opções: Pret, Branc e Azul. Prdut: Tênis Infantil, Variaçã 1: Tênis Infantil Pret, Variaçã 2: Tênis Infantil Branc). Camps: Id: É identificadr da variaçã n banc de dads. Nme: É nme u descriçã da variaçã. (Ex.: Tênis Azul 41). URL: Este camp é a URL amigável desta variaçã na lja virtual. Fts: Neste camp fica a array cm as fts da variaçã. Precs: Aqui é infrmada uma array cm a definiçã de preçs. Preçs d prdut base serã replicads para as suas variações. Prec: Neste camp é infrmad preç padrã da variaçã. Frmat: É frmat da embalagem da variaçã d prdut quand fr despachad. Esta infrmaçã é usada pels crreis para realizar cálcul de frete. As infrmações válidas sã: 1: Frmat caixa/pacte 2: Frmat rl/prisma 3: Envelpe

50 46 Pes: Infrme aqui, em quilgramas, pes brut da embalagem de envi da variaçã. Cmpriment: Infrme aqui, em centímetrs, cmpriment da embalagem de envi da variaçã. Altura: Infrme aqui, em centímetrs, a altura da embalagem de envi da variaçã. Largura: Infrme aqui, em centímetrs, a largura da embalagem de envi da variaçã. Diametr: Infrme aqui, em centímetrs, diâmetr da embalagem de envi da variaçã. Quantidade: Aqui deve ser infrmada a quantidade em estque desta variaçã d prdut. Ativ: Indica se a variaçã está ativa u nã. SKU: Infrme códig únic da variaçã que está send manipulada. IdPrdutBase: O identificadr d prdut base desta variaçã. Caracteristicas: Aqui é infrmada uma array cm a definiçã de valres para as características da variaçã. ValresGrade: Este camp deve infrmar a pçã de grade para esta variaçã e a rdem desta. Cnsulte a seçã Grades de prduts para mais infrmações sbre grades e pções de grade. Camps: Valr: A pçã de grade atribuída a esta variaçã. Ordem: Um inteir que irá ditar a rdenaçã da exibiçã das variações na lja virtual. * Camps usads smente pr prduts cm variaçã.

51 47 Cadastr de lista de prduts Para cadastrar uma lista de prduts devem ser seguids s seguintes passs. É pssível cadastrar uma lista de prduts simples e cm variações, desde que sejam seguidas as mesmas instruções infrmadas n tópic anterir. URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/prduts/lista/salvar Métd: POST Parâmetrs: prduts, sbrescreverfts e atualizarapenasdadsinfrmads, inativarprdutsfradalista O parâmetr sbrescreverfts indica se sistema irá sbrescrever as fts existentes pel que está send enviad n prdut u se serã smadas as fts já existentes n prdut que está send salv. O valr padrã neste parâmetr é N cas nã seja infrmad. Infrme S para indicar que as fts serã sbrescritas pelas enviadas. Infrme N para indicar que as fts enviadas serã acrescentadas às fts já existentes n prdut. O parâmetr atualizarapenasdadsinfrmads indica a sistema se s dads devem ser atualizads cm exatamente s dads enviads inclusive se frem enviads dads em branc u se se serã atualizads apenas s dads que fram infrmads, u seja, que estiver em branc nã será atualizad. O valr padrã neste parâmetr é S cas nã seja infrmad. Infrme S para indicar que devem ser atualizads apenas s camps que fram infrmads. Infrme N para indicar que tds s camps serã alterads independentemente de nã serem infrmads, u infrmads em branc. O parâmetr inativarprdutsfradalista indica a sistema se s prduts que nã estiverem cntids na lista a ser salva devem ser inativads. O valr padrã neste parâmetr é N cas nã seja infrmad. Infrme S para indicar que devem ser inativads tds s prduts fra da lista passada para métd. Infrme N para indicar que s prduts fra da lista passada para métd nã serã inativads.

52 48 Exempl de cnsum

53 49

54 50

55 51 Retrn: Uma lista d bjet ResultadPrdutDTO que cntém s camps IdPrdutLjaVirtual, SKU e s camps Situaca e MensagemErr para identificar quais prduts fram inserids crretamente e quais nã. Alteraçã de estque de prduts pr id Para alterar a quantidade de estque de um prdut utilizand seu id devem ser seguids s passs descrits abaix. URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/prduts/estque/{idprdut} Métd: POST Parâmetr: idprdut e quantidade Exempl de cnsum

56 52 Retrn: nenhum Descriminaçã ds camps Camp Especificaçã Descriçã idprdut String Infrme aqui identificadr d prdut que terá seu estque atualizad. quantidade Int Infrme aqui a nva quantidade de estque d prdut. Alteraçã de estque de prduts pr SKU Para alterar a quantidade de estque de um prdut utilizand seu SKU devem ser seguids s passs descrits abaix. URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/prduts/estque Métd: POST Parâmetr: sku e quantidade Exempl de cnsum Retrn: nenhum Descriminaçã ds camps Camp Especificaçã Descriçã

57 53 sku String Infrme aqui identificadr d prdut que terá seu estque atualizad. quantidade Int Infrme aqui a nva quantidade de estque d prdut. Inativaçã de prduts pr id Para inativar um prdut utilizand seu id devem ser seguids s passs descrits abaix. URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/prduts/inativar/{idprdut} Métd: GET Parâmetr: idprdut Exempl de cnsum Retrn: nenhum Descriminaçã ds camps Camp Especificaçã Descriçã idprdut String Infrme aqui identificadr d prdut que será inativad. Inativaçã de prduts pr SKU Para Inativar um prdut utilizand seu SKU devem ser seguids s passs descrits abaix.

58 54 URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/prduts/inativar Métd: POST Parâmetr: sku Exempl de cnsum Retrn: nenhum Descriminaçã ds camps Camp Especificaçã Descriçã sku String Infrme aqui códig SKU d prdut que será inativad. Reativaçã de prduts pr id Para reativar um prdut utilizand seu id devem ser seguids s passs descrits abaix. URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/prduts/reativar/{idprdut} Métd: GET Parâmetr: idprdut Exempl de cnsum

59 55 Retrn: nenhum Descriminaçã ds camps Camp Especificaçã Descriçã idprdut String Infrme aqui identificadr d prdut que será reativad. Reativaçã de prduts pr SKU Para alterar a quantidade de estque de um prdut devem ser seguids s passs descrits abaix. URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/prduts/reativar Métd: POST Parâmetr: sku Exempl de cnsum Retrn: nenhum Descriminaçã ds camps Camp Especificaçã Descriçã sku String Infrme aqui códig SKU d prdut que será reativad.

60 56 Exclusã de prduts pr id Para excluir um prdut utilizand seu id devem ser seguids s passs descrits abaix. É imprtante saber que só é pssível excluir prduts que ainda nã estejam em itens de pedids existentes, cas cntrári, nã é pssível excluir prduts, pis iss geraria incnsistência ds dads. Neste cas, se quiser que prdut nã apareça mais em sua lja virtual mdifique seu status para Inativ. Cuidad a usar este recurs vist que prdut é um cadastr cmplex d sistema e sua exclusã remve ds destaques em que está inserid. URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/prduts/excluir/{idprdut} Métd: GET Parâmetr: idprdut Exempl de cnsum Retrn: nenhum Descriminaçã ds camps Camp Especificaçã Descriçã idprdut String Infrme aqui identificadr d prdut que será remvid da base de dads da lja virtual. Exclusã de prduts pr SKU Para excluir um prdut utilizand seu SKU devem ser seguids s passs descrits abaix. É imprtante saber que só é pssível excluir prduts que ainda nã estejam em itens de pedids existentes, cas cntrári, nã é pssível excluir prduts, pis iss geraria incnsistência ds dads. Neste cas,

61 57 se quiser que prdut nã apareça mais em sua lja virtual mdifique seu status para Inativ. Cuidad a usar este recurs vist que prdut é um cadastr cmplex d sistema e sua exclusã remve ds destaques em que está inserid. URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/prduts/excluir Métd: POST Parâmetr: sku Exempl de cnsum Retrn: nenhum Descriminaçã ds camps Camp Especificaçã Descriçã sku String Infrme aqui códig SKU d prdut que será remvid da base de dads da lja virtual. Cnsulta de prdut pr id Cas seja necessári, é pssível bter cadastr de um prdut existente através d seu id. Para fazer iss, segui s passs descrits abaix: URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/prduts/bter/{idprdut} Métd: GET

62 58 Parâmetr: idprdut Exempl de cnsum Retrn:

63 59 Descriminaçã ds camps Camp Especificaçã Descriçã Ativ Bl Indica se prdut está ativ u nã. Id Int Identificadr d prdut n banc de dads da lja virtual. (Ex: 5). Nme String Nme d prdut n banc de dads da lja virtual.

64 60 Descrica String Descriçã detalhada d prdut. SKU String Códig únic d prdut. URL Frmat String Int Categria Cntrat de Categria A categria d prdut. Este camp é a URL amigável d prdut na lja virtual. Ela é usada para melhrar a indexaçã da lja virtual em mecanisms de busca (Ggle, Bing, etc) É frmat da embalagem d prdut quand fr despachad. Esta infrmaçã é usada pels crreis para realizar cálcul de frete. As infrmações válidas sã: 1: Frmat caixa/pacte 2: Frmat rl/prisma 3: Envelpe Altura Decimal A altura da embalagem de envi d prdut, em centímetrs. Largura Decimal A largura da embalagem de envi d prdut, em centímetrs. Cmpriment Decimal O cmpriment da embalagem de envi d prdut, em centímetrs. Diametr Decimal O diâmetr da embalagem de envi d prdut, em centímetrs. Pes flat O pes brut da embalagem de envi d prdut, em quilgramas. Prec Decimal Neste camp é infrmad preç padrã d prdut. Quantidade Int A quantidade em estque d prdut. Precs Caracteristicas Array de Precs Array de Características Aarray cm a definiçã de preçs. Em cada bjet estará infrmad Id d preç, a tabela de preçs vinculada neste preç e valr d prdut neste víncul. Array cm a definiçã de valres para as características d prdut. Em cada bjet há infrmad Id da definiçã da característica, a característica vinculada neste vincul e valr, u descriçã, que

65 61 Fts Integrad Array de Fts Bl prdut pssui para esta característica. Array cm as fts d prdut. Cada bjet pssui Id da ft, nme d arquiv e a URL para acess via HTTP. Indica se prdut fi cadastrad pela integraçã. Os prduts integrads só pderã ser excluíds através de integraçã durante períd em que a integraçã estiver habilitada. Grades* Array de Grades Neste camp fica a array cm as grades d prdut. Estas grades sã cadastradas previamente. Cnsulte a seçã Grades de prduts para mais infrmações sbre grades e pções. Variaces* Array de Variaces Neste camp fica a array cm as variações d prdut. Um prdut variad pssui uma dentre as diversas pções de uma grade. (Ex.: Grade: Cr, Opções: Pret, Branc e Azul. Prdut: Tênis Infantil, Variaçã 1: Tênis Infantil Pret, Variaçã 2: Tênis Infantil Branc). Camps: Id: É identificadr da variaçã n banc de dads. Nme: É nme u descriçã da variaçã. (Ex.: Tênis Azul 41). URL: Este camp é a URL amigável desta variaçã na lja virtual. Fts: Neste camp fica a array cm as fts da variaçã. Precs: Aqui é infrmada uma array cm a definiçã de preçs. Preçs d prdut base serã replicads para as suas variações. Prec: Neste camp é infrmad preç padrã da variaçã. Frmat: É frmat da embalagem da variaçã d

66 62 prdut quand fr despachad. Esta infrmaçã é usada pels crreis para realizar cálcul de frete. As infrmações válidas sã: 1: Frmat caixa/pacte 2: Frmat rl/prisma 3: Envelpe Pes: Infrme aqui, em quilgramas, pes brut da embalagem de envi da variaçã. Cmpriment: Infrme aqui, em centímetrs, cmpriment da embalagem de envi da variaçã. Altura: Infrme aqui, em centímetrs, a altura da embalagem de envi da variaçã. Largura: Infrme aqui, em centímetrs, a largura da embalagem de envi da variaçã. Diametr: Infrme aqui, em centímetrs, diâmetr da embalagem de envi da variaçã. Quantidade: Aqui deve ser infrmada a quantidade em estque desta variaçã d prdut. Ativ: Indica se a variaçã está ativa u nã. SKU: Infrme códig únic da variaçã que está send manipulada. IdPrdutBase: O identificadr d prdut base desta variaçã. Caracteristicas: Aqui é infrmada uma array cm a definiçã de valres para as características da variaçã. ValresGrade: Este camp deve infrmar a pçã de grade para esta variaçã e a rdem desta. Cnsulte a seçã Grades de prduts para mais infrmações sbre grades e pções de grade. Camps:

67 63 Valr: A pçã de grade atribuída a esta variaçã. Ordem: Um inteir que irá ditar a rdenaçã da exibiçã das variações na lja virtual. * Camps usads smente pr prduts cm variaçã. Cnsulta de prdut pr SKU Cas seja necessári, é pssível bter cadastr de um prdut existente através d seu códig SKU. Para fazer iss, segui s passs descrits abaix: URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/prduts/bter Métd: POST Parâmetr: sku Exempl de cnsum Retrn:

68 64

69 65 Descriminaçã ds camps Camp Especificaçã Descriçã Ativ Bl Indica se prdut está ativ u nã. Id Int Identificadr d prdut n banc de dads da lja virtual. (Ex: 5). Nme String Nme d prdut n banc de dads da lja virtual.

70 66 Descrica String Descriçã detalhada d prdut. SKU String Códig únic d prdut. URL Frmat String Int Categria Cntrat de Categria A categria d prdut. Este camp é a URL amigável d prdut na lja virtual. Ela é usada para melhrar a indexaçã da lja virtual em mecanisms de busca (Ggle, Bing, etc) É frmat da embalagem d prdut quand fr despachad. Esta infrmaçã é usada pels crreis para realizar cálcul de frete. As infrmações válidas sã: 1: Frmat caixa/pacte 2: Frmat rl/prisma 3: Envelpe Altura Decimal A altura da embalagem de envi d prdut, em centímetrs. Largura Decimal A largura da embalagem de envi d prdut, em centímetrs. Cmpriment Decimal O cmpriment da embalagem de envi d prdut, em centímetrs. Diametr Decimal O diâmetr da embalagem de envi d prdut, em centímetrs. Pes flat O pes brut da embalagem de envi d prdut, em quilgramas. Prec Decimal Neste camp é infrmad preç padrã d prdut. Quantidade Int A quantidade em estque d prdut. Precs Caracteristicas Array de Precs Array de Características Aarray cm a definiçã de preçs. Em cada bjet estará infrmad Id d preç, a tabela de preçs vinculada neste preç e valr d prdut neste víncul. Array cm a definiçã de valres para as características d prdut. Em cada bjet há infrmad Id da definiçã da característica, a característica vinculada neste vincul e valr, u descriçã, que

71 67 Fts Integrad Array de Fts Bl prdut pssui para esta característica. Array cm as fts d prdut. Cada bjet pssui Id da ft, nme d arquiv e a URL para acess via HTTP. Indica se prdut fi cadastrad pela integraçã. Os prduts integrads só pderã ser excluíds através de integraçã durante períd em que a integraçã estiver habilitada. Grades* Array de Grades Neste camp fica a array cm as grades d prdut. Estas grades sã cadastradas previamente. Cnsulte a seçã Grades de prduts para mais infrmações sbre grades e pções. Variaces* Array de Variaces Neste camp fica a array cm as variações d prdut. Um prdut variad pssui uma dentre as diversas pções de uma grade. (Ex.: Grade: Cr, Opções: Pret, Branc e Azul. Prdut: Tênis Infantil, Variaçã 1: Tênis Infantil Pret, Variaçã 2: Tênis Infantil Branc). Camps: Id: É identificadr da variaçã n banc de dads. Nme: É nme u descriçã da variaçã. (Ex.: Tênis Azul 41). URL: Este camp é a URL amigável desta variaçã na lja virtual. Fts: Neste camp fica a array cm as fts da variaçã. Precs: Aqui é infrmada uma array cm a definiçã de preçs. Preçs d prdut base serã replicads para as suas variações. Prec: Neste camp é infrmad preç padrã da variaçã. Frmat: É frmat da embalagem da variaçã d

72 68 prdut quand fr despachad. Esta infrmaçã é usada pels crreis para realizar cálcul de frete. As infrmações válidas sã: 1: Frmat caixa/pacte 2: Frmat rl/prisma 3: Envelpe Pes: Infrme aqui, em quilgramas, pes brut da embalagem de envi da variaçã. Cmpriment: Infrme aqui, em centímetrs, cmpriment da embalagem de envi da variaçã. Altura: Infrme aqui, em centímetrs, a altura da embalagem de envi da variaçã. Largura: Infrme aqui, em centímetrs, a largura da embalagem de envi da variaçã. Diametr: Infrme aqui, em centímetrs, diâmetr da embalagem de envi da variaçã. Quantidade: Aqui deve ser infrmada a quantidade em estque desta variaçã d prdut. Ativ: Indica se a variaçã está ativa u nã. SKU: Infrme códig únic da variaçã que está send manipulada. IdPrdutBase: O identificadr d prdut base desta variaçã. Caracteristicas: Aqui é infrmada uma array cm a definiçã de valres para as características da variaçã. ValresGrade: Este camp deve infrmar a pçã de grade para esta variaçã e a rdem desta. Cnsulte a seçã Grades de prduts para mais infrmações sbre grades e pções de grade. Camps:

73 69 Valr: A pçã de grade atribuída a esta variaçã. Ordem: Um inteir que irá ditar a rdenaçã da exibiçã das variações na lja virtual. * Camps usads smente pr prduts cm variaçã.

74 70 8. Variações Variações sã prduts pr definiçã. Sã prduts cm pções diferentes de uma grade de prduts. Pr exempl, um prdut Camiseta que pssui uma grade cr, teria as variações: Camiseta Azul e Camiseta Branca. Cadastr de variações Para cadastrar uma variaçã devem ser seguids s passs abaix. URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/prduts /salvarvariaca Métd: POST Parâmetr: variaca Exempl de cnsum

75 71

76 72 Retrn: O id da variaçã cadastrada u atualizada, cas a prpriedade Id tenha sid enviada cm valr diferente de 0. Descriminaçã ds camps Camp Especificaçã Descriçã Ativ Bl Indica se variaçã (prdut) está ativa u nã.

77 73 Id Int Infrme 0 para cadastrar uma nva variaçã, u Id da variaçã que deseja atualizar cadastr. (Ex: 5). Nme String Nme d prdut n banc de dads da lja virtual. SKU String Códig únic d prdut. URL String Este camp é a URL amigável d prdut na lja virtual. Ela é usada para melhrar a indexaçã da lja virtual em mecanisms de busca (Ggle, Bing, etc) Frmat Int É frmat da embalagem d prdut quand fr despachad. Esta infrmaçã é usada pels crreis para realizar cálcul de frete. As infrmações válidas sã: 1: Frmat caixa/pacte 2: Frmat rl/prisma 3: Envelpe Altura Decimal A altura da embalagem de envi d prdut, em centímetrs. Largura Decimal A largura da embalagem de envi d prdut, em centímetrs. Cmpriment Decimal O cmpriment da embalagem de envi d prdut, em centímetrs. Diametr Decimal O diâmetr da embalagem de envi d prdut, em centímetrs. Pes flat O pes brut da embalagem de envi d prdut, em quilgramas. Prec Decimal Neste camp é infrmad preç padrã d prdut. Quantidade Int A quantidade em estque d prdut. Precs Array de Precs Aarray cm a definiçã de preçs. Em cada bjet estará infrmad Id d preç, a tabela de preçs vinculada neste preç e valr d prdut neste víncul. Caracteristicas Array de Características Array cm a definiçã de valres para as características d prdut. Em cada bjet há infrmad Id da definiçã da característica, a

78 74 característica vinculada neste vincul e valr, u descriçã, que prdut pssui para esta característica. Fts Array de Fts Array cm as fts d prdut. Cada bjet pssui Id da ft, nme d arquiv e a URL para acess via HTTP. IdPrdutBase Int O identificadr d prdut base desta variaçã. ValresGrade Array de PrdutOpcaGrade Array cm as pções de grades atreladas a prdut base. Camps: Valr: A pçã de grade atribuída a esta variaçã. Ordem: Um inteir que irá ditar a rdenaçã da exibiçã das variações na lja virtual. Exclusã de variações Para excluir uma variaçã devem ser seguids s passs abaix. Para que uma variaçã pssa ser excluída ela nã deve pssuir vendas. URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/prduts/excluirvariaca/{id} Métd: GET Parâmetr: id Exempl de cnsum Retrn: nenhum Descriminaçã ds camps

79 75 Camp Especificaçã Descriçã Id Int É identificadr da variaçã que será remvida da base de dads da lja virtual. Cnsultar variaçã pr id Este recurs serve para que seja btida a variaçã de um prdut através d identificadr desta. URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/prduts/cnsultarvariaca/{id} Métd: GET Parâmetr: Exempl de cnsum Retrn: a variaçã cadastrada n seu banc de dads. Descriminaçã ds camps Camp Especificaçã Descriçã Id Int É identificadr da variaçã que será remvida da base de dads da lja virtual. Exempl de retrn

80 76

81 77

82 78 9. Grups Os grups de clientes servem para permitir que s clientes sejam separads através d critéri d usuári da platafrma. Eles pssuem um títul e uma descriçã. N cadastr de clientes é pssível infrmar à quais grups um cliente pertence. Psterirmente, usuári da administraçã pderá exprtar cadastr de s de apenas um grup de cliente, se desejar. Cadastr de grups Para cadastrar um grup devem ser seguids s passs abaix. URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/grups/salvar Métd: POST Parâmetr: grup Exempl de cnsum Retrn: O id d grup cadastrad u atualizad, cas a prpriedade Id tenha sid enviada cm valr diferente de 0. Descriminaçã ds camps Camp Especificaçã Descriçã

83 79 Id Int Infrme 0 para cadastrar um nv grup, u Id d grup que deseja atualizar cadastr. (Ex: 5). Titul String É títul d grup que está send manipulad. Descrica String Infrme a descriçã d grup que está manipuland. Exclusã de grups Para excluir um grup devem ser seguids s passs abaix. Fique atent a usar este recurs, pis a exclusã de um grup fará cm que sua vinculaçã cm clientes deixe de existir. URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/grups/excluir/{id} Métd: GET Parâmetr: id Exempl de cnsum Retrn: nenhum Descriminaçã ds camps Camp Especificaçã Descriçã Id Int É identificadr d grup que será remvid da base de dads da lja virtual.

84 80 Listagem de grups Este recurs serve para que seja btida a listagem de grups cadastrads na lja virtual. Seu bjetiv é permitir que cas cliente já esteja perand a lja virtual sem integraçã, n mment de iniciar us da integraçã, pssa vincular s grups já existentes em sua lja cm entidades crrespndentes n sistema de retaguarda, evitand duplicidade de infrmações. URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/grups/listar Métd: GET Parâmetr: Exempl de cnsum Retrn: a listagem de tds s grups cadastrads n seu banc de dads. Descriminaçã ds camps Camp Especificaçã Descriçã Id Int Infrme 0 para cadastrar um nv grup, u Id d grup que deseja atualizar cadastr. (Ex: 5). Titul String É títul d grup que está send manipulad. Descrica String Infrme a descriçã d grup que está manipuland. Exempl de retrn

85 81

86 Clientes Este recurs permite que sejam cadastrads e mantids clientes na base de dads de sua lja virtual. Este recurs serve para que sejam exprtads para a lja virtual a sua carteira de clientes d sistema de retaguarda, cas deseje, além de também imprtar da lja virtual s clientes cadastrads apenas em sua base de dads e ainda nã existentes na base de dads d sistema de retaguarda. Cadastr de clientes Para cadastrar um cliente devem ser seguids s passs abaix. URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/clientes/salvar Métd: POST Parâmetr: cliente Exempl de cnsum

87 83 Retrn: O id d cliente cadastrad u atualizad, cas a prpriedade Id tenha sid enviada cm valr diferente de 0. Descriminaçã ds camps Camp Especificaçã Descriçã Id Int Infrme 0 para cadastrar um nv cliente, u Id d cliente que deseja atualizar cadastr. (Ex: 5). Nme String É nme d cliente que está send manipulad. Apelid String O camp que infrma cm cliente deseja ser chamad. Tip RG_IE Int String Este camp indica se cliente é pessa física u pessa jurídica. As pções válidas sã: 0: Para pessa física 1: Para pessa jurídica Neste camp deve ser infrmad RG d cliente cas seja pessa física, u a Inscriçã Estadual n cas d cliente ser pessa jurídica.

88 84 CPF_CNPJ Sex String String Representa CPF n cas d cliente ser pessa física, e n cas dele ser uma pessa jurídica representa CNPJ. Para clientes que sã pessa física deve ser infrmad Masculin u Feminin. Celular String É camp que cntem númer d celular de cntat d cliente. TelefneFix1 TelefneFix2 DataNasciment String String String Camp cm númer de um telefne fix primári de cntat cm cliente. Infrma númer d telefne fix secundári de cntat cm cliente. Data de nasciment d cliente cas seja pessa física, u de fundaçã da empresa n cas de cliente ser pessa jurídica. O frmat para este camp é DD/MM/YYYY (Ex.: 01/01/2020). String d cliente que será usad para acessar sua cnta. Senha ReceberOfertas Enderecs Grups Ativ String Bl Array de Enderec Array de Grup Bl Senha que cliente usará n acess de sua cnta na lja virtual (Ex.: ) Indica se cliente deseja receber u nã s de campanhas de marketing da lja virtual. Infrme true para indicar que cliente deseja receber fertas em seu , u false para indicar que nã deseja recebe-ls. Um array cm tds s endereçs d cliente. Aqui devem ser infrmads tds s endereçs d cliente. Os camps d endereç estã descrits n próxim tópic deste manual. Infrma a quais grups de clientes este cliente pertence. É enviad uma array cm s grups, neles pde ser infrmada apenas a prpriedade Id u tdas as utras prpriedades. Indica se cliente está ativ u nã. Infrme true para clientes ativs e false para clientes inativs. Clientes cadastrads inativs serã

89 85 ntificads pr . Cadastr de endereçs de clientes Para cadastrar nvs endereçs n cadastr de clientes já existentes na base de dads da lja virtual devem ser seguids s seguintes passs. Lembrese que cliente deve existir na base de dads da lja virtual. URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/clientes/enderec/salvar/{idcliente} Métd: POST Parâmetr: enderec e idcliente Exempl de cnsum

90 86 Retrn: Id d nv endereç u d endereç atualizad, cas parâmetr Id tenha sid infrmad cm um valr diferente de 0. Descriminaçã ds camps Camp Especificaçã Descriçã Id Int É identificadr d endereç que será atualizad. Se estiver cadastrand um nv endereç infrme 0.

91 87 Descrica String O nme, u descriçã, d endereç d cliente (Ex.: Minha cassa, Trabalh, Casa da sgra, etc) CEP String CEP d endereç. O frmat deste camp é Bairr String Nme d bairr d endereç que está send manipulad. Neste camp é infrmada a cidade d endereç que está send infrmad. Cidade Estad Cntrat de Cidade Cntrat de Estad Camps Nme: é nme da cidade d endereç. CdigIBGE: é códig da cidade n IBGE. * ambs s camps sã brigatóris. Aqui fica a infrmaçã d estad d endereç manipulad. Camps Nme: é nme d estad d endereç. Sigla: é a Unidade Federativa d estad (Ex.: SP). CdigIBGE: O códig d estad n IBGE. Este camp é pcinal. AliqutaICMSInterna: Alíquta de ICMS interna d estad. Camp pcinal e mais usad n retrn de endereçs. Infrma qual país d endereç que está send infrmad. Pais Cntrat de País Camps Nme: é nme d país d endereç. NmeCmplet: é nme cmplet d país. Este camp é pcinal. CdBACEN: Códig d país n banc central. Este camp é pcinal.

92 88 Sigla: é a sigla resumida d país (Ex.: BR). SiglaCmpleta: é a sigla cmpleta d país (Ex.: BRA). CdigArea: O códig de área d país (Ex.: 55). Este camp é pcinal. Tip String O tip de lgradur d endereç (Ex.: Rua, Vila, Praça, Avenida). Lgradur String Lgradur d endereç sem tip já infrmad. Cmplement String Cas haja, infrma cmplement d endereç (Ex.: Casa A, Apt 305, etc). Numer String O númer d endereç (Ex.: 195, 47A). Referencia String Pnt de referência d endereç manipulad (Ex.: Em frente à sede da Alterdata). Cnsulta de cliente pr id Este recurs serve para bter as infrmações de um cliente específic através d seu identificadr na base de dads da lja virtual. URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/clientes/bter/{idcliente} Métd: GET Parâmetr: idcliente Exempl de cnsum Retrn: as infrmações d cliente cm identificadr na base de dads da lja virtual infrmad n cnsum d webservice. Descriminaçã ds camps

93 89 Camp Especificaçã Descriçã Id Int Identificadr d cliente na base de dads. Nme String É nme d cliente. Apelid String Infrma cm cliente deseja ser chamad. Tip RG_IE CPF_CNPJ Sex Int String String String Indica se cliente é pessa física u pessa jurídica. As pções que pdem ser retrnadas sã: 0: Para pessa física 1: Para pessa jurídica RG d cliente cas seja pessa física, u a Inscriçã Estadual n cas d cliente ser pessa jurídica. CPF n cas d cliente ser pessa física, e n cas dele ser uma pessa jurídica representa CNPJ. Para clientes que sã pessa física. Retrna Masculin u Feminin. Celular String Númer d celular de cntat d cliente. TelefneFix1 String Númer de um telefne fix primári de cntat cm cliente. TelefneFix2 String Númer d telefne fix secundári de cntat cm cliente. DataNasciment String Data de nasciment d cliente cas seja pessa física, u de fundaçã da empresa n cas de cliente ser pessa jurídica. O frmat deste camp é DD/MM/YYYY (Ex.: 01/01/2020). String d cliente que usad para acessar sua cnta. Senha String Esta infrmaçã é retrnada em branc. ReceberOfertas Bl Indica se cliente aceita u nã receber fertas em seu . Enderecs Array de Enderec Um array cm tds s endereçs d cliente.

94 90 Camps Id: É identificadr d endereç n banc de dads. Descrica: O nme, u descriçã, d endereç d cliente (Ex.: Minha cassa, Trabalh, Casa da sgra, etc) CEP: CEP d endereç n frmat Bairr: Nme d bairr d endereç. Cidade Nme: é nme da cidade d endereç. CdigIBGE: é códig da cidade n IBGE. Estad Nme: é nme d estad d endereç. Sigla: é a Unidade Federativa d estad (Ex.: SP). CdigIBGE: O códig d estad n IBGE. AliqutaICMSInterna: Alíquta de ICMS interna d estad. Pais Nme: é nme d país d endereç. NmeCmplet: é nme cmplet d país. CdBACEN: Códig d país n banc central. Sigla: é a sigla resumida d país (Ex.: BR). SiglaCmpleta: é a sigla cmpleta d país (Ex.: BRA). CdigArea: O códig de área d país (Ex.: 55). Tip: O tip de lgradur d endereç (Ex.: Rua, Vila, Praça, Avenida). Lgradur: Lgradur d endereç sem tip já infrmad. Cmplement: Cmplement d endereç (Ex.: Casa A, Apt 305, etc).

95 91 Grups Ativ Array de Grup Bl Numer: O númer d endereç (Ex.: 195, 47A). Referencia: Pnt de referência d endereç (Ex.: Em frente à sede da Alterdata). Infrma a quais grups de clientes este cliente pertence. Camps Id: É identificadr d grup n banc de dads. Titul: O títul, u nme, d grup de clientes. Descrica: A descriçã detalhada d grup. Indica se cliente está ativ u nã. Infrme true para clientes ativs e false para clientes inativs. Exempl de retrn

96 92

97 93 Cnsulta de clientes pr filtr Este recurs serve para bter a listagem de clientes na base de dads da lja através de uma filtragem ds principais dads de cliente. URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/clientes/cnsultar Métd: POST Parâmetr: filtr Exempl de cnsum Retrn: a listagem de clientes cadastrads na base de dads da lja virtual baseada ns filtrs infrmads.

98 94 Descriminaçã ds camps Camp Especificaçã Descriçã Id Int Identificadr d cliente na base de dads. Nme String É nme d cliente. Apelid String Infrma cm cliente deseja ser chamad. Tip RG_IE CPF_CNPJ Sex Int String String String Indica se cliente é pessa física u pessa jurídica. As pções que pdem ser retrnadas sã: 0: Para pessa física 1: Para pessa jurídica RG d cliente cas seja pessa física, u a Inscriçã Estadual n cas d cliente ser pessa jurídica. CPF n cas d cliente ser pessa física, e n cas dele ser uma pessa jurídica representa CNPJ. Para clientes que sã pessa física. Retrna Masculin u Feminin. Celular String Númer d celular de cntat d cliente. TelefneFix1 String Númer de um telefne fix primári de cntat cm cliente. TelefneFix2 String Númer d telefne fix secundári de cntat cm cliente. DataNasciment String Data de nasciment d cliente cas seja pessa física, u de fundaçã da empresa n cas de cliente ser pessa jurídica. O frmat deste camp é DD/MM/YYYY (Ex.: 01/01/2020). String d cliente que usad para acessar sua cnta. Senha String Esta infrmaçã é retrnada em branc. ReceberOfertas Bl Indica se cliente aceita u nã receber fertas em seu .

99 95 Um array cm tds s endereçs d cliente. Enderecs Array de Enderec Camps Id: É identificadr d endereç n banc de dads. Descrica: O nme, u descriçã, d endereç d cliente (Ex.: Minha cassa, Trabalh, Casa da sgra, etc) CEP: CEP d endereç n frmat Bairr: Nme d bairr d endereç. Cidade Nme: é nme da cidade d endereç. CdigIBGE: é códig da cidade n IBGE. Estad Nme: é nme d estad d endereç. Sigla: é a Unidade Federativa d estad (Ex.: SP). CdigIBGE: O códig d estad n IBGE. AliqutaICMSInterna: Alíquta de ICMS interna d estad. Pais Nme: é nme d país d endereç. NmeCmplet: é nme cmplet d país. CdBACEN: Códig d país n banc central. Sigla: é a sigla resumida d país (Ex.: BR). SiglaCmpleta: é a sigla cmpleta d país (Ex.: BRA). CdigArea: O códig de área d país (Ex.: 55). Tip: O tip de lgradur d endereç (Ex.: Rua, Vila, Praça, Avenida). Lgradur: Lgradur d endereç sem tip já infrmad.

100 96 Grups Ativ Array de Grup Bl Cmplement: Cmplement d endereç (Ex.: Casa A, Apt 305, etc). Numer: O númer d endereç (Ex.: 195, 47A). Referencia: Pnt de referência d endereç (Ex.: Em frente à sede da Alterdata). Infrma a quais grups de clientes este cliente pertence. Camps Id: É identificadr d grup n banc de dads. Titul: O títul, u nme, d grup de clientes. Descrica: A descriçã detalhada d grup. Indica se cliente está ativ u nã. Infrme true para clientes ativs e false para clientes inativs. Exempl de retrn

101 97

102 Etapas As etapas servem para permitir que andament ds pedids pssa ser custmizad pels usuáris da platafrma. O banc de dads tem etapas fixas que nã pdem ser excluídas, mas usuári da lja virtual pde incluir utras etapas entre as etapas padrões d andament d pedid cas deseje. As etapas pssuem um identificadr, descriçã, a etapa de referência e a psiçã relativa à etapa de referência, se antes u depis. Quand um pedid é gerad na lja virtual, ele irá criar seu andament de acrd cm as etapas cadastradas na lja virtual. Cadastr de etapas Para cadastrar uma etapa devem ser seguids s passs abaix. URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/etapas/salvar Métd: POST Parâmetr: etapa Exempl de cnsum

103 99 Retrn: O id da etapa cadastrada u atualizada, cas a prpriedade Id tenha sid enviada cm valr diferente de 0. Descriminaçã ds camps Camp Especificaçã Descriçã Id Int Descrica String Descriçã, u nme, da etapa. Referencia Psica Cntrat de Etapa Int Infrme 0 para cadastrar uma nva etapa, u Id da etapa que deseja atualizar cadastr. (Ex: 5). É a etapa de referência da etapa que está send manipulada. Pde ser infrmad cntrat da etapa cm s mesms camps infrmads aqui, u apenas camp Id que é únic brigatóri. Indica a psiçã da etapa cm relaçã a etapa de referência citada acima. Os valres válids sã: 0: para antes da etapa de referência 1: para depis da etapa de referência

104 100 Exclusã de etapas Para excluir uma etapa devem ser seguids s passs abaix. Fique atent a usar este recurs, pis a exclusã de uma etapa remve-a d andament de tds s pedids que a pssuírem. URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/etapas/excluir/{id} Métd: GET Parâmetr: id Exempl de cnsum Retrn: nenhum Descriminaçã ds camps Camp Especificaçã Descriçã Id Int É identificadr da etapa que será remvida da base de dads. Listagem de etapas Este recurs serve para que seja btida a listagem de etapas cadastradas na lja virtual. Seu bjetiv é permitir que cas cliente já esteja perand a lja virtual sem integraçã, n mment de iniciar us da integraçã, pssa vincular as etapas já existentes em sua lja cm entidades crrespndentes n sistema de retaguarda, evitand duplicidade de infrmações. URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/etapas/listar

105 101 Métd: GET Parâmetr: Exempl de cnsum Retrn: a listagem de tdas as etapas cadastradas n seu banc de dads. Descriminaçã ds camps Camp Especificaçã Descriçã Id Int É identificadr da etapa na base de dads da lja virtual. (Ex: 5). Descrica String Infrma a descriçã da etapa. Psica Referência Int Cntrat de Etapa Indica a psiçã da etapa cm relaçã à etapa de referência, se antes (0) u depis (1). É a etapa referente antes u depis, de acrd cm a psiçã, da etapa em questã. Exempl de retrn

106 102

107 103

108 Pedids O bjetiv d recurs de integraçã de pedids é permitir que usuári pssa visualizar s pedids da lja virtual em seu sistema de retaguarda. Além diss, usuári também pderá cancelar um pedid e mdificar seu andament através ds recurss de integraçã. Cnsulta de pedid pr id Este recurs serve para bter as infrmações de um pedid específic através d seu identificadr na base de dads da lja virtual. URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/pedids/obter/{idpedid} Métd: GET Parâmetr: idpedid Exempl de cnsum Retrn: as infrmações d pedid cm identificadr na base de dads da lja virtual infrmad n cnsum d webservice. Descriminaçã ds camps Camp Especificaçã Descriçã Id Int É identificadr d pedid na base de dads da lja virtual. Data String Data de realizaçã d pedid. Cancelad Bl Indica se pedid fi cancelad (true) u nã (false). AliqutaDescnt Decimal A alíquta de descnt aplicada n ttal d pedid. ValrDescnt Decimal O valr d descnt n ttal d pedid.

109 105 Status String Indica a descriçã da etapa atual d pedid. Subttal Decimal É a sma ds itens d pedid sem valr de frete. Ttal Decimal É a sma de td pedid. IdCliente Inteir É identificadr d cliente d pedid na base de dads da lja virtual. ArquivNtaXML String Este camp exibe nme d arquiv XML da NFe d pedid. Se estiver vazi significa que XML da NFe ainda nã fi enviad. ArquivNtaPDF Integrad String Bl Este camp exibe nme d arquiv PDF da NFe d pedid. Se estiver vazi significa que PDF da NFe ainda nã fi enviad. Indica se pedid está cm integraçã ativa. Quand um pedid nã está integrad, a lja virtual irá cnsiderar que a integraçã nã cnhece s pedids, e sempre que estque de um prdut fr mdificad, utilizará s itens de pedids nã integrads para abater a diferença de estque deste prdut. Sã as infrmações de pagament d pedid. Pagament Cntrat de Pagament Camps Id: É identificadr d pagament na base de dads da lja virtual. Servic: É códig d serviç de pagament usad. Os valres pssíveis sã: 1: Outrs, 100: PagSegur, 200: Braspag CdigTransaca: É códig da transaçã d serviç de pagament. Data: Indica a data d últim prcessament d pagament. Frma: Identifica códig d tip de pagament usad. As pções sã:

110 Outrs 2 - Cartã de crédit 3 Transferência eletrônica (TEF) 4 - Blet 5 - Depósit em cnta, 6 - Carteira eletrônica, 7 OiPagg, 8 Cartã de débit Mei: Identifica a frma de pagament usada. As pções válidas sã: 1 Outrs, 100 Visa, 101 MasterCard, 102 AmericanExpress, 103 Diners, 104 Hipercard, 105 Aura, 106 El, 107 Srcred, 108 Hiper, 109 Discver, 110 Cabal, 111 Siricredi, 112 CperCard, 113 Avista, 114 Mais, 115 UPI, 116 PLENOCard, 117 PersnalCard, 118 JCB, 119 BrasilCard,

111 FORTBRASIL, 121 CARDBAN, 122 VALECARD, 123 GRANDCARD, 124 Credz, 200 Bradesc, 201 Santander, 202 Itau, 203 Unibanc, 204 BancDBrasil, 205 BancReal, 206 Banrisul, 207 HSBC, 208 Brb (Banc de Brasília), 209 Caixa, 210 Citibank, Sald Detalhes: É um text cm um resum das infrmações de pagament. ValrBrut: Indica valr brut pag pel cliente n serviç de pagament. Descnts: Indica valr ds descnts cbrads pel serviç de pagament. ValrLiquid: Indica valr líquid que será recebid pel vendedr. Status: É um camp Int que armazena status atual d pagament. Parcelas: Indica em quantas parcelas pedid fi pag. Cas nã haja parcelament, este camp virá cm valr 1. InfrmacesExtras: Armazena infrmações adicinais

112 108 Andaments Array de andaments d pedid sbre pagament, cm a url d blet se a frma de pagament fi blet bancári. Aqui fica descriminad andament d pedid através das etapas. Camps: Data: data da última atualizaçã d andament. Etapa: cntrat da etapa a que se refere andament. Estad: é estad, u status, atual deste andament. Este camp d tip Inteir e pde assumir s seguintes valres: 1: NaIniciad 2: Iniciad 3: Aprvad 4: Negad Id: é identificadr d andament na base de dads da lja virtual. Aqui estã as infrmações referentes as endereçs de cbrança e de entrega d pedid. EnderecCbranca e EnderecEntrega Cntrat de Endereç Camps: Id: Identificadr d endereç na base de dads da lja virtual. Descrica: guarda nme que cliente usu para identificar endereç. CEP: armazena códig de CEP d endereç. Tip: indica tip de lgradur d endereç (Ex.: Rua, Avenida, Vila, etc) Lgradur: guarda nme d lgradur d endereç (Ex.: Dr. Jsé da Silva)

113 109 Númer: guarda númer d endereç (Ex.: 500) Cmplement: Infrma cmplement d endereç (Ex.: Casa B) Bairr: este camp armazena nme d bairr d endereç em questã. Cidade: infrma a cidade d endereç. CdigIBGE: Códig da cidade n IBGE Nme: Nme da cidade Estad: armazena estad d endereç. AliqutaICMSInterna: Indica a alíquta de ICMS interna d estad (Ex.: 19) CdigIBGE: Códig d estad n IBGE Nme: Nme d estad Sigla: Unidade federativa d estad (Ex.: RJ, SP, etc) Pais: indica país d endereç CdBACEN: Códig d país n Banc Central. CdigArea: Códig de área d país. Nme: Nme d país (Ex.: Brasil) NmeCmplet: Nme cmplet d país (Ex.: República Federativa d Brasil) Sigla: Sigla d país (Ex.: BR) SiglaCmpleta: Sigla cmpleta d país (Ex: BRA) Referencia: Pnt de referência d endereç (Ex.: Próxim à farmácia ppular) Infrma resum das infrmações de frete e entrega d pedid. Frete Cntrat de Frete Camps: Praz: Praz de entrega mais lng ds itens d pedid.

114 110 Servic: Indica serviç de frete selecinad pel cliente. Id: Identificadr d serviç de frete na base de dads da lja virtual Nme: Indica nme d serviç (Ex.: Sedex) Cdig: é códig d serviç para s crreis u transprtadra. Padra: Indica que serviç é padrã da lja virtual, u seja, nã pde ser mdificad u remvid. Obs: Cm dit, há serviçs de frete padrões na base de dads da lja virtual. Estes serviçs sã s descrits abaix: Nme: Encmenda nrmal (PAC) Id: 1 Nme: Sedex Id: 2 Nme: E-sedex Id: 3 Valr: Ttal ds fretes de cada um ds itens d pedid. Cntém as infrmações ds itens d pedid. Itens Array itens d pedid Camps: Id: identificadr d item na base de dads da lja virtual.

115 111 IdPrdut: indica identificadr d prdut deste item na base de dads. SkuPrdut: indica códig SKU d prdut deste item na base de dads. Quantidade: guarda a quantidade d prdut n item d pedid. ValrUnitari: armazena valr unitári d prdut n mment da cmpra. AliqutaDescnt: infrma a alíquta de descnt usada n item. ValrDescnt: infrma valr de descnt frnecid n item. ValrTtal: infrma valr ttal deste item d pedid (quantidade x valr unitári). Frete: Infrmações de frete d item. Os camps sã s mesms d frete d pedid cnfrme explicad anterirmente. Exempl de retrn

116 112

117 113

118 114

119 115

120 116

121 117

122 118

123 119 Listagem de pedids pr filtr Para listar s pedids pr filtrs devem ser seguids s passs abaix. URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/pedids/listarprfiltr Métd: POST Parâmetr: filtr Exempl de cnsum Retrn: A listagem ds pedids encntrads de acrd cm s filtrs infrmads. Descriminaçã ds camps Camp Especificaçã Descriçã PeridInici PeridFim String String Para bter apenas pedids após a data infrmada neste camp. O frmat é DD/MM/YYYY HH:MM:SS. Para bter apenas pedids antes da data infrmada neste camp. O frmat é DD/MM/YYYY HH:MM:SS. Status Int Para bter pedids pr status este camp e próxim devem estar

124 120 IdEtapa Int infrmads. Neste, é indicada a situaçã da etapa que será passada n próxim parâmetr. Os valres pssíveis sã: 0: para NaIniciad (Apenas pedids que a etapa nã iniciada mais recentemente seja a infrmada n próxim parâmetr). 1: para Iniciad (Apenas pedids que a etapa iniciada mais recentemente seja a infrmada n próxim parâmetr). 2: para Aprvad (Apenas pedids que a etapa aprvada mais recentemente seja a infrmada n próxim parâmetr). 3: para Negad (Apenas pedids que a etapa negada mais recentemente seja a infrmada n próxim parâmetr). O identificadr da etapa que servirá para filtr ds pedids cm cuja etapa mais recente d status infrmad anterirmente seja a etapa infrmada aqui. Pedids cancelads nã serã retrnads se este filtr fr utilizad. O status atual d pagament. Os valres pssíveis sã: StatusPagament Int 1: para Aguardand (Apenas pedids que aguardam pagament). 2: para EmAnalise (Apenas pedids que pssuem pagament sb análise). 3: para Cancelad (Apenas pedids que tiveram pagament cancelad). 4: para Pag(Apenas pedids que tiveram pagament aprvad). 5: para EmDisputa(Apenas pedids que pssuem pagament em disputa). 6: para Reemblsad(Apenas pedids que tiveram pagament reemblsad). 7: para Dispnivel(Apenas pedids que pssuem pagament

125 121 Integrad String cncluíd e dispnível). Cas seja enviad valr 0, a listagem irá ignrar este filtr. Se este camp fr enviad cm valr S irá retrnar smente pedids cm integraçã ativa, cas seja enviad cm N, retrnará pedids sem integraçã ativa, e cas nã seja infrmad nenhum destes valres a listagem irá ignrar este filtr. Exempl de retrn

126 122

127 123

128 124

129 125

130 126

131 127

132 128 Descriminaçã ds camps Camp Especificaçã Descriçã Id Int É identificadr d pedid na base de dads da lja virtual. Data String Data de realizaçã d pedid. Cancelad Bl Indica se pedid fi cancelad (true) u nã (false). AliqutaDescnt Decimal A alíquta de descnt aplicada n ttal d pedid. ValrDescnt Decimal O valr d descnt n ttal d pedid. Status String Indica a descriçã da etapa atual d pedid. Subttal Decimal É a sma ds itens d pedid sem valr de frete. Ttal Decimal É a sma de td pedid. IdCliente Inteir É identificadr d cliente d pedid na base de dads da lja virtual. ArquivNtaXML String Este camp exibe nme d arquiv XML da NFe d pedid. Se estiver vazi significa que XML da NFe ainda nã fi enviad. ArquivNtaPDF Integrad String Bl Este camp exibe nme d arquiv PDF da NFe d pedid. Se estiver vazi significa que PDF da NFe ainda nã fi enviad. Indica se pedid está cm integraçã ativa. Quand um pedid nã está integrad, a lja virtual irá cnsiderar que a integraçã nã cnhece s pedids, e sempre que estque de um prdut fr mdificad, utilizará s itens de pedids nã integrads para abater a diferença de estque deste prdut. Sã as infrmações de pagament d pedid. Pagament Cntrat de Pagament Camps Id: É identificadr d pagament na base de dads da lja virtual. Servic: É códig d serviç de pagament usad. Os valres pssíveis sã:

133 129 1: Outrs, 100: PagSegur, 200: Braspag CdigTransaca: É códig da transaçã d serviç de pagament. Data: Indica a data d últim prcessament d pagament. Frma: Identifica códig d tip de pagament usad. As pções sã: 1 - Outrs 2 - Cartã de crédit 3 Transferência eletrônica (TEF) 4 - Blet 5 - Depósit em cnta, 6 - Carteira eletrônica, 7 OiPagg, 8 Cartã de débit Mei: Identifica a frma de pagament usada. As pções válidas sã: 1 Outrs, 100 Visa, 101 MasterCard, 102 AmericanExpress, 103 Diners, 104 Hipercard, 105 Aura, 106 El, 107 Srcred, 108 Hiper, 109 Discver, 110 Cabal,

134 Siricredi, 112 CperCard, 113 Avista, 114 Mais, 115 UPI, 116 PLENOCard, 117 PersnalCard, 118 JCB, 119 BrasilCard, 120 FORTBRASIL, 121 CARDBAN, 122 VALECARD, 123 GRANDCARD, 124 Credz, 200 Bradesc, 201 Santander, 202 Itau, 203 Unibanc, 204 BancDBrasil, 205 BancReal, 206 Banrisul, 207 HSBC, 208 Brb (Banc de Brasília), 209 Caixa, 210 Citibank, Sald Detalhes: É um text cm um resum das infrmações de pagament. ValrBrut: Indica valr brut pag pel cliente n serviç de pagament. Descnts: Indica valr ds descnts cbrads

135 131 Andaments EnderecCbranca e EnderecEntrega Array de andaments d pedid Cntrat de Endereç pel serviç de pagament. ValrLiquid: Indica valr líquid que será recebid pel vendedr. Status: É um camp Int que armazena status atual d pagament. Parcelas: Indica em quantas parcelas pedid fi pag. Cas nã haja parcelament, este camp virá cm valr 1. InfrmacesExtras: Armazena infrmações adicinais sbre pagament, cm a url d blet se a frma de pagament fi blet bancári. Aqui fica descriminad andament d pedid através das etapas. Camps: Data: data da última atualizaçã d andament. Etapa: cntrat da etapa a que se refere andament. Estad: é estad, u status, atual deste andament. Este camp d tip Inteir e pde assumir s seguintes valres: 1: NaIniciad 2: Iniciad 3: Aprvad 4: Negad Id: é identificadr d andament na base de dads da lja virtual. Aqui estã as infrmações referentes as endereçs de cbrança e de entrega d pedid. Camps:

136 132 Id: Identificadr d endereç na base de dads da lja virtual. Descrica: guarda nme que cliente usu para identificar endereç. CEP: armazena códig de CEP d endereç. Tip: indica tip de lgradur d endereç (Ex.: Rua, Avenida, Vila, etc) Lgradur: guarda nme d lgradur d endereç (Ex.: Dr. Jsé da Silva) Númer: guarda númer d endereç (Ex.: 500) Cmplement: Infrma cmplement d endereç (Ex.: Casa B) Bairr: este camp armazena nme d bairr d endereç em questã. Cidade: infrma a cidade d endereç. CdigIBGE: Códig da cidade n IBGE Nme: Nme da cidade Estad: armazena estad d endereç. AliqutaICMSInterna: Indica a alíquta de ICMS interna d estad (Ex.: 19) CdigIBGE: Códig d estad n IBGE Nme: Nme d estad Sigla: Unidade federativa d estad (Ex.: RJ, SP, etc) Pais: indica país d endereç CdBACEN: Códig d país n Banc Central. CdigArea: Códig de área d país. Nme: Nme d país (Ex.: Brasil) NmeCmplet: Nme cmplet d país (Ex.: República Federativa d Brasil) Sigla: Sigla d país (Ex.: BR)

137 133 SiglaCmpleta: Sigla cmpleta d país (Ex: BRA) Referencia: Pnt de referência d endereç (Ex.: Próxim à farmácia ppular) Infrma resum das infrmações de frete e entrega d pedid. Frete Cntrat de Frete Camps: Praz: Praz de entrega mais lng ds itens d pedid. Servic: Indica serviç de frete selecinad pel cliente. Id: Identificadr d serviç de frete na base de dads da lja virtual Nme: Indica nme d serviç (Ex.: Sedex) Cdig: é códig d serviç para s crreis u transprtadra. Padra: Indica que serviç é padrã da lja virtual, u seja, nã pde ser mdificad u remvid. Obs: Cm dit, há serviçs de frete padrões na base de dads da lja virtual. Estes serviçs sã s descrits abaix: Nme: Encmenda nrmal (PAC) Id: 1 Nme: Sedex Id: 2 Nme: E-sedex

138 134 Id: 3 Valr: Ttal ds fretes de cada um ds itens d pedid. Cntém as infrmações ds itens d pedid. Camps: Itens Array itens d pedid Id: identificadr d item na base de dads da lja virtual. IdPrdut: indica identificadr d prdut deste item na base de dads. SkuPrdut: indica códig SKU d prdut deste item na base de dads. Quantidade: guarda a quantidade d prdut n item d pedid. ValrUnitari: armazena valr unitári d prdut n mment da cmpra. AliqutaDescnt: infrma a alíquta de descnt usada n item. ValrDescnt: infrma valr de descnt frnecid n item. ValrTtal: infrma valr ttal deste item d pedid (quantidade x valr unitári). Frete: Infrmações de frete d item. Os camps sã s mesms d frete d pedid cnfrme explicad anterirmente.

139 135 Atualizaçã de andament de pedid Para mdificar andament de um pedid devem ser seguids s passs abaix. Para usar este métd será necessári infrmar cntrat d pedid n frmat explicad n tópic anterir e identificadr da etapa que será aprvada n pedid. Basead na etapa infrmada, sistema irá atualizar andament d pedid até esta etapa para autrizad. Fique atent a dis aspects a usar este recurs: O primeir é que se a etapa de pagament d pedid ainda nã tiver sid aprvada as infrmações referentes a pagament d pedid devem ser infrmadas n cntrat d pedid. O segund aspect é n cas de uma das etapas a serem atualizadas para aprvada ser a de emissã de NFe. Neste cas, deve ser realizad uplad ds arquivs de NFe em XML e em PDF através d webservice para uplad de arquivs de NFe descrit n próxim tópic deste manual. Após ser realizad uplad destes arquivs, seus nmes gerads pela API de integraçã n mment d seu uplad, devem ser enviads n cntrat d pedid que está send atualizad. URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/pedids/atualizarstatus Métd: POST Parâmetr: parametrs O parâmetr parametrs cntém as tdas infrmações pertinentes à alteraçã d andament de um pedid. Pedid pedid que terá seu andament mdificad. IdEtapaAtualizar Id da etapa até a qual pedid será atualizad. NvEstad O estad que será atribuíd a nv andament atual. 2 Aprvad 3 Negad Observaces O mtiv pel qual andament fi negad, em cas d estad ser Negad. Exempl de cnsum

140 136 Retrn: nenhum Descriminaçã ds camps Camp Especificaçã Descriçã Pedid Cntrat de pedid Cntrat cnfrme descrit n últim tópic d manual. Uplad de arquivs de NFe d pedid Para realizar uplad ds arquivs de NFe de um pedid, tant em PDF cm em XML, devem ser seguids s seguintes passs. URL: integracaecmmerce.alterdata.cm.br/wsintegraca.svc/pedids/upladarquivnfe/{idpedid} Métd: POST Parâmetr: idpedid, arquivxml e arquivpdf O parâmetr idpedid é identificadr d pedid na base de dads da lja virtual. arquivxml é uma string em base 64 cntend cnteúd d arquiv xml da nta.

141 137 arquivpdf é uma string em base 64 cntend cnteúd d arquiv pdf da nta. Cabeçalh Para a peraçã de Uplad, além ds cabeçalhs URL e Tken, deve ser infrmad também s cabeçalhs FileNameXML e FileNamePDF cntend nme ds arquivs xml e pdf respectivamente. Exempl de cnsum (C#)

142 138