Spree Commerce
Spree Commerce API integration and workflow automation
Actions (44)
Account · 9
- Create an accountPOST /api/v2/storefront/account
Creates a new user account.
documented - Create an addressPOST /api/v2/storefront/account/addresses
Creates a new address for the current user.
documented - List addressesGET /api/v2/storefront/account/addresses
Returns addresses for the current user.
documented - List credit cardsGET /api/v2/storefront/account/credit_cards
Returns the current user's saved credit cards.
documented - Remove an addressDELETE /api/v2/storefront/account/addresses/{id}
Removes a specific address from the current user.
documented - Retrieve an accountGET /api/v2/storefront/account
Returns the current logged-in user's account details.
documented - Retrieve an orderGET /api/v2/storefront/account/orders/{order_number}
Retrieves a specific order for the current user.
documented - Update an accountPATCH /api/v2/storefront/account
Updates the current user's account details.
documented - Update an addressPATCH /api/v2/storefront/account/addresses/{id}
Updates a specific address for the current user.
documented
Orders · 9
- Approve an orderPATCH /api/v2/platform/orders/{id}/approve
Approves an order.
documented - Approve an orderPATCH /api/v2/platform/orders/{id}/approve
Approves an order (admin/approver).
documented - Complete an orderPATCH /api/v2/platform/orders/{id}/complete
Marks an order as complete.
documented - Complete an orderGET /api/v2/platform/orders/{id}/complete
Marks a platform order as complete.
documented - Create an orderPOST /api/v2/platform/orders
Creates a new platform order.
documented - List ordersGET /api/v2/platform/orders
Returns the platform orders.
documented - Next an orderPATCH /api/v2/platform/orders/{id}/next
Moves an order to the next state.
documented - Retrieve an orderGET /api/v2/platform/orders/{id}
Retrieves a platform order by ID.
documented - Use store credit for an orderPATCH /api/v2/platform/orders/{id}/use_store_credit
Applies store credit to an order.
documented
Cart · 8
- Add item to cartPOST /api/v2/storefront/cart/add_item
Adds a line item (variant) to the current cart.
documented - Apply gift card to cartPOST /api/v2/storefront/cart/apply_gift_card
Applies a gift card code to the current cart.
documented - Create a cartPOST /api/v2/storefront/cart
Creates a new shopping cart (guest or user).
documented - Delete a cartDELETE /api/v2/storefront/cart
Deletes the current cart and cancels shipments/payments.
documented - Remove a coupon codeDELETE /api/v2/storefront/cart/remove_coupon_code/{coupon_code}
Removes a specific coupon from the cart.
documented - Remove all couponsDELETE /api/v2/storefront/cart/remove_coupon_code
Removes all coupons applied to the cart.
documented - Retrieve a cartGET /api/v2/storefront/cart
Returns the current cart by order token.
documented - Set line item quantityPATCH /api/v2/storefront/cart/set_quantity
Sets the quantity for a given line item.
documented
Addresses · 5
- Create an addressPOST /api/v2/platform/addresses
Creates a new address for a user in the platform.
documented - Delete an addressDELETE /api/v2/platform/addresses/{id}
Deletes a specific address.
documented - List addressesGET /api/v2/platform/addresses
Returns the addresses in the platform (admin) tenant.
documented - Retrieve an addressGET /api/v2/platform/addresses/{id}
Retrieves a specific address by ID.
documented - Update an addressPATCH /api/v2/platform/addresses/{id}
Updates a specific address.
documented
Checkout · 4
- Complete checkoutPATCH /api/v2/storefront/checkout/complete
Completes the checkout flow and creates a completed order.
documented - Create paymentPOST /api/v2/storefront/checkout/create_payment
Creates a new payment for the current checkout.
documented - List shipping ratesGET /api/v2/storefront/checkout/shipping_rates
Returns available shipping rates for the current checkout.
documented - Update checkoutPATCH /api/v2/storefront/checkout
Updates the checkout state (address, shipping, etc.).
documented
Products · 4
- Fetch product with variantsGET /api/v2/storefront/products/classic-varsity-top
Fetch a product with related resources (e.g., variants, images) via include.
documented - List all productsGET /api/v2/storefront/products
Returns a list of products for the current store.
documented - List platform productsGET /api/v2/platform/products
Lists products in the platform (admin) context.
documented - Retrieve a productGET /api/v2/storefront/products/{id}
Returns a specific product by ID.
documented