Objetos {2}

//API Tonolucro Merchant | Resource: Merchant

Segue abaixo o descritivo dos principais objetos representativos da API.

/Order

Representação de um pedido feito por em consumidor.

Especificação

attribute	type	specification
id	integer	Identificador numérico
uid	string	Identificador único
externalId	string	Valor do objeto /ExternalID
amount	float	Valor bruto do pedido
amountDiscount	float	Valor do desconto
amountTotal	float	Valor total do pedido
status	/OrderStatus	Status atual do pedido
notes	string	Observações inseridas pelo consumidor
createdAt	string	Data/hora de criação no formato ISO8601
customer	/Customer	Informações do consumidor
coupon	/Coupon	Informações do cupom de desconto
payment	/Payment	Informações de pagamento do pedido
cart	/Cart	Informações do carrinho de produtos
shipment	/Shipment	Informações do serviço de delivery

Exemplo

{
    "id": "400218",
    "uid": "d40f86965d406245asdff95ceba7cb3b",
    "externalId": "12345",
    "amount": "240.99",
    "amountDiscount": "0.00",
    "amountTotal": "240.99",
    "status": {
        "id": "1",
        "title": "Aberto",
        "object": "OrderStatus"
    },
    "notes": "",
    "createdAt": "2018-09-25T15:04:57-0300",
    "customer": {
        "id": "1",
        "uid": "6b5ed84611d1e853e69dsdf65b7fdaee",
        "externalId": null,
        "name": "JACK BAUER",
        "document": {
            "number": "000.000.000-00",
            "type": "cpf",
            "object": "Document"
        },
        "phone": "(63) 0000-0000",
        "phoneMobile": "(63) 0000-0000",
        "email": "[e-mail]",
        "createdAt": "2016-01-11T18:43:50-0300",
        "object": "Customer"
    },
    "coupon": null,
    "payment": {
        "prepaid": false,
        "statusPayment": {
            "id": "3",
            "title": "COBRAR NA ENTREGA",
            "alert": "(!) Cobrar do consumidor na hora da entrega.",
            "object": "OrderPaymentStatus"
        },
        "paymentType": {
            "id": "9",
            "uid": "44f510f50asdf593bf60f55237dcaa49",
            "externalId": "ABC123",
            "paymentTypeParentId": "8",
            "environmentId": "2",
            "title": "Visa",
            "titleInternal": "MAQ. DÉBITO - VISA",
            "slug": "pos-debito-visa",
            "priority": "6",
            "active": true,
            "object": "PaymentType"
        },
        "amountCart": "233.00",
        "amountCartDiscount": "0",
        "amountShipment": "7.99",
        "amountShipment_discount": "0",
        "amountDiscount": "0.00",
        "amountTotal": "240.99",
        "amountChange": "0.00",
        "paymentAt": "2018-09-25T15:05:01-0300",
        "object": "Payment"
    },
    "cart": {
        "amountCart": "233.00",
        "amountCartDiscount": "0",
        "amountCartTotal": "233.00",
        "items": [
            {
                "id": "661031",
                "orderId": "400218",
                "salesProductId": "528",
                "salesProductUid": "a9ac085a69268f875dacaad44aa7d52a",
                "salesProductExternalId": null,
                "salesPricingId": "1",
                "notes": "",
                "quantity": "1",
                "amountUnit": "46.00",
                "amountTotal": "46.00",
                "title": "Pizza Média c/ 2 Sabores",
                "titleInternal": "",
                "items": [
                    {
                        "id": "1764195",
                        "orderSalesProductId": "661031",
                        "productId": "1251",
                        "productUid": "22723259db52d1a7a11a30fa90cbd64d",
                        "productExternalId": null,
                        "quantity": "1",
                        "amountUnit": "20.00",
                        "amountTotal": "20.00",
                        "title": "Abobrinha (Brasil Sabor 2015)",
                        "titleInternal": "Abobrinha (Brasil Sabor 2015)",
                        "object": "OrderInventoryProduct"
                    }
                ],
                "object": "OrderSalesProduct"
            },
            {
                "id": "661032",
                "orderId": "400218",
                "salesProductId": "529",
                "salesProductUid": "83adce58c81ab5427cca05a974d6543e",
                "salesProductExternalId": null,
                "salesPricingId": "1",
                "notes": "",
                "quantity": "1",
                "amountUnit": "73.00",
                "amountTotal": "73.00",
                "title": "Pizza Grande c/ 2 Sabores",
                "titleInternal": "",
                "items": [
                    {
                        "id": "1764199",
                        "orderSalesProductId": "661032",
                        "productId": "1321",
                        "productUid": "77ea6b2850343a7578a4ead3e407d772",
                        "productExternalId": null,
                        "quantity": "1",
                        "amountUnit": "29.00",
                        "amountTotal": "29.00",
                        "title": "Abobrinha (Brasil Sabor 2015)",
                        "titleInternal": "Abobrinha (Brasil Sabor 2015)",
                        "object": "OrderInventoryProduct"
                    }
                ],
                "object": "OrderSalesProduct"
            },
            {
                "id": "661033",
                "orderId": "400218",
                "salesProductId": "531",
                "salesProductUid": "51a7cdd734e64235e497a1bc9edb453f",
                "salesProductExternalId": null,
                "salesPricingId": "1",
                "notes": "",
                "quantity": "1",
                "amountUnit": "114.00",
                "amountTotal": "114.00",
                "title": "Pizza Big c/ 2 Sabores",
                "titleInternal": "",
                "items": [
                    {
                        "id": "1764203",
                        "order_sales_product_id": "661033",
                        "product_id": "1462",
                        "product_uid": "e29b958d3273e50dc8e5bc815acb106c",
                        "product_external_id": null,
                        "quantity": "1",
                        "amount_unit": "51.00",
                        "amount_total": "51.00",
                        "title": "Alcachofra",
                        "title_internal": "Alcachofra",
                        "object": "OrderInventoryProduct"
                    }
                ],
                "object": "OrderSalesProduct"
            }
        ],
        "object": "Cart"
    },
    "shipment": {
        "id": "400218",
        "shipment_plan_id": "2",
        "status_shipment": {
            "id": "1",
            "title": "Pendente",
            "object": "OrderShipmentStatus"
        },
        "amount_shipment": "7.99",
        "amount_shipment_discount": "0",
        "amount_shipment_total": "7.99",
        "delivery_at": "2018-09-25T15:04:57-0300",
        "nfse": "",
        "address_delivery": {
            "street": "X Sul Rua X QI X",
            "number": "Lote X",
            "complement": "Casa X",
            "district": "Plano Diretor Sul",
            "zip": "77015000",
            "state": "TO",
            "city": "Palmas",
            "reference": "Entre o 1 batalhão da PM e Bombeiro.",
            "latitude": null,
            "longitude": null,
            "object": "Address"
        },
        "address_pickup": {
            "street": "103 Norte Avenida Juscelino Kubitschek",
            "number": "159",
            "complement": "",
            "district": "Plano Diretor Norte",
            "zip": "77001014",
            "state": "TO",
            "city": "Palmas",
            "reference": "",
            "latitude": "-10.184235",
            "longitude": "-48.340089",
            "object": "Address"
        },
        "transport_type": {
            "id": 1,
            "title": "Moto",
            "object": "TransportType"
        },
        "package_type": {
            "id": 1,
            "title": "Bag (normal)",
            "object": "PackageType"
        },
        "slo": {
            "id": 1,
            "title": "Entrega imediata",
            "object": "SLO"
        },
        "driver": null,
        "carrier": {
            "id": "1",
            "title": "TNL PALMAS",
            "description": null,
            "image": null,
            "document": {
                "number": "27.692.571/0001-90",
                "type": "cnpj",
                "object": "Document"
            },
            "sponsor": "Darley Passarin",
            "phone": "(63) 3219-6900",
            "email": "[e-mail]",
            "address": {
                "street": "103 Sul Rua SO 5",
                "number": "18",
                "complement": "",
                "district": "Plano Diretor Sul",
                "zip": "77015018",
                "state": "TO",
                "city": "Palmas",
                "reference": "",
                "latitude": "-10.187481",
                "longitude": "-48.339311",
                "object": "Address"
            },
            "created_at": "2018-01-09T11:28:34-0300",
            "updated_at": null,
            "object": "Franchise"
        },
        "object": "Shipment"
    },
    "object": "Order"
}

