Store API
A site can have one online store. The plan that the site uses determines the functionality available to that store. For example, more premium plans allow a greater number of products, custom domain checkout, as well as more advanced functionality like automatic tax calculation and shipping rates. Use plan_level on the Site API to determine the site's current plan.
Use the Store API to get and update information about a site's store.
Use the Store API to get and update information about a site's store.
Note: To authenticate with the Weebly API, you need to use OAuth. This will allow you to access resources based on a particular user and site.
In this topic:
Fields
The following table shows all the fields that exist for this API and which are changeable using PATCH. Sites can have only one store, so you can only get details for that one store.
Name |
Description |
Type |
Change- able? |
user_id |
The unique ID of the user authenticated during the OAuth process and who owns the store. |
string |
|
site_id |
Unique ID of the site that this store is a part of. |
string |
|
currency |
The currency set for this store |
string |
|
weight_unit |
The weight unit set for this store. Valid values are:
|
string |
|
company_name |
The name given to the store. |
string |
X |
street street2 |
The store's street address. |
string |
X |
city |
The store's city. |
string |
X |
postal_code |
The store's postal/zip code. |
string |
X |
state |
The store's state or region. |
string |
X |
country |
The store's country |
string |
X |
email |
The email set for the store. This may be different than the associated user's email. |
string |
X |
phone |
The phone number set for the store. |
string |
X |
Note: Any fields returned that are not documented are currently unsupported and can be safely ignored.
Retrieve Details for a Store
Enpoint URL
Returns the details for a site's store.
Scope: read:store-catalog
Scope: read:store-catalog
Request
Example request
Response
See Fields table. All fields for the group are returned.
Example response
Update a Store
Endpoint URL
Updates the given store.
Scope: write:store-catalog
Scope: write:store-catalog
Updateable Fields
These fields can be updated.
Name |
Description |
Type |
company_name |
The name given to the store. |
string |
street street2 |
The store's street address. |
string |
city |
The store's city. |
string |
state |
The store's state or region. |
string |
postal_code |
The store's zip/postal code. |
string |
country |
The store's country. |
string |
email |
The store's email. This may be different than the associated user's email. |
string |
phone |
The store's phone. |
string |
Request
Example request
Response
Example response