Sign in

v2

OpenAPI 3.0.3Proprietary2026-07-263483431.1 MB
Business Stores

Update a business store

Requires the store:update scope. Use is_public instead of legacy visibility.

patch/v3/stores/{id}

Request body

namestring
is_publicboolean
custom_domain_idinteger nullable
warehouse_idinteger nullable
logostring nullable

Logo upload value or empty value to clear the logo.

is_auto_expireboolean
auto_expire_daysinteger
is_discount_editableboolean
is_unique_codeboolean
max_unique_code_amountnumber
is_postal_codeboolean
postal_code_requirement'autofill' | 'manual'
is_customer_otp_requiredboolean
is_manual_shipping_costboolean
is_courier_requiredboolean
is_transferproof_requiredboolean
is_dropshipping_allowedboolean
is_moota_enabledboolean
email_notification_statusesstring[]
email_reply_to_idinteger nullable
email_reply_to_assignment'fixed' | 'rotator'
is_email_new_orderboolean
is_email_notificationsboolean
whatsapp_notification_statusesstring[]
is_whatsapp_new_orderboolean
is_whatsapp_payment_d1_fuboolean
is_whatsapp_payment_d2_fuboolean
is_whatsapp_payment_last_fuboolean
is_whatsapp_link_downloadboolean
non_cod_purchase_triggersstring[]
cod_purchase_triggersstring[]
capi_purchase_value_type'gross_revenue' | 'net_revenue' | 'adj_gross_revenue'
days_of_payment_processinginteger
is_show_download_invoiceboolean
is_show_whatsappboolean
is_fuc_product_enabledboolean
is_fuc_bundle_enabledboolean
is_advanced_validationboolean
min_name_lengthinteger
min_address_lengthinteger
max_per_phoneinteger
max_per_ipinteger
blocked_messagestring
is_order_hard_filterboolean
is_customer_spam_filterboolean
is_ip_spam_filterboolean
is_spam_filterboolean
is_use_wababoolean
waba_account_idinteger nullable
greeting_messagestring
inactivity_periodinteger
is_greeting_message_enabledboolean
digital_only_complete_type'auto' | 'when_settled' | 'manual'
auto_other_incomestring
fixed_auto_other_incomenumber
other_income_namestring
dynamic_other_income_cod_type'fixed' | 'percentage'
dynamic_other_income_cod_default_amountnumber
dynamic_other_income_cod_default_percentagenumber
dynamic_other_income_epayment_type'fixed' | 'percentage'
dynamic_other_income_epayment_default_amountnumber
dynamic_other_income_epayment_default_percentagenumber
store_courier_other_incomesobject[]
store_method_other_incomesobject[]
store_sales_peopleobject[]
store_custom_audiencesobject[]

Response

Business store

idinteger required

Numeric Scalev store database ID.

unique_idstring required

Public store unique ID used by storefront routes.

uuidstring uuid
namestring required
business_idinteger
is_activeboolean
is_publicboolean
logostring nullable

Public URL for the store logo when configured.

custom_domainobject nullable
payment_methodsstring[]
xendit_va_bank_codesstring[]
created_atstring date-time
last_updated_atstring date-time