/Order/Status

Representação do status geral do pedido

Especificação

ID	name	specification
1	Aberto	Pedido em execução
2	Concluído	Pedido entregue, concluído
3	Cancelado	Pedido cancelado/recusado
4	Análise	Pedido em análise pelo Tonolucro

Exemplo

{
    "id": "1",
    "title": "Aberto",
    "object": "OrderStatus"
}

/Order/Status/Payment

Representação do status de pagamento do pedido

Especificação

ID	name	specification
1	Pendente	Não foi escolhida a forma de pagamento
2	Pago Online	Foi pago online
3	Cobrar na Entrega	Deverá ser cobrado no momento da entrega do pedido
4	Análise	Pagamento em análise pelo Tonolucro

Exemplo

{
    "id": "3",
    "title": "COBRAR NA ENTREGA",
    "alert": "(!) Cobrar do consumidor na hora da entrega.",
    "object": "OrderPaymentStatus"
}

/Order/Status/Shipment

Representação dos status de preparação e entrega do pedido.

Especificação

ID	name	specification
1	Pendente	Pedido não aceito pelo estabelecimento
2	Produção	Pedido aceito e em produção
3	Saiu para entrega	Pedido saiu para entrega
4	Entregue	Pedido entregue/concluído
5	Cancelado	Pedido cancelado/recusado
6	Entregador na porta	Entregador chegou na porta do cliente
7	Coletado	Entregador coletou o produto
13	Pronto para coleta	Pedido pronto para coleta/entrega

