Introduction
This article aims to provide a high-level overview of what to expect from the Company Store API functionality. If you are in the process of setting up a new API, please note that this article may not offer the level of detail you need. In such cases, we recommend referring to either our API Set-Up Help Center Article or our Comprehensive API Documentation for more specific guidance and information.
The Company Store application is equipped with robust API capabilities. One major benefit of our APIs is their bidirectional functionality, allowing you to set up APIs that enable other systems to read information, write data, or perform both actions.
At OMG, we have been consulting with clients who are new to API configuration for years. A common challenge we’ve observed among these clients is their difficulty in determining whether their intended objectives are achievable using our API functionality.
To simplify this process and help visualize the capabilities for our clients, we have provided the information below. We have categorized the majority of the data that can be transferred via our API into three sections:
- Product Data
- User Data
- Order Data
For each section, we have indicated whether each data point can be transferred to another system, updated by another system, or created by another system.
Please keep in mind that this resource serves as a high-level overview to address some of the fundamental questions regarding what our API can and cannot do. There are additional values that can be utilized in our APIs that are not included in this list. For a complete breakdown of all possible fields, as well as detailed instructions on how to set everything up, please refer to our API documentation and Help Center articles.
Product Data
Data |
Transferable (Shown) |
Creatable |
Updatable |
Product Name |
✔ |
✔ |
✔ |
SKU & SKU Separator |
✔ |
✔ |
✔ |
Internal ID |
✔ |
✔ |
✔ |
Origin Address ID |
✔ |
✔ |
✔ |
Base Price, Retail Price, and Cost |
✔ |
✔ |
✔ |
Setup Charge |
✔ |
✔ |
✔ |
Minimum and Maximum Order Quantity |
✔ |
✔ |
✔ |
Product Dimensions |
✔ |
✔ |
✔ |
Shipping Modifier |
✔ |
✔ |
✔ |
Title |
✔ |
✔ |
✔ |
Description |
✔ |
✔ |
✔ |
Keywords |
✔ |
✔ |
✔ |
Custom URL |
✔ |
✔ |
✔ |
Description |
✔ |
✔ |
✔ |
Product Images |
✔ |
✔ |
✔ |
Active & Featured Status |
✔ |
✔ |
✔ |
Tax & Shipping Exempt |
✔ |
✔ |
✔ |
Categories |
✔ |
✔ |
✔ |
Vendors |
✔ |
✔ |
✔ |
Options & Sub Options |
✔ |
✔ |
✔ |
New Product Trigger |
✔ |
✔ |
✔ |
New Product Expiration Date |
✔ |
✔ |
✔ |
Inventories |
✔ |
✔ |
✔ |
Enable Quantity Discount |
✔ |
✔ |
✔ |
Related Products Type |
✔ |
✔ |
✔ |
Enable Related Products |
✔ |
✔ |
✔ |
Enable Product Personalization |
✔ |
✔ |
✔ |
Enable Inventory |
✔ |
✔ |
✔ |
Enable Logo Locations |
✔ |
✔ |
✔ |
Primary Category ID |
✔ |
✔ |
✔ |
Vendor Inventory Enabled |
✔ |
✔ |
✔ |
Inventory Vendor ID |
✔ |
✔ |
✔ |
Tax Code |
✔ |
✔ |
✔ |
Note |
✔ |
✔ |
✔ |
Created and Updated At |
✔ |
✘ |
✘ |
Vendor Inventory Enabled |
✔ |
✔ |
✔ |
Inventory Vendor ID |
✔ |
✔ |
✔ |
Tax Code |
✔ |
✔ |
✔ |
Note |
✔ |
✔ |
✔ |
Created and Updated At |
✔ |
✘ |
✘ |
Order Data
Data |
Transferable (Shown) |
Creatable |
Updatable |
Order ID |
✔ |
✘ |
✘ |
Created and Updated Date |
✔ |
✘ |
✘ |
Status |
✔ |
✘ |
✔ |
Site ID |
✔ |
✘ |
✘ |
Site Name and URL |
✔ |
✘ |
✘ |
Custom Store ID |
✔ |
✘ |
✘ |
Organization Name |
✔ |
✘ |
✘ |
Organization ID |
✔ |
✘ |
✘ |
Custom Data Collections |
✔ |
✘ |
✘ |
Customer Email |
✔ |
✘ |
✘ |
Customer ID |
✘ |
✘ |
✘ |
Username |
✔ |
✘ |
✘ |
Item Total |
✔ |
✘ |
✘ |
Grand Total |
✔ |
✘ |
✘ |
Shipping Contact & Address |
✔ |
✘ |
✔ |
Billing Contact & Address |
✔ |
✘ |
✔ |
Payment Info |
✔ |
✘ |
✘ |
Line Items |
✔ |
✘ |
✘ |
Vendors |
✔ |
✘ |
✘ |
Logos |
✔ |
✘ |
✘ |
Gift Certificate Information |
✔ |
✘ |
✘ |
Coupon & Balance Adjustments |
✔ |
✘ |
✘ |
Shipping Method & Tracking Number |
✔ |
✔ |
✔ |
Shipment Date & Note |
✔ |
✔ |
✔ |
User Data
Data |
Transferable(Shown) |
Creatable |
Updatable |
User ID |
✔ |
✘ |
✘ |
Username |
✔ |
✔ |
✔ |
First & Last Name |
✔ |
✔ |
✔ |
Active Status |
✔ |
✔ |
✔ |
Confirmed Status |
✔ |
✘ |
✘ |
Email |
✔ |
✔ |
✔ |
Timezone |
✔ |
✔ |
✔ |
Phone |
✔ |
✔ |
✔ |
Company |
✔ |
✔ |
✔ |
Title |
✔ |
✔ |
✔ |
Groups |
✔ |
✔ |
✔ |
Balance |
✔ |
✔ |
✔ |
Balance Note |
✘ |
✔ |
✔ |
Password |
✘ |
✔ |
✔ |
Enable SMS Notifications |
✔ |
✔ |
✔ |
Don’t Send Confirmation Email |
✘ |
✔ |
✘ |
Avalara Tax Exemption Reason |
✔ |
✔ |
✔ |
Custom User Fields |
✘ |
✔ |
✔ |
Manager Order Approval Email & SMS |
✔ |
✔ |
✔ |
User Note |
✔ |
✔ |
✔ |
User Addresses |
✔ |
✔ |
✔ |
Comments
0 comments
Please sign in to leave a comment.