--- title: IPaaS Integration Guide | ChannelApe description: Learn how to successfully integrate a sales channel. --- [![Full Color Logo - Cropped - New](https://www.channelape.com/hubfs/2023%20Mega%20Menu%20Assets/Logos/Full%20Color%20Logo%20-%20Cropped%20-%20New.svg)](https://www.channelape.com) - Solutions - Resources ![grow-icon](https://www.channelape.com/hubfs/2023%20Mega%20Menu%20Assets/Icons/grow-icon.svg) Grow [Wholesale channels Big Box - X12 EDI support](https://www.channelape.com/solutions/grow/b2b-wholesale) [Brick-and-mortar channels Enable smaller retailers](https://www.channelape.com/solutions/grow/brick-and-mortar-channels) [Dropship your products Let others easily sell for you](https://www.channelape.com/solutions/grow/dropship-your-products) [Pre-sale orders Without the headache later](https://www.channelape.com/solutions/grow/pre-sale-orders) [Distribution footprint Additional locations & partners](https://www.channelape.com/solutions/grow/distribution-footprint) ![manage-icon](https://www.channelape.com/hubfs/2023%20Mega%20Menu%20Assets/Icons/manage-icon.svg) Manage [Reserve Inventory Influencers, wholesale & more](https://www.channelape.com/solutions/manage/reserve-inventory) [Inventory effective & expiration dates No more spreadsheets required](https://www.channelape.com/solutions/manage/inventory-effective-expiration-date) [Multi-status, multi-location inventory Warehouses, stores, and channels](https://www.channelape.com/solutions/manage/multi-status-multi-location-inventory) [Fulfillment holds & order edits Auto-hold on new CX ticket](https://www.channelape.com/solutions/manage/fulfillment-holds-order-edits) [Automate fulfillment rules Bundles, marketing SKUs, and more](https://www.channelape.com/solutions/manage/automate-fulfillment-rules) ![monitor-icon](https://www.channelape.com/hubfs/2023%20Mega%20Menu%20Assets/Icons/monitor-icon.svg) Monitor [Inbounds - New & Returns By SKU & Date](https://www.channelape.com/solutions/monitor/inbounds-new-return) [Fulfillable Inventory By status and location](https://www.channelape.com/solutions/monitor/fulfillable-inventory) [Fulfillment Partners SLAs, exceptions, and overall activity](https://www.channelape.com/fulfillment-partners) [Dashboards & Reports Use ours or build your own](https://www.channelape.com/solutions/monitor/dashboards-reports) [Monitoring, Alerting, Export Email, Slack, GSheets, S3, 5Tran](https://www.channelape.com/solutions/monitor/monitoring-alerting) ![enable-icon](https://www.channelape.com/hubfs/2023%20Mega%20Menu%20Assets/Icons/enable-icon.svg) Enable [Clearer financial picture Simplify monthly close](https://www.channelape.com/solutions/enable/clearer-financial-picture) [Store inventory online See your retail store inventory](https://www.channelape.com/solutions/enable/store-inventory) [One team to implement More than just a tool](https://www.channelape.com/solutions/enable/one-team-to-implement-customize-manage) [Customization - API Dozens of API endpoints](https://dev.channelape.com) [Integrations See all the apps](https://www.channelape.com/apps) [Support Get 24/7 help](https://www.channelape.com/support-landing) [Knowledge Base Read in-depth guides](https://www.channelape.com/support-landing?kb=true) [Guides & Whitepapers Improved inventory management](https://www.channelape.com/resources) [Fulfillment Partners Global 3PL warehouse companies](https://www.channelape.com/fulfillment-partners) ![book-icon](https://www.channelape.com/hubfs/2023%20Mega%20Menu%20Assets/Icons/book-icon.svg) Featured Resources ![The Definitive Guide to 3PL’s-min](https://www.channelape.com/hubfs/The%20Definitive%20Guide%20to%203PL%E2%80%99s-min.png) eBook The definitive guide to 3PL Get the information and insights you need to make better-informed decisions for your business. Download Now ![Saysh Shoes-1](https://www.channelape.com/hubfs/Saysh%20Shoes-1.png) Case Study Saysh When Saysh saw a 1000% increase in order volume for their holiday sale, they successfully fulfilled every order—without overselling. Read Story ![integration-issues](https://www.channelape.com/hubfs/2022%20-%202H/integration-issues.png) Whitepaper Online Customer Shopping Habits Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor. Download Now - Solutions ![grow-icon](https://www.channelape.com/hubfs/2023%20Mega%20Menu%20Assets/Icons/grow-icon.svg) Grow [Wholesale channels Big Box - X12 EDI support](https://www.channelape.com/solutions/grow/b2b-wholesale) [Brick-and-mortar channels Enable smaller retailers](https://www.channelape.com/solutions/grow/brick-and-mortar-channels) [Dropship your products Let others easily sell for you](https://www.channelape.com/solutions/grow/dropship-your-products) [Pre-sale orders Without the headache later](https://www.channelape.com/solutions/grow/pre-sale-orders) [Distribution footprint Additional locations & partners](https://www.channelape.com/solutions/grow/distribution-footprint) ![manage-icon](https://www.channelape.com/hubfs/2023%20Mega%20Menu%20Assets/Icons/manage-icon.svg) Manage [Reserve Inventory Influencers, wholesale & more](https://www.channelape.com/solutions/manage/reserve-inventory) [Inventory effective & expiration dates No more spreadsheets required](https://www.channelape.com/solutions/manage/inventory-effective-expiration-date) [Multi-status, multi-location inventory Warehouses, stores, and channels](https://www.channelape.com/solutions/manage/multi-status-multi-location-inventory) [Fulfillment holds & order edits Auto-hold on new CX ticket](https://www.channelape.com/solutions/manage/fulfillment-holds-order-edits) [Automate fulfillment rules Bundles, marketing SKUs, and more](https://www.channelape.com/solutions/manage/automate-fulfillment-rules) ![monitor-icon](https://www.channelape.com/hubfs/2023%20Mega%20Menu%20Assets/Icons/monitor-icon.svg) Monitor [Inbounds - New & Returns By SKU & Date](https://www.channelape.com/solutions/monitor/inbounds-new-return) [Fulfillable Inventory By status and location](https://www.channelape.com/solutions/monitor/fulfillable-inventory) [Fulfillment Partners SLAs, exceptions, and overall activity](https://www.channelape.com/fulfillment-partners) [Dashboards & Reports Use ours or build your own](https://www.channelape.com/solutions/monitor/dashboards-reports) [Monitoring, Alerting, Export Email, Slack, GSheets, S3, 5Tran](https://www.channelape.com/solutions/monitor/monitoring-alerting) ![enable-icon](https://www.channelape.com/hubfs/2023%20Mega%20Menu%20Assets/Icons/enable-icon.svg) Enable [Clearer financial picture Simplify monthly close](https://www.channelape.com/solutions/enable/clearer-financial-picture) [Store inventory online See your retail store inventory](https://www.channelape.com/solutions/enable/store-inventory) [One team to implement More than just a tool](https://www.channelape.com/solutions/enable/one-team-to-implement-customize-manage) [Customization - API Dozens of API endpoints](https://dev.channelape.com) - Resources [Integrations See all the apps](https://www.channelape.com/apps) [Support Get 24/7 help](https://www.channelape.com/support-landing) [Knowledge Base Read in-depth guides](https://www.channelape.com/support-landing?kb=true) [Guides & Whitepapers Improved inventory management](https://www.channelape.com/resources) [Fulfillment Partners Global 3PL warehouse companies](https://www.channelape.com/fulfillment-partners) [Login](https://appx.channelape.io/) iPaaS Integration Guide # How to successfully integrate a sales channel. ## What’s needed? You'll need a few things to successfully interact with our API and these values will be unique for each ChannelApe customer: - Business ID - Channel ID - API Token **Please reach out to support@channelape.com so they can provision you a sandbox and get you above 3 IDs/keys.** **Our APIs are rate limited so keep an eye out for 429 errors and exponentially backoff.** # ![](https://www.channelape.com/hs-fs/hubfs/image-png-Feb-25-2022-12-25-55-28-AM.png?width=35&name=image-png-Feb-25-2022-12-25-55-28-AM.png) ### Create orders 1. You'll want to create orders (POST Create order) in ChannelApe with an "OPEN" status. 2. We'll then pick up the order and process and if successfully processed for fulfillment, status will change to IN\_PROGRESS. # ![](https://www.channelape.com/hs-fs/hubfs/image-png-Feb-25-2022-12-25-55-28-AM.png?width=35&name=image-png-Feb-25-2022-12-25-55-28-AM.png) ### Process fulfillments 1. You'll need to enumerate orders (GET Query orders by channel) to check for fulfillments but we have a few query parameters to make this easier/reduce load: 1. status: set this to **IN\_PROGRESS** 2. updatedAtStartDate: set this to the last timestamp you queried in **ISO 8601 format** 2. A fulfillment with a status of **PENDING**, **NEW**, **BACKORDERED**, or **CANCELED** is not fulfilled; you'll want to make sure the status is **OPEN** and there is at least a trackingNumber on it 3. Please change the fulfillment status to **SUCCESS** after you successfully post it to the sales channel. 1. You can use **PUT** or **PATCH** to update the entire fulfillments list on the order level as there is no fulfillments subresource at this time. # ![](https://www.channelape.com/hs-fs/hubfs/image-png-Feb-25-2022-12-25-55-28-AM.png?width=35&name=image-png-Feb-25-2022-12-25-55-28-AM.png) ### Close orders 1. Please change the order status to **CLOSED** when **Sales Channel** closes the order. 1. **PATCH** on the order status will work here. # ![](https://www.channelape.com/hs-fs/hubfs/image-png-Feb-25-2022-12-25-55-28-AM.png?width=35&name=image-png-Feb-25-2022-12-25-55-28-AM.png) ### Close orders 1. If **Sales Channel cancels** or refunds the order, please change the order status to **CANCELED**. [![channelape-white](https://www.channelape.com/hubfs/channelape-white.svg)](https://www.channelape.com/) 228 Park Ave S PMB 82108 New York, New York 10003-1502 ### Product - [Login](https://app.channelape.io/) - [API docs](https://docs.channelape.io/) - [Knowledgebase](https://www.channelape.com/support-landing?kb=true) - [Status](https://channelape.statuspage.io/) - [Support](https://www.channelape.com/support-landing) ### Company - [Blog](https://www.channelape.com/blog) - [Fulfillment partner program](https://www.channelape.com/partner) - [Careers](https://www.channelape.com/careers) - [Branding Guidelines](https://www.channelape.com/branding-guidelines) © 2022 ChannelApe [Privacy Policy](https://www.channelape.com/privacy) [Terms of Service](https://www.channelape.com/terms)