Child pages

Rest API questions

https://developer.channeladvisor.com/frequently-asked-questions

Machine readable

https://api.channeladvisor.com/v1/$metadata

OAuth - explained - end points - available scopes

https://developer.channeladvisor.com/authorization/introduction-to-oauth-2-0#IntroductiontoOAuth2.0-AvailableAuthorizationScopes

Products

https://developer.channeladvisor.com/working-with-products/product-uploads/submit-a-bulk-product-upload

Product Quantity

https://developer.channeladvisor.com/working-with-products/quantity

Products - https://developer.channeladvisor.com/working-with-products

...

...

Outline the process of creating products (as a general concept): see https://developer.channeladvisor.com/working-with-products/product-endpoints

The Product Creation and Update process usually flows something like this with REST API.

1. Client provides new SKU data to the system at will.
2. Some pre-requisites may need to be in place depending on design of the client products:
   1. Variation Names/Types
   2. Distribution Centers - ie when an order will be fulfilled by a marketplace store of products
3. During creation of SKUs, apply all known product attributes within the same product creation request for ease of use - otherwise individual attribute requests are required to append new attributes.
4. Apply Quantity information to products.

5. Once a product has been created, these are the options going forward:

   CREATE Bundles	The products now need to be applied to Bundles for sale.
   UPDATE Field Data	Data needs to be adjusted added for an existing product in an existing field
   ADD More Data	Data needs to be added to an existing product in an existing field, or a new field and data needs to be added for a product
   DELETE Individual Data	A data point needs to be cleared of the existing values, leaving a blank
   DELETE the Entire Product	Remove a product from the system because it is no longer active
   UPLOAD Product Data	Same as ADD and UPDATE, but executed in bulk
   EXPORT Product Data	Extract data in bulk

   About Export Status

   • To retrieve only orders that haven't already been marked as exported by the Developer Key and Application ID combination being used.

   • This is a good way to ensure order imports are not duplicated.
   • See more on all the options for filtering, querying, expanding data under the Getting and Filtering Data page

   Considerations

   • Default export status value is 'false'.
   • Export status is set by each Developer Key and Integration Application ID and can be set and removed at will through the API.
   • The Application ID is unique by the Integration created in the Developer Console, so plan to mark orders as exported and retrieve orders from the same Integration to ensure the goal of avoiding retrieving already imported orders. 
   • Export status is not viewable in the system user interface and is not a field on an item through the API.
   • To test Export status on orders previously marked as exported=true, place a GET Orders request to retrieve orders without defining a specific Order ID. The orders marked as Exported should not be in the response.
   • Retrieving a specific order ID will always ignore the status, so this is not a valid way to test if Exported status has been set.

Complete Product Entity Table

This table is a single view of all related Product entities that may exist for a product, including definitions for collections, and whether or not to expect to see a property populated.

Important Notes:

• When a field is Always Populated = "No" or "Conditional No", expect a null or "" (blank) value, but cases where Data Source contains "Marketplace", a value may be provided.
• A product cannot exist concurrently as a Parent, Child, Standalone, AND Bundle, so the collection properties for Children and BundleComponents will only be available when a product is respectively a Parent/Child or Bundle. 

1. Resource URL / Endpoint

   GET https://api.channeladvisor.com/v1/Orders?exported=false
   GET https://api.channeladvisor.com/v1/Orders?exported=true
   POST https://api.channeladvisor.com/v1/Orders(OrderID)/Export
   DELETE https://api.channeladvisor.com/v1/Orders(OrderID)/Export 

   Required Parameters (for GET)

   Property	Required	Note
   exported	Required	Include in URL. Query value will be true or false. Note: there is no dollar sign ($) before this parameter.

   Required Parameters (for POST and DELETE)

   Property	Required	Note
   OrderID	Required	Include in URL. The ChannelAdvisor generated unique identifier for the Order. Cannot be substituted with Marketplace Order ID.

   Export Status Request Examples

   
   

   • Retrieving Non-Exported Orders
   • Marking Orders as Exported
   • Marking an Order as Not Exported