Objetos {1}

Segue abaixo o descritivo dos principais objetos para representar as informações compartilhadas pela API.

/Document

Representação do tipo da pessoa, seja física ou jurídica.

attribute

type

specification

number

string

Número formatado do CPF ou CNPJ

type

string

Tipo do documento, que pode ser: "cpf" o "cnpj"

"document": {
    "number": "00.000.000/0001-00",
    "type": "cnpj",
    "object": "Document"
}

/Address

Representação de um endereço de coleta e/ou entrega.

attribute

type

specification

street

string

Logradouro

number

string

Número do imóvel

complement

string

Complemento do logradouro

district

string

Bairro

zip

number

CEP

state

string:2

Estado (UF)

city

string

Cidade

reference

string

Referências de como chegar ao imóvel

latitude

string

Coordenadas GPS

longitude

string

Coordenadas GPS

"address": {
    "street": "107 Norte Avenida NS 5",
    "number": "",
    "complement": "Quadra 107 Norte, Av. NS 5, S/N, Lote 01, Conj 01 e 02 Piso Superior (Capim Dourado Shopping)",
    "district": "Plano Diretor Norte",
    "zip": "77001098",
    "state": "TO",
    "city": "Palmas",
    "reference": "",
    "latitude": "-10.180842",
    "longitude": "-48.349772",
    "object": "Address"
}

/ExternalID

Representação do objeto de integração entre sistemas.

attribute

type

specification

integer

Identificador numérico

uid

string

Identificador único

content

string

Informação que irá apresentada no campo "external_id"

createdAt

string

Data/hora de criação no formato ISO8601

updatedAt

string

Data/hora de atualização no formato ISO8601

{
    "id": "1",
    "uid": "4e6891d094e79f1b06231d9356703268",
    "content": "ABC123",
    "createdAt": "2018-10-02T19:20:51-0300",
    "updatedAt": "2018-10-02T19:20:51-0300",
    "object": "ExternalID"
}

/Merchant

Representação das informações cadastrais de um estabelecimento.

attribute

type

specification

integer

Identificador numérico

uid

string

Identificador único

externalId

string

Valor do objeto

title

string

Nome fantasia

description

string

Descrição do perfil

image

string

Url do logotipo/imagem

document

CPF/CNPJ

sponsor

string

Nome do responsável

phone

string

Telefone institucional

string

E-mail institucional

address

Endereço do imóvel

url

string

Url do estabelecimento no marketplace

rating

integer

Nota da avaliação: de 0 a 5

foodService

Informações de produção do estabelecimento

deliveryService

Informações do serviço de delivery

supportService

Informações da franquia responsável pelo suporte ao estabelecimento

createdAt

string

Data/hora de criação no formato ISO8601

updatedAt

string

Data/hora de atualização no formato ISO8601

{
    "id": "533",
    "uid": "25a94f9991f070791f94f3f496dccabc",
    "externalId": "",
    "title": "Pamonharia Paraíso",
    "description": "",
    "image": "https://sandbox.tonolucro.com/images/empresa/55e50b96d4693.jpg",
    "document": {
        "object": "Document"
    },
    "sponsor": "João da Silva",
    "phone": "(63) 3212-1205",
    "email": "pamonhariaparaiso@gmail.com",
    "address": {
        "object": "Address"
    },
    "url": "https://sandbox.tonolucro.com/palmas/pamonharia-paraiso",
    "rating": "5",
    "foodService": {
        "object": "Food"
    },
    "deliveryService": {
        "object": "Delivery"
    },
    "supportService": {
        "object": "Franchise"
    },
    "createdAt": "2015-08-31T23:26:52-0300",
    "updatedAt": "2018-06-01T16:45:51-0300",
    "object": "Merchant"
}

/Merchant/Service/Food

Representação das informações do Food Service.

attribute

type

specification

cuisine

Tipo de Cozinha

preparationTime

Tempo de Preparo

priceRange

Faixa de Preço

foodCourt

Praça de Alimentação

{
    "cuisine": {
        "id": "8",
        "name": "Tipo de Cozinha",
        "value": "Fast-food",
        "object": "Cuisine"
    },
    "preparationTime": {
        "id": "1",
        "name": "Tempo de Preparo",
        "value": "Até 30 minutos",
        "object": "PreparationTime"
    },
    "priceRange": {
        "id": "2",
        "name": "Faixa de Preço",
        "value": "16 a 25 reais",
        "object": "PriceRange"
    },
    "foodCourt": {
        "id": "2",
        "name": "Praça de Alimentação",
        "value": "Capim Dourado",
        "object": "FoodCourt"
    },
    "object": "Food"
}

/Merchant/Service/Food/Characteristic

Representação das características específicas do estabelecimento.

attribute

type

specification

integer

Identificador numérico

name

string

Tipo/nome da característica

value

string

Informação da característica

object

string

Especialização do objeto

{
    "id": "8",
    "name": "Tipo de Cozinha",
    "value": "Fast-food",
    "object": "Cuisine"
}

/Merchant/Service/Delivery

