Home

Série 1

Páginas filhas
  • PriceTable

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Esta entidade exibe informações sobre a Tabela de preço e suporta as seguintes operações: GETPOSTPUT e .DELETE.

Campos do retorno

Nome

Descrição

Tamanho do campo

Tipo

Mais detalhes

id

Id da tabela de preço

3

Caracter

 

description

Descrição da tabela de preço

30

Caracter

 

initialValidDate

Data de validade inicial

8

Data

 

initialValidTime

Hora de validade inicial

5

Caracter

 

finalValidDate

Data de validade final

8

Data

 

finalValidTime

Hora de validade final

5

Caracter

 

 

Leitura de registro (GET):

/first/api/v1/pricetable/

Retorno:

{

  "total": 2,

  "hasNext": false,

  "syncing": false,

  "lines": [

    {

      "pk": "004",

      "id": "004",

      "description": "TERESINA NORMAL",

      "initialValidDate": "20121113",

      "initialValidTime": "00:00",

      "finalValidDate": "20491231",

      "finalValidTime": "23:59",

      "paymentCondition": "",

      "active": "1",

      "items": {

        "url": "/first/api/v1/pricetableitem?tableId=004"

      }

    },

    {

      "pk": "005",

      "id": "005",

      "description": "TERESINA A VISTA",

      "initialValidDate": "20121118",

      "initialValidTime": "00:00",

      "finalValidDate": "20491231",

      "finalValidTime": "23:59",

      "paymentCondition": "",

      "active": "2",

      "items": {

        "url": "/first/api/v1/pricetableitem?tableId=005"

      }

    }

]

Inclusão de registro (POST):

/first/api/v1/pricetable

Body:

    {

      "id": "880",

      "description": "nova tabela",

      "initialValidDate": "20121113",

      "initialValidTime": "00:00",

      "finalValidDate": "20491231",

      "finalValidTime": "23:59",

      "paymentCondition": "",

      "active": "1",

      "items": {

        "productId":"00001",

        "basePrice":99,

        "salePrice":99,

        active:"1"

      }

    }

Retorno:

{

  "url": "/first/api/v1/pricetable/880",

  "id": "880"

}

Alteração de registro (PUT):

No exemplo abaixo estamos deletando o atual item da tabela e colocando outro no lugar.

/first/api/v1/pricetable/880

Body:

    {

      "description": "nova tabela alterada",

      "items": [

          {

            "item": "0001",

            delete: true

          },

          {

            "productId":"00002",

            "basePrice":10,

            "salePrice": 44,

            active: "1",

            add:true

          }

      ]

}

Retorno:

{

  "url": "/first/api/v1/pricetable/880",

  "id": "880"

}

Exclusão de registro (DELETE):

/first/api/v1/pricetable/880

 

Retorno:

{

  "url": "/first/api/v1/pricetable/880",

  "id": "880"

}

PriceTable Item

Para visualizar os itens da tabela de preço deve ser usada uma requisição GET na url localhost:8085/first/api/v1/pricetableitem

Para filtrar por Tabela de preço podemos utilizar query string:

/first/api/v1/pricetableitem?tableId=012

 

Campos do retorno

Nome

Descrição

Tamanho do campo

Tipo

Mais detalhes

Item

Código do item da tabela de preço

4

Caractere

 

tableId

Código da tabela de preço que o item pertence

3

Caractere

 

productId

Código do produto

15

Caractere

 

basePrice

Preço base

14

Numérico

 

salePrice

Preço de venda

14

Numérico

 

active

Item ativo

1

Caractere

 

state

Estado

2

Caractere

 

region

Região

6

Caractere

 

priceRange

Faixa para o preço

9

Numérico

 

Comission

Percentual para calculo da Comissao sobre o produto

5

Numérico