Exemplo

{
    "id": "1",
    "title": "Pendente",
    "object": "OrderShipmentStatus"
}

/Order/Payment

Representação das informações de pagamento de um pedido

Especificação

attribute	type	specification
prepaid	boolean	Informa se o pedido já foi pago online para que o estabelecimento ou transportadora não precise cobrar do consumidor na ponta
status_payment	/Status/Payment	Status atual do pagamento
payment_type	/Order/Payment/Type	Tipo de pagamento escolhido
amount_cart	float	Valor total dos produtos do carrinho
amount_cart_discount	float	Valor de descontos nos produtos
amount_shipment	float	Valor da taxa de delivery
amount_shipment_discount	float	Desconto na taxa de delivery
amount_discount	float	Desconto total
amount_total	float	Valor final total
amount_change	float	Valor de troco, caso o cliente tenha escolhido a forma de pagamento em dinheiro
payment_at	string	Data/hora da escolha da forma de pagamento

Exemplo

{
    "prepaid": false,
    "status_payment": {
        "id": "3",
        "title": "COBRAR NA ENTREGA",
        "alert": "(!) Cobrar do consumidor na hora da entrega.",
        "object": "OrderPaymentStatus"
    },
    "payment_type": {
        "id": "9",
        "uid": "44f510f504b5a593bf60f55237dcaa49",
        "external_id": "ABC123",
        "payment_type_parent_id": "8",
        "environment_id": "2",
        "title": "Visa",
        "title_internal": "MAQ. DÉBITO - VISA",
        "slug": "pos-debito-visa",
        "priority": "6",
        "active": true,
        "object": "PaymentType"
    },
    "amount_cart": "233.00",
    "amount_cart_discount": "0",
    "amount_shipment": "7.99",
    "amount_shipment_discount": "0",
    "amount_discount": "0.00",
    "amount_total": "240.99",
    "amount_change": "0.00",
    "payment_at": "2018-09-25T15:05:01-0300",
    "object": "Payment"
}