Representação do serviço de delivery de um estabelecimento.

attribute

type

specification

active

boolean

Informa se o serviço de delivery está ativo ou não

outsourced

boolean

Informa se o delivery é terceirizado ao Tonolucro ou não

addressPickup

Endereço de coleta dos pedidos

carrier

Transportadora que pode ser a franquia do Tonolucro na cidade ou o próprio estabelecimento

{
    "active": true,
    "outsourced": true,
    "addressPickup": {
        "object": "Address"
    },
    "carrier": {
        "object": "Franchise|Merchant"
    },
    "object": "Delivery"
}

/Merchant/Operation

Representação do horário de funcionamento do estabelecimento.

attribute

type

specification

open

boolean

Informa se no momento da requisição o estabelecimento está aberto ou não

periods

array

Informação semanal de horários de abertura

{
    "open": true,
    "periods": [
        [
            "Segunda",
            "18h00",
            "23h00"
        ],
        [
            "Terça",
            "18h00",
            "23h00"
        ],
        [
            "Quarta",
            "18h00",
            "23h00"
        ],
        [
            "Quinta",
            "18h00",
            "23h00"
        ],
        [
            "Sexta",
            "18h00",
            "23h00"
        ],
        [
            "Sábado",
            "18h00",
            "23h00"
        ]
    ],
    "object": "Operation"
}

/Store/Inventory/Products/Group

Representação dos grupos de produtos.

attribute

type

specification

integer

Identificador numérico

uid

string

Identificador único

externalId

string

Valor do objeto

merchantId

integer

Identificador numérico do

title

string

Nome do grupo de produtos

titleProductChoice

string

Legenda apresentada ao usuário para escolha do produto de um grupo

editable

boolean

Informa se os produtos do grupo podem ser ativados ou não.

priority

integer

Ordem numérica de forma crescente

active

boolean

Informa se o grupo está ativo ou não

{
    "id": "374",
    "uid": "2da785f4b936d737adf564e24fbcddda",
    "externalId": null,
    "merchantId": "534",
    "title": "Refrigerante Lata",
    "titleProductChoice": "Escolha o Sabor",
    "editable": true,
    "priority": "300",
    "active": true,
    "object": "Group"
}

/Store/Inventory/Product

Representação do produto.

attribute

type

specification

integer

Identificador numérico

uid

string

Identificador único

externalId

string

Valor do objeto

merchantId

integer

Identificador numérico do

productGroupId

integer

Identificador numérico do

productGroupTitle

string

Título do

title

string

Nome público do produto

titleInternalOrder

string

Nome interno do produto

image

string

Url da imagem do produto

amount

float

Preço do produto

amountDiscount

float

Valor do desconto

amountSale

float

Valor final de venda

priority

integer

Ordem numérica de forma crescente

active

boolean

Informa se o produto está ativo ou não

{
    "id": "976",
    "uid": "c4722f41eab36695b0eb09224c813ABC",
    "externalId": null,
    "merchantId": "000",
    "productGroupId": "000",
    "productGroupTitle": "Refrigerante Lata 250ml",
    "title": "Coca-cola Zero",
    "titleInternalOrder": "Coca-cola Zero 250ml",
    "image": "",
    "amount": "5.00",
    "amountDiscount": "0.00",
    "amountSale": "5.00",
    "priority": "740",
    "active": true,
    "object": "Product"
}

/Merchant/Store/Sales/Category

Representação das categorias de anúncios de produtos.

attribute

type

specification

integer

Identificador numérico

uid

string

Identificador único

externalId

string

Valor do objeto

merchantId

integer

Identificador numérico

title

string

Nome público da categoria

titleInternalOrder

string

Nome interno da categoria

image

string

Url da imagem

priority

integer

Ordem numérica de forma crescente

active

boolean

Informa se a categoria está ativa ou não

{
    "id": "98",
    "uid": "6e1df93a77d3b2a65c15abe658bc6abc",
    "externalId": null,
    "merchantId": "534",
    "title": "Pizza Média (2 Sabores)",
    "titleInternalOrder": "PIZZA M",
    "image": "",
    "priority": "90",
    "active": true,
    "object": "SalesCategory"
}

/Merchant/Store/Sales/Product

Representação do um anúncio de produto.

attribute

type

specification

integer

Identificador numérico

uid

string

Identificador único

externalId

string

Valor do objeto

merchantId

integer

Identificador numérico da

salesCategoryId

integer

Identificador numérico do

salesPricingId

integer

Identificador numérico do /Sales/Pricing

title

string

Nome público do anúncio

titleInternalOrder

string

Nome interno do anúncio

description

string

Texto descritivo do anúncio

image

string

Url da imagem

imageThumbnail

string

Url da miniatura da imagem

amount

float

Preço do anúncio

amountDiscount

float

Valor do desconto

amountSale

float

Valor final

featured

/Featured

Objeto que informa em quais dias da semana o produto ficará em destaque no marketplace

priority

integer

Ordem numérica de forma crescente

active

boolean

Informa se o anúncio está ativo ou não

