When you configure an export, import, other type of flow step using the prebuilt X-Cart 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 X-Cart API documentation. You can also create a composite endpoint for this application in HTTP mode.
Resource |
API endpoint |
Export |
Import |
---|---|---|---|
Address |
Retrieve a list of addresses from a profile |
X |
|
Retrieve an address from a profile |
X |
||
Add an address to a profile |
X |
||
Update the address of a profile |
X |
||
Delete an address from a profile |
X |
||
Attribute |
Retrieve a list of global yes/no attributes |
X |
|
Retrieve a global yes/no attribute |
X |
||
Retrieve a list of global hidden attributes |
X |
||
Retrieve a global hidden attribute |
X |
||
Retrieve a list of global plain field attributes |
X |
||
Retrieve a global plain field attribute |
X |
||
Retrieve a list of global textarea attributes |
X |
||
Retrieve a global textarea attribute |
X |
||
Retrieve a list of product class yes/no attributes |
X |
||
Retrieve a product class yes/no attribute |
X |
||
Retrieve a list of product class plain field attributes |
X |
||
Retrieve a product class plain field attribute |
X |
||
Retrieve a list of product class textarea attributes |
X |
||
Retrieve a product class textarea attribute |
X |
||
Retrieve a list of product-specific yes/no attributes |
X |
||
Retrieve a product-specific yes/no attribute |
X |
||
Retrieve a list of product-specific plain field attributes |
X |
||
Retrieve a product-specific plain field attribute |
X |
||
Retrieve a list of product-specific textarea attributes |
X |
||
Retrieve a product-specific textarea attribute |
X |
||
Create a global yes/no attribute |
X |
||
Update a global yes/no attribute |
X |
||
Delete a global yes/no attribute |
X |
||
Create a global hidden attribute |
X |
||
Update a global hidden attribute |
X |
||
Delete a global hidden attribute |
X |
||
Create a global plain field attribute |
X |
||
Update a global plain field attribute |
X |
||
Delete a global plain field attribute |
X |
||
Create a global textarea attribute |
X |
||
Update a global textarea attribute |
X |
||
Delete a global textarea attribute |
X |
||
Add a yes/no attribute to a product class |
X |
||
Update a product class yes/no attribute |
X |
||
Delete a product class yes/no attribute |
X |
||
Add a plain field attribute to a product class |
X |
||
Update a product class plain field attribute |
X |
||
Delete a product class plain field attribute |
X |
||
Add a textarea attribute to a product class |
X |
||
Update a product class textarea attribute |
X |
||
Delete a product class textarea attribute |
X |
||
Add a yes/no attribute to a product |
X |
||
Update a product-specific yes/no attribute |
X |
||
Delete a product-specific yes/no attribute |
X |
||
Add a plain field attribute to a product |
X |
||
Update a product-specific plain field attribute |
X |
||
Delete a product-specific plain field attribute |
X |
||
Add a textarea attribute to a product |
X |
||
Update a product-specific textarea attribute |
X |
||
Delete a product-specific textarea attribute |
X |
||
Attribute group |
Retrieve a list of attribute groups |
X |
|
Retrieve an attribute group |
X |
||
Retrieve a list of attribute groups from a product class |
X |
||
Retrieve an attribute group from a product class |
X |
||
Create an attribute group |
X |
||
Update an attribute group |
X |
||
Delete an attribute group |
X |
||
Add an attribute group to a product class |
X |
||
Update an attribute group of a product class |
X |
||
Delete attribute group |
X |
||
Attribute option |
Retrieve a list of options from a global hidden attribute |
X |
|
Retrieve an option from a global hidden attribute |
X |
||
Retrieve a list of options from a global plain field attribute |
X |
||
Retrieve an option from a global plain field attribute |
X |
||
Retrieve a list of options from a product class plain field attribute |
X |
||
Retrieve an option from a product class plain field attribute |
X |
||
Retrieve a list of options from a product-specific plain field attribute |
X |
||
Retrieve an option from a product-specific plain field attribute |
X |
||
Add an option to a global hidden attribute |
X |
||
Update an option of a global hidden attribute |
X |
||
Delete an option from a global hidden attribute |
X |
||
Add an option to a global plain field attribute |
X |
||
Update an option of a global plain field attribute |
X |
||
Delete an option from a global plain field attribute |
X |
||
Add an option to a product class plain field attribute |
X |
||
Update an option of a product class plain field attribute |
X |
||
Delete an option from a product class plain field attribute |
X |
||
Add an option to a product-specific plain field attribute |
X |
||
Update an option of a product-specific plain field attribute |
X |
||
Delete an option from a product-specific plain field attribute |
X |
||
Attribute property |
Retrieve a property from a product attribute |
X |
|
Update a property of a product attribute |
X |
||
Add a property to a product attribute |
X |
||
Cart |
Retrieve a list of carts |
X |
|
Retrieve a cart by ID |
X |
||
Category |
Retrieve a list of categories |
X |
|
Retrieve a category |
X |
||
Retrieve a list of products from a category |
X |
||
Retrieve category statistics |
X |
||
Create a category |
X |
||
Update a category |
X |
||
Delete a category |
X |
||
Update a category position in the categories tree |
X |
||
Add a product to a category |
X |
||
Delete a product from a category |
X |
||
Category banner |
Retrieve a banner from a category |
X |
|
Add a banner to a category |
X |
||
Delete a banner from a category |
X |
||
Category icon |
Retrieve an icon from a category |
X |
|
Add an icon to a category |
X |
||
Delete an icon from a category |
X |
||
Coupon |
Retrieve a list of coupons |
X |
|
Retrieve a coupon |
X |
||
Create a coupon |
X |
||
Update a coupon |
X |
||
Delete a coupon |
X |
||
Custom product tab |
Retrieve a list of custom product tabs |
X |
|
Retrieve a custom product tab |
X |
||
Create a custom product tab |
X |
||
Update a custom product tab |
X |
||
Delete a custom product tab |
X |
||
Detail |
Retrieve a list of cart details |
X |
|
Retrieve a list of order details |
X |
||
Featured product |
Retrieve a list of featured products from a category |
X |
|
Retrieve a featured product from a category |
X |
||
Retrieve a list of featured products from the front page |
X |
||
Add a featured product to a category |
X |
||
Delete a featured product from a category |
X |
||
Add a featured product to the front page |
X |
||
Delete a featured product from the front page |
X |
||
Hidden attribute value |
Retrieve a value from a product hidden attribute |
X |
|
Update the value of a product hidden attribute |
X |
||
Add a value to a product hidden attribute |
X |
||
Delete a value from a product hidden attribute |
X |
||
History event |
Retrieve a list of cart history events |
X |
|
Retrieve a list of order history events |
X |
||
Membership |
Retrieve a list of memberships |
X |
|
Retrieve a membership |
X |
||
Create a membership |
X |
||
Update a membership |
X |
||
Delete a membership |
X |
||
Order |
Retrieve a list of orders |
X |
|
Retrieve an order by order number |
X |
||
Retrieve an order by order ID |
X |
||
Plain field attribute value |
Retrieve a list of values from a product plain field attribute |
X |
|
Retrieve a value from a product plain field attribute |
X |
||
Add a value to a product plain field attribute |
X |
||
Update the value of a product plain field attribute |
X |
||
Delete a value from a product plain field attribute |
X |
||
Product |
Retrieve a list of products |
X |
|
Retrieve a product |
X |
||
Create a product |
X |
||
Update a product |
X |
||
Delete a product |
X |
||
Product attachment |
Retrieve a list of product attachments |
X |
|
Retrieve a product attachment |
X |
||
Create a product attachment |
X |
||
Update a product attachment |
X |
||
Delete a product attachment |
X |
||
Product class |
Retrieve a list of product classes |
X |
|
Retrieve a product class |
X |
||
Create a product class |
X |
||
Update a product class |
X |
||
Delete a product class |
X |
||
Product image |
Retrieve an image from a product |
X |
|
Add an image to a product |
X |
||
Update the properties of a product image |
X |
||
Delete an image from a product |
X |
||
Product pincode |
Retrieve a list of product pin codes |
X |
|
Retrieve a product pin code |
X |
||
Create a product pin code |
X |
||
Update a product pin code |
X |
||
Delete a product pin code |
X |
||
Product review |
Retrieve a list of product reviews |
X |
|
Retrieve a product review |
X |
||
Create a product review |
X |
||
Update a product review |
X |
||
Delete a product review |
X |
||
Product sticker |
Retrieve a list of product stickers |
X |
|
Retrieve a product sticker |
X |
||
Create a product sticker |
X |
||
Update a product sticker |
X |
||
Delete a product sticker |
X |
||
Product tag |
Retrieve a list of product tags |
X |
|
Retrieve a product tag |
X |
||
Create a product tag |
X |
||
Update a product tag |
X |
||
Delete a product tag |
X |
||
Product variant |
Retrieve a list of product variants |
X |
|
Retrieve a product variant |
X |
||
Create a product variant |
X |
||
Update a product variant |
X |
||
Delete a product variant |
X |
||
Product variant wholesale price |
Retrieve a list of wholesale prices from a product variant |
X |
|
Retrieve a wholesale price from a product variant |
X |
||
Add a wholesale price to a product variant |
X |
||
Update a wholesale price of a product variant |
X |
||
Delete wholesale price |
X |
||
Product wholesale price |
Retrieve a list of product wholesale prices |
X |
|
Retrieve a product wholesale price |
X |
||
Create a product wholesale price |
X |
||
Update a product wholesale price |
X |
||
Delete a product wholesale price |
X |
||
Profile |
Retrieve a list of profiles |
X |
|
Retrieve a profile |
X |
||
Create a profile |
X |
||
Update a profile |
X |
||
Delete a profile |
X |
||
Related product |
Retrieve a list of related products |
X |
|
Retrieve a related product |
X |
||
Create a related product |
X |
||
Update a related product |
X |
||
Delete a related product |
X |
||
Sale discount |
Retrieve a list of sale discounts |
X |
|
Retrieve a sale discount |
X |
||
Create a sale discount |
X |
||
Update a sale discount |
X |
||
Delete a sale discount |
X |
||
Tax class |
Retrieve a list of tax classes |
X |
|
Retrieve a tax class |
X |
||
Create a tax class |
X |
||
Update a tax class |
X |
||
Delete a tax class |
X |
||
Textarea attribute value |
Retrieve a value from a product textarea attribute |
X |
|
Update the value of a product textarea attribute |
X |
||
Add a value to a product textarea attribute |
X |
||
Delete a value from a product textarea attribute |
X |
||
Transaction |
Retrieve a list of cart payment transactions |
X |
|
Retrieve a list of order payment transactions |
X |
||
Vendor |
Retrieve a list of vendors |
X |
|
Retrieve a vendor |
X |
||
Update a vendor |
X |
||
Vendor transaction |
Retrieve a list of vendor transactions |
X |
|
Volume discount |
Retrieve a list of volume discounts |
X |
|
Retrieve a volume discount |
X |
||
Create a volume discount |
X |
||
Update a volume discount |
X |
||
Delete a volume discount |
X |
||
Yes/no attribute value |
Retrieve a list of values from a product yes/no attribute |
X |
|
Retrieve a value from a product yes/no attribute |
X |
||
Add a value to a product yes/no attribute |
X |
||
Update the value of a product yes/no attribute |
X |
||
Delete a value from a product yes/no attribute |
X |
Comments
Please sign in to leave a comment.