Path Parameters
The unique identifier of the store to update
Query Parameters
The company ID that owns this store for authorization purposes
Request Body Fields
Request Body Fields
Updated store name. Example: “bulk ingest test #1”
Updated store contact email address. Example: “[email protected]”
Updated store contact phone number. Example: “+12679397993”
Updated point of contact user ID. Example: 1000418
Updated address information. Can include existing addresses (with IDs) and new addresses (without IDs)
Request Example
Response
Indicates whether the update operation was successful
Response Example
Address Update Behavior
Address Update Rules
Address Update Rules
When
id
is provided: Updates the existing address with new informationOnly the provided fields will be updated
When
id
is null
: Creates a new address record and associates it with the storeNew addresses will be assigned unique IDs automatically
To remove an address: Don’t include it in the addresses array
Removing the primary store address may affect operations
Update Impact
What Gets Updated
What Gets Updated
Basic store details like name, email, and phone number
Point of contact can be reassigned to different users
Existing addresses are modified, new addresses are created
Delivery service partner configurations remain unchanged
Store operational status and settings are maintained
Best Practices
Update Recommendations
Update Recommendations
Only include fields you want to change
Omitted fields will retain their current values
Always include existing address IDs when updating addresses
Forgetting to include an address ID may create duplicates
Verify that the new point_of_contact user exists and has appropriate permissions
Invalid user IDs will result in update failure
Perform updates during low-activity periods to minimize operational impact
Store updates don’t affect ongoing orders
Error Scenarios
Common Update Errors
Common Update Errors
The specified store_id doesn’t existStatus Code: 404
The store doesn’t belong to the specified company_idStatus Code: 403
The point_of_contact user ID doesn’t existStatus Code: 400
Address information is incomplete or invalidStatus Code: 400
Operational Continuity: Store updates are designed to maintain operational continuity. Existing orders, inventory, and partner integrations continue functioning normally during and after updates.
Audit Trail: All store updates are logged for compliance and troubleshooting purposes. Update timestamps and user information are automatically recorded.