productSingle

Vínculo com um produto único em situações de anúncio simples

salesProductGroup

array

Lista de grupos de produtos vinculados ao anúncio

{
    "id": "5689",
    "uid": "4b1fa7d93141dd9b69d5aae06e11aABC",
    "externalId": "ABC123",
    "merchantId": "534",
    "salesCategoryId": "980",
    "salesPricingId": "1",
    "title": "Pizza Big + Pizza M (Grátis)",
    "titleInternalOrder": "",
    "description": "Na compra da pizza Big ganhe uma M (doce) + frete grátis",
    "image": "https://tonolucro.delivery/images/anuncio/5963d8e927881.jpg",
    "imageThumbnail": "",
    "amount": "84.00",
    "amountDiscount": "0.00",
    "amountSale": "84.00",
    "featured": {
        "weekdays": {
            "monday": true,
            "tuesday": false,
            "wednesday": false,
            "thursday": false,
            "friday": false,
            "saturday": false,
            "sunday": false,
            "object": "Weekdays"
        },
        "object": "Featured"
    },
    "priority": "5442",
    "active": false,
    "productSingle": {
        "id": "13658",
        "uid": "ABCa38f26b009463e02d20fc1fb66c67",
        "externalId": null,
        "merchantId": "534",
        "productGroupId": "2999",
        "title": "Pizza Big + Pizza M (Grátis)",
        "titleInternalOrder": "Pizza Big + Pizza M (Grátis)",
        "image": "",
        "amount": "0.00",
        "amountDiscount": "0.00",
        "amountSale": "0.00",
        "priority": "10666",
        "active": true,
        "object": "Product"
    },
    "salesProductGroup": [
        {
            "id": "289",
            "salesProductId": "434",
            "productGroupId": "278",
            "productGroupUid": "9b552fe58532db4618fb6555e000bad6",
            "productGroupExternalId": "ABC123",
            "required": true,
            "limit": "1",
            "priority": "0",
            "object": "SalesProductGroup"
        },
        {
            "id": "372",
            "salesProductId": "434",
            "productGroupId": "269",
            "productGroupUid": "29e8e49667de4e549b259cbe27fba11b",
            "productGroupExternalId": null,
            "required": true,
            "limit": "1",
            "priority": "0",
            "object": "SalesProductGroup"
        },
        {
            "id": "373",
            "salesProductId": "434",
            "productGroupId": "268",
            "productGroupUid": "ddd11eb731be2d0TY9e73492f45efd4e",
            "productGroupExternalId": null,
            "required": true,
            "limit": "1",
            "priority": "0",
            "object": "SalesProductGroup"
        }
    ],
    "object": "SalesProduct"
}

/Merchant/Store/Sales/Product/Group

Representação do vínculo entre anúncios e grupos de produtos.

attribute

type

specification

integer

Identificador numérico

salesProductId

integer

Identificador numérico do

productGroupId

integer

Identificador numérico do

productGroupUid

string

Identificador numérico do

productGroupExternalId

string

Valor de referência do

required

boolean

Na regra de escolha de um produto do grupo, será obrigatório escolher um ou mais itens

limit

integer

Na regra de escolha de um produto do grupo, deverá ser selecionado o valor limite de itens

priority

integer

Ordem numérica de forma crescente

{
    "id": "289",
    "salesProductId": "434",
    "productGroupId": "278",
    "productGroupUid": "9b552fe58532db4618fb6555e000bad6",
    "productGroupExternalId": "ABC123",
    "required": true,
    "limit": "1",
    "priority": "0",
    "object": "SalesProductGroup"
}

/Merchant/Store/Sales/Pricing

Representação das regras de cálculo de preço para /Sales/Product/Group

attribute

type

specification

integer

Identificador numérico

uid

string

Identificador único

externalId

string

Valor do objeto

title

string

Nome da regra

code

string

Código representativo

alert

string

Texto que explica a regra ao consumidor

{
    "id": "1",
    "uid": "c21f969b5f03d33dabe04f8f136e7682",
    "externalId": null,
    "title": "Normal",
    "code": "default",
    "alert": "",
    "object": "SalesPricing"
}

/Franchise

Representação do franqueado do Tonolucro em uma determinada região.

attribute

type

specification

integer

Identificador numérico

title

string

Nome da franquia

document

CNPJ

sponsor

string

Nome do responsável

phone

string

Telefone institucional

string

E-mail institucional

address

Endereço do imóvel

createdAt

string

Data/hora de criação no formato ISO8601

updatedAt

string

Data/hora de atualização no formato ISO8601

{
    "id": "1",
    "title": "TNL PALMAS",
    "name": "TONOLUCRO PALMAS",
    "document": {
        "object": "Document"
    },
    "sponsor": "Darley Passarin",
    "phone": "(63) 0000-0000",
    "email": "palmas@tonolucro.com",
    "address": {
        "object": "Address"
    },
    "createdAt": "2018-01-09 11:28:34",
    "object": "Franchise"
}

Previous/ExternalID NextObjetos {2}

Last updated 5 years ago