The Delivery App's API meets integrations for POS, Hub and Logistics, all documentation and API can be developed for the active features across the Neemo platform.

For the approval of the integration, the credentials for the test environment were sent along with the Email, remembering that this environment is shared by several partners who are also developing the integration, however, attention is needed in cases of major menu changes.

Click here to access swagger for order status change API.

There are currently three levels of integration:

1. Order integration.
2. Menu integration.
3. Webhook request.

1. Order Integration

Some APIs are available that allow the integration of orders made through the Delivery App platform. All APIs return data in JSON format.

O fluxo básico para integração de pedidos consiste em:

1.1.1 Order list.

1.1.2 Order details.

1.1.3 Payment methods.

1.1.4 Change order status.

           1.1 Order API

                   1.1.1 Order listing POST::/v1/order

The POS should create a query routine in the order listing API, making queries around 60 seconds (recommended not to use a shorter time). A list of orders will be returned, which must be traversed, using the ID in the next step:

It is important to use the status parameter to filter orders:

                      0 = New order

                      1 = Confirmed

                      2 = Delivered

                      4 = Sent/Ready

                      3, 5, 6, 7 = Canceled orders

The parameter created_at return created orders from the informed date, being useful not to bring the same requests every time you consult an API.

• id (integer): order id
• name (string): customer name
• email (string): customer e-mail
• phone (string): customer phone
• date (string): order date
• updated_at (string): order modification date
• status (integer): 0 = new order, 1 = confirmed, 2 = delivered, 3 = canceled (restaurant), 4 = sent, 5 = automatically canceled (system), 6 = canceled, payment reversed (restaurant), 7 = automatically canceled, payment reversed (system), 8 = waiting for online payment approval, 9 = online payment disapproved
• tax (decimal): order delivery fee
• voucher_code (string): voucher code used
• voucher_discount (decimal): discount applied to the order through the use of the voucher (discount voucher)
• payment_method (string): form of payment
• notes (string): order notes
• street (string): address street
• cep (string): address zip code
• number (string): address number
• city (string): address city
• neighborhood (string): address neighborhood
• complement (string): address complement
• reference_point (string): delivery address reference point
• forma_entrega (integer): order delivery method (1 = delivery, 2 = teke out, 3 = order at the table)
• table_name (string): when forma_entrega is 3, the table name will be returned
• order_number (integer): order number
• troco (decimal): change for (value that the customer will give in cash)
• client_id (integer): customer id
• payment_online (boolean): if true the payment was made online through the app or web
• latitude (decimal): delivery address latitude
• longitude (decimal): delivery address longitude
• cpf_in_note (string): if it has any value, it indicates that the user requested CPF in the invoice
• printed (boolean): if the order of the order was printed
• total_discount (decimal): total discount the order received
• taxa_extra (decimal): extra fee amount
• taxa_extra_title (string): title of what was charged as an extra fee
• sub_total (decimal): order subtotal (total of products purchased)
• total (decimal): order total, amount the customer paid (already including delivery fee, fees and discounts)

                   1.1.2 Detail order listing POST::/v1/order/{order_id}

It is in this API that the POS will integrate the products sold. Querying the Order Details API returns all the details of the sale as well as the products sold.

The return is the same as the order listing and is added to the following listing:

• fidelity_program_discount (decimal): discount received through the loyalty program
• FidelityProgram (array): loyalty program information
• Payment (array): online payment information
• Vouchers (array): voucher information (discount coupons)
  ItemOrder (array): information about order items
• PizzaOrders (array): order pizza information
• ComboOrders (array): order combo information
• OrderAdditionals (array): additional order information
• PromotionGroupOrders (array): information about promotional combos

Below is the details of the arrays mentioned above:

FidelityProgram: 

• award (string): text with loyalty program award. Ex. “R$ 10,00”, “Free Delivery”, “1 soda”
• award_item (string): only when the award is a gift, for example, a menu item “1 coca-cola 2 lts”, this value will also come in the award

Payment: 

• Proceed to topic 1.1.3 Payment Methods

Vouchers:

• voucher_discount (decimal): discount amount received by the voucher
• voucher_code (string): used discount code

ItemOrder

• title (string): item title
• quantity (integer): item quantity
• name (string): item variation name
• price (decimal): item price
• total (decimal): total paid for the item (includes complements and quantity)
• notes (string): notes for this item
• ref (string): item REF
• variacao_ref (string): variation REF
• ComplementCategories (array): each complements category can contain multiple complements. “Additional” complements category example.
  • quantity (integer): complement amount
  • title (string): complement title
  • price_un (decimal): complement unit price
  • total (decimal): total paid for the complement
  • ref (string): complement REF
• title (string): complements category title
• Complements (array): contains category complements 

PizzaOrders

