Skip to main content

Update ChannelApe Step

Syncs data updated during the play to ChannelApe.

Prerequisites​

Update ChannelApe step requires locations to be setup prior to running.

Environment Variables​

  • CHANNEL_APE_SECRET_KEY - The Secret key generated for the API User assigned to this Play and used to interact with our APIs.

  • MAXIMUM_CONCURRENT_CONNECTIONS - The number of simultaneous HTTP connections that can be opened during the Play's run. Generally speaking this should be left at 5, which is default. In certain circumstances this should be increased to improve runtimes for API-heavy Plays, like Inventory Sync.

  • VIRTUAL_SALES_CHANNEL_LOCATION_ID - The ChannelApe Location ID configured for the IMS Location on the eCommerce Sales Channel (e.g. Shopify). Used to propagate Inventory updates to inventory on the eCommerce Sales Channel.

  • BATCH_INVENTORY - If enabled, any inventory adjustments made will use the asynchronous batch API. Step/Play will not fail on adjustments that can’t be made. You can use the inventory activities report to check on the status of the batch.