Available Shift4Shop (formerly 3dCart) APIs

Naga Sri Hari Gonaboyina

Updated November 25, 2024 17:22

When you configure an export, import, or other type of flow step using the prebuilt Shift4Shop 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 Shift4Shop API documentation. *You can also create a composite endpoint for this application in HTTP mode.

Resource	API endpoint	Export	Import
Admins	Get all admin users	X
	Get an admin user	X
	Get all admin permissions	X
	Get a permission	X
	Get the logintoken from a specific admin user	X
	Adds a new admin user to the system		X
	Update a single admin record in the database		X
	Delete an admin		X
Carts	Get a specific cart	X
	Adds a new cart to the system		X
	Adds a new item to a cart		X
	Update a single cart record in the database		X
	Updates a specific item from a specific cart		X
	Deletes a cartitem in the system		X
	Delete a cart in the system		X
Categories	Create		X
	Update		X
	Delete		X
	Create options		X
	Update options		X
Category	Get all categories	X
	Get a category	X
	Get the options from a specific category	X
CRM	Get all CRMs	X
	Get a specific CRM	X
	Get all the messages from a specific CRM	X
	Get all CRM departments	X
	Get all CRM status	X
	Get all CRM saved reply	X
	Get all CRM saved reply	X
	Get all CRM saved reply	X
	Get all the messages from a specific CRM	X
	Adds a new CRM to the system		X
	Adds a new CRM message to the system		X
	Adds a new CRM save reply to the system		X
	Update a single CRM record in the database		X
	Update a single CRM status record in the database		X
	Update a single CRM saved reply record in the database		X
	Delete a CRM in the system		X
	Delete a CRM message in the system		X
	Delete a CRM saved reply in the system		X
Customer groups	Get all customer groups	X
	Get a customer group	X
	Create		X
	Update		X
	Delete		X
Customers	Get all customers	X
	Get a customer	X
	Get customers from a customer group	X
	Create		X
	Update		X
	Delete		X
Distributors	Get all distributors	X
	Get a distributor	X
	Create		X
	Update		X
	Delete		X
Frontend scripts	Get all frontend scripts	X
	Get a frontend script	X
	Adds a new frontend script to the system		X
	Update a single frontend script record in the database		X
	Delete a frontend script		X
Gift registries	Get all gift registries	X
	Get a specific gift registry	X
	Gets the items from a specific gift registry	X
Manufacturers	Get all manufacturers	X
	Get a manufacturer	X
	Create		X
	Update		X
	Delete		X
Orders	Get all orders	X
	Get a specific order	X
	Gets the shipments from a specific order	X
	Gets the items from a specific order	X
	Gets the transactions from a specific order	X
	Gets the questions from a specific order	X
	Create		X
	Update		X
	Create shipments		X
	Update shipments		X
	Create items		X
	Update items		X
	Create transactions		X
	Update transactions		X
	Create questions		X
	Update questions		X
Order status	Get all order status	X
Order status	Get an order status	X
Payment tokens	Get all payment tokens	X
	Get a payment token	X
	Adds a new payment token to the system		X
	Update a single payment token record in the database		X
	Delete a payment token		X
Products	Get all products	X
	Get a product	X
	Get all products from a specific distributor	X
	Get all products from a specific manufacturer	X
	Get all products from a specific category	X
	Get all products (SKU info section only)	X
	Get all products by catalog ID (SKU info section only)	X
	Get the options from a specific product	X
	Get the categories from a specific product	X
	Get the distributors from a specific product	X
	Get the images from a specific product	X
	Get the features from a specific product	X
	Get the related products from a specific product	X
	Get the upselling products from a specific product	X
	Get the discounts from a specific product	X
	Get the serials from a specific product	X
	Get the advanced options from a specific product	X
	Get the eproducts from a specific product	X
	Create		X
	Update		X
	Delete		X
	Create images		X
	Update images		X
	Create features		X
	Update features		X
	Create related		X
	Update related		X
	Create upselling		X
	Update upselling		X
	Create discount		X
	Update discount		X
	Create serials		X
	Update serials		X
	Create eproducts		X
	Update eproducts		X
	Create options		X
	Update options		X
	Update advanced options		X
Promotions	Get all promotions	X
	Get a promotion	X
	Adds a new promotion to the system		X
	Update a single promotion record in the database		X
	Deletes a promotions in the system		X
RMA	Get all RMAs	X
	Get a specific RMA	X
	Gets the items from a specific RMA	X
Store settings	Get the store settings	X
Store settings	Update the store settings in the database		X