Skip to main content
PUT
Update Store
This endpoint allows you to update various aspects of a store’s configuration including name, contact details, point of contact, and addresses. Address updates support both modifying existing addresses and adding new ones.

Path Parameters

string
required
The unique identifier of the store to update

Query Parameters

string
required
The company ID that owns this store for authorization purposes
string
Updated store name. Example: “bulk ingest test #1”
string
Updated store contact email address. Example: “[email protected]
string
Updated store contact phone number. Example: “+12679397993”
number
Updated point of contact user ID. Example: 1000418
array
Updated address information. Can include existing addresses (with IDs) and new addresses (without IDs)

Request Example

Response

boolean
Indicates whether the update operation was successful

Response Example

Address Update Behavior

behavior
When id is provided: Updates the existing address with new information
Only the provided fields will be updated
behavior
When id is null: Creates a new address record and associates it with the store
New addresses will be assigned unique IDs automatically
behavior
To remove an address: Don’t include it in the addresses array
Removing the primary store address may affect operations

Update Impact

updated
Basic store details like name, email, and phone number
updated
Point of contact can be reassigned to different users
updated
Existing addresses are modified, new addresses are created
preserved
Delivery service partner configurations remain unchanged
preserved
Store operational status and settings are maintained

Best Practices

best-practice
Only include fields you want to change
Omitted fields will retain their current values
best-practice
Always include existing address IDs when updating addresses
Forgetting to include an address ID may create duplicates
best-practice
Verify that the new point_of_contact user exists and has appropriate permissions
Invalid user IDs will result in update failure
best-practice
Perform updates during low-activity periods to minimize operational impact
Store updates don’t affect ongoing orders

Error Scenarios

error
The specified store_id doesn’t existStatus Code: 404
error
The store doesn’t belong to the specified company_idStatus Code: 403
error
The point_of_contact user ID doesn’t existStatus Code: 400
error
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.