Endpoints

https://api.storenvy.com/v1/{endpoint}.json

https://api.storenvy.com/v1/products.json?api_key=29fjso3i3ifososifjua020tr9fjf

curl -H "Content-Type: application/json" ...

Back To TopUser

Note: This endpoint is only valid with Oauth authentication – It will not work with API Key-based authentication since that key ties directly to a store, not a user.

GET /v1/me

Get profile information for the current OAuth-authenticated user.

Back To TopStore

GET /v1/store	Get the basic details of your Store.
POST /v1/stores	Create a store for an Oauth-authenticated user, if they don't already have one. Note: This can only be performed once. If you'd like to create stores as an API caller for your users, see POST /v1/application/stores.
PUT /v1/store	Update your store's information.
GET /v1/store/visits	Get the weekly and daily breakdown of visits to your store.
GET /v1/store/marketplace_visits	Get the weekly and daily breakdown of visits to your marketplace store.

Back To TopPage Templates

Your store's page templates which include Home, Collection, Product, Contact, FAQ, and Maintenance. To update the Store's CSS of Layout markup, see the PUT /v1/store.json endpoint.

GET /v1/store/templates	Get a list of your page Templates.
PUT /v1/store/templates/:id	Update details of a page Template.
POST /v1/store/templates	Create a new custom page Template.

Back To TopOrders

Orders are records of past purchases made by a store's customers.

GET /v1/orders	Get a list of Orders ordered by ID. 50 per page. Sorted by newest first.
GET /v1/orders/:id	Get a specific Order by ID.
PUT /v1/orders/:id/ship	Mark an item as "shipped" and automatically create a Fulfillment. You may optionally pass a list of items to add to the Fulfillment. If there are any items remaining unshipped, the status of the Order will say "Partially Shipped".
PUT /v1/orders/:id/hold	Mark an order as "on hold" because of some kind of delay. This will remove it from the list of "open" orders.
PUT /v1/orders/:id/open	Mark an order as "open" after it has been put "on hold" or "shipped".
GET /v1/orders/:id/products	Get a list of the Products in an order.
GET /v1/orders/:id/variants	Get a list of the Variants in an order.

Back To TopFulfillments

Fulfillments are records of past product shipments.

PUT /v1/orders/:order_id/fulfillments/:id

Update a specific Fulfillment by ID. To view past Order Fulfillments, get the whole Order.

Back To TopProducts

GET /v1/products	Get a list of all your Products. 20 per page. Sort by ID ASC.
POST /v1/products	Create a Product. After a product is created, you must use the resulting id to create Variants for the product. Note: A "default" Variant will be created for this product automatically after it is created. Update the Variant to change the name or inventory levels. In the future, we will provide a way to create all Product Variants in this call.
GET /v1/products/:id	Get a Product by ID.
PUT /v1/products/:id	Update a Product.
DELETE /v1/products/:id	Delete a Product by ID.

Back To TopVariants

Variants are the various styles or flavors your Product comes in. Example: Small, medium, large.

POST /v1/products/:product_id/variants	Create a Variant for a Product.
GET /v1/products/:product_id/variants/:id	Get a Variant for a Product
PUT /v1/products/:product_id/variants/:id	Update a Variant for a Product.
DELETE /v1/products/:product_id/variants/:id	Delete a Variant for a Product.

Back To TopCollections

Collections are groups of products similar to categories. A Product may be in more than one Collection.

GET /v1/collections	Get a list of Collections.
GET /v1/collections/:id	Get a Collection by ID.
POST /v1/collections	Create a Collection.
PUT /v1/collections/:id	Update a Collection by ID.
DELETE /v1/collections/:id	Delete a Collection.

Back To TopShipping Groups

A Shipping Group is a time-saving feature that allows you to set shipping rates for all products of the same type in one place. A Shipping Group connects to Shipping Classes through a Shipping Rate.

GET /v1/shipping_groups	Get a list of Shipping Groups.
GET /v1/shipping_groups/:id	Get a Shipping Group by ID.
POST /v1/shipping_groups	Create a Shipping Group.
PUT /v1/shipping_groups/:id	Update a Shipping Group.
DELETE /v1/shipping_groups/:id	Delete a Shipping Group. Must not have any Products associated with it in order to Delete.

Back To TopShipping Classes

Shipping Classes are the different types of shipping options you offer such as "Standard" or "First Class". Shipping Classes are connected to Countries and are only offered to users whose shipping address matches one of the countries on the Shipping Class. A Shipping Class connects to Shipping Groups through a Shipping Rate.

GET /v1/shipping_classes	Get a list of Shipping Classes.
GET /v1/shipping_classes/:id	Get a Shipping Class by ID.
POST /v1/shipping_classes	Create a Shipping Class.
PUT /v1/shipping_classes/:id	Update a Shipping Class.
DELETE /v1/shipping_classes/:id	Delete a Shipping Class.

Back To TopShipping Rates

Shipping Rates are the prices for shipping a product from a certain Shipping Group via a certain Shipping Class. Requires a Shipping Group and a Shipping Class.

GET /v1/shipping_rate	Get a Shipping Rate for a certain combination of Shipping Group and Shipping Class.
PUT /v1/shipping_rate	Update a Shipping Rate for a certain combination of Shipping Group and Shipping Class.

Back To TopWebhook Notifications

Webhooks are callbacks that receive a POST request each time an event happens through the storefront.

GET /v1/webhooks	Get a list of your Webhooks.
GET /v1/webhooks/:id	Get a Webhook by ID.
POST /v1/webhooks	Create a new Webhook.
PUT /v1/webhoooks/:id	Update a Webhook.
DELETE /v1/webhoooks/:id	Delete a webhook.

Back To TopEndpoints for OAuth App Creators

These actions are available exclusively to you as the application owner to do special things outside the scope of a normal store.

POST /v1/application/stores

Create a brand new store and a brand new user account. Perfect for dynamically generating stores on the fly for customers. Note, the response envelope will include a premade OAuth access_token for placing OAuth calls on the new Store with your Application. Be sure to keep these credentials because they will not be reissued or displayed again.