When you configure an export, import, other type of flow step using the prebuilt ChannelEngine 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 ChannelEngine API documentation. You can also create a composite endpoint for this application in HTTP mode.
|
Resource |
API endpoint |
Export |
Import |
|---|---|---|---|
|
Agentic commerce protocol |
Create checkout session |
X |
|
|
Update checkout session |
X |
||
|
Retrieve checkout session |
X |
||
|
Complete checkout session |
X |
||
|
Cancel checkout session |
X |
||
|
Attribute |
Get list of all the data attributes |
X |
|
|
Post all active attributes for the product data |
X |
||
|
Get list of all the offer attributes |
X |
||
|
Post all active attributes for the product offer |
X |
||
|
Cancellations |
Get cancellations |
X |
|
|
Create cancellation |
X |
||
|
Create multiple cancellations |
X |
||
|
Get cancellations |
X |
||
|
Create cancellation |
X |
||
|
Mark export as failed |
X |
||
|
Category |
Get all active categories for your channel |
X |
|
|
Post all active categories as a list |
X |
||
|
Channels |
Get channels |
X |
|
|
Competition prices |
Get the price from the buy box winner |
X |
|
|
Custom fields |
Get custom fields |
X |
|
|
Delete custom fields by a given list of custom field IDs |
X |
||
|
Fulfillment stock |
Get product stock for warehouses |
X |
|
|
Listed products |
Get products by channel |
X |
|
|
Notifications |
Get notifications |
X |
|
|
Offers |
Update stock & price |
X |
|
|
Update stock |
X |
||
|
Get product stock across all warehouses |
X |
||
|
Get product-level stock limitations for channel |
X |
||
|
Sets product-level stock limitations for channel |
X |
||
|
Remove product-level stock limitations for channel |
X |
||
|
Order documents |
Get documents by filters |
X |
|
|
Get document file for order |
X |
||
|
Acknowledge document |
X |
||
|
Orders |
Create order |
X |
|
|
Create order |
X |
||
|
Generate order invoice |
X |
||
|
Generate packing slip |
X |
||
|
Get orders by filter |
X |
||
|
Get new orders |
X |
||
|
Acknowledge orders |
X |
||
|
Generate order invoice |
X |
||
|
Uploads an order invoice |
X |
||
|
Generate packing slip |
X |
||
|
Update order comment |
X |
||
|
Upload order invoice PDF |
X |
||
|
Mark export as failed |
X |
||
|
Product attributes |
Create custom attribute group |
X |
|
|
Get custom attribute groups |
X |
||
|
Delete custom attribute group |
X |
||
|
Add custom attributes to group |
X |
||
|
Delete custom attributes from group |
X |
||
|
Get custom attribute groups and linked marketplaces |
X |
||
|
Rename custom attribute groups |
X |
||
|
Product bundles |
Get product bundles |
X |
|
|
Create product bundles |
X |
||
|
Update product bundles |
X |
||
|
Products |
Acknowledge product data changes |
X |
|
|
Get product data changes |
X |
||
|
Acknowledge product offer changes |
X |
||
|
Get product offer changes |
X |
||
|
Get product data changes |
X |
||
|
Create or update a product |
X |
||
|
Update part of a product |
X |
||
|
Delete product |
X |
||
|
Update or create products |
X |
||
|
Get products |
X |
||
|
Update product attributes |
X |
||
|
Delete product |
X |
||
|
Get product |
X |
||
|
Update product attributes |
X |
||
|
Delete products |
X |
||
|
Add update or delete custom attributes |
X |
||
|
Add update or deletes a custom attribute |
X |
||
|
Updates selected products and sets them either to frozen or not-frozen status |
X |
||
|
Purchase orders |
Create purchase order invoice |
X |
|
|
Create purchase order invoice bulk |
X |
||
|
Get purchase order shipments by filter |
X |
||
|
Create purchase order shipment |
X |
||
|
Update purchase order shipment |
X |
||
|
Get purchase orders by filter |
X |
||
|
Acknowledge lines of a purchase order |
X |
||
|
Refunds |
Get refund by identifier |
X |
|
|
Get refunds by filter |
X |
||
|
Process refund |
X |
||
|
Get refund by identifier |
X |
||
|
Get refunds by filter |
X |
||
|
Create a refund |
X |
||
|
Acknowledge refund |
X |
||
|
Upsert extra data for refund |
X |
||
|
Reports |
Create product feed |
X |
|
|
Get status of report |
X |
||
|
Get report |
X |
||
|
Get report |
X |
||
|
Create settlement report |
X |
||
|
Get report status |
X |
||
|
Get report |
X |
||
|
Get report |
X |
||
|
Returns |
Get return by identifier |
X |
|
|
Get returns by filter |
X |
||
|
Create return |
X |
||
|
Process return |
X |
||
|
Get returns |
X |
||
|
Create return |
X |
||
|
Get return by identifier |
X |
||
|
Get returns by filter |
X |
||
|
Create return |
X |
||
|
Handle return |
X |
||
|
Handle returns in bulk |
X |
||
|
Acknowledge return |
X |
||
|
Upsert extra data for return |
X |
||
|
Get marketplace returns |
X |
||
|
Create merchant return |
X |
||
|
Get returns by filter |
X |
||
|
Mark returns as received |
X |
||
|
Get unhandled returns |
X |
||
|
Get return |
X |
||
|
Acknowledge return |
X |
||
|
Mark export failed |
X |
||
|
Settings |
Get settings |
X |
|
|
Settlements |
Get settlements |
X |
|
|
Upload settlement file to ChannelEngine |
X |
||
|
Shipments |
Get shipments |
X |
|
|
Get a shipping label |
X |
||
|
Get air waybill for shipment |
X |
||
|
Get shipments by filter |
X |
||
|
Create shipments |
X |
||
|
Update shipment |
X |
||
|
Get carriers providing shipping labels |
X |
||
|
Create shipment and initiate shipping label generation |
X |
||
|
Get shipping label |
X |
||
|
Get air waybill no for shipment |
X |
||
|
Delivery state |
X |
||
|
Upload proof of delivery document |
X |
||
|
Mark import as failed |
X |
||
|
Stock locations |
Get stock locations |
X |
|
|
Creates stock location |
X |
||
|
Support |
Support order |
X |
|
|
Test shipping label |
X |
||
|
Test order document |
X |
||
|
Targets |
Create multiple targets |
X |
|
|
Edit multiple targets |
X |
||
|
Delete multiple targets |
X |
||
|
Webhooks |
Get webhooks |
X |
|
|
Create or update webhook |
X |
||
|
Update webhook |
X |
||
|
Delete webhook |
X |