/Order/Payment/Type

Representação dos tipos de pagamento.

Especificação

attribute	type	specification
id	integer	Identificador numérico
uid	string	Identificador único
external_id	string	Valor do objeto /ExternalID
payment_type_parent_id	integer	Identificador numérico de herança de outro tipo de pagamento
environment_id	integer	Identificador da forma de pagamento: 1 ONLINE; 2 NA ENTREGA;
title	string	Nome público
title_internal	string	Nome interno
slug	string	Identificador único para URL
priority	integer	Ordem numérica de forma crescente
active	boolean	Informa se o tipo de pagamento está ativo ou não

Exemplo

{
    "id": "9",
    "uid": "44f510f504b5a593bf60f55237dcaa49",
    "external_id": "ABC123",
    "payment_type_parent_id": "8",
    "environment_id": "2",
    "title": "Visa",
    "title_internal": "MAQ. DÉBITO - VISA",
    "slug": "pos-debito-visa",
    "priority": "6",
    "active": true,
    "object": "PaymentType"
}

/Order/Cart

Representação dos produtos vinculados a um pedido.

Especificação

attribute	type	specification
amount_cart	float	Valor do pedido
amount_cart_discount	float	Valor do desconto
amount_cart_total	float	Valor total dos produtos
items[]	array	Lista de anúncios /Order/Sales/Product

Exemplo

{
    "amount_cart": "233.00",
    "amount_cart_discount": "0",
    "amount_cart_total": "233.00",
    "items": [],
    "object": "Cart"
}

/Order/Sales/Product

Representação do vínculo entre carrinho de compras e anúncios.

Especificação

attribute	type	specification
id	integer	Identificador numérico
order_id	integer	Identificador numérico do pedido
sales_product_id	integer	Identificador numérico do anúncio /Sales/Product
sales_product_uid	string	Identificador único do anúncio /Sales/Product
sales_product_external_id	string	Identificador externo do anúncio /Sales/Product
sales_pricing_id	integer	Identificador numérico /Sales/Pricing
notes	string	Observações do consumidor em relação ao produto
quantity	integer	Quantidade de itens desse anúncio/pacote
amount_unit	float	Valor unitário
amount_total	float	Valor final
title	string	Nome público do anúncio
title_internal	string	Nome interno do anúncio
items[]	array	Lista de produtos /Order/Inventory/Product

Exemplo

{
    "id": "661031",
    "order_id": "400218",
    "sales_product_id": "528",
    "sales_product_uid": "a9ac085a69268f875dacaad44aa7d52a",
    "sales_product_external_id": null,
    "sales_pricing_id": "1",
    "notes": "",
    "quantity": "1",
    "amount_unit": "46.00",
    "amount_total": "46.00",
    "title": "Pizza Média c/ 2 Sabores",
    "title_internal": "",
    "items": [],
    "object": "OrderSalesProduct"
}

/Order/Inventory/Product

Representação dos produtos vinculados a um anúncio de um carrinho de compras.

Especificação

attribute	type	specification
id	integer	Identificador numérico
order_sales_product_id	integer	Identificador numérico /Order/Sales/Product
product_id	integer	Identificador numérico do /Inventory/Product
product_uid	string	Identificador único do /Inventory/Product
product_external_id	string	Identificador externo do /Inventory/Product
quantity	integer	Quantidade de produtos
amount_unit	float	Valor unitário
amount_total	float	Valor final
title	string	Nome público do /Inventory/Product
title_internal	string	Nome interno do /Inventory/Product

Exemplo

