When you configure an export, import, other type of flow step using the prebuilt ChannelApe 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 ChannelApe API documentation. You can also create a composite endpoint for this application in HTTP mode.
|
Resource |
API endpoint |
Export |
Import |
|---|---|---|---|
|
(RPC) Apply categories |
Get RPC apply categories |
X |
|
|
Post RPC apply categories |
X |
||
|
(RPC) Create API account |
Get RPC create API account |
X |
|
|
Post RPC create API account |
X |
||
|
(RPC) Create webhook Portal magic link |
Get RPC create webhook portal magic link |
X |
|
|
Post RPC create webhook portal magic link |
X |
||
|
(RPC) Get ATP |
Get RPC, get ATP |
X |
|
|
Post RPC, get ATP |
X |
||
|
(RPC) Highlight address search |
Get RPC highlight address search |
X |
|
|
Post RPC highlight address search |
X |
||
|
(RPC) Highlight search inventory items |
Get RPC highlight search inventory items |
X |
|
|
Post RPC highlight search inventory items |
X |
||
|
(RPC) Highlight search locations |
Get RPC highlight search locations |
X |
|
|
Post RPC highlight search locations |
X |
||
|
(RPC) Highlight search orders |
Get RPC highlight search orders |
X |
|
|
Post RPC highlight search orders |
X |
||
|
(RPC) Highlight search shipment receipts |
Get RPC highlight search shipment receipts |
X |
|
|
Post RPC highlight search shipment receipts |
X |
||
|
(RPC) Highlight search shipments |
Get RPC highlight search shipments |
X |
|
|
Post RPC highlight search shipments |
X |
||
|
(RPC) Inventory presell |
Get RPC inventory presell |
X |
|
|
Post RPC inventory presell |
X |
||
|
(RPC) Is system permission enabled for business |
Get RPC is system permission enabled for business |
X |
|
|
Post RPC is system permission enabled for business |
X |
||
|
(RPC) Is writeable order type |
Get RPC is writeable order type |
X |
|
|
Post RPC is writeable order type |
X |
||
|
(RPC) login API account |
Get RPC login API account |
X |
|
|
Post RPC login API account |
X |
||
|
(RPC) Magnify |
Get RPC magnify |
X |
|
|
Post RPC magnify |
X |
||
|
(RPC) Populate sales orders from legacy |
Get RPC populate sales orders from legacy |
X |
|
|
Post RPC populate sales orders from legacy |
X |
||
|
(RPC) Postgres FDW dIsconnect |
Get RPC postgres FDW disconnect |
X |
|
|
Post RPC postgres FDW disconnect |
X |
||
|
(RPC) Postgres FDW dIsconnect all |
Get RPC postgres FDW disconnect all |
X |
|
|
Post RPC postgres FDW disconnect all |
X |
||
|
(RPC) Postgres FDW Get connections |
Get RPC postgres FDW get connections |
X |
|
|
Post RPC postgres FDW get connections |
X |
||
|
(RPC) Postgres FDW handler |
Get RPC postgres FDW handler |
X |
|
|
Post RPC postgres FDW handler |
X |
||
|
(RPC) Unmagnify |
Get RPC unmagnify |
X |
|
|
Post RPC unmagnify |
X |
||
|
(RPC) Upsert address |
Get RPC upsert address |
X |
|
|
Post RPC upsert address |
X |
||
|
(RPC) Upsert Inventory item |
Get RPC upsert inventory item |
X |
|
|
Post RPC upsert inventory item |
X |
||
|
(RPC) Upsert location |
Get RPC upsert location |
X |
|
|
Post RPC upsert location |
X |
||
|
(RPC) Upsert location address |
Get RPC upsert location address |
X |
|
|
Post RPC upsert location address |
X |
||
|
(RPC) Upsert order |
Get RPC upsert order |
X |
|
|
Post RPC upsert order |
X |
||
|
(RPC) Upsert orders full |
Get RPC upsert orders full |
X |
|
|
Post RPC upsert orders full |
X |
||
|
(RPC) Upsert shipment |
Get RPC upsert shipment |
X |
|
|
Post RPC upsert shipment |
X |
||
|
(RPC) Upsert shipment inventory item |
Get RPC upsert shipment inventory item |
X |
|
|
Post RPC upsert shipment inventory item |
X |
||
|
(RPC) Upsert shipment item |
Get RPC upsert shipment item |
X |
|
|
Post RPC upsert shipment item |
X |
||
|
(RPC) Upsert shipment package |
Get RPC upsert shipment package |
X |
|
|
Post RPC upsert shipment package |
X |
||
|
(RPC) Upsert shipment package items |
Get RPC upsert shipment package items |
X |
|
|
Post RPC upsert shipment package items |
X |
||
|
(RPC) Upsert shipment receipt |
Get RPC upsert shipment receipt |
X |
|
|
Post RPC upsert shipment receipt |
X |
||
|
(RPC) Upsert shipment receipt inventory items |
Get RPC upsert shipment receipt inventory items |
X |
|
|
Post RPC upsert shipment receipt inventory items |
X |
||
|
(RPC) Upsert shipment receipt item |
Get RPC upsert shipment receipt item |
X |
|
|
Post RPC upsert shipment receipt item |
X |
||
|
(RPC) Upsert shipment receipts full |
Get RPC upsert shipment receipts full |
X |
|
|
Post RPC upsert shipment receipts full |
X |
||
|
(RPC) Upsert shipment receipts with items |
Get RPC upsert shipment receipts with items |
X |
|
|
Post RPC upsert shipment receipts with items |
X |
||
|
(RPC) Upsert shipments full |
Get RPC upsert shipments full |
X |
|
|
Post RPC upsert shipments full |
X |
||
|
Actions (Deprecated) |
Query actions by business |
X |
|
|
Get action |
X |
||
|
Update action with error |
X |
||
|
Update action health check |
X |
||
|
Complete action |
X |
||
|
Addresses |
Delete addresses |
X |
|
|
Get addresses |
X |
||
|
Patch addresses |
X |
||
|
Post addresses |
X |
||
|
Analytics (Deprecated) |
Retrieve a list of available analytics |
X |
|
|
Business members |
Delete business members |
X |
|
|
Get business members |
X |
||
|
Patch business members |
X |
||
|
Post business members |
X |
||
|
Businesses |
Delete businesses |
X |
|
|
Get businesses |
X |
||
|
Patch businesses |
X |
||
|
Post businesses |
X |
||
|
Businesses (Deprecated) |
Get business |
X |
|
|
Get business members |
X |
||
|
Get business member or owner |
X |
||
|
Get businesses API accounts |
X |
||
|
Get API account |
X |
||
|
Categories |
Delete categories |
X |
|
|
Get categories |
X |
||
|
Patch categories |
X |
||
|
Post categories |
X |
||
|
Channels |
Delete channels |
X |
|
|
Get channels |
X |
||
|
Patch channels |
X |
||
|
Post channels |
X |
||
|
Channels (Deprecated) |
Get channels for business |
X |
|
|
Get channel |
X |
||
|
Create channel |
X |
||
|
Update channel |
X |
||
|
Create custom export channel |
X |
||
|
Update custom export channel |
X |
||
|
Completed task counts (Deprecated) |
Retrieve completed task counts |
X |
|
|
Completed tasks (Deprecated) |
Get completed tasks for business |
X |
|
|
Get completed task |
X |
||
|
Countries |
Delete countries |
X |
|
|
Get countries |
X |
||
|
Patch countries |
X |
||
|
Post countries |
X |
||
|
Currencies |
Delete currencies |
X |
|
|
Get currencies |
X |
||
|
Patch currencies |
X |
||
|
Post currencies |
X |
||
|
Customers |
Delete customers |
X |
|
|
Get customers |
X |
||
|
Patch customers |
X |
||
|
Post customers |
X |
||
|
Default shipment allocations |
Delete default shipment allocations |
X |
|
|
Get default shipment allocations |
X |
||
|
Patch default shipment allocations |
X |
||
|
Post default shipment allocations |
X |
||
|
Enum values |
Get enum values |
X |
|
|
Fulfillment line items |
Delete fulfillment line items |
X |
|
|
Get fulfillment line items |
X |
||
|
Patch fulfillment line items |
X |
||
|
Post fulfillment line items |
X |
||
|
Fulfillment shipments items |
Delete fulfillment shipments items |
X |
|
|
Get fulfillment shipments items |
X |
||
|
Patch fulfillment shipments items |
X |
||
|
Post fulfillment shipments items |
X |
||
|
Fulfillments |
Delete fulfillments |
X |
|
|
Get fulfillments |
X |
||
|
Patch fulfillments |
X |
||
|
Post fulfillments |
X |
||
|
Integrations (Deprecated) |
Get integrations |
X |
|
|
Get integration |
X |
||
|
Introspection |
Openapi description (this document) |
X |
|
|
Inventories (Deprecated) |
Get inventory item by SKU |
X |
|
|
Get inventory item |
X |
||
|
Create inventory item |
X |
||
|
Update inventory item |
X |
||
|
Inventories: Quantities (Deprecated) |
Retrieve inventory item quantities |
X |
|
|
Adjust inventory item quantity |
X |
||
|
Set inventory item quantity |
X |
||
|
Inventory item current quantities |
Get inventory item current quantities |
X |
|
|
Inventory item current quantities live |
Get inventory item current quantities live |
X |
|
|
Inventory items |
Delete inventory items |
X |
|
|
Get inventory items |
X |
||
|
Patch inventory items |
X |
||
|
Post inventory items |
X |
||
|
Location addresses |
Get location addresses |
X |
|
|
Locations |
Delete locations |
X |
|
|
Get locations |
X |
||
|
Patch locations |
X |
||
|
Post locations |
X |
||
|
Locations (Deprecated) |
Get locations for a business |
X |
|
|
Get location |
X |
||
|
Create location |
X |
||
|
Update location |
X |
||
|
Order activities (Deprecated) |
Create an order activity |
X |
|
|
Order line item taxes |
Delete order line item taxes |
X |
|
|
Get order line item taxes |
X |
||
|
Patch order line item taxes |
X |
||
|
Post order line item taxes |
X |
||
|
Order line items |
Delete order line items |
X |
|
|
Get order line items |
X |
||
|
Patch order line items |
X |
||
|
Post order line items |
X |
||
|
Orders |
Delete orders |
X |
|
|
Get orders |
X |
||
|
Patch orders |
X |
||
|
Post orders |
X |
||
|
Orders (Deprecated) |
Query orders by business |
X |
|
|
Get order |
X |
||
|
Search for order by business and channel order ID |
X |
||
|
Query orders by business and purchase order number |
X |
||
|
Query orders by channel |
X |
||
|
Get order summary |
X |
||
|
Create order |
X |
||
|
Update order |
X |
||
|
Delete order |
X |
||
|
Patch order |
X |
||
|
Orders full |
Get orders full |
X |
|
|
Product blocks (Deprecated) |
Query product blocks by channel ID |
X |
|
|
Query product blocks by business ID and product filter ID |
X |
||
|
Get product block |
X |
||
|
Put product block |
X |
||
|
Delete product block |
X |
||
|
Product filters (Deprecated) |
Query product filters by business ID and label |
X |
|
|
Get product filter |
X |
||
|
Product modifiers (Deprecated) |
Get product modifiers for business |
X |
|
|
Get product modifier |
X |
||
|
Create product modifier |
X |
||
|
Update product modifier |
X |
||
|
Delete product modifier |
X |
||
|
Product pushes (Deprecated) |
Query product pushes by channel ID |
X |
|
|
Get product push |
X |
||
|
Put product push without ordinal |
X |
||
|
Put product push |
X |
||
|
Delete product push |
X |
||
|
Product categories |
Delete product categories |
X |
|
|
Get product categories |
X |
||
|
Patch product categories |
X |
||
|
Post product categories |
X |
||
|
Product data |
Delete product data |
X |
|
|
Get product data |
X |
||
|
Patch product data |
X |
||
|
Post product data |
X |
||
|
Product tags |
Delete product tags |
X |
|
|
Get product tags |
X |
||
|
Patch product tags |
X |
||
|
Post product tags |
X |
||
|
Product variant options |
Delete product variant options |
X |
|
|
Get product variant options |
X |
||
|
Patch product variant options |
X |
||
|
Post product variant options |
X |
||
|
Product variant tags |
Delete product variant tags |
X |
|
|
Get product variant tags |
X |
||
|
Patch product variant tags |
X |
||
|
Post product variant tags |
X |
||
|
Product variants |
Delete product variants |
X |
|
|
Get product variants |
X |
||
|
Patch product variants |
X |
||
|
Post product variants |
X |
||
|
Products |
Delete products |
X |
|
|
Get products |
X |
||
|
Patch products |
X |
||
|
Post products |
X |
||
|
Products (Deprecated) |
Get product |
X |
|
|
Create product |
X |
||
|
Update product |
X |
||
|
Products filters (Deprecated) |
Create product filter |
X |
|
|
Update product filter |
X |
||
|
Delete product filter |
X |
||
|
Recipes (Deprecated) |
Query recipes by business ID |
X |
|
|
Get recipe |
X |
||
|
Create recipe |
X |
||
|
Update recipe |
X |
||
|
Delete recipe |
X |
||
|
Refund adjustments |
Delete refund adjustments |
X |
|
|
Get refund adjustments |
X |
||
|
Patch refund adjustments |
X |
||
|
Post refund adjustments |
X |
||
|
Refund line item restock types |
Delete refund line item restock types |
X |
|
|
Get refund line item restock types |
X |
||
|
Patch refund line item restock types |
X |
||
|
Post refund line item restock types |
X |
||
|
Refund line items |
Delete refund line items |
X |
|
|
Get refund line items |
X |
||
|
Patch refund line items |
X |
||
|
Post refund line items |
X |
||
|
Refund transactions |
Delete refund transactions |
X |
|
|
Get refund transactions |
X |
||
|
Patch refund transactions |
X |
||
|
Post refund transactions |
X |
||
|
Refunds |
Delete refunds |
X |
|
|
Get refunds |
X |
||
|
Patch refunds |
X |
||
|
Post refunds |
X |
||
|
Schedules (Deprecated) |
Query schedules by business ID |
X |
|
|
Get schedule |
X |
||
|
Create schedule |
X |
||
|
Search fields (Deprecated) |
Get businesses search fields |
X |
|
|
Get search field |
X |
||
|
Create search field |
X |
||
|
Update search fields |
X |
||
|
Delete search field |
X |
||
|
Shipment allocations |
Delete shipment allocations |
X |
|
|
Get shipment allocations |
X |
||
|
Patch shipment allocations |
X |
||
|
Post shipment allocations |
X |
||
|
Shipment inventory items |
Get shipment inventory items |
X |
|
|
Shipment items |
Delete shipment items |
X |
|
|
Get shipment items |
X |
||
|
Patch shipment items |
X |
||
|
Post shipment items |
X |
||
|
Shipment package items |
Get shipment package items |
X |
|
|
Shipment packages |
Delete shipment packages |
X |
|
|
Get shipment packages |
X |
||
|
Patch shipment packages |
X |
||
|
Post shipment packages |
X |
||
|
Shipment receipt inventory items |
Get shipment receipt inventory items |
X |
|
|
Shipment receipt items |
Delete shipment receipt items |
X |
|
|
Get shipment receipt items |
X |
||
|
Patch shipment receipt items |
X |
||
|
Post shipment receipt items |
X |
||
|
Shipment receipt webhooks |
Delete shipment receipt webhooks |
X |
|
|
Get shipment receipt webhooks |
X |
||
|
Patch shipment receipt webhooks |
X |
||
|
Post shipment receipt webhooks |
X |
||
|
Shipment receipts |
Delete shipment receipts |
X |
|
|
Get shipment receipts |
X |
||
|
Patch shipment receipts |
X |
||
|
Post shipment receipts |
X |
||
|
Shipment receipts full |
Get shipment receipts full |
X |
|
|
Shipment receipts with items |
Get shipment receipts with items |
X |
|
|
Shipment webhooks |
Delete shipment webhooks |
X |
|
|
Get shipment webhooks |
X |
||
|
Patch shipment webhooks |
X |
||
|
Post shipment webhooks |
X |
||
|
Shipments |
Delete shipments |
X |
|
|
Get shipments |
X |
||
|
Patch shipments |
X |
||
|
Post shipments |
X |
||
|
Shipments full |
Get shipments full |
X |
|
|
Standard product variant options |
Delete standard product variant options |
X |
|
|
Get standard product variant options |
X |
||
|
Patch standard product variant options |
X |
||
|
Post standard product variant options |
X |
||
|
Steps (Deprecated) |
Query steps |
X |
|
|
Get step |
X |
||
|
Subscriptions (Deprecated) |
Get subscription |
X |
|
|
Suppliers (Deprecated) |
Get suppliers for business |
X |
|
|
Get supplier |
X |
||
|
Create supplier |
X |
||
|
Update supplier |
X |
||
|
Suppliers: Inventories (Deprecated) |
Get inventory items for supplier |
X |
|
|
Get inventory item |
X |
||
|
Create inventory item |
X |
||
|
Update inventory item |
X |
||
|
Delete inventory item |
X |
||
|
System permissions |
Delete system permissions |
X |
|
|
Get system permissions |
X |
||
|
Patch system permissions |
X |
||
|
Post system permissions |
X |
||
|
Table columns |
Get table columns |
X |
|
|
Table relations |
Get table relations |
X |
|
|
Tags |
Delete tags |
X |
|
|
Get tags |
X |
||
|
Patch tags |
X |
||
|
Post tags |
X |
||
|
Users |
Delete users |
X |
|
|
Get users |
X |
||
|
Patch users |
X |
||
|
Post users |
X |
||
|
Variant webhooks |
Delete variant webhooks |
X |
|
|
Get variant webhooks |
X |
||
|
Patch variant webhooks |
X |
||
|
Post variant webhooks |
X |
||
|
Variants (Deprecated) |
Get product's variants |
X |
|
|
Get variant |
X |
||
|
Variants search (Deprecated) |
Search variants |
X |
|
|
Search variants by vendor |
X |
||
|
Search variants by SKU |
X |
||
|
Search variants by upc |
X |
||
|
Search variants by tag |
X |
||
|
Webhook actions |
Delete webhook actions |
X |
|
|
Get webhook actions |
X |
||
|
Patch webhook actions |
X |
||
|
Post webhook actions |
X |
||
|
Webhook configuration actions |
Delete webhook configuration actions |
X |
|
|
Get webhook configuration actions |
X |
||
|
Patch webhook configuration actions |
X |
||
|
Post webhook configuration actions |
X |
||
|
Webhook configurations |
Delete webhook configurations |
X |
|
|
Get webhook configurations |
X |
||
|
Patch webhook configurations |
X |
||
|
Post webhook configurations |
X |
||
|
White label |
Get white label |
X |