My Account
Actions & Action Templates
Inviting New Users
Managing Notifications
Partnership Billing Settings
Passwordless Sign-in
Privacy Policy
Referral Partners
Setting Billing Address
Signing Up
Single Sign-On (SSO)
Terms of Service
Viewing Subscription Info
Buyers
Check Order Status
Downloading Assets
Inviting Sellers
Onboarding Status
Packing Slips - Buyers
Selecting Products
Seller SLAs
Sending Test Orders
Signing Up As A Buyer
Syncing Order Updates
Sellers
Onboarding
Adding Partners
Connecting Your Platform
Fixing SKUs in Scientific Notation
How to Set Up Pricing
Marking Products Active
Seller Quickstart Guide
The 4Ps of Seller Onboarding
Resources
Integrations
Building API Integrations
Connecting BigCommerce
Connecting Magento 2
Connecting Shopify
Connecting WooCommerce
Connecting through SFTP
Connecting through Seller EDI
Connecting through Seller EDI - Advance Ship Notice (856) Specification
Connecting through Seller EDI - Inventory Update (846) Specification
Connecting through Seller EDI - Invoice (810) Specification
Connecting through Seller EDI - Purchase Order (850) Specification
Connecting through Seller EDI - Purchase Order Acknowledgements (855) Specification
Connecting through Web App
Getting Started with the Buyer API
How Inventory Sync Works
Integrating your CRM
Supported Connection Methods
Updating Shipping Information
Security
Tutorials
Downloading EDI Files related to Purchase Orders
How can I confirm that Convictional can pull my Products from my WooCommerce Store?
How to Resend an Advance Ship Notice
How to Resolve " Your SFTP user requires delete permission on your SFTP server."
How to Resolve "Already Processed Files"
How to Resolve "Unable to access your SFTP server"
How to Resolve "Your SFTP user requires read permission on your SFTP server"
How to Resolve "Your SFTP user requires write permission on your SFTP server."
How to check if you are a buyer or seller on Convictional?
Migrating Ecommerce Platforms
Using REF Segments for Identifying Vendors instead of an ISA ID
Troubleshooting
Table of Contents
- All Categories
- Integrations
- Building API Integrations
Building API Integrations
Updated
by Jeremy Tupper
Convictional offers an API so you can do the same things you would otherwise do online via API.
API Documentation
We offer API documentation that covers all the public endpoints for our various services.
API Credentials
Every user is issued an API key when your account is created. You can see yours in the Integration Settings.

Support
Please contact support@convictional.com if you have questions.