Você está vendo a versão antiga da página. Ver a versão atual.

Comparar com o atual Ver Histórico da Página

« Anterior Versão 2 Atual »

La API Delivery App atende para integraciones para PDV, Hub e Logistica, toda la documentación e la API pueden ser desarollado para las caracteristicas activas en la toda a plataforma Neemo.

Para la homologación de la integración fue enviado por correo electrónico las credenciales para lo entorno de prueba, recordando que este ambiente se comparte con otros socios que estão também em desarollo del integración, sin embargo, es necessario de atención en casos de grandes alterciones de menú.

Haga clic aquí acceder swagger para API de modificación de estado de los pedidos.

Actualmente hay dos niveles de integración:

  1. Integración de pedidos
  2. Integración de menú/productos



1. Integración de pedidos

Hay algunas APIs disponibles que permiten la integración de pedidos realizados por la plataforma Delivery App. Todas las APIs devuelven datos en formato JSON.

El flujo básico para la integración de pedidos consiste en:

    1.1.1 Listado de pedidos

    1.1.2 Lista de detalles del pedido

    1.1.3 Métodos de pago

    1.1.4 Cambiar el estado del pedido 

           1.1 API de pedidos

                   1.1.1 Listado de pedidos POST::/v1/order

El POS debe crear una rutina de consulta en el API de listado de pedidos, haciendo consultas alrededor de 60 segundos (recomendado no usar un tiempo más corto). Se devolverá una lista de pedidos, que debe ser escaneada, utilizando la identificación (ID) en el siguiente paso:

Es importante utilizar el parámetro de estado (status) para filtrar pedidos

                  0 = Nuevo pedido. 

                  1 = Confirmado. 

                  2 = Entregado. 

                  4 = Enviado / Listo. 

                  3, 5, 6, 7 = Pedidos cancelados.


El parámetro created_at devuelve pedidos creados a partir de la fecha ingresada, siendo útil para no traer las mismas solicitudes siempre que consultes la API.

  • id (integer): id de pedido
  • name (string): nombre del cliente
  • email (string): email del cliente
  • phone (string): telefono del cliente
  • date (string): fecha del pedido
  • updated_at (string): fecha de modificación del pedido
  • status (integer): 0 = Nuevo Pedido, 1 = Confirmado, 2 = Entregado, 3 = Cancelado (restaurante), 4 = Enviado/Expedido, 5 = Cancelado Automáticamente (sistema), 6 = Cancelado, con pago reembolsado (restaurante), 7 = Cancelado Automáticamente con Pago reembolsado (sistema), 8 = Esperando la aprobación del pago en línea, 9 = Pago en línea rechazado
  • tax (decimal): importe de la tarifa de envío del pedido
  • voucher_code (string): Código de cupón utilizado
  • voucher_discount (decimal): Descuento aplicado al pedido mediante el bono (cupón de descuento)
  • payment_method (string): forma de pago
  • notes (string): observaciones do pedido
  • street (string): calle para entrega
  • cep (string): Código postal para la entrega
  • number (string): numero para entrega
  • city (string): ciudad para la entrega
  • neighborhood (string): barrio para la entrega
  • complement (string): complemento de la dirección de entrega
  • reference_point (string): punto de referencia de la dirección de entrega
  • forma_entrega (integer): forma de entrega del pedido (1 = entrega, 2 = retira en la tienda, 3 = pedido en la mesa)
  • table_name (string): cuando form_delivery es 3, se devolverá el nombre de la tabla.
  • order_number (integer): numero de pedido
  • troco (decimal): cambiar a (cantidad que el cliente dará en efectivo)
  • client_id (integer): id de cliente
  • payment_online (boolean): si es true, el pago se realizó en línea a través de la aplicación o la web
  • latitude (decimal): latitud de la dirección de envío
  • longitude (decimal): longitud de la dirección de entrega
  • cpf_in_note (string): si tiene algún valor indica que el usuario solicitó NIT en la factura
  • printed (boolean): si se imprimió el comando de la orden
  • total_discount (decimal): descuento total que recibió el pedido
  • taxa_extra (decimal): monto de tarifa adicional
  • taxa_extra_title (string): título de lo que se cobró como tarifa adicional
  • sub_total (decimal): subtotal del pedido (total de productos comprados)
  • total (decimal): pedido total, importe pagado por el cliente (incluidos gastos de envío, tarifas y descuentos)


                   1.1.2 Lista de detalles del pedido POST::/v1/order/{order_id}

Es en esta API donde el POS integrará los productos vendidos. La consulta en la API de detalles del pedido devolverá todos los detalles de la venta, así como los productos vendidos.

Las mismas devoluciones de la API de listado de pedidos, más las siguientes devoluciones:

  • fidelity_program_discount (decimal): descuento recibido a través del programa de fidelización.
  • FidelityProgram (array): información del programa de fidelización.
  • Payment (array): información de pago en línea.
  • Vouchers (array): informaciones del cupón (cupón de descuento).
  • ItemOrder (array): información sobre los productos del pedido.
  • PizzaOrders (array): información sobre las pizzas del pedido.
  • ComboOrders (array): información sobre los combos del pedido.
  • OrderAdditionals (array): información sobre adicionales del pedido.
  • PromotionGroupOrders (array): información sobre combos promocionales.


Detallando las matrices (arrays) anteriores:

FidelityProgram: 

  • award (string): texto con el premio del programa de fidelización. Ej. "$2000", "Entrega gratuita", "1 refresco"
  • award_item (string): solo cuando el premio sea un producto o regalo, por ejemplo un producto en el menú “1 coca-cola 2 litros”, este valor también vendrá en el award


Payment (pago): 


Vouchers(cupónes):

  • voucher_discount (decimal): monto de descuento recibido por el cupón
  • voucher_code (string): código de descuento utilizado


ItemOrder (producto):

  • title (string): titulo del producto
  • quantity (integer): cantidad del producto
  • name (string): nombre de variación del artículo   
  • price (decimal): precio del ítem
  • total (decimal): total pagado por el artículo (incluye suplementos y cantidad)
  • notes (string): notas para este artículo
  • ref (string): REF del ítem (codigo POS)
  • variacao_ref (string): variación REF
  • ComplementCategories (array): cada categoría de complementos puede contener varios complementos. Ej: categoría de complemento “Adicionales”.
    • quantity (integer): cantidad de complementos
    • title (string): título del complemento
    • price_un (decimal): precio unitario del complemento
    • total (decimal): total pagado por el complemento
    • ref (string): Codigo REF del complemento (Cod POS)
    • title (string): título de categoría de complemento
    • Complements (array): contiene complementos de categoría


PizzaOrders

  • quantity (integer): cantidad de la pizza
  • total_un (decimal): total pagado unitario por la pizza
  • notes (string): notas de la pizza
  • pizza_maior_valor (boolean): true - se cobró el valor más alto de los sabores. False - se calculó el promedio de los sabores
  • PizzaTamanho (array): información sobre el tamaño de la pizza
    • title (string): titulo del tamaño
    • qtd_sabor (integer): cantidad de sabor de la pizza
    • ref (string): REF del tamaño (Codigo POS)
    • ComplementCategories (array): sigue el mismo modelo que los productos (ItemOrder)
  • PizzaMassa (array): información sobre masa/borde de la pizza
    • title (string): titulo de la masa/borde
    • price (decimal): precio de la masa/borde
    • ref (string): REF de massa/borde (codigo POS)
  • PizzaSabor (array): Información sobre los sabores de la pizzas
    • title (string): título de sabor
    • price (decimal): precio de sabor
    • ref (string): REF de sabor (codigo POS)
    • ref_sabor_tamanho (string): REF de sabor vinculado al tamaño
    • ComplementCategories (array): sigue el mismo modelo que los productos (ItemOrder)


ComboOrders

  • quantity (integer): cantidad del combo
  • total_un (decimal): total unitario del combo
  • combo_title (string): titulo del combo
  • ref (string): REF del combo (codigo POS)
  • ComboItens (array): productos pedidos dentro del combo
    • price (decimal): precio de lo producto
    • item_name (string): nombre del producto
    • price_name (string): nombre de la variación del producto
    • ref (string): REF del producto (codigo POS)
    • variacao_ref (string): REF de la variación (codigo POS)


OrderAdditionals

  • title (string): titulo de la categoría de adicional
  • text_input (boolean): true - adicional fue informado mediante entrada de texto. False - adicional se eligió mediante selección de cantidad.
  • Additionals (array): adicionales que el usuario ha elegido
    • ref (string): REF del adicional (codigo POS)
    • quantity (integer): cantidad elegida
    • price_un (decimal): valor unitario del adicional
    • text_input (string): entrada de texto informado por el usuario, en caso de el parámetro text_input en OrderAdditionals es verdadero.


PromotionGroupOrders

  • id (integer): ID de grupo de promoción.
  • name (string): nombre de grupo de promoción.
  • quantity (integer): cantidad elegida.
  • notes (string): observación.
  • type (integer): regla de cálculo de promoción. 1 = suma total (suma de todos los productos de la promoción). 2 = valor más alto (se cobra el precio del producto de valor más alto). 3 = nuevo precio (un precio fijo para la promoción, independientemente de los productos elegidos).
  • value (decimal): precio unitario pagado en la promoción.
  • ref (string): codigo de referencia del producto, para integración (codigo POS)
  • bonus 
    • type (integer): tipo de bonificación de promoción.

                                 1 = Ninguno.

                                 2 = Envío gratuito.

                                 3 = Puntos en el Programa de Fidelización.

                                 4 = regalo

  • value (string): si type es 1, devuelve nulo. De lo contrario, se devolverá el bono.
  • Products (Array)
    • id (integer): id de la opción
    • title (string): titulo de la opción
    • price_un (decimal): precio unitario
    • quantity (integer): cantidad
    • subtotal (decimal): subtotal de la opción
    • ComplementCategories (Array)
      • id (integer): id del complemento
      • title (string): titulo del complemento
      • price_un (decimal): precio del unitario
      • quantity (integer): cantidad
      • ref (string): codigo POS de integración
      • subtotal (decimal): subtotal del complemento
      • id (integer): id de la categoria de complemento
      • title (string): titulo de la categoria de complementos
      • Complements (Array)
    • id (integer): ID del producto
    • type (string): tipo de producto. Puede devolver ‘item’ o ‘pizza’. 
    • name (string): nombre do produto
    • calculation (integer):
    • quantity (integer): siempre será 1
    • subtotal (decimal): subtotal de los productos
    • Options (Array): las opciones son los ítems (productos) / pizzas adquiridos

                   1.1.3 Métodos de pago

Haga clic aqui para ir a la prueba y puede comprobar la api de POST

Plantilla  json para enviar al servidor:

{

  "token_account": "s6s7sd678dd86s8fh69hj54465df"

}



Plantilla JSON de la respuesta del servidor

{

  "code": 200,

  "name": "Success",

  "payment_methods": [

    "Dinheiro",   

    "Débito Mastercard",

    "Débito Visa",

    "Elo",

    "Crédito Hipercard"

  ],

  "payment_options": [

    {

      "name": "Dinheiro",

      "ref": "106"

    },

    {

      "name": "Débito Mastercard",

      "ref": "100"

    },

    {

      "name": "Débito Visa",

      "ref": "101"

    },

    {

      "name": "Débito Elo",

      "ref": "105"

    } 

]

}


                   1.1.4 Cambiar el estado del pedido

Es muy importante que el POS notifique a API Delivery cuando haya un cambio de estado (confirmación del pedido, pendiente de entrega, etc...), y especialmente si hay una cancelación. Debido a que API Delivery notificará al consumidor por correo electrónico y notificaciones automáticas, esta notificación se realiza a través de la API de cambio de estado.



           2.1. Integración de menú/productos

Se encuentran disponibles también algunas API que permiten la integración de menús con la plataforma Delivery App, permitiendo al POS consultar y registrar productos, pizzas y categorías y cambiar su disponibilidad.

                  2.1.1 API de produtos

La API del menú permite la actualización de los productos del menú, pudiendo cambiar el título y la disponibilidad, y también permite actualizar las variaciones de los productos, permitiendo cambiar precio, título y disponibilidad. También permite el registro de Categorías y Pizzas.

                      2.1.1.1 Registro de categoría

Haga clic aquí para ir a la prueba y puede comprobar la api de POST

Plantilla json que se enviará en el cuerpo de la solicitud:

{

    "token_account": "871523671eg93jhe91e139e1",

    "title": "Refrigerantes",

    "available": true,

    "pizza": true,

    "out_id": "123456"

}

           

  • token_account [string]:  token de autenticación de la tienda.
  • title [string]: titulo de la categoria.
  • available [boolean]: true = activado, false = deactivado
  • out_id [string]: código POS.
  • pizza [boolean]: envíe true se va a utilizar la categoría para registro de PizzaTamanho y PizzaSabor


En caso de éxito, la devolución de la solicitud será:                   

{

    "code": 201,

    "name": "Category success created",

    "id": 456

}


El retorno code: 201 significa que la categoría se ha registrado correctamente. El ID es la identificación interna de la categoría en Delivery App.

                  2.1.2 Actualización de categoría

Haga clic aquí para ir a la prueba y puede comprobar la api de PUT.

Plantilla json que se enviará en el cuerpo de la solicitud:

{

"token_account": "7339afcfc50ccd855a13f186516cbdd0",

"Categories": [{

"ref": "3et267er",

"title": "INTEGRAÇÃO 2",

"available": false

}, {

"ref": "3et267er",

"title": "INTEGRAÇÃO 2",

"available": false

}]

}


  • token_account [string]: token de autenticación de la tienda.
  • Categories [Array]: Categorias que van a ser actualizadas
  • ref [string]: odigo de referencia (mismo out_id del cadastro) de lo sistema integrado. El ref se utiliza para consultar la categoría que se actualizará.
  • title [string]: titulo de la categoria.
  • available [boolean]: true = activado, false = deactivado


En caso de éxito, la devolución de la solicitud será:

{

    "code": 200,

    "name": "success",

    "Results": [

        {

            "ref": "123456",

            "updated": true,

            "message": "Categoria atualizada",

            "Errors": []

        },

        {

            "ref": "12121212",

            "updated": false,

            "message": "Categoria não encontrada",

            "Errors": [

                "Categoria não encontrada com código ref informado"

            ]

        }

    ]

}

Cada categoría tiene su retorno individual, cuando se actualice con éxito se devolverá updated: true.

                  2.1.3 Atualización de producto

Haga clic aqui para ir a la prueba y puede comprobar la api de PUT.

Plantilla json que se enviará en el cuerpo de la solicitud:

{

    "token_account": "7339afcfc50ccd855a13f186516cbdd0",

    "Items": [

    {

    "ref": "23009",

    "title": ””,

    "enable": true,

    "intro": "descrição do item"

    },

    {

    "ref": "55100",

    "title": "Coca Cola 2 litros",

    "enable": false

    }

    ]

}

          

  • ref [string]: código de enlace del producto entre el sistema Delivery App y el sistema que se va a integrar.
  • title [string]:nuevo título del artículo, pase vacío o null si el título no se va a cambiar.
  • enable [boolean]: ambia la disponibilidad del artículo (producto), pase null si la disponibilidad no va a cambiar
  • intro [string]:  texto de la introducción / descripción del artículo (producto).


En caso de éxito, la devolución de la solicitud será:           

{

    "code": 200,

    "name": "Success",

    "Results": [{

    "ref": "23009",

    "updated": true,

    "message": ""

    },

    {

    "ref": "55100",

    "updated": true,

    "message": ""

    }

    ]

}

La devolución informa individualmente si el artículo fue actualizado o no. Si updated = true, el artículo se actualizó exitosamente, si es falso, no fue posible actualizar y el message debe contener el motivo de no haber actualizado.

                  2.1.4 Atualización de variación

Haja clic aqui para ir a la prueba y puede comprobar la api de PUT.

Plantilla json que se enviará en el cuerpo de la solicitud:

{

"token_account": "7339afcfc50ccd855a13f186516cbdd0",

"Variants": [{

    "item_ref": "23009",

    "ref": "55020",

    "price": 12.4,

    "enable": true,

    "title": "2 litros",

                           "promotional_price": 0.0,

         },

         {

    "item_ref": null,

    "ref": "40020",

    "price": 18.99,

    "enable": false,

    "title": ""

     }]

}


  • item_ref [string]: código de enlace del artículo que contiene la variación que se actualizará entre el sistema Delivery App y el sistema que se integrará.
  • ref [string]: código de enlace de la variación entre el sistema Delivery App y el sistema a integrar.
  • price [decimal]: nuevo precio para actualizar, pasar null si no se actualiza.
  • enable [boolean]: cambia la disponibilidad de la variación, pasa null si no se actualiza.
  • title [string]: nuevo título de variación, pase vacío o null si no está cambiando el título.
  • promotional_price [decimal]:  valor decimal que indica el precio promocional del valor de variación del artículo. Para eliminar la promoción de un artículo, simplemente pase 0.0.
  • item_ref no es obligatorio (se puede enviar null), ya que algunas integraciones usan solo el enlace en la variación. Su uso es importante en los casos en que la variación pueda repetir la referencia para diferentes elementos, por lo que será necesario identificar a qué elemento pertenece la variación que se actualiza.


En caso de éxito, la devolución de la solicitud será:

{

    "code": 200,

    "name": "Success",

    "Results": [{

    "ref": "55020",

    "updated": true,

    "message": ""

    },

    {

    "ref": "40020",

    "updated": false,

    "message": "mais de uma variação encontrada com o mesmo ref"

    }

    ]

}

La devolución informa individualmente si la variación fue actualizada o no. Si updated = true, la variación se actualizó exitosamente, si es falso, no fue posible actualizar y el message debe contener el motivo de no haber actualizado.

                  2.1.5 Regístro del ítem/prodcto

Haja clic aquí para ir a la prueba y puede comprobar la api de POST.

Plantilla json que se enviará en el cuerpo de la solicitud:

{

"token_account": "token_integracao",

"Items": [{

      "category_id": 4,

      "title": "title123",

      "intro": "descrição de item",

      "enable": true,

      "ref": "ref654",

      "only_scheduling": false,

      "Prices": [

        {

          "name": "price123",

          "value": 1.6,

          "enable": true,

          "promotional_price": 1.5,

          "promotion_enable": true,

          "ref": "ref234"

        }

      ]

    }]

}


  • category_id [int]: código de enlace de artículo que hace referencia a qué categoría de artículo.
  • title [string]: string que indica el titulo (nombre) del producto/ítem.
  • intro [string]: string que indica la descrición inicial del producto. 
  • enable [boolean]: cambia la disponibilidad del producto, pase null si no se actualiza.
  • only_scheduling [boolean]: si true, el ítem está disponiblie solo para agendamento disponível apenas para programación.
  • ref [string]: código de enlace del artículo entre el sistema Delivery App y el sistema que se va a integrar.
  • Prices: {
    •  name [string]: string que se refiere al nombre de la variación del artículo.
    •  value [decimal]:  valor decimal que indica el precio de la variación del artículo
    •  enable [boolean]: cambia la disponibilidad de la variación del artículo, pasa null si no se actualiza.
    •  promotional_price [decimal]: valor decimal que indica el precio promocional del valor de variación del artículo.
    • promotion_enable [boolean]: cambia la disponibilidad del precio promocional de la variación del artículo.
    •  ref [string]: código de enlace de la variación entre el sistema Delivery App y el sistema a integrar.

                     }


En caso de éxito, la devolución de la solicitud será:

{

  "code": 200,

  "name": "Success",

  "Results": [

    {

      "id": 734,

      "ref": "ref789",

      "inserted": true,

      "message": "Item cadastrado com sucesso",

      "Prices": [

        {

          "id": 1224,

          "ref": "ref234",

          "inserted": true,

          "message": "Price cadastrado",

          "Errors": {}

        }

      ],

      "Errors": {}

    }

  ]

}

La devolución informa si el artículo se registró con "message: item cadastrado com sucesso".

                  2.1.6 Registro de variación del producto

Haja clic aqui para ir a la prueba y puede comprobar la api de POST.

Plantilla json que se enviará en el cuerpo de la solicitud:

{

  "token_account": "7efdf38d0bdd899c06c72f6b2b6fa7db",

  "Variants": [

    {

      "name": "name123",

      "value": 1.6,

      "enable": true,

      "promotional_price": 1.5,

      "promotion_enable": true,

      "ref": "ref432",

      "item_id": 677

    }

  ]

}


  • name [string]: string que se refere ao nome da variação do item.
  • value [decimal]: valor decimal que indica o preço da variação do item.
  • enable [boolean]: altera a disponibilidade da variação do item, passar null se não for atualizar.
  • promotional_price [decimal]:  valor decimal que indica o preço promocional referente ao valor da variação do item.
  • promotion_enable [boolean]: altera a disponibilidade do preço promocional da variação do item.
  • ref [string]: código de vinculação da variação entre o sistema Delivery App e o sistema a ser integrado.
  • item_id [int]: código que faz referência a qual item a variação vai ser associada.


En caso de éxito, la devolución de la solicitud será:

{

  "code": 200,

  "name": "Success",

  "Results": [

    {

      "id": 1225,

      "ref": "ref432",

      "inserted": true,

      "message": "Variação cadastrado com sucesso",

      "Errors": {}

    }

  ]

}

La devolución informa si el artículo fue registrado con  "message: Variação cadastrado com sucesso".

                  2.1.7 Registro del adicionales global

Haja clic aqui para ir a la prueba y puede comprobar la api de POST.

Plantilla json que se enviará en el cuerpo de la solicitud: 

{

"token_account": "c952f82f05318d398821111109a0c7d2",

"Complements": [{

"title": "bacon",

"description": "bacon fatiado",

"enable": true,

"price": 3,

"ref": "222222",

"code": "10"

}, {

"title": "",

"description": "",

"enable": false,

"price": 3.99,

"ref": "333333",

"code": "10"

  }]

}

  • *title [string] - Titulo adicional
  • description [string] - Decisión del adicional
  • enable [boolean] - Adicional activo/inactivo
  • *price [decimal] - Precio del adicional
  • ref [string] - Código de referencia para la integración
  • code [string] - Código para identificación interna del adicional

                                                                                               *obligatorios

En caso de éxito, la devolución de la solicitud será:

{

  "code": 200,

  "name": "Success",

  "Results": [

    {

      "ref": "222222",

      "inserted": true

    },

    {

      "ref": "333333",

      "inserted": false,

      "message": "Erro de cadastro de complemento",

      "Errors": [

        "Título não pode ficar em branco",

        "Título não pode ficar em branco"

      ]}

  ]

}


                        2.1.7.1 Registro del categoria de adicionales y grupos del adicinal

Haja clic aqui para ir a la prueba y puede comprobar la api de POST.

Plantilla json que se enviará en el cuerpo de la solicitud:

{

"token_account": "7efdf38d0bdd899c06c72f6b2b6fa7db",

"ComplementCategories": [{

"ref": "111111",

"title": "Adicionais de lanche 2",

"code": "integracao",

"minimum": 0,

"maximum": 5,

"enable": true,

"more_than_one": true,

"Complements": ["ref_complemento", "ref_complemento"]

}, {

"ref": "222222",

"title": "Adicionais de lanche",

"code": "integracao",

"minimum": 0,

"maximum": 1,

"enable": true,

"more_than_one": true,

  "Complements": []

}]

}


  • ref [string] - Código de referencia para la integración
  • *title [string] - Título de adicional
  • code [string] - Código para la identificación interna del adicional
  • *minimum [integer] - Minimo de adicionales que puedem ser escolhido
  • *maximum [integer] - Máximo de adicionales que pueden ser escolhido
  • enable [boolean] - Adicional activo/inactivo
  • more_than_one [boolean] - Indica si se permite elegir más de una unidad del mismo adicional
  • Complements [Array] - Array de referencia de los adicionales qué faraón es parte del grupo.

                                                                                                                                                                *obligatorios

  • minimum deve ser >= 0 e < maximum
  • maximum deve ser > 0


En caso de éxito, la devolución de la solicitud será:

{

  "code": 200,

  "name": "Success",

  "Results": [

    {

      "ref": "111111",

      "inserted": true

    },

    {

      "ref": "222222",

      "inserted": false,

      "message": "parâmetro Complements não encontrado ou vazio",

      "Errors": [

        "parâmetro Complements não encontrado ou vazio"

      ]

    }

  ]

}


                        2.1.7.2 Enlace grupos de adiconal al ítem

Haja clic aqui para ir a la prueba y puede comprobar la api de POST.

Plantilla json que se enviará en el cuerpo de la solicitud:

{

"token_account": "d952b77f05317d598001f7b109a0c7d2",

"Items": [{

"ref": "8804505",

"ComplementCategories": ["1001301", "2001302"]

},

{

"ref": "1505",

"ComplementCategories": ["1001301"]

},

{

"ref": "8804505",

"ComplementCategories": ["9199"]

}]

}


  • ref [string] - Código de referencia del ítem que será enlazado en los grupos de los adicionales.
  • ComplementCategories [Array] - Array de referencias de lo grupo de adicional qué será enlazado al ítem.


En caso de éxito, la devolución de la solicitud será:

{

  "code": 200,

  "name": "Success",

  "Results": [

    {

      "ref": "8804505",

      "inserted": true

    },

    {

      "ref": "1505",

      "inserted": false,

      "message": "Item não encontrado",

      "Errors": [

        "Item não encontrado"

      ]

    },

    {

      "ref": "8804505",

      "inserted": false,

      "message": "Grupos de complemento não encontrado",

      "Errors": [

        "Grupos de complemento não encontrado"

      ]}

  ]

}

                  2.1.8 Cadastro de complementos padrão

Haja clic aqui para ir a la prueba y puede comprobar la api de POST.

ATENCIÓN!

Esta funcionalidad quedará obsoleta.


Plantilla json que se enviará en el cuerpo de la solicitud:

{

    "token_account": "token",

    "ComplementCategories": [{

            "item_id": 742,

     "title": "INTEGRAÇÃO",

     "minimum": 0,

     "maximum": 6,

     "ordem": 1,

     "enable": true,

     "more_than_one": true,

     "ref": "ref222",

     "Complements": [{

                 "title": "integração",

                 "description": "descrição do complemento",

                 "enable":  true,

                 "price":  3.4,

                 "ref":"ref333"

            }]

    }]

}


    • item_id [int]: string que se refiere al nombre de variación del producto.
    • title [string]: nuevo título de adicionale, pasar vazio ou null si no cambia el titulo.
    • minimum [int]: indica la cantidad mínima de adicionale en lo producto referenciado.
    • maximum [int]: indica la cantidad máxima de adicionale en lo producto referenciado.
    • ordem [int]: ordem a ser exibida lo adicional (default será el orden de regístro).
    • enable [boolean]: cambiar la disponibilidad de los adicionales en lo producto.
    • more_than_one [boolean]: indica se poderá ser escolhido mais que uma unidade do mesmo complemento pertencente a essa categoria.
    • ref [string]: código de vinculación del adicionale entre lo sistema Delivery App y lo sistema haja ser integrado.
  • Complements: {
    • title [string]: nuevo titulo de adicionale, se pasar vazio ou null si no cambia el titulo.
    • description [string]: breve texto que irá descrever o complemento.
    • complement_category_id [int]: faz referência do complemento com a categoria do mesmo.
    • enable [boolean]: altera a disponibilidade do complemento, passar null se não for atualizar.
    • price [decimal]: valor que indica o preço do complemento.
    • ref [string]:  código de vinculação do complemento entre o sistema Delivery App e o sistema a ser integrado.

                                    }


En caso de éxito, la devolución de la solicitud será:

{

  "code": 200,

  "name": "Success",

  "Results": [

    {

      "id": 323,

      "ref": "ref123",

      "inserted": true,

      "message": "Complemento(s) cadastrado(s)",

      "Complements": [

        {

          "id": 698,

          "ref": "ref123",

          "inserted": true,

          "message": "Complemento cadastrado",

          "Errors": {}

        }

      ],

      "Errors": {}

    }

  ]

}

La devolución informa si el artículo fue registrado con "message: Complemento cadastrado".

                  2.1.9 Regístro de sabor de pizza

Haja clic aqui para ir a la prueba y puede comprobar la api de POST.

Plantilla json que se enviará en el cuerpo de la solicitud:

{

    "token_account": "token_de_integracao",

    "sabores": [

        {

            "title": "4 Queijos",

            "description": "pizza 4 queijos",

            "enable": true,

            "ordem": 1,

            "id_categoria": 176,

            "ref": "ref234",

            "preco_tamanho": [

                {

                    "ref": "ref234",

                    "price": 1.6,

                    "id_tamanho": 196,

                    "enable": true

                }

            ] }

    ]}


    • title [string]: novo titulo de adicional, pasar vazio ou null si no cambia lo titulo.
    • description [string]: breve texto que describirá lo adicional.
    • enable [boolean]: cambio la disponibilidad del sabor, pasar null se no actualiza.
    • ordem [int]: ordenación de los sabores.
    • id_categoria [int]:  código de referencia de lo sabor con su categoría.
    • ref [string]:  código de vinculación de lo sabor entre o sistema Delivery App e o sistema a ser integrado.
  • preco_tamanho: 
    • ref [string]: código de unión de lo sabor en lo tamaño entre o sistema Delivery App e o sistema a ser integrado.
    • price [decimal]valor que indica lo preço de lo sabor del tamaño escolhido.
    • id_tamanho [int]: código de vinculación del tamanho que referencia qual o sabor de la pizza.
    • enable [boolean]: cambie la disponibilidad del sabor, pasar null si no actualiza.

     

En caso de éxito, la devolución de la solicitud será:

{

  "code": 200,

  "name": "Success",

  "Results": [

    {

      "ref": "ref234",

      "inserted": true,

      "message": "Sabor cadastrado"

    } ]

}

La devolución informa si el artículo fue registrado con  "message: Sabor cadastrado".

                  2.1.10 Inscripción en la categoría de sabor a pizza

Haja clic aqui para ir a la prueba y puede comprobar la api de POST.

Plantilla json que se enviará en el cuerpo de la solicitud:

{

    "token_account": "token_de_integracao",

    "Categorias": [

        {

            "enable": true,

            "maximum": 6,

            "minimum": 2,

            "ref": "ref897",

            "pizza_sabor_id": 11,

            "title": "titulo 2",

            "more_than_one": false,

            "Complementos": [

                {

                    "title": "Nome complemento 1",

                    "description": "fffgggf",

                    "enable": true,

                    "ref": "ref789",

                    "Prices": [

                        {

                            "pizza_tamanho_id": 11,

                            "price": 1.7,

                            "ref": "ref234"

                        }

                    ]

                }

            ]

        }

    ]

}


    • enable [boolean]: cambie la disponibilidad de los sabores en la pizza.
    • maximum [int]: cantidad máxima de adicionales que se pueden elegir.
    • minimum [int]: cantidad mínima de adicionales que se pueden elegir.
    • ref [string]: código de unión de la variación entre o sistema Delivery App e o sistema a ser integrado.
    • pizza_sabor_id [int]: ID del sabor de la pizza que estará vinculado a la categoría de adicional.
    • title [string]: nuevo titulo de la categoría, pasar vazio ou null si no cambia lo titulo.
    • more_than_one [boolean]: indica se poderá  elegir más que una unidad de lo mismo adicional pertenciente a esta categoría.
  • Complementos: 
      • title [string]: titulo/nombre de lo adicional.
      • description [string]breve texto que describirá el complemento.
      • enable [boolean]: cambio la disponibilidad del sabor de la pizza.
      • ref [string]: código de enlace entre o sistema Delivery App e o sistema a ser integrado.
  • Prices: 
      • pizza_tamanho_id [int]: código de enlace adicional a un tamaño determinado.
      • price [decimal]: precio del adicional.
      • ref [string]: código de enlace adicional entre o sistema Delivery App e o sistema a ser integrado.


En caso de éxito, la devolución de la solicitud será:

{

  "code": 200,

  "name": "Success",

  "Results": [

    {

      "inserted": true,

      "ref": "ref897",

      "id": 452,

      "Complementos": [

        {

          "ref": "ref789",

          "id": 1525,

          "Prices": [

            {

              "ref": "ref789",

              "id": 1525

            },

          ]

        }

      ]

    }

  ]

}

La devolución informa individualmente si el artículo ha sido actualizado o no, si inserted = true, el ítem ha sido actualizado con éxito, si no, no es posible actualizar y la message deberá informar la razón de no actualizar.

                  2.1.11Registro del tamaño de la pizza

Haja clic aqui para ir a la prueba y puede comprobar la api de POST.

Plantilla json que se enviará en el cuerpo de la solicitud:

{

    "token_account": "token_de_integracao",

    "Tamanhos": [

        {

"title": "Tamanho 1",

"dois_sabor": true,

"tres_sabor": true,

"quatro_sabor": true,

"enable": true,

"ordem": 1,

"category_id": 176,

"ref": "ref123",

            "balcao": false

        } ]

}


  • title [string]: nuevo titulo del tamaño, pasar vazio ou null lo que no cambio el titulo.
  • dois_sabor [boolean]: si es true, indica que la pizza acepta dos sabores.
  • tres_sabor [boolean]: si es true, indica que la pizza acepta tres sabores.
  • quatro_sabor [boolean]: si es true, indica que la pizza acepta cuatro sabores.
  • enable [boolean]: cambio la disponibilidad del tamaño de la pizza.
  • ordem [int]: ordenacíon do tamanho de la pizza.
  • category_id [int]:  vinculación de ítem que referencia cual la categoría del ítem.
  • ref [string]: código de enlace del tamaño de la pizza entre o sistema Delivery App e o sistema a ser integrado.
  • balcao [boolean]: si es true, lo tamaño de la pizza solo estará disponible para retiro en tienda.


En caso de éxito, la devolución de la solicitud será:

{

  "code": 200,

  "name": "Success",

  "Results": [

    {

      "inserted": true,

      "ref": "ref123",

      "id": 232

    }

  ]

}

La devolución informa individualmente si el artículo fue actualizado o no, si inserted = true, el ítem fue actualizado con éxito, si es falso, no fue posible actualizar y el mensaje debe contener el motivo por la cual no se actualizó.

                  2.1.12 Registro de categoría de tamaño de pizza

Haja clic aqui para ir a la prueba y puede comprobar la api de POST.

Plantilla json que se enviará en el cuerpo de la solicitud:

{

    "token_account": "token_de_integracao",

    "Categorias": [

        {

            "enable": true,

            "title": "title1",

            "minimum": 1,

            "maximum": 2,

            "ref": "ref345",

            "pizza_tamanho_id": 11,

            "more_than_one": true,

            "Complementos": [

                {

                    "enable": true,

                    "title": "title2",

                    "description": "description123",

                    "ref": "ref534",

                    "price": 4.7

                } ]

        } ]

}


    • enable [boolean]: cambio la disponibilidad del item, pasar null si no actualiza.
    • title [string]: nuevo titulo del tamaño, pasar vazio ou null si no cambia el titulo.
    • maximum [int]: cantidad máxima de adicionales que se poderá elegir.
    • minimum [int]: cantidad mínima de adicionales que se poderá elegir.
    • ref [string]: código de enlace del tamaño de la pizza entre o sistema Delivery App e o sistema a ser integrado.
    • pizza_tamanho_id [int]: código de enlace del tamaño que referencia en la categoria del tamanho.
    • more_than_one [boolean]: indica se puede elegir más que una unidad del mismo adicional pertenciente a esa categoría.
  • Complementos : 
      • enable [boolean]: cambiar disponibilidad del adicional, pasar null si no actualiza.
      • title [string]: nuevo titulo del adicional, pasar vazio ou null si no actualiza em titulo.
  • description [string]:
    • ref [string]: código de enlace delo tamaño de la pizza entre o sistema Delivery App e o sistema a ser integrado.
    • price [decimal]: precio del adicional.


En caso de éxito, la devolución de la solicitud será:

{

  "code": 200,

  "name": "Success",

  "Results": [

    {

      "inserted": true,

      "ref": "ref345",

      "id": 129,

      "Complementos": [

        {

          "ref": "ref534",

          "id": 328

        }]

    }]

}

La devolución informa individualmente si el artículo fue actualizado o no, si inserted = trueel artículo fue actualizado correctamente, si es falso, no fue posible actualizar y el mensaje debe contener el motivo por el cual no se actualizó.

  • Sem rótulos