Skip to main content

Create a business

API operation: Open the endpoint in the API reference

Use POST /business to create a business. The current public operation is Business.register.

If available, the operation requires administrator or business-manager authentication. Required fields currently include name, email, slug, minimum, delivery_price, tax_type, tax, and service_fee. Other requirements depend on the selected fields and project configuration; see the operation guide for the complete request schema.

The operation validates or normalizes structured fields such as schedule, types, taxes, and ribbon. Media fields such as logo, header, and seo_image are processed as images. Do not put provider credentials, customer data, or production-only identifiers in examples.

Legacy SDK example​

const response = await ordering.businesses().save()

Confirm the SDK package and version before using this helper. The operation guide specifies the exact POST /business contract.

OpenAPI reference​

Operation: POST /business

Request body fields

NameTypeRequired
aboutanyNo
addressanyNo
address_notesanyNo
always_deliverbooleanNo
cancel_order_after_minutesinteger | nullNo
cellphoneanyNo
city_idintegerNo
city_nameanyNo
countryanyNo
country_codeanyNo
currencyanyNo
delivery_pricenumberYes
delivery_tax_ratenumberNo
delivery_tax_typenumberNo
delivery_timeanyNo
descriptionanyNo
disabled_reasonanyNo
emailanyYes
enabledbooleanNo
eta_status_timesstringNo
eta_variation_timeintegerNo
external_idanyNo
featuredbooleanNo
fixed_usage_feenumberNo
franchise_idinteger | nullNo
front_layoutanyNo
headeranyNo
localityanyNo
locationstringNo
logoanyNo
maximumnumber | nullNo
minimumnumberYes
nameanyYes
neighborhoodanyNo
order_default_priorityintegerNo
owner_idintegerNo
parent_business_idinteger | nullNo
percentage_usage_feenumberNo
phoneanyNo
pickup_timeanyNo
price_levelanyNo
printer_idintegerNo
ribbonstringNo
routeanyNo
scheduleanyNo
seo_descriptionanyNo
seo_imageanyNo
seo_titleanyNo
service_feenumberYes
slugstringYes
snooze_untilstring | nullNo
stateanyNo
state_codeanyNo
street_numberanyNo
sublocalityanyNo
taxnumberYes
tax_idinteger | nullNo
tax_typenumberYes
taxesarray<integer>No
timezonestringNo
typesarray<integer>No
zipcodeanyNo

Responses

CodeDescription
200OK (Envelope)
400Bad Request (ErrorResponse)
401Unauthorized
404Not Found
429Too Many Requests (ErrorResponse)
500Internal Server Error (ErrorResponse)
503Service Unavailable (ErrorResponse)
Open this operation in the API reference