{"info":{"_postman_id":"636a08dd-3a79-417a-9de1-5297ae7b5fc7","name":"ChannelApe API Documentation","description":"ChannelApe is a set of commerce APIs that allow you to manipulate catalogs retrieve orders from many integrations, rate shop and more.\n\nThe ChannelApe API is designed around [REST](https://en.wikipedia.org/wiki/Representational_state_transfer) and you must [sign up](https://app.channelape.com/user/signup) for an account before you can make requests. Once you signup, verify your account and create a business, then you'll be all set to come back here for authorization. \n\nIf you need longer than the default 14 day trial, please [email our support team](mailto:support@channelape.com?subject=Please%20Extend%20My%20Developer%20Trial) with the name of the business and your email and we'll extend your business as a developer account.\n\n\n# Authorization\nEvery request requires a valid session ID passed as the value for the X-Channel-Ape-Authorization-Token header. To  generate a new session ID, use the [Users - Create session](https://docs.channelape.io/#421a1ffc-895c-4517-9dbd-a3e523a7a8ef) request.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json"},"item":[{"name":"Actions","item":[{"name":"Get action","id":"5c57db86-de42-480e-9d0a-2a42acba94e4","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.channelape.com/v1/actions/{{action_id}}"},"response":[],"_postman_id":"5c57db86-de42-480e-9d0a-2a42acba94e4"},{"name":"Get business actions","id":"24e4fbcc-bec0-48cf-819a-b2fdafefb45c","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.channelape.com/v1/actions?size=5&endDate=2016-03-23T12:42:21.338Z&businessId=3875411f-fcd3-444a-9691-622d022ff639&startDate=2016-03-01T12:41:21.338Z&lastKey=9a852b6e-f31d-40ca-adb6-2cbc401adb4e","protocol":"https","host":["api","channelape","com"],"path":["v1","actions"],"query":[{"key":"size","value":"5"},{"key":"endDate","value":"2016-03-23T12:42:21.338Z"},{"key":"businessId","value":"3875411f-fcd3-444a-9691-622d022ff639"},{"key":"startDate","value":"2016-03-01T12:41:21.338Z"},{"key":"lastKey","value":"9a852b6e-f31d-40ca-adb6-2cbc401adb4e"}]}},"response":[],"_postman_id":"24e4fbcc-bec0-48cf-819a-b2fdafefb45c"},{"name":"Update action with error","id":"8f421a25-8758-4f70-a180-583f24bb8f29","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.channelape.com/v1/actions/f9655f68-544c-49b1-b06e-0a83fa0f13d4/error","description":"Error out an in progress action. This will allow a new action to run with the same target if it is queued."},"response":[],"_postman_id":"8f421a25-8758-4f70-a180-583f24bb8f29"},{"name":"Update action health check","id":"fecefa13-da44-4560-8b62-7204ae2ff3b6","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.channelape.com/v1/actions/f9655f68-544c-49b1-b06e-0a83fa0f13d4/healthcheck","description":"Updated action health check which keeps action from erroring out. Action will error if health check interval * 2 + 1 minute is exceeded without an update."},"response":[],"_postman_id":"fecefa13-da44-4560-8b62-7204ae2ff3b6"},{"name":"Complete action","id":"72b2e70c-d97e-4850-a8dd-527dd562d4eb","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.channelape.com/v1/actions/bb87e11d-b012-4024-9835-990cb92ce86a/complete","description":"Complete an in progress action. This will allow a new action to run with the same target if it is queued."},"response":[],"_postman_id":"72b2e70c-d97e-4850-a8dd-527dd562d4eb"}],"id":"2b7a4d15-de4a-41f3-937a-76d15d8629db","description":"An action is a process by which ChannelApe accomplishes tasks. An inventory action might update inventory quantities across all marketplaces, thus performing specific tasks.","_postman_id":"2b7a4d15-de4a-41f3-937a-76d15d8629db"},{"name":"Businesses","item":[{"name":"Add Business Member","id":"79348815-ea9f-42d3-abea-821727a8517b","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":"{\n  \"username\": \"{{username}}\"\n}"},"url":"https://api.channelape.com/v1/businesses/{{business_id}}/members","description":"Add verified user to a business by providing their username. Only the business owner can add other members."},"response":[],"_postman_id":"79348815-ea9f-42d3-abea-821727a8517b"},{"name":"Get Business","id":"f809e007-1068-4ea6-aae1-f7667685da5b","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":"{\n  \"name\" : \"Neil's Noooiiccee Nikes\",\n  \"timeZone\" : \"America/New_York\"\n}"},"url":"https://api.channelape.com/v1/businesses/{{business_id}}","description":"Retrieve infomation about the business."},"response":[],"_postman_id":"f809e007-1068-4ea6-aae1-f7667685da5b"},{"name":"Get Business Members","id":"ba431381-cd2a-4ae3-be26-dcccef03f931","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":"{\n  \"name\" : \"Let us try this, One more time\",\n  \"timeZone\" : \"America/Atka\"\n}"},"url":{"raw":"https://api.channelape.com/v1/businesses?businessId={{business_id}}","protocol":"https","host":["api","channelape","com"],"path":["v1","businesses"],"query":[{"key":"businessId","value":"{{business_id}}"}]},"description":"Retrieve all users belonging to the given business."},"response":[],"_postman_id":"ba431381-cd2a-4ae3-be26-dcccef03f931"},{"name":"Get Businesses for User","id":"939dcbf9-083b-46a9-b0e3-aefe16c7825b","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.channelape.com/v1/businesses?userId={{user_id}}","protocol":"https","host":["api","channelape","com"],"path":["v1","businesses"],"query":[{"key":"userId","value":"{{user_id}}"}]},"description":"Retrieve all businesses belonging to the given user."},"response":[],"_postman_id":"939dcbf9-083b-46a9-b0e3-aefe16c7825b"},{"name":"Delete Business Member","id":"a43fdf6b-cd35-4b3c-bb41-8766d14b07b3","request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.channelape.com/v1/businesses/{{business_id}}/members/{{user_id}}","description":"Remove a user from the business. Only the business owner can remove other members.\n\n__Note:__ Business owner cannot be removed from the business."},"response":[],"_postman_id":"a43fdf6b-cd35-4b3c-bb41-8766d14b07b3"},{"name":"Update Business","id":"edf5e2a1-5b34-48c0-85de-92292486fa69","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":"{\n  \"name\" : \"Jim's Vitamins\",\n  \"timeZone\" : \"America/Atka\"\n}"},"url":"https://api.channelape.com/v1/businesses/{{business_id}}","description":"Update the name and/or timeZone of a business. Only the business owner can update the business.\n\nRequired Request Fields\n---\n__name__ - Name of your business. Can be updated later.\n\n__timeZone__ - TimeZone your business operates under. Will change how dashboards render along with what times you see for recipe schedules in the app. API stores all values in UTC/GMT. Can be updated later."},"response":[],"_postman_id":"edf5e2a1-5b34-48c0-85de-92292486fa69"},{"name":"Verify Business Member","id":"b16735bc-9d1e-6d78-89d1-e7a1223aadac","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.channelape.com/v1/businessmemberverifications/{{business_member_verification_token}}","description":"Once a business owner adds a member to the business, they need to verify their membership using this call and the token emailed to them."},"response":[],"_postman_id":"b16735bc-9d1e-6d78-89d1-e7a1223aadac"},{"name":"Create Business","id":"041c4e24-ea0d-47d0-b9b6-064b7daf2771","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":"{\n  \"name\" : \"Jill's Supplement Store\",\n  \"timeZone\" : \"America/New_York\",\n  \"alphabeticCurrencyCode\" : \"USD\",\n  \"inventoryItemKey\" : \"SKU\"\n}"},"url":"https://api.channelape.com/v1/businesses/","description":"Create a new business.\n\nRequired Request Fields\n---\n__name__ - Name of your business. Can be updated later.\n\n__timeZone__ - TimeZone your business operates under. Will change how dashboards render along with what times you see for recipe schedules in the app. API stores all values in UTC/GMT. Can be updated later.\n\n__alphabeticCurrencyCode__ - ISO 4217 currency code used by your business. All supplier inventory items will assume this currency. When an order is placed with an uknown currency, this currency will be assumed.\n\n__inventoryItemKey__ - Valid values are \"SKU\" or \"UPC\". Cannot be changed once business is created. Unique identifier for all inventory items under a supplier. Duplicate inventory item keys for a given supplier will be ommitted."},"response":[],"_postman_id":"041c4e24-ea0d-47d0-b9b6-064b7daf2771"}],"id":"ed18fc75-2c36-446a-8608-74e9eee5cb12","description":"A business is a ChannelApe account created to access the platform. Some customers make 1 business for each sales channel, others put all their channels in 1 business. This is just a way to logically group orders, channels, products and suppliers.","_postman_id":"ed18fc75-2c36-446a-8608-74e9eee5cb12"},{"name":"Channels","item":[{"name":"Create channel","id":"020b1ca2-636d-40f8-ae29-45051cd5c7d3","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":"{\n    \"businessId\": \"0ea98dc8-367c-4288-888a-7872e105dc52\",\n    \"integrationId\" :\"13b33833-698c-4616-b37e-63969979fb8c\",\n    \"name\" : \"Don's Donnybrook Gear\",\n    \"enabled\" : true,\n    \"credentials\" : {\n        \"accessToken\" : \"xxxxxxxxxxxxxxxxx\",\n        \"shopSubdomain\" : \"example-site\"\n     },\n    \"settings\": {\n        \"allowCreate\": true,\n        \"allowDelete\": true,\n        \"allowRead\": true,\n        \"allowUpdate\": true,\n        \"priceType\": \"wholesale\",\n        \"disableVariants\" : \"false\",\n        \"updateFields\": [\n          \"images\",\n          \"price\"\n        ]\n  }\n}"},"url":"https://api.channelape.com/v1/channels/","description":"Create a channel for a business.\r\n\r\n# Required Fields\r\n__businessId__ - ID for ChannelApe business that channel should be created for.\r\n\r\n__integrationId__ - ID for integration of which this channel will be an instance of (i.e. Shopify Channel integraion, Exporter Integration, eBay Channel Integration). \r\n\r\n__name__ - Needs to be unique across all channels for the business.\r\n\r\n__credentials__ - Only required if the integration has credential keys.\r\n\r\n# Optional Fields\r\n__enabled__ - Indicates whether the channel is installed. Uninstalled channels cannot run actions. Defaults to _false_.\r\n\r\n__settings__ - Map with multiple optional values.\r\n\r\n* __allowCreate__ - Allow ChannelApe to create products and variants on this channel. Defaults to _false_.\r\n\r\n* __allowRead__ - Allow ChannelApe to read existing products and variants from this channel. Defaults to _true_.\r\n\r\n* __allowUpdate__ - Allow ChannelApe to update products and variants on this channel for all fields included in __updateFields__. Defaults to _false_.\r\n\r\n* __allowDelete__ - Allow ChannelApe to delete products and variants from this channel. Defaults to _false_.\r\n\r\n* __priceType__ - Which price variant price field _retail_ or _wholesale_ that ChannelApe will use when creating or updating variants on this channel. Defaults to _retail_.\r\n\r\n* __updateFields__ - Set of product and variant fields that ChannelApe is allowed to update. Defaults to _images_, _inventoryQuantity_, _price_, _vendor_, _weight_, _description_, _title_, and _tags_.\r\n\r\n* __disableVariants__ - Should ChannelApe push products with multiple variants when available to the channel or just single products. Only a limited number of channels support this flag. Defaults to _false_."},"response":[],"_postman_id":"020b1ca2-636d-40f8-ae29-45051cd5c7d3"},{"name":"Update channel","id":"cc36d1aa-1d0e-4566-ae98-9766b108b98c","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":"{\n    \"name\" : \"Don's Donnybrook Gear 86\",\n    \"enabled\" : true,\n    \"credentials\" : {\n        \"accessToken\" : \"xxxxxxxxxxxxxxxxx\",\n        \"shopSubdomain\" : \"example-site\"\n     },\n    \"settings\": {\n        \"allowCreate\": true,\n        \"allowDelete\": true,\n        \"allowRead\": true,\n        \"allowUpdate\": true,\n        \"priceType\": \"wholesale\",\n        \"disableVariants\" : \"false\",\n        \"updateFields\": [\n          \"images\",\n          \"price\"\n        ]\n  }\n}"},"url":"https://api.channelape.com/v1/channels/{{channel_id}}","description":"Update a channel for a business.\r\n\r\n# Required Fields\r\n__name__ - Needs to be unique across all channels for the business.\r\n\r\n__credentials__ - Only required if the integration has credential keys.\r\n\r\n# Optional Fields\r\n__enabled__ - Indicates whether the channel is installed. Uninstalled channels cannot run actions. Defaults to _false_.\r\n\r\n__settings__ - Map with multiple optional values.\r\n\r\n* __allowCreate__ - Allow ChannelApe to create products and variants on this channel. Defaults to _false_.\r\n\r\n* __allowRead__ - Allow ChannelApe to read existing products and variants from this channel. Defaults to _true_.\r\n\r\n* __allowUpdate__ - Allow ChannelApe to update products and variants on this channel for all fields included in __updateFields__. Defaults to _false_.\r\n\r\n* __allowDelete__ - Allow ChannelApe to delete products and variants from this channel. Defaults to _false_.\r\n\r\n* __priceType__ - Which price variant price field _retail_ or _wholesale_ that ChannelApe will use when creating or updating variants on this channel. Defaults to _retail_.\r\n\r\n* __updateFields__ - Set of product and variant fields that ChannelApe is allowed to update. Defaults to _images_, _inventoryQuantity_, _price_, _vendor_, _weight_, _description_, _title_, and _tags_.\r\n\r\n* __disableVariants__ - Should ChannelApe push products with multiple variants when available to the channel or just single products. Only a limited number of channels support this flag. Defaults to _false_."},"response":[],"_postman_id":"cc36d1aa-1d0e-4566-ae98-9766b108b98c"},{"name":"Create custom export channel","id":"740850c4-f7d3-8bf6-3ec5-70e5e91b5d94","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":"{\r\n    \"businessId\": \"some-business-id\",\r\n    \"integrationId\": \"02df0b31-a071-4791-b9c2-aa01e4fb0ce6\",\r\n    \"enabled\": true,\r\n    \"name\": \"My Custom Export\",\r\n    \"settings\": {\r\n        \"allowRead\": true,\r\n        \"priceType\": \"retail\",\r\n        \"outputFile\": {\r\n            \"header\": true,\r\n            \"columns\": [\r\n                {\r\n                    \"header\": \"Product ID\",\r\n                    \"field\": \"productId\"\r\n                },\r\n                {\r\n                    \"header\": \"Variant ID\",\r\n                    \"field\": \"inventoryItemValue\"\r\n                },\r\n                {\r\n                    \"header\": \"SKU\",\r\n                    \"field\": \"sku\"\r\n                },\r\n                {\r\n                    \"header\": \"UPC\",\r\n                    \"field\": \"upc\"\r\n                },\r\n                {\r\n                    \"header\": \"Length\",\r\n                    \"value\": \"10\"\r\n                },\r\n                {\r\n                    \"header\": \"Product Title\",\r\n                    \"field\": \"productTitle\"\r\n                },\r\n                {\r\n                    \"header\": \"Product Description\",\r\n                    \"field\": \"productDescription\"\r\n                },\r\n                {\r\n                    \"header\": \"Product Primary Category\",\r\n                    \"field\": \"productPrimaryCategory\"\r\n                },\r\n                {\r\n                    \"header\": \"Product Secondary Category\",\r\n                    \"field\": \"productSecondaryCategory\"\r\n                },\r\n                {\r\n                    \"header\": \"Product Vendor\",\r\n                    \"field\": \"productVendor\"\r\n                },\r\n                {\r\n                    \"header\": \"Option 1 Name\",\r\n                    \"value\": \"Size\"\r\n                },\r\n                {\r\n                    \"header\": \"Option 1 Value\",\r\n                    \"field\": \"optionValue\",\r\n                    \"key\": \"Size\"\r\n                },\r\n                {\r\n                    \"header\": \"Option 2 Name\",\r\n                    \"field\": \"optionValue\",\r\n                    \"key\": \"Flavor\"\r\n                },\r\n                {\r\n                    \"header\": \"Option 2 Value\",\r\n                    \"key\": \"Flavor\"\r\n                },\r\n                {\r\n                    \"header\": \"Color\",\r\n                    \"field\": \"optionValue\",\r\n                    \"key\": \"Color\"\r\n                },\r\n                {\r\n                    \"header\": \"Product Image 1\",\r\n                    \"field\": \"productImage\",\r\n                    \"index\": 0\r\n                },\r\n                {\r\n                    \"header\": \"Product Image 2\",\r\n                    \"field\": \"productImage\",\r\n                    \"index\": 1\r\n                },\r\n                {\r\n                    \"header\": \"Thumbnail\",\r\n                    \"field\": \"productImage\",\r\n                    \"index\": 28\r\n                },\r\n                {\r\n                    \"header\": \"Product Tags\",\r\n                    \"field\": \"productTags\"\r\n                },\r\n                {\r\n                    \"header\": \"Description\",\r\n                    \"field\": \"description\"\r\n                },\r\n                {\r\n                    \"header\": \"Primary Category\",\r\n                    \"field\": \"primaryCategory\"\r\n                },\r\n                {\r\n                    \"header\": \"Secondary Category\",\r\n                    \"field\": \"secondaryCategory\"\r\n                },\r\n                {\r\n                    \"header\": \"Vendor\",\r\n                    \"field\": \"vendor\"\r\n                },\r\n                {\r\n                    \"header\": \"Quantity\",\r\n                    \"field\": \"quantity\"\r\n                },\r\n                {\r\n                    \"header\": \"Pounds\",\r\n                    \"field\": \"weight\",\r\n                    \"unitOfMeasurement\": \"lb\"\r\n                },\r\n                {\r\n                    \"header\": \"Grams\",\r\n                    \"field\": \"weight\",\r\n                    \"unitOfMeasurement\": \"g\"\r\n                },\r\n                {\r\n                    \"header\": \"Ounces\",\r\n                    \"field\": \"weight\",\r\n                    \"unitOfMeasurement\": \"oz\"\r\n                },\r\n                {\r\n                    \"header\": \"Weight\",\r\n                    \"field\": \"weight\",\r\n                    \"unitOfMeasurement\": \"kg\"\r\n                },\r\n                {\r\n                    \"header\": \"Currency Code\",\r\n                    \"field\": \"alphabeticCurrencyCode\"\r\n                },\r\n                {\r\n                    \"header\": \"Retail Price\",\r\n                    \"field\": \"retailPrice\"\r\n                },\r\n                {\r\n                    \"header\": \"Wholesale Price\",\r\n                    \"field\": \"wholesalePrice\"\r\n                },\r\n                {\r\n                    \"header\": \"Condition\",\r\n                    \"field\": \"condition\"\r\n                },\r\n                {\r\n                    \"header\": \"Image 1\",\r\n                    \"field\": \"image\",\r\n                    \"index\": 0\r\n                },\r\n                {\r\n                    \"header\": \"Image 2\",\r\n                    \"field\": \"image\",\r\n                    \"index\": 1\r\n                },\r\n                {\r\n                    \"header\": \"Cover Image\",\r\n                    \"field\": \"image\",\r\n                    \"index\": 4\r\n                },\r\n                {\r\n                    \"header\": \"Tags\",\r\n                    \"field\": \"tags\"\r\n                },\r\n                {\r\n                    \"header\": \"Additional Field 1 Name\",\r\n                    \"value\": \"ebay_category_id\"\r\n                },\r\n                {\r\n                    \"header\": \"Additional Field 1 Value\",\r\n                    \"field\": \"additionalFieldValue\",\r\n                    \"key\": \"ebay_category_id\"\r\n                },\r\n                {\r\n                    \"header\": \"Name\",\r\n                    \"value\": \"jcpenny_title\"\r\n                },\r\n                {\r\n                    \"header\": \"Value\",\r\n                    \"field\": \"additionalFieldValue\",\r\n                    \"key\": \"jcpenny_title\"\r\n                },\r\n                {\r\n                    \"header\": \"Name\",\r\n                    \"value\": \"sears_title\"\r\n                },\r\n                {\r\n                    \"header\": \"Value\",\r\n                    \"field\": \"additionalFieldValue\",\r\n                    \"key\": \"sears_title\"\r\n                },\r\n                {\r\n                    \"header\": \"Amazon Quantity\",\r\n                    \"field\": \"additionalFieldValue\",\r\n                    \"key\": \"amz_quantity\"\r\n                }\r\n            ]\r\n        }\r\n    }\r\n}"},"url":"https://api.channelape.com/v1/channels/","description":"Create a Custom Export Channel for a business.\r\n\r\n# Required Fields\r\n__businessId__ - ID for ChannelApe business that channel should be created for.\r\n\r\n__integrationId__ - ID for Custom Export Channel. Must match ChannelApe Exporter integration ID (02df0b31-a071-4791-b9c2-aa01e4fb0ce6).\r\n\r\n__name__ - Needs to be unique across all channels for the business.\r\n\r\n# Optional Fields\r\n__enabled__ - Indicates whether the channel is installed. Uninstalled channels cannot run actions. Defaults to _false_.\r\n\r\n__settings__ - Map with multiple optional values.\r\n\r\n* __allowRead__ - Allow ChannelApe to read existing products and variants from this channel. Defaults to _true_.\r\n\r\n* __priceType__ - Which price variant price field _retail_ or _wholesale_ that ChannelApe will use when creating or updating variants on this channel. Defaults to _retail_.\r\n\r\n* __outputFile__ - Map with multiple optional values to indicate file format.\r\n    \r\n    * __header__ - Whether the output file should contain a header row consisting of _column header_ values. Defaults to _true_.\r\n    * __columns__ - List of columns to write to output file. Defaults to empty list.\r\n        * __header__ - Value used for column header. Required field with no default.\r\n        * __field__ - Indicates ChannelApe product or variant field should be outputted for this column. Valid values are:\r\n            * productId\r\n            * inventoryItemValue\r\n            * sku\r\n            * upc\r\n            * productTitle\r\n            * produtDescription\r\n            * productPrimaryCategory\r\n            * productSecondaryCategory\r\n            * productVendor\r\n            * optionValue\r\n            * productImage\r\n            * productTags - Sorted alphabetically and comma separated\r\n            * title\r\n            * description\r\n            * primaryCategory\r\n            * secondaryCategory\r\n            * vendor\r\n            * quantity\r\n            * weight\r\n            * alphabeticCurrencyCode\r\n            * retailPrice\r\n            * wholesalePrice\r\n            * condition\r\n            * image\r\n            * tags - Sorted alphabetically and comma separated\r\n            * additionalFieldValue\r\n        * __index__ - Only applicable for _productImage_ and _image_ fields. Indicates index (starting at 0) of image within images list. Return null if index does not exist.\r\n        * __key__ - Only appicable for _optionValue_ and _additionalFieldValue_ fields. Indicates key within map to retrieve. Returns null if key does not exist.\r\n        * __value__ - Static value to be written to each cell in the column. Only valid when _field_ is empty.\r\n        * __unitOfMeasurement__ - Only applicable for _weight_ field. Indicates what unit to output variant weight in. Defaults to grams. Valid values are:\r\n            * oz - Ounces\r\n            * lb - Pounds\r\n            * g - Grams\r\n            * kg - Kilograms\r\n            * t - Metric Tonnes\r\n\r\n\r\n"},"response":[],"_postman_id":"740850c4-f7d3-8bf6-3ec5-70e5e91b5d94"},{"name":"Update custom export channel","id":"8db70c08-a8a1-6c34-8d53-ee9d3f2aacc3","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":"{\r\n    \"enabled\": true,\r\n    \"name\": \"My Custom Export\",\r\n    \"settings\": {\r\n        \"allowRead\": true,\r\n        \"priceType\": \"wholesale\",\r\n        \"outputFile\": {\r\n            \"header\": false,\r\n            \"columns\": [\r\n                {\r\n                    \"header\": \"Product ID\",\r\n                    \"field\": \"productId\"\r\n                },\r\n                {\r\n                    \"header\": \"Variant ID\",\r\n                    \"field\": \"inventoryItemValue\"\r\n                },\r\n                {\r\n                    \"header\": \"SKU\",\r\n                    \"field\": \"sku\"\r\n                },\r\n                {\r\n                    \"header\": \"UPC\",\r\n                    \"field\": \"upc\"\r\n                },\r\n                {\r\n                    \"header\": \"Length\",\r\n                    \"value\": \"10\"\r\n                },\r\n                {\r\n                    \"header\": \"Product Title\",\r\n                    \"field\": \"productTitle\"\r\n                },\r\n                {\r\n                    \"header\": \"Product Description\",\r\n                    \"field\": \"productDescription\"\r\n                },\r\n                {\r\n                    \"header\": \"Product Primary Category\",\r\n                    \"field\": \"productPrimaryCategory\"\r\n                },\r\n                {\r\n                    \"header\": \"Product Secondary Category\",\r\n                    \"field\": \"productSecondaryCategory\"\r\n                },\r\n                {\r\n                    \"header\": \"Product Vendor\",\r\n                    \"field\": \"productVendor\"\r\n                },\r\n                {\r\n                    \"header\": \"Option 1 Name\",\r\n                    \"value\": \"Size\"\r\n                },\r\n                {\r\n                    \"header\": \"Option 1 Value\",\r\n                    \"field\": \"optionValue\",\r\n                    \"key\": \"Size\"\r\n                },\r\n                {\r\n                    \"header\": \"Option 2 Name\",\r\n                    \"field\": \"optionValue\",\r\n                    \"key\": \"Flavor\"\r\n                },\r\n                {\r\n                    \"header\": \"Option 2 Value\",\r\n                    \"key\": \"Flavor\"\r\n                },\r\n                {\r\n                    \"header\": \"Color\",\r\n                    \"field\": \"optionValue\",\r\n                    \"key\": \"Color\"\r\n                },\r\n                {\r\n                    \"header\": \"Product Image 1\",\r\n                    \"field\": \"productImage\",\r\n                    \"index\": 0\r\n                },\r\n                {\r\n                    \"header\": \"Product Image 2\",\r\n                    \"field\": \"productImage\",\r\n                    \"index\": 1\r\n                },\r\n                {\r\n                    \"header\": \"Thumbnail\",\r\n                    \"field\": \"productImage\",\r\n                    \"index\": 28\r\n                },\r\n                {\r\n                    \"header\": \"Product Tags\",\r\n                    \"field\": \"productTags\"\r\n                },\r\n                {\r\n                    \"header\": \"Description\",\r\n                    \"field\": \"description\"\r\n                },\r\n                {\r\n                    \"header\": \"Primary Category\",\r\n                    \"field\": \"primaryCategory\"\r\n                },\r\n                {\r\n                    \"header\": \"Secondary Category\",\r\n                    \"field\": \"secondaryCategory\"\r\n                },\r\n                {\r\n                    \"header\": \"Vendor\",\r\n                    \"field\": \"vendor\"\r\n                },\r\n                {\r\n                    \"header\": \"Quantity\",\r\n                    \"field\": \"quantity\"\r\n                },\r\n                {\r\n                    \"header\": \"Pounds\",\r\n                    \"field\": \"weight\",\r\n                    \"unitOfMeasurement\": \"lb\"\r\n                },\r\n                {\r\n                    \"header\": \"Grams\",\r\n                    \"field\": \"weight\",\r\n                    \"unitOfMeasurement\": \"g\"\r\n                },\r\n                {\r\n                    \"header\": \"Ounces\",\r\n                    \"field\": \"weight\",\r\n                    \"unitOfMeasurement\": \"oz\"\r\n                },\r\n                {\r\n                    \"header\": \"Weight\",\r\n                    \"field\": \"weight\",\r\n                    \"unitOfMeasurement\": \"kg\"\r\n                },\r\n                {\r\n                    \"header\": \"Currency Code\",\r\n                    \"field\": \"alphabeticCurrencyCode\"\r\n                },\r\n                {\r\n                    \"header\": \"Retail Price\",\r\n                    \"field\": \"retailPrice\"\r\n                },\r\n                {\r\n                    \"header\": \"Wholesale Price\",\r\n                    \"field\": \"wholesalePrice\"\r\n                },\r\n                {\r\n                    \"header\": \"Condition\",\r\n                    \"field\": \"condition\"\r\n                },\r\n                {\r\n                    \"header\": \"Image 1\",\r\n                    \"field\": \"image\",\r\n                    \"index\": 0\r\n                },\r\n                {\r\n                    \"header\": \"Image 2\",\r\n                    \"field\": \"image\",\r\n                    \"index\": 1\r\n                },\r\n                {\r\n                    \"header\": \"Cover Image\",\r\n                    \"field\": \"image\",\r\n                    \"index\": 4\r\n                },\r\n                {\r\n                    \"header\": \"Tags\",\r\n                    \"field\": \"tags\"\r\n                },\r\n                {\r\n                    \"header\": \"Additional Field 1 Name\",\r\n                    \"value\": \"ebay_category_id\"\r\n                },\r\n                {\r\n                    \"header\": \"Additional Field 1 Value\",\r\n                    \"field\": \"additionalFieldValue\",\r\n                    \"key\": \"ebay_category_id\"\r\n                },\r\n                {\r\n                    \"header\": \"Name\",\r\n                    \"value\": \"jcpenny_title\"\r\n                },\r\n                {\r\n                    \"header\": \"Value\",\r\n                    \"field\": \"additionalFieldValue\",\r\n                    \"key\": \"jcpenny_title\"\r\n                },\r\n                {\r\n                    \"header\": \"Name\",\r\n                    \"value\": \"sears_title\"\r\n                },\r\n                {\r\n                    \"header\": \"Value\",\r\n                    \"field\": \"additionalFieldValue\",\r\n                    \"key\": \"sears_title\"\r\n                },\r\n                {\r\n                    \"header\": \"Amazon Quantity\",\r\n                    \"field\": \"additionalFieldValue\",\r\n                    \"key\": \"amz_quantity\"\r\n                }\r\n            ]\r\n        }\r\n    }\r\n}"},"url":"https://api.channelape.com/v1/channels/{{channel_id}}","description":"Update a Custom Export Channel for a business.\r\n\r\n# Required Fields\r\n__name__ - Needs to be unique across all channels for the business.\r\n\r\n# Optional Fields\r\n__enabled__ - Indicates whether the channel is installed. Uninstalled channels cannot run actions. Defaults to _false_.\r\n\r\n__settings__ - Map with multiple optional values.\r\n\r\n* __allowRead__ - Allow ChannelApe to read existing products and variants from this channel. Defaults to _true_.\r\n\r\n* __priceType__ - Which price variant price field _retail_ or _wholesale_ that ChannelApe will use when creating or updating variants on this channel. Defaults to _retail_.\r\n\r\n* __outputFile__ - Map with multiple optional values to indicate file format.\r\n    \r\n    * __header__ - Whether the output file should contain a header row consisting of _column header_ values. Defaults to _true_.\r\n    * __columns__ - List of columns to write to output file. Defaults to empty list.\r\n        * __header__ - Value used for column header. Required field with no default.\r\n        * __field__ - Indicates ChannelApe product or variant field should be outputted for this column. Valid values are:\r\n            * productId\r\n            * inventoryItemValue\r\n            * sku\r\n            * upc\r\n            * productTitle\r\n            * produtDescription\r\n            * productPrimaryCategory\r\n            * productSecondaryCategory\r\n            * productVendor\r\n            * optionValue\r\n            * productImage\r\n            * productTags - Sorted alphabetically and comma separated\r\n            * title\r\n            * description\r\n            * primaryCategory\r\n            * secondaryCategory\r\n            * vendor\r\n            * quantity\r\n            * weight\r\n            * alphabeticCurrencyCode\r\n            * retailPrice\r\n            * wholesalePrice\r\n            * condition\r\n            * image\r\n            * tags - Sorted alphabetically and comma separated\r\n            * additionalFieldValue\r\n        * __index__ - Only applicable for _productImage_ and _image_ fields. Indicates index (starting at 0) of image within images list. Return null if index does not exist.\r\n        * __key__ - Only appicable for _optionValue_ and _additionalFieldValue_ fields. Indicates key within map to retrieve. Returns null if key does not exist.\r\n        * __value__ - Static value to be written to each cell in the column. Only valid when _field_ is empty.\r\n        * __unitOfMeasurement__ - Only applicable for _weight_ field. Indicates what unit to output variant weight in. Defaults to grams. Valid values are:\r\n            * oz - Ounces\r\n            * lb - Pounds\r\n            * g - Grams\r\n            * kg - Kilograms\r\n            * t - Metric Tonnes\r\n\r\n\r\n"},"response":[],"_postman_id":"8db70c08-a8a1-6c34-8d53-ee9d3f2aacc3"},{"name":"Get channel","id":"5ae83c32-233a-40a4-b018-a1fd5875d295","request":{"method":"GET","header":[{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.channelape.com/v1/channels/{{channel_id}}","description":"Retrieve a single channel by ID."},"response":[],"_postman_id":"5ae83c32-233a-40a4-b018-a1fd5875d295"},{"name":"Get Channels for Business","id":"68fe1cc9-d8a9-4193-8335-4f1f95ab880c","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.channelape.com/v1/channels?businessId={{business_id}}","protocol":"https","host":["api","channelape","com"],"path":["v1","channels"],"query":[{"key":"businessId","value":"{{business_id}}"}]},"description":"Retrieve all channels belonging to a business."},"response":[],"_postman_id":"68fe1cc9-d8a9-4193-8335-4f1f95ab880c"},{"name":"Add manual action","id":"9a2f4538-d529-425b-9d53-b6b9295cb748","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":"{\n    \"action\" : \"PRODUCT_PUSH\"\n}"},"url":"https://api.channelape.com/v1/channels/{{channel_id}}/actions","description":"Start a manual action for a channel.\n\n# Required Fields\n__action__ - Name of action you wish to run for this channel. Must be an action listed for this integration."},"response":[],"_postman_id":"9a2f4538-d529-425b-9d53-b6b9295cb748"}],"id":"95e92a2c-5d58-4f88-a0d3-9d5e4e80158e","description":"Channel references the marketplaces, affiliate networks, or partners that ChannelApe can interact with to distribute your catalog or to retrieve orders from. Some examples of channels would be, Amazon, Shopify, ShareaSale or Google Shopping.","_postman_id":"95e92a2c-5d58-4f88-a0d3-9d5e4e80158e"},{"name":"Completed Task Counts","item":[{"name":"Retrieve compled task counts","id":"6a787f5a-6b35-46e6-8e61-eedf2766c16f","request":{"method":"GET","header":[{"key":"x-channel-ape-authorization-token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://staging-api.channelape.com/v1/completedtasks/counts?businessId=99d16f26-2ae3-4eee-9c9b-4cb8dafbb9ae&startDate=2016-10-16T00:00:00.000Z&endDate=2016-10-19T00:00:00.000Z","protocol":"https","host":["staging-api","channelape","com"],"path":["v1","completedtasks","counts"],"query":[{"key":"businessId","value":"99d16f26-2ae3-4eee-9c9b-4cb8dafbb9ae"},{"key":"startDate","value":"2016-10-16T00:00:00.000Z"},{"key":"endDate","value":"2016-10-19T00:00:00.000Z"}]}},"response":[],"_postman_id":"6a787f5a-6b35-46e6-8e61-eedf2766c16f"}],"id":"ec84e572-57b3-48fc-8fa2-17614150c0a0","_postman_id":"ec84e572-57b3-48fc-8fa2-17614150c0a0"},{"name":"Completed Tasks","item":[{"name":"Get completed task","id":"312f6e7c-fb3b-42d3-8f7f-0951a5c3bdf0","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.channelape.com/v1/completedtasks/cd066699-fc6c-4f34-805a-69023b026ba2"},"response":[],"_postman_id":"312f6e7c-fb3b-42d3-8f7f-0951a5c3bdf0"},{"name":"Get completed tasks for business","id":"158f3566-39e0-404e-a8ab-feec71402331","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.channelape.com/v1/completedtasks?businessId=3875411f-fcd3-444a-9691-622d022ff639&size=5&lastKey=499322cd-c859-455e-a777-9a7852a5c9c3&startDate=2016-03-23T12:41:21.338Z&endDate=2016-03-23T12:42:21.338Z","protocol":"https","host":["api","channelape","com"],"path":["v1","completedtasks"],"query":[{"key":"businessId","value":"3875411f-fcd3-444a-9691-622d022ff639"},{"key":"size","value":"5"},{"key":"lastKey","value":"499322cd-c859-455e-a777-9a7852a5c9c3"},{"key":"startDate","value":"2016-03-23T12:41:21.338Z"},{"key":"endDate","value":"2016-03-23T12:42:21.338Z"}]}},"response":[],"_postman_id":"158f3566-39e0-404e-a8ab-feec71402331"}],"id":"aa31ec8a-8d87-4f37-bf4b-2c89a1a32f9f","description":"This is a unit we use for billing, you won't need to use it for the API. A completed task is recorded anytime we Create, Update or Delete something within ChannelApe or on a Channel.","_postman_id":"aa31ec8a-8d87-4f37-bf4b-2c89a1a32f9f"},{"name":"File Previews","item":[{"name":"Create file preview","id":"38e18b45-aad1-4b8c-8192-9ba532877ce1","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":"{\n    \"fileType\" : \"TSV\",\n    \"url\" : \"ftp://ftp.example.com/test.txt\",\n    \"authorization\" : {\n      \"username\" : \"admin\",\n      \"password\" : \"admin\"\n     },\n    \"headers\" : false\n}"},"url":"https://api.channelape.com/v1/filepreviews"},"response":[],"_postman_id":"38e18b45-aad1-4b8c-8192-9ba532877ce1"}],"id":"36d6f710-5780-4b79-86f5-a555ff8705bd","_postman_id":"36d6f710-5780-4b79-86f5-a555ff8705bd"},{"name":"Integrations","item":[{"name":"Get integration","id":"dbb8566d-6a3f-41c2-b6dc-3d2ec34e065e","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.channelape.com/v1/integrations/{{integration_id}}","description":"Retrieve integration information."},"response":[],"_postman_id":"dbb8566d-6a3f-41c2-b6dc-3d2ec34e065e"},{"name":"Get integrations","id":"50156844-ec79-45f1-a8a3-aa953f79c73a","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.channelape.com/v1/integrations?businessId={{business_id}}","protocol":"https","host":["api","channelape","com"],"path":["v1","integrations"],"query":[{"key":"businessId","value":"{{business_id}}"}]},"description":"Retrieve all public integrations. Private supplier integrations that have already been installed can also be retrieved by passing the businessId query paramter.\n\nOptional Query Parameters\n---\n__businessId__ - Needed to retrieve any private supplier integrations associated with business."},"response":[],"_postman_id":"50156844-ec79-45f1-a8a3-aa953f79c73a"}],"id":"867bce21-b8c3-430b-b8ff-0cbec958e7ed","_postman_id":"867bce21-b8c3-430b-b8ff-0cbec958e7ed"},{"name":"Inventories","item":[{"name":"Create inventory item","id":"d6ad6f80-086a-418f-9d24-46eb35a626a4","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":"{\n    \"sku\": \"CA-FAKEFAKEFAKE\",\n    \"upc\": \"asdf141-fasdf1231-sadf-aaaa\",\n    \"title\" : \"Krabby Patty - Testing removal of business ID\",\n    \"vendor\" : \"test 1 2 3\",\n    \"quantity\": 5,\n    \"grams\": \"44.662\",\n    \"retailPrice\": \"19.95\",\n    \"condition\" : \"NEW\",\n    \"description\" : \"Test 1 2 3\",\n    \"wholesalePrice\": \"0.05\",\n    \"categories\" : {\n        \"test\" : \"uhm\"\n    },\n    \"images\": [\n        \"image1\",\n        \"image2\",\n        \"image3\"\n    ],\n    \"options\": {\n        \"color\": \"red\",\n        \"size\": \"XL\",\n      \"stateOfMatter\" : \"gas\"\n    },\n    \"additionalFields\": {\n        \"height\": \"40\",\n        \"width\": \"20\"\n    }\n}"},"url":"https://api.channelape.com/v1/suppliers/32a61bc2-5668-4f0c-9c85-20a4492671b8/inventories"},"response":[],"_postman_id":"d6ad6f80-086a-418f-9d24-46eb35a626a4"},{"name":"Delete inventory item","id":"265e3a06-4b42-4e55-ac00-382c9ae8dbe1","request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.channelape.com/v1/suppliers/e53b8da6-741b-4ab4-b4b9-42b4747c64bc/inventories/CA-DELETEME","description":"Deletes an inventory item associated with a supplier. Inventory items can only be deleted if there is no variant references that depend on them."},"response":[],"_postman_id":"265e3a06-4b42-4e55-ac00-382c9ae8dbe1"},{"name":"Get inventory items for supplier","id":"8174f1c6-7efd-4350-85d0-2a9088e97437","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.channelape.com/v1/suppliers/9b5aaa6b-7740-488c-b965-9b89a40bc0dd/inventories?lastKey=00045529859197&size=300","protocol":"https","host":["api","channelape","com"],"path":["v1","suppliers","9b5aaa6b-7740-488c-b965-9b89a40bc0dd","inventories"],"query":[{"key":"lastKey","value":"00045529859197"},{"key":"size","value":"300"}]},"description":"Query inventory items for a given supplier.\n\nOptional query parameters\n---\n__lastKey__ - ID returned on previous page of results. Used to retrieve next page of results when results are paginated.\n\n__size__ - Integer between 1 and infinity (defaults to 250). Maximum number of results to return.\n\n__count__ - Boolean values of true or false (defaults to false). Should query return count of all matched results."},"response":[],"_postman_id":"8174f1c6-7efd-4350-85d0-2a9088e97437"},{"name":"Update inventory item","id":"4b3c0f5c-44c8-41bd-a4e0-55a52fd632d4","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":"{\n  \"options\": {\n    \"Size\": \"100 ea\"\n  },\n  \"additionalFields\": {\n    \"WindsorQtyOnHand\": \"Maybe kinda yes\",\n    \"MfgAddress\": \"1801 S. Nova Road Daytona Beach, FL 32119\",\n    \"GeneralCategory\": \"Supplements\",\n    \"Description\": \"Chromium Picolinate, 100 Capsules\",\n    \"WholeSalePrice\": \"4.99\",\n    \"LasQtyOnHand\": \"Yes\",\n    \"LogoURL\": \"https://www.europasports.com/media/images/logos/png/nutrakey.png\",\n    \"Directions\": \"Take one capsule (200 mcg) with water or your favorite beverage twice daily on an empty stomach. Take first dose in the morning & second dose one hour prior to lunch.\",\n    \"PrimaryCategory\": \"Weight Loss / Energy\",\n    \"Image100URL\": \"https://www.europasports.com/media/catalog/100/820103309684.jpg\",\n    \"UPC\": \"820103309684\",\n    \"ListDate\": \"2013-11-18\",\n    \"CaseQty\": \"12\",\n    \"Depth\": \"2.000\",\n    \"ChltQtyOnHand\": \"Yes\",\n    \"ProductDetails\": \"Glucose Metabolism. Essential trace element insulin & glucose regulation.  Pharmaceutical grade. Chromium is a metal. It's called an \\\"essential trace elements\\\" because very small amounts of chromium are necessary for human health. Chromium is used in the body for optimizing blood sugar control and is essential in glucose uptake into muscle cells. The biologically active form of chromium participates in glucose metabolism by enhancing the effects of insulin. Insulin is a peptide hormone produced in the beta-cells of the pancreas. It is central to carbohydrate and fat metabolism. Insulin causes the cells in the skeletal muscles, liver, and fat tissue to absorb glucose from the blood. In the liver and skeletal muscles, glucose is stored as glycogen and in fat cells, as triglycerides. Insulin is provided in the body in a constant proportion to remove excess glucose from the blood, which otherwise would be toxic. When blood glucose levels fall below a certain level, the body begins to use stored sugar as an energy source through glycogenolysis, which breaks down the glycogen stored in the liver and muscle into glucose, which can be utilized as an energy source.\",\n    \"CollectionID\": \"1005940\",\n    \"LabeledAsGlutenFree\": \"0\",\n    \"ItemName\": \"Chromium Picolinate\",\n    \"Height\": \"4.250\",\n    \"ItemSize\": \"100\",\n    \"Width\": \"2.000\",\n    \"StrQtyOnHand\": \"No\",\n    \"OrlQtyOnHand\": \"Yes\",\n    \"BasicDescription\": \"CHROMIUM PICOLINATE 200mcg100C\",\n    \"MAPPrice\": \"0.00\",\n    \"ThumbNailURL\": \"https://www.europasports.com/media/catalog/50/820103309684.gif\",\n    \"Ingredients\": \"Gelatin, rice flour.\",\n    \"ImageURL\": \"https://www.europasports.com/media/catalog/250/820103309684.jpg\",\n    \"MesqQtyOnHand\": \"Yes\",\n    \"Title\": \"Nutrakey Chromium Picolinate\",\n    \"SupplierNumber\": \"615\",\n    \"FreQtyOnHand\": \"Yes\",\n    \"ItemMeasure\": \"ea\",\n    \"Brand\": \"Nutrakey\",\n    \"Mass\": \"0.2\",\n    \"Image500URL\": \"https://www.europasports.com/media/catalog/500/820103309684.jpg\",\n    \"ImageName\": \"820103309684\",\n    \"ExtendedSize\": \"100 Capsules\",\n    \"SupplierName\": \"NUTRAKEY\",\n    \"SuggestedRetailPrice\": \"8.99\",\n    \"PostDate\": \"2013-11-27\",\n    \"StockCode\": \"6150062\",\n    \"Warnings\": \"Hypoallergenic: contains no yeast, dairy egg, gluten, corn soy, wheat, sugar, starch, salt, preservatives, or artificial color, flavor or fragrance.\",\n    \"SeaTacQtyOnHand\": \"No\",\n    \"SupplierWebAddress\": \"http://thenutrakey.com/health/shop/\"\n  },\n  \"categories\": {\n    \"secondary\": \"Supplements\",\n    \"primary\": \"Weight Loss / Energy\"\n  },\n  \"alphabeticCurrencyCode\": \"USD\",\n  \"businessId\": \"9b32e7d4-d6a0-4d86-9c5d-9f6094d692c2\",\n  \"condition\": \"NEW\",\n  \"createdAt\": \"2015-07-29T20:04:00.195Z\",\n  \"description\": \"<div class=\\\"description\\\">Description</div><p>Glucose Metabolism. Essential trace element insulin & glucose regulation.  Pharmaceutical grade. Chromium is a metal. It's called an \\\"essential trace elements\\\" because very small amounts of chromium are necessary for human health. Chromium is used in the body for optimizing blood sugar control and is essential in glucose uptake into muscle cells. The biologically active form of chromium participates in glucose metabolism by enhancing the effects of insulin. Insulin is a peptide hormone produced in the beta-cells of the pancreas. It is central to carbohydrate and fat metabolism. Insulin causes the cells in the skeletal muscles, liver, and fat tissue to absorb glucose from the blood. In the liver and skeletal muscles, glucose is stored as glycogen and in fat cells, as triglycerides. Insulin is provided in the body in a constant proportion to remove excess glucose from the blood, which otherwise would be toxic. When blood glucose levels fall below a certain level, the body begins to use stored sugar as an energy source through glycogenolysis, which breaks down the glycogen stored in the liver and muscle into glucose, which can be utilized as an energy source.</p><div class=\\\"directions\\\">Directions</div><p>Take one capsule (200 mcg) with water or your favorite beverage twice daily on an empty stomach. Take first dose in the morning & second dose one hour prior to lunch.</p><div class=\\\"warnings\\\">Warnings</div><p>Hypoallergenic: contains no yeast, dairy egg, gluten, corn soy, wheat, sugar, starch, salt, preservatives, or artificial color, flavor or fragrance.</p>\",\n  \"errors\": [],\n  \"grams\": \"0\",\n  \"images\": [\n    \"https://www.europasports.com/media/catalog/500/820103309684.jpg\"\n  ],\n  \"quantity\": 1,\n  \"retailPrice\": \"8.99\",\n  \"sku\": \"CA-FAKEFAKEFAKE\",\n  \"title\": \"Nutrakey Chromium Picolinate\",\n  \"upc\": \"820103309684\",\n  \"updatedAt\": \"2015-07-30T14:18:31.979Z\",\n  \"vendor\": \"R.J.'s Awesome Test of Awesomeness\",\n  \"wholesalePrice\": \"4.99\",\n  \"resolveVariants\" : false\n}"},"url":"https://api.channelape.com/v1/suppliers/32a61bc2-5668-4f0c-9c85-20a4492671b8/inventories/CA-FAKEFAKEFAKE","description":"# Optional Fields\r\n__resolveVariants__ - When set to true, any variants that this inventory item is used by will be resolved synchronously. When set to false, variant resolution will be queued up and processed asynchronously. Defaults to _false_.\r\n"},"response":[],"_postman_id":"4b3c0f5c-44c8-41bd-a4e0-55a52fd632d4"},{"name":"Get inventory item","id":"a07d4975-b118-4a8b-8236-48c5cc740d12","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.channelape.com/v1/suppliers/c9490497-36e0-4783-9e15-6582fe785d15/inventories/040200"},"response":[],"_postman_id":"a07d4975-b118-4a8b-8236-48c5cc740d12"}],"id":"d7c64977-1783-4897-90b5-e5199fd17878","_postman_id":"d7c64977-1783-4897-90b5-e5199fd17878"},{"name":"Orders","item":[{"name":"Create order","id":"0ac29bd0-b803-4c9e-8a21-6d1817d53dcc","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":"{\n  \"businessId\": \"{{business_id}}\",\n  \"channelId\": \"{{channel_id}}\",\n  \"channelOrderId\": \"{{channel_order_id}}\",\n  \"status\": \"CANCELED\",\n  \"alphabeticCurrencyCode\": \"USD\",\n  \"totalPrice\": \"30.80\",\n  \"subtotalPrice\": \"30.80\",\n  \"totalTax\": \"1.97\",\n  \"totalShippingPrice\": \"3.00\",\n  \"totalShippingTax\": \"0.18\",\n  \"totalGrams\": \"226.796\",\n  \"purchasedAt\": \"2015-09-11T20:52:15.000Z\",\n  \"canceledAt\": \"2015-09-13T08:04:00.000Z\",\n  \"canceledReason\": \"Wrong product\",\n  \"customer\": {\n    \"name\": \"Dan Nino\",\n    \"firstName\": \"Dan\",\n    \"lastName\": \"Nino\",\n    \"email\": \"iomalte14@yopmail.com\",\n    \"phone\": \"(570)555-1234\",\n    \"shippingAddress\": {\n      \"name\": \"Dan Nino\",\n      \"firstName\": \"Dan\",\n      \"lastName\": \"Nino\",\n      \"company\": \"ChannelApe\",\n      \"address1\": \"224 Wyoming Avenue\",\n      \"address2\": \"Rear of 1st Floor\",\n      \"city\": \"Scranton\",\n      \"province\": \"Pennsylvania\",\n      \"provinceCode\": \"PA\",\n      \"country\": \"United States\",\n      \"countryCode\": \"US\",\n      \"postalCode\": \"18503\",\n      \"phone\": \"(555)555-5555\",\n      \"additionalFields\": [\n        {\n          \"name\": \"shipping_address_id\",\n          \"value\": \"3425252\"\n        },\n        {\n          \"name\": \"note\",\n          \"value\": \"Leave with dog.\"\n        }\n      ]\n    },\n    \"billingAddress\": {\n      \"name\": \"Dan Nino\",\n      \"firstName\": \"Dan\",\n      \"lastName\": \"Nino\",\n      \"company\": \"ChannelApe\",\n      \"address1\": \"224 Wyoming Avenue\",\n      \"address2\": \"Rear of 1st Floor\",\n      \"city\": \"Scranton\",\n      \"province\": \"Pennsylvania\",\n      \"provinceCode\": \"PA\",\n      \"country\": \"United States\",\n      \"countryCode\": \"US\",\n      \"postalCode\": \"18503\",\n      \"phone\": \"(555)555-5555\",\n      \"additionalFields\": [\n        {\n          \"name\": \"billing_address_id\",\n          \"value\": \"897987466\"\n        },\n        {\n          \"name\": \"note\",\n          \"value\": \"Paid with PayPal\"\n        }\n      ]\n    },\n    \"additionalFields\": [\n      {\n        \"name\": \"FirstTimeCustomer\",\n        \"value\": \"false\"\n      },\n      {\n        \"name\": \"InternationalCustomer\",\n        \"value\": \"false\"\n      }\n    ]\n  },\n  \"fulfillments\": [\n    {\n      \"id\": \"94938\",\n      \"status\": \"CANCELED\",\n      \"shippingCompany\": \"UPS\",\n      \"shippingMethod\": \"SecondDay\",\n      \"trackingNumber\": \"AF335244\",\n      \"lineItems\": [\n        {\n          \"id\": \"52365397597450\",\n          \"sku\": \"0Z-DAPL-Y6NE\",\n          \"upc\": \"442806190\",\n          \"price\": \"30.80\",\n          \"shippingPrice\": \"3.00\",\n          \"shippingTax\": \"0.18\",\n          \"shippingMethod\": \"2nd Day Air\",\n          \"quantity\": 1,\n          \"title\": \"Metagenics Multigenics Intensive Care without Iron 180T\",\n          \"vendor\": \"Metagenics\",\n          \"grams\": \"226.796\",\n          \"additionalFields\": [\n            {\n              \"name\": \"ASIN\",\n              \"value\": \"B003B6UM5S\"\n            },\n            {\n              \"name\": \"QuantityShipped\",\n              \"value\": \"1\"\n            },\n            {\n              \"name\": \"ItemTaxCurrencyCode\",\n              \"value\": \"USD\"\n            },\n            {\n              \"name\": \"PromotionDiscountCurrencyCode\",\n              \"value\": \"USD\"\n            },\n            {\n              \"name\": \"PromotionDiscountAmount\",\n              \"value\": \"0.00\"\n            }\n          ]\n        }\n      ],\n      \"additionalFields\": [\n        {\n          \"name\": \"WarehouseID\",\n          \"value\": \"CA-34\"\n        }\n      ]\n    }\n  ],\n  \"lineItems\": [\n    {\n      \"id\": \"52365397597450\",\n      \"sku\": \"0Z-DAPL-Y6NE\",\n      \"upc\": \"442806190\",\n      \"price\": \"30.80\",\n      \"shippingPrice\": \"3.00\",\n      \"shippingTax\": \"0.18\",\n      \"shippingMethod\": \"2nd Day Air\",\n      \"quantity\": 1,\n      \"title\": \"Metagenics Multigenics Intensive Care without Iron 180T\",\n      \"vendor\": \"Metagenics\",\n      \"grams\": \"226.796\",\n      \"additionalFields\": [\n        {\n          \"name\": \"ASIN\",\n          \"value\": \"B003B6UM5S\"\n        },\n        {\n          \"name\": \"QuantityShipped\",\n          \"value\": \"1\"\n        },\n        {\n          \"name\": \"ItemTaxCurrencyCode\",\n          \"value\": \"USD\"\n        },\n        {\n          \"name\": \"PromotionDiscountCurrencyCode\",\n          \"value\": \"USD\"\n        },\n        {\n          \"name\": \"PromotionDiscountAmount\",\n          \"value\": \"0.00\"\n        }\n      ]\n    }\n  ],\n  \"additionalFields\": [\n    {\n      \"name\": \"MarketplaceId\",\n      \"value\": \"ATVPDKIKX0DER\"\n    },\n    {\n      \"name\": \"FulfillmentChannel\",\n      \"value\": \"AFN\"\n    },\n    {\n      \"name\": \"ShipmentServiceLevelCategory\",\n      \"value\": \"SecondDay\"\n    },\n    {\n      \"name\": \"ShipServiceLevel\",\n      \"value\": \"SecondDay\"\n    },\n    {\n      \"name\": \"NumberOfItemsShipped\",\n      \"value\": \"1\"\n    },\n    {\n      \"name\": \"NumberOfItemsUnshipped\",\n      \"value\": \"0\"\n    },\n    {\n      \"name\": \"EarliestShipDate\",\n      \"value\": \"2015-09-14T07:15:36Z\"\n    },\n    {\n      \"name\": \"LatestShipDate\",\n      \"value\": \"2015-09-14T07:15:36Z\"\n    }\n  ]\n}"},"url":"https://api.channelape.com/v1/orders","description":"Create a new order for a channel. \n\nRequired Fields\n---\n__channelId__ - ID for ChannelApe channel that order belongs to (i.e. Shopify Channel, Amazon Channel, eBay Channel).\n\n__channelOrderId__ - ID for order unique to ChannelApe business that you assign (i.e. Shopify Order ID, ASIN).\n\n__alphabeticCurrencyCode__ - Currency used throughout all price fields of the order (i.e. USD, EUR, CAD).\n\n__status__ - State of order (OPEN, IN_PROGRESS, CLOSED, CANCELED).\n\n__lineItems__ - List of line items for the order. At least one is required to create order. Only required fields for a lineItem are a \"id\" and \"quantity\". \"id\" needs to be unique across all line items for the order and \"quantity\" needs to be greater then 0."},"response":[],"_postman_id":"0ac29bd0-b803-4c9e-8a21-6d1817d53dcc"},{"name":"Update order","id":"1c0d0b6f-e6d6-4c6d-9ee7-6ac21e3fe0cf","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":"{\n  \"businessId\": \"{{business_id}}\",\n  \"channelId\": \"{{channel_id}}\",\n  \"channelOrderId\": \"{{channel_order_id}}\",\n  \"status\": \"CANCELED\",\n  \"alphabeticCurrencyCode\": \"USD\",\n  \"totalPrice\": \"30.80\",\n  \"subtotalPrice\": \"30.80\",\n  \"totalTax\": \"1.97\",\n  \"totalShippingPrice\": \"3.00\",\n  \"totalShippingTax\": \"0.18\",\n  \"totalGrams\": \"226.796\",\n  \"purchasedAt\": \"2015-09-11T20:52:15.000Z\",\n  \"canceledAt\": \"2015-09-13T08:04:00.000Z\",\n  \"canceledReason\": \"Wrong product\",\n  \"customer\": {\n    \"name\": \"Dan Nino\",\n    \"firstName\": \"Dan\",\n    \"lastName\": \"Nino\",\n    \"email\": \"iomalte14@yopmail.com\",\n    \"phone\": \"(570)555-1234\",\n    \"shippingAddress\": {\n      \"name\": \"Dan Nino\",\n      \"firstName\": \"Dan\",\n      \"lastName\": \"Nino\",\n      \"company\": \"ChannelApe\",\n      \"address1\": \"224 Wyoming Avenue\",\n      \"address2\": \"Rear of 1st Floor\",\n      \"city\": \"Scranton\",\n      \"province\": \"Pennsylvania\",\n      \"provinceCode\": \"PA\",\n      \"country\": \"United States\",\n      \"countryCode\": \"US\",\n      \"postalCode\": \"18503\",\n      \"phone\": \"(555)555-5555\",\n      \"additionalFields\": [\n        {\n          \"name\": \"shipping_address_id\",\n          \"value\": \"3425252\"\n        },\n        {\n          \"name\": \"note\",\n          \"value\": \"Leave with dog.\"\n        }\n      ]\n    },\n    \"billingAddress\": {\n      \"name\": \"Dan Nino\",\n      \"firstName\": \"Dan\",\n      \"lastName\": \"Nino\",\n      \"company\": \"ChannelApe\",\n      \"address1\": \"224 Wyoming Avenue\",\n      \"address2\": \"Rear of 1st Floor\",\n      \"city\": \"Scranton\",\n      \"province\": \"Pennsylvania\",\n      \"provinceCode\": \"PA\",\n      \"country\": \"United States\",\n      \"countryCode\": \"US\",\n      \"postalCode\": \"18503\",\n      \"phone\": \"(555)555-5555\",\n      \"additionalFields\": [\n        {\n          \"name\": \"billing_address_id\",\n          \"value\": \"897987466\"\n        },\n        {\n          \"name\": \"note\",\n          \"value\": \"Paid with PayPal\"\n        }\n      ]\n    },\n    \"additionalFields\": [\n      {\n        \"name\": \"FirstTimeCustomer\",\n        \"value\": \"false\"\n      },\n      {\n        \"name\": \"InternationalCustomer\",\n        \"value\": \"false\"\n      }\n    ]\n  },\n  \"fulfillments\": [\n    {\n      \"id\": \"94938\",\n      \"status\": \"CANCELED\",\n      \"shippingCompany\": \"UPS\",\n      \"shippingMethod\": \"SecondDay\",\n      \"trackingNumber\": \"AF335244\",\n      \"lineItems\": [\n        {\n          \"id\": \"52365397597450\",\n          \"sku\": \"0Z-DAPL-Y6NE\",\n          \"upc\": \"442806190\",\n          \"price\": \"30.80\",\n          \"shippingPrice\": \"3.00\",\n          \"shippingTax\": \"0.18\",\n          \"shippingMethod\": \"2nd Day Air\",\n          \"quantity\": 1,\n          \"title\": \"Metagenics Multigenics Intensive Care without Iron 180T\",\n          \"vendor\": \"Metagenics\",\n          \"grams\": \"226.796\",\n          \"additionalFields\": [\n            {\n              \"name\": \"ASIN\",\n              \"value\": \"B003B6UM5S\"\n            },\n            {\n              \"name\": \"QuantityShipped\",\n              \"value\": \"1\"\n            },\n            {\n              \"name\": \"ItemTaxCurrencyCode\",\n              \"value\": \"USD\"\n            },\n            {\n              \"name\": \"PromotionDiscountCurrencyCode\",\n              \"value\": \"USD\"\n            },\n            {\n              \"name\": \"PromotionDiscountAmount\",\n              \"value\": \"0.00\"\n            }\n          ]\n        }\n      ],\n      \"additionalFields\": [\n        {\n          \"name\": \"WarehouseID\",\n          \"value\": \"CA-34\"\n        }\n      ]\n    }\n  ],\n  \"additionalFields\": [\n    {\n      \"name\": \"MarketplaceId\",\n      \"value\": \"ATVPDKIKX0DER\"\n    },\n    {\n      \"name\": \"FulfillmentChannel\",\n      \"value\": \"AFN\"\n    },\n    {\n      \"name\": \"ShipmentServiceLevelCategory\",\n      \"value\": \"SecondDay\"\n    },\n    {\n      \"name\": \"ShipServiceLevel\",\n      \"value\": \"SecondDay\"\n    },\n    {\n      \"name\": \"NumberOfItemsShipped\",\n      \"value\": \"1\"\n    },\n    {\n      \"name\": \"NumberOfItemsUnshipped\",\n      \"value\": \"0\"\n    },\n    {\n      \"name\": \"EarliestShipDate\",\n      \"value\": \"2015-09-14T07:15:36Z\"\n    },\n    {\n      \"name\": \"LatestShipDate\",\n      \"value\": \"2015-09-14T07:15:36Z\"\n    }\n  ]\n}"},"url":"https://api.channelape.com/v1/orders/21c922c0-69a4-425b-aea3-4ad8e1aaffc4","description":"Update a single order using its ID. Line Item information cannot be updated. Any data not included in the request will be erased from the currently saved order.\n\nRequired Fields\n---\n__channelId__ - ID for ChannelApe channel that order belongs to (i.e. Shopify Channel, Amazon Channel, eBay Channel).\n\n__channelOrderId__ - ID for order unique to ChannelApe business that you assign (i.e. Shopify Order ID, ASIN).\n\n__alphabeticCurrencyCode__ - Currency used throughout all price fields of the order (i.e. USD, EUR, CAD).\n\n__status__ - State of order (OPEN, IN_PROGRESS, CLOSED, CANCELED)."},"response":[],"_postman_id":"1c0d0b6f-e6d6-4c6d-9ee7-6ac21e3fe0cf"},{"name":"Get order","id":"57e867d2-f60a-472d-a9b0-7616b55173e3","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":"{\n  \"channelOrderId\": \"11111\",\n  \"channelId\": \"9aef1bfc-39b2-488c-9e61-b37946b7412e\",\n  \"status\": \"OPEN\",\n  \"alphabeticCurrencyCode\": \"USD\",\n  \"customer\": {\n    \"firstName\": \"R.J.\",\n    \"lastName\": \"Davis\",\n    \"email\": \"rjdavis@channelape.com\"\n  },\n  \"lineItems\": [{\n    \"id\": \"ABC134\",\n    \"quantity\": 4\n  }]\n}"},"url":"https://api.channelape.com/v1/orders/{{order_id}}","description":"Retrieve a single order by its order ID."},"response":[],"_postman_id":"57e867d2-f60a-472d-a9b0-7616b55173e3"},{"name":"Query orders by business","id":"7d5c4ffa-1e23-44ba-b723-26543c451558","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":"{\n  \"channelOrderId\": \"488\",\n  \"channelId\": \"9aef1bfc-39b2-488c-9e61-b37946b7412e\",\n  \"status\": \"OPEN\",\n  \"alphabeticCurrencyCode\": \"USD\",\n  \"lineItems\": [{\n    \"id\": \"42\",\n    \"quantity\": 4\n  }]\n}"},"url":{"raw":"https://api.channelape.com/v1/orders?businessId={{business_id}}&status=CLOSED&size=100&startDate=2016-02-20T20:21:51.403Z&endDate=2017-02-27T20:00:00.000Z&lastKey={{last_key}}","protocol":"https","host":["api","channelape","com"],"path":["v1","orders"],"query":[{"key":"businessId","value":"{{business_id}}"},{"key":"status","value":"CLOSED"},{"key":"size","value":"100"},{"key":"startDate","value":"2016-02-20T20:21:51.403Z"},{"key":"endDate","value":"2017-02-27T20:00:00.000Z"},{"key":"lastKey","value":"{{last_key}}"}]},"description":"Query orders for a given business.\n\nRequired query parameters\n---\n\n__businessId__ - ID of ChannelApe business\n\nOptional query parameters\n---\n\n__status__ - String of OPEN, IN_PROGRESS, CLOSED, or CANCELED (no default). Used to filter results by one or many statuses. Multiple statuses can be provided by duplicate the status key and providing a different value.\n\n__startDate__ - ISO 8601 date string (defaults to epoch time). Used to filter results after given purchase date.\n\n__endDate__ - ISO 8601 date string (defaults to current time). Used to filter results before given purchase date.\n\n__lastKey__ - ID returned on previous page of results. Used to retrieve next page of results when results are paginated.\n\n__size__ - Integer between 1 and 100 (defaults to 100). Maximum number of results to return.\n\n__count__ - Boolean values of true or false (defaults to false). Should query return count of all matched results."},"response":[],"_postman_id":"7d5c4ffa-1e23-44ba-b723-26543c451558"},{"name":"Search for order by business and channel order ID","id":"58201a50-d707-48ed-8768-a3ddd973b3bd","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":"{\n  \"channelOrderId\": \"488\",\n  \"channelId\": \"9aef1bfc-39b2-488c-9e61-b37946b7412e\",\n  \"status\": \"OPEN\",\n  \"alphabeticCurrencyCode\": \"USD\",\n  \"lineItems\": [{\n    \"id\": \"42\",\n    \"quantity\": 4\n  }]\n}"},"url":{"raw":"https://api.channelape.com/v1/orders?businessId={{business_id}}&channelOrderId={{channel_order_id}}","protocol":"https","host":["api","channelape","com"],"path":["v1","orders"],"query":[{"key":"businessId","value":"{{business_id}}"},{"key":"channelOrderId","value":"{{channel_order_id}}"}]},"description":"Search for an order within a business using its Channel Order ID.\n\nRequired query parameters\n---\n__businessId__ - ID of ChannelApe business\n\n__channelOrderId__ - ID of order you are searching for."},"response":[],"_postman_id":"58201a50-d707-48ed-8768-a3ddd973b3bd"},{"name":"Query orders by channel","id":"6dc19307-5197-4650-bba0-2787705be104","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":"{\n  \"channelOrderId\": \"488\",\n  \"channelId\": \"9aef1bfc-39b2-488c-9e61-b37946b7412e\",\n  \"status\": \"OPEN\",\n  \"alphabeticCurrencyCode\": \"USD\",\n  \"lineItems\": [{\n    \"id\": \"42\",\n    \"quantity\": 4\n  }]\n}"},"url":{"raw":"https://api.channelape.com/v1/orders?channelId={{channel_id}}}&status=OPEN&size=100&startDate=2016-02-20T20:21:51.403Z&endDate=2017-02-27T20:00:00.000Z&lastKey={{last_key}}","protocol":"https","host":["api","channelape","com"],"path":["v1","orders"],"query":[{"key":"channelId","value":"{{channel_id}}}"},{"key":"status","value":"OPEN"},{"key":"size","value":"100"},{"key":"startDate","value":"2016-02-20T20:21:51.403Z"},{"key":"endDate","value":"2017-02-27T20:00:00.000Z"},{"key":"lastKey","value":"{{last_key}}"}]},"description":"Query orders for a given channel.\n\nRequired query parameters\n---\n__channelId__ - ID of ChannelApe channel\n\nOptional query parameters\n---\n__status__ - String of OPEN, IN_PROGRESS, CLOSED, or CANCELED (no default). Used to filter results by one or many statuses. Multiple statuses can be provided by duplicate the status key and providing a different value.\n\n__startDate__ - ISO 8601 date string (defaults to epoch time). Used to filter results after given purchase date.\n\n__endDate__ - ISO 8601 date string (defaults to current time). Used to filter results before given purchase date.\n\n__lastKey__ - ID returned on previous page of results. Used to retrieve next page of results when results are paginated.\n\n__size__ - Integer between 1 and 100 (defaults to 100). Maximum number of results to return.\n\n__count__ - Boolean values of true or false (defaults to false). Should query return count of all matched results."},"response":[],"_postman_id":"6dc19307-5197-4650-bba0-2787705be104"},{"name":"Delete order","id":"4c0a18df-4557-460d-b159-6055bac4c0a4","request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":"{\n  \"channelOrderId\": \"11111\",\n  \"channelId\": \"9aef1bfc-39b2-488c-9e61-b37946b7412e\",\n  \"status\": \"OPEN\",\n  \"alphabeticCurrencyCode\": \"USD\",\n  \"customer\": {\n    \"firstName\": \"R.J.\",\n    \"lastName\": \"Davis\",\n    \"email\": \"rjdavis@channelape.com\"\n  },\n  \"lineItems\": [{\n    \"id\": \"ABC134\",\n    \"quantity\": 4\n  }]\n}"},"url":"https://api.channelape.com/v1/orders/0202cd4e-077c-496d-a218-5171172a9afa","description":"Delete a single order using its ID."},"response":[],"_postman_id":"4c0a18df-4557-460d-b159-6055bac4c0a4"},{"name":"Get order summary","id":"677ecce4-57d8-5aa3-a478-66eaf8e97692","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":"{\n  \"channelOrderId\": \"488\",\n  \"channelId\": \"9aef1bfc-39b2-488c-9e61-b37946b7412e\",\n  \"status\": \"OPEN\",\n  \"alphabeticCurrencyCode\": \"USD\",\n  \"lineItems\": [{\n    \"id\": \"42\",\n    \"quantity\": 4\n  }]\n}"},"url":{"raw":"https://api.channelape.com/v1/orders/summaries?businessId={{business_id}}&startDate=2017-02-26T18:51:24.275Z&endDate=2017-05-03T18:51:24.275Z","protocol":"https","host":["api","channelape","com"],"path":["v1","orders","summaries"],"query":[{"key":"businessId","value":"{{business_id}}"},{"key":"startDate","value":"2017-02-26T18:51:24.275Z"},{"key":"endDate","value":"2017-05-03T18:51:24.275Z"}]},"description":"Retrieves a summary of order inforamtion between two periods. Defaults to seven days.\n\nRequired query parameters\n---\n__businessId__ - ID of ChannelApe business\n\nOptional query parameters\n---\n__startDate__ - ISO 8601 date string (defaults to 7 days prior). Used to filter results after given purchase date.\n\n__endDate__ - ISO 8601 date string (defaults to current time). Used to filter results before given purchase date.\n\nResponse variables\n---\n__earliestCreationTime__ - Timestamp of startDate given as query parameter or seven days prior if no startDate is given.\n\n__latestCreationTime__ - Timestamp of endDate given as query parameter or current time if no endDate is given.\n\n__agingOrders__ - Orders with a createdAt date between seven days and two months ago and an order status of OPEN or IN_PROGRESS. Note this list does not change regardless of what startDat and endDate are set to.\n\n__alphabeticCurrencyCode__ - Currency that all money values returned are in. Should be currency code used by business. This endpoint does not convert currencies and instead assumes all orders have the same currency as the business.\n\n__closedOrders__ - Number of orders with CLOSED status found for this business between the provided start and end dates.\n\n__openOrders__ - Number of orders with OPEN status found for this business between the provided start and end dates.\n\n__inProgressOrders__ - Number of orders with IN_PROGRESS status found for this business between the provided start and end dates.\n\n__canceledOrders__ - Number of orders with CANCELED status found for this business between the provided start and end dates.\n\n__totalOrders__ - Number of orders found for this business between the provided start and end dates.\n\n__totalRevenue__ - Summation of totalPrice for all orders found between the provided start and end dates with an OPEN, IN_PROGRESS, or CLOSED status.\n\n__channels__ - Total order and revenue information for all channels (enabled or not) for the business sorted in descending order by total revenue. totalRevenue for each channel is calculated by summing the totalPrice for each order that has an IN_PROGRESS, CLOSED, or OPEN status. Channel without any orders are excluded.\n\n__topSellingLineItems__ - Top 100 selling line items sorted in descending order by totalRevenue. totalRevenue for each line item is calcualted by multipling line item price by quantity. Line items with the same line item ID are summed together to get the totalRevenue for each line item."},"response":[],"_postman_id":"677ecce4-57d8-5aa3-a478-66eaf8e97692"}],"id":"6ef49f96-2f1c-49d7-a3a3-4da5974d477c","description":"An order is transaction that was placed on either your website or marketplace. Using the ChannelApe API you could query orders by business and retrieve orders from every channel we support in a unified format.","_postman_id":"6ef49f96-2f1c-49d7-a3a3-4da5974d477c"},{"name":"Product Blocks","item":[{"name":"Get product block","id":"ecd21cd4-dbd6-4f42-a491-9838312f4069","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.channelape.com/v1/channels/a0b92153-650e-458a-9253-edeb945c5d31/productblocks/dacbeace-dafc-4609-88f1-7a836bb75fda"},"response":[],"_postman_id":"ecd21cd4-dbd6-4f42-a491-9838312f4069"},{"name":"Query product blocks by channel ID","id":"7a0d5baf-a4bf-4c93-a825-b9bdc0be6ab6","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.channelape.com/v1/channels/a0b92153-650e-458a-9253-edeb945c5d31/productblocks"},"response":[],"_postman_id":"7a0d5baf-a4bf-4c93-a825-b9bdc0be6ab6"},{"name":"Delete product block","id":"5942b7bd-371b-4abb-874f-06f8b238958e","request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.channelape.com/v1/channels/a0b92153-650e-458a-9253-edeb945c5d31/productblocks/a3f76404-6f5f-4240-8cb0-8042becf56be"},"response":[],"_postman_id":"5942b7bd-371b-4abb-874f-06f8b238958e"},{"name":"Query product blocks by business ID and product filter ID","id":"1c14c81e-717e-4c5a-87e8-22e0a3a3b969","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.channelape.com/v1/channels/productblocks?businessId=9f5c18b9-fef3-4d75-9dab-ea9a15fb3940&productFilterId=8cc21616-e22f-46d1-913e-00aeecb8d0f2","protocol":"https","host":["api","channelape","com"],"path":["v1","channels","productblocks"],"query":[{"key":"businessId","value":"9f5c18b9-fef3-4d75-9dab-ea9a15fb3940"},{"key":"productFilterId","value":"8cc21616-e22f-46d1-913e-00aeecb8d0f2"}]}},"response":[],"_postman_id":"1c14c81e-717e-4c5a-87e8-22e0a3a3b969"},{"name":"Put product block","id":"4bc275b9-4e9a-46cf-b0d3-063a26c45e8f","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.channelape.com/v1/channels/a0b92153-650e-458a-9253-edeb945c5d31/productblocks/a3f76404-6f5f-4240-8cb0-8042becf56be"},"response":[],"_postman_id":"4bc275b9-4e9a-46cf-b0d3-063a26c45e8f"}],"id":"1a5badc3-16f4-4114-b885-f802f81a4d01","_postman_id":"1a5badc3-16f4-4114-b885-f802f81a4d01"},{"name":"Product Filters","item":[{"name":"Update product filter","id":"69e6870e-54b1-4bc9-9909-208eee1e59e7","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":"{\n  \"complement\": false,\n  \"createdAt\": \"2015-10-22T17:23:38.106Z\",\n  \"errors\": [],\n  \"id\": \"90887395-9ace-45e5-8e0a-f97920cde82f\",\n  \"label\": \"Product Filter with sets of SKUs, UPCs, and Vendors - UPDATE\",\n  \"skus\": [\n    \"190856\"\n  ],\n  \"tags\": [\n    \"EuropaSports\"\n  ],\n  \"upcs\": [\n    \"027434004190\"\n  ],\n  \"updatedAt\": \"2015-10-22T17:24:28.074Z\",\n  \"vendors\": [\n    \"TwinLab\",\n    \"Clif\"\n  ]\n}"},"url":"https://api.channelape.com/v1/products/filters/90887395-9ace-45e5-8e0a-f97920cde82f"},"response":[],"_postman_id":"69e6870e-54b1-4bc9-9909-208eee1e59e7"},{"name":"Delete product filter","id":"de365662-54db-49c5-890a-52a51113af46","request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.channelape.com/v1/products/filters/8cc21616-e22f-46d1-913e-00aeecb8d0f2"},"response":[],"_postman_id":"de365662-54db-49c5-890a-52a51113af46"},{"name":"Create product filter","id":"c9a43ef4-4bfc-4bc5-a3eb-288fc5392bcf","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":"{\n    \"businessId\": \"0ea98dc8-367c-4288-888a-7872e105dc52\",\n    \"label\" : \"Testing Empty Tag Set Error\",\n    \"condition\" : \"NEW\",\n      \"skus\": [\n        \"190856\"\n      ],\n      \"tags\": [\n      ]\n}"},"url":"https://api.channelape.com/v1/products/filters"},"response":[],"_postman_id":"c9a43ef4-4bfc-4bc5-a3eb-288fc5392bcf"},{"name":"Query  product filters by business ID and label","id":"f563933e-07ee-483d-97bf-c1d4d0e938c3","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.channelape.com/v1/products/filters?businessId=9f5c18b9-fef3-4d75-9dab-ea9a15fb3940&label=true","protocol":"https","host":["api","channelape","com"],"path":["v1","products","filters"],"query":[{"key":"businessId","value":"9f5c18b9-fef3-4d75-9dab-ea9a15fb3940"},{"key":"label","value":"true"}]}},"response":[],"_postman_id":"f563933e-07ee-483d-97bf-c1d4d0e938c3"},{"name":"Get  product filter","id":"a3268f0a-fcd3-41c3-9bf6-be40af033e97","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.channelape.com/v1/products/filters/90887395-9ace-45e5-8e0a-f97920cde82f"},"response":[],"_postman_id":"a3268f0a-fcd3-41c3-9bf6-be40af033e97"}],"id":"8cdcaf84-4a02-4755-89e0-1fac91956ab4","_postman_id":"8cdcaf84-4a02-4755-89e0-1fac91956ab4"},{"name":"Product Modifiers","item":[{"name":"Create product modifier","id":"fbc7866e-a1ea-4b76-b165-e56be8050f63","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":"{\n    \"businessId\": \"9f5c18b9-fef3-4d75-9dab-ea9a15fb3940\",\n    \"name\" : \"Set Equal to Five\",\n    \"description\" : \"Setting quantity to five\",\n    \"modifier\" : \"setEqualTo\",\n    \"target\" : \"quantity\",\n    \"value\" : \"4.8\"\n}"},"url":"https://api.channelape.com/v1/products/modifiers"},"response":[],"_postman_id":"fbc7866e-a1ea-4b76-b165-e56be8050f63"},{"name":"Delete  product modifier","id":"9e2fb3ed-3100-4b81-90bd-710d9fb3a2da","request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.channelape.com/v1/products/modifiers/576b5814-07e3-4e60-9f41-9cd7b9ea3266"},"response":[],"_postman_id":"9e2fb3ed-3100-4b81-90bd-710d9fb3a2da"},{"name":"Update  product modifier","id":"5465b5c9-58c3-464e-b691-c47f1ca4aa5d","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":"{\n    \"name\" : \"Add Five Dollars to Price\",\n    \"description\" : \"Add five dollars to retail price\",\n    \"modifier\" : \"addAmount\",\n    \"target\" : \"retailPrice\",\n    \"value\" : \"5.00\"\n}"},"url":"https://api.channelape.com/v1/products/modifiers/d3232e23-fb76-4316-a5ee-0175e71289b0"},"response":[],"_postman_id":"5465b5c9-58c3-464e-b691-c47f1ca4aa5d"},{"name":"Create product modifier","id":"b6b5487e-83b9-4c7e-9dee-ccfb355e6f9a","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":"{\n    \"businessId\": \"41ad9601-a0b1-46a7-a1db-068b36104b6f\",\n    \"name\" : \"Set Equal to Five\",\n    \"description\" : \"Setting quantity to five\",\n    \"modifier\" : \"setEqualTo\",\n    \"target\" : \"quantity\",\n    \"value\" : \"4.8\"\n}"},"url":"https://api.channelape.com/v1/products/modifiers"},"response":[],"_postman_id":"b6b5487e-83b9-4c7e-9dee-ccfb355e6f9a"},{"name":"Get product modifiers for business","id":"27189cbc-ba2e-43c7-b6ba-fd70411de114","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.channelape.com/v1/products/modifiers?businessId=9f5c18b9-fef3-4d75-9dab-ea9a15fb3940","protocol":"https","host":["api","channelape","com"],"path":["v1","products","modifiers"],"query":[{"key":"businessId","value":"9f5c18b9-fef3-4d75-9dab-ea9a15fb3940"}]}},"response":[],"_postman_id":"27189cbc-ba2e-43c7-b6ba-fd70411de114"},{"name":"Get  product modifier","id":"fda83538-7521-4f71-812a-35a2193439e8","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.channelape.com/v1/products/modifiers/d3232e23-fb76-4316-a5ee-0175e71289b0"},"response":[],"_postman_id":"fda83538-7521-4f71-812a-35a2193439e8"}],"id":"ac680208-c874-4901-9fbf-b95e41a9472d","_postman_id":"ac680208-c874-4901-9fbf-b95e41a9472d"},{"name":"Product Pushes","item":[{"name":"Query product pushes by channel ID","id":"306ef0d1-f2c0-4879-97e2-7be706b91c72","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.channelape.com/v1/channels/a0b92153-650e-458a-9253-edeb945c5d31/productpushes"},"response":[],"_postman_id":"306ef0d1-f2c0-4879-97e2-7be706b91c72"},{"name":"Delete product push","id":"d3947bca-b01d-40b9-8098-9595c5de335d","request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.channelape.com/v1/channels/a0b92153-650e-458a-9253-edeb945c5d31/productpushes/5"},"response":[],"_postman_id":"d3947bca-b01d-40b9-8098-9595c5de335d"},{"name":"Put product push without ordinal","id":"a8e1b377-48a2-455c-bfb9-1575eba55dd0","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":"{\n\t\"productFilterIds\": [\n\t\t\"02178907-f8ce-4fd1-91b0-8c7d5e21b7bc\",\n\t\t\"b0d2f967-98ff-4813-b01b-e11db46bc659\",\n\t\t\"4f517811-37e8-4127-b899-255482a27a9b\"\n\t],\n\t\"productModifierIds\": [\n\t\t\"d3232e23-fb76-4316-a5ee-0175e71289b0\",\n\t\t\"b59fc8e5-9dbc-49cc-8367-665551493997\"\n\t],\n\t\"primaryCategoryModifier\": {\n\t\t\"name\": \"Wall Fixtures\",\n\t\t\"value\": \"116880\"\n\t},\n\t\"secondaryCategoryModifier\": {\n\t\t\"name\": \"Lamps, Lighting & Ceiling Fans\",\n\t\t\"value\": \"20697\"\n\t}\n}"},"url":"https://api.channelape.com/v1/channels/a0b92153-650e-458a-9253-edeb945c5d31/productpushes"},"response":[],"_postman_id":"a8e1b377-48a2-455c-bfb9-1575eba55dd0"},{"name":"Put product push","id":"074f010f-55f1-4426-bd7d-4aab47e29229","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":"{\n\t\"productFilterIds\": [\n\t\t\"02178907-f8ce-4fd1-91b0-8c7d5e21b7bc\",\n\t\t\"b0d2f967-98ff-4813-b01b-e11db46bc659\",\n\t\t\"4f517811-37e8-4127-b899-255482a27a9b\"\n\t],\n\t\"productModifierIds\": [\n\t\t\"d3232e23-fb76-4316-a5ee-0175e71289b0\",\n\t\t\"b59fc8e5-9dbc-49cc-8367-665551493997\"\n\t],\n\t\"primaryCategoryModifier\": {\n\t\t\"name\": \"Wall Fixtures\",\n\t\t\"value\": \"116880\"\n\t},\n\t\"secondaryCategoryModifier\": {\n\t\t\"name\": \"Lamps, Lighting & Ceiling Fans\",\n\t\t\"value\": \"20697\"\n\t}\n}"},"url":"https://api.channelape.com/v1/channels/a0b92153-650e-458a-9253-edeb945c5d31/productpushes/5"},"response":[],"_postman_id":"074f010f-55f1-4426-bd7d-4aab47e29229"},{"name":"Get product push","id":"a0fbef1e-b3fb-4b67-9ddf-455b3c1311cc","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.channelape.com/v1/channels/a0b92153-650e-458a-9253-edeb945c5d31/productpushes/1"},"response":[],"_postman_id":"a0fbef1e-b3fb-4b67-9ddf-455b3c1311cc"}],"id":"99e8133d-8926-477c-ace7-d2a4d3c1aba6","_postman_id":"99e8133d-8926-477c-ace7-d2a4d3c1aba6"},{"name":"Products","item":[{"name":"Update Product","id":"19fa8eaa-38ee-45f5-be72-447e03281469","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":"{\n  \"categories\": {\n    \"secondary\": \"so secondary\",\n    \"primary\": \"such primary\"\n  },\n  \"businessId\": \"bff40446-6061-4496-b56a-617fba995d8f\",\n  \"description\": \"Wow what a test - of presentation layer\",\n  \"images\": [\n    \"someOtherUrl\",\n    \"someUrl\"\n  ],\n  \"optionKeys\": [\n    \"More\",\n    \"Color\",\n    \"Cowbell\",\n    \"Density\",\n    \"Width\"\n  ],\n  \"tags\": [\n    \"Test\",\n    \"Hodor\"\n  ],\n  \"title\": \"Testing new product fields\",\n  \"vendor\": \"Hodor\"\n}"},"url":"https://api.channelape.com/v1/products/ba2ca4a0-320a-49a5-bba3-4745cf1a4985"},"response":[],"_postman_id":"19fa8eaa-38ee-45f5-be72-447e03281469"},{"name":"Get Product","id":"869f4321-b9af-4b6d-8af4-87f771185a63","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.channelape.com/v1/products/ba2ca4a0-320a-49a5-bba3-4745cf1a4985"},"response":[],"_postman_id":"869f4321-b9af-4b6d-8af4-87f771185a63"},{"name":"Create product","id":"4385f3ce-a13a-4f74-9c77-c1a42b2699bf","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":"{\n  \"categories\": {\n    \"secondary\": \"so secondary\",\n    \"primary\": \"such primary\"\n  },\n  \"businessId\": \"bff40446-6061-4496-b56a-617fba995d8f\",\n  \"description\": \"Wow what a test - of presentation layer\",\n  \"images\": [\n    \"someOtherUrl\",\n    \"someUrl\"\n  ],\n  \"optionKeys\": [\n    \"More\",\n    \"Color\",\n    \"Cowbell\",\n    \"Density\",\n    \"Width\"\n  ],\n  \"tags\": [\n    \"Test\",\n    \"Hodor\"\n  ],\n  \"title\": \"Testing new product fields\",\n  \"vendor\": \"Hodor\"\n}"},"url":"https://api.channelape.com/v1/products/"},"response":[],"_postman_id":"4385f3ce-a13a-4f74-9c77-c1a42b2699bf"}],"id":"e565542e-8b85-426b-89cf-d616878a7df4","description":"A product is an inventory item located in your catalog. Products are usually listed for sale on a marketplace such as Amazon or Ebay.","_postman_id":"e565542e-8b85-426b-89cf-d616878a7df4"},{"name":"Recipes","item":[{"name":"Get recipe","id":"1730d6a9-597a-46b6-abcd-7326275bb15d","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.channelape.com/v1/recipes/6c62785b-a8b1-453d-aa87-1f23b6821dd4"},"response":[],"_postman_id":"1730d6a9-597a-46b6-abcd-7326275bb15d"},{"name":"Create recipe","id":"3e265a3a-68ff-4ea5-8796-66723c67fa79","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":"{\n  \"businessId\": \"6b30c39f-2c7f-422c-8dbb-39072117e94c\",\n  \"sourceId\" : \"95c48ab3-41df-4a41-af87-3242e2c15c3b\",\n  \"sourceType\" : \"schedule\",\n  \"targetId\" : \"ec67fc63-77f0-4b64-8378-3e7211901f49\",\n  \"targetType\" : \"supplier\",\n  \"targetAction\" : \"PRODUCT_PULL\",\n  \"enabled\" : \"true\"\n}"},"url":"https://api.channelape.com/v1/recipes"},"response":[],"_postman_id":"3e265a3a-68ff-4ea5-8796-66723c67fa79"},{"name":"Delete recipe","id":"ec6d6ca4-5319-4f94-916d-bb7bd530846a","request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.channelape.com/v1/recipes/ee507b56-8b59-4852-860e-579fda07f811"},"response":[],"_postman_id":"ec6d6ca4-5319-4f94-916d-bb7bd530846a"},{"name":"Update recipe","id":"70d4d3f4-b02f-4a76-a929-de2fe76c16c6","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":"{\n  \"enabled\": false,\n  \"sourceId\": \"dd9fc4f7-1d33-467c-8ecb-42b59b488736\",\n  \"sourceType\": \"schedule\",\n  \"targetAction\": \"PRODUCT_PULL\",\n  \"targetId\": \"14384039-7364-44f9-ab00-cd74287ab72a\",\n  \"targetType\": \"supplier\"\n}"},"url":"https://api.channelape.com/v1/recipes/6c62785b-a8b1-453d-aa87-1f23b6821dd4"},"response":[],"_postman_id":"70d4d3f4-b02f-4a76-a929-de2fe76c16c6"},{"name":"Query recipes by business ID","id":"8bf0cbeb-f379-4429-8388-e3de25b1938e","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.channelape.com/v1/recipes?businessId=dbe7abb7-7d2d-4611-a294-c8ddd094a744","protocol":"https","host":["api","channelape","com"],"path":["v1","recipes"],"query":[{"key":"businessId","value":"dbe7abb7-7d2d-4611-a294-c8ddd094a744"}]}},"response":[],"_postman_id":"8bf0cbeb-f379-4429-8388-e3de25b1938e"}],"id":"eb54f053-6f8d-4619-891e-bf5c432e6cec","description":"Recipes are used to create automations within the ChannelApe platform. Recipes can be triggered via a schedule or the completion of an action.","_postman_id":"eb54f053-6f8d-4619-891e-bf5c432e6cec"},{"name":"Schedules","item":[{"name":"Get schedule","id":"f47eaf83-b9fe-490b-b6f5-14c56e9af8ba","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.channelape.com/v1/schedules/adac31c7-d17f-4537-9a86-118360bfaad6"},"response":[],"_postman_id":"f47eaf83-b9fe-490b-b6f5-14c56e9af8ba"},{"name":"Create schedule","id":"54f56ec7-47a3-4966-845d-7d9190de4777","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":"{\n  \"businessId\": \"dbe7abb7-7d2d-4611-a294-c8ddd094a744\",\n  \"daysOfWeek\": [\n    \"WEDNESDAY\",\n    \"MONDAY\",\n    \"FRIDAY\"\n  ],\n  \"endTimeInMinutes\": 1440,\n  \"intervalInMinutes\": 1337,\n  \"startTimeInMinutes\": 544\n}"},"url":"https://api.channelape.com/v1/schedules"},"response":[],"_postman_id":"54f56ec7-47a3-4966-845d-7d9190de4777"},{"name":"Query schedules by business ID","id":"6d313390-780e-4f28-b0c4-99d81fe1ec0c","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.channelape.com/v1/schedules?businessId=dbe7abb7-7d2d-4611-a294-c8ddd094a744","protocol":"https","host":["api","channelape","com"],"path":["v1","schedules"],"query":[{"key":"businessId","value":"dbe7abb7-7d2d-4611-a294-c8ddd094a744"}]}},"response":[],"_postman_id":"6d313390-780e-4f28-b0c4-99d81fe1ec0c"}],"id":"10f70b55-02b6-46cf-899f-02825e51b8bd","_postman_id":"10f70b55-02b6-46cf-899f-02825e51b8bd"},{"name":"Subscriptions","item":[{"name":"Get subscription","id":"ef3f61a5-79a3-471b-8abc-4e16031a5804","request":{"method":"GET","header":[{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.channelape.com/v1/subscriptions/3875411f-fcd3-444a-9691-622d022ff639"},"response":[],"_postman_id":"ef3f61a5-79a3-471b-8abc-4e16031a5804"}],"id":"7d155149-74ed-4023-af3b-8c5ab529dc88","_postman_id":"7d155149-74ed-4023-af3b-8c5ab529dc88"},{"name":"Suppliers","item":[{"name":"Update supplier","id":"4979cf82-99fe-4f62-97d0-a274a3ad758d","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":"{\n  \"credentials\": {\n    \"password\": \"admin\",\n    \"username\": \"admin\"\n  }\n}"},"url":"https://api.channelape.com/v1/suppliers/32a61bc2-5668-4f0c-9c85-20a4492671b8"},"response":[],"_postman_id":"4979cf82-99fe-4f62-97d0-a274a3ad758d"},{"name":"Add manual action","id":"c9bed498-d2d1-4127-9dc3-97ac7a2a8b9b","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":"{\n    \"action\" : \"PRODUCT_UPDATE\"\n}"},"url":"https://api.channelape.com/v1/suppliers/c9490497-36e0-4783-9e15-6582fe785d15/actions"},"response":[],"_postman_id":"c9bed498-d2d1-4127-9dc3-97ac7a2a8b9b"},{"name":"Get Suppliers for Business","id":"8a9d6102-b052-4dc0-a782-f8a2b132dadc","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.channelape.com/v1/suppliers?businessId=9f5c18b9-fef3-4d75-9dab-ea9a15fb3940","protocol":"https","host":["api","channelape","com"],"path":["v1","suppliers"],"query":[{"key":"businessId","value":"9f5c18b9-fef3-4d75-9dab-ea9a15fb3940"}]}},"response":[],"_postman_id":"8a9d6102-b052-4dc0-a782-f8a2b132dadc"},{"name":"Create supplier","id":"847f7a13-da89-4adb-9fb5-423a6c8c2228","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":"{\n  \"businessId\": \"e02b7ccb-12b9-4cdb-b28b-89d3d0a5ff90\",\n  \"integrationId\": \"e4e47fd7-15fa-4276-99a9-6dba0621e68b\",\n  \"name\": \"Generic Data Feed\",\n  \"credentials\" : {\n      \"username\" : \"admin\",\n      \"password\" : \"admin\"\n   },\n  \"fileSettings\": {\n  \"sources\": [{\n    \"id\": \"1\",\n    \"fileType\": \"CSV\",\n    \"url\": \"https://test-file.example.com/test.csv\",\n    \"joinIndex\": 8,\n    \"headers\": true\n  }],\n  \"removedFromFeedTag\": \"RemovedFromMissguidedFeed\",\n  \"productMapping\": {\n    \"columnIndex\": 3,\n    \"sourceId\": \"1\"\n  },\n  \"skuMapping\": {\n    \"columnIndex\": 8,\n    \"sourceId\": \"1\"\n  },\n  \"primaryCategoryMapping\": {\n    \"columnIndex\": 6,\n    \"sourceId\": \"1\"\n  },\n  \"secondaryCategoryMapping\": {\n    \"columnIndex\": 7,\n    \"sourceId\": \"1\"\n  },\n  \"vendorMapping\": {\n    \"columnIndex\": 1,\n    \"sourceId\": \"1\"\n  },\n  \"titleMapping\": [{\n    \"columnIndex\": 0,\n    \"sourceId\": \"1\"\n  }],\n  \"descriptionMapping\": [{\n    \"columnIndex\": 5,\n    \"sourceId\": \"1\"\n  }],\n  \"retailPriceMapping\": {\n    \"columnIndex\": 17,\n    \"sourceId\": \"1\",\n    \"currencyCode\": \"EUR\"\n  },\n  \"imagesMapping\": [{\n    \"columnIndex\": 10,\n    \"sourceId\": \"1\"\n  }, {\n    \"columnIndex\": 11,\n    \"sourceId\": \"1\"\n  }, {\n    \"columnIndex\": 12,\n    \"sourceId\": \"1\"\n  }, {\n    \"columnIndex\": 13,\n    \"sourceId\": \"1\"\n  }, {\n    \"columnIndex\": 14,\n    \"sourceId\": \"1\"\n  }],\n  \"optionsMapping\": [{\n    \"key\": \"size\",\n    \"sourceId\": \"1\",\n    \"columnIndex\": 15\n  }, {\n    \"key\": \"color\",\n    \"sourceId\": \"1\",\n    \"columnIndex\": 9\n  }],\n  \"additionalFieldsMapping\": [{\n    \"key\": \"url\",\n    \"sourceId\": \"1\",\n    \"columnIndex\": 2\n  }, {\n    \"key\": \"productId\",\n    \"sourceId\": \"1\",\n    \"columnIndex\": 3\n  }, {\n    \"key\": \"timestamp\",\n    \"sourceId\": \"1\",\n    \"columnIndex\": 4\n  }, {\n    \"key\": \"sizeName\",\n    \"sourceId\": \"1\",\n    \"columnIndex\": 15\n  }, {\n    \"key\": \"sizeInStock\",\n    \"sourceId\": \"1\",\n    \"columnIndex\": 16\n  }, {\n    \"key\": \"sizePriceGBP\",\n    \"sourceId\": \"1\",\n    \"columnIndex\": 17\n  }, {\n    \"key\": \"sizeOldPriceGBP\",\n    \"sourceId\": \"1\",\n    \"columnIndex\": 18\n  }, {\n    \"key\": \"sizePriceEUR\",\n    \"sourceId\": \"1\",\n    \"columnIndex\": 19\n  }, {\n    \"key\": \"sizeOldPriceEUR\",\n    \"sourceId\": \"1\",\n    \"columnIndex\": 20\n  }],\n  \"tagsMapping\": [{\n    \"prefix\": \"SizeInStock_\",\n    \"sourceId\": \"1\",\n    \"columnIndex\": 16\n  }]\n}\n}"},"url":"https://api.channelape.com/v1/suppliers/"},"response":[],"_postman_id":"847f7a13-da89-4adb-9fb5-423a6c8c2228"},{"name":"Get supplier","id":"843b5c93-83bd-40ed-92cc-9dc0a04243b5","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.channelape.com/v1/suppliers/8711588f-e78d-4d36-81ed-40d87eb24fc7"},"response":[],"_postman_id":"843b5c93-83bd-40ed-92cc-9dc0a04243b5"},{"name":"Create Shopify supplier","id":"f814778b-f1be-4cde-940a-0b8345c3db16","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":"{\n    \"businessId\": \"0ea98dc8-367c-4288-888a-7872e105dc52\",\n    \"integrationId\" :\"5d3eface-f513-4ae6-8552-74539e7a6aba\",\n    \"shopSubdomain\": \"humdingers-business-of-the-americas\",\n    \"authorizationCode\": \"dc08c9b91c0a516af4c086937891d337\",\n    \"name\" : \"Test Shopify Access Token Generation\"\n}"},"url":"https://api.channelape.com/v1/suppliers/shopify"},"response":[],"_postman_id":"f814778b-f1be-4cde-940a-0b8345c3db16"}],"id":"e045a9a9-4ca5-4813-bc3d-846debf2f866","_postman_id":"e045a9a9-4ca5-4813-bc3d-846debf2f866"},{"name":"Users","item":[{"name":"Create session","id":"421a1ffc-895c-4517-9dbd-a3e523a7a8ef","request":{"auth":{"type":"basic","basic":{"username":"{{username}}","password":"{{password}}","saveHelperData":true,"showPassword":false}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic dGVzdEBleGFtcGxlLmNvbTpUZXN0"}],"body":{"mode":"raw","raw":""},"url":"https://api.channelape.com/v1/sessions/","description":"Generates a new session ID for a user. Request requires valid username and password passed through Basic Authentication."},"response":[],"_postman_id":"421a1ffc-895c-4517-9dbd-a3e523a7a8ef"},{"name":"Get session","id":"49d6e717-d53f-4b3e-9fad-6abfc26d6335","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.channelape.com/v1/sessions/{{session_id}}","description":"Retrieves a session by ID. Valid session ID will also return the user ID the session is associated with."},"response":[],"_postman_id":"49d6e717-d53f-4b3e-9fad-6abfc26d6335"},{"name":"Get user","id":"87cdbba4-70ab-4a81-bffc-c3843d72f5eb","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.channelape.com/v1/users/{{user_id}}","description":"Retrieves a user by ID. Valid user IDs will also return username."},"response":[],"_postman_id":"87cdbba4-70ab-4a81-bffc-c3843d72f5eb"}],"id":"3a51d259-0d54-4d7c-98a3-9ea5c6f599c9","_postman_id":"3a51d259-0d54-4d7c-98a3-9ea5c6f599c9"},{"name":"Variant References","item":[{"name":"Update variant reference","id":"53a397d4-10ca-4947-9579-b2f6d664ae30","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":"{\n    \"vendor\": \"32a61bc2-5668-4f0c-9c85-20a4492671b8\",\n    \"title\": \"32a61bc2-5668-4f0c-9c85-20a4492671b8\",\n    \"grams\": \"32a61bc2-5668-4f0c-9c85-20a4492671b8\",\n    \"retailPrice\": \"32a61bc2-5668-4f0c-9c85-20a4492671b8\",\n    \"wholesalePrice\": \"32a61bc2-5668-4f0c-9c85-20a4492671b8\",\n    \"images\":\"32a61bc2-5668-4f0c-9c85-20a4492671b8\",\n    \"optionKeys\": \"32a61bc2-5668-4f0c-9c85-20a4492671b8\",\n    \"condition\" : \"32a61bc2-5668-4f0c-9c85-20a4492671b8\",\n    \"description\" : \"32a61bc2-5668-4f0c-9c85-20a4492671b8\",\n    \"additionalFields\": \"32a61bc2-5668-4f0c-9c85-20a4492671b8\",\n    \"tags\": [\n        \"moist\",\n        \"Adding some Europa tag for testing\"\n    ],\n    \"categories\": \"32a61bc2-5668-4f0c-9c85-20a4492671b8\"\n}"},"url":"https://api.channelape.com/v1/products/4de8995d-1cb6-45ee-b824-b7d6925f6f91/variantreferences/040285"},"response":[],"_postman_id":"53a397d4-10ca-4947-9579-b2f6d664ae30"},{"name":"Get variant reference","id":"8ef98701-a634-44d1-8370-59a40b4a445a","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.channelape.com/v1/products/4de8995d-1cb6-45ee-b824-b7d6925f6f91/variantreferences/040285"},"response":[],"_postman_id":"8ef98701-a634-44d1-8370-59a40b4a445a"},{"name":"Delete variant reference","id":"833f5fa4-71f8-1423-1e0d-bc2a204154bf","request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.channelape.com/v1/products/4de8995d-1cb6-45ee-b824-b7d6925f6f91/variantreferences/040285"},"response":[],"_postman_id":"833f5fa4-71f8-1423-1e0d-bc2a204154bf"},{"name":"Create variant reference","id":"b214858f-f81f-4cb5-ac1b-b0c6345c1e55","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":"{\n    \"sku\": \"CA-DELETEME\",\n    \"upc\": \"CA-DELETEME\",\n    \"vendor\": \"0473685d-dcc8-4afa-8ebe-3a7a6296b45a\",\n    \"title\": \"0473685d-dcc8-4afa-8ebe-3a7a6296b45a\",\n    \"grams\": \"0473685d-dcc8-4afa-8ebe-3a7a6296b45a\",\n    \"retailPrice\": \"0473685d-dcc8-4afa-8ebe-3a7a6296b45a\",\n    \"wholesalePrice\": \"0473685d-dcc8-4afa-8ebe-3a7a6296b45a\",\n    \"images\":\"0473685d-dcc8-4afa-8ebe-3a7a6296b45a\",\n    \"optionKeys\": \"0473685d-dcc8-4afa-8ebe-3a7a6296b45a\",\n    \"condition\" : \"0473685d-dcc8-4afa-8ebe-3a7a6296b45a\",\n    \"description\" : \"0473685d-dcc8-4afa-8ebe-3a7a6296b45a\",\n    \"additionalFields\": \"0473685d-dcc8-4afa-8ebe-3a7a6296b45a\",\n    \"tags\": [\n        \"green\",\n        \"moist\",\n        \"toxic\"\n    ],\n    \"categories\": \"0473685d-dcc8-4afa-8ebe-3a7a6296b45a\"\n}"},"url":"https://api.channelape.com/v1/products/5c42d9dd-2d40-4465-a1c1-87b6fea91fdb/variantreferences"},"response":[],"_postman_id":"b214858f-f81f-4cb5-ac1b-b0c6345c1e55"}],"id":"cd692c9a-9f20-4178-8b67-11761a0392e3","_postman_id":"cd692c9a-9f20-4178-8b67-11761a0392e3"},{"name":"Variants","item":[{"name":"Get Variant","id":"dd79fd0d-09c1-44ad-b47d-aa0d2e90d7a3","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.channelape.com/v1/products/4de8995d-1cb6-45ee-b824-b7d6925f6f91/variants/040285"},"response":[],"_postman_id":"dd79fd0d-09c1-44ad-b47d-aa0d2e90d7a3"},{"name":"Get Product's Variants","id":"96be19c4-6348-46cc-af62-8777e2e87469","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.channelape.com/v1/products/0c3ebdea-d815-4de3-8927-367e0335ba17/variants"},"response":[],"_postman_id":"96be19c4-6348-46cc-af62-8777e2e87469"}],"id":"95257c40-f0df-4a1d-8d85-1ff1ec25ae72","description":"A variant is a specific version (SKU) of your products in your catalog. If your product is a T-Shirt, variants would be the different sizes or colors. The T-shirt could also be known as the parent and the different colors and sizes would be known as children.","_postman_id":"95257c40-f0df-4a1d-8d85-1ff1ec25ae72"},{"name":"Variants Search","item":[{"name":"Search Variants","id":"c800f023-a22a-4b0c-8a83-a399678fde99","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.channelape.com/v1/products/variants?productFilterId=a9cc3f93-4a94-4132-b4f6-0890507dbaf8&size=100","protocol":"https","host":["api","channelape","com"],"path":["v1","products","variants"],"query":[{"key":"productFilterId","value":"a9cc3f93-4a94-4132-b4f6-0890507dbaf8"},{"key":"size","value":"100"}]}},"response":[],"_postman_id":"c800f023-a22a-4b0c-8a83-a399678fde99"},{"name":"Search Variants by Vendor","id":"91299007-97d3-4d40-b6b6-4d34aa97b18b","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.channelape.com/v1/products/variants/vendors?businessId={{business_id}}&vendor=Cli&size=250&count=false","protocol":"https","host":["api","channelape","com"],"path":["v1","products","variants","vendors"],"query":[{"key":"businessId","value":"{{business_id}}"},{"key":"vendor","value":"Cli"},{"key":"size","value":"250"},{"key":"count","value":"false"}]},"description":"Query vendors for a business. Could be used to find vendors given a partial match. Only returns a single matched variant even if more variants with that same vendor exist.\n\nRequired query parameters\n---\n\n__businessId__ - ID of ChannelApe business\n\nOptional query parameters\n---\n\n__vendor__ - Entire or beginning characters of the vendor you wish to find in this business.\n\n__size__ - Integer between 1 and 250 (defaults to 10). Maximum number of results to return.\n\n__count__ - Boolean values of true or false (defaults to false). Should query return count of all matched results."},"response":[],"_postman_id":"91299007-97d3-4d40-b6b6-4d34aa97b18b"},{"name":"Search Variants by SKU","id":"53c29882-878c-4c6a-9a92-c509f09b730c","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.channelape.com/v1/products/variants/skus?businessId={{business_id}}&sku=10&size=250&count=false","protocol":"https","host":["api","channelape","com"],"path":["v1","products","variants","skus"],"query":[{"key":"businessId","value":"{{business_id}}"},{"key":"sku","value":"10"},{"key":"size","value":"250"},{"key":"count","value":"false"}]},"description":"Query SKUs for a business. Could be used to find SKUs given a partial match. Only returns a single matched variant even if more variants with that same SKU exist.\n\nRequired query parameters\n---\n\n__businessId__ - ID of ChannelApe business\n\nOptional query parameters\n---\n\n__sku__ - Entire or beginning characters of the SKU you wish to find in this business.\n\n__size__ - Integer between 1 and 250 (defaults to 10). Maximum number of results to return.\n\n__count__ - Boolean values of true or false (defaults to false). Should query return count of all matched results."},"response":[],"_postman_id":"53c29882-878c-4c6a-9a92-c509f09b730c"},{"name":"Search Variants by UPC","id":"df646dec-41fb-40d6-b6e1-fe7a5d614001","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.channelape.com/v1/products/variants/upcs?businessId={{business_id}}&upc=10&size=250&count=false","protocol":"https","host":["api","channelape","com"],"path":["v1","products","variants","upcs"],"query":[{"key":"businessId","value":"{{business_id}}"},{"key":"upc","value":"10"},{"key":"size","value":"250"},{"key":"count","value":"false"}]},"description":"Query UPCs for a business. Could be used to find UPCs given a partial match. Only returns a single matched variant even if more variants with that same UPC exist.\n\nRequired query parameters\n---\n\n__businessId__ - ID of ChannelApe business\n\nOptional query parameters\n---\n\n__upc__ - Entire or beginning characters of the UPC you wish to find in this business.\n\n__size__ - Integer between 1 and 250 (defaults to 10). Maximum number of results to return.\n\n__count__ - Boolean values of true or false (defaults to false). Should query return count of all matched results."},"response":[],"_postman_id":"df646dec-41fb-40d6-b6e1-fe7a5d614001"},{"name":"Search Variants by tag","id":"a2d2cc53-4155-41a0-b64d-78cf4693f937","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{session_id}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.channelape.com/v1/products/variants/tags?businessId={{business_id}}&tag=Win&size=250&count=false","protocol":"https","host":["api","channelape","com"],"path":["v1","products","variants","tags"],"query":[{"key":"businessId","value":"{{business_id}}"},{"key":"tag","value":"Win"},{"key":"size","value":"250"},{"key":"count","value":"false"}]},"description":"Query tags for a business. Could be used to find tags given a partial match. Only returns a single matched variant even if more variants with that same tag exist.\n\nRequired query parameters\n---\n\n__businessId__ - ID of ChannelApe business\n\nOptional query parameters\n---\n\n__tag__ - Entire or beginning characters of the tag you wish to find in this business.\n\n__size__ - Integer between 1 and 250 (defaults to 10). Maximum number of results to return.\n\n__count__ - Boolean values of true or false (defaults to false). Should query return count of all matched results."},"response":[],"_postman_id":"a2d2cc53-4155-41a0-b64d-78cf4693f937"}],"id":"3954a0e7-367f-437d-94f2-730cc3db716f","_postman_id":"3954a0e7-367f-437d-94f2-730cc3db716f"},{"name":"Search Fields","item":[{"name":"Create Search Field","id":"ea4464da-e3ef-47d2-923e-a786508b8c99","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{sessionId}}"}],"body":{"mode":"raw","raw":"{\n  \"label\":\"Color\",\n  \"prefix\": \"color_\",\n  \"ordinal\": 3\n}"},"url":"https://api.channelape.com/v1/businesses/{{business_id}}/searchfields","description":"Create a search field for a business, that are used for searching. Label and prefix must be unique to a business.\n\nRequired Fields\n---\n__label__ - Label that will render next to the input box on the search page.\n\n__prefix__ - The prefix of tags to search for.\n\nOptional Fields\n---\n__ordinal__ - Controls the rendering order of search fields on the search page."},"response":[],"_postman_id":"ea4464da-e3ef-47d2-923e-a786508b8c99"},{"name":"Get Businesses Search Fields","id":"d56bb127-e455-4534-85d3-6537f66fbb22","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{sessionId}}"}],"body":{"mode":"raw","raw":"{\n  \"label\":\"Test Label637\",\n  \"prefix\": \"test_label367\",\n  \"ordinal\": 3\n}"},"url":"https://api.channelape.com/v1/businesses/{{business_id}}/searchfields","description":"Retrieves all search fields for a given business."},"response":[],"_postman_id":"d56bb127-e455-4534-85d3-6537f66fbb22"},{"name":"Get Search Field","id":"a6218a56-b4e4-4dc2-8a0b-519e722449d0","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{sessionId}}"}],"body":{"mode":"raw","raw":"{\n  \"label\":\"Test Label637\",\n  \"prefix\": \"test_label367\",\n  \"ordinal\": 3\n}"},"url":"https://api.channelape.com/v1/businesses/{{business_id}}/searchfields/2","description":"Retrieves label, prefix, and ordinal of a given search field."},"response":[],"_postman_id":"a6218a56-b4e4-4dc2-8a0b-519e722449d0"},{"name":"Delete Search Field","id":"b0de4003-c70a-411f-b8e7-43ca99efa4c2","request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{sessionId}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.channelape.com/v1/businesses/{{business_id}}/searchfields/2","description":"Deletes a search field and moves ordinals of existing search fields to fill the gap of the removed field."},"response":[],"_postman_id":"b0de4003-c70a-411f-b8e7-43ca99efa4c2"},{"name":"Update Search Field","id":"3a49bf56-b967-41fd-b104-8ea5cb6eef26","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Channel-Ape-Authorization-Token","value":"{{sessionId}}"}],"body":{"mode":"raw","raw":"{\n\t\"label\": \"Color\",\n    \"prefix\": \"color_\",\n\t\"ordinal\": 3\n}"},"url":"https://api.channelape.com/v1/businesses/{{business_id}}/searchfields/2","description":"Update Search field at a given ordinal. The ordinal in the path is the existing ordinal and the ordinal in the body indicates an ordinal move if any. The label and prefix must be unique to a business.\n\nRequired Fields\n---\n__label__ - Label that will render next to the input box on the search page.\n\n__prefix__ - The prefix of tags to search for.\n\n\nOptional Fields\n---\n__ordinal__ - Controls the rendering order of search fields on the search page.\n\n"},"response":[],"_postman_id":"3a49bf56-b967-41fd-b104-8ea5cb6eef26"}],"id":"aee940b5-7680-41d7-b609-5b9401359faf","description":"Search Fields are used in channelape to render custom fields on the search page to provide a customized search experience for business users. The label is rendered next to a search box that will autocomplete for any variants that have tags that start with the prefix and the user input.","_postman_id":"aee940b5-7680-41d7-b609-5b9401359faf"}]}