shoprocket_get_store
Get store
The Shoprocket store this key belongs to: name, address, environment (test or live), paused state, currencies and languages, setup status. The store's API keys are never returned. GET /v1/store/details.
Takes no parameters.
shoprocket_get_store_stats
Get store stats
Sales statistics for a date range, compared with the previous period: orders, revenue, visitors, abandoned carts, conversion rate, average order value, a daily sales graph, regions, sources and popular products. GET /v1/store/stats.
Parameterstorequiredfromrequired
shoprocket_list_orders
List orders
List or search orders with totals, customer, addresses, payment and fulfillment status, discounts, line items and shipping. Filter by payment status, fulfillment status, payment method, customer ids, amount range, sale/discount use or free text. GET /v1/orders.
Parameterspagelimitsearchstatuscustomerhas_salepayment_methodorder_amount_tohas_discount_codeorder_amount_fromfulfillment_statushas_automatic_discount
shoprocket_get_order
Get order
One order by id (ord_..., not the #number shown in the dashboard): totals, customer, billing and shipping address, payment and fulfillment status, discounts, line items and tracking. GET /v1/orders/{id}.
Parametersorder_idrequired
shoprocket_update_order_status
Update order status
WRITE: change an order's payment status and/or fulfillment status (for example mark it shipped or paid). Shoprocket needs both values, so a value you leave out is read from the order first and kept. With send_email true Shoprocket EMAILS THE CUSTOMER an order update (optionally with custom_text); the default is no email. Cancelling can return the items to stock (release_stock). POST /v1/orders/{id}.
Parametersorder_idrequiredsend_emailcustom_textrelease_stockpayment_statusfulfillment_status
shoprocket_list_products
List products
List products with price, SKU, stock quantity, categories, images, variants (skus) and status. Search by text, filter by category slugs, product ids or slugs, and sort. GET /v1/products.
Parametersidspagesortlimitslugssearchproduct_category
shoprocket_get_product
Get product
One product by id (prod_...): description, price, SKU, stock, dimensions, categories, media, variants (skus), add-ons. GET /v1/products/{id}.
Parametersproduct_idrequired
shoprocket_create_product
Create product
WRITE: create a product in the store (visible to shoppers unless status is 0). A name and at least one category (name or slug) are required. Does not create duplicates by itself: calling twice creates two products. Variants and add-ons are not set by this tool. PUT /v1/products.
Parametersskunamerequiredpricestatusweightsummaryquantitycategoriesrequireddescriptionmax_order_quantitymin_order_quantity
shoprocket_update_product
Update product
WRITE: change a product's fields (price, stock quantity, description, status...). Shoprocket requires the name on every update, so pass the current name to keep it. Only the fields you pass are sent. POST /v1/products/{id}.
Parametersskunamerequiredpricestatusweightsummaryquantitycategoriesproduct_idrequireddescriptionmax_order_quantitymin_order_quantity
shoprocket_list_categories
List categories
List product categories with id, name and slug. GET /v1/categories.
Parameterspagelimit
shoprocket_get_category
Get category
One category by id (cat_...); with expand_products also the products in it. GET /v1/categories/{id}.
Parameterscategory_idrequiredexpand_products
shoprocket_create_category
Create category
WRITE: create a product category (optionally assigning existing products). Calling twice with the same name may create a duplicate or be refused by Shoprocket. PUT /v1/categories.
Parametersnamerequiredslugproducts
shoprocket_update_category
Update category
WRITE: rename a category, change its slug, or set the products in it. Only the fields you pass are sent. POST /v1/categories/{id}.
Parametersnameslugproductscategory_idrequired
shoprocket_list_customers
List customers
List customers with name, email, phone, company, tax number, country and marketing opt-in. GET /v1/customers.
Parameterspagelimit
shoprocket_get_customer
Get customer
One customer by id (cus_...). GET /v1/customers/{id}.
Parameterscustomer_idrequired
shoprocket_create_customer
Create customer
WRITE: add a customer record (it does not email the customer). marketing_subscribed records newsletter consent: set it to true only if the customer actually opted in. PUT /v1/customers.
Parameterstax_numbercompany_namecustomer_namecustomer_emailrequiredcustomer_contactmarketing_subscribed
shoprocket_update_customer
Update customer
WRITE: change a customer's email, name, phone, company, tax number or newsletter consent. Only the fields you pass are sent. Set marketing_subscribed true only if the customer actually opted in. POST /v1/customers/{id}.
Parametersnameemailcontacttax_numbercustomer_idrequiredcompany_namemarketing_subscribed
shoprocket_list_discount_codes
List discount codes
List discount codes with type, value, what they apply to, usage limit and count, minimum order, dates and status. GET /v1/discount-codes.
Parameterspagelimit
shoprocket_get_discount_code
Get discount code
One discount code by id (ofr_...). GET /v1/discount-codes/{id}.
Parametersdiscount_code_idrequired
shoprocket_create_discount_code
Create discount code
WRITE: create a live discount code that shoppers can use at checkout and that reduces the store's revenue. Type fixed or percentage needs coupon_value; free_shipping does not. Use usage_limit and dates to bound it. Calling twice creates two codes. PUT /v1/discount-codes.
Parametersstart_datecoupon_codecoupon_typerequireddescriptionrequiredexpire_dateusage_limitcoupon_valuelimit_per_usercoupon_applies_torequiredminimum_order_valuecoupon_applies_to_value
shoprocket_list_automatic_discounts
List automatic discounts
List automatic discounts (applied at checkout without a code) with type, value, conditions, dates and status. GET /v1/automatic-discounts.
Parameterspagelimit
shoprocket_list_sales
List sale promotions
List sale promotions (price reductions on products) with type, value, what they apply to, dates and status. GET /v1/sale-promotions.
Parameterspagelimit
shoprocket_list_shipping_methods
List shipping methods
List the store's shipping methods and rates. GET /v1/shippings.
Parameterspagelimit
shoprocket_list_taxes
List taxes
List the store's tax rules. GET /v1/taxes.
Parameterspagelimit
shoprocket_list_zones
List shipping zones
List the store's shipping zones (the regions it ships to). GET /v1/zones.
Parameterspagelimit
shoprocket_list_payment_methods
List payment methods
List the store's payment gateways (Stripe, PayPal, manual...) and whether they are enabled. Gateway credentials are never returned. GET /v1/payment-methods.
Takes no parameters.