Available Spree Commerce APIs

Tanisha Ray

Updated November 25, 2024 17:23

When you configure an export, import, or other type of flow step using the prebuilt Spree Commerce connector, you can select any of the API operations listed below*, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Spree Commerce API documentation. *You can also create a composite endpoint for this application in HTTP mode.

Resource	API endpoint	Export	Import
Products	Index	X
	Show	X
	Search	X
	Create		X
	Update		X
	Delete		X
Product properties	Index	X
	Show	X
	Search	X
	Create		X
	Update		X
	Delete		X
Variants	Index	X
	Show	X
	Search	X
	Create		X
	Update		X
	Delete		X
Option types	Index	X
	Show	X
	Search	X
	Create		X
	Update		X
	Delete		X
Option values	Index	X
	Show	X
	Search	X
	Create		X
	Update		X
	Delete		X
Orders	Index	X
	Show	X
	Search	X
	Create		X
	Empty		X
Payments	Index	X
	Show	X
	Search	X
	Create		X
	Authorize		X
	Capture		X
	Purchase		X
	Void		X
	Credit		X
Shipments	Index	X
	Create		X
	Update		X
	Ready		X
	Ship		X
	Add variant		X
	Remove variant		X
Return authorizations	Index	X
	Show	X
	Search	X
	Create		X
	Update		X
	Delete		X
Taxonomies	Index	X
	Show	X
	Search	X
	Taxon index	X
	Taxon show	X
	Create		X
	Update		X
	Delete		X
	Taxon create		X
	Taxon update		X
	Taxon delete		X
Addresses	Index	X
Countries	Index	X
	Show	X
	Search	X
Stock locations	Index	X
	Show	X
	Search	X
	Create		X
	Update		X
	Delete		X
Stock items	Index	X
	Show	X
	Search	X
	Create		X
	Update		X
	Delete		X
Stock movements	Index	X
	Show	X
	Search	X
	Create		X
	Update		X
Zones	Index	X
	Show	X
	Search	X
	Create		X
	Update		X
	Delete		X
Checkouts	Add line items to an order		X
	Updating an order		X
	Delivery		X
	Payment		X
	Confirm		X
	Complete		X
Line items	Create		X
	Update		X
	Delete		X