EXextend
Stores

Create a store

Creates a store in the account authorized by the merchant token. Returns the create response; optional settings appear when configured. Requires any one scope: stores:create, stores:full, all.

post/stores

Request

  • Base URL
    https://api.helloextend.com
  • URL
    https://api.helloextend.com/stores
  • Auth
    API key in header X-Extend-Access-Token

Request body

approvedboolean

Ignored on create. A new store starts unapproved until Extend approves it.

enabledboolean

Ignored on create. A new store starts disabled until Extend enables it.

annualSalesnumber
storeTypestring
currencyCode'AUD' | 'CAD' | 'EUR' | 'GBP' | 'NZD' | 'USD'
domainstring required
namestring required
secondaryNamestring
platform'magento' | 'shopify' | 'salesforce' | 'big-commerce' | 'woo-commerce' | 'custom' required
generateLeadsEnabledboolean
historicalLeadsEnabledboolean
historicalLeadsLookbackMonthsnumber
claimsManagementEnabledboolean
isABTestingEnabledboolean
isTestStoreboolean
locationFilteringEnabledboolean
offersByCategoryEnabledboolean
syncOrderProductsboolean
offerPlanRecordEnabledboolean
offerVersionstring
offerPriceType'product_list_price' | 'product_purchase_price' | 'product_sale_price'
analyticsDisabledboolean
bankDetailsSubmittedAtnumber
enableMerchantPortalLeadEmailsConfigurationboolean
unmappedProductContractsboolean
merchantEwRevenueAgreement'net_revenue_share' | 'gross_revenue_share' | 'wholesale' | 'null' nullable
merchantEwRevenueSharePercentagenumber nullable
merchantSpRevenueAgreement'revenue_share' | 'null' nullable
merchantSpRevenueSharePercentagenumber nullable
partialReimbursementEnabledboolean nullable
partialReimbursementPercentagenumber nullable
partialReimbursementType'percentage' | 'fixed' | 'null' nullable
partialReimbursementFixednumber nullable
localesConfigobject
trustConsumerDataboolean
accountIdstring

Required when the token's accountId is *. The account must be within the token's account boundary. Otherwise the token's accountId is used.

isMiniDemoboolean

Response

Successful request

accountIdstring required

The account that owns the store.

adminDealerNumberstring

Returned when configured on the store.

adminLocationNumberstring

Returned when configured on the store.

adminManufacturerstring

Returned when configured on the store.

analyticsDisabledboolean

Returned when configured on the store.

annualSalesnumber

Returned when configured on the store.

approvedboolean required

Whether Extend has approved the store.

bankDetailsSubmittedAtnumber

Returned when configured on the store.

claimsManagementEnabledboolean

Returned when configured on the store.

currencyCode'AUD' | 'CAD' | 'EUR' | 'GBP' | 'NZD' | 'USD'

Returned when configured on the store.

customLeadUrlstring

Returned when configured on the store. Absent from the create response.

defaultLeadUrlstring

Returned when configured on the store. Absent from the create response.

postClaimRedirectUrlstring

Returned when configured on the store. Absent from the create response.

domainstring required

The store's domain.

enabledboolean required

Whether the store is enabled. Always returned by create, as false; other responses return it when set.

enableMerchantPortalLeadEmailsConfigurationboolean

Returned when configured on the store.

extendCutnumber nullable

Returned only when present on an unfiltered list or create response. Omitted from merchant get and update responses.

generateLeadsEnabledboolean

Returned when configured on the store.

historicalLeadsEnabledboolean

Always returned. Defaults to true when not configured.

historicalLeadsLookbackMonthsnumber

Always returned. Defaults to 0 when not configured.

inStoreAppEnabledboolean

Returned when configured on the store. Absent from the create response.

isABTestingEnabledboolean

Always returned. Defaults to false when not configured.

isTestStoreboolean

Returned when configured on the store.

leadUrlConfigurabilityEnabledboolean

Returned when configured on the store. Absent from the create response.

localesConfigobject

Returned when configured on the store.

locationFilteringEnabledboolean

Returned when configured on the store.

merchantCutnumber required

Always returned. Defaults to 0 when not set.

merchantEwRevenueAgreement'net_revenue_share' | 'gross_revenue_share' | 'wholesale' | 'null' nullable

Returned when configured on the store.

merchantEwRevenueSharePercentagenumber nullable

Returned when configured on the store.

merchantSpRevenueAgreement'revenue_share' | 'null' nullable

Returned when configured on the store.

merchantSpRevenueSharePercentagenumber nullable

Returned when configured on the store.

partialReimbursementEnabledboolean nullable

Returned when configured on the store.

partialReimbursementPercentagenumber nullable

Returned when configured on the store.

partialReimbursementType'percentage' | 'fixed' | 'null' nullable

Returned when configured on the store.

partialReimbursementFixednumber nullable

Returned when configured on the store.

namestring required

The store's name. Always returned by create; other responses return it when set.

offerModalVersionstring

Returned when configured on the store.

offerPlanRecordEnabledboolean

Always returned. Defaults to false when not configured.

offerPriceType'product_list_price' | 'product_purchase_price' | 'product_sale_price'

Returned when configured on the store.

offersByCategoryEnabledboolean

Returned by create and list. Always false in merchant get and update responses after restricted properties are filtered.

offerVersionstring

Returned when configured on the store.

platform'magento' | 'shopify' | 'salesforce' | 'big-commerce' | 'woo-commerce' | 'custom' required

The ecommerce platform the store runs on.

secondaryNamestring

Returned when configured on the store.

storeTypestring

Returned when configured on the store.

syncOrderProductsboolean

Returned by create and list. Always false in merchant get and update responses after restricted properties are filtered.

tableauUserIdstring

Returned when configured on the store. Absent from the create response.

trustConsumerDataboolean

Returned when configured on the store.

unmappedProductContractsboolean

Always returned. Defaults to false when not configured.

whiteLabeledEnabledboolean

Returned when configured on the store.

offersCustomContentEnabledboolean

Returned when configured on the store. Absent from the create response.

themeConfigurabilityEnabledboolean

Returned when configured on the store. Absent from the create response.

isMiniDemoboolean

Returned when configured on the store.

createdAtnumber required

Store creation timestamp in milliseconds since the Unix epoch.

deletedAtnumber

Soft deletion timestamp in milliseconds since the Unix epoch, returned only for a deleted store. Absent from the create response.

idstring required

The store ID.

logoKeystring

Returned when configured on the store.

logoUrlstring nullable

Returned when configured on the store.

organizationIdstring

Returned when configured on the store.

preDiscountedboolean

Returned by list, get and update when configured. Absent from the create response.

updatedAtnumber required

Last update timestamp in milliseconds since the Unix epoch.

Changes

No recorded changes to this operation across all 1 revision of this API.