Sample Payout Account
```json { "id": 12345, "account_type": "MERCHANT", "account_id": 12345, "app_id": 11111, "is_active": true, "country_code": "US", "payment_provider": "STRIPE", "payment_provider_account_id": "acct_ASDFGHJKLasdfghjkl", "payment_provider_account_type": "EXPRESS", "payment_provider_account": { "account_id": "acct_ASDFGHJKLasdfghjkl", "account_type": "EXPRESS", "email": "email@merchant.com", "banking_country": "US", "banking_currency": "usd", "charges_enabled": true, "payouts_enabled": true, "requirements": { "alternatives": [], "currently_due": [], "errors": [], "eventually_due": [], "past_due": [], "pending_verification": [] } }, "errors": [], "date_created": "2025-04-22T16:36:23+0000", "date_last_modified": "2025-04-22T16:36:23+0000" } ```(credentials + headers) Violet-->>App: Authentication Token + Refresh Token Note over App,Violet: API Requests App->>Violet: API Request
(with auth token) Violet-->>App: API Response Note over App,Violet: Token Refresh (before expiry) App->>Violet: GET /auth/token
(with refresh token) Violet-->>App: New Authentication Token Note over App,Violet: Continued API Usage App->>Violet: API Request
(with new auth token) Violet-->>App: API Response ``` # Initial Authentication | Field | Description | | -------- | ----------------------------------------------------------------------------------------------------- | | username | Username for your Violet account created on channel.violet.io (this is your email you signed up with) | | password | Password for your Violet account you created on channel.violet.io | #### Making the Login Request The first call to Violet that needs to be made is the /login call, to authenticate your Violet Account and credentials and retrieve an authentication token. **Endpoint**: `POST /login` **Required Headers**: ```http X-Violet-App-Id: your-app-id-here X-Violet-App-Secret: your-app-secret-here Content-Type: application/json ``` **Request Body** ```json { "username": "your-email@example.com", "password": "your-password" } ``` #### Sample Code {% tabs %} {% tab title="Bash" %} ```bash curl -X POST https://sandbox-api.violet.io/v1/login \ -H "X-Violet-App-Id: your-app-id-here" \ -H "X-Violet-App-Secret: your-app-secret-here" \ -H "Content-Type: application/json" \ -d '{ "username": "your-email@example.com", "password": "your-password" }' ``` {% endtab %} {% tab title="JavaScript" %} ```javascript async function authenticateWithViolet() { try { const response = await fetch('https://sandbox-api.violet.io/v1/login', { method: 'POST', headers: { 'X-Violet-App-Id': process.env.VIOLET_APP_ID, 'X-Violet-App-Secret': process.env.VIOLET_APP_SECRET, 'Content-Type': 'application/json' }, body: JSON.stringify({ username: process.env.VIOLET_USERNAME, password: process.env.VIOLET_PASSWORD }) }); if (!response.ok) { const errorData = await response.json(); throw new Error(errorData.message || 'Authentication failed'); } const data = await response.json(); return { authToken: data.token, refreshToken: data.refresh_token, expiresAt: new Date(data.expires_at) }; } catch (error) { console.error('Authentication failed:', error.message); throw error; } } ``` {% endtab %} {% endtabs %} ### Expected Response ```json { "id": 10084, "first_name": "First", "last_name": "Name", "email": "user@violet.io", "type": "DEVELOPER", "verified": true, "date_created": "2022-04-11T21:03:04+0000", "date_last_modified": "2024-10-23T21:52:56+0000", "roles": [ { "name": "ROLE_DEVELOPER", "permissions": [ { "name": "MANAGE_APPS" }, { "name": "MANAGE_USER" } ] } ], "tos_accepted": false, "token": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ1c2VyQGV4YW1wbGUuY29tIiwic2NvcGVzIjpbIlJPTEVfREVWRUxPUEVSIl0sInVzZXJfaWQiOjEwMzk3LCJ1c2VyX3R5cGUiOiJERVZFTE9QRVIiLCJtZXJjaGFudF9pZHMiOltdLCJkZXZlbG9wZXJfaWQiOjEwMjkyLCJhcHBfaWQiOiIxMDM4MiIsImlzcyI6Imh0dHBzOi8vdmlvbGV0LmlvIiwiaWF0IjoxNjUyMzc3ODc0LCJleHAiOjE2NTI0NjQyNzR9.BW1HDpe1Gm2wA-esP8NWEtn9thEsfeKsIGEicAoMgDPEOyO6VdNP71ajqnPrMqITGadHApH-b6LewiBFAcobw", "refresh_token": "rt_1234567890abcdef" } ``` # Making Authenticated Requests Use this in the Header of every request you send to Violet. #### Required Headers for API Requests ```http X-Violet-App-Id: your-app-id-here X-Violet-App-Secret: your-app-secret-here X-Violet-Token: your-authentication-token-here Content-Type: application/json ``` #### Example API Request ```javascript async function makeVioletAPIRequest(authToken, endpoint, method = 'GET', data = null) { const url = `https://sandbox-api.violet.io/v1${endpoint}`; const options = { method, headers: { 'X-Violet-App-Id': process.env.VIOLET_APP_ID, 'X-Violet-App-Secret': process.env.VIOLET_APP_SECRET, 'X-Violet-Token': authToken, 'Content-Type': 'application/json' } }; if (data && (method === 'POST' || method === 'PUT' || method === 'PATCH')) { options.body = JSON.stringify(data); } try { const response = await fetch(url, options); if (response.status === 401) { throw new Error('TOKEN_EXPIRED'); } if (!response.ok) { const errorData = await response.json(); throw new Error(errorData.message || 'API request failed'); } return response.json(); } catch (error) { throw error; } } // Example usage const merchants = await makeVioletAPIRequest(authToken, '/merchants'); ``` # Token Refresh Management Auth tokens expire after a set time period. Use your refresh token to obtain new auth tokens without re-entering your login credentials. Always refresh your token before it expires to maintain uninterrupted API access. #### Refreshing Tokens **Endpoint**: `GET /auth/token` **Required Headers**: ```http X-Violet-App-Id: your-app-id-here X-Violet-App-Secret: your-app-secret-here X-Violet-Token: your-refresh-token-here Content-Type: application/json ``` #### Example Automatic Token Refresh Implementation ```javascript class VioletAuthManager { constructor(appId, appSecret, username, password) { this.appId = appId; this.appSecret = appSecret; this.username = username; this.password = password; this.authToken = null; this.refreshToken = null; this.expiresAt = null; this.baseURL = 'https://sandbox-api.violet.io/v1'; } async initialize() { const tokens = await this.login(); this.setTokens(tokens); return tokens; } async login() { const response = await fetch(`${this.baseURL}/login`, { method: 'POST', headers: { 'X-Violet-App-Id': this.appId, 'X-Violet-App-Secret': this.appSecret, 'Content-Type': 'application/json' }, body: JSON.stringify({ username: this.username, password: this.password }) }); if (!response.ok) { const errorData = await response.json(); throw new Error(errorData.message || 'Login failed'); } const data = await response.json(); return { authToken: data.token, refreshToken: data.refresh_token, expiresAt: new Date(data.expires_at) }; } async refreshAuthToken() { if (!this.refreshToken) { throw new Error('No refresh token available. Please re-authenticate.'); } try { const response = await fetch(`${this.baseURL}/auth/token`, { headers: { 'X-Violet-App-Id': this.appId, 'X-Violet-App-Secret': this.appSecret, 'X-Violet-Token': this.refreshToken, 'Content-Type': 'application/json' } }); if (!response.ok) { throw new Error('Token refresh failed'); } const data = await response.json(); this.authToken = data.token; this.expiresAt = this.extractExpiryFromJWT(data.token); return this.authToken; } catch (error) { // If refresh fails, re-authenticate console.warn('Token refresh failed, re-authenticating...'); const tokens = await this.login(); this.setTokens(tokens); return this.authToken; } } async getValidToken() { // Check if token is expired or will expire within 5 minutes const now = new Date(); const fiveMinutesFromNow = new Date(now.getTime() + 5 * 60 * 1000); if (!this.authToken || !this.expiresAt || this.expiresAt <= fiveMinutesFromNow) { await this.refreshAuthToken(); } return this.authToken; } async makeRequest(endpoint, method = 'GET', data = null) { const token = await this.getValidToken(); const url = `${this.baseURL}${endpoint}`; const options = { method, headers: { 'X-Violet-App-Id': this.appId, 'X-Violet-App-Secret': this.appSecret, 'X-Violet-Token': token, 'Content-Type': 'application/json' } }; if (data && ['POST', 'PUT', 'PATCH'].includes(method)) { options.body = JSON.stringify(data); } try { let response = await fetch(url, options); if (response.status === 401) { // Token might be expired, try refreshing once await this.refreshAuthToken(); options.headers['X-Violet-Token'] = this.authToken; response = await fetch(url, options); } if (!response.ok) { const errorData = await response.json(); throw new Error(errorData.message || 'API request failed'); } return response.json(); } setTokens({ authToken, refreshToken, expiresAt }) { this.authToken = authToken; this.refreshToken = refreshToken; this.expiresAt = expiresAt; } extractExpiryFromJWT(token) { try { const payload = JSON.parse(atob(token.split('.')[1])); return new Date(payload.exp * 1000); } catch (error) { console.warn('Failed to extract expiry from JWT:', error); return new Date(Date.now() + 24 * 60 * 60 * 1000); // Default to 24 hours } } } // Usage example const authManager = new VioletAuthManager( process.env.VIOLET_APP_ID, process.env.VIOLET_APP_SECRET, process.env.VIOLET_USERNAME, process.env.VIOLET_PASSWORD ); await authManager.initialize(); // Make authenticated requests const merchants = await authManager.makeRequest('/merchants'); const orders = await authManager.makeRequest('/orders'); ``` # Environments ## Overview The Violet API provides developers with access to two environments: **Test Mode** and **Live Mode**. From the experience of the developer, these environments are nearly identical with only two primary differences. 1. When an order is placed in Test Mode, no dollars are transacted and no orders are fulfilled. When an order is placed in Live Mode, dollars are transacted and orders will be received and fulfilled by real merchants. 2. The Test Mode product catalog is mostly static and much smaller than the Live Mode product catalog. The Live Mode product catalog is constantly growing as more merchants join Violet. ### Live Mode URLs * **Violet API** -
Click to expand to learn more about the API scopes
### Products & Inventory | Scope | Purpose | | ----------------------------- | ---------------------------------- | | `read_products` | Read product catalog | | `read_inventory` | Read inventory data | | `read_locations` | Read inventory locations | | `read_metaobject_definitions` | Read metaobject definitions | | `read_metaobjects` | Read metaobject data | | `read_publications` | Read sales channel publications | | `write_publications` | Publish products to sales channels | | `read_locales` | Read store locale data | | `read_translations` | Read translation data | ### Customers | Scope | Purpose | | ----------------- | ---------------------------------------- | | `write_customers` | Create customers for non-guest checkouts | | `read_customers` | Read customer information | ### Orders & Checkout | Scope | Purpose | | ------------------------------------------- | ------------------------------- | | `write_orders` | Create and update orders | | `read_orders` | Read orders submitted by Violet | | `write_draft_orders` | Populate and submit orders | | `read_draft_orders` | Read draft order data | | `write_merchant_managed_fulfillment_orders` | Flag orders requiring review | ### Fulfillment & Shipping | Scope | Purpose | | ------------------- | ------------------------- | | `read_fulfillments` | Read fulfillment statuses | | `read_shipping` | Read shipping policies | | `read_markets` | Read shipping regions | ### Pricing & Discounts | Scope | Purpose | | ------------------ | ---------------------- | | `read_price_rules` | Read pricing rules | | `read_discounts` | Read discount policies | ### Policies & Returns | Scope | Purpose | | --------------------- | --------------------------- | | `read_legal_policies` | Read refund/return policies | | `read_returns` | Discover returned orders | ### Cart Operations (Unauthenticated) | Scope | Purpose | | ---------------------------------------- | ------------------------------------- | | `unauthenticated_write_checkouts` | Create carts without rate limits | | `unauthenticated_read_product_listings` | Read product data without rate limits | | `unauthenticated_read_product_inventory` | Read inventory without rate limits |The merchant connected, but their catalog is empty
**Most likely cause.** No products have been published to the channel yet. A new channel starts with none of the merchant's products, and this is the expected state immediately after connection. **Resolution.** Walk the merchant through making their first products available, using the merchant-facing instructions in the [Merchant Help Center](https://merchant-help.violet.io/). This is the most common ticket on this feature. Front-load it in merchant onboarding rather than handling it reactively.The channel doesn't appear in the merchant's Shopify admin
**Possible causes, in order of likelihood.** 1. The merchant connected before the feature was enabled for the channel and hasn't reconnected. They keep full-catalog syncing until they re-authorize. 2. The app's `channel_config` extension isn't deployed and released, so Shopify rejected channel creation. 3. The app's specification handle doesn't match the handle in the deployed extension. 4. The app is missing the `read_publications` scope, so the publication couldn't be identified. **Resolution.** Confirm the prerequisites in [Enablement & Rollout](/ecom-platforms/shopify/sales-channel/enablement#prerequisites), then have the merchant reconnect. Reconnecting is safe and repairs partially provisioned connections without creating a duplicate channel.The merchant published a product, but it never arrived
**Check in this order.** 1. **Shopify status.** Draft products sync but are never available for purchase; Archived products are archived in Violet. The product must be Active. 2. **Channel catalog rules.** Collection filters, excluded collections, excluded tags, and excluded vendors still apply on top of publication filtering. A published product matching an exclusion rule is correctly withheld. 3. **Which channel was ticked.** On a store connected to several Violet channels, it's easy to publish to the wrong one. 4. **Elapsed time.** Sync is event-driven and usually takes seconds, but is not instantaneous.The merchant unpublished a product, but it's still being sold
**Most likely cause.** A missed publication event. Violet's scheduled catalog validation does not currently re-verify publication membership, so an unpublish that occurs during an extended webhook interruption may not be reflected until the product is next modified. **Second cause.** The channel's integration is reading `status` or `available` rather than `publishing_status`. Unpublishing updates only `publishing_status`, so the other two keep describing the product as it is in the merchant's store, usually still `AVAILABLE`, since it is still selling there. **Resolution.** Trigger a product re-sync for the affected product. If it recurs across products, check that the integration reads `publishing_status`. See [Unpublishing is an update, not a deletion](/ecom-platforms/shopify/sales-channel/catalog-sync#unpublishing-is-an-update-not-a-deletion).The merchant is enabled for the feature but still syncing their whole catalog
**Cause.** The merchant-level setting is on, but no channel is provisioned for *this particular* app. This happens on stores connected to several Violet channels, where one connection is provisioned and another isn't. **Resolution.** Have the merchant reconnect the affected channel. Provisioning is per connection, and reconnecting repairs the missing one without touching the others.Does enabling this change anything for merchants already connected?
No. Existing merchants keep full-catalog syncing until they reconnect. Enabling the feature on an app does not retroactively scope anyone's catalog.Can we migrate existing merchants in bulk?
No. Channel creation requires Shopify permissions that a merchant only grants by re-authorizing, so migration is necessarily merchant-initiated. Plan a reconnection campaign.Can Violet publish the merchant's products to the channel for them?
Not today. Product selection is entirely merchant-driven, and there is no backfill that publishes an existing catalog to a new channel. Merchants must make the first selection themselves.If a merchant unpublishes everything, is their connection broken?
No. It's a valid state: an empty publication means an empty catalog. The connection stays healthy and the catalog repopulates as soon as they publish something.Does unpublishing a product affect orders already placed for it?
No. Existing orders, fulfillment, and refunds are unaffected.Can a merchant share different products with different Violet channels?
Yes. Each connected app has its own channel and its own product selection.What happens if we turn the feature off for a merchant?
They revert to full-catalog syncing and their catalog expands back to their whole store. Confirm this is what the merchant expects before doing it.404 Redirect Error During OAuth
**Problem**: Merchant clicks the installation link and sees a 404 error from Shopify during the OAuth redirect. **Cause**: The **App URL** in Shopify Partner Dashboard uses a different host than the **Redirect URI**. Shopify requires both URLs to share the same host. **What went wrong:** * ❌ App URL: `https://yourcompany.com` + Redirect URI: `https://connect.violet.io/...` → **Hosts don't match** * ✅ App URL: `https://connect.violet.io/your-alias` + Redirect URI: `https://connect.violet.io/your-alias/...` → **Hosts match** **Solution:** 1. Go to [Shopify Partner Dashboard](https://partners.shopify.com) → **App Distribution** 2. Navigate to your Custom App → select **View on Dev Dashboard** (far right link) 3. Click **Configuration** (or **App setup**) 4. Update the **App URL** field to: * **Live Mode**: `https://connect.violet.io/{YOUR_APP_ALIAS}` * **Test Mode**: `https://connect.violet.dev/{YOUR_APP_ALIAS}` 5. Verify the **Redirect URI** uses the same host as the App URL 6. Save changes 7. Have the merchant retry the installation link **Finding Your App Alias:** [Channel Dashboard](https://channel.violet.io) → App Settings → Violet Connect **Prevention:** See [Shopify App Setup](/ecom-platforms/shopify/shopify-app-setup#app-url) for correct configuration.Install Link Missing or Invalid
**Problem**: Cannot find the Install Link in Shopify Partner Dashboard, or the Install Link field shows an error in Violet pre-registration. **Cause**: Custom distribution was not selected for the app. **Solution:** 1. Go to [Shopify Partner Dashboard](https://partners.shopify.com) → **App Distribution** → Your Custom App 2. Look for the **Distribution** section on the app overview page 3. Click **"Select distribution method"** 4. Choose **"Custom distribution"** and confirm 5. After selection, you'll see the Distribution page with the Install Link 6. Copy the Install Link and use it in your Violet pre-registration  **Prevention:** Always select "Custom distribution" immediately after creating your custom app. See [Shopify App Setup - Step 5](/ecom-platforms/shopify/shopify-app-setup#step-5-select-custom-distribution).Merchant Clicked Violet Connect Before Installing App
**Problem**: Merchant clicked the Violet Connect link but sees an error because the app isn't installed. **Cause**: The merchant needs to install the custom app via the Shopify Install Link BEFORE using Violet Connect. **Solution:** 1. Ask the merchant to close the Violet Connect page 2. Send them the **Shopify Install Link** (Channel Dashboard → Pre-Registered → Actions → Copy Shopify Install Link) 3. Have them click the Install Link and complete app installation in Shopify admin 4. After installation is confirmed, send them the Violet Connect link again 5. They should now be able to complete onboarding successfully **Prevention:** Always send the Shopify Install Link first and confirm the merchant has installed the app before sending the Violet Connect link.Wrong Store URL
**Problem**: Merchant reports the Violet Connect link shows the wrong store name/URL. **Cause**: Store URL was entered incorrectly during pre-registration. **Solution**: 1. Delete the incorrect pre-registration (Actions menu → Delete) 2. Create a new pre-registration with the correct store URL 3. Copy and send the new Violet Connect link to merchantPermission Errors - Features Don't Work
**Problem**: Merchant completes installation but features don't work (products missing, shipping rates not calculating, etc.) **Cause**: Missing API scopes in the custom app configuration. **Solution**: 1. Go to [Shopify Partner Dashboard](https://partners.shopify.com) → **App Distribution** 2. Navigate to your Custom App → select **View on Dev Dashboard** (far right link) 3. Check Configuration tab → Admin API access scopes 4. Add missing scopes from [Prerequisites](/ecom-platforms/shopify/prerequisites) section 5. Update pre-registration: Actions menu → Edit 6. Have merchant use new link and reinstallMissing Credentials from Shopify Partner Dashboard
**Problem**: Can't pre-register merchant because you don't have credentials. **Cause**: Haven't completed prerequisites in Shopify Partner Dashboard. **Solution**: 1. Review the [Prerequisites](/ecom-platforms/shopify/prerequisites) section 2. Log in to [Shopify Partner Dashboard](https://partners.shopify.com) 3. Create custom app for this merchant 4. Configure required API scopes 5. Generate and copy credentials 6. Return to Channel Dashboard to pre-registerMerchant Already Connected
**Problem**: Merchant tries to connect but sees "store already connected" error. **Cause**: This store is already connected to your channel (check "Connected Merchants" tab). **Solution**: * If merchant needs a fresh connection, delete the existing connection first * Create a new pre-registration * Send new link to merchantDo we need to migrate all existing custom apps immediately?
**No.** Existing merchant-created custom apps continue working indefinitely. Only migrate when you need to: * Change permissions * Rotate credentials * Set up a new merchantCan merchants still access their existing custom apps?
**Yes.** They can view them in Settings > Apps and sales channels, and they can uninstall them if needed. They just can't create new ones after January 1, 2026.What happens to my old Shopify integrations?
**Old integrations**: Merchants connected before January 2026 will continue to work as-is. No changes needed for existing merchants. **New onboarding**: All new merchants must follow the pre-registration process in this guide.Why did Shopify require this change?
Shopify deprecated the previous channel-controlled custom app model to give merchants better security and control. With single-merchant custom apps: * Each merchant owns their app and credentials * Merchants can revoke access at any time * Merchants have full visibility into API permissions * Better audit trail for data access * Merchants have full control over their integrationsWhat if a merchant needs additional permissions?
You must create a new single-merchant app with the expanded permissions and send them a new installation link. The old app will continue working until they're ready to switch. Permission changes require: 1. Update the custom app in Shopify Partner Dashboard to include additional scopes 2. Create a new pre-registration with the updated credentials 3. Have merchant reinstall using the new linkDo we need to update our API version?
Not necessarily. Single-merchant apps work with any stable API version. However, it's good practice to use recent versions (2025-10 or later).Can one single-merchant app be installed on multiple stores?
**No.** Each single-merchant app is designed for exactly one merchant. You need to create separate apps for each merchant, even if they're owned by the same company.How do we handle merchants who create new stores after January 1, 2026?
You'll need to create a new single-merchant app and send them the installation link for each new store.Can we automate app creation via API?
Shopify doesn't currently provide an API to create single-merchant apps programmatically. You must create them through the Partner dashboard. Violet will proactively notify you if this changes.What if we have hundreds of merchants?
This is time-intensive but manageable: * Create apps in batches * Prioritize based on need * Remember that existing apps don't require immediate migration * Establish a process for creating new apps efficientlyI lost my Client Secret or forgot to copy it before navigating away
The Client Secret appears only once in Shopify. If you didn't copy it, you'll need to regenerate it: 1. Go to [Shopify Partner Dashboard](https://partners.shopify.com) → **App Distribution** 2. Navigate to your Custom App → select **View on Dev Dashboard** (far right link) 3. Navigate to the **API credentials** section 4. Find the Client Secret field and click **Rotate**  4. Copy the new Client Secret immediately 5. Return to Violet Channel Dashboard 6. Edit the pre-registration for this merchant (Actions menu → Edit) 7. Update the **Client Secret** field with the new value 8. Save the pre-registration 9. If the merchant already started installation with the old credentials, send them the updated installation linkWhat happens to our existing API credentials?
They continue working unchanged. The access tokens from merchant-created custom apps remain valid.Can I edit a pre-registration after creating it?
Yes. Use the **Edit** action in the Pre-Registered tab to update: * Merchant Name * Store URL * Client ID * Client Secret **Important**: If a merchant has already started installation, editing credentials will require them to reinstall with updated credentials.How do I know when a merchant has completed installation?
The merchant automatically moves from the "Pre-Registered" tab to the "Connected Merchants" tab. You'll see them appear in your Connected Merchants list, and their status will change from "Pending" to "Active".Can I pre-register the same merchant multiple times?
No. Each store URL can only have one active pre-registration. If you need to create a new pre-registration: 1. Delete the existing one (Actions menu → Delete) 2. Create a new pre-registration with the updated credentials 3. Send new installation linkWhat is the Install Link and where do I find it?
The **Install Link** is a Shopify-generated URL that allows merchants to install your custom app directly in their Shopify admin. **Format:** `https://admin.shopify.com/store/{store}/oauth/install_custom_app?client_id=...` **Where to find it:** 1. Go to [Shopify Partner Dashboard](https://partners.shopify.com) 2. Navigate to **App Distribution** → Select your custom app 3. Click on the **Distribution** section 4. If you haven't selected a distribution method, click "Select distribution method" and choose "Custom distribution" 5. The Install Link appears on the Distribution page with a Copy button **When you need it:** The Install Link is required when creating a pre-registration in Violet Channel Dashboard. It's also what you send to merchants FIRST, before the Violet Connect link. Why do merchants need to install the app before using Violet Connect?
The two-step process (Install Link, then Violet Connect) is required because: 1. **Shopify requirement**: Custom apps must be installed in the merchant's Shopify admin before OAuth can complete 2. **App authorization**: The Install Link triggers Shopify's app installation flow, which grants the necessary permissions 3. **OAuth handshake**: Violet Connect then completes the OAuth process using the pre-registered credentials **The correct order is:** 1. Channel sends Shopify Install Link to merchant 2. Merchant installs app in Shopify admin 3. Channel sends Violet Connect link to merchant 4. Merchant completes Violet onboarding Skipping step 2 will cause errors during Violet Connect onboarding.Can Violet create orders for merchants who use Global-E?
**Yes, but with limitations.** Violet can create orders for domestic markets (e.g., US-to-US) without any issues. However, for international markets managed by Global-E, orders created through Violet bypass Global-E's checkout entirely. This means Global-E will not act as the Merchant of Record, and no duties, taxes, or landed costs will be calculated by Global-E for those orders. See the [Global-E x Shopify](/ecom-platforms/shopify/global-e) page for full details.Why can't Violet route orders through Global-E's checkout?
Global-E's checkout is rendered inside an iFrame on the merchant's storefront and is not accessible via a standalone API. Duty/tax calculations, payment processing, and Merchant of Record coverage are all tightly coupled to that checkout session. There is no API endpoint to calculate duties independently or to retroactively assign MoR coverage to an order created outside of Global-E's flow.What should a merchant do if they use Global-E and want to connect with Violet?
The merchant should notify their channel partner during onboarding that they use Global-E for international orders. The channel partner can then configure the integration so that Violet only creates orders in markets where Global-E is not the Merchant of Record, avoiding unintentional tax compliance gaps.Will international orders created by Violet appear in Global-E's reporting?
**No.** Orders created by Violet go directly through the Shopify API and are invisible to Global-E. They will not receive a `GEOrderId`, will not appear in Global-E's settlement reports, and will not be covered by Global-E's financial reconciliation.Is the merchant liable for taxes on international orders placed through Violet that bypass Global-E?
**Yes.** When an order bypasses Global-E, the merchant — not Global-E — is the legal seller. The merchant assumes responsibility for VAT/GST obligations, customs compliance, and duties in the destination country. Merchants should consult their tax and legal advisors before enabling international markets for Violet orders outside of Global-E's coverage.Are there any cost changes?
Single-merchant apps (custom apps) remain free. There's no cost difference between old and new custom apps.Client ID & Secret] G --> H[Pre-register Merchant
in Channel Dashboard] H --> I[Send Install Link
to Merchant] I --> J[Merchant Installs App
in Shopify Admin] J --> K[Send Violet Connect Link
to Merchant] K --> L[Merchant Authenticates
with Violet] L --> M[Pre-filled Store Details
Displayed] M --> N[Merchant Clicks
Connect to Shopify] N --> O[Violet Completes
OAuth Handshake] O --> P[Merchant moves to
Connected Merchants Tab] P --> Q[✓ Onboarding Complete] ``` *** ### Additional Resources #### Official Shopify Documentation * [Partner Dashboard](https://partners.shopify.com/) * [Custom Apps Guide](https://shopify.dev/docs/apps/build/authentication-authorization) * [OAuth Documentation](https://shopify.dev/docs/apps/build/authentication-authorization/access-tokens/authorization-code-grant) * [API Scopes Reference](https://shopify.dev/docs/api/usage/access-scopes) #### Violet Documentation * [Violet Connect Overview](/prism/violet-connect) * [Platform Integration Guides](/ecom-platforms/ecom-platforms) # BigCommerce Overview of Violet's BigCommerce integration for channel developers BigCommerce is an enterprise-focused ecommerce platform with a comprehensive REST API and advanced webhook support. Merchants connect to Violet by providing API credentials either through an OAuth app flow or directly via Store Level API credentials. ## Connection BigCommerce supports two connection paths: **OAuth (Recommended)** — Merchants authorize through the BigCommerce App Marketplace. Violet receives a token exchange with `client_id`, `access_token`, and `store_hash` automatically. **Store Level API** — Merchants generate credentials directly in their BigCommerce store admin and provide them manually. This requires the store URL (e.g. `https://store-{hash}.mybigcommerce.com`), Client ID, Client Secret, and Access Token. ### Required API Scopes When connecting via Store Level API, Violet validates that all of the following scopes are present: | Scope | Access Level | | -------------------------------- | ----------------------------- | | `store_v2_default` | Default store access | | `store_v2_customers` | Customers (modify) | | `store_cart` | Carts (modify) | | `store_v2_orders` | Orders (modify) | | `store_v2_information_read_only` | Store information (read-only) | | `store_checkout` | Checkout (modify) | | `store_v2_products_read_only` | Products (read-only) | Violet will return an error listing any missing scopes during the connection attempt. ## Webhooks Webhooks are registered automatically when a merchant connects. Violet listens for order and product lifecycle events. Webhook signatures are validated on all inbound requests. ## Notable Behavior * **Coupon codes**: BigCommerce supports coupon codes natively. Use `Coupon Codes` (not `Promotions`) when creating discount codes for use with Violet-submitted orders. * **Refunds**: Refunds submitted through Violet may appear as "offline" in BigCommerce — this is expected behavior. * **Rate limits**: BigCommerce enforces rate limits of approximately 450 requests per 30 seconds. Violet handles retries with exponential backoff. * **Product variants**: BigCommerce uses a named option/value system for variants. Violet maps these to its unified variant model automatically. # WooCommerce Overview of Violet's WooCommerce integration for channel developers WooCommerce is a WordPress-based ecommerce plugin used by millions of online stores. Merchants connect to Violet using REST API keys generated from their WordPress admin. ## Connection Merchants provide a **Consumer Key**, **Consumer Secret**, and their **Store URL**. These are generated in the WooCommerce admin under **WooCommerce → Settings → Advanced → REST API**. ### Permalink Requirement WooCommerce's REST API requires the **Post name** permalink structure to function correctly. Merchants using the default WordPress permalink structure (`/?p=123`) will encounter 404 errors. Merchants should confirm this setting under **Settings → Permalinks** in WordPress. ## Webhooks Webhooks are registered and managed automatically by Violet. The following topics are used: | Topic | Purpose | | ----------------- | ----------------------------------- | | `product.created` | New product published | | `product.updated` | Product changes synced | | `product.deleted` | Product removed from catalog | | `order.updated` | Order status or fulfillment updated | | `order.deleted` | Order removed | Webhooks are named using the pattern `violet_{topic}_{environment}` to distinguish Violet's webhooks from others and to avoid accidental deletion. ## Notable Behavior * **Product types**: WooCommerce has `simple`, `variable`, `grouped`, `external`, `virtual`, and `downloadable` product types. Violet syncs `simple` and `variable` products. Variable products use WooCommerce's variation system, which Violet maps to its unified variant model. * **Discount codes**: WooCommerce coupon codes are supported. Violet distributes discount amounts at the line-item level and creates a coupon line in the submitted order. * **Tax**: WooCommerce's tax configuration can be complex. Tax calculation behavior depends on the merchant's store settings. # Magento Overview of Violet's Magento (Adobe Commerce) integration for channel developers Magento (now Adobe Commerce) is an open-source ecommerce platform for mid-market and enterprise merchants. Violet supports Magento 2.x via its REST API, with enhanced functionality available through an optional Violet Magento extension. ## Connection Merchants provide an **API Token**, **API Secret**, and their **Store URL**. ### Violet Extension (Recommended) The Violet Magento extension unlocks additional capabilities and is recommended for most merchants. When the extension is installed, Violet can: * Access store admin contact information * Receive real-time webhook notifications for product and order changes * Sync Violet's internal token directly to the merchant's store Without the extension, Violet operates in **API-only mode**, which provides full order submission and product sync but relies on scheduled sync jobs rather than real-time events. The extension is installed via **Composer 2+** and requires Magento 2.4.x. ### Bearer Tokens (Magento 2.4.4+) Magento 2.4.4 and newer may require **standalone Bearer tokens** to be enabled. Merchants should verify this setting if they encounter authentication errors after providing valid credentials. ## Notable Behavior * **Multi-store**: Magento supports complex multi-store and multi-website configurations. Violet connects to the default store view unless merchant configuration specifies otherwise. * **No native scopes**: Unlike other platforms, Magento does not have granular API access scopes. Valid credentials provide full API access. # Salesforce Commerce Cloud Overview of Violet's Salesforce Commerce Cloud (SFCC) integration for channel developers Salesforce Commerce Cloud (SFCC), formerly known as Demandware, is an enterprise ecommerce platform. SFCC uses the Open Commerce API (OCAPI) for backend integrations. This is one of the more involved platform setups due to SFCC's access control model. ## Connection SFCC credentials are passed as a JSON blob containing the following fields: | Field | Description | | ----------------------- | --------------------------------------------------- | | `ocapi_client_id` | OCAPI client ID configured in Business Manager | | `ocapi_client_password` | OCAPI client password | | `access_key` | Business Manager access key for the connecting user | | `username` | Business Manager username (email) | | `site_id` | The SFCC site ID to connect (e.g. `RefArch`) | The store URL is also required. ## Required OCAPI Permissions Violet validates OCAPI permissions during authentication. Both **Shop API** and **Data API** resource access must be configured in Business Manager for the provided client ID. Violet checks for a defined set of required resources across both API types and returns a detailed error listing any missing scopes if they are not present. To simplify setup, merchants can grant wildcard (`/**`) access to the client ID rather than configuring individual resource paths. ## Merchant Setup Requirements * **Customer Group**: The SFCC site must have a customer group named `VIOLET_API`. Violet-submitted orders are placed under this customer group. * **Payment Method**: A payment method must be configured on the site that Violet can reference when submitting orders. ## Webhooks SFCC does not support traditional real-time webhooks for the OCAPI integration. Product and order data is synchronized via scheduled sync jobs rather than push notifications. ## Notable Behavior * **Order management**: SFCC order management is handled separately from the core OCAPI integration. If merchants use a standalone Order Management System (OMS) alongside SFCC, additional configuration may be required. * **Locales and sites**: SFCC supports complex multi-locale and multi-site configurations. Violet connects to the site specified in the `site_id` credential field. # CommerceTools Overview of Violet's commercetools integration for channel developers # Centra Overview of Violet's Centra integration for channel developers Centra is a fashion and lifestyle-focused ecommerce platform built for mid-market to enterprise brands. It provides two separate APIs: a GraphQL Integration API for backend operations, and a REST Checkout API for cart and checkout flows. ## Connection Merchants provide a **Store URL** and an **Integration API Token**. Optionally, a **Checkout API Shared Secret** can also be provided to enable real-time cart calculation. | Credential | API | Description | | -------------------------- | ----------------------- | ---------------------------------------------- | | Store URL | Both | Base URL of the Centra store | | Integration API Token | GraphQL Integration API | Bearer token for product/order operations | | Checkout API Shared Secret | Checkout API (optional) | Enables real-time shipping and tax calculation | The Integration API token is a long-lived bearer token configured in the Centra admin. ## Webhooks Centra does not expose a programmatic API for webhook registration. Webhooks must be configured manually in the Centra admin under the **Webhook plugin**, pointing each event type to the Violet webhook gateway. Centra webhooks send arrays of entity IDs rather than full payloads. Violet fetches the full data for each ID via the Integration API upon receiving a notification. Inbound webhook signatures use the format `X-Centra-Signature: t={timestamp},v1={hmac}`. If provided, the signature is verified using the optional webhook endpoint secret. ## Cart Calculation When the Checkout API shared secret is provided, Violet uses Centra's Checkout API for real-time cart calculation. This enables accurate shipping rates and tax estimates before order submission. When the shared secret is not provided, Violet falls back to local calculation (taxes will be set to 0 and calculated at order time). ## Notable Behavior * **Three-tier product structure**: Centra uses a Product → ProductVariant → ProductSize hierarchy. Violet maps ProductSizes as purchasable SKUs, with ProductVariant names (e.g. color) and ProductSize names (e.g. S/M/L) as variant dimensions. * **Pricelist-based pricing**: Prices in Centra are linked to pricelists, which are associated with markets and currencies. Contextual pricing is supported. * **Rate limiting**: Centra enforces limits on both request count and GraphQL query complexity. Violet handles 429 responses with retry logic. * **Voucher codes**: Centra supports voucher codes on orders. Violet passes the discount code when submitting an order and validates whether it was applied based on the order response. * **Wholesale and DTC**: Centra supports both direct-to-consumer and wholesale business models. # PrestaShop Overview of Violet's PrestaShop integration for channel developers PrestaShop is an open-source ecommerce platform widely used in Europe. Violet integrates via PrestaShop's built-in web service API, with enhanced functionality available through the Violet PrestaShop extension. ## Connection Merchants provide an **API Key** and their **Store URL**. The API key is generated in the PrestaShop admin under **Advanced Parameters → Webservice**. ### Violet Extension (Required for Full Functionality) The Violet PrestaShop extension must be installed for the integration to function correctly. The extension enables real-time webhook notifications and provides additional endpoints for order management. Without it, Violet will return an error during authentication. The extension is compatible with PrestaShop **1.7 and above**. ### API Key Permissions The API key used for the integration requires access to the following PrestaShop resources: * Orders (read/write) * Products (read) * Customers (read/write) * Configurations (read) * Currencies (read) * Shops and Shop URLs (read) Violet validates API access during authentication and will return an error if required permissions are missing. ## Notable Behavior * **Store URL**: The store URL must include the full base URL with `https://` prefix. * **Multi-store**: PrestaShop supports multi-store configurations. Violet connects to the primary shop by default. * **Currency**: Currency is read from the store's configured default currency during connection. # Ecwid Overview of Violet's Ecwid (Lightspeed eCom) integration for channel developers Ecwid (now part of Lightspeed) is a hosted ecommerce platform that can be embedded into existing websites. Violet integrates via Ecwid's REST API using OAuth-based authentication. ## Connection Ecwid uses an OAuth app flow. The merchant authorizes Violet's app installation, and Violet receives an access token along with the merchant's Store ID. Merchants must be on the **Venture plan or higher** for API access. ### Required OAuth Scopes The following scopes are required for the Violet integration to function: | Scope | Purpose | | ----------------------- | --------------------------- | | `read_store_profile` | Access store configuration | | `read_catalog` | Sync product catalog | | `read_orders` | Read order data | | `update_orders` | Update order status | | `create_orders` | Submit new orders | | `create_customers` | Create customer records | | `read_customers` | Read customer data | | `read_discount_coupons` | Access coupon/discount data | Violet validates that all required scopes are granted during authentication. ## Webhooks Webhooks are registered automatically via the Ecwid API when a merchant connects. Violet listens for product and order events to keep the catalog and order status in sync. ## Notable Behavior * **Plan requirement**: The Ecwid Venture plan or higher is required for REST API access. Merchants on the Free or Venture plan may have limited API capabilities. * **Discount codes**: Ecwid coupon/discount codes are supported for order submission. * **Store URL**: The store's canonical URL is retrieved from the merchant's Ecwid profile during connection. # Wix Overview of Violet's Wix integration for channel developers Wix is a website builder and ecommerce platform used by millions of businesses. Violet integrates via the Wix API using an API key generated in the Wix dashboard. ## Connection Merchants provide a **Wix API Key** and their **Site ID**. API keys are generated in the Wix dashboard under **Settings → Advanced → API Keys**. ### Required Permissions The API key must have the following permissions enabled: | Permission | Purpose | | --------------- | ----------------------------------- | | `manage_orders` | Read and update orders | | `read_store` | Access store configuration and info | | `read_products` | Read product catalog | Violet validates all three permissions during the connection attempt by making test API calls to each endpoint. Any permission that returns an authorization error will be reported as a missing scope. ## Webhooks Webhooks for Wix merchants are registered via the Wix API after a successful connection. Violet receives events for product and order changes. ## Notable Behavior * **Shipping methods**: Wix does not expose a dedicated API endpoint for retrieving configured shipping methods. Violet assumes shipping methods are configured and proceeds accordingly. * **OAuth**: The Wix integration currently uses API key authentication rather than a full OAuth flow. Merchants generate keys directly in their dashboard and provide them during onboarding. * **Site-based access**: Each Wix API key is scoped to a specific site. Merchants with multiple Wix sites will need separate connections for each. # Squarespace Overview of Violet's Squarespace integration for channel developers Squarespace is a website builder and ecommerce platform known for its design-focused templates. Violet integrates via the Squarespace Commerce API. ## Connection Merchants provide a **Commerce API Key** generated in their Squarespace account. This is created under **Settings → Advanced → Developer API Keys**. ## Webhooks Squarespace webhooks are registered automatically after a merchant connects. Violet listens for product and order events. ## Notable Behavior * **Currency objects**: The Squarespace Commerce API represents all monetary values as objects containing a `value` and `currency` code. Violet handles this currency object format natively — no additional configuration is required. * **Discount codes**: Squarespace supports discount codes for Violet-submitted orders. Custom (fixed and percentage) discounts are also supported. * **POS integration**: Squarespace has a point-of-sale (POS) product. Orders submitted through Violet are tagged as online orders and handled through the online order flow. * **Tax**: Squarespace supports both tax-inclusive and tax-exclusive pricing. The interpretation is reflected in the order details returned after submission. * **Inventory**: Squarespace tracks inventory at the variant level. Violet syncs stock quantities from the platform during catalog synchronization. # Swell Overview of Violet's Swell integration for channel developers Swell is a headless ecommerce backend designed for modern storefronts. Violet integrates via Swell's API using a store secret key. ## Connection Merchants provide a **Secret Key** and their **Store ID**. The secret key is generated in the Swell dashboard under **Developer → API Keys**. The store ID is the subdomain used to access the store (e.g. `my-store` from `my-store.swell.store`). ## Webhooks Swell webhooks are registered automatically when a merchant connects. Violet listens for product and order lifecycle events. ## Notable Behavior * **Headless-first**: Swell is designed as a headless backend, meaning the merchant may not have a traditional storefront URL. The store URL is derived from the store ID during connection. * **Inventory**: Swell tracks inventory at the variant level. Stock quantities are synced during catalog synchronization. # Spree Commerce Overview of Violet's Spree Commerce integration for channel developers Spree Commerce is an open-source Ruby on Rails ecommerce framework with a JSON:API-style REST API. Violet integrates using OAuth2 client credentials. ## Connection Merchants provide a **Client ID** and **Client Secret** from an OAuth application configured in their Spree store. The OAuth application must be created with the `admin write` scope. Merchants also provide their **Store URL** — the base URL of their Spree instance. ## Webhooks Webhooks are registered automatically via the Spree API after a merchant connects. Violet listens for order and product lifecycle events. All Violet-originated orders are tagged with `channel = "Violet"` so that event processing can correctly identify Violet-placed orders. ## API Format Spree responses follow JSON:API conventions, using `included` arrays for related resources. Violet handles this format transparently. ## Notable Behavior * **Discounts**: Discount codes are not supported for Violet-submitted orders on Spree. Custom discount amounts are also not supported at this time. * **Checkout flow**: Spree uses an explicit multi-step checkout flow. Violet manages this flow internally during order submission. * **Product data**: Spree uses `taxons` for product categorization. *** > **Looking for Vendo?** [Vendo](/ecom-platforms/vendo) is a hosted variant of Spree with a near-identical integration. See the Vendo page for any differences. # Vendo Overview of Violet's Vendo integration for channel developers Vendo is a hosted, multi-vendor ecommerce platform built on top of Spree Commerce. Because Vendo is a managed Spree variant, the connection process and integration behavior are nearly identical to Spree with a few minor differences. ## Connection Merchants provide a **Client ID** and **Client Secret** from an OAuth application, along with their **Store URL**. The OAuth application must be created with the `admin write` scope — the same requirement as Spree. ## Differences from Spree | Feature | Spree | Vendo | | ---------------------- | ---------------------------------- | ---------------------- | | Product categorization | `taxons` | `categories` | | Checkout flow | Requires explicit step advancement | Advances automatically | ## Webhooks Webhook behavior is the same as Spree — webhooks are registered automatically. Violet-originated orders are tagged with `channel = "Violet"`. ## Notable Behavior All other behavior (discount support, API format, order submission flow) is the same as [Spree](/ecom-platforms/spree). # Miva Merchant Overview of Violet's Miva Merchant integration for channel developers Miva Merchant is a mid-market to enterprise ecommerce platform with a single-endpoint JSON API. All API calls are authenticated using HMAC-SHA256 request signing. ## Connection Merchants provide the following credentials: | Field | Description | | --------------- | ----------------------------------------------------------- | | **API Token** | The API access token from the Miva admin | | **Signing Key** | Base64-encoded HMAC-SHA256 signing key | | **Store Code** | The Miva store code (not the URL) | | **Store URL** | The API endpoint URL (e.g. `https://store.example.com/mm5`) | All credentials are available in the Miva admin under **User Management** (for the API token and signing key). ## Webhooks / Notifications Miva does not expose an API for programmatic webhook registration. Merchants must configure notifications manually in the Miva admin under **Utilities → Notifications**, pointing each topic to the Violet webhook gateway URL. Violet receives the following notification types: * `product.*` — triggers a product sync * `order.*` — triggers an order sync Inbound notifications are verified using HMAC-SHA256 with the merchant's signing key. ## Notable Behavior * **Single endpoint**: All Miva API calls are POSTed to a single endpoint (`/json.mvc`), differentiated by a `Function` parameter. Violet handles this internally. * **Product enrichment**: Miva requires separate API calls to fetch product images, attributes, and variants. Violet makes these calls in parallel to minimize latency during catalog sync. * **Currency**: The Miva API returns a numeric currency ID rather than an ISO currency code. Currency must be configured on the merchant record separately — it cannot be auto-detected from the platform. * **Order cancellation**: Miva does not provide an API for canceling orders. Cancellations must be handled through the Miva admin panel. * **Price format**: Miva uses decimal dollar values (e.g. `19.99`), not integer cents. # Shoprenter Overview of Violet's Shoprenter integration for channel developers Shoprenter is a hosted ecommerce platform popular in Central and Eastern Europe, particularly in Hungary. Violet integrates via Shoprenter's REST API using API credentials. ## Connection Merchants provide a **Username**, **Password**, and their **Store URL**. API credentials are generated in the Shoprenter admin dashboard. ## Notable Behavior * **Regional focus**: Shoprenter is primarily used by merchants in Hungary and the surrounding region. Store URLs typically follow a `{storename}.shoprenter.hu` pattern, though custom domains are supported. * **Product catalog**: Violet syncs products and variants from Shoprenter during catalog synchronization. # SAP Commerce Cloud Overview of Violet's SAP Commerce Cloud integration for channel developers SAP Commerce Cloud (formerly Hybris) exposes its storefront API through the **OCC v2** (Omni-Commerce Connect) REST layer. Violet integrates using OAuth2 client credentials against this API. ## Connection Merchants provide the following credentials: | Field | Description | | --------------------------------- | ---------------------------------------------------------------------------------- | | **Store URL** | OCC base URL (e.g. `https://api.merchant.com/occ/v2`) | | **Client ID** | OAuth2 client ID | | **Client Secret** | OAuth2 client secret | | **Base Site ID** | The OCC site ID (e.g. `electronics`, `apparel-uk`) | | **Service User UID** *(optional)* | A user UID scoped to order history access; falls back to `current` if not provided | There is no OAuth user-consent flow. Onboarding is credential-based. ### Token Management Violet mints OAuth tokens internally via the client credentials grant against `${baseUrl}/authorizationserver/oauth/token`. Tokens are cached and refreshed approximately 30 seconds before expiry. A 401 on any call invalidates the cached token and triggers a retry. ## Webhooks SAP Commerce Cloud OCC v2 does not push native webhooks by default. Violet attempts to register webhooks via the optional **SAP Webhook Services** extension (`webhookconfigurations` endpoint). If the extension is not installed, Violet logs a degraded-mode message and operators must configure outbound webhooks manually via BackOffice, pointing them at the Violet webhook ingress endpoint. Inbound webhook signatures use HMAC-SHA256 over the raw request body. The signature is passed in the `X-Sap-Cc-Webhook-Signature` header as a base64-encoded digest. ## Discounts Both custom (fixed/percentage) and synced promo codes are supported: * **Custom discounts**: applied before cart creation; the bag total is decremented directly. * **Discount codes**: forwarded to the OCC `vouchers` endpoint during cart processing. After order placement, Violet validates whether the code was applied from the `appliedVouchers` response and marks the discount accordingly. ## Notable Behavior * **Cart-based order submission**: Order submission follows the full OCC cart pipeline — create cart, add items, set addresses, set delivery mode, apply payment, apply vouchers, then place order. * **Delivery mode selection**: Violet matches the requested shipping method to an available OCC delivery mode by code, then by name. If no match is found, the first available mode is used. * **Payment**: OCC's payment model was designed for shopper-side card capture. Violet forwards the gateway transaction ID as a `subscriptionId`. Merchants whose storefronts require full PCI capture inside SAP Commerce Cloud must handle that separately before using Violet's Direct Order Submission. * **Customer listing**: Standard OCC v2 does not expose a bulk customer listing endpoint. Customer sync is driven from order history rather than a direct customer list. * **Service user UID**: The `fetchOrders` endpoint requires a user-scoped token. If using client-credentials only, provide a service user UID in the optional credential field. The literal `current` value only resolves under user-bearer grants, not client credentials. * **Collections**: Category hierarchy and media are not synced — only name, handle, and status. # Oracle Commerce Cloud Overview of Violet's Oracle Commerce Cloud integration for channel developers Oracle Commerce Cloud (OCC) is an enterprise ecommerce platform. Violet integrates using an application key registered in the OCC admin, which is exchanged for a short-lived access token via the OCC admin API. ## Connection Merchants provide two credentials: | Field | Description | | ------------------- | -------------------------------------------------------------------- | | **Store URL** | OCC instance hostname (e.g. `mystore.oracle.com`) | | **Application Key** | JWT generated when the integration is registered in the OCC admin UI | The application key is created in the OCC admin under the integrations or third-party applications section. Violet authenticates server-to-server via `/ccadmin/v1/login` using the application key as a bearer token with a `grant_type=client_credentials` body. > **Note**: Username/password authentication (`/ccadmin/v1/mfalogin`) is reserved for internal admin users and is not used by Violet. ### Scope Validation OCC permissions are determined by the application's assigned role at registration time, not per-call requested scopes. Violet validates credentials by performing a test authentication during connection — a successful token exchange confirms the key is valid and active. ## Webhooks OCC ships a fixed catalog of webhook slots. Violet registers the following slots automatically after a merchant connects: | Slot ID | Event | | ----------------- | -------------------- | | `order-submit` | New order placed | | `order-update` | Order status changed | | `shipment-create` | Shipment created | | `shipment-update` | Shipment updated | Registration is performed via `PUT /ccadmin/v1/webhooks/{slotId}`. Failures on individual slots are logged but do not abort overall registration. ## Notable Behavior * **Application key**: The application key is a JWT, not a username/password pair. It is generated once in the OCC admin when an integration is registered and does not expire on its own (expiry is determined by the application's configuration in OCC). * **Token refresh**: Violet does not use OAuth refresh tokens for this platform. Each request exchanges the application key for a short-lived access token as needed. * **Shipping methods**: Violet verifies that shipping methods are configured on the store during connection by querying the OCC shipping methods endpoint. # Rithum Overview of Violet's Rithum integration for channel developers Rithum (formerly CommerceHub) is a B2B marketplace and drop-shipping platform that connects suppliers with retailers. Unlike direct-to-consumer storefronts, Rithum operates as a fulfillment network — merchants are suppliers who fulfill orders placed through retail channel partners. > **Partner requirement**: Rithum is a partner-gated integration. To enable Rithum for your Violet application, you must first become a registered Rithum partner. Contact Violet support to initiate the partner enablement process once your Rithum partnership is established. ## Connection Rithum does not use a standard Violet Connect onboarding flow. There is no OAuth redirect or credential form presented to the merchant. Instead, connection and authentication are managed through the Rithum partner relationship — credentials are provisioned externally and configured at the platform level. Merchant profiles are fetched via the Rithum site profile API once the integration is active. ## Order Status Rithum uses a three-tier status model that maps independently to Violet's order lifecycle: | Rithum Status Type | Description | | ------------------- | ------------------------------------------------------- | | **Checkout status** | Whether the order has been acknowledged by the supplier | | **Payment status** | Payment state of the order | | **Shipping status** | Fulfillment and shipment state | Violet reconciles these three status dimensions into a unified order and bag state. ## Products Rithum supports the following product types: | Type | Description | | ------------------ | ----------------------------------------------------------- | | `VARIATION_PARENT` | Parent product grouping variants (not directly purchasable) | | `STANDARD` | Standard physical product | | `DIGITAL` | Downloadable or digital product | | `BUNDLE` | Bundle of multiple products | `VARIATION_PARENT` items are treated as offer containers and are not directly purchasable — child variants are exposed as SKUs. ## Discounts Rithum does not have a native discount or coupon code system. Discounts are applied as negative line-item values using Rithum's `additionalCostOrDiscount` field. Custom discounts (fixed or percentage) are supported; synced promo codes are not. ## Shipping When the requested shipping method cannot be matched to an available Rithum shipping option, Violet falls back to the first available shipping method configured on the supplier's account. ## Notable Behavior * **No standard auth flow**: Onboarding is managed through the Rithum partner relationship rather than Violet Connect. * **Drop-shipping model**: Rithum merchants are suppliers fulfilling orders on behalf of retail partners, not direct-to-consumer storefronts. * **Order acknowledgment**: Orders must be acknowledged by the supplier (reflected in checkout status) before fulfillment proceeds. # Lightspeed eCom Overview of Violet's Lightspeed eCom integration for channel developers Lightspeed eCom (formerly SEOshop) is a cloud-based ecommerce platform for retail merchants. Violet integrates using HTTP Basic authentication with an API key and secret provided by the merchant. ## Connection Merchants provide three credentials: | Field | Description | | -------------- | ------------------------------------------------------------------- | | **Store URL** | Lightspeed API base URL (e.g. `https://api.shoplightspeed.com/en/`) | | **API Key** | Generated in the Lightspeed merchant admin | | **API Secret** | Generated alongside the API key | Credentials are validated during onboarding by hitting the Lightspeed Account endpoint. There is no OAuth consent flow. Lightspeed does not have a scope model; all permissions are determined by the API key at the time it is created. ## Webhooks Violet registers webhooks automatically after a merchant connects. The following topics are subscribed: | Topic | Event | | ----------------- | ---------------------- | | `product.created` | Product created | | `product.updated` | Product updated | | `product.deleted` | Product deleted | | `order.created` | Order placed | | `order.updated` | Order updated | | `order.paid` | Order payment received | | `order.shipped` | Order shipped | | `return.created` | Return initiated | | `return.updated` | Return updated | | `return.deleted` | Return deleted | > **Note**: Lightspeed does not sign webhook deliveries — there is no HMAC signature to verify. Authenticity is established at registration time via the credentialed merchant URL. ## Direct Order Submission Order submission follows a multi-step checkout pipeline: 1. `POST /checkouts.json` — create checkout with customer and addresses 2. `POST /checkouts/{id}/products.json` — add each line item 3. `PUT /checkouts/{id}.json` — set shipping method 4. `PUT /checkouts/{id}.json` — set payment method (always external "Violet") 5. `GET /checkouts/{id}/validate.json` — must return `{validated: true}` 6. `POST /checkouts/{id}/order.json` — finalize and retrieve order ID 7. `PUT /orders/{id}.json` — mark payment status as paid ## Discounts Both custom discounts and synced promo codes are supported: * **Custom discounts** (fixed or percentage): Amount is calculated and the bag total is decremented before checkout creation. * **Discount codes**: Passed at checkout finalization. Lightspeed does not have a dedicated discount-code endpoint — the code is included when the checkout is submitted, and Violet reads the finalized order response to determine whether the code was applied. ## Products Lightspeed's product model separates the product container from its purchasable variants: * **Product**: Container only — holds name, description, and media. Not directly purchasable. * **Variant**: Holds price, inventory, and dimensions. These map to Violet SKUs. Variant titles use a `Type:Value, Type:Value` format (e.g. `Color:Red, Size:M`), which Violet parses into individual variant dimensions. ## Pagination Lightspeed uses `?page=N&limit=N` pagination with a hard limit of 250 results per page. Order polling uses `?updated_at_min` (ISO-8601 with `+0000` offset) to fetch only recently modified records. ## Notable Behavior * **No scope model**: Lightspeed does not use OAuth scopes. All permissions are implicit in the API key. * **Webhook signatures**: Inbound webhooks are not signed. Violet does not perform signature verification for this platform. * **Shipping validation**: Violet verifies that at least one shipping method is configured on the store during connection. * **Fulfillment status mapping**: Only `shipped` and `partially_shipped` shipment statuses are mapped to Violet's fulfillment states. Orders in `not_shipped` or `cancelled` states leave the bag's fulfillment status unset. # 3dcart / Shift4Shop Overview of Violet's 3dcart (Shift4Shop) integration for channel developers 3dcart, now rebranded as Shift4Shop, is a hosted ecommerce platform. Violet integrates using OAuth 2.0 — merchants authorize access via a standard redirect flow using your app's registered client credentials. > **Taxes and shipping**: 3dcart does not support dynamic tax calculation or real-time shipping rate retrieval. Channels are responsible for calculating and displaying taxes independently. Shipping rates must be configured statically — either by the merchant or by the channel — within Violet before checkout can complete. ## Connection 3dcart uses an OAuth redirect flow. Your Violet application must have a 3dcart client ID and client secret registered with Violet. When a merchant connects, Violet redirects them to: ``` https://apirest.3dcart.com/oauth/authorize ?client_id={clientId} &redirect_uri={callbackUrl} &response_type=code &store_url={merchantStoreUrl} ``` After the merchant approves, the authorization code is exchanged for an access token and stored as the merchant's credential. > **App credentials required**: Your Violet application must have 3dcart OAuth credentials (client ID and client secret) registered before merchants can connect. Contact Violet support to configure these. ## Webhooks Violet registers webhooks automatically after a merchant connects. The following events are subscribed: | Event | Trigger | | ----------------------- | ---------------------------------- | | `Order Status Change` | Order status updated | | `Product New` | Product created | | `Product Changed` | Product details updated | | `Product Stock Changed` | Product inventory quantity changed | | `Product Deleted` | Product removed | ## Order Submission Orders are submitted directly to the 3dcart store. The flow is: 1. Look up or create the customer by email 2. Compose and submit the order via the 3dcart Orders API 3. Set the order to `New` status at creation 4. Update to `Processing` status after payment is confirmed ## Products 3dcart uses a product + options model. SKU IDs in Violet are compound identifiers that encode the product catalog ID and any selected option values using `::` and `:` separators. Violet parses these internally when composing line items. ## Notable Behavior * **No dynamic taxes**: 3dcart does not return tax estimates at cart or checkout time. Channels must calculate and display taxes independently. * **No dynamic shipping rates**: 3dcart does not expose a live shipping rate endpoint. Shipping rates must be configured statically within Violet by the merchant or the channel. * **No order polling**: Fetching individual orders or paginating order history is not implemented for this platform. Order state is driven entirely by inbound webhooks. * **App credentials required**: Unlike some platforms where merchants supply their own API keys, 3dcart requires your Violet app to have registered OAuth credentials with 3dcart before any merchant can connect. # Shoptet Overview of Violet's Shoptet integration for channel developers Shoptet is a Czech ecommerce platform popular in Central and Eastern Europe. Violet supports two tiers of Shoptet merchants — **Standard** and **Premium** — and the integration capabilities differ significantly between them. > **Tier differences**: Standard tier merchants have no API access. Their catalog is synced via a product feed and order submission is not available. Premium tier merchants connect via API and support the full Violet feature set including real-time webhooks, direct order submission, and live cart calculation. Channels must be prepared to handle both merchant types if they intend to support Shoptet broadly. ## Standard Tier Standard tier Shoptet merchants do not have access to the Shoptet REST API. Violet connects them using a store URL and a Google Product Feed URL. **What is supported:** * Catalog sync via Google Product Feed (ingested at connection time and on a scheduled basis) **What is not supported:** * Real-time webhook events (no API, no webhooks) * Direct order submission * Live cart calculation or shipping rate retrieval * Credential validation (no API to test against) **Connection inputs required:** | Field | Description | | ------------- | --------------------------------------------- | | **Store URL** | The merchant's Shoptet storefront URL | | **Feed URL** | URL to the merchant's Google Product Feed XML | The feed is registered with Violet at onboarding and catalog ingestion begins immediately. *** ## Premium Tier Premium tier merchants have Shoptet REST API access and support the full integration. Two auth flows are available depending on how your app is configured. ### Flow A — Marketplace OAuth Addon Used when your Violet app is registered as a Shoptet marketplace addon. The merchant installs the addon from the Shoptet app store, which initiates an OAuth authorization flow. Violet exchanges the authorization code for a long-lived OAuth access token. Short-lived API Access Tokens (\~30 minutes) are minted on demand from this long-lived token and cached internally — no manual token refresh is required. > **App credentials required**: Your Violet app must have Shoptet OAuth credentials registered with Violet before merchants can connect via this flow. Contact Violet support to configure these. ### Flow B — Private API Token Used when merchants connect outside the Shoptet marketplace. The merchant generates a Private API Token in their Shoptet admin panel and provides it during Violet Connect onboarding. Credentials are validated against the Shoptet eshop endpoint at connection time. | Field | Description | | --------------------- | ----------------------------------------------- | | **Store URL** | The merchant's Shoptet storefront URL | | **Private API Token** | Long-lived token generated in the Shoptet admin | *** ## Webhooks (Premium only) Violet registers webhooks automatically for Premium tier merchants. The following events are subscribed: | Event | Trigger | | ---------------- | -------------------- | | `product:create` | Product created | | `product:update` | Product updated | | `product:delete` | Product deleted | | `order:create` | Order placed | | `order:update` | Order status changed | Shoptet webhook payloads are minimal (eshop ID, event type, timestamp). Violet fetches the full resource from the API on receipt. ## Direct Order Submission (Premium only) Orders are submitted directly to the Shoptet API. VAT rates are fetched per product variant at order time to ensure line items carry the correct tax percentage. Order cancellation resolves the merchant's configured cancellation status by name (matching keywords like `storno` or `cancel`). **Discount codes are not supported** for order submission — Shoptet's API does not validate codes pre-order and there is no reliable post-creation correlation. Code discounts are rejected up front before payment is captured. ## Cart Calculation (Premium only) Shoptet has no cart estimation endpoint. Violet computes cart totals locally: * **Subtotal**: Sum of SKU prices × quantities (prices are stored gross/VAT-inclusive). * **Tax**: Estimated by fetching the VAT rate per product variant and extracting the embedded VAT from each gross line item. If a variant lookup fails, the tax total falls back to 0 while gross totals remain intact. * **Shipping**: Sourced from the merchant's configured fallback shipping methods in Violet, filtered by the customer's country. The live Shoptet shipping endpoint is not used because it does not return reliable per-cart pricing. * **Discounts**: Custom (fixed/percentage) discounts are supported. Discount codes are not supported at cart calculation time. ## Products (Premium only) * Products are identified by **GUID** (not a numeric ID). Variants also have a GUID plus a `code` field used as the SKU identifier. * Prices are stored per-variant with an `includingVat` flag indicating whether the stored price is gross or net. Violet normalizes all prices to gross before storing in the catalog. * Promotional pricing (`actionPrice`) is supported — Violet uses the action price as the sale price when the current date falls within the validity window. * Images, variant parameters, and per-warehouse stock are returned only when explicitly requested via Shoptet's `include` parameter. ## Notable Behavior * **Standard vs Premium**: Channels must expect two distinct merchant types. Standard tier merchants will have catalog data but cannot receive orders through Violet's standard checkout flow. * **No discount codes**: Shoptet does not support discount code validation at order creation time. Synced promo codes are marked as not supported for all Shoptet merchants. * **VAT-inclusive pricing**: Shoptet is primarily used by European merchants. All prices are treated as VAT-inclusive and tax is extracted from gross line totals rather than added on top. * **Rate limiting**: Shoptet enforces a leaky-bucket rate limit (50 connections per IP, 3 per token) with 5-second write locks. # Quickstart The best way to get started with the Violet Checkout API is to work your way through the subsequent pages. You will complete each of the following: 1. Logging into the Violet API 2. Viewing Merchants connected to your app 3. Finding Products (we call them offers) and SKUs 4. Adding SKUs to a cart 5. Completing a checkout Navigate to 'Create a Violet Application' in the left nav to get started. # Create a Violet Application ## About Violet Applications Violet Applications provide you with the necessary credentials and tools to invoke our APIs and build your new system. Violet applications are the entry point to any system built on Violet and manage merchants you've connected to. You can learn more about Violet Applications here [Apps](/concepts/apps), but for now, follow the steps below to continue with this recipe and create your first Violet Application. ## Create an App 1. Sign up at [channel.violet.io/signup](https://channel.violet.io/signup) or login at [channel.violet.io/login](https://channel.violet.io/login) 2. You will be asked to Create an Org, select a slug you feel comfortable with for use across your team 3. Invite other member of your team (you can do this later, too) 4. Name your application (don't worry, you can change this later as many times as you'd like). 5. Save your App ID and App Secret, you will need them for API authentication. # Login This section walks you through testing the Violet APIs. Make sure you have already signed up at channel.violet.io/signup and created an application in the previous step. If you haven't, please go through Create a Violet Application. {% hint style="info" %} You will need your App ID and App Secret in order to complete this step. {% endhint %} ### Login This API tests your connection to Violet by logging into your Application. Add `X-Violet-App-Id` and `X-Violet-App-Secret` added to your headers for login. These are available from the application you created on channel.violet.io. Every request after login will require these header params for authentication, along with the `X-Violet-Token` that you get from login and refreshing your token. {% hint style="info" %} While your username and password will be the same across environments (test and live) as will your `X-Violet-App-Id`, this is **not** true for your `X-Violet-App-Secret`. The `X-Violet-App-Secret` you retrieve from the Channel dashboard is *different* depending on the live/test mode toggle. You must use the correct app secret that corresponds to the environment you are trying to login to: `test` for `sandbox-api.violet.io` and `live` for `api.violet.io`. {% endhint %} In addition to the headers mentioned above, include your `username` (your username is the email you signed up with) and `password`. If successful, an access token will be returned in the response body for use in additional requests against the API along with information about your API. {% hint style="warning" %} While the User Management feature of the Dashboard allows multiple users to login and view the dashboard,\ only an App's "Owner" username and password will allow you to generate a token.\ You can view who your App's owner is on the [team view](https://channel.violet.io/settings/team) {% endhint %} {% openapi src="/files/Z8lTzWUZ943hinGNXfLt" path="/login" method="post" expanded="true" %} [user-service.yaml](https://2435497985-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZrOgj5n6PuU2r0Ya8Tzl%2Fuploads%2Fgit-blob-670a4e234cc11a295d9996f677a5ab50b430eb8f%2Fuser-service.yaml?alt=media) {% endopenapi %} **Refresh your Token** Use the Refresh Token to get a new token. This is an operation you will have to do on a regular basis. You can use your App Id and App Secret with a refresh token to get a new token. This saves the step of having to send your username and password each time to get a new token. # View Merchants Before you get to creating orders we want you to understand the concepts of Merchants, Catalogs, and Products, as well as how they work within Violet. Merchants are storefronts that have integrated themselves with Violet, allowing for their catalog of products to be available through the Violet APIs. Additionally, Merchants have given Violet the access to write, read, place orders directly with their systems; allowing Violet (and you!) to seamlessly checkout. Merchants can be public or private when integrated with Violet. Public Merchants allow any Violet customer to view their catalog while private merchants require prior authorization for your Violet application to transact with them. Continue with this recipe to retrieve a list of test merchants, see what they look like in Violet, and learn how to use this information. In this Recipe, we are only interacting with a few of the available Merchant APIs. To learn more about Merchants in Violet and for the complete list of available APIs, please refer to our [Merchants](/prism/merchants) page. ## [View Merchants you are connected to](/prism/overview/view-merchants/get-merchants) {% hint style="info" %} You can get a list of all the merchants that your app has access to by using the above endpoint. {% endhint %} ## [Get Individual Merchant Info](/prism/overview/view-merchants/get-merchant-by-id) {% hint style="info" %} You can use this endpoint to view detailed information about any specific merchant using their merchant ID. {% endhint %} # Get Merchants What Merchants am I connected to? You can get a list of all the merchants that your app has access to by using the following endpoint. {% openapi src="/files/4aTPn9xdHLUUFFF1Dmrf" path="/merchants" method="get" expanded="true" %} [merchant-service.yaml](https://2435497985-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZrOgj5n6PuU2r0Ya8Tzl%2Fuploads%2Fgit-blob-247261bff470e8e872c7a1803ef78263c444666d%2Fmerchant-service.yaml?alt=media) {% endopenapi %} # Get Merchant by ID Get Individual Merchant Info {% openapi src="/files/4aTPn9xdHLUUFFF1Dmrf" path="/merchants/{merchant\_id}" method="get" expanded="true" %} [merchant-service.yaml](https://2435497985-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZrOgj5n6PuU2r0Ya8Tzl%2Fuploads%2Fgit-blob-247261bff470e8e872c7a1803ef78263c444666d%2Fmerchant-service.yaml?alt=media) {% endopenapi %} # Interact with Catalogs Catalogs are collections of purchasable Products available on Violet through integrated Merchants. Since multiple Merchants can sell the same product, each Merchant has a Product "Offer". These offers are often call Products in other e-commerce platforms. Each Offer is the parent entity for all of the nested SKUs associated with said Offer. It is the individual SKU, from an Offer, that be bought through your application when integrated with our checkout orchestration process. In this section, you will take the Merchant Id you retrieved from [View Merchants](/prism/overview/view-merchants) and do the following: 1. Retrieve offers available from Merchants and understand what this information means 2. Take a SKU from the product offer and use it in the next section to [Place an Order](/prism/overview/place-an-order) # List Connected Offers Search and list Offers across all connected merchants To retrieve Offers across all merchants you are connected to, use the Search Offers endpoint. This returns paginated results scoped to your channel — you will only see Offers from merchants that have an active connection with your application. {% hint style="warning" %} `POST /catalog/offers/search` returns eventually consistent data and is not real-time consistent. Use Offer Search for discovery, then use non-search Offer endpoints when you need real-time Offer data. {% endhint %} ## Endpoint ``` POST /v1/catalog/offers/search ``` ## Basic Request To list all connected Offers with no filters, send a `POST` request with an empty body: ```bash curl -X POST https://sandbox-api.violet.io/v1/catalog/offers/search?page=1&size=20 \ -H "X-Violet-App-Id: your-app-id-here" \ -H "X-Violet-App-Secret: your-app-secret-here" \ -H "X-Violet-Token: your-token-here" \ -H "Content-Type: application/json" \ -d '{}' ``` The response is a standard [paginated response](https://github.com/violetio/docs/blob/main/concepts/pagination.md) containing an array of Offer objects. ## Filtering Results The search body accepts optional filters to narrow results: ```json { "query": "sneakers", "min_price": 2500, "max_price": 15000, "available": true } ``` {% hint style="info" %} Prices are in the smallest currency unit (e.g., cents). A `min_price` of `2500` means $25.00 USD. {% endhint %} For the full list of supported filter options, see the [Search Offers API Reference](https://github.com/violetio/docs/blob/main/api-reference/catalog-service/catalog-offers/search-offers.md). ## Currency Conversion Pass the `base_currency` query parameter to receive prices in your preferred currency. The default is USD. ``` POST /v1/catalog/offers/search?base_currency=GBP ``` All prices in the response will reflect the specified currency. ## Enhanced Search (Beta) An optional enhanced search mode provides faster response times and NLP-based querying. To enable it, pass `beta=true` as a query parameter: ``` POST /v1/catalog/offers/search?beta=true ``` See the [Search Offers API Reference](https://github.com/violetio/docs/blob/main/api-reference/catalog-service/catalog-offers/search-offers.md) for current capabilities and limitations of enhanced search. ## When to Use This vs. Get Merchant Offers | Use Case | Endpoint | | --------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | | Browse or search across **all** connected merchants | `POST /catalog/offers/search` | | List offers from a **specific** merchant | [`GET /catalog/offers/merchants/{merchant_id}`](/prism/overview/interact-with-catalogs/get-offers-for-a-merchant) | | Fetch a **single** offer by ID | `GET /catalog/offers/{offer_id}` | ## Keeping Your Catalog Up to Date {% hint style="info" %} Violet **strongly** discourages scraping the search endpoint to keep your catalog current. Instead, use [Offer Webhooks](/prism/webhooks/events/offer-webhooks) to receive real-time notifications when Offers are added, updated, or removed. {% endhint %} **Recommended pattern:** 1. Perform an initial pull using this endpoint to populate your catalog 2. Subscribe to `OFFER_AVAILABLE`, `OFFER_UPDATED`, and `OFFER_REMOVED` webhooks 3. Use the [Get Offer by ID](https://github.com/violetio/docs/blob/main/api-reference/catalog-service/catalog-offers/get-offer-by-id.md) endpoint to fetch full details when a webhook fires This approach keeps your catalog current without unnecessary API calls. ## Troubleshooting: Empty Results If your search returns an empty `content` array regardless of what filters you use, the issue is usually with **your connections** — not your search parameters. The endpoint returns `200 OK` with empty content when there are no matching offers, which can be misleading. ### Check your parameter casing The Violet API uses **snake\_case** for all request body parameters. Unrecognized parameters are silently ignored, so camelCase variants won't cause an error — they simply have no effect. | Incorrect (camelCase) | Correct (snake\_case) | | --------------------- | --------------------- | | `merchantId` | `merchant_id` | | `minPrice` | `min_price` | | `maxPrice` | `max_price` | {% hint style="warning" %} If your filters seem to have no effect, check your casing first. This is the most common cause of unexpected results. {% endhint %} ### Verify your merchant connections Check whether your app is connected to any merchants in the environment you're testing against: ```bash curl -X GET https://sandbox-api.violet.io/v1/merchants \ -H "X-Violet-App-Id: your-app-id-here" \ -H "X-Violet-App-Secret: your-app-secret-here" \ -H "X-Violet-Token: your-token-here" ``` If this returns an empty list, you have no active merchant connections in this environment. ### Check your environment Merchant connections are **environment-specific**. A merchant connected in live mode is not automatically connected in sandbox, and vice versa. Make sure you're querying the same environment where your merchants are connected (`sandbox-api.violet.io` vs `api.violet.io`). {% hint style="info" %} **New to sandbox?** All sandbox applications come pre-connected to Violet's demo merchants. If `GET /merchants` returns demo merchants but offer search is still empty, the demo catalog may still be syncing. Try filtering by one of the demo merchant IDs using `GET /catalog/offers/merchants/{merchant_id}` to confirm. {% endhint %} # Get Offers for a Merchant Get Offers for a Merchant by Merchant Id *Note: For more details on this endpoint and the other possible filter options it can take, please refer to the* [*API Reference*](/api-reference/catalog/offers/get-all-merchant-offers) {% hint style="info" %} When retrieving Offers, if you provide the `base_currency` query parameter the currency in the Offer object will match what was passed in and all prices will reflect that currency. The default currency when no parameter is provided is `USD`. {% endhint %} {% hint style="info" %} Violet **strongly** discourages scraping this endpoint. Most offers do not change very often,\ so re-scraping all of a merchants offers on a regular basis is a very costly way to keep your catalog up to date. Violet's recommendation is to make use of [offer webhooks](/prism/webhooks/handling-webhooks) to be notified when offers are added/updated in Violet's system.\ This works because when your merchants onboard, their products are pulled into Violet's system and so you will receive a webhook for each of the new merchant's offers.\ Additionally, Violet employs a number of methods to keep our merchant's catalogs up to date and all of those methods will generate webhooks sent to your system. {% endhint %} {% openapi src="/files/WvoCWRwklnzhcKrWChSh" path="/catalog/offers/merchants/{merchant\_id}" method="get" expanded="true" %} [catalog-service.yaml](https://2435497985-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZrOgj5n6PuU2r0Ya8Tzl%2Fuploads%2Fgit-blob-c6e2fedb8258cc2d1a44f80a88a6690e23686c69%2Fcatalog-service.yaml?alt=media) {% endopenapi %} # Get Details About a SKU Get details about a SKU given SKU ID *Note: For more details on this endpoint and the other possible filter options it can take, please refer to the* [*API Reference*](/api-reference/catalog/skus/get-sku-by-id) {% openapi src="/files/WvoCWRwklnzhcKrWChSh" path="/catalog/skus/{sku\_id}" method="get" expanded="true" %} [catalog-service.yaml](https://2435497985-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZrOgj5n6PuU2r0Ya8Tzl%2Fuploads%2Fgit-blob-c6e2fedb8258cc2d1a44f80a88a6690e23686c69%2Fcatalog-service.yaml?alt=media) {% endopenapi %} # Try 'Iterative Checkout' {% hint style="info" %} If this is your first time trying Violet's Checkout API, we recommend following this guide step by step. Our docs allow you to try endpoints by entering your own values and submitting the request directly. You can also use cURL or any HTTP client of your choice — the request and response examples throughout serve as a reference for properly formatted requests when building your own integration with Violet. {% endhint %} So far you have been able to view all the Merchants available for your application, view their catalog of products and select one specific product. Here you will learn how to go through the entire flow of purchasing a product through Violet. To get started with the Checkout process, we will create a cart and add products to it. For this section, we have taken the SKU that we retrieved details for in [Interact with Catalogs](/prism/overview/interact-with-catalogs). {% hint style="warning" %} Currently Violet passes all failures in checkout relating to surpassing rate limits downstream. When integrating with Violet you must consider and prepare for such scenarios in all API calls to Violet. [Handling rate limits with Violet](/concepts/rate-limits) {% endhint %} {% hint style="warning" %} A cart response can come back with status code `200` and still have errors in the `errors` field. This is because there might only be errors on some of the SKUs or Bags while the rest of the order is in a good state. Make sure your system is coded to always check for the presence of the `errors` field on responses, no matter the status code. Note that not all order errors are blocking. `INTERNAL_ADD_ITEM` for example just indicates that an item could not be added to the cart, this does not block checkout of other items. {% endhint %} # Create Cart Create a new Cart with SKU 10064 in it. *Note: For more details on this endpoint please refer to the the* [*API Reference*](/api-reference/orders-and-checkout/carts/create-cart) Cart creation begins the checkout process. Products can be added to the cart at creation with a JSON Body listing 1 or more sku\_id & quantity pairs. {% hint style="info" %} It is not required that you add a SKU to create a cart, since it is possible for your customers cart to be empty, however, in this example, we will purchase a product with the SKU 10064 (which we noted down from the previous section) {% endhint %} {% openapi src="/files/SFt1gqvuZ3Y8AQjdppVs" path="/checkout/cart" method="post" expanded="true" %} [order-service.yaml](https://2435497985-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZrOgj5n6PuU2r0Ya8Tzl%2Fuploads%2Fgit-blob-4abe5aea8922866d3520a6e30cc002332bcb9d5f%2Forder-service.yaml?alt=media) {% endopenapi %} # Apply Customer Info Here we will apply customer info to the cart (including the address). *Note: For more details on this endpoint please refer to the API Reference* Once you have a cart with products in it you need to apply the customer information. For a brand new customer this would likely include Apply Guest Customer to Cart , Set Shipping Address , and Set Billing Address. For the sake of ease in this example we will simplify address handling and use the same address for billing and shipping and pass this along with the customer the body of the request. For more details on what fields this API can take, refer to the documentation linked above. In this example, we have used the cart we created in the previous step. *Your Cart Id will be unique and need to be updated in the request below.* Using `same_address: true` we can set the shipping and billing address simultaneously. {% hint style="info" %} See our [Quick Checkout Guide](/prism/checkout-guides/guides/utilizing-quick-checkout) for tips on how you can combine this step with the create cart call to reduce e-comm requests and use less rates {% endhint %} {% openapi src="/files/SFt1gqvuZ3Y8AQjdppVs" path="/checkout/cart/{cart\_id}/customer" method="post" expanded="true" %} [order-service.yaml](https://2435497985-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZrOgj5n6PuU2r0Ya8Tzl%2Fuploads%2Fgit-blob-4abe5aea8922866d3520a6e30cc002332bcb9d5f%2Forder-service.yaml?alt=media) {% endopenapi %} # Get Shipping Method This will get the available shipping methods, it will return an array of shipping methods for each bag in the cart. *Note: For more information on this endpoint go to the* [*API Reference*](/api-reference/orders-and-checkout/cart-shipping/get-available-shipping-methods) Once the Shipping and Billing Address are set, then you can get the shipping methods available for a cart (and bags within the cart). {% openapi src="/files/SFt1gqvuZ3Y8AQjdppVs" path="/checkout/cart/{cart\_id}/shipping/available" method="get" expanded="true" %} [order-service.yaml](https://2435497985-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZrOgj5n6PuU2r0Ya8Tzl%2Fuploads%2Fgit-blob-4abe5aea8922866d3520a6e30cc002332bcb9d5f%2Forder-service.yaml?alt=media) {% endopenapi %} # Apply Shipping Method Set the shipping method for each bag within a cart. By passing in an array of Objects containing the bag id and associated shipping id. *Note: For more information on this endpoint go to* [*Set Shipping Methods*](/api-reference/orders-and-checkout/cart-shipping/set-shipping-methods) Once you have all the available shipping methods for the bags within the cart, you can select and apply them to the cart. Note: Your `bag_id` and `cart_id` will be different from the example you have been following so far. Please update the calls with your information. {% openapi src="/files/SFt1gqvuZ3Y8AQjdppVs" path="/checkout/cart/{cart\_id}/shipping" method="post" expanded="true" %} [order-service.yaml](https://2435497985-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZrOgj5n6PuU2r0Ya8Tzl%2Fuploads%2Fgit-blob-4abe5aea8922866d3520a6e30cc002332bcb9d5f%2Forder-service.yaml?alt=media) {% endopenapi %} # Apply Payment Method Apply a Payment Method for the Cart. Set the payment method for your customer. Violet doesn't recommend using card numbers directly in API calls, even during testing. For this example, we have instead used a sample card token available through [Stripe](https://stripe.com/docs/testing). When building out your live integration to Violet, learn about all the payment options available to you [here](/prism/payments). {% openapi src="/files/SFt1gqvuZ3Y8AQjdppVs" path="/checkout/cart/{cart\_id}/payment" method="post" expanded="true" %} [order-service.yaml](https://2435497985-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZrOgj5n6PuU2r0Ya8Tzl%2Fuploads%2Fgit-blob-4abe5aea8922866d3520a6e30cc002332bcb9d5f%2Forder-service.yaml?alt=media) {% endopenapi %} # Submit Cart Submit a Cart, turning the Cart into an Order For this example we didn't price our cart at any point. It will be done automatically before completing the checkout. {% hint style="info" %} When building your own integration with Violet, there are instances where carts are not priced automatically after applying shipping methods. You will know this is needed when the response from the apply shipping methods call has a 0 value for `tax_total`. If that happens, make a call to [price cart](/api-reference/orders-and-checkout/cart-pricing/price-cart) before calling `submit`. {% endhint %} {% openapi src="/files/SFt1gqvuZ3Y8AQjdppVs" path="/checkout/cart/{cart\_id}/submit" method="post" expanded="true" %} [order-service.yaml](https://2435497985-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZrOgj5n6PuU2r0Ya8Tzl%2Fuploads%2Fgit-blob-4abe5aea8922866d3520a6e30cc002332bcb9d5f%2Forder-service.yaml?alt=media) {% endopenapi %} # Violet Connect {% hint style="warning" %} **Important for Shopify Channels**: As of January 2026, Shopify requires all new merchant connections to use single-merchant custom apps. You MUST pre-register Shopify merchants in the Channel Dashboard before they can connect. See the [Shopify Custom App Migration Guide](https://github.com/violetio/docs/blob/main/channel-docs/prism/violet-connect/guides/shopify-custom-app-migration.md) for complete instructions. {% endhint %} Violet Connect is an onboarding tool that you can use to securely and safely onboard merchants onto your marketplace experience with ease. The tool acts as a bridge between a merchants store and Violet so that you can have them sync their catalog, connect payout accounts and set up commission rates; all without any additional work on your end. ### Key Features #### For Shopify Merchants (Pre-Registration Required) * **Pre-register merchants** in your Channel Dashboard with their app credentials * **Send merchant-specific links** that streamline the onboarding to under 2 minutes * **Track installation status** from pending to active in real-time * See [complete Shopify documentation](/ecom-platforms/shopify) #### For All Other Platforms * Merchants enter their platform credentials directly in Violet Connect * Standard onboarding flow with platform-specific requirements * Full catalog sync and checkout capabilities once connected ### Customization Violet provides you with the option to fully customize the onboarding experience for your merchants so that they are only interacting with your brand label. Your Violet Connect page will be customized with the following: * A unique URL path of your choice * The name of your application * A description of your experience * Your logo or icon By default, Violet automatically shows every e-commerce platform we have integrations with on your Violet Connect dashboard, however, you can contact us to have a predefined list of supported platforms you want to show your merchants. Once completed, Violet redirects your merchants to a redirect URL that you have configured, along with any additional data you may need from our end about the merchant, such as the Violet specific merchant Id. See the [Setup](/prism/violet-connect/setup) page for required configurations to enable Violet Connect for your channel. # Setup Follow these steps to get your Channel ready to connect merchants {% hint style="warning" %} **Shopify Pre-Registration Required**: As of January 2026, Shopify requires all new merchant connections to use single-merchant custom apps. You MUST pre-register Shopify merchants before they can connect. See [Pre-Registering Shopify Merchants](#pre-registering-shopify-merchants-required) below. {% endhint %} ## Pre-Registering Shopify Merchants (Required) Shopify now requires all merchants to use single-merchant custom apps. **You must pre-register merchants in the Channel Dashboard before they can connect through Violet Connect.** {% hint style="info" %} **Follow the full step-by-step guide:** [Pre-Registration Process](/ecom-platforms/shopify/pre-registration) {% endhint %} ### Quick Steps for Shopify Pre-Registration: 1. **Create a single-merchant custom app** in your Shopify Partner Dashboard for each merchant 2. **Pre-register the merchant** in Channel Dashboard → Merchants → Pre-Registered tab 3. **Send the Violet Connect link** to your merchant for 2-minute authorization Pre-registration provides: * OAuth credentials configured upfront for each merchant * Merchant-specific Violet Connect links (fastest onboarding path) * Real-time tracking of installation status **Background on this requirement**: [Shopify Custom App Migration Guide](/prism/violet-connect/guides/shopify-custom-app-migration) ## ## Set up Violet Connect Violet Connect is customized to the user experience you want to provide so that your merchants are interacting with ***your*** brand. In order to get yourself set up with Violet Connect, you will need upload the following to your [Channel Dashboard](https://channel.violet.io/app-settings): The channel will be responsible for providing the following values that will populate and configure the onboarding experience. These values can be configured by you in the Channel dashboard. There may be additional configuration options that will be discussed during your integration. * App Name — This is displayed in the top left hand corner of your Violet Connect dashboard * Square Logo or Icon — This is displayed in the top left hand corner of your Violet Connect dashboard * Redirect URL — This is the page your merchant is taken to once the onboarding process is complete. Violet will append any information you need from our end, such as the merchant Id, to query parameters of this URL. See below. * App Description * More Info URL Once all these have been set, you can contact Violet on
Sample Response
```json { "merchant_onboarding_id": 10000, "channel_merchant_id": "chnl_123456789", "app_id": 10385, "date_created": "2024-06-24T15:30:55+0000", "date_last_modified": "2024-06-24T15:30:57+0000" } ```Sample Request
```json POST /v1/merchants/onboard { "channel_merchant_id": "chnl_123456789", "payout_details": { "payment_provider": "STRIPE", "payment_provider_metadata": { "stripe_account_id": "acct_123456789" } } } ```Sample Response
```json { "merchant_onboarding_id": 10000, "channel_merchant_id": "chnl_123456789", "app_id": 10385, "payout_details": { "payment_provider": "STRIPE", "payment_provider_metadata": { "stripe_account_id": "acct_123456789" } }, "date_created": "2024-06-24T15:30:55+0000", "date_last_modified": "2024-06-24T15:30:57+0000" } ```Sample Request
This call will update an existing Merchant Onboarding record with additional Payout Details: ```json PUT /v1/merchants/onboard/merchant_onboarding_id/10000 { "channel_merchant_id": "chnl_999999999", "payout_details": { "payment_provider": "STRIPE", "payment_provider_metadata": { "stripe_account_id": "acct_123456789" } } } ```Sample Response
```json { "merchant_onboarding_id": 10000, "channel_merchant_id": "chnl_999999999", "app_id": 10385, "payout_details": { "payment_provider": "STRIPE", "payment_provider_metadata": { "stripe_account_id": "acct_123456789" } }, "date_created": "2024-06-24T15:30:55+0000", "date_last_modified": "2024-06-24T15:30:57+0000" } ```| Request | Error Code | Error Title | Error Message | Reason | How to Fix |
|---|---|---|---|---|---|
PUT | 4429 | merchant_onboarding_record_not_found | Merchant onboarding record with ID {} not found. | The provided merchant_onboarding_id doesn’t exist in our system. | Create a new merchant_onboarding_record using the POST /merchant/onboarding API. |
POST | 2514 | merchant_already_onboarded | This merchant already exists in Violet (Merchant Id: {}). Once a merchant has been onboarded, you must directly interact with the Merchant endpoints available here to retrieve or update merchant details. | Call is made after the merchant has already been onboarded through Violet Connect and that merchant in Violet has the same channel_merchant_id as this merchant onboarding update request. | Directly interact with the Merchant endpoints available in Violet Docs to retrieve/update merchant details. |
| Field | Can be updated? | Behavior if passed in | Notes |
|---|---|---|---|
merchant_onboarding_id | No | Used for record retrieval | If a merchant_onboarding_id is passed in and a record is not found, a merchant_onboarding_record_not_found exception will be thrown. |
channel_merchant_id | Yes | Updated | |
date_created | No | Ignored | |
date_last_modified | No | Ignored |
| Field | Type | Required | Description |
|---|---|---|---|
merchant_onboarding_id | Path Parameter | Yes | The unique identifier for this merchant’s onboarding record. This value was returned as a part of the Create External Account call. |
Sample Response
```json { "merchant_onboarding_id": 10000, "app_id": 10385, "channel_merchant_id": "chnl_123456789", "payout_details": { "payment_provider": "STRIPE", "payment_provider_metadata": { "stripe_account_id": "acct_123456789" } }, "date_created": "2024-06-24T15:30:55+0000", "date_last_modified": "2024-06-24T15:30:57+0000" } ```| Request | Error Code | Error Title | Error Message | Reason | How to Fix |
|---|---|---|---|---|---|
PUT | 4429 | merchant_onboarding_record_not_found | Merchant onboarding record with ID {} not found. | The provided merchant_onboarding_id doesn’t exist in our system. | Create a new merchant_onboarding_record using the POST /merchant/onboarding API. |
POST | 2514 | merchant_already_onboarded | This merchant already exists in Violet (Merchant Id: {}). Once a merchant has been onboarded, you must directly interact with the Merchant endpoints available here to retrieve or update merchant details. | Call is made after the merchant has already been onboarded through Violet Connect and that merchant in Violet has the same channel_merchant_id as this merchant onboarding update request. | Directly interact with the Merchant endpoints available in Violet Docs to retrieve/update merchant details. |
Sample Response
```json { "content": [ { "merchant_onboarding_id": 10000, "app_id": 10385, "channel_merchant_id": "chnl_123456789", "payout_details": { "payment_provider": "STRIPE", "payment_provider_metadata": { "stripe_account_id": "acct_123456789" } }, "date_created": "2024-06-24T15:30:55+0000", "date_last_modified": "2024-06-24T15:30:57+0000" }, { "merchant_onboarding_id": 10001, "app_id": 10385, "channel_merchant_id": "chnl_1111111111", "payout_details": { "payment_provider": "STRIPE", "payment_provider_metadata": { "stripe_account_id": "acct_1111111111" } }, "date_created": "2024-06-24T15:30:55+0000", "date_last_modified": "2024-06-24T15:30:57+0000" }, { "merchant_onboarding_id": 10003, "app_id": 10385, "channel_merchant_id": "chnl_222222222", "payout_details": { "payment_provider": "STRIPE", "payment_provider_metadata": { "stripe_account_id": "acct_222222222" } }, "date_created": "2024-06-24T15:30:55+0000", "date_last_modified": "2024-06-24T15:30:57+0000" } ], "pageable": { "page_number": 0, "page_size": 3, "sort": { "unsorted": false, "sorted": true, "empty": false }, "offset": 0, "paged": true, "unpaged": false }, "total_pages": 1, "total_elements": 3, "last": false, "number_of_elements": 3, "first": true, "size": 3, "number": 0, "sort": { "unsorted": false, "sorted": true, "empty": false }, "empty": false } ```Shopify merchants who have been pre-registered by their channel may skip this step automatically.
Pre-registered Shopify merchants: your store URL will be pre-filled.
Shopify merchants: If you were pre-registered, you'll see a "Connect to Shopify" button instead. When installing the app, leave "Embed app in Shopify admin" unchecked.
When will Violet be able to provide full integration with Squarespace?
Violet currently supports a full integration with Squarespace.How do I connect a new merchant to my app?
You can view a step-by-step guide [here](/prism/violet-connect/guides/violet-connect-for-merchants) or watch a video example in the [Violet Connect for Channels](/prism/violet-connect/guides/violet-connect-for-channels) guide.How do I pre-register Shopify merchants in the Channel Dashboard?
You can pre-register Shopify merchants in the Channel Dashboard by navigating to **Merchants → Pre-Registered tab → Add Pre-Registration**. This allows you to configure OAuth credentials upfront and provide merchants with direct installation links. Shopify now requires merchants to use single-merchant custom apps instead of the previous channel-controlled approach. Pre-registration streamlines this required process for your merchants. See the [Shopify Merchant Onboarding Guide](/ecom-platforms/shopify) for complete step-by-step instructions.How do I disconnect a merchant from my app?
You can disconnect a merchant from your Channel by using the Request Merchant App Uninstall [endpoint](/api-reference/apps/merchant-app-installs/request-merchant-app-uninstall).How do I let my merchant change the email they used for Violet Connect Onboarding?
To prevent issues of “dead emails” we *highly* recommend that merchants use a group based email address that multiple people have access to when initially setting up their accounts. `violet.merchant@companydomain.com` for example. We recommend adding this to you onboarding procedures as a recommendation to pass on. Currently we have a manual process on Violet’s end that allows us to accomplish this task, however there are a few security related considerations. 1. The new email must be @companydomain.com. To avoid scams, we cannot transfer a merchant to [gmail.com](http://gmail.com) email address or any other public email provider. 2. The merchant cannot yet have setup their payout account; this is to prevent financial fraud. You can check this in the Merchants tab, if the `Payout Account` is marked “Needs Attention” they have not yet created their account. 1. For cases where a payout account exists, we may require the merchant to complete additional verification steps before we can complete a transfer. We have a project in our backlog to support merchants transferring ownership themselves, but for now it will be a manual process. Assuming they fulfill the above conditions, to complete this process we will need from you: 1. The MerchantId and Name 2. The original email used (optional but useful) 3. The desired new email (must meet above conditions) 4. A screenshot of their payout account tab, to verify the above conditions. Make sure the merchant name and Id is visible in the shot. Contact us with the above information and we will take a look.Why is the ‘Write Customers’ permission required during onboarding?
Write Customers allows the order to be associated with a customer record in their system. This comes with things like their email, etc. Most Merchants want to make sure that data is carried through, and in order to do that, we have to be able to Write Customers as a part of the Order Creation process in their system. We’ve historically requested this scope. Shopify did eventually give us the ability to write customers under the `write_orders` scope however we’ve continued requesting the `write_customers` scope for forwards compatibility. On July 1st Shopify will be rolling out a new suite of customer protection rules that will impact API functionality and having the `write_customers` scope ensures that there will be no disruptions to our integration with Shopify when this goes into effect. We will likely revisit our scopes once we’ve reached July 1st. If it’s safe to do so we can likely reduce this scope down to `read_customers`. We prefer to over-optimize on scopes as asking all merchants to go back and change their scopes after onboarding has been a painful experience in the past. If the merchant is not comfortable with `write_customers`, they could complete the onboarding in Violet Connect, get past the scope validation part, then go back into their Shopify Custom Apps view and uncheck the `write_customers` scope. We don’t write any customers during that brief window that we have the `write_customers` scope so there will be no impact on their system. If we find that we require the scope once Shopify’s changes go into effect on July 1st we can then explain the need for it to the merchant and ask them to re-enable the scope for `write_customers`.Where can my merchant see their payouts?
Merchants have access to the same [distributions](/prism/payments/payouts/distributions) exports as channels. Merchants can also view their payout on Stripe's Stripe Express Dashboard. * Have the merchant go toWhat does the Channel Login Detected message mean?
If you see the Channel Login Detected dialog, that means that an account with the entered email already exists in Violet as a channel account. An account (email) cannot be both a merchant and a channel. If you are a channel and you are trying to create a test store, you must use a different email address for the test merchant. Adding `+merchant` before the @ is often an easy way to accomplish this as the email will still go to the same inbox. E.g.Should we restrict merchants to Stripe Express accounts during onboarding?
Yes, we strongly recommend limiting merchants to Stripe Express accounts only during the payout step of merchant onboarding. Violet can enforce this restriction upon confirmation from your team. **Why Stripe Standard Accounts Create Risk:** Stripe Standard accounts present significant operational challenges because merchants retain full control over payout schedules. These accounts typically enable auto-payouts, preventing balance accumulation in their Stripe account. This creates a critical issue: Stripe prohibits auto-debiting from Standard accounts, so any transfer reversal attempts will fail when no balance exists. Your channel would then bear responsibility for these funds and must manually recover them from the merchant. **Benefits of Stripe Express Accounts:** Stripe Express accounts eliminate these risks by enabling auto-debits, including allowing for negative balances, and giving your team control over payout schedules. This configuration ensures smoother operations and reduces your financial exposure.Does Violet work with Global-e?
Yes, Violet works with Global-e via an indirect integration model. Violet does not interact directly with Global-e but interacts with the ecom platforms that interact with Global-e.Sample Response
```json { "id": 39041, "product_id": "206bc004966b4883a737d7ec1f25c557", "external_id": "8335219130669", "external_url": "https://the-violet-garden.myshopify.com/products/dancing-sneaker-green", "name": "Dancing Sneaker Green", "description": "Dancing sneakers in a beautiful green.", "html_description": "Dancing sneakers in a beautiful green.
", "source": "SHOPIFY", "seller": "the violet garden", "vendor": "The Violet Garden", "merchant_id": 10189, "available": true, "visible": true, "min_price": 13500, "max_price": 13500, "currency": "USD", "source_category_name": "", "meta": [], "variants": [ { "id": 858860, "external_id": "10558450303277", "name": "Style", "visual": true, "values": [ { "id": 6049067, "external_id": "Design Two", "name": "Design Two", "sku_ids": [ 196611, 196598, 196602, 196600, 196616, 196606 ], "display_order": 2 }, { "id": 6049070, "external_id": "Design One", "name": "Design One", "sku_ids": [ 196609, 196613, 196597, 196612, 196601, 196605 ], "display_order": 1 }, { "id": 6049069, "external_id": "Design Four", "name": "Design Four", "sku_ids": [ 196595, 196599, 196596, 196603, 196607, 196604 ], "display_order": 4 }, { "id": 6049068, "external_id": "Design Three", "name": "Design Three", "sku_ids": [ 196594, 196610, 196608, 196593, 196615, 196614 ], "display_order": 3 } ], "display_order": 2 }, { "id": 858861, "external_id": "10558450270509", "name": "Size", "visual": false, "values": [ { "id": 6049076, "external_id": "43", "name": "43", "sku_ids": [ 196614, 196597, 196600, 196604 ], "display_order": 6 }, { "id": 6049071, "external_id": "38", "name": "38", "sku_ids": [ 196594, 196602, 196601, 196607 ], "display_order": 1 }, { "id": 6049074, "external_id": "41", "name": "41", "sku_ids": [ 196609, 196608, 196598, 196599 ], "display_order": 4 }, { "id": 6049075, "external_id": "42", "name": "42", "sku_ids": [ 196610, 196613, 196596, 196616 ], "display_order": 5 }, { "id": 6049073, "external_id": "40", "name": "40", "sku_ids": [ 196615, 196603, 196606, 196605 ], "display_order": 3 }, { "id": 6049072, "external_id": "39", "name": "39", "sku_ids": [ 196611, 196595, 196593, 196612 ], "display_order": 2 } ], "display_order": 1 } ], "skus": [ { "id": 196603, "offer_id": 39041, "merchant_id": 10189, "external_id": "45101326008621", "name": "Dancing Sneaker Green - 40 / Design Four", "gtin": "", "upc": "", "in_stock": true, "qty_available": 10, "inventory_tracked": true, "sale_price": 13500, "retail_price": 13500, "currency": "USD", "taxable": true, "tax_type": "DEFAULT", "albums": [ { "id": 91022, "parent_id": 196603, "type": "SKU", "name": "Dancing Sneaker Green - 40 / Design Four Media", "media": [ { "id": 185738, "album_id": 91022, "external_id": "41484160827693", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_158776f7-2cd6-4c39-9c89-ab1a95924100.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_158776f7-2cd6-4c39-9c89-ab1a95924100.png", "type": "IMAGE", "display_order": 1, "primary": true } ], "primary_media": { "id": 185738, "album_id": 91022, "external_id": "41484160827693", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_158776f7-2cd6-4c39-9c89-ab1a95924100.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_158776f7-2cd6-4c39-9c89-ab1a95924100.png", "type": "IMAGE", "display_order": 1, "primary": true } } ], "variant_values": [ { "variant": "Size", "value": "40" }, { "variant": "Style", "value": "Design Four" } ], "type": "PHYSICAL", "status": "AVAILABLE", "date_created": "2023-05-01T20:08:23+0000", "date_last_modified": "2023-08-07T15:02:53+0000", "sku_dimensions": { "weight": 3.0, "type": "SKU" } }, { "id": 196614, "offer_id": 39041, "merchant_id": 10189, "external_id": "45101326401837", "name": "Dancing Sneaker Green - 43 / Design Three", "gtin": "", "upc": "", "in_stock": true, "qty_available": 10, "inventory_tracked": true, "sale_price": 13500, "retail_price": 13500, "currency": "USD", "taxable": true, "tax_type": "DEFAULT", "albums": [ { "id": 91033, "parent_id": 196614, "type": "SKU", "name": "Dancing Sneaker Green - 43 / Design Three Media", "media": [ { "id": 185749, "album_id": 91033, "external_id": "41484160958765", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_85d6d1fe-b49c-4d4b-97b6-0bef6815cfbb.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_85d6d1fe-b49c-4d4b-97b6-0bef6815cfbb.png", "type": "IMAGE", "display_order": 1, "primary": true } ], "primary_media": { "id": 185749, "album_id": 91033, "external_id": "41484160958765", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_85d6d1fe-b49c-4d4b-97b6-0bef6815cfbb.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_85d6d1fe-b49c-4d4b-97b6-0bef6815cfbb.png", "type": "IMAGE", "display_order": 1, "primary": true } } ], "variant_values": [ { "variant": "Style", "value": "Design Three" }, { "variant": "Size", "value": "43" } ], "type": "PHYSICAL", "status": "AVAILABLE", "date_created": "2023-05-01T20:08:24+0000", "date_last_modified": "2023-08-07T15:02:53+0000", "sku_dimensions": { "weight": 3.0, "type": "SKU" } }, { "id": 196599, "offer_id": 39041, "merchant_id": 10189, "external_id": "45101326139693", "name": "Dancing Sneaker Green - 41 / Design Four", "gtin": "", "upc": "", "in_stock": true, "qty_available": 10, "inventory_tracked": true, "sale_price": 13500, "retail_price": 13500, "currency": "USD", "taxable": true, "tax_type": "DEFAULT", "albums": [ { "id": 91018, "parent_id": 196599, "type": "SKU", "name": "Dancing Sneaker Green - 41 / Design Four Media", "media": [ { "id": 185734, "album_id": 91018, "external_id": "41484160827693", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_158776f7-2cd6-4c39-9c89-ab1a95924100.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_158776f7-2cd6-4c39-9c89-ab1a95924100.png", "type": "IMAGE", "display_order": 1, "primary": true } ], "primary_media": { "id": 185734, "album_id": 91018, "external_id": "41484160827693", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_158776f7-2cd6-4c39-9c89-ab1a95924100.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_158776f7-2cd6-4c39-9c89-ab1a95924100.png", "type": "IMAGE", "display_order": 1, "primary": true } } ], "variant_values": [ { "variant": "Style", "value": "Design Four" }, { "variant": "Size", "value": "41" } ], "type": "PHYSICAL", "status": "AVAILABLE", "date_created": "2023-05-01T20:08:23+0000", "date_last_modified": "2023-08-07T15:02:53+0000", "sku_dimensions": { "weight": 3.0, "type": "SKU" } }, { "id": 196616, "offer_id": 39041, "merchant_id": 10189, "external_id": "45101326205229", "name": "Dancing Sneaker Green - 42 / Design Two", "gtin": "", "upc": "", "in_stock": true, "qty_available": 10, "inventory_tracked": true, "sale_price": 13500, "retail_price": 13500, "currency": "USD", "taxable": true, "tax_type": "DEFAULT", "albums": [ { "id": 91035, "parent_id": 196616, "type": "SKU", "name": "Dancing Sneaker Green - 42 / Design Two Media", "media": [ { "id": 185751, "album_id": 91035, "external_id": "41484160860461", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_79f40a05-4ede-4cd0-ad76-4f301bf0aa57.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_79f40a05-4ede-4cd0-ad76-4f301bf0aa57.png", "type": "IMAGE", "display_order": 1, "primary": true } ], "primary_media": { "id": 185751, "album_id": 91035, "external_id": "41484160860461", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_79f40a05-4ede-4cd0-ad76-4f301bf0aa57.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_79f40a05-4ede-4cd0-ad76-4f301bf0aa57.png", "type": "IMAGE", "display_order": 1, "primary": true } } ], "variant_values": [ { "variant": "Style", "value": "Design Two" }, { "variant": "Size", "value": "42" } ], "type": "PHYSICAL", "status": "AVAILABLE", "date_created": "2023-05-01T20:08:24+0000", "date_last_modified": "2023-08-07T15:02:53+0000", "sku_dimensions": { "weight": 3.0, "type": "SKU" } }, { "id": 196597, "offer_id": 39041, "merchant_id": 10189, "external_id": "45101326303533", "name": "Dancing Sneaker Green - 43 / Design One", "gtin": "", "upc": "", "in_stock": true, "qty_available": 10, "inventory_tracked": true, "sale_price": 13500, "retail_price": 13500, "currency": "USD", "taxable": true, "tax_type": "DEFAULT", "albums": [ { "id": 91016, "parent_id": 196597, "type": "SKU", "name": "Dancing Sneaker Green - 43 / Design One Media", "media": [ { "id": 185732, "album_id": 91016, "external_id": "41484161155373", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_6d8d2c39-c9b3-4943-a41e-0214bf0df19c.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_6d8d2c39-c9b3-4943-a41e-0214bf0df19c.png", "type": "IMAGE", "display_order": 1, "primary": true } ], "primary_media": { "id": 185732, "album_id": 91016, "external_id": "41484161155373", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_6d8d2c39-c9b3-4943-a41e-0214bf0df19c.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_6d8d2c39-c9b3-4943-a41e-0214bf0df19c.png", "type": "IMAGE", "display_order": 1, "primary": true } } ], "variant_values": [ { "variant": "Style", "value": "Design One" }, { "variant": "Size", "value": "43" } ], "type": "PHYSICAL", "status": "AVAILABLE", "date_created": "2023-05-01T20:08:23+0000", "date_last_modified": "2023-08-07T15:02:53+0000", "sku_dimensions": { "weight": 3.0, "type": "SKU" } }, { "id": 196602, "offer_id": 39041, "merchant_id": 10189, "external_id": "45101325648173", "name": "Dancing Sneaker Green - 38 / Design Two", "gtin": "", "upc": "", "in_stock": true, "qty_available": 10, "inventory_tracked": true, "sale_price": 13500, "retail_price": 13500, "currency": "USD", "taxable": true, "tax_type": "DEFAULT", "albums": [ { "id": 91021, "parent_id": 196602, "type": "SKU", "name": "Dancing Sneaker Green - 38 / Design Two Media", "media": [ { "id": 185737, "album_id": 91021, "external_id": "41484160860461", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_79f40a05-4ede-4cd0-ad76-4f301bf0aa57.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_79f40a05-4ede-4cd0-ad76-4f301bf0aa57.png", "type": "IMAGE", "display_order": 1, "primary": true } ], "primary_media": { "id": 185737, "album_id": 91021, "external_id": "41484160860461", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_79f40a05-4ede-4cd0-ad76-4f301bf0aa57.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_79f40a05-4ede-4cd0-ad76-4f301bf0aa57.png", "type": "IMAGE", "display_order": 1, "primary": true } } ], "variant_values": [ { "variant": "Size", "value": "38" }, { "variant": "Style", "value": "Design Two" } ], "type": "PHYSICAL", "status": "AVAILABLE", "date_created": "2023-05-01T20:08:23+0000", "date_last_modified": "2023-08-07T15:02:53+0000", "sku_dimensions": { "weight": 3.0, "type": "SKU" } }, { "id": 196604, "offer_id": 39041, "merchant_id": 10189, "external_id": "45101326467373", "name": "Dancing Sneaker Green - 43 / Design Four", "gtin": "", "upc": "", "in_stock": true, "qty_available": 10, "inventory_tracked": true, "sale_price": 13500, "retail_price": 13500, "currency": "USD", "taxable": true, "tax_type": "DEFAULT", "albums": [ { "id": 91023, "parent_id": 196604, "type": "SKU", "name": "Dancing Sneaker Green - 43 / Design Four Media", "media": [ { "id": 185739, "album_id": 91023, "external_id": "41484160827693", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_158776f7-2cd6-4c39-9c89-ab1a95924100.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_158776f7-2cd6-4c39-9c89-ab1a95924100.png", "type": "IMAGE", "display_order": 1, "primary": true } ], "primary_media": { "id": 185739, "album_id": 91023, "external_id": "41484160827693", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_158776f7-2cd6-4c39-9c89-ab1a95924100.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_158776f7-2cd6-4c39-9c89-ab1a95924100.png", "type": "IMAGE", "display_order": 1, "primary": true } } ], "variant_values": [ { "variant": "Style", "value": "Design Four" }, { "variant": "Size", "value": "43" } ], "type": "PHYSICAL", "status": "AVAILABLE", "date_created": "2023-05-01T20:08:23+0000", "date_last_modified": "2023-08-07T15:02:53+0000", "sku_dimensions": { "weight": 3.0, "type": "SKU" } }, { "id": 196609, "offer_id": 39041, "merchant_id": 10189, "external_id": "45101326041389", "name": "Dancing Sneaker Green - 41 / Design One", "gtin": "", "upc": "", "in_stock": true, "qty_available": 10, "inventory_tracked": true, "sale_price": 13500, "retail_price": 13500, "currency": "USD", "taxable": true, "tax_type": "DEFAULT", "albums": [ { "id": 91028, "parent_id": 196609, "type": "SKU", "name": "Dancing Sneaker Green - 41 / Design One Media", "media": [ { "id": 185744, "album_id": 91028, "external_id": "41484161155373", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_6d8d2c39-c9b3-4943-a41e-0214bf0df19c.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_6d8d2c39-c9b3-4943-a41e-0214bf0df19c.png", "type": "IMAGE", "display_order": 1, "primary": true } ], "primary_media": { "id": 185744, "album_id": 91028, "external_id": "41484161155373", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_6d8d2c39-c9b3-4943-a41e-0214bf0df19c.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_6d8d2c39-c9b3-4943-a41e-0214bf0df19c.png", "type": "IMAGE", "display_order": 1, "primary": true } } ], "variant_values": [ { "variant": "Style", "value": "Design One" }, { "variant": "Size", "value": "41" } ], "type": "PHYSICAL", "status": "AVAILABLE", "date_created": "2023-05-01T20:08:24+0000", "date_last_modified": "2023-08-07T15:02:53+0000", "sku_dimensions": { "weight": 3.0, "type": "SKU" } }, { "id": 196598, "offer_id": 39041, "merchant_id": 10189, "external_id": "45101326074157", "name": "Dancing Sneaker Green - 41 / Design Two", "gtin": "", "upc": "", "in_stock": true, "qty_available": 10, "inventory_tracked": true, "sale_price": 13500, "retail_price": 13500, "currency": "USD", "taxable": true, "tax_type": "DEFAULT", "albums": [ { "id": 91017, "parent_id": 196598, "type": "SKU", "name": "Dancing Sneaker Green - 41 / Design Two Media", "media": [ { "id": 185733, "album_id": 91017, "external_id": "41484160860461", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_79f40a05-4ede-4cd0-ad76-4f301bf0aa57.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_79f40a05-4ede-4cd0-ad76-4f301bf0aa57.png", "type": "IMAGE", "display_order": 1, "primary": true } ], "primary_media": { "id": 185733, "album_id": 91017, "external_id": "41484160860461", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_79f40a05-4ede-4cd0-ad76-4f301bf0aa57.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_79f40a05-4ede-4cd0-ad76-4f301bf0aa57.png", "type": "IMAGE", "display_order": 1, "primary": true } } ], "variant_values": [ { "variant": "Style", "value": "Design Two" }, { "variant": "Size", "value": "41" } ], "type": "PHYSICAL", "status": "AVAILABLE", "date_created": "2023-05-01T20:08:23+0000", "date_last_modified": "2023-08-07T15:02:53+0000", "sku_dimensions": { "weight": 3.0, "type": "SKU" } }, { "id": 196600, "offer_id": 39041, "merchant_id": 10189, "external_id": "45101326336301", "name": "Dancing Sneaker Green - 43 / Design Two", "gtin": "", "upc": "", "in_stock": true, "qty_available": 10, "inventory_tracked": true, "sale_price": 13500, "retail_price": 13500, "currency": "USD", "taxable": true, "tax_type": "DEFAULT", "albums": [ { "id": 91019, "parent_id": 196600, "type": "SKU", "name": "Dancing Sneaker Green - 43 / Design Two Media", "media": [ { "id": 185735, "album_id": 91019, "external_id": "41484160860461", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_79f40a05-4ede-4cd0-ad76-4f301bf0aa57.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_79f40a05-4ede-4cd0-ad76-4f301bf0aa57.png", "type": "IMAGE", "display_order": 1, "primary": true } ], "primary_media": { "id": 185735, "album_id": 91019, "external_id": "41484160860461", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_79f40a05-4ede-4cd0-ad76-4f301bf0aa57.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_79f40a05-4ede-4cd0-ad76-4f301bf0aa57.png", "type": "IMAGE", "display_order": 1, "primary": true } } ], "variant_values": [ { "variant": "Style", "value": "Design Two" }, { "variant": "Size", "value": "43" } ], "type": "PHYSICAL", "status": "AVAILABLE", "date_created": "2023-05-01T20:08:23+0000", "date_last_modified": "2023-08-07T15:02:53+0000", "sku_dimensions": { "weight": 3.0, "type": "SKU" } }, { "id": 196595, "offer_id": 39041, "merchant_id": 10189, "external_id": "45101325877549", "name": "Dancing Sneaker Green - 39 / Design Four", "gtin": "", "upc": "", "in_stock": true, "qty_available": 9, "inventory_tracked": true, "sale_price": 13500, "retail_price": 13500, "currency": "USD", "taxable": true, "tax_type": "DEFAULT", "albums": [ { "id": 91014, "parent_id": 196595, "type": "SKU", "name": "Dancing Sneaker Green - 39 / Design Four Media", "media": [ { "id": 185730, "album_id": 91014, "external_id": "41484160827693", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_158776f7-2cd6-4c39-9c89-ab1a95924100.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_158776f7-2cd6-4c39-9c89-ab1a95924100.png", "type": "IMAGE", "display_order": 1, "primary": true } ], "primary_media": { "id": 185730, "album_id": 91014, "external_id": "41484160827693", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_158776f7-2cd6-4c39-9c89-ab1a95924100.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_158776f7-2cd6-4c39-9c89-ab1a95924100.png", "type": "IMAGE", "display_order": 1, "primary": true } } ], "variant_values": [ { "variant": "Size", "value": "39" }, { "variant": "Style", "value": "Design Four" } ], "type": "PHYSICAL", "status": "AVAILABLE", "date_created": "2023-05-01T20:08:23+0000", "date_last_modified": "2023-08-07T15:02:53+0000", "sku_dimensions": { "weight": 3.0, "type": "SKU" } }, { "id": 196605, "offer_id": 39041, "merchant_id": 10189, "external_id": "45101325910317", "name": "Dancing Sneaker Green - 40 / Design One", "gtin": "", "upc": "", "in_stock": true, "qty_available": 10, "inventory_tracked": true, "sale_price": 13500, "retail_price": 13500, "currency": "USD", "taxable": true, "tax_type": "DEFAULT", "albums": [ { "id": 91024, "parent_id": 196605, "type": "SKU", "name": "Dancing Sneaker Green - 40 / Design One Media", "media": [ { "id": 185740, "album_id": 91024, "external_id": "41484161155373", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_6d8d2c39-c9b3-4943-a41e-0214bf0df19c.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_6d8d2c39-c9b3-4943-a41e-0214bf0df19c.png", "type": "IMAGE", "display_order": 1, "primary": true } ], "primary_media": { "id": 185740, "album_id": 91024, "external_id": "41484161155373", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_6d8d2c39-c9b3-4943-a41e-0214bf0df19c.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_6d8d2c39-c9b3-4943-a41e-0214bf0df19c.png", "type": "IMAGE", "display_order": 1, "primary": true } } ], "variant_values": [ { "variant": "Style", "value": "Design One" }, { "variant": "Size", "value": "40" } ], "type": "PHYSICAL", "status": "AVAILABLE", "date_created": "2023-05-01T20:08:23+0000", "date_last_modified": "2023-08-07T15:02:53+0000", "sku_dimensions": { "weight": 3.0, "type": "SKU" } }, { "id": 196601, "offer_id": 39041, "merchant_id": 10189, "external_id": "45101325615405", "name": "Dancing Sneaker Green - 38 / Design One", "gtin": "", "upc": "", "in_stock": true, "qty_available": 10, "inventory_tracked": true, "sale_price": 13500, "retail_price": 13500, "currency": "USD", "taxable": true, "tax_type": "DEFAULT", "albums": [ { "id": 91020, "parent_id": 196601, "type": "SKU", "name": "Dancing Sneaker Green - 38 / Design One Media", "media": [ { "id": 185736, "album_id": 91020, "external_id": "41484161155373", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_6d8d2c39-c9b3-4943-a41e-0214bf0df19c.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_6d8d2c39-c9b3-4943-a41e-0214bf0df19c.png", "type": "IMAGE", "display_order": 1, "primary": true } ], "primary_media": { "id": 185736, "album_id": 91020, "external_id": "41484161155373", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_6d8d2c39-c9b3-4943-a41e-0214bf0df19c.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_6d8d2c39-c9b3-4943-a41e-0214bf0df19c.png", "type": "IMAGE", "display_order": 1, "primary": true } } ], "variant_values": [ { "variant": "Style", "value": "Design One" }, { "variant": "Size", "value": "38" } ], "type": "PHYSICAL", "status": "AVAILABLE", "date_created": "2023-05-01T20:08:23+0000", "date_last_modified": "2023-08-07T15:02:53+0000", "sku_dimensions": { "weight": 3.0, "type": "SKU" } }, { "id": 196611, "offer_id": 39041, "merchant_id": 10189, "external_id": "45101325812013", "name": "Dancing Sneaker Green - 39 / Design Two", "gtin": "", "upc": "", "in_stock": true, "qty_available": 10, "inventory_tracked": true, "sale_price": 13500, "retail_price": 13500, "currency": "USD", "taxable": true, "tax_type": "DEFAULT", "albums": [ { "id": 91030, "parent_id": 196611, "type": "SKU", "name": "Dancing Sneaker Green - 39 / Design Two Media", "media": [ { "id": 185746, "album_id": 91030, "external_id": "41484160860461", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_79f40a05-4ede-4cd0-ad76-4f301bf0aa57.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_79f40a05-4ede-4cd0-ad76-4f301bf0aa57.png", "type": "IMAGE", "display_order": 1, "primary": true } ], "primary_media": { "id": 185746, "album_id": 91030, "external_id": "41484160860461", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_79f40a05-4ede-4cd0-ad76-4f301bf0aa57.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_79f40a05-4ede-4cd0-ad76-4f301bf0aa57.png", "type": "IMAGE", "display_order": 1, "primary": true } } ], "variant_values": [ { "variant": "Size", "value": "39" }, { "variant": "Style", "value": "Design Two" } ], "type": "PHYSICAL", "status": "AVAILABLE", "date_created": "2023-05-01T20:08:24+0000", "date_last_modified": "2023-08-07T15:02:53+0000", "sku_dimensions": { "weight": 3.0, "type": "SKU" } }, { "id": 196612, "offer_id": 39041, "merchant_id": 10189, "external_id": "45101325779245", "name": "Dancing Sneaker Green - 39 / Design One", "gtin": "", "upc": "", "in_stock": true, "qty_available": 4, "inventory_tracked": true, "sale_price": 13500, "retail_price": 13500, "currency": "USD", "taxable": true, "tax_type": "DEFAULT", "albums": [ { "id": 91031, "parent_id": 196612, "type": "SKU", "name": "Dancing Sneaker Green - 39 / Design One Media", "media": [ { "id": 185747, "album_id": 91031, "external_id": "41484161155373", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_6d8d2c39-c9b3-4943-a41e-0214bf0df19c.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_6d8d2c39-c9b3-4943-a41e-0214bf0df19c.png", "type": "IMAGE", "display_order": 1, "primary": true } ], "primary_media": { "id": 185747, "album_id": 91031, "external_id": "41484161155373", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_6d8d2c39-c9b3-4943-a41e-0214bf0df19c.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_6d8d2c39-c9b3-4943-a41e-0214bf0df19c.png", "type": "IMAGE", "display_order": 1, "primary": true } } ], "variant_values": [ { "variant": "Size", "value": "39" }, { "variant": "Style", "value": "Design One" } ], "type": "PHYSICAL", "status": "AVAILABLE", "date_created": "2023-05-01T20:08:24+0000", "date_last_modified": "2023-08-07T15:02:53+0000", "sku_dimensions": { "weight": 3.0, "type": "SKU" } }, { "id": 196606, "offer_id": 39041, "merchant_id": 10189, "external_id": "45101325943085", "name": "Dancing Sneaker Green - 40 / Design Two", "gtin": "", "upc": "", "in_stock": true, "qty_available": 8, "inventory_tracked": true, "sale_price": 13500, "retail_price": 13500, "currency": "USD", "taxable": true, "tax_type": "DEFAULT", "albums": [ { "id": 91025, "parent_id": 196606, "type": "SKU", "name": "Dancing Sneaker Green - 40 / Design Two Media", "media": [ { "id": 185741, "album_id": 91025, "external_id": "41484160860461", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_79f40a05-4ede-4cd0-ad76-4f301bf0aa57.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_79f40a05-4ede-4cd0-ad76-4f301bf0aa57.png", "type": "IMAGE", "display_order": 1, "primary": true } ], "primary_media": { "id": 185741, "album_id": 91025, "external_id": "41484160860461", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_79f40a05-4ede-4cd0-ad76-4f301bf0aa57.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_79f40a05-4ede-4cd0-ad76-4f301bf0aa57.png", "type": "IMAGE", "display_order": 1, "primary": true } } ], "variant_values": [ { "variant": "Size", "value": "40" }, { "variant": "Style", "value": "Design Two" } ], "type": "PHYSICAL", "status": "AVAILABLE", "date_created": "2023-05-01T20:08:23+0000", "date_last_modified": "2023-08-07T15:02:53+0000", "sku_dimensions": { "weight": 3.0, "type": "SKU" } }, { "id": 196610, "offer_id": 39041, "merchant_id": 10189, "external_id": "45101326237997", "name": "Dancing Sneaker Green - 42 / Design Three", "gtin": "", "upc": "", "in_stock": true, "qty_available": 10, "inventory_tracked": true, "sale_price": 13500, "retail_price": 13500, "currency": "USD", "taxable": true, "tax_type": "DEFAULT", "albums": [ { "id": 91029, "parent_id": 196610, "type": "SKU", "name": "Dancing Sneaker Green - 42 / Design Three Media", "media": [ { "id": 185745, "album_id": 91029, "external_id": "41484160958765", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_85d6d1fe-b49c-4d4b-97b6-0bef6815cfbb.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_85d6d1fe-b49c-4d4b-97b6-0bef6815cfbb.png", "type": "IMAGE", "display_order": 1, "primary": true } ], "primary_media": { "id": 185745, "album_id": 91029, "external_id": "41484160958765", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_85d6d1fe-b49c-4d4b-97b6-0bef6815cfbb.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_85d6d1fe-b49c-4d4b-97b6-0bef6815cfbb.png", "type": "IMAGE", "display_order": 1, "primary": true } } ], "variant_values": [ { "variant": "Style", "value": "Design Three" }, { "variant": "Size", "value": "42" } ], "type": "PHYSICAL", "status": "AVAILABLE", "date_created": "2023-05-01T20:08:24+0000", "date_last_modified": "2023-08-07T15:02:53+0000", "sku_dimensions": { "weight": 3.0, "type": "SKU" } }, { "id": 196607, "offer_id": 39041, "merchant_id": 10189, "external_id": "45101325713709", "name": "Dancing Sneaker Green - 38 / Design Four", "gtin": "", "upc": "", "in_stock": true, "qty_available": 10, "inventory_tracked": true, "sale_price": 13500, "retail_price": 13500, "currency": "USD", "taxable": true, "tax_type": "DEFAULT", "albums": [ { "id": 91026, "parent_id": 196607, "type": "SKU", "name": "Dancing Sneaker Green - 38 / Design Four Media", "media": [ { "id": 185742, "album_id": 91026, "external_id": "41484160827693", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_158776f7-2cd6-4c39-9c89-ab1a95924100.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_158776f7-2cd6-4c39-9c89-ab1a95924100.png", "type": "IMAGE", "display_order": 1, "primary": true } ], "primary_media": { "id": 185742, "album_id": 91026, "external_id": "41484160827693", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_158776f7-2cd6-4c39-9c89-ab1a95924100.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_158776f7-2cd6-4c39-9c89-ab1a95924100.png", "type": "IMAGE", "display_order": 1, "primary": true } } ], "variant_values": [ { "variant": "Size", "value": "38" }, { "variant": "Style", "value": "Design Four" } ], "type": "PHYSICAL", "status": "AVAILABLE", "date_created": "2023-05-01T20:08:23+0000", "date_last_modified": "2023-08-07T15:02:53+0000", "sku_dimensions": { "weight": 3.0, "type": "SKU" } }, { "id": 196613, "offer_id": 39041, "merchant_id": 10189, "external_id": "45101326172461", "name": "Dancing Sneaker Green - 42 / Design One", "gtin": "", "upc": "", "in_stock": true, "qty_available": 10, "inventory_tracked": true, "sale_price": 13500, "retail_price": 13500, "currency": "USD", "taxable": true, "tax_type": "DEFAULT", "albums": [ { "id": 91032, "parent_id": 196613, "type": "SKU", "name": "Dancing Sneaker Green - 42 / Design One Media", "media": [ { "id": 185748, "album_id": 91032, "external_id": "41484161155373", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_6d8d2c39-c9b3-4943-a41e-0214bf0df19c.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_6d8d2c39-c9b3-4943-a41e-0214bf0df19c.png", "type": "IMAGE", "display_order": 1, "primary": true } ], "primary_media": { "id": 185748, "album_id": 91032, "external_id": "41484161155373", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_6d8d2c39-c9b3-4943-a41e-0214bf0df19c.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_6d8d2c39-c9b3-4943-a41e-0214bf0df19c.png", "type": "IMAGE", "display_order": 1, "primary": true } } ], "variant_values": [ { "variant": "Style", "value": "Design One" }, { "variant": "Size", "value": "42" } ], "type": "PHYSICAL", "status": "AVAILABLE", "date_created": "2023-05-01T20:08:24+0000", "date_last_modified": "2023-08-07T15:02:53+0000", "sku_dimensions": { "weight": 3.0, "type": "SKU" } }, { "id": 196608, "offer_id": 39041, "merchant_id": 10189, "external_id": "45101326106925", "name": "Dancing Sneaker Green - 41 / Design Three", "gtin": "", "upc": "", "in_stock": true, "qty_available": 10, "inventory_tracked": true, "sale_price": 13500, "retail_price": 13500, "currency": "USD", "taxable": true, "tax_type": "DEFAULT", "albums": [ { "id": 91027, "parent_id": 196608, "type": "SKU", "name": "Dancing Sneaker Green - 41 / Design Three Media", "media": [ { "id": 185743, "album_id": 91027, "external_id": "41484160958765", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_85d6d1fe-b49c-4d4b-97b6-0bef6815cfbb.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_85d6d1fe-b49c-4d4b-97b6-0bef6815cfbb.png", "type": "IMAGE", "display_order": 1, "primary": true } ], "primary_media": { "id": 185743, "album_id": 91027, "external_id": "41484160958765", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_85d6d1fe-b49c-4d4b-97b6-0bef6815cfbb.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_85d6d1fe-b49c-4d4b-97b6-0bef6815cfbb.png", "type": "IMAGE", "display_order": 1, "primary": true } } ], "variant_values": [ { "variant": "Style", "value": "Design Three" }, { "variant": "Size", "value": "41" } ], "type": "PHYSICAL", "status": "AVAILABLE", "date_created": "2023-05-01T20:08:23+0000", "date_last_modified": "2023-08-07T15:02:53+0000", "sku_dimensions": { "weight": 3.0, "type": "SKU" } }, { "id": 196594, "offer_id": 39041, "merchant_id": 10189, "external_id": "45101325680941", "name": "Dancing Sneaker Green - 38 / Design Three", "gtin": "", "upc": "", "in_stock": true, "qty_available": 10, "inventory_tracked": true, "sale_price": 13500, "retail_price": 13500, "currency": "USD", "taxable": true, "tax_type": "DEFAULT", "albums": [ { "id": 91013, "parent_id": 196594, "type": "SKU", "name": "Dancing Sneaker Green - 38 / Design Three Media", "media": [ { "id": 185729, "album_id": 91013, "external_id": "41484160958765", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_85d6d1fe-b49c-4d4b-97b6-0bef6815cfbb.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_85d6d1fe-b49c-4d4b-97b6-0bef6815cfbb.png", "type": "IMAGE", "display_order": 1, "primary": true } ], "primary_media": { "id": 185729, "album_id": 91013, "external_id": "41484160958765", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_85d6d1fe-b49c-4d4b-97b6-0bef6815cfbb.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_85d6d1fe-b49c-4d4b-97b6-0bef6815cfbb.png", "type": "IMAGE", "display_order": 1, "primary": true } } ], "variant_values": [ { "variant": "Style", "value": "Design Three" }, { "variant": "Size", "value": "38" } ], "type": "PHYSICAL", "status": "AVAILABLE", "date_created": "2023-05-01T20:08:23+0000", "date_last_modified": "2023-08-07T15:02:53+0000", "sku_dimensions": { "weight": 3.0, "type": "SKU" } }, { "id": 196596, "offer_id": 39041, "merchant_id": 10189, "external_id": "45101326270765", "name": "Dancing Sneaker Green - 42 / Design Four", "gtin": "", "upc": "", "in_stock": true, "qty_available": 10, "inventory_tracked": true, "sale_price": 13500, "retail_price": 13500, "currency": "USD", "taxable": true, "tax_type": "DEFAULT", "albums": [ { "id": 91015, "parent_id": 196596, "type": "SKU", "name": "Dancing Sneaker Green - 42 / Design Four Media", "media": [ { "id": 185731, "album_id": 91015, "external_id": "41484160827693", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_158776f7-2cd6-4c39-9c89-ab1a95924100.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_158776f7-2cd6-4c39-9c89-ab1a95924100.png", "type": "IMAGE", "display_order": 1, "primary": true } ], "primary_media": { "id": 185731, "album_id": 91015, "external_id": "41484160827693", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_158776f7-2cd6-4c39-9c89-ab1a95924100.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_158776f7-2cd6-4c39-9c89-ab1a95924100.png", "type": "IMAGE", "display_order": 1, "primary": true } } ], "variant_values": [ { "variant": "Style", "value": "Design Four" }, { "variant": "Size", "value": "42" } ], "type": "PHYSICAL", "status": "AVAILABLE", "date_created": "2023-05-01T20:08:23+0000", "date_last_modified": "2023-08-07T15:02:53+0000", "sku_dimensions": { "weight": 3.0, "type": "SKU" } }, { "id": 196593, "offer_id": 39041, "merchant_id": 10189, "external_id": "45101325844781", "name": "Dancing Sneaker Green - 39 / Design Three", "gtin": "", "upc": "", "in_stock": true, "qty_available": 10, "inventory_tracked": true, "sale_price": 13500, "retail_price": 13500, "currency": "USD", "taxable": true, "tax_type": "DEFAULT", "albums": [ { "id": 91012, "parent_id": 196593, "type": "SKU", "name": "Dancing Sneaker Green - 39 / Design Three Media", "media": [ { "id": 185728, "album_id": 91012, "external_id": "41484160958765", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_85d6d1fe-b49c-4d4b-97b6-0bef6815cfbb.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_85d6d1fe-b49c-4d4b-97b6-0bef6815cfbb.png", "type": "IMAGE", "display_order": 1, "primary": true } ], "primary_media": { "id": 185728, "album_id": 91012, "external_id": "41484160958765", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_85d6d1fe-b49c-4d4b-97b6-0bef6815cfbb.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_85d6d1fe-b49c-4d4b-97b6-0bef6815cfbb.png", "type": "IMAGE", "display_order": 1, "primary": true } } ], "variant_values": [ { "variant": "Style", "value": "Design Three" }, { "variant": "Size", "value": "39" } ], "type": "PHYSICAL", "status": "AVAILABLE", "date_created": "2023-05-01T20:08:23+0000", "date_last_modified": "2023-08-07T15:02:53+0000", "sku_dimensions": { "weight": 3.0, "type": "SKU" } }, { "id": 196615, "offer_id": 39041, "merchant_id": 10189, "external_id": "45101325975853", "name": "Dancing Sneaker Green - 40 / Design Three", "gtin": "", "upc": "", "in_stock": true, "qty_available": 9, "inventory_tracked": true, "sale_price": 13500, "retail_price": 13500, "currency": "USD", "taxable": true, "tax_type": "DEFAULT", "albums": [ { "id": 91034, "parent_id": 196615, "type": "SKU", "name": "Dancing Sneaker Green - 40 / Design Three Media", "media": [ { "id": 185750, "album_id": 91034, "external_id": "41484160958765", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_85d6d1fe-b49c-4d4b-97b6-0bef6815cfbb.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_85d6d1fe-b49c-4d4b-97b6-0bef6815cfbb.png", "type": "IMAGE", "display_order": 1, "primary": true } ], "primary_media": { "id": 185750, "album_id": 91034, "external_id": "41484160958765", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_85d6d1fe-b49c-4d4b-97b6-0bef6815cfbb.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_85d6d1fe-b49c-4d4b-97b6-0bef6815cfbb.png", "type": "IMAGE", "display_order": 1, "primary": true } } ], "variant_values": [ { "variant": "Style", "value": "Design Three" }, { "variant": "Size", "value": "40" } ], "type": "PHYSICAL", "status": "AVAILABLE", "date_created": "2023-05-01T20:08:24+0000", "date_last_modified": "2023-08-07T15:02:53+0000", "sku_dimensions": { "weight": 3.0, "type": "SKU" } } ], "albums": [ { "id": 90986, "parent_id": 39041, "type": "OFFER", "name": "Primary Album", "media": [ { "id": 185752, "album_id": 90986, "external_id": "41484161155373", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_6d8d2c39-c9b3-4943-a41e-0214bf0df19c.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_6d8d2c39-c9b3-4943-a41e-0214bf0df19c.png", "type": "IMAGE", "display_order": 1, "primary": true }, { "id": 185753, "album_id": 90986, "external_id": "41484160958765", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_85d6d1fe-b49c-4d4b-97b6-0bef6815cfbb.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_85d6d1fe-b49c-4d4b-97b6-0bef6815cfbb.png", "type": "IMAGE", "display_order": 3, "primary": false }, { "id": 185755, "album_id": 90986, "external_id": "41484160860461", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_79f40a05-4ede-4cd0-ad76-4f301bf0aa57.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_79f40a05-4ede-4cd0-ad76-4f301bf0aa57.png", "type": "IMAGE", "display_order": 2, "primary": false }, { "id": 185677, "album_id": 90986, "external_id": "41484160925997", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_d793242c-e9da-4b37-844d-2636695bf4f8.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_d793242c-e9da-4b37-844d-2636695bf4f8.png", "type": "IMAGE", "display_order": 6, "primary": false }, { "id": 185754, "album_id": 90986, "external_id": "41484160991533", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_a0b733cd-321a-4e85-b925-722b9bb8eb67.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_a0b733cd-321a-4e85-b925-722b9bb8eb67.png", "type": "IMAGE", "display_order": 4, "primary": false }, { "id": 185678, "album_id": 90986, "external_id": "41484160827693", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_158776f7-2cd6-4c39-9c89-ab1a95924100.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_158776f7-2cd6-4c39-9c89-ab1a95924100.png", "type": "IMAGE", "display_order": 5, "primary": false } ], "primary_media": { "id": 185752, "album_id": 90986, "external_id": "41484161155373", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_6d8d2c39-c9b3-4943-a41e-0214bf0df19c.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_shoes_floating_with_a_green_pastel_colour_6d8d2c39-c9b3-4943-a41e-0214bf0df19c.png", "type": "IMAGE", "display_order": 1, "primary": true } } ], "three_denabled": false, "type": "PHYSICAL", "status": "AVAILABLE", "publishing_status": "PUBLISHED", "date_created": "2023-05-01T20:08:23+0000", "date_last_modified": "2023-08-07T15:02:53+0000", "commission_rate": 25.0, "currency_symbol": "$", "subscription_status": "NOT_SUBSCRIBED", "tags": [ "madebymidjourney" ] } ```As a Channel, how should I interpret or act upon each status?
* **`UNAVAILABLE`** The channel would confirm with the merchant that the offer is correctly set up in their store, and if it is, they can use the dashboard to re-sync the offer. If there is still an issue after a re-sync, contacting support would be the next step. * **`AVAILABLE`** Unless the offer should *not* be available, there is nothing needed here. The channel can re-sync an offer via the dashboard, and contact support if that doesn’t resolve the issue. * **`DISABLED_UNAVAILABLE` / `DISABLED_AVAILABLE`** Both of the “disabled” statuses are due to a merchant being disabled, so a channel would need to handle that situation, first. They are also automatically updated when a merchant is disabled or re-enabled, so the channel would generally not need to do anything. If the status hasn’t be automatically updated, and the merchant’s status is enabled, then a re-sync via the dashboard should resolve the issue. Otherwise, raising a ticket to support would be the next step. * **`FOR_DELETION`** Offers in this state were already in an **`ARCHIVED`** status for an extended period of time, and so likely the channel wouldn’t need to do anything here. If this is an error, a re-sync via the dashboard should fix it, else raising a ticket to support would be the next step. * **`ARCHIVED`** The channel would need to confirm with the merchant, but given this happens when the offer is deleted on the merchant’s side, there is not really anything that can be done by the channel. While the merchant could recreate the product, it would show up in Violet as a new offer. Eventually, an archived offer would go into **`FOR_DELETION`** status to eventually be deleted.As a Merchant, how should I interpret or act upon each status?
* **`UNAVAILABLE`** This indicates an inventory issue or a misconfigured product. (For example, a digital item likely wouldn’t have a quantity or be tracked by inventory, so checking its configuration can resolve an incorrect status.) * **`AVAILABLE`** Unless this is a mistake, nothing needs to be done here. Otherwise, checking the item configuration or inventory stock should resolve it. * **`DISABLED_UNAVAILABLE` / `DISABLED_AVAILABLE`** The merchant would need to resolve its own status in order to resolve the offer statuses. * **`FOR_DELETION` / `ARCHIVED`** These are going to be due to the merchant deleting a product from their store so that its associated offer becomes archived. At this point, while the merchant could (re)create the product, a new offer would be created, instead, leaving the old one a stub which will eventually be deleted from Violet's system.SKU as part of Offer
```json { "id": 39045, "product_id": "8d8c749c469b45e795f458360e2fc4be", "external_id": "8335172993325", "external_url": "https://the-violet-garden.myshopify.com/products/rouge-fire-flower-t-shirt", "name": "Shirt", "description": "Pastel-red flower design, short-sleeved t-shirt. Designed to keep you cool when you need to be cool and hot when you need to be hot. This shirt looks great on a sunny day under a blue sky.", "source": "SHOPIFY", "seller": "the violet garden", "vendor": "The Violet Garden", "merchant_id": 10189, "available": true, "visible": true, "min_price": 3000, "max_price": 3000, "currency": "USD", "source_category_name": "", "meta": [], "variants": [ ... ], "skus": [ { "id": 196701, "offer_id": 39045, "merchant_id": 10189, "external_id": "45101095092525", "name": "Shirt - Large / Design Three / Red", "gtin": "", "upc": "", "in_stock": true, "qty_available": 100, "inventory_tracked": true, "sale_price": 3000, "retail_price": 3000, "currency": "USD", "taxable": true, "tax_type": "DEFAULT", "albums": [], "variant_values": [ { "variant": "Style", "value": "Design Three" }, { "variant": "Size", "value": "Large" }, { "variant": "Color", "value": "Red" } ], "type": "PHYSICAL", "status": "AVAILABLE", "date_created": "2023-05-01T20:08:25+0000", "date_last_modified": "2023-06-29T23:58:33+0000", "sku_dimensions": { "weight": 0.0, "type": "SKU" } }, { "id": 196697, "offer_id": 39045, "merchant_id": 10189, "external_id": "45101095059757", "name": "Shirt - Large / Design Two / Red", "gtin": "", "upc": "", "in_stock": true, "qty_available": 100, "inventory_tracked": true, "sale_price": 3000, "retail_price": 3000, "currency": "USD", "taxable": true, "tax_type": "DEFAULT", "albums": [], "variant_values": [ { "variant": "Size", "value": "Large" }, { "variant": "Color", "value": "Red" }, { "variant": "Style", "value": "Design Two" } ], "type": "PHYSICAL", "status": "AVAILABLE", "date_created": "2023-05-01T20:08:25+0000", "date_last_modified": "2023-06-29T23:58:33+0000", "sku_dimensions": { "weight": 0.0, "type": "SKU" } }, { "id": 196705, "offer_id": 39045, "merchant_id": 10189, "external_id": "45101094797613", "name": "Shirt - Small / Design Two / Red", "gtin": "", "upc": "", "in_stock": true, "qty_available": 99, "inventory_tracked": true, "sale_price": 3000, "retail_price": 3000, "currency": "USD", "taxable": true, "tax_type": "DEFAULT", "albums": [ { "id": 90993, "parent_id": 196705, "type": "SKU", "name": "Rouge Fire Flower T-Shirt - Small / Design Two Media", "media": [ { "id": 185704, "album_id": 90993, "external_id": "41483613471021", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_tshirt_with_a_red_pastel_colour_backgroun_b6d58e24-200e-42b9-86c4-8feeaf4bc8e6.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_tshirt_with_a_red_pastel_colour_backgroun_b6d58e24-200e-42b9-86c4-8feeaf4bc8e6.png", "type": "IMAGE", "display_order": 1, "primary": true } ], "primary_media": { "id": 185704, "album_id": 90993, "external_id": "41483613471021", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_tshirt_with_a_red_pastel_colour_backgroun_b6d58e24-200e-42b9-86c4-8feeaf4bc8e6.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_tshirt_with_a_red_pastel_colour_backgroun_b6d58e24-200e-42b9-86c4-8feeaf4bc8e6.png", "type": "IMAGE", "display_order": 1, "primary": true } } ], "variant_values": [ { "variant": "Size", "value": "Small" }, { "variant": "Color", "value": "Red" }, { "variant": "Style", "value": "Design Two" } ], "type": "PHYSICAL", "status": "AVAILABLE", "date_created": "2023-05-01T20:08:25+0000", "date_last_modified": "2023-06-29T23:58:33+0000", "sku_dimensions": { "weight": 0.0, "type": "SKU" } }, ... ], "albums": [ { "id": 90990, "parent_id": 39045, "type": "OFFER", "name": "Primary Album", "media": [ { "id": 185779, "album_id": 90990, "external_id": "41483613339949", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_tshirt_with_a_red_pastel_colour_backgroun_e963dc9b-12e7-4b1e-96bb-97dc1b061cbc.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_tshirt_with_a_red_pastel_colour_backgroun_e963dc9b-12e7-4b1e-96bb-97dc1b061cbc.png", "type": "IMAGE", "display_order": 1, "primary": true }, { "id": 185780, "album_id": 90990, "external_id": "41483613405485", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_tshirt_with_a_red_pastel_colour_backgroun_a80ec00e-eae1-41e4-8d6b-81c64bbc8f52.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_tshirt_with_a_red_pastel_colour_backgroun_a80ec00e-eae1-41e4-8d6b-81c64bbc8f52.png", "type": "IMAGE", "display_order": 2, "primary": false }, { "id": 185781, "album_id": 90990, "external_id": "41483613274413", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/grid_0.webp", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/grid_0.webp", "type": "IMAGE", "display_order": 3, "primary": false }, { "id": 185782, "album_id": 90990, "external_id": "41483613372717", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_tshirt_with_a_red_pastel_colour_backgroun_d2f90fab-7ac4-4161-b710-5363f1b4e244.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_tshirt_with_a_red_pastel_colour_backgroun_d2f90fab-7ac4-4161-b710-5363f1b4e244.png", "type": "IMAGE", "display_order": 5, "primary": false }, { "id": 185783, "album_id": 90990, "external_id": "41483613438253", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_tshirt_with_a_red_pastel_colour_backgroun_d90ec5f7-a1a7-43c6-bdf9-38f7ff5764b9_1.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_tshirt_with_a_red_pastel_colour_backgroun_d90ec5f7-a1a7-43c6-bdf9-38f7ff5764b9_1.png", "type": "IMAGE", "display_order": 6, "primary": false }, { "id": 185778, "album_id": 90990, "external_id": "41483613471021", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_tshirt_with_a_red_pastel_colour_backgroun_b6d58e24-200e-42b9-86c4-8feeaf4bc8e6.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_tshirt_with_a_red_pastel_colour_backgroun_b6d58e24-200e-42b9-86c4-8feeaf4bc8e6.png", "type": "IMAGE", "display_order": 4, "primary": false } ], "primary_media": { "id": 185779, "album_id": 90990, "external_id": "41483613339949", "url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_tshirt_with_a_red_pastel_colour_backgroun_e963dc9b-12e7-4b1e-96bb-97dc1b061cbc.png", "source_url": "https://cdn.shopify.com/s/files/1/0758/9363/7421/files/wealthy_floral_design_tshirt_with_a_red_pastel_colour_backgroun_e963dc9b-12e7-4b1e-96bb-97dc1b061cbc.png", "type": "IMAGE", "display_order": 1, "primary": true } } ], "three_denabled": false, "type": "PHYSICAL", "status": "AVAILABLE", "publishing_status": "PUBLISHED", "date_created": "2023-05-01T20:08:25+0000", "date_last_modified": "2023-06-29T23:58:33+0000", "commission_rate": 25.0, "currency_symbol": "$", "subscription_status": "NOT_SUBSCRIBED", "tags": [ "madebymidjourney" ] } ```SKU JSON
```json { "id": 196701, "offer_id": 39045, "merchant_id": 10189, "external_id": "45101095092525", "name": "Shirt - Large / Design Three / Red", "gtin": "", "upc": "", "in_stock": true, "qty_available": 100, "inventory_tracked": true, "sale_price": 3000, "retail_price": 3000, "currency": "USD", "taxable": true, "tax_type": "DEFAULT", "albums": [], "variant_values": [ { "variant": "Style", "value": "Design Three" }, { "variant": "Size", "value": "Large" }, { "variant": "Color", "value": "Red" } ], "type": "PHYSICAL", "status": "AVAILABLE", "date_created": "2023-05-01T20:08:25+0000", "date_last_modified": "2023-06-29T23:58:33+0000", "sku_dimensions": { "weight": 0.0, "type": "SKU" } } ```Example Metadata as part of Offer of Sku
```json { ... "metadata": [{ "version": 1.0, "type": "STRING", "external_type": "single_line_text_field", "key": "region", "value": "US", "source": "EXTERNAL" }] ... } ```JSON Example
```json { ... "metadata": [{ "version": 1.0, "type": "JSON", "external_type": "json", "key": "json_example", "value": "{\"key\":\"value\"}", "source": "EXTERNAL" }] ... } ```Sample Request
```jsx POST /carts/estimate { "base_currency": "USD", "skus": [ { "quantity": 2, "sku_id": 123 } ], "shipping_address": { "city": "Seattle", "state": "WA", "postal_code": "Sample Response
```jsx { "estimated_carts": [ { "merchant_id": 123, "platform": "SHOPIFY", "base_currency": "USD", "sub_total": 1, "shipping_total": 1, "discount_total": 1, "total": 1, "skus": [ { "quantity": 1, "sku_id": 80455, "name": "Lunar Lemonade - 10 oz.", "price": 9999, "merchant_id": 10064, "external_id": "42519630413999", "available": true, "requires_shipping": true, "product_type": "PHYSICAL", } ], "available_shipping_methods": [ { "carrier": "OTHER", "label": "Teleportation", "price": 10000 } ], "has_shipping_methods": true, "external_error_messages": [ "Option 1: Rate
```json "rates": [ { "name": "WA Sales Tax", "type": "TAX", "rate": 10.0 } ] ```Option 2: Amount
```json "rates": [ { "name": "WA Sales Tax", "type": "TAX", "amount": 10000 } ] ```Option 3: Rate + Amount
```json "rates": [ { "name": "WA Sales Tax", "type": "TAX", "rate": 10.0, "amount": 10000 } ] ``` {% hint style="info" %} Violet prioritizes amount in calculations but persists both values. {% endhint %}Sample Create Order request with line-item taxes
```json { "payment_method": { "type": "SINGLE_USE_CARD_TOKEN", "payment_provider": "STRIPE", "token": "tok_amex" }, "order": { "app_order_id": "ishan-dos-sandbox", "customer": { "first_name": "Ishan", "last_name": "Guru", "email": "ishan.guru+line_item_taxes@violet.io" }, "bags": [ { "skus": [ { "sku_id": 80445, "price": 100000, "quantity": 2, "rates": [ { "name": "Washington (WA) Sales Tax", "type": "TAX", "amount": 10000 } ] } ], "shipping_method": { "label": "Teleportation2", "price": 10000 } } ], "shipping_address": { "address_1": "2815 Elliott Ave", "address_2": "Unit 100", "city": "Seattle", "state": "WA", "country": "US", "postal_code": "98121" }, "currency": "USD" } } ```Sample Response
```json { "id": 99400, "token": "1a028df30d444a78992a52d117297c65", "errors": [], "app_id": 10193, "developer_id": 10122, "customer": { "first_name": "Ishan", "last_name": "Guru", "email": "ishan.guru+dos_testing@violet.io", "name": "Ishan Guru" }, "bags": [ { "id": 118380, "order_id": 99400, "merchant_id": 10064, "app_id": 10193, "external_id": "6277080055983", "status": "ACCEPTED", "fulfillment_status": "PROCESSING", "financial_status": "PAID", "dispute_status": "UNDISPUTED", "skus": [ { "id": 112067, "merchant_id": 10064, "app_id": 10193, "product_id": "815b064726de41d9a21de4bfc029416f", "sku_id": 80445, "external_id": "42519630413999", "name": "Lunar Lemonade - 10 oz.", "brand": "Space Drinks", "thumbnail": "https://cdn.shopify.com/s/files/1/0621/1849/4383/files/wealthy_lunar_lemonade_4a9c0731-8758-4847-91e1-d6d37d6ace22.png", "quantity": 2, "price": 100000, "weight": 3.0, "available": true, "status": "PROCESSING", "product_type": "PHYSICAL", "rates": [ { "order_sku_id": 112067, "amount": 10000, "rate": 10.0, "type": "TAX", "name": "Sales Tax", "dollar_amount": 100.0, "decimal_rate": 0.1 } ], "line_price": 200000 } ], "shipping_method": { "type": "FLAT_RATE_PRICE", "label": "Teleportation2", "price": 10000, "custom": false, "id": 97302, "merchant_id": 10064 }, "taxes": [ { "order_id": 99400, "merchant_id": 10064, "state": "WA", "rate": 5.0, "amount": 10000 } ], "sub_total": 200000, "shipping_total": 10000, "tax_total": 10000, "duty_total": 0, "total": 220000, "taxes_included": false, "external_checkout": false, "commission_rate": 25.0, "date_created": "2024-12-13T00:08:58+0000", "date_last_modified": "2024-12-13T00:08:58.000+00:00", "remorse_period_ends": "2025-01-12T00:08:58+0000", "currency": "USD", "external_currency": "USD", "channel": "MARKETPLACE", "app_order_id": "ishan-dos-sandbox", "platform": "SHOPIFY", "fulfillments": [], "discounts": [], "wallet_based_checkout": false, "bag_status": "ACCEPTED", "bag_id": 118380, "merchant_name": "Space Drinks" } ], "shipping_address": { ... }, "billing_address": { ... }, "sub_total": 200000, "shipping_total": 10000, "tax_total": 10000, "duty_total": 0, "total": 220000, "app_order_id": "ishan-dos-sandbox", "status": "COMPLETED", "is_guest": true, "date_created": "2024-12-13T00:08:56+0000", "date_last_modified": "2024-12-13T00:09:01+0000", "payment_transactions": [ ... ], "order_status": "COMPLETED", "order_id": 99400 } ```Sample Request
```jsx POST /orders { "payment_method": { "type": "SINGLE_USE_CARD_TOKEN", "payment_provider": "STRIPE", "token": "tok_1289y1ishakj12h31kj212kh" }, "order": { "app_order_id": "mario-test-1", "customer": { "first_name": "Ultra", "last_name": "Violet", "email": "super@mar.io" }, "bags": [ { "skus": [ { "sku_id": 80455, "price": 100000 } ], "shipping_method": { "carrier": "OTHER", "label": "Teleportation", "price": 10000 }, "tax_total": 10000 } ], "shipping_address": { "address_1": "2815 Elliott Ave", "address_2": "Unit 100", "city": "Seattle", "state": "WA", "country": "US", "postal_code": "98121" }, "billing_address": { "address_1": "200 West Street", "city": "New York", "state": "NY", "country": "US", "postal_code": "10282" }, "currency": "USD" } } ```Sample Response
```jsx { "id": 54609, "token": "f9bd116404dc4441838a94f31a942d5f", "errors": [], "app_id": 10193, "developer_id": 10122, "customer": { "first_name": "Ultra", "last_name": "Violet", "email": "super@mar.io", "name": "Ultra Violet" }, "bags": [ { "id": 64579, "order_id": 54609, "merchant_id": 10064, "status": "ACCEPTED", "fulfillment_status": "PROCESSING", "financial_status": "PAID", "skus": [ { "id": 60509, "merchant_id": 10064, "app_id": 10193, "product_id": "815b064726de41d9a21de4bfc029416f", "sku_id": 80445, "external_id": "42519630413999", "name": "Lunar Lemonade - 10 oz.", "brand": "Space Drinks", "thumbnail": "https://cdn.shopify.com/s/files/1/0621/1849/4383/files/wealthy_lunar_lemonade_4a9c0731-8758-4847-91e1-d6d37d6ace22.png", "quantity": 1, "price": 100000, "weight": 3.0, "available": true, "status": "PROCESSING", "product_type": "PHYSICAL", "line_price": 100000 } ], "shipping_method": { "type": "FLAT_RATE_PRICE", "carrier": "OTHER", "label": "Teleportation", "price": 10000, "custom": false, "id": 21839, "merchant_id": 10064 }, "taxes": [ { "order_id": 54609, "merchant_id": 10064, "state": "WA", "rate": 10.0, "amount": 10000 } ], "sub_total": 100000, "shipping_total": 10000, "tax_total": 10000, "duty_total": 0, "total": 120000, "taxes_included": false, "transactions": [], "external_checkout": false, "commission_rate": 0.0, "date_created": "2024-06-28T20:31:56+0000", "date_last_modified": "2024-06-28T20:31:56.000+00:00", "remorse_period_ends": "2024-07-28T20:31:56+0000", "currency": "USD", "external_currency": "USD", "channel": "MARKETPLACE", "app_order_id": "ishan-test-1", "platform": "SHOPIFY", "fulfillments": [], "discounts": [], "wallet_based_checkout": false, "bag_id": 64579, "bag_status": "ACCEPTED", "merchant_name": "Space Drinks" } ], "shipping_address": { "name": "Ultra Violet", "city": "Seattle", "state": "WA", "country": "US", "postal_code": "98121", "type": "BILLING", "address_1": "2815 Elliott Ave", "address_2": "Unit 100", "first_name": "Ultra", "last_name": "Violet" }, "billing_address":{ "name": "Ultra Violet", "city": "New York", "state": "NY", "country": "US", "postal_code": "10282", "type": "BILLING", "address_1": "200 West Street", "first_name": "Ultra", "last_name": "Violet" }, "payment_transactions": [ { "id": 31464, "order_id": 54627, "payment_provider": "STRIPE", "payment_provider_transaction_id": "pi_3PXoWvK29KDiBVld1n7ym4B0", "payment_method_id": 10630, "payment_provider_payment_method_id": "pm_1PXoWvK29KDiBVldLNqe04Oi", "payment_intent_client_secret": "pi_3PXoWvK29KDiBVld1n7ym4B0_secret_tB77zb3BoTCKigUe5R38hrCKS", "amount": 120000, "metadata": { "payment_intent_client_secret": "pi_3PXoWvK29KDiBVld1n7ym4B0_secret_tB77zb3BoTCKigUe5R38hrCKS", "payment_intent_id": "pi_3PXoWvK29KDiBVld1n7ym4B0" }, "currency": "USD", "status": "CAPTURED", "errors": [], "date_created": "2024-07-01T18:00:45+0000", "date_last_modified": "2024-07-01T18:00:48+0000" } ], "sub_total": 0, "shipping_total": 0, "tax_total": 0, "duty_total": 0, "total": 0, "app_order_id": "mario-test-1", "status": "COMPLETED", "is_guest": true, "date_created": "2024-06-28T20:31:56+0000", "date_last_modified": "2024-06-28T20:31:56+0000", "priced": true, "wallet_based_checkout": false, "currency": "USD", "channel": "MARKETPLACE", "currency_symbol": "$", "intent_based_checkout": true, "order_status": "COMPLETED", "order_id": 54609, "guest": true } ```Sample $0 Order Request (No Payment Method)
```json POST /orders { "order": { "app_order_id": "promo-order-001", "customer": { "first_name": "Jane", "last_name": "Doe", "email": "jane@example.com" }, "bags": [ { "skus": [ { "sku_id": 12345, "price": 0, "quantity": 1 } ], "shipping_method": { "label": "Free Shipping", "price": 0 }, "tax_total": 0 } ], "shipping_address": { "address_1": "123 Main St", "city": "Seattle", "state": "WA", "country": "US", "postal_code": "98101" }, "currency": "USD" } } ```Sample Request: Discount Bringing Order to $0
```json POST /orders { "order": { "app_order_id": "full-discount-001", "customer": { "first_name": "John", "last_name": "Smith", "email": "john@example.com" }, "bags": [ { "skus": [ { "sku_id": 12345, "price": 5000, "quantity": 1 } ], "discounts": [ { "type": "CUSTOM", "target_type": "ORDER", "amount": 5000, "code": "FREEGIFT" } ], "shipping_method": { "label": "Free Shipping", "price": 0 }, "tax_total": 0 } ], "shipping_address": { "address_1": "456 Oak Ave", "city": "Portland", "state": "OR", "country": "US", "postal_code": "97201" }, "currency": "USD" } } ```VALID - Code is valid and discount appliedINVALID - Code failed validationERROR - System error occurred
APPLIED - Discount successfully appliedINVALID - Code failed validationERROR - System error occurred
VALID - Discount is valid and appliedINVALID - Discount failed validationERROR - System error occurredNOT\_SUPPORTED - Platform doesn't support this discount type
APPLIED - Discount successfully appliedINVALID - Discount failed validationERROR - System error occurredNOT\_SUPPORTED - Platform doesn't support this discount type