{
    "id": "1764195",
    "order_sales_product_id": "661031",
    "product_id": "1251",
    "product_uid": "22723259db52d1a7a11a30fa90cbd64d",
    "product_external_id": null,
    "quantity": "1",
    "amount_unit": "20.00",
    "amount_total": "20.00",
    "title": "Abobrinha (Brasil Sabor 2015)",
    "title_internal": "Abobrinha (Brasil Sabor 2015)",
    "object": "OrderInventoryProduct"
}

/Order/Shipment

Representação das informações do serviço de delivery.

Especificação

attribute	type	specification
id	integer	Identificador numérico
shipment_plan_id	integer	Identificador numérico do responsável pela entrega: 1 = Estabelecimento; 2 = Tonolucro
status_shipment	/Status/Shipment	Status atual do fluxo de produção e entrega
amount_shipment	float	Valor do frete
amount_shipment_discount	float	Valor de desconto no frete
amount_shipment_total	float	Valor final do frete
delivery_at	string	Data/hora de entrega no formato ISO8601
nfse	string	Link da NFSe após emissão
address_delivery	/Address	Endereço de entrega do consumidor
address_pickup	/Address	Endereço de coleta do estabelecimento
transport_type	/Transport/Type	Tipo do transporte: 1 = Moto
package_type	/Package/Type	Tipo do pacote: 1 = Bag (normal)
slo	/SLO	Nível de serviço: 1 = Entrega imediata
driver	/Driver	Pessoa responsável pela entrega
carrier	/Carrier	Transportadora responsável pela entrega

Exemplo

{
    "id": "372630",
    "shipment_plan_id": "2",
    "status_shipment": {
        "id": "4",
        "title": "Entregue",
        "object": "OrderShipmentStatus"
    },
    "amount_shipment": "5.99",
    "amount_shipment_discount": "0",
    "amount_shipment_total": "5.99",
    "delivery_at": "2018-07-02T19:28:30-0300",
    "nfse": "",
    "address_delivery": { },
    "address_pickup": { },
    "transport_type": {
        "id": 1,
        "title": "Moto",
        "object": "TransportType"
    },
    "package_type": {
        "id": 1,
        "title": "Bag (normal)",
        "object": "PackageType"
    },
    "slo": {
        "id": 1,
        "title": "Entrega imediata",
        "object": "SLO"
    },
    "driver": {
        "id": "540",
        "name": "FERNANDO DA SILVA",
        "phone_mobile": null,
        "document": null,
        "vehicle": null,
        "object": "Driver"
    },
    "carrier": {
        "id": "1",
        "title": "TNL PALMAS",
        "description": null,
        "image": null,
        "document": {
            "number": "27.692.571/0001-90",
            "type": "cnpj",
            "object": "Document"
        },
        "sponsor": "Darley Passarin",
        "phone": "(63) 3219-6900",
        "email": "[e-mail]",
        "address": {
            "street": "103 Sul Rua SO 5",
            "number": "18",
            "complement": "",
            "district": "Plano Diretor Sul",
            "zip": "77015018",
            "state": "TO",
            "city": "Palmas",
            "reference": "",
            "latitude": "-10.187481",
            "longitude": "-48.339311",
            "object": "Address"
        },
        "created_at": "2018-01-09T11:28:34-0300",
        "updated_at": null,
        "object": "Franchise"
    },
    "object": "Shipment"
}

/Order/Shipment/Transport/Type

Representação do tipo de transporte

Especificação

ID	title	specification
1	Moto	Transporte via Moto
2	Bicicleta	Transporte via Bicicleta
3	Carro	Transporte via Carro

Exemplo

{
    "id": 1,
    "title": "Moto",
    "object": "TransportType"
}

/Order/Shipment/Package/Type

Representação do tipo de armazenamento/pacote

Especificação

ID	title	specification
1	Bag (normal)	Mochila térmica
2	Bag (grande)	Mochila térmica grande
3	Caixa (normal)	Caixa fixa moto
4	Caixa (grande)	Caixa fixa moto grande

Exemplo

{
    "id": 1,
    "title": "Bag (normal)",
    "object": "PackageType"
}