• quantity (integer): pizza quantity
• total_un (decimal): unit total paid for pizza
• notes (string): pizza notes
• pizza_maior_valor (boolean): true - the highest value of the flavors was charged. false - flavors were averaged
• PizzaTamanho (array): pizza size information
• title (string): size title
• qtd_sabor (integer): quantidade de sabor da pizza
• ref (string): size REF
• ComplementCategories (array): follows the same model as the items
• PizzaMassa (array): pizza dough/edge information
• title (string): mass/edge title
• price (decimal): mass/edge value
• ref (string): mass/edge REF
• PizzaSabor (array): information about pizza flavors
• title (string): flavor title
• price (decimal): flavor value
• ref (string): flavor REF
• ref_sabor_tamanho (string): flavor REF linked to size
• ComplementCategories (array): follows the same model as the items

ComboOrders

• quantity (integer): combo amount
• total_un (decimal): unit total of the combo
• combo_title (string): combo title
• ref (string): combo REF
• ComboItens (array): items ordered in the combo
• price (decimal): item price
• item_name (string): item name
• price_name (string): item variation name
• ref (string): item REF
• variacao_ref (string): variation REF

OrderAdditionals

• title (string): additional category title
• text_input (boolean): true - additional was informed via text input. false - additional was chosen via quantity selection.
• Additionals (array): additional that the user has chosen
• ref (string): additional REF
• quantity (integer): chosen quantity
• price_un (decimal): additional unit value
• text_input (string): user-entered text input, if the text_input parameter in OrderAdditionals is true.

PromotionGroupOrders

• id (integer): promotion group id.
• name (string): promotion group name.
• quantity (integer): chosen quantity.
• notes (string): notes.
• type (integer): promotion calculation rule. 1 = total sum (sum of all promotion products). 2 = highest value (charged the price of the highest value product). 3 = new price (a fixed price for the promotion, regardless of the chosen products).
• value (decimal): unit price paid in the promotion.
• ref (string): product reference code, for integration.
• bônus
• type (integer): type of promotion bonus. 

1 = none.

2 = free shipping. 

3 = points in the Loyalty Program. 

4 = gift

• value (string): if type is 1, return null. Otherwise, the bonus will be returned.

• Products (Array)
• id (integer): product ID
• type (string): item type. May return 'item' or 'pizza'. 
• name (string): product name
• calculation (integer): if it is total sum will send 1, if it is higher value will send 2, NovoPreco = 3
• quantity (integer): will always be 1
• subtotal (decimal): product subtotal
• Options (Array): the options are the items/pizzas themselves purchased
  • id (integer): complement ID
  • title (string): complemento title
  • price_un (decimal): unit price
  • quantity (integer): quantity
  • ref (string): integration code REF
  • subtotal (decimal): complement subtotal
• id (integer): option ID
• title (string): option title
• price_un (decimal): unit price
• quantity (integer): quantity
• subtotal (decimal): option subtotal
• ComplementCategories (Array)
• id (integer): complement category id
• title (string): complement category title
• Complements (Array)

                   1.1.3 Payment methods

Click here to go to the test and you can check the POST api.

Json template to send to server:

Server response Json template:

                   1.1.4 Change order status

It is important for the POS to notify API Delivery when there is any change in status (order confirmation, out for delivery, delivered and/or ready), and especially if there is cancellation. Because the Delivery API will notify the consumer via email and push notification, this notification is done through the Status Change API.

           2.1. Integração de cardápio

Some APIs are available that allow the integration of the menu with the Delivery App platform, allowing the POS to consult and register products, pizzas and categories and change their availability.

                  2.1.1 Products API

The menu API allows the updating of menu items, being able to change the title and availability, and also allows the updating of the variations of the items, allowing to change price, title and availability. It also allows registration of Categories and Pizzas.

                      2.1.1.1 Category registration

Click here to go to the test and you can check the POST api.

Json template to be sent in the request body:

• token_account [string]: store authentication token.
• title [string]: category title.
• available [boolean]: true = enable, false = disable
• out_id [string]: integrated system reference code.
• pizza [boolean]: send true if you are going to use the category to register PizzaTamanho and PizzaSabor.

Return of the request in case of success:

The return “code”:201 means that the category was registered successfully. The ID is the internal ID of the category in the Delivery App.

                  2.1.2 Category update

Click here to go to the test and you can check the PUT api.

Json template to be sent in the request body:

• token_account [string]: store authentication token.
• Categories [Array]: categories that will be updated.
• ref [string]: reference code (same out_id of the record) of the integrated system. The ref is used to query the category that will be updated.
• title [string]: category title
• available [boolean]: true = enable, false = disable

Return of the request in case of success:

Each category has its individual return, when successfully updated it will be returned updated: true.

                  2.1.3 Item update

Click here to go to the test and you can check the PUT api.

Json template to be sent in the request body:

• ref [string]: item link code between the Delivery App system and the system to be integrated.
• title [string]: new item title, pass it empty or null if not changing the title.
• enable [boolean]: change item availability, pass null if not updating.
• intro [string]: text referring to the introduction/description of the item.

Requisition return on success:

The return informs individually if the item was updated or not, if updated = true, the item was updated successfully, if false, it was not possible to update and the message must contain the reason for not having updated.

                  2.1.4 Variation update

Click here to go to the test and you can check the PUT api

Json template to be sent in the request body:

• item_ref [string]: item link code that contains the variation to be updated between the Delivery App system and the system to be integrated.
• ref [string]: variation binding code between the Delivery App system and the system to be integrated.
• price [decimal]: new price to be updated, pass null if not updating.
• enable [boolean]: changes the availability of the variation, pass null if not updating.
• title [string]: new variation title, pass it empty or null if not changing the title.
• promotional_price [decimal]:  decimal value that indicates the promotional price referring to the variation value of the item. To remove an item's promotion, simply pass 0.0.
• item_ref: It's not mandatory (can be null), as some integrations only use the binding in the variation. Its use is important in cases where the variation can repeat the ref for different items, so it will be necessary to identify which item the variation being updated belongs to.

Request return on success:

The return individually informs if the variation was updated or not, if updated = true, the variation was updated successfully, if false, it was not possible to update and the message must contain the reason for not having updated.

                  2.1.5 Item registration

Click here to go to the test and you can check the POST api.

Json template to be sent in the request body:

• category_id [int]: Item linking code that references the item's category.
• title [string]: string that indicates the title (name) of the item.
• intro [string]: string that indicates the initial Description of the item.
• enable [boolean]: change item availability, pass null if not updating.
• only_scheduling [boolean]: if true, item is available for scheduling only.
• ref [string]: item link code between the Delivery App system and the system to be integrated.

• Prices: {

• name [string]: string that refers to the item variation name.
• value [decimal]: decimal value that indicates the price of the item variation.
• enable [boolean]: change item variation availability, pass null if not updating.
• promotional_price [decimal]: decimal value that indicates the promotional price referring to the variation value of the item.
• promotion_enable [boolean]: changes the availability of the promotional price of the item variation.
• ref [string]: variation link code between the Delivery system

App and the system to be integrated.

Return of the request in case of success:

The return informs if the item was registered with "message: Item registered successfully".

                  2.1.6 Registration of item variations

Click here to go to the test and you can check the POST api.

Json template to be sent in the request body:

• name [string]: string that refers to the name of the item's variation.
• value [decimal]: decimal value that indicates the price of the item variation.
• enable [boolean]: change item variation availability, pass null if not updating.
• promotional_price [decimal]: decimal value that indicates the promotional price referring to the variation value of the item.
• promotion_enable [boolean]: changes the availability of the promotional price of the item variation.
• ref [string]: variation binding code between the Delivery App system and the system to be integrated.
• item_id [int]: code that refers to which item the variation will be associated with.

Return of the request in case of success:

The return informs if the item was registered with "message: Variation registered successfully".

                  2.1.7 Global complements registration

Click here to check the POST api.

Json template to be sent in the request body:

• *title [string] - complement title
• description [string] - complement description
• enable [boolean] - complement enable/disable
• *price [decimal] - complement price
• ref [string] - reference code for integration
• code [string] - code for internal identification of the complement

                                                                                               *obligatory

Return of the request in case of success:

                        2.1.7.1 Registration complements category and complements groups

Click here to check the POST api.

Json template to be sent in the request body:

• ref [string] - reference code for integration
• *title [string] - complement title
• code [string] - code for internal identification of the complement
• *minimum [integer] - Minimum of complements that can be chosen, (minimum must be >= 0 e < maximum)
• *maximum [integer] - Maximum of complements that can be chosen, (maximum must be > 0)
• enable [boolean] - complement enable/disable
• more_than_one [boolean] - indicates if it is allowed to choose more than one unit of the same complement
• Complements [Array] - array of ref two complements that farão part of the group

                                                                                                                                                                *obrigatórios

Return of the request in case of success:

                        2.1.7.2 Link complement Groups to Item

Click here to check the POST api.

Json template to be sent in the request body:

• ref [string] - Item reference code that will be linked to complements groups.
• ComplementCategories [Array] - Array of complement group refs that will be linked to the item.

Return of the request in case of success:

                  2.1.8 Standard complement registration

Click here to go to the test and you can check the POST api.

Json template to be sent in the request body:

• item_id [int]: string that refers to the name of the item's variation.
• title [string]: new complement title, pass it empty or null if not changing the title.
• minimum [int]: indicates the minimum amount of complements in the referenced product.
• maximum [int]: indicates the maximum amount of complements in the referenced product.
• ordem [int]: order in which the add-on will be shown (default will be the registration order).
• enable [boolean]: changes the availability of add-ons in the item.
• more_than_one [boolean]: indicates whether more than one unit of the same complement belonging to that category can be chosen.
• ref [string]: complement binding code between the Delivery App system and the system to be integrated.

• Complements: {

• title [string]: new complement title, pass it empty or null if not changing the title.
• description [string]: short text that will describe the complement.
• complement_category_id [int]: references the complement with its category.
• enable [boolean]: change the availability of the complement, pass null if not updating.
• price [decimal]: value that indicates the price of the complement.
• ref [string]: complement binding code between the Delivery App system and the system to be integrated.

                                   }

Return of the request in case of success:

The return informs if the item was registered with "message: Complemento registered".

                  2.1.9 Pizza flavor registration

Click here to go to the test and you can check the POST api.

Json template to be sent in the request body:

• title [string]: new complement title, pass it empty or null if not changing the title.
• description [string]: short text that will describe the complement.
• enable [boolean]: change flavor availability, pass null if not updating.
• ordem [int]: flavor ordering.
• id_categoria [int]:  flavor reference code with its category.
• ref [string]: flavor binding code between the Delivery App system and the system to be integrated.

• preco_tamanho: 

• ref [string]: flavor binding code by size between the Delivery App system and the system to be integrated.
• price [decimal]:  value that indicates the price of the flavor of the chosen size.
• id_tamanho [int]: size binding code that references what the pizza tastes like.
• enable [boolean]: change flavor availability, pass null if not updating.

Return of the request in case of success:

The return informs if the item was registered with "message: Sabor registered".

                  2.1.10 Pizza flavor category registration

Click here to go to the test and you can check the POST api.

Json template to be sent in the request body:

• enable [boolean]: changes the availability of flavors on the pizza.
• maximum [int]: maximum amount of complements that can be chosen.
• minimum [int]: minimum amount of complements that can be chosen.
• ref [string]: variation binding code between the Delivery App system and the system to be integrated.
• pizza_sabor_id [int]: id of the pizza flavor that will be linked to the complement category.
• title [string]: new category title, pass it empty or null if not changing the title.
• more_than_one [boolean]: indicates whether more than one unit of the same complement belonging to that category can be chosen.

• Complementos: 

• title [string]: complement title/name
• description [string]:  short text that will describe the complement.
• enable [boolean]: changes the availability of pizza flavor.
• ref [string]: link code between the Delivery App system and the system to be integrated.

• Prices: 

• pizza_tamanho_id [int]: complement binding code to a certain size.
• price [decimal]: complement price.
• ref [string]: complement binding code between the Delivery App system and the system to be integrated.

Return of the request in case of success:

The return individually informs whether the item was updated or not, if inserted = true, the item was updated successfully, if false, it could not be updated and the message must contain the reason for not updating.

                  2.1.11 Pizza size registration 

Click here to go to the test and you can check the POST api.

Json template to be sent in the request body:

• title [string]: new size title, pass empty or null if not changing the title.
• dois_sabor [boolean]: if true, indicates that the pizza accepts two flavors.
• tres_sabor [boolean]: if true, indicates that the pizza accepts three flavors.
• quatro_sabor [boolean]: if true, indicates that the pizza accepts four flavors.
• enable [boolean]: changes the availability of pizza size.
• ordem [int]: ordering the size of the pizza.
• category_id [int]:  Item linking code that references the item's category.
• ref [string]: pizza size binding code between the Delivery App system and the system to be integrated.
• balcao [boolean]: if true, this pizza size is available for store pickup only.

Return of the request in case of success:

The return individually informs whether the item was updated or not, if inserted = true, the item was updated successfully, if false, it could not be updated and the message must contain the reason for not updating.

                  2.1.12 Pizza size category registration

Click here to go to the test and you can check the POST api.

Json template to be sent in the request body:

• enable [boolean]: change item availability, pass null if not updating.
• title [string]: new size title, pass empty or null if not changing the title.
• maximum [int]: maximum amount of complements that can be chosen.
• minimum [int]: minimum amount of complements that can be chosen.
• ref [string]: pizza size binding code between the Delivery App system and the system to be integrated.
• pizza_tamanho_id [int]: size binding code that references which size category.
• more_than_one [boolean]: indicates whether more than one unit of the same complement belonging to that category can be chosen.

• Complementos : 

• enable [boolean]: change the availability of the add-on, pass null if not updating.
• title [string]: new complement title, pass it empty or null if not changing the title.

• description [string]: short text that will describe the complement.

• ref [string]: pizza size binding code between the Delivery App system and the system to be integrated.
• price [decimal]: complement price

Json template to be sent in the request body:

The return individually informs whether the item was updated or not, if inserted = true, the item was updated successfully, if false, it could not be updated and the message must contain the reason for not updating.