Edit existing Sale

put

https://api.tilby.com/v2/sales/{id}

In this case you must specify the id in the URL and change the data you wanna update

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

id of the Sale that need to be updated

Body Params

Object data that need to be updated

Here can be set all params that has been changed in the sale before closing. Only defined params will be updated

currency

string

required

name

string

required

length between 3 and 30

open_at

date-time

required

seller_id

integer

required

seller_name

string

required

assigned_id

integer

assigned_name

string

auto_print_order

boolean

bill_lock

boolean

booked_for

string

booking_external_id

string

this field can be used be integration to handle a code that can be used to reference their original booking. It is not unique in Tilby. Generally speaking we suggest to use sale uuid as key.

booking_id

number

booking_status

string

enum

in preparation of the future deprecation of the bookings endpoint, this. status will be used on the Rooms and Tables section to show if a table is occupied or it will be in the future. If this status will be 'arrived' and sale.status == open, then the table is considered occupied. Open_at will be ignored in this case

Allowed:

channel

string

covers

integer

customer_signature

string

customer_signature_sent

boolean

customer_tax_code

string

length between 0 and 16

deliver_at

date-time

Delivering date

device_name

string

device_serial

string

e_invoice

object

external_id

string

this param can be used by external integration that needs to save a unique id associated with the sale

fidelity_pienissimo

string

is_summary

boolean

lottery_code

string | null

notes

string

pms_reservation_id

string

pms_reservation_name

string

pms_type

string

price_changes

array of objects

price_changes

printed_prebills

integer

Defaults to 0

room_id

number

room_name

string

sale_customer

object

sale_number

integer

used by Tilby's app to know the sales count and order

sale_parent_id

integer

it is used if this sales come from another sale. Can happen in payment split for example

sale_parent_uuid

string

it is used if this sales come from another sale. Can happen in payment split for example

secondary_currency

string

secondary_exchange_rate

number

secondary_final_amount

number

sent_exits

object

split_sale_origin_uuid

string

table_id

number

table_name

string

length ≤ 25

tables

array of objects | null

First element of the array is the equivalent of table_id,table_name, room_id and room_name.
If sales is open, first element will be always replaced with the columns data.
if table_id is populated, tables can not be empty.
To empty the tables must be set tables = null or tables = [] and to null also the columns table_id ecc
if there are multiple tables, first element must ALWAYS be father.
Father by api can be changed setting a new table_id ecc but won't be reset the rest of th array by default.
From UI father can only be changed after deleting other tables. Then, father can be changed

tables

amount

number

Sum of price * quantity + discount/surcharges of all sale_items

change

number

Payment change (also known as 'resto'). This will be set by the app when the sale will be closed. It's calculated if the sum of payments is greater than final_amount of the sale

change_type

string

enum

It is "cash" when there are cash payments in the array of payments.
it is "ticket" when there are tickets and no cash payments in the array of payments.
it is "other" when there are no cash or tickets in the payments.

Allowed:

closed_at

date-time

Closing (or Storing) date

final_amount

number

Sum of price * quantity + discount/surcharges of all sale_items + discount/surcharges on amount

final_net_amount

number

Sum of final_price * quantity of all sale_items

lastupdate_at

date-time

lastupdate_by

integer

order_id

integer

it is used if the order is sent to cash registry

order_type

string

enum

Defaults to normal

it is used if the order is sent to cash registry

Allowed:

order_uuid

string

it is used if the order is sent to cash registry

payments

array of objects

payments

sale_documents

array of objects

sale_documents

sale_items

array of objects

sale_items

scloby_shop_id

string

Tilby Pass Shop ID

status

string

enum

required

Sale status, can be open, closed or stored

Allowed:

uuid

string

must be unique

Responses

404

Order not found

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Returns the object data updated