/Order/Shipment/SLO

Representação do nível de atendimento

Especificação

ID	title	specification
1	Entrega imediata	Execução imediata do serviço
2	Entrega agendada	Execução agendada

Exemplo

{
    "id": 1,
    "title": "Entrega imediata",
    "object": "SLO"
}

/Driver

Representação das informações do profissiona motofretista.

Especificação

attribute	type	specification
id	integer	Identificador numérico
name	string	Nome do profissional
phone_mobile	string	Numéro do telefone celular
document	/Document	CPF/CNPJ
vehicle	/Vehicle	Informações do veículo

Exemplo

{
    "id": "1234",
    "name": "FERNANDO DA SILVA",
    "phone_mobile": null,
    "document": null,
    "vehicle": null,
    "object": "Driver"
}

/Driver/Vehicle

Representação das informações do veículo.

Especificação

attribute	type	specification
id	integer	Identificador numérico
driver_id	integer	Identificador numérico do /Driver
license_plate	string	Número da placa
type	string	Tipo do veículo
model	string	Modelo do veículo

Exemplo

{
    "id": "1234",
    "driver_id": "1234",
    "license_plate": "ABC-1234",
    "type": "Moto",
    "model": "CG Titan",
    "object": "Vehicle"
}

/Carrier

Representação das informações da pessoa jurídica responsável pela gestão da entrega.

Especificação

attribute	type	specification
id	integer	Identificador numérico
title	string	Nome fantasia
description	string	Descrição do perfil
image	string	Url do logotipo/imagem
document	/Document	CPF/CNPJ
sponsor	string	Nome do responsável
phone	string	Telefone institucional
email	string	E-mail institucional
address	/Address	Endereço do imóvel
created_at	string	Data/hora de criação no formato ISO8601
updated_at	string	Data/hora de atualização no formato ISO8601

Exemplo

{
    "id": "1",
    "title": "TNL PALMAS",
    "description": null,
    "image": null,
    "document": {
        "number": "27.692.571/0001-90",
        "type": "cnpj",
        "object": "Document"
    },
    "sponsor": "Darley Passarin",
    "phone": "(63) 3219-6900",
    "email": "[e-mail]",
    "address": {
        "street": "103 Sul Rua SO 5",
        "number": "18",
        "complement": "",
        "district": "Plano Diretor Sul",
        "zip": "77015018",
        "state": "TO",
        "city": "Palmas",
        "reference": "",
        "latitude": "-10.187481",
        "longitude": "-48.339311",
        "object": "Address"
    },
    "created_at": "2018-01-09T11:28:34-0300",
    "updated_at": null,
    "object": "Franchise"
}

/Customer

Representação das informações do consumidor.

Especificação

attribute	type	specification
id	integer	Identificador numérico
uid	string	Identificador único
external_id	string	Valor do objeto /ExternalID
name	string	Nome completo
document	/Document	CPF/CNPJ
phone	string	Telefone fixo
phone_mobile	string	Telefone celular
email	string	E-mail
created_at	string	Data/hora de criação no formato ISO8601

Exemplo

{
    "id": "36499",
    "uid": "2d272ead3dddbqeer03e930776d54d1",
    "external_id": null,
    "name": "JACK BOUER",
    "document": {
        "number": "000.000.000-00",
        "type": "cpf",
        "object": "Document"
    },
    "phone": "(63) 0000-0000",
    "phone_mobile": "(63) 000-000",
    "email": "[e-mail]",
    "created_at": "2016-01-11T18:43:50-0300",
    "object": "Customer"
}

/Coupon

Representação das informações de um cupom de desconto.

Especificação

attribute	type	specification
id	integer	Identificador numérico
title	string	Nome da campanha/promoção
code	string	Código do cupom

Exemplo

{
    "id": "1234",
    "title": "Dia do Cliente",
    "code": "ABC123",
    "object": "Coupon"
}