Request Body Fields
Request Body Fields
Store name as it will appear to customers. Example: “SSP Test Store - final”
Store contact email address. Example: “[email protected]”
Store contact phone number in international format. Example: “+14132231249”
ID of the company this store belongs to. Example: 1000022
Array of address objects for different store purposes
Whether to create a billing vendor account for this store. Set to
true
to enable automated billing setup.User ID of the primary point of contact for this store. Example: 1000049
Request Example
Response
Unique store identifier (UUID format)
Indicates whether store setup process is complete
Store disabled status
Role-based access control enablement status
Store name as provided
Store contact email
Store contact phone number
Associated company ID
Point of contact user ID
Generated billing vendor ID if create_bill_vendor was true
Array of created address records with full details including IDs
Array of delivery service partner configurations (UberEats, DoorDash, GrubHub)
Associated vendor/billing ID
Response Example
Automatic Partner Setup: The store is automatically configured with delivery service partners (UberEats, DoorDash, GrubHub) but they start in disabled state. You’ll need to configure each partner individually after store creation.
Address Types: Use address_type
0
for the main store address where operations happen, and address_type 1
for the address where welcome packages and onboarding materials should be shipped.Point of Contact: Ensure the point_of_contact user ID exists and has appropriate permissions before creating the store.
Billing Vendor: When create_bill_vendor is true, a billing vendor account is automatically created and linked to the store for payment processing.