Documentação de software

Ferramentas do usuário

Ferramentas do site

Você está aqui: IWS » api » Lista de Operações
Visitou: • Lista de Operações
api:ecommerce

Tabela de conteúdos

Lista de Operações

Cartão

Get

  • Recupera os cartões

Path {url_base}/Datasnap/Rest/TCartao/all/{limite}/{pagina}
Tipo GET
Parâmetros do Path
Nome Tipo Descrição
{limite} Inteiro(10) Limite de registros a serem exibidos
{pagina} Inteiro(10) Número da página começando em 0
Resposta
Tipo Array
Exemplo {
 "result":[
  {
   "id":4,
   "descricao":"VISA CR\u00C9DITO",
   "ativo":true
  }
]}

Put

  • Registra uma transação de cartão de crédito

Path {url_base}/Datasnap/Rest/TCartao/transaction
Tipo PUT
Corpo de Requisição
Tipo Objeto
id_pedido Inteiro(20), Obrigatório
nsu String(150), Obrigatório
total Decimal(18,2), Obrigatório
numero_parcelas Inteiro(10), Obrigatório
valor_parcela Decimal(18,2), Obrigatório
cartao String(100), Obrigatório
Exemplo
 {
  "id_pedido": 15976292001,
  "nsu": "00000000000000000",
  "total": 100,
  "numero_parcelas": 10,
  "valor_parcela": 10,
  "cartao": "VISA CRÉDITO"
 }

Categoria

Get

  • Recupera as categorias dos produtos

Path {url_base}/Datasnap/Rest/TCategoria/all/{limite}/{pagina}
Tipo GET
Parâmetros do Path
Nome Tipo Descrição
{limite} Inteiro(10) Limite de registros a serem exibidos
{pagina} Inteiro(10) Número da página começando em 0
Resposta
Tipo Array
Exemplo {
 "result":[
  {
   "id":2182001,
   "descricao":"SACOLAS"
  },
  {
   "id":2183001,
   "descricao":"EMBALAGEM"
  }
]}

Path {url_base}/Datasnap/Rest/TCategoria/find/{id}
Tipo GET
Parâmetros do Path
Nome Tipo Descrição
{id} Inteiro(20) Id da categoria
Resposta
Tipo Objeto
Exemplo {
 "result":{
   "id":2182001,
   "descricao":"SACOLAS"
}}

Produto

Get

  • Recupera os produtos

Path {url_base}/Datasnap/Rest/TProduto/all/{ativo}/{limite}/{pagina}
Tipo GET
Parâmetros do Path
Nome Tipo Descrição
{ativo} SmallInt(0 ou 1) Define se retorna produtos Ativos ou Inativos
{limite} Inteiro(10) Limite de registros a serem exibidos
{pagina} Inteiro(10) Número da página começando em 0
Resposta
Tipo Array
Exemplo
 {
  "result":[
  {
   "id":9732186001,
   "descricao":"COCO RALADO MAIS COCO UMID. SOCOCO 24X100GR",
   "referencia":"COCO RALADO MAIS COCO UMID. SO",
   "codigobarra":"0000001006506",
   "estoque":15,
   "preco":37.64,
   "peso":0,
   "unidade":"CX",
   "decimais":0,
   "categoria":
   {
     "id":3400,
     "descricao":"MERCEARIA\/FARINACEO"
   },
   "ativo":true
   "pesavel":false
  },
  {
   "id":9732194001,
   "descricao":"COCO RALADO MAIS COCO SOCOCO 50X50GR",
   "referencia":"COCO RALADO MAIS COCO SOCOCO 5",
   "codigobarra":"47896004401056",
   "estoque":36,
   "preco":62.02,
   "peso":2.6,
   "unidade":"CX",
   "decimais":0,
   "categoria":
   {
     "id":3300,
     "descricao":"MERCEARIA\/DIVERSOS"
   },
   "ativo":true
   "pesavel":false
  }
 ]}

Path {url_base}/Datasnap/Rest/TProduto/find/{id}
Tipo GET
Parâmetros do Path
Nome Tipo Descrição
{id} Inteiro(20) Id do produto
Resposta
Tipo Objeto
Exemplo
 {
  "result":{
   "id":9732186001,
   "descricao":"COCO RALADO MAIS COCO UMID. SOCOCO 24X100GR",
   "referencia":"COCO RALADO MAIS COCO UMID. SO",
   "codigobarra":"0000001006506",
   "estoque":15,
   "preco":37.64,
   "peso":0,
   "unidade":"CX",
   "decimais":0,
   "categoria":
   {
     "id":3400,
     "descricao":"MERCEARIA\/FARINACEO"
   },
   "ativo":true
   "pesavel":false
  }}

Path {url_base}/Datasnap/Rest/TProduto/findByEan/{ean}
Tipo GET
Parâmetros do Path
Nome Tipo Descrição
{ean} String(20) Código de Barra do Produto
Resposta
Tipo Objeto
Exemplo
 {
  "result":{
   "id":9732186001,
   "descricao":"COCO RALADO MAIS COCO UMID. SOCOCO 24X100GR",
   "referencia":"COCO RALADO MAIS COCO UMID. SO",
   "codigobarra":"0000001006506",
   "estoque":15,
   "preco":37.64,
   "peso":0,
   "unidade":"CX",
   "decimais":0,
   "categoria":
   {
     "id":3400,
     "descricao":"MERCEARIA\/FARINACEO"
   },
   "ativo":true
   "pesavel":false
  }}

  • Lista todos os produtos atualizados no período informado

Path {url_base}/Datasnap/Rest/TProduto/lastupdated/{inicio}/{termino}
Tipo GET
Parâmetros do Path
Nome Tipo Descrição
{inicio} String(20) Data de início, 99.99.9999 99:99:9
{termino} String(20) Data de término, 99.99.9999 99:99:9
Resposta
Tipo Objeto
Exemplo
 {
  "result":[
  {
   "id":9732186001,
   "descricao":"COCO RALADO MAIS COCO UMID. SOCOCO 24X100GR",
   "referencia":"COCO RALADO MAIS COCO UMID. SO",
   "codigobarra":"0000001006506",
   "estoque":15,
   "preco":37.64,
   "peso":0,
   "unidade":"CX",
   "decimais":0,
   "categoria":
   {
     "id":3400,
     "descricao":"MERCEARIA\/FARINACEO"
   }
   "ativo":true
   "pesavel":false
  },
  {
   "id":9732194001,
   "descricao":"COCO RALADO MAIS COCO SOCOCO 50X50GR",
   "referencia":"COCO RALADO MAIS COCO SOCOCO 5",
   "codigobarra":"47896004401056",
   "estoque":36,
   "preco":62.02,
   "peso":2.6,
   "unidade":"CX",
   "decimais":0,
   "categoria":
   {
     "id":3300,
     "descricao":"MERCEARIA\/DIVERSOS"
   }
  }
   "ativo":true
   "pesavel":false
 ]}

  • Lista os produtos com preço por atacado

Path {url_base}/datasnap/rest/TProduto/atacado/{limite}/{pagina}
Tipo GET
Parâmetros do Path
Nome Tipo Descrição
{limite} Inteiro(10) Limite de registros a serem exibidos
{pagina} Inteiro(10) Número da página começando em 0
Resposta
Tipo Objeto
Exemplo
 {
 "result":[
   {
   "id":44094389932001,
   "id_produto":9620001,
   "preco":4.69,
   "quantidade":10
   }
 ]
 }

* Recupera a imagem do produto na base64

Path {url_base}/datasnap/rest/TProduto/foto/{id_produto}
Tipo GET
Parâmetros do Path
Nome Tipo Descrição
{id_produto} Inteiro(20) ID do produto
Resposta
Tipo Objeto
Exemplo
 {
 "result": "\/9j\/4AAQSkZJRgABAQEAYABgAAD\/2w..."
 }

Delete

* Exclui os produtos que sofreram alteração no período informado

Path {url_base}/Datasnap/Rest/TProduto/lastupdated/{inicio}/{termino}
Tipo DELETE
Parâmetros do Path
Nome Tipo Descrição
{inicio} String(20) Data de início, 99.99.9999 99:99:9
{termino} String(20) Data de término, 99.99.9999 99:99:9

Promoção

Ao inserir um produto em promoção no pedido, o campo preço deverá ser o valor da promoção

Get

  • Recupera os produtos em promoção

Path {url_base}/Datasnap/Rest/TPromocao/all/{limite}/{pagina}
Tipo GET
Parâmetros do Path
Nome Tipo Descrição
{limite} Inteiro(10) Limite de registros a serem exibidos
{pagina} Inteiro(10) Número da página começando em 0
Resposta
Tipo Array
Exemplo
 {
  "result":[
  {
   "id":23740000001,
   "inicio":"06\/07\/2016",
   "termino":null,
   "preco":160,
   "preco_normal":169
   "id_produto":123456789
 ]}
Path {url_base}/Datasnap/Rest/TPromocao/find/{id}
Tipo GET
Parâmetros do Path
Nome Tipo Descrição
{id} Inteiro(20) Id da promoção
Resposta
Tipo Objeto
Exemplo
 {
  "result":{
   "id":23740000001,
   "inicio":"06\/07\/2016",
   "termino":null,
   "preco":160,
   "preco_normal":169
   "id_produto":123456789
 }
Path {url_base}/Datasnap/Rest/TPromocao/produto/{idProduto}
Tipo GET
Parâmetros do Path
Nome Tipo Descrição
{idProduto} Inteiro(20) Id do Produto
Resposta
Tipo Objeto
Exemplo
 {
  "result":{
   "id":23740000001,
   "inicio":"06\/07\/2016",
   "termino":null,
   "preco":160,
   "preco_normal":169
   "id_produto":123456789
 }

Tipo Endereço

Get

Path {url_base}/Datasnap/Rest/TTipoEndereco/all/{limite}/{pagina}
Tipo GET
Parâmetros do Path
Nome Tipo Descrição
{limite} Inteiro(10) Limite de registros a serem exibidos
{pagina} Inteiro(10) Número da página começando em 0
Resposta
Tipo Array
Exemplo {
 "result":[
  {
   "id":63,
   "descricao":"Cobrança"
  },
  {
   "id":14001,
   "descricao":"Comercial"
  }
]}
Path {url_base}/Datasnap/Rest/TTipoEndereco/find/{id}
Tipo GET
Parâmetros do Path
Nome Tipo Descrição
{id} Inteiro(20) Id do tipo endereço
Resposta
Tipo Objeto
Exemplo {
 "result":{
   "id":63,
   "descricao":"Cobrança"
}}

Tipo Telefone

Get

Path {url_base}/Datasnap/Rest/TTipoTelefone/all/{limite}/{pagina}
Tipo GET
Parâmetros do Path
Nome Tipo Descrição
{limite} Inteiro(10) Limite de registros a serem exibidos
{pagina} Inteiro(10) Número da página começando em 0
Resposta
Tipo Array
Exemplo {
 "result":[
  {
   "id":51,
   "descricao":"RESIDENCIAL"
  },
  {
   "id":52,
   "descricao":"COMERCIAL"
  }
]}
Path {url_base}/Datasnap/Rest/TTipoTelefone/find/{id}
Tipo GET
Parâmetros do Path
Nome Tipo Descrição
{id} Inteiro(20) Id do tipo telefone
Resposta
Tipo Objeto
Exemplo {
 "result":{
   "id":51,
   "descricao":"RESIDENCIAL"
}}

Cliente

Get

Path {url_base}/Datasnap/Rest/TCliente/all/{limite}/{pagina}
Tipo GET
Parâmetros do Path
Nome Tipo Descrição
{limite} Inteiro(10) Limite de registros a serem exibidos
{pagina} Inteiro(10) Número da página começando em 0
Resposta
Tipo Array
Exemplo {
 "result":[
  {
   "id":23763899001,
   "nome":"Julius A. Swafford"
   "documento":"56148825619"
  },
  {
   "id":23763562001,
   "nome":"Helena L. Porter"
   "documento":"36644610293"
  }
]}

Path {url_base}/Datasnap/Rest/TCliente/find/{id}
Tipo GET
Parâmetros do Path
Nome Tipo Descrição
{id} Inteiro(20) Id do cliente
Resposta
Tipo Objeto
Exemplo {
 "result":{
   "id":23763899001,
   "nome":"Julius A. Swafford"
   "documento":"56148825619"
}}

Path {url_base}/Datasnap/Rest/TCliente/findByDoc/{doc}
Tipo GET
Parâmetros do Path
Nome Tipo Descrição
{doc} String(30) Documento do cliente
Resposta
Tipo Objeto
Exemplo {
 "result":{
   "id":23763899001,
   "nome":"Julius A. Swafford"
   "documento":"56148825619"
}}

Put

Path {url_base}/Datasnap/Rest/TCliente/cliente
Tipo PUT
Corpo de Requisição
Tipo Objeto
nome String(50), Obrigatório
documento String(11), Obrigatório, Único, CPF
Exemplo
 {
  "nome":"Giovana Cunha da Silva",
  "documento":"41358187657"
 }
Resposta
Tipo Inteiro(20)
Exemplo
 {
  "result":23764106001
 }

Post

Path {url_base}/Datasnap/Rest/TCliente/cliente/{id}
Tipo POST
Parâmetros do Path
Nome Tipo Descrição
{id} Inteiro(20) Id do cliente
Corpo de Requisição
Tipo Objeto
nome String(50), Obrigatório
documento String(11), Obrigatório, Único, CPF
Exemplo
 {
  "nome":"Giovana Cunha da Silva",
  "documento":"41358187657"
 }

Email

Get

Path {url_base}/Datasnap/Rest/TCliente/emails/{idCliente}
Tipo GET
Parâmetros do Path
Nome Tipo Descrição
{idCliente} Inteiro(20) Id do cliente
Resposta
Tipo Array
Exemplo {
 "result":[
  {
   "id":23764109001,
   "email":"giovana.cunha@gionh.com",
   "preferencia":0
  },
  {
   "id":23764129001,
   "email":"giovana.cunha@dom.com",
   "preferencia":1
  }
]}

Put

Path {url_base}/Datasnap/Rest/TCliente/email
Tipo PUT
Corpo de Requisição
Tipo Objeto
id_cliente Inteiro(20), Obrigatório
email String(100), Obrigatório, Único, Email
preferencia Inteiro(1), Obrigatório, 1 ou 0
Exemplo
 {
  "id_cliente":23764238001,
  "email":"giovana@dom.com",
  "preferencia":1
 }
Resposta
Tipo Inteiro(20)
Exemplo
 {
  "result":23764109001
 }

Post

Path {url_base}/Datasnap/Rest/TCliente/email/{idEmail}
Tipo POST
Parâmetros do Path
Nome Tipo Descrição
{idEmail} Inteiro(20) Id do email
Corpo de Requisição
Tipo Objeto
id_cliente Inteiro(20), Obrigatório
email String(100), Obrigatório, Único, Email
preferencia Inteiro(1), Obrigatório, 1 ou 0
Exemplo
 {
  "id_cliente":23764238001,
  "email":"giovana@dom.com",
  "preferencia":1
 }

Telefone

Get

Path {url_base}/Datasnap/Rest/TCliente/telefones/{idCliente}
Tipo GET
Parâmetros do Path
Nome Tipo Descrição
{idCliente} Inteiro(20) Id do cliente
Resposta
Tipo Telefone(array)
Exemplo {
 "result":[
  {
   "id":23764125001,
   "tipo_telefone":
   {
    "id":51,
    "descricao":"RESIDENCIAL"
   },
   "ddd":35,
   "telefone":"36239999",
   "contato":"Giovana"
  },
  {
   "id":23764127001,
   "tipo_telefone":
   {
    "id":52,
    "descricao":"COMERCIAL"
   },
   "ddd":35,
   "telefone":"88888888",
   "contato":"Giovana"
  }
 ]}

Put

Path {url_base}/Datasnap/Rest/TCliente/telefone
Tipo PUT
Corpo de Requisição
Tipo Objeto
id_cliente Inteiro(20), Obrigatório
id_tipo_telefone Inteiro(20), Obrigatório, Único
telefone String(30), Obrigatório, [0-9]+
ddd Inteiro(3), Obrigatório
contato String(100)
Exemplo
 {
  "id_cliente": 23764238001,
  "id_tipo_telefone": 52,
  "telefone": "88888888",
  "ddd": 35,
  "contato": ""
 }
Resposta
Tipo Inteiro(20)
Exemplo
 {
  "result":23764127001
 }

Post

Path {url_base}/Datasnap/Rest/TCliente/telefone/{idTelefone}
Tipo POST
Parâmetros do Path
Nome Tipo Descrição
{idTelefone} Inteiro(20) Id do telefone
Corpo de Requisição
Tipo Objeto
Tipo Objeto
id_cliente Inteiro(20), Obrigatório
id_tipo_telefone Inteiro(20), Obrigatório, Único
telefone String(30), Obrigatório, [0-9]+
ddd Inteiro(3), Obrigatório
contato String(100)
Exemplo
 {
  "id_cliente": 23764238001,
  "id_tipo_telefone": 52,
  "telefone": "88888888",
  "ddd": 35,
  "contato": "Giovana"
 }

Endereço

Get

Path {url_base}/Datasnap/Rest/TCliente/enderecos/{idCliente}
Tipo GET
Parâmetros do Path
Nome Tipo Descrição
{idCliente} Inteiro(20) Id do cliente
Resposta
Tipo Endereço(array)
Exemplo
 {
  "result":[
  {
   "id":23764140001,
   "tipo_endereco":
   {
    "id":63,
    "descricao":"Cobran\u00E7a"
   },
   "cidade":"ITAJUB\u00C1",
   "uf":"MG",
   "cep":"37505000",
   "logradouro":"Rua Antonio Figueira Lopes",
   "numero":36,
   "complemento":"Casa",
   "bairro":"Boa Vista",
   "referencia":""
  },
  {
   "id":23764143001,
   "tipo_endereco":
   {
    "id":14001,
    "descricao":"Comercial"
   },
   "cidade":"S\u00C3O PAULO",
   "uf":"SP",
   "cep":"37505000",
   "logradouro":"Rua Auriliano Miguel Ferreira",
   "numero":100,
   "complemento":"Casa",
   "bairro":"Interlagos",
   "referencia":"Pr\u00F3ximo ao Supermercado"
  }
 ]}

Put

Path {url_base}/Datasnap/Rest/TCliente/endereco
Tipo PUT
Corpo de Requisição
Tipo Objeto
id_cliente Inteiro(20), Obrigatório
id_tipo_endereco Inteiro(20), Obrigatório, Único
cep String(12), Obrigatório, [0-9]+
cidade String(60), Obrigatório
uf String(2), Obrigatório
logradouro String(100), Obrigatório
numero Inteiro(10), Obrigatório
complemento String(100)
bairro String(100), Obrigatório
referencia String(100)
Exemplo
 {
  "id_cliente": 23764238001,
  "id_tipo_endereco": 14001,
  "cep": '37505000",
  "cidade": "São Paulo",
  "uf": "SP",
  "logradouro": "Rua Auriliano Miguel Ferreira",
  "numero": 100,
  "complemento": "Casa",
  "bairro": "Interlagos",
  "referencia": "Próximo ao supermercado"
 }
Resposta
Tipo Inteiro(20)
Exemplo
 {
  "result":23764143001
 }

Post

Path {url_base}/Datasnap/Rest/TCliente/endereco/{idEndereco}
Tipo POST
Parâmetros do Path
Nome Tipo Descrição
{idEndereco} Inteiro(20) Id do endereço
Corpo de Requisição
Tipo Objeto
id_cliente Inteiro(20), Obrigatório
id_tipo_endereco Inteiro(20), Obrigatório, Único
cep String(12), Obrigatório, [0-9]+
cidade String(60), Obrigatório
uf String(2), Obrigatório
logradouro String(100), Obrigatório
numero Inteiro(10), Obrigatório
complemento String(100)
bairro String(100), Obrigatório
referencia String(100)
Exemplo
 {
  "id_cliente": 23764238001,
  "id_tipo_endereco": 14001,
  "cep": '37505000",
  "cidade": "São Paulo",
  "uf": "SP",
  "logradouro": "Rua Auriliano Miguel Ferreira",
  "numero": 100,
  "complemento": "Casa",
  "bairro": "Interlagos",
  "referencia": "Próximo ao supermercado"
 }

Pedido

Regras para se utilizar o preço por atacado

  • O campo preço deverá permanecer o preço normal do produto
  • O campo desconto deverá ser a diferença do preço normal e o preço por atacado multiplicado a quantidade pedida
  • A quantidade pedida deverá ser igual ou superior a quantidade por atacado
  • O campo atacado deverá ter o valor 1

Ex.: Produto X

Preço normal R$ 1,59

Preço por atacado: R$ 1,55

Quantidade por atacado : 10

Quantidade pedida: 11

Desconto = (1,59 - 1,55) * 11

Desconto = 0,44

Get

Path {url_base}/Datasnap/Rest/TPedido/all/{limite}/{pagina}
Tipo GET
Parâmetros do Path
Nome Tipo Descrição
{limite} Inteiro(10) Limite de registros a serem exibidos
{pagina} Inteiro(10) Número da página começando em 0
Resposta
Tipo Pedido(array)
Exemplo
 {
  "result":[
  {
   "id":23748139001,
   "numero":"0000033139",
   "cliente":
   {
    "id":64713834955,
    "nome":"Cláudio Pereira Santos",
    "documento":"20385449000122"
   },
   "data":"03\/08\/2016",
   "validade":"10\/08\/2016",
   "desconto":0,
   "acrescimo":0,
   "situacao":"VENCIDO",
   "frete":0,
   "status":2
  },
  {
   "id":23748146001,
   "numero":"0000033140",
   "cliente":
   {
    "id":64713834955,
    "nome":"Maria Rita da Silva",
    "documento":"62188968891"
   },
   "data":"04\/08\/2016",
   "validade":"11\/08\/2016",
   "desconto":0,
   "acrescimo":0,
   "situacao":"VENCIDO",
   "frete":0,
   "status":2
  }
 ]}
Path {url_base}/Datasnap/Rest/TPedido/find/{id}
Tipo GET
Parâmetros do Path
Nome Tipo Descrição
{id} Inteiro(10) Id do pedido
Resposta
Tipo Pedido
Exemplo
 {
  "result":{
   "id":23748139001,
   "numero":"0000033139",
   "cliente":
   {
    "id":64713834955,
    "nome":"Cláudio Pereira Santos",
    "documento":"20385449000122"
   },
   "data":"03\/08\/2016",
   "validade":"10\/08\/2016",
   "desconto":0,
   "acrescimo":0,
   "situacao":"VENCIDO",
   "frete":0,
   "status":2
   "produtos":[{
    "produto": {
     "id":10133569001,
     "descricao":"CALDO ARISCO 10X6X57GR CARNE",
     "referencia":"CALDO ARISCO 10X6X57GR CARNE",
     "codigobarra":"7891700080358",
     "estoque":79,
     "preco":9.89,
     "peso":0,
     "unidade":"CX",
     "decimais":0,
     "categoria": {
      "id":3300,
      "descricao":
      "MERCEARIA\/DIVERSOS"
     }},
    "quantidade":1,
    "valor":9.89,
    "desconto":0
    }]
 }}
Status Situação
-1 Descartado
1 Aberto
2 Vencido/Impresso
3 Faturado/A Faturar/Confirmado

Put

Path {url_base}/Datasnap/Rest/TPedido/pedido
Tipo PUT
Corpo de Requisição
Tipo Objeto
id_cliente Inteiro(20), Obrigatório
id_produto Inteiro(20), Obrigatório
preco Decimal(18,2), Obrigatório, > 0
quantidade Decimal(18,3), Obrigatório, > 0
desconto Decimal(18,2), Obrigatório, > 0, < preco
atacado Inteiro(1), Obrigatório, 0 ou 1
Exemplo
 {
  "id_cliente": 23764238001,
  "id_produto": 10133569001,
  "preco": 9.90,
  "quantidade": 1,
  "desconto": 0,
  "atacado": 0
 }
Resposta
Tipo Inteiro(20)
Exemplo
 {
  "result":9667557001
 }

Post

Um pedido só pode ser alterado enquando o seu status for igual a 1

Path {url_base}/Datasnap/Rest/TPedido/produto/{idPedido}
Tipo POST
Parâmetros do Path
Nome Tipo Descrição
{idPedido} Inteiro(20) Id do pedido
Corpo de Requisição
Tipo Objeto
id_cliente Inteiro(20), Obrigatório
id_produto Inteiro(20), Obrigatório
preco Decimal(18,2), Obrigatório, > 0
quantidade Decimal(18,3), Obrigatório, > 0
desconto Decimal(18,2), Obrigatório, > 0, < preco
atacado Inteiro(1), Obrigatório, 0 ou 1
Exemplo
 {
  "id_cliente": 23764238001,
  "id_produto": 10133569001,
  "preco": 9.90,
  "quantidade": 1,
  "desconto": 0,
  "atacado": 0
 }

Path {url_base}/Datasnap/Rest/TPedido/frete/{idPedido}
Tipo POST
Parâmetros do Path
Nome Tipo Descrição
{idPedido} Inteiro(20) Id do pedido
Corpo de Requisição
Tipo Objeto
frete Decimal(18,2), Obrigatório, > 0
Exemplo
 {
  "frete": 9.90
 }

Delete

Um pedido só pode ser alterado enquando o seu status for igual a 1

Path {url_base}/Datasnap/Rest/TPedido/pedido/{idPedido}
Tipo DELETE
Parâmetros do Path
Nome Tipo Descrição
{idPedido} Inteiro(20) Id do pedido

Path {url_base}/Datasnap/Rest/TPedido/produto/{idPedido}/{idProduto}
Tipo DELETE
Parâmetros do Path
Nome Tipo Descrição
{idPedido} Inteiro(20) Id do pedido
{idProduto} Inteiro(20) Id do produto

Pagamento

  • Define a forma de pagamento e confirma o pedido alterando seu status para “IMPRESSO”.

A soma das importâncias deve corresponder ao total do pedido, assim como a soma das parcelas deve corresponder ao valor da importância

Path {url_base}/Datasnap/Rest/TPedido/pagamento/{idPedido}
Tipo PUT
Parâmetros do Path
Nome Tipo Descrição
{idPedido} Inteiro(20) Id do pedido
{idProduto} Inteiro(20) Id do produto
Corpo de Requisição
Tipo Array
id_forma_pagamento Inteiro(20), Obrigatório
importancia Decimal(18,2), Obrigatório
numero_parcelas Inteiro(10), Obrigatório, > 0
parcelas Array
numero Inteiro(20), Obrigatório
vencimento String, Obrigatório, 99/99/9999
valor Decimal(18,2), Obrigatório
Exemplo
 [
  {
   "id_forma_pagamento": 4
   "importancia": 2.59,
   "numero_parcelas": 1,
   "parcelas": [
   {
    "numero": 1,
    "vencimento": "30/07/2017",
    "valor": 2.59
   }
   ]
  }
 ]

Nota Fiscal

Get

Path {url_base}/Datasnap/Rest/TNotafiscal/all/{limite}/{pagina}
Tipo GET
Parâmetros do Path
Nome Tipo Descrição
{limite} Inteiro(10) Limite de registros a serem exibidos
{pagina} Inteiro(10) Número da página começando em 0
Resposta
Tipo Nota fiscal(array)
Exemplo
 {
  "result":[
  {
   "id":44056200003001,
   "numero":"0000952312",
   "id_pedido":123456789,
   "cliente":{
    "id":2569001,
    "nome":"NOME DO CLIENTE",
    "documento":"99999999999999"
   },
   "emissao":"09\/04\/2015",
   "modelo":"55",
   "serie":"1",
   "bc":713.5,
   "bcst":0,
   "icms":85.62,
   "valorst":0,
   "frete":0,
   "seguro":0,
   "despesas":0,
   "total":9921.27,
   "cfop":1403,
   "ipi":0
 > }
   ]
 }

Path {url_base}/Datasnap/Rest/TNotafiscal/itens/{idNotaFiscal
Tipo GET
Parâmetros do Path
Nome Tipo Descrição
{idNotaFiscal} Inteiro(20) ID da nota fiscal
Resposta
Tipo Itens da Nota fiscal(array)
Exemplo
 {
  "result": [
   {
    "id": 44056206844001,
    "numero_item": 1,
    "descricao": "ALHO CLASSE A 200TRITURADO",
    "ncm": "07129090",
    "cst": 0,
    "cfop": 1102,
    "unid": "UN",
    "qtde": 48,
    "valor": 121.18,
    "bc": 121.18,
    "aliquota": 12
   }
  ]
 }

Path {url_base}/Datasnap/Rest/TNotafiscal/findByIdPedido/{idPedido}
Tipo GET
Parâmetros do Path
Nome Tipo Descrição
{idPedido} Inteiro(20) ID do pedido
Resposta
Tipo Nota fiscal(object)
Exemplo
 {
  "result":
  {
   "id":44056200003001,
   "numero":"0000952312",
   "id_pedido":123456789,
   "cliente":{
    "id":2569001,
    "nome":"NOME DO CLIENTE",
    "documento":"99999999999999"
   },
   "emissao":"09\/04\/2015",
   "modelo":"55",
   "serie":"1",
   "bc":713.5,
   "bcst":0,
   "icms":85.62,
   "valorst":0,
   "frete":0,
   "seguro":0,
   "despesas":0,
   "total":9921.27,
   "cfop":1403,
   "ipi":0
  }
 }

api/ecommerce.txt · Última modificação: 2021/05/25 19:40 por rafael

Ferramentas da página

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki