Spree Commerce

Spree Platform API

Spree Platform API

E-commerce#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Spree Platform API

Endpoints 230

Addresses

  • GETReturn a list of Addresses/api/v2/platform/addressesReturns a list of Addresses
  • POSTCreate an Address/api/v2/platform/addressesCreates an Address
  • GETReturn an Address/api/v2/platform/addresses/:idReturns an Address
  • DELETEDelete an Address/api/v2/platform/addresses/:idDeletes an Address
  • PATCHUpdate an Address/api/v2/platform/addresses/:idUpdates an Address

Adjustments

  • GETReturn a list of Adjustments/api/v2/platform/adjustmentsReturns a list of Adjustments
  • POSTCreate an Adjustment/api/v2/platform/adjustmentsCreates an Adjustment
  • GETReturn an Adjustment/api/v2/platform/adjustments/:idReturns an Adjustment
  • DELETEDelete an Adjustment/api/v2/platform/adjustments/:idDeletes an Adjustment
  • PATCHUpdate an Adjustment/api/v2/platform/adjustments/:idUpdates an Adjustment

Classifications

  • GETReturn a list of Classifications/api/v2/platform/classificationsReturns a list of Classifications
  • POSTCreate a Classification/api/v2/platform/classificationsCreates a Classification
  • GETReturn a Classification/api/v2/platform/classifications/:idReturns a Classification
  • DELETEDelete a Classification/api/v2/platform/classifications/:idDeletes a Classification
  • PATCHUpdate a Classification/api/v2/platform/classifications/:idUpdates a Classification

Countries

  • GETReturns a list of Countries/api/v2/platform/countriesReturns a list of Countries
  • GETReturns a Country/api/v2/platform/countries/:idReturns a Country

CMS Pages

  • GETReturn a list of CMS Pages/api/v2/platform/cms_pagesReturns a list of CMS Pages
  • POSTCreate a CMS Page/api/v2/platform/cms_pagesCreates a CMS Page
  • GETReturn a CMS Page/api/v2/platform/cms_pages/:idReturns a CMS Page
  • DELETEDelete a CMS Page/api/v2/platform/cms_pages/:idDeletes a CMS Page
  • PATCHUpdate a CMS Page/api/v2/platform/cms_pages/:idUpdates a CMS Page

CMS Sections

  • GETReturn a list of CMS Sections/api/v2/platform/cms_sectionsReturns a list of CMS Sections
  • POSTCreate a CMS Section/api/v2/platform/cms_sectionsCreates a CMS Section
  • GETReturn a CMS Section/api/v2/platform/cms_sections/:idReturns a CMS Section
  • DELETEDelete a CMS Section/api/v2/platform/cms_sections/:idDeletes a CMS Section
  • PATCHUpdate a CMS Section/api/v2/platform/cms_sections/:idUpdates a CMS Section

Digital Assets

  • GETReturn a list of Digital Assets/api/v2/platform/digitalsReturns a list of Digital Assets
  • POSTCreate a Digital Asset/api/v2/platform/digitalsCreates a Digital Asset
  • GETReturn a Digital Asset/api/v2/platform/digitals/:idReturns a Digital Asset
  • DELETEDelete a Digital Asset/api/v2/platform/digitals/:idDeletes a Digital Asset
  • PATCHUpdate a Digital Asset/api/v2/platform/digitals/:idUpdates a Digital Asset

Digital Links

  • GETReturn a list of Digital Links/api/v2/platform/digital_linksReturns a list of Digital Links
  • POSTCreate a Digital Link/api/v2/platform/digital_linksCreates a Digital Link
  • GETReturn a Digital Link/api/v2/platform/digital_links/:idReturns a Digital Link
  • DELETEDelete a Digital Link/api/v2/platform/digital_links/:idDeletes a Digital Link
  • PATCHUpdate a Digital Link/api/v2/platform/digital_links/:idUpdates a Digital Link
  • PATCHReset a Digital Link/api/v2/platform/digital_links/:id/resetResets a digital link, allowing further downloads.

Line Items

  • GETReturn a list of Line Items/api/v2/platform/line_itemsReturns a list of Line Items
  • POSTCreate a Line Item/api/v2/platform/line_itemsCreates a Line Item
  • GETReturn a Line Item/api/v2/platform/line_items/:idReturns a Line Item
  • DELETEDelete a Line Item/api/v2/platform/line_items/:idDeletes a Line Item
  • PATCHUpdate a Line Item/api/v2/platform/line_items/:idUpdates a Line Item

Menus

  • GETReturn a list of Menus/api/v2/platform/menusReturns a list of Menus
  • POSTCreate a Menu/api/v2/platform/menusCreates a Menu
  • GETReturn a Menu/api/v2/platform/menus/:idReturns a Menu
  • DELETEDelete a Menu/api/v2/platform/menus/:idDeletes a Menu
  • PATCHUpdate a Menu/api/v2/platform/menus/:idUpdates a Menu

Menu Items

  • GETReturn a list of Menu Items/api/v2/platform/menu_itemsReturns a list of Menu Items
  • POSTCreate a Menu Item/api/v2/platform/menu_itemsCreates a Menu Item
  • GETReturn a Menu Item/api/v2/platform/menu_items/:idReturns a Menu Item
  • DELETEDelete a Menu Item/api/v2/platform/menu_items/:idDeletes a Menu Item
  • PATCHUpdate a Menu Item/api/v2/platform/menu_items/:idUpdates a Menu Item
  • PATCHReposition a Menu Item/api/v2/platform/menu_items/:id/repositionReposition a Menu Item

Option Types

  • GETReturn a list of Option Types/api/v2/platform/option_typesReturns a list of Option Types
  • POSTCreate an Option Type/api/v2/platform/option_typesCreates an Option Type
  • GETReturn an Option Type/api/v2/platform/option_types/:idReturns an Option Type
  • DELETEDelete an Option Type/api/v2/platform/option_types/:idDeletes an Option Type
  • PATCHUpdate an Option Type/api/v2/platform/option_types/:idUpdates an Option Type

Option Values

  • GETReturn a list of Option Values/api/v2/platform/option_valuesReturns a list of Option Values
  • POSTCreate an Option Value/api/v2/platform/option_valuesCreates an Option Value
  • GETReturn an Option Value/api/v2/platform/option_values/:idReturns an Option Value
  • DELETEDelete an Option Value/api/v2/platform/option_values/:idDeletes an Option Value
  • PATCHUpdate an Option Value/api/v2/platform/option_values/:idUpdates an Option Value

Orders

  • GETReturn a list of Orders/api/v2/platform/ordersReturns a list of Orders
  • POSTCreates an Order/api/v2/platform/ordersCreates an Order
  • GETReturn an Order/api/v2/platform/orders/:idReturns an Order
  • DELETEDelete an Order/api/v2/platform/orders/:idDeletes an Order
  • PATCHUpdate an Order/api/v2/platform/orders/:idUpdates an Order
  • PATCHAdvances an Order/api/v2/platform/orders/:id/advanceAdvances an Order
  • PATCHNext an Order/api/v2/platform/orders/:id/nextMoves an Order to the next state
  • PATCHCompletes an Order/api/v2/platform/orders/:id/completeMarks an Order as completed
  • PATCHEmpties an Order/api/v2/platform/orders/:id/emptyRemoves all line items, promotions, shipment and payments from an Order
  • PATCHApproves an Order/api/v2/platform/orders/:id/approveApproves an Order, when using a token created for a user, it will save this user as the approver
  • PATCHCancels an Order/api/v2/platform/orders/:id/cancelCancels an Order, when using a token created for a user, it will save this user as the canceler
  • PATCHUse Store Credit for an Order/api/v2/platform/orders/:id/use_store_creditCreates Store Credit payment for an Order
  • PATCHApply Coupon Code for an Order/api/v2/platform/orders/:id/apply_coupon_codeCreates Store Credit payment for an Order

Payments

  • GETReturn a list of Payments/api/v2/platform/paymentsReturns a list of Payments
  • GETReturn a Payment/api/v2/platform/payments/:idReturns a Payment
  • DELETEDelete a Payment/api/v2/platform/payments/:idDeletes a Payment

Payment Methods

  • GETReturn a list of Payment Methods/api/v2/platform/payment_methodsReturns a list of Payment Methods
  • POSTCreate a Payment Method/api/v2/platform/payment_methodsCreates a Payment Method
  • GETReturn a Payment Method/api/v2/platform/payment_methods/:idReturns a Payment Method
  • DELETEDelete a Payment Method/api/v2/platform/payment_methods/:idDeletes a Payment Method
  • PATCHUpdate a Payment Method/api/v2/platform/payment_methods/:idUpdates a Payment Method

Products

  • GETReturn a list of Products/api/v2/platform/productsReturns a list of Products
  • POSTCreate a Product/api/v2/platform/productsCreates a Product
  • GETReturn a Product/api/v2/platform/products/:idReturns a Product
  • DELETEDelete a Product/api/v2/platform/products/:idDeletes a Product
  • PATCHUpdate a Product/api/v2/platform/products/:idUpdates a Product

Promotions

  • GETReturn a list of Promotions/api/v2/platform/promotionsReturns a list of Promotions
  • POSTCreate a Promotion/api/v2/platform/promotionsCreates a Promotion
  • GETReturn a Promotion/api/v2/platform/promotions/:idReturns a Promotion
  • DELETEDelete a Promotion/api/v2/platform/promotions/:idDeletes a Promotion
  • PATCHUpdate a Promotion/api/v2/platform/promotions/:idUpdates a Promotion

Promotion Actions

  • GETReturn a list of Promotion Actions/api/v2/platform/promotion_actionsReturns a list of Promotion Actions
  • POSTCreate a Promotion Action/api/v2/platform/promotion_actionsCreates a Promotion Action
  • GETReturn a Promotion Action/api/v2/platform/promotion_actions/:idReturns a Promotion Action
  • DELETEDelete a Promotion Action/api/v2/platform/promotion_actions/:idDeletes a Promotion Action
  • PATCHUpdate a Promotion Action/api/v2/platform/promotion_actions/:idUpdates a Promotion Action

Promotion Categories

  • GETReturn a list of Promotion Categories/api/v2/platform/promotion_categoriesReturns a list of Promotion Categories
  • POSTCreate a Promotion Category/api/v2/platform/promotion_categoriesCreates a Promotion Category
  • GETReturn a Promotion Category/api/v2/platform/promotion_categories/:idReturns a Promotion Category
  • DELETEDelete a Promotion Category/api/v2/platform/promotion_categories/:idDeletes a Promotion Category
  • PATCHUpdate a Promotion Category/api/v2/platform/promotion_categories/:idUpdates a Promotion Category

Promotion Rules

  • GETReturn a list of Promotion Rules/api/v2/platform/promotion_rulesReturns a list of Promotion Rules
  • POSTCreate a Promotion Rule/api/v2/platform/promotion_rulesCreates a Promotion Rule
  • GETReturn a Promotion Rule/api/v2/platform/promotion_rules/:idReturns a Promotion Rule
  • DELETEDelete a Promotion Rule/api/v2/platform/promotion_rules/:idDeletes a Promotion Rule
  • PATCHUpdate a Promotion Rule/api/v2/platform/promotion_rules/:idUpdates a Promotion Rule

Roles

  • GETReturn a list of Roles/api/v2/platform/rolesReturns a list of Roles
  • POSTCreate a Role/api/v2/platform/rolesCreates a Role
  • GETReturn a Role/api/v2/platform/roles/:idReturns a Role
  • DELETEDelete a Role/api/v2/platform/roles/:idDeletes a Role
  • PATCHUpdate a Role/api/v2/platform/roles/:idUpdates a Role

Shipments

  • GETReturn a list of Shipments/api/v2/platform/shipmentsReturns a list of Shipments
  • POSTCreate a Shipment/api/v2/platform/shipmentsCreates a Shipment
  • GETReturn a Shipment/api/v2/platform/shipments/:idReturns a Shipment
  • DELETEDelete a Shipment/api/v2/platform/shipments/:idDeletes a Shipment
  • PATCHUpdate a Shipment/api/v2/platform/shipments/:idUpdates a Shipment
  • PATCHAdds item (Variant) to an existing Shipment/api/v2/platform/shipments/:id/add_itemIf selected Variant was already added to Order it will increase the quantity of existing Line Item, if not it will create a new Line Item
  • PATCHRemoves item (Variant) from Shipment/api/v2/platform/shipments/:id/remove_itemIf selected Variant is removed completely and Shipment doesn't include any other Line Items, Shipment itself will be deleted
  • PATCHMark Shipment as ready to be shipped/api/v2/platform/shipments/:id/readyMarks Shipment as ready to be shipped
  • PATCHMark Shipment as shipped/api/v2/platform/shipments/:id/shipMarks Shipment as shipped
  • PATCHCancels the Shipment/api/v2/platform/shipments/:id/cancelCancels the Shipment
  • PATCHResumes the Shipment/api/v2/platform/shipments/:id/resumeResumes previously canceled Shipment
  • PATCHMoves Shipment back to pending state/api/v2/platform/shipments/:id/pendMoves Shipment back to pending state

Shipping Categories

  • GETReturn a list of Shipping Categories/api/v2/platform/shipping_categoriesReturns a list of Shipping Categories
  • POSTCreate a Shipping Category/api/v2/platform/shipping_categoriesCreates a Shipping Category
  • GETReturn a Shipping Category/api/v2/platform/shipping_categories/:idReturns a Shipping Category
  • DELETEDelete a Shipping Category/api/v2/platform/shipping_categories/:idDeletes a Shipping Category
  • PATCHUpdate a Shipping Category/api/v2/platform/shipping_categories/:idUpdates a Shipping Category

Shipping Methods

  • GETReturn a list of Shipping Methods/api/v2/platform/shipping_methodsReturns a list of Shipping Methods
  • POSTCreate a Shipping Method/api/v2/platform/shipping_methodsCreates a Shipping Method
  • GETReturn a Shipping Method/api/v2/platform/shipping_methods/:idReturns a Shipping Method
  • DELETEDelete a Shipping Method/api/v2/platform/shipping_methods/:idDeletes a Shipping Method
  • PATCHUpdate a Shipping Method/api/v2/platform/shipping_methods/:idUpdates a Shipping Method

States

  • GETReturns a list of States/api/v2/platform/statesReturns a list of States
  • GETReturns a State/api/v2/platform/states/:idReturns a State

Stock Items

  • GETReturn a list of Stock Items/api/v2/platform/stock_itemsReturns a list of Stock Items
  • POSTCreate a Stock Item/api/v2/platform/stock_itemsCreates a Stock Item
  • GETReturn a Stock Item/api/v2/platform/stock_items/:idReturns a Stock Item
  • DELETEDelete a Stock Item/api/v2/platform/stock_items/:idDeletes a Stock Item
  • PATCHUpdate a Stock Item/api/v2/platform/stock_items/:idUpdates a Stock Item

Stock Locations

  • GETReturn a list of Stock Locations/api/v2/platform/stock_locationsReturns a list of Stock Locations
  • POSTCreate a Stock Location/api/v2/platform/stock_locationsCreates a Stock Location
  • GETReturn a Stock Location/api/v2/platform/stock_locations/:idReturns a Stock Location
  • DELETEDelete a Stock Location/api/v2/platform/stock_locations/:idDeletes a Stock Location
  • PATCHUpdate a Stock Location/api/v2/platform/stock_locations/:idUpdates a Stock Location

Store Credit Categories

  • GETReturn a list of Store Credit Categories/api/v2/platform/store_credit_categoriesReturns a list of Store Credit Categories
  • POSTCreate a Store Credit Category/api/v2/platform/store_credit_categoriesCreates a Store Credit Category
  • GETReturn a Store Credit Category/api/v2/platform/store_credit_categories/:idReturns a Store Credit Category
  • DELETEDelete a Store Credit Category/api/v2/platform/store_credit_categories/:idDeletes a Store Credit Category
  • PATCHUpdate a Store Credit Category/api/v2/platform/store_credit_categories/:idUpdates a Store Credit Category

Store Credit Types

  • GETReturn a list of Store Credit Types/api/v2/platform/store_credit_typesReturns a list of Store Credit Types
  • POSTCreate a Store Credit Type/api/v2/platform/store_credit_typesCreates a Store Credit Type
  • GETReturn a Store Credit Type/api/v2/platform/store_credit_types/:idReturns a Store Credit Type
  • DELETEDelete a Store Credit Type/api/v2/platform/store_credit_types/:idDeletes a Store Credit Type
  • PATCHUpdate a Store Credit Type/api/v2/platform/store_credit_types/:idUpdates a Store Credit Type

Store Credits

  • GETReturn a list of Store Credits/api/v2/platform/store_creditsReturns a list of Store Credits
  • POSTCreate a Store Credit/api/v2/platform/store_creditsCreates a Store Credit
  • GETReturn a Store Credit/api/v2/platform/store_credits/:idReturns a Store Credit
  • DELETEDelete a Store Credit/api/v2/platform/store_credits/:idDeletes a Store Credit
  • PATCHUpdate a Store Credit/api/v2/platform/store_credits/:idUpdates a Store Credit

Tax Categories

  • GETReturn a list of Tax Categories/api/v2/platform/tax_categoriesReturns a list of Tax Categories
  • POSTCreate a Tax Category/api/v2/platform/tax_categoriesCreates a Tax Category
  • GETReturn a Tax Category/api/v2/platform/tax_categories/:idReturns a Tax Category
  • DELETEDelete a Tax Category/api/v2/platform/tax_categories/:idDeletes a Tax Category
  • PATCHUpdate a Tax Category/api/v2/platform/tax_categories/:idUpdates a Tax Category

Tax Rates

  • GETReturn a list of Tax Rates/api/v2/platform/tax_ratesReturns a list of Tax Rates
  • POSTCreate a Tax Rate/api/v2/platform/tax_ratesCreates a Tax Rate
  • GETReturn a Tax Rate/api/v2/platform/tax_rates/:idReturns a Tax Rate
  • DELETEDelete a Tax Rate/api/v2/platform/tax_rates/:idDeletes a Tax Rate
  • PATCHUpdate a Tax Rate/api/v2/platform/tax_rates/:idUpdates a Tax Rate

Taxons

  • GETReturn a list of Taxons/api/v2/platform/taxonsReturns a list of Taxons
  • POSTCreate a Taxon/api/v2/platform/taxonsCreates a Taxon
  • GETReturn a Taxon/api/v2/platform/taxons/:idReturns a Taxon
  • DELETEDelete a Taxon/api/v2/platform/taxons/:idDeletes a Taxon
  • PATCHUpdate a Taxon/api/v2/platform/taxons/:idUpdates a Taxon
  • PATCHReposition a Taxon/api/v2/platform/taxons/:id/repositionReposition a Taxon

Taxonomies

  • GETReturn a list of Taxonomies/api/v2/platform/taxonomiesReturns a list of Taxonomies
  • POSTCreate a Taxonomy/api/v2/platform/taxonomiesCreates a Taxonomy
  • GETReturn a Taxonomy/api/v2/platform/taxonomies/:idReturns a Taxonomy
  • DELETEDelete a Taxonomy/api/v2/platform/taxonomies/:idDeletes a Taxonomy
  • PATCHUpdate a Taxonomy/api/v2/platform/taxonomies/:idUpdates a Taxonomy

Users

  • GETReturn a list of Users/api/v2/platform/usersReturns a list of Users
  • POSTCreate a User/api/v2/platform/usersCreates a User
  • GETReturn a User/api/v2/platform/users/:idReturns a User
  • DELETEDelete a User/api/v2/platform/users/:idDeletes a User
  • PATCHUpdate a User/api/v2/platform/users/:idUpdates a User

Variants

  • GETReturn a list of Variants/api/v2/platform/variantsReturns a list of Variants
  • GETReturn a Variant/api/v2/platform/variants/:idReturns a Variant
  • DELETEDelete a Variant/api/v2/platform/variants/:idDeletes a Variant

Vendors

  • GETReturn a list of Vendors/api/v2/platform/vendorsReturns a list of Vendors. Only available in Enterprise Edition
  • POSTCreate a Vendor/api/v2/platform/vendorsCreates a Vendor. Only available in Enterprise Edition
  • GETReturn a Vendor/api/v2/platform/vendors/:idReturns a Vendor. Only available in Enterprise Edition
  • DELETEDelete a Vendor/api/v2/platform/vendors/:idDeletes a Vendor. Only available in Enterprise Edition
  • PATCHUpdate a Vendor/api/v2/platform/vendors/:idUpdates a Vendor. Only available in Enterprise Edition
  • PATCHInvites Vendor to the platform/api/v2/platform/vendors/:id/inviteAlso triggers an invitation email send out to the vendor's contact person. Only available in Enterprise Edition
  • PATCHStart onboarding process/api/v2/platform/vendors/:id/start_onboardingMarks Vendor as onboarding in progress. Only available in Enterprise Edition
  • PATCHCompletes onboarding process/api/v2/platform/vendors/:id/complete_onboardingMarks Vendor as onboarding complete. Only available in Enterprise Edition
  • PATCHApproves Vendor/api/v2/platform/vendors/:id/approveMarks Vendor as approved, and triggers an approval email send out to the vendor's contact person. Also activated Vendor products will become available for…
  • PATCHRejects Vendor/api/v2/platform/vendors/:id/rejectMarks Vendor as rejected, and triggers an approval email send out to the vendor's contact person. Only available in Enterprise Edition
  • PATCHSuspends Vendor/api/v2/platform/vendors/:id/suspendMarks Vendor as suspended, and triggers an approval email send out to the vendor's contact person. Also the vendor's products will become unavailable for…

Webhook Events

  • GETReturn a list of Webhook Events/api/v2/platform/webhooks/eventsReturns a list of Webhook Events

Webhook Subscribers

  • GETReturn a list of Webhook Subscribers/api/v2/platform/webhooks/subscribersReturns a list of Webhook Subscribers
  • POSTCreate a Webhook Subscriber/api/v2/platform/webhooks/subscribersCreates a Webhook Subscriber
  • GETReturn a Webhook Subscriber/api/v2/platform/webhooks/subscribers/:idReturns a Webhook Subscriber
  • DELETEDelete a Webhook Subscriber/api/v2/platform/webhooks/subscribers/:idDeletes a Webhook Subscriber
  • PATCHUpdate a Webhook Subscriber/api/v2/platform/webhooks/subscribers/:idUpdates a Webhook Subscriber

Wishlists

  • GETReturn a list of Wishlists/api/v2/platform/wishlistsReturns a list of Wishlists
  • POSTCreate a Wishlist/api/v2/platform/wishlistsCreates a Wishlist
  • GETReturn a Wishlist/api/v2/platform/wishlists/:idReturns a Wishlist
  • DELETEDelete a Wishlist/api/v2/platform/wishlists/:idDeletes a Wishlist
  • PATCHUpdate a Wishlist/api/v2/platform/wishlists/:idUpdates a Wishlist

Wished Items

  • GETReturn a list of Wished Items/api/v2/platform/wished_itemsReturns a list of Wished Items
  • POSTCreate a Wished Item/api/v2/platform/wished_itemsCreates a Wished Item
  • GETReturn a Wished Item/api/v2/platform/wished_items/:idReturns a Wished Item
  • DELETEDelete a Wished Item/api/v2/platform/wished_items/:idDeletes a Wished Item
  • PATCHUpdate a Wished Item/api/v2/platform/wished_items/:idUpdates a Wished Item

Zones

  • GETReturn a list of Zones/api/v2/platform/zonesReturns a list of Zones
  • POSTCreate a Zone/api/v2/platform/zonesCreates a Zone
  • GETReturn a Zone/api/v2/platform/zones/:idReturns a Zone
  • DELETEDelete a Zone/api/v2/platform/zones/:idDeletes a Zone
  • PATCHUpdate a Zone/api/v2/platform/zones/:idUpdates a Zone

Data Feeds

  • GETReturn a list of Data Feeds/api/v2/platform/data_feeds
  • POSTCreate a Data Feed/api/v2/platform/data_feedsCreates a Data Feed
  • GETReturn a Data Feed/api/v2/platform/data_feeds/:idReturns a Data Feed
  • DELETEDelete a Data Feed/api/v2/platform/data_feeds/:idDeletes a Data Feed
  • PATCHUpdate a Data Feed/api/v2/platform/data_feeds/:idUpdates a Data Feed

API details

Base URL
http://{defaultHost}
Authentication
A bearer token in the Authorization header
Operations
230 operations on 111 pathsGET 87PATCH 63DELETE 41POST 39
Main resources
Orders 13Shipments 12Vendors 11Digital Links 6Menu Items 6Taxons 6Addresses 5Adjustments 5CMS Pages 5CMS Sections 5
Response formats
application/vnd.api+json
Description format
OpenAPI 3.0.3, API version v2

How to test the Spree Platform API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Spree Platform API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Return a list of Addresses” (GET /api/v2/platform/addresses), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Spree Platform API?

Spree Platform API It is listed under E-commerce and has 230 endpoints.

Who publishes the Spree Platform API?

It is listed from Spree Commerce's public API description (an OpenAPI document), not published by Spree Commerce on Swastik Codes. Anyone who controls spreecommerce.org can claim the profile by adding a DNS TXT record.

What is the base URL of the Spree Platform API?

Requests go to http://{defaultHost}. Endpoint paths are added to this base URL.

How do I authenticate with the Spree Platform API?

With A bearer token in the Authorization header.

How many endpoints does the Spree Platform API have?

230 operations on 111 paths (87 GET, 63 PATCH, 41 DELETE, 39 POST). The largest groups are Orders, Shipments, Vendors, Digital Links.

Is forking the Spree Platform API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.