Jump to Content
Zoey SupportGuidesAPI DocsLatest NewsStatusCreate Support RequestReturn to zoey.com
HomeGuides
GuidesAPI DocsLatest NewsStatusCreate Support RequestReturn to zoey.comZoey Support
Guides
REST API

Overview

  • Welcome To Zoey Support!
    • Browser Compatibility
    • GDPR Compliance
    • SSL SNI Requirements
    • Site-wide HTTPS
  • Support Holidays

My Subscription

  • Two Factor Authentication
  • Swap Account (Store) Owner
  • Update Billing Information
  • Switching Businesses (Stores)
  • Manage Your Team (Sales People / Admin Users)
  • Change Store Name (internally)
  • Link Your Domain
    • Link Your Subdomain
    • Using 3rd Party Proxy or Cloudflare
    • Adding A Domain Alias
    • SPF: Emails Not Going to SPAM

Data Import

  • CSV File Import
  • CSV Troubleshooting
    • Changing Your Excel CSV Delimiter
  • CSV Import How-Tos
    • Accounts - Importing Accounts & Contacts
    • Importing Categories
    • Category Product Sort Order Import
    • Deleting Attribute Values
    • Downloadable Products Import Template
    • Gift Card Codes Import
    • Global Translations Import
    • Image ALT Tag (For SEO) Import
    • Order Import
      • Order Attribute Update Import
    • Order State/Status Update Import
    • Product Attachments Import
    • Product Image Import
    • Sales Rep Assignments Import
    • Shipment & Tracking Number Import
    • SKU Replacement Import
    • Tax Rates Import
    • Uploading Image Files
    • URL Rewrite - 301 Redirect Import
  • Import Troubleshooting
    • Error: Column Names Have Duplicates
    • Error: Invalid Value For 'tax_class_id'
    • Error: Product Type Is Invalid Or Not Supported
    • Error: Skip import row, is not valid value "" for field "type"
  • Product CSV Fields & Values
    • How to Disable Products
  • Zoey EDI
  • Exporting Data

Integrations

  • Connecting to the Zoey API with Postman
  • Faire Integration
  • Data Mapper Integrations
    • Fishbowl - Data Mapper Integration
    • SOS Inventory - Data Mapper Integration
    • Data Mapper Examples
      • Full Order Data Export Data Mapper
      • Invoices Data Mapper Export
      • Shipments Data Mapper
      • Products Data Mappers
      • Account Address Data Mappers
      • Transactions Import: Payments & Deposits
      • Transactions Export Data Mapper
      • Order Import Data Mapper
    • Values for Data Mappers
    • Formulas in your Data Mapper
    • Data Mapper Troubleshooting
    • Data Mapper Audit Log
  • Google Sheets Importer
    • Step 1: Connect your Google Account and Create Import
    • Step 2: Mapping and Scheduling Google Sheet Import
  • NetSuite
    • Step 1: Prepare your Zoey Data
    • Step 2: Set up a NetSuite API User for Zoey
    • Step 3: Create Integration in NetSuite
    • Step 4: Set up the Zoey Integration Configuration Page In Zoey
    • Customers - Importing & Exporting with NetSuite
      • Saved Search - Importing NetSuite Customers
    • Products - Import from NetSuite
    • Sales Orders - Importing & Exporting with NetSuite
    • Invoices, Shipments, and Payments - Importing & Exporting with NetSuite
    • Mapping Currencies, Payments, and Shipments with NetSuite
    • Order History
    • Record Caching
    • NetSuite Error Log and Troubleshooting
      • Error: You do not have permission to set a value for element. Permission Errors with sending Zoey Orders to NetSuite
      • Error: Saved Search not Syncing
      • Error: INVALID_KEY_OR_REF WARNING WARNING
      • ShipperHQ and NetSuite Shipping Method Mapping
  • QuickBooks Online
    • Step 1: Install the QuickBooks Integration App on Zoey
    • Step 2: Connect to QuickBooks
    • Step 3: QuickBooks Online Integration Settings
      • Step 3a. QuickBooks UK - VAT Setup
    • Syncing Customers and Products
    • Syncing Payments
    • Syncing Refunds
    • Manually Sync Invoices and Payments to QuickBooks
    • QuickBooks Online Error Logging
      • Error: Required param missing, need to supply the required value for the API
      • Error: Link Orders on Duplicate Document Number Error
      • Error: Invalid Reference Id : Categories cannot be used in transactions.
      • Error: Invalid Reference Id : Names element id 0 not found
      • Error: Failed to create QuickBooks invoice for Order due to missing items.
      • Error: Duplicate Name Exists Error
      • Error: Cannot Change Who Customer Bills With Error
      • Payment Review: Invoice not Synced to QuickBooks Online
      • An application error has occurred while processing your request
    • QuickBooks Online FAQs
  • ShipStation
    • Install the ShipStation Integration
    • ShipStation Integration Settings
      • ShipStation REST API Settings
      • Shipping Rates from ShipStation
    • Configuring ShipStation Order Statuses
      • ShipStation Split Shipments

Products

  • Products Overview
  • Creating Products - Product Types
    • Bundled Product
    • Configurable Product
      • Configurable Products Additional Settings
    • Downloadable Product
    • Gift Card
    • Grouped Product
    • Simple Product
    • Variation Product (Invisible Simple Product)
    • Virtual Product
  • Comparing Products
  • Gift Cards
  • Products List
    • Bulk Editing Products
    • Columns In The Product List
    • Editing Inventory From The Product List
    • Search And Advanced Product Search
    • Tabs On The Product List
  • Advanced Product Pricing Structures
    • Configurable Product Advanced Pricing
    • Customer Group Pricing
    • Minimum Advertised Price (MAP)
    • Price Suffix
    • Tier Pricing
    • Tier Pricing Groups
    • Account Specific Product Prices
  • Custom Attributes
    • Delete Attribute Values
    • Filter By Custom Attribute
    • Manage Attributes (Product > Attributes)
    • Search By Custom Attribute
    • Sort By Custom Attribute
    • Product Video Attribute
  • Customizations
    • All Customization Settings
    • Editing Customizations
    • Copy Customizations From One Product To Others
    • Multi-Column Layouts for Customizations
    • One Time Charge Per Product for Customization
    • Weight for Customizations
  • Multiple Product Templates
    • Switching Themes With Multiple Product Templates
  • Inventory & Shipping
    • Product Backorders
    • Minimum / Maximum Quantity Allowed
    • Minimum Quantity Groups
    • Quantity Increments, Packaging and Decimal Quantity
    • Configurable, Bundle And Grouped Product Inventory
    • Default Qty Value
    • Inventory Locations
  • Linking Simple Products to Configurable Products as Variations
  • Placeholder Image for Products
  • Product Image Recommendations
  • Product Settings
    • Controlling Product Visibility
    • Inventory Management
    • Catalog Settings
    • Swatches
    • Search Settings
    • Downloadable Product Options
    • Product Image Paths Export
    • Configurable Product Table Order Interface
    • Bulk Update Make Products Taxable
    • Product Access Restriction
    • Duplicating a Product
    • Ordered Product Notification Emails
    • Previously Ordered Product Notification
  • Related Products, Up-sell Products, Cross-sell Products
  • Quick Order Forms
    • Quick Order Form by Unique Product Lookup
  • Reviews & Ratings
  • Search Engine Optimization (SEO)
  • File Manager
  • Product Attachments
    • Adding Attachments To Product Template
  • Product Page Variables for Javascript
  • Status Flags (New, Sale)
  • Showing Attributes from Variations
  • Product Alerts
  • Reserved Products
  • Product Audit Log

Categories

  • Creating Categories
    • Category Images
  • Creating Sub-Categories (Child Categories)
  • Creating A Redirect for A Category
  • Editing Search Engine Information For Categories
  • Managing Products in Categories through CSV
  • Manage Products In Categories - Adding & Organizing
    • Bulk Assign Products To Category
    • Sorting Products In Categories With Product Attributes
  • Multiple Category Templates
  • Number Of Products Per Page
  • Parent Categories Not Showing Products
  • Products Not Visible In A Category
  • Terminology For Categories
  • Category Page Variables for Javascript
  • Category Table View

Accounts & Customers

  • Accounts
    • Account Roles & Permissions
      • Creating a Contact Role for Account Locations
      • Creating a Billing/Accounting Role
    • Customer Registration Form
    • Account Switching
    • Order Approval
    • Registration Approval
    • Emails Sent to Contacts
    • Account Notes
    • Account List Tabs
  • Add Products to Customer's Cart
  • Changing a Contact Role and Permissions
  • Cookie Law Banner
  • Customer Attributes
    • Editing Account Attributes via Export & Import
    • Matrix (Table) Attribute
  • Customer Groups
    • Uses of Customer Groups
    • Automatic Customer Group Assignment by VAT
  • Customer Web Settings
  • Emails and Notifications
    • Multiple Email Recipients When Placing an Order
    • Adding Internal Recipients to Email Notifications
    • Adding Recipients to an Email
    • How to Disable an Email
    • Editing Email Templates
    • How to resend the Invite Email
  • Group Price List
  • Managing Contacts and Addresses in the Customer Portal
  • Managing Ship Tos in the Admin
  • Manually Creating an Account
  • Prevent Spam - reCAPTCHA
  • Registration Pending Approval
  • How to Merge Accounts
  • Terms & Conditions for Customer Registration
  • Deactivating an Account

Quotes

  • About Quotes
  • How Customers use Quotes
    • Submitting A Quote
    • Quote Approval
    • Editing A Quote
    • Add to Cart / Add to Quote Button
  • Setting Up Quotes
    • Adding Quote Mini-Cart to the Header
    • Quote Access Restriction
    • Quote Customer Permissions
    • Quote Creation Settings
    • Quote Management Settings
    • Quote IDs
    • Quote Attributes
  • Admin Quote Creation
  • Admin Quote Management
    • Quote Change Request
    • Quote Custom Shipping Rate
    • Quote Expiration & Reminders
    • Quote Items (Products) Editing
    • Quote Individual Product Settings
    • Quote PDFs
    • Quote Statuses
  • Converting Quote To Order
  • Quote Import/Export
  • New Quote Email Template

Drafts

  • About Drafts
    • Drafts in the Web Admin
    • Drafts in the Customer Portal
    • Drafts in the Mobile App

Sales Rep

  • About Sales Rep
  • Adding Sales Reps
  • Default Sales Reps
  • Editing and Tagging Sales Reps
  • Viewing and Exporting Sales Rep Data

Orders

  • How to Process Orders - Order Lifecycle
    • Overview of Order Terminology
      • Suspected Fraud Status
    • Creating an Order from the Admin
    • Canceling an Order
    • Canceling Items on an Order
    • Invoicing your Orders
      • Creating Additional Invoices
      • Customer Invoice Grid - My Invoices
    • Collecting Deposit Payments
      • Payment Terms: Deposit Automation
      • Request Deposit for Specific Products Automatically
    • Paying an Invoice
      • Voiding an Invoice
    • Refunding a Payment
    • Issuing a Credit Memo
    • Transaction Totals Explained - FAQ
    • Custom Order Statuses
    • Deleting an Order
    • Editing an Order
    • Editing an Invoice
    • Credit Card Authorization (Stripe & Authorize.net)
    • Shipping your Orders
      • Shipping Cost for Shipments
      • Voiding a Shipment
    • Partial Payments, Deposits, and Refunds
      • Invoicing your Orders
      • Syncing Payments (OMS v7)
  • Order Grid Features
    • Shipments, Invoices, and Transactions Grids
    • Archiving Orders
    • Bulk Changing Status
    • Order Filters (Advanced Search)
    • Order Grid Tabs
    • Order Status Colors
    • Viewed Orders
    • Partially Paid & Partially Shipped Orders
    • Customer Order Grid - My Orders
  • Order Attributes
    • Order Delivery Date / Delivery Day Validation
  • Store Credit
  • Customize PDFs (Invoice, Packing Slip, Credit Memo)
    • PDF Templates
    • Adding custom CSS to your PDFs - PDF Styles
    • How to make Invoice PDF fit in a Windowed Envelope
  • Order Settings - General
  • Checkout Terms & Conditions (Agreements)
  • Gift Messages
  • How Order and Invoice Totals are Calculated
  • Minimum Order Amount
  • Multiple Ship-To Address Orders
  • Order Comments
  • Order, Invoice, Credit Memo & Shipment Numbers
  • Order Variables Accessible on Order Success Page
  • Printing Orders & Statements
  • Printing Packing Slips
  • Recurring Orders
  • Share Shopping Cart
  • Shipping & Payment Method Restrictions
  • Split Orders (Split Products Into Different Orders)
  • Shopping Cart Settings
  • Pick Lists
  • Incremental Order Numbers
  • Shipment Tracking
  • Order Automation Rules

Payments

  • 3D Secure CC Validation
  • Authorize.net
    • Authorize.Net Error: Transaction Not Accepted or Generating Authorize.net Transaction Key
    • Authorize.Net Error: Gateway Error (TESTMODE) The transaction amount submitted was greater than the maximum amount allowed
  • Bank Transfers
  • Invoicing Automation
  • Cash On Delivery
  • Check / Money Orders
  • Net Terms
  • PayPal Express Checkout
    • PayPal Payments Pro
    • Connecting PayPal To Authorize.net
    • Troubleshooting PayPal
    • Require phone numbers for PayPal Express Checkout orders
  • Purchase Orders
  • Saved Cards
  • Send Invoice
  • Stripe
    • Stripe ACH
      • Stripe ACH - Saved Accounts
      • Troubleshooting Stripe Webhooks
    • Stripe EU
  • Zero Subtotal Checkout

Shipping

  • Pacejet
  • FedEx (Federal Express)
  • Flat Rate Shipping
  • Free Shipping
    • Free Shipping Based on Order Subtotal
    • Free Shipping For Customer Groups
    • Free Shipping For Specific Products
    • Limit Free Shipping By State/Region
    • Free Shipping with a Promo Code
  • Matrix Rates
    • Advanced Matrix Rates
    • Product Matrix Rates
  • Setting up Free Shipping
  • Shipping & Tax Estimate
  • Table Rate Shipping
    • Country Codes
    • US/State Codes
  • United Parcel Service (UPS)
  • USPS (United States Postal Service)
  • Shipping Weight Calculation for Configurable Products

Design

  • Help Designing your Store
  • Theme Design FAQs
  • Themes
    • Editing an Unpublished Theme
    • Publishing and Un-Publishing Themes
    • Preview Theme / View Store
    • Manage Assets: CSS, JavaScript, HTML Editor
    • Theme Visibility By Customer Group
    • Multi-User Editing of Different Pages
    • Private Site Login Screen - CSS for Dark Mode
  • Pages
    • All Page/Template Types
    • Blog Pages
    • Creating a New Page
    • Creating A Multi-Column Layout
    • Creating an Order Form by Category
    • Information Page Access Restriction
    • Layout Settings
    • My Account Pages
    • Order Success Page
    • Page Settings
    • Pages You Can/Can't Change
    • Products & Category Templates
    • Save Draft, Save, Publish and Unpublish
    • URLs & SEO
    • View Templates As
    • Contact Us Form
  • How do I edit my store Footer?
    • Suggested Footer Links
  • Blocks (The + Add Menu)
    • Banners
    • Blog
    • Box
    • Box (Locked)
    • Buttons
    • Category Blocks
    • Category Lists (Menus)
    • Category: Subcategory Lists
    • FAQ / Accordion
    • HTML Block
    • Images
    • Product Attribute Blocks
    • Product Essentials
    • Product Lists
    • Slideshows
    • Social Media Icons
    • Text Blocks
    • Video Banner
  • How To Articles
    • Add Information To Shopping Cart, Checkout and Quote Cart/Submit
    • Add Newsletter to Checkout
    • Adding an "Ordered Items Page" Link
    • Adding Quantity Available to Product Page
    • Anchor Tags
    • Click To Enlarge Product Images
    • Converting To A New Header
    • Customizing Links In The Header Navigation with CSS
    • Dark Theme
    • Enable Category Products Infinite Scroll
    • Enable Search Results Infinite Scroll
    • Product List from Categories
    • Setting Featured And New Products
    • Using the Mega Menu Header
    • Image Sizes
    • Adding A Pop-Up To Your Storefront
    • How to Hide Drafts in your Store
    • Adding a Mobile Only Image to Slideshow
    • Creating a Custom Order Form Page
    • Sort Attribute Values for Store Filters
    • How to show custom message to specific Customer Group
  • Theme Fonts, Colors, and Styles
  • CMS - Content Editor
  • Desktop, Tablet & Mobile
  • Multi-Language Design
  • For Developers
  • Min Height Set
  • Mobile Design
    • Mobile Header
  • Header Navigation Links
    • Header Navigation FAQs

Taxes

  • Getting Started
  • Tax Rates
  • Setting up Tax Classes
  • Creating Tax Rules
  • Apply Tax on Shipping
  • Setting up VAT
  • VAT Verification
  • Troubleshooting Taxes

Sales & Discounts

  • Catalog Sales and Discounts
    • Discount Rules
      • Discount Conditions
    • Sale Price Rules
    • Tier (Step) Pricing
    • Promotions FAQs
  • Creating a Catalog Sale Rule
  • Common Discount Rules
    • Auto-Add Product To Cart
    • Bottle and Can Deposit/CRV: Auto-Add Product to Cart (Matching QTY)
    • Product Surcharge (Tariff): Auto-Add Product to Cart (Matching QTY)
    • Buy X, Get Y free (different SKU)
    • Buy X Amount, Get % Off
    • Buy X Get Y Free (same SKU)
    • Customer Group Discount
    • Discount by Account Attribute
    • Discount Cart Based on Cart Total
    • Discount for Specific Customer or Account
    • Discount Highest Price Item
    • Discount Shipping Only
    • Free Shipping
    • Give X $ or % Off
    • Product Attribute Discount
    • Quantity Discount by Category
    • Single-Use Discount for New Customers
    • Stop Free Shipping with Discount
    • Using Multiple Discount Rules to create Tiered Discounts

Language and Currency

  • Currency (changing or adding)
  • Languages (changing or adding)
    • Available Languages for Store Views
    • Change Default & Control Panel Language
  • Limit Customer Groups to Specific Languages and Currencies
  • Locale Settings
    • States and Regions
    • Store Scope
  • Multi-Language SEO
    • Locale Values for hreflang tag
    • X-Default with Hreflang
  • Translating Your Store
    • Translating Any Text in your Store
    • Translating Your Categories
    • Translating Categories via Import
    • Translating Your Checkout
    • Translating Your Cookie Notice
    • Translating Your Design
    • Translating Global Elements
    • Translating Your Login / Create Account / Forgot Password / Empty Cart Pages
    • Translating Your Products
    • Translating ReCaptcha
    • Translating Your Product Images
    • Translating Tier Pricing
    • Translating Your Search Results Page
    • Translating Quotes
    • Translating Drafts
    • Translating Net Terms Details

SEO

  • 301 Redirects
  • Meta Data
  • MicroData (Structured Data, Schema.org)
  • SEO Best Practices Overview
  • Setting Up Your Sitemap
  • URLs End Numbers
  • URL Redirects
    • Deleting URL Rewrites
  • Creating Custom URLs
  • Image Alt and Title Tags
  • SEO FAQ
  • OG Tags: Facebook Open Graph MetaTags
  • Google Mobile Usability Issues Detected

Blog

  • Creating Your Blog
  • Managing Your Blog
  • Common Troubleshooting Steps
  • Search Blog Content

Analytics & Reports

  • Google Apps
    • Google Analytics
    • Google Advanced / Enhanced Ecommerce Analytics
    • Google Adwords Conversion Tracking
    • Google Dynamic Remarketing Conversion Tracking
    • Google Search Console
    • Google Tag Manager
    • Google Customer Reviews
    • Stop Payment Solution from Being Referral Source
    • Verify Site Ownership for Google
  • Reports - Overview
    • Transaction Reports
    • Customizable Reports - Export Current Grid
    • Incomplete Reports - Refresh Statistics
    • Accounts Receivable Report
    • Accounts by Orders Total
    • Orders Report
    • Tax Report
    • Shipping Report
    • Credit Memo Report
    • Coupons Report
    • Find Customers by SKU
    • Products in Carts
    • Bestsellers
    • Products Ordered
    • New Accounts
    • Customers by Orders Total
    • Customers Reviews
    • Products Reviews
    • Ordered Items Summary
    • Forecasting Report
  • Bing Ads Conversion Tracking

Apps

  • Adding Apps to your Store
  • App Requests
  • AfterShip
  • AgeVerify
  • Avalara AvaTax for Zoey
    • AvaTax Logs and Troubleshooting
  • Avalara CertCapture for Zoey
  • Cookie-script.com
  • eWay Rapid 3.1 (v1.4.1)
  • Facebook Login
  • Facebook Tracking Pixel and Conversion Code
  • GDPR App
  • GoDataFeed
  • Google Address Autocomplete
  • Jotform - Create Your Own Form
  • LiveChat
  • MailChimp for Zoey
  • M2E
    • Enabling M2E
  • Nosto
  • Olark Live Chat
  • OrderCup
  • Ordoro
  • Pinterest Rich Pins
  • Shiptheory
  • ShipWorks
  • SKU Vault
  • StitchLabs
  • Store Locator (Stockist.co)
  • Yotpo
  • Webgility / ECC / QuickBooks
  • XPS Ship
  • ShipperHQ
    • Dimensional Packaging
    • ShipperHQ Import Template
    • ShipperHQ - No Shipment Methods Available
    • ShipperHQ Advanced Sync Troubleshooting

Abandoned Cart

  • Abandoned Cart Recovery

Google Shopping Feed

  • About the Google Shopping Feed App
  • Getting Started with Google Shopping
  • Google Shopping Feed Taxonomies
  • Set Up Tax and Shipping in the Google Shopping Feed
  • Testing & Generating the Google Shopping Feed
  • Submitting your Google Shopping feed to Google
  • Running AdWords Shopping Campaigns with the Google Shopping Feed
  • Feed Settings for Google Shopping
    • File Settings > Google Shopping App
    • Columns Map > Google Shopping
    • Directives > Columns Map > Google Shopping
    • Product Filters > Google Shopping
    • Configurable Product > Google Shopping
    • Group Product > Google Shopping
    • Bundle Product > Google Shopping
    • Shipping > Google Shopping
    • Different Currencies for Feed - Google Shopping
  • Google Shopping Import Fields

How To

  • Customer Access Restriction (Private Site)
  • Re-Indexing Your Store
    • ERROR: Cannot Initialize the Indexer Process
  • Enabling Maintenance Mode
  • Catalog Access Restrictions
    • Product Access Restriction
      • How to restrict an Account to specific list of Products
    • Category Access Restriction
  • Restricting Language and Currencies to Customer Groups

Sales Portal Theme

  • B2B Sales Portal Theme
    • Installing the B2B Sales Portal Theme
    • Editing B2B Sales Portal Homepage
    • My Catalog for B2B Sales Portal

Troubleshooting

  • Troubleshooting Blog
  • Troubleshooting CSV Imports
  • Troubleshooting PayPal
  • Troubleshooting Products
  • Troubleshooting Promotions
  • Troubleshooting Shipping
  • Troubleshooting Taxes
  • Troubleshooting Categories

Mobile App

  • iOS 3.0 Release Notes
  • Mobile Help
    • Mobile App FAQs
  • Mobile Barcode Scanning
  • Markdown
  • Mobile Account Search and Filter

REST API

Suggest Edits

Click Here for Documentation on the Zoey REST API

Updated over 1 year ago


  • Table of Contents
    • Click Here for Documentation on the Zoey REST API