Skip to main content
POST
Create a store from an existing one

Authorizations

Authorization
string
header
required

Token returned by POST /auth/token, sent as Authorization: Bearer <token>.

Body

application/json
name
string
required

Name of the new store

Example:

"Partner Store SP"

source_store_id
integer
required

Id of an existing store used as template. The new store is created in the same account. Your credential must have access to it.

Example:

1234

created_by_email
string<email>
required

Email of an existing user of the source store's account, recorded as the creator. The user is not created by this call.

Example:

"integrations@example.com"

store_type
enum<string>

Service model of the new store. Defaults to the source store's type.

Available options:
ALL_SERVICES,
PICK_AND_SHIP,
DEMO_ALL_SERVICES
Example:

"ALL_SERVICES"

warehouse_id
integer

Warehouse for the new store. Must already be assigned to the source store. Defaults to the source store's first warehouse.

Example:

232

description
string | null

Free-text description

Example:

"Store provisioned via API"

source_shipping_group_ids
integer[]

Ids of the source store's shipping groups to copy. Replaces the country defaults and creates the new store's Open API integration.

Example:
default_shipping_group_id
integer

Which of source_shipping_group_ids becomes the default group. Required with source_shipping_group_ids; must not be an international-only group.

Example:

101

webhook_consumer_url
string<uri>

HTTPS URL that will receive the new store's webhooks. Only with source_shipping_group_ids. Must use https and a domain name (no raw IP).

Example:

"https://example.com/cubbo/webhooks"

webhook_feeds
enum<string>[]

Feeds to deliver to webhook_consumer_url. Requires webhook_consumer_url. Omitted means all three.

Available options:
order_status,
inventory_movement,
replenishment_status
Example:

Response

Store created. The body is the full store record plus, when an integration was created, its credentials.

Response of POST /stores: the full store record (the fields of Store plus the store's configuration flags, its account and its warehouses) and, only when an Open API integration was created, the open_api_integration credentials.

id
integer

Store id

Example:

4821

name
string

Store name

Example:

"Partner Store SP"

description
string | null

Free-text description

Example:

"Store provisioned via API"

created_at
string<date-time>

Creation time

Example:

"2026-09-03T14:02:11.000Z"

updated_at
string<date-time>

Last update time

Example:

"2026-09-03T14:05:47.000Z"

tax_id
string | null

Store tax id (CNPJ in Brazil, digits only; RFC in Mexico)

Example:

"00000000000191"

invoice_customization
object | null

Advanced NF-e customization keyed by invoice purpose (Brazil)

Example:
state
string | null

State of the store's fiscal address (two-letter UF code in Brazil)

Example:

"SP"

tax_regime
enum<string> | null

Brazilian tax regime

Available options:
SIMPLES_NACIONAL,
LUCRO_REAL,
LUCRO_PRESUMIDO,
null
Example:

"SIMPLES_NACIONAL"

tax_company_name
string | null

Legal company name

Example:

"Partner Store SP LTDA"

tax_address
string | null

Fiscal address street

Example:

"Av. Paulista"

tax_address_number
string | null

Fiscal address number

Example:

"1000"

tax_address_neighborhood
string | null

Fiscal address neighborhood

Example:

"Bela Vista"

tax_city
string | null

Fiscal address city

Example:

"Sao Paulo"

tax_zipcode
string | null

Fiscal address postal code

Example:

"01310-100"

tax_state_phone
string | null

Phone registered with the state registration

Example:

"+55 11 0000-0000"

tax_state_registration
string | null

State registration number (Inscricao Estadual)

Example:

"123456789"

store_type
enum<string>

Service model of the store

Available options:
ALL_SERVICES,
PICK_AND_SHIP,
DEMO_ALL_SERVICES
Example:

"ALL_SERVICES"

b2b
boolean

Whether the store operates business-to-business

Example:

false

d2c
boolean

Whether the store operates direct-to-consumer

Example:

true

skip_product_lot_in_returns
boolean | null

Store configuration flag

Example:

null

receive_only_complete_returns
boolean | null

Store configuration flag

Example:

null

return_inspection_enabled
boolean | null

Store configuration flag

Example:

null

requires_stock_only_from_confirmed_replenishments
boolean

Store configuration flag

Example:

false

has_store_branches
boolean

Store configuration flag

Example:

false

is_oxxo_store
boolean

Store configuration flag

Example:

false

enable_replenishment_invoices
boolean | null

Store configuration flag

Example:

null

enable_removal_order_invoices
boolean | null

Store configuration flag

Example:

null

enable_manual_client_invoice
boolean

Store configuration flag

Example:

false

enable_b2b_cnpj_client_invoice
boolean

Store configuration flag

Example:

false

account
object

The account the store belongs to (id, name, account type, and the account's stores)

Example:
warehouses
object[]

Warehouses assigned to the new store

Example:
open_api_integration
object

Credentials of the new store's Open API integration. Present only when source_shipping_group_ids was sent. Secrets are shown once.