Learn how to build an App, use SDKs, or customize your store front.
\nThe Everbee Oposhop API gives you complete flexibility to create custom applications, use our Everbee SDK, and design unique shopping experiences. Build standalone apps that merchants can install in their stores, leverage our SDKs for rapid development, or take full control of your storefront design and functionality.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"28506789","collectionId":"3c9ccdab-7d97-4cf4-a5f5-d014d9ec0105","publishedId":"2sB2jAb8Hx","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-05-28T16:11:36.000Z"},"item":[{"name":"Building An App","item":[{"name":"Supported APP Types","item":[],"id":"23d1d0a4-9426-41d2-9ea6-97544f4a6908","description":"When creating a new app for the EverBee App Ecosystem, you'll need to choose between two app types. Both apps are listed in the admin dashboard's app marketplace and provide admin functionality, but they differ in how merchants interact with them within the admin interface.
\nStandalone apps are independent applications that merchants install from the app ecosystem. When merchants click on your app in their admin dashboard, they're redirected to your own hosted application with a separate interface.
\nListed in App Ecosystem: Your app appears in the admin dashboard's app marketplace
\nExternal Redirect: Clicking your app takes merchants to your own hosted dashboard
\nSeparate Interface: Complete control over your app's admin interface and user experience
\nIndependent Hosting: You host and manage your own application servers
\nOAuth Integration: Secure authentication flow connects your app to the merchant's store
\nAdmin Dashboard → App Ecosystem → Click Your App → Redirects to → your-app.com/dashboard\n\nComplex POD Platforms: Advanced design tools, extensive product catalogs, comprehensive order management
\nCustom Admin Experiences: Unique workflows, specialized interfaces, fully branded dashboards
\nAdvanced Analytics: Detailed reporting, custom metrics, business intelligence features
\nMulti-Store Management: Apps that manage multiple stores or complex business structures
\nEstablished Companies: Teams with existing infrastructure and development resources
\nFull-featured POD platforms with advanced design studios
\nComprehensive order management and fulfillment dashboards
\nComplex product catalog management systems
\nAdvanced analytics and reporting tools
\nMulti-supplier integration platforms
\nEmbedded apps integrate directly within the admin dashboard interface. Instead of redirecting merchants to an external site, your app's functionality appears as native admin pages, inside an iframe.
\nListed in App Ecosystem: Your app appears in the admin dashboard's app marketplace
\nNative Integration: Your app's interface appears directly within the admin dashboard
\nSeamless Experience: Merchants use your features without leaving their admin interface
\nPlatform Hosted: Your app runs within the EverBee admin environment
\nSession-Based: Uses the merchant's existing admin session
\nAdmin Dashboard → App Ecosystem → Click Your App → Opens Within → Admin Dashboard Interface\n\nStreamlined Tools: Simple, focused functionality that complements existing admin features
\nQuick Setup: Fast development and deployment without separate infrastructure
\nNative Feel: Apps that should feel like built-in admin features
\nSimple Workflows: Straightforward processes that don't require complex interfaces
\nNew Developers: Teams wanting to focus on core features rather than admin infrastructure
\nSimple product personalization setup tools
\nBasic order customization interfaces
\nStreamlined design upload and management
\nQuick product enhancement widgets
\nSimple reporting and analytics panels
\nApp Submission Enhancements:
\nStorefront Support Toggle: Option to enable storefront integration during app submission
\nJavaScript URL: Link to your storefront JavaScript file for DOM manipulation and functionality
\nCSS URL: Link to your stylesheet for storefront styling and customization
\nHow It Works:
\nYour App → Admin Setup → Storefront Integration → Customer Experience\nAdmin: Configure personalization options\n↓\nStorefront: Customer sees personalization interface on product pages\n↓ \nCustomer: Customizes product and adds to cart\n↓\nAdmin: View and fulfill personalized orders\n\nStorefront Use Cases:
\nProduct personalization interfaces on product detail pages
\nCustom design upload widgets
\nReal-time preview generators
\nInteractive customization tools
\nEnhanced product option selectors
\nTechnical Implementation:
\nYour JavaScript file gets loaded on relevant storefront pages
\nDOM manipulation capabilities for adding personalization interfaces
\nCSS styling to match store themes
\nIntegration with our POD SDK for seamless functionality
\nYou're building a comprehensive POD management platform
\nYou need complete control over admin interface and branding
\nYou have complex business logic requiring custom dashboards
\nYou have development resources for full application infrastructure
\nYou want to integrate with multiple e-commerce platforms
\nYou're an established company with existing admin systems
\nYou're adding focused functionality to complement existing admin features
\nYou want the fastest path to market with minimal infrastructure
\nYou prefer your app to feel like a native admin feature
\nYou have limited development resources
\nYou're building your first admin tool
\nYou want platform-managed hosting and updates
\nRegister Your App in the developer portal and choose \"Standalone\"
\nSet Up OAuth redirect URLs and required permissions
\nBuild Your Admin Interface with your preferred technology stack
\nImplement API Integration to connect with merchant stores
\nOptional: Prepare Storefront Assets (JavaScript/CSS URLs for future storefront integration)
\nSubmit for Review once your admin interface is complete
\nRegister Your App in the developer portal and choose \"Embedded\"
\nDevelop Admin Components using our admin framework guidelines
\nTest Integration within the admin dashboard environment
\nConfigure App Settings that merchants can customize
\nOptional: Prepare Storefront Assets (JavaScript/CSS URLs for future storefront integration)
\nSubmit for Review and automatic deployment within admin
\nWhen submitting your app, you'll have additional options:
\nStorefront Integration Fields:
\nEnable Storefront Integration: Check to add customer-facing functionality
\nJavaScript URL: https://cdn.your-app.com/storefront.js
CSS URL: https://cdn.your-app.com/storefront.css
Example Storefront Integration:
\n// Your storefront.js file\n(function() {\n // Wait for EverBee POD SDK\n window.EverBeeAppAPI.events.on('sdk.ready', function() {\n // Add personalization interface to product pages\n if (window.EverBeeAppAPI.product.getSelectedProduct().id) {\n addPersonalizationWidget();\n }\n });\n function addPersonalizationWidget() {\n const product = window.EverBeeAppAPI.product.getSelectedProduct();\n // Create your personalization interface\n const widget = document.createElement('div');\n widget.className = 'your-app-personalization';\n widget.innerHTML = `\n <h3 class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>Customize Your ${product.name}</h3>\n <comment class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> Your personalization UI -->\n `;\n // Insert into product page\n const target = document.querySelector('.product-form');\n target.appendChild(widget);\n }\n})();\n\nConsider these questions to choose the right app type:
\nHow complex is your admin interface?
\nSimple focused tools → Embedded
\nComprehensive management platform → Standalone
\nDo you need custom branding?
\nYes, important for business → Standalone
\nNo, native admin look preferred → Embedded
\nWhat are your development resources?
\nLimited, want to focus on features → Embedded
\nSufficient for full infrastructure → Standalone
\nHow quickly do you need to launch?
\nFast time-to-market → Embedded
\nCan invest in full development → Standalone
\nQuestions about app types or development? We're here to help:
\nDeveloper Portal: Documentation, code samples, and testing environments
\nCommunity Forum: Connect with other POD app developers
\nSupport Tickets: Direct technical assistance
\nOffice Hours: Weekly developer Q&A sessions
\nBoth app types provide powerful ways to integrate POD services into the EverBee ecosystem. Choose the option that best matches your current needs.
\n","_postman_id":"23d1d0a4-9426-41d2-9ea6-97544f4a6908"},{"name":"App installation Guide","item":[],"id":"7c51d127-6582-4ce7-aab4-9e5e96ed56c9","description":"When a user clicks the \"Install\" button, the system will redirect to the app's website_url with the following query string parameters:
URL Format:
\n${websiteUrl}?app_id=${app_id}&store_id=${store_id}&subdomain=${subdomain}&token=${token}&user_id=${user_id}\n\nParameters:
\napp_id: The application's unique identifier
store_id: The store's unique identifier
subdomain: The store's subdomain
token: The authentication token
user_id: The user's unique identifier
Example:
\nhttps://yourapp.example.com?app_id=abc123&store_id=store_456&subdomain=mystore&token=eyJhbGciOiJIUzI1NiJ9...&user_id=user_789\n\nYour app should then redirect the user to the Everbee OAuth authorization endpoint with the token for authentication:
\nURL: https://auth.everbee.com/oauth/authorize
Required Parameters:
\nresponse_type: Must be code
client_id: Your app's client ID (obtained when registering your app)
redirect_uri: Your app's registered redirect URI
state: A unique value to prevent CSRF attacks (recommended: combine store_id, subdomain, and user_id)
token: The authentication token received in Step 1 (required for user authentication)
Example Authorization URL:
\nhttps://auth.everbee.com/oauth/authorize?response_type=code&client_id=your_client_id&redirect_uri=https://yourapp.example.com/callback&state=store_456_mystore_user_789&token=eyJhbGciOiJIUzI1NiJ9...\n\nThe user will be presented with a beautifully designed authorization screen showing:
\nYour app's name and logo (if provided)
\nApp description and website URL
\nRequested permissions/scopes in a user-friendly format
\nOptions to \"Approve\" or \"Deny\" the installation
\nAuthorization Screen Features:
\nClean, modern UI with proper branding
\nAutomatic scope formatting (e.g., \"products:read\" becomes \"Products - view\")
\nApplication logo support with fallback to app name initial
\nLoading states for form submissions
\nMobile-responsive design
\nNote: The authorization endpoint uses the provided token to authenticate the user and determine the current_resource_owner. The token must be valid and not expired for the authorization to proceed.
After the user approves or denies the installation, they will be redirected to your redirect_uri with:
Success Response (User clicked \"Approve\"):
\nhttps://yourapp.example.com/callback?code=authorization_code_here&state=store_456_mystore_user_789\n\nDenial Response (User clicked \"Deny\"):
\nhttps://yourapp.example.com/callback?error=access_denied&error_description=The+user+denied+the+request&state=store_456_mystore_user_789\n\nError Response (Invalid parameters or server error):
\nhttps://yourapp.example.com/callback?error=invalid_request&error_description=Missing+required+parameter&state=store_456_mystore_user_789\n\nYour app must exchange the received authorization code for an access token:
\nPOST https://auth.everbee.com/oauth/token
Headers:
\nContent-Type: application/json\n\nBody Parameters:
\ngrant_type: Must be authorization_code
code: The authorization code received from the callback
client_id: Your app's client ID
client_secret: Your app's client secret
redirect_uri: The same redirect URI used in the authorization request
Example Request:
\n{\n \"grant_type\": \"authorization_code\",\n \"code\": \"authorization_code_here\",\n \"client_id\": \"your_client_id\", \n \"client_secret\": \"your_client_secret\",\n \"redirect_uri\": \"https://yourapp.example.com/callback\"\n}\n\nSuccess Response:
\n{\n \"access_token\": \"eyJhbGciOiJIUzI1NiJ9...\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 7200,\n \"refresh_token\": \"refresh_token_here\",\n \"scope\": \"read:profile write:store\",\n \"created_at\": 1640995200\n}\n\nError Response:
\n{\n \"error\": \"invalid_grant\",\n \"error_description\": \"The provided authorization grant is invalid, expired, revoked, does not match the redirection URI used in the authorization request, or was issued to another client.\"\n}\n\nRequest Details:
\nMethod: POST
URL: https://auth.everbee.com/oauth/token
{\n \"grant_type\": \"refresh_token\",\n \"client_id\": \"{{client_id}}\",\n \"client_secret\": \"{{client_secret}}\",\n \"refresh_token\": \"{{refresh_token}}\"\n}\n\nSet these variables in your Postman environment:
\n{\n \"access_token\": \"eyJhbGciOiJIUzI1NiJ9...\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 7200,\n \"refresh_token\": \"refresh_token_here\",\n \"scope\": \"read:profile write:store\",\n \"created_at\": 1640995200\n}\n\n{\n \"error\": \"invalid_grant\",\n \"error_description\": \"The provided authorization grant is invalid, expired, revoked, does not match the redirection URI used in the authorization request, or was issued to another client\"\n}\n\nAfter successful installation, when a user clicks \"Open\" to access your app, the request will be made to your app's URL with the same parameters as the initial installation:
\nURL Format:
\n${appUrl}?app_id=${app_id}&store_id=${store_id}&subdomain=${subdomain}&token=${token}&user_id=${user_id}\n\nExample:
\nhttps://yourapp.example.com?app_id=abc123&store_id=store_456&subdomain=mystore&token=eyJhbGciOiJIUzI1NiJ9...&user_id=user_789\n\nInvalid Client:
\n{\n \"error\": \"invalid_client\",\n \"error_description\": \"Client authentication failed\"\n}\n\nInvalid Scope:
\n{\n \"error\": \"invalid_scope\", \n \"error_description\": \"The requested scope is invalid, unknown, or malformed\"\n}\n\nAccess Denied:
\n{\n \"error\": \"access_denied\",\n \"error_description\": \"The resource owner or authorization server denied the request\"\n}\n\nState Parameter: Always include and validate the state parameter to prevent CSRF attacks
HTTPS Only: All OAuth flows must use HTTPS
\nToken Storage: Store access tokens securely and never expose them in client-side code
\nToken Refresh: Implement proper token refresh logic before tokens expire
\nRedirect URI Validation: Ensure your redirect URIs are exact matches with what's registered
\nEverBee supports two distinct app types to match your development needs and business goals. Whether you're building a comprehensive POD platform with custom branding or a streamlined tool that integrates natively into the admin dashboard, our app ecosystem provides the flexibility you need.
\n","_postman_id":"b3bebc52-03c4-4a2b-b195-c159b6fea8f2"},{"name":"Everbee SDK","item":[],"id":"449b3f27-df3a-4ac8-80e2-8bf5a43dc385","description":"The EverBee Storefront SDK allows third-party developers to:
\nAdd products to a cart
\nRetrieve and update cart data
\nManage personalization data (images, text options)
\nReact to global SDK events
\nThis will be useful if you are updating/customizing storefront PDP page UI.
\nGlobal Namespace:
\nwindow.EverBeeAppAPI\n\nAll API calls use session/local storage for cart management — no explicit authentication required for buyers.
\nready(callback)Executes callback once the SDK is initialized.
\nEverBeeAppAPI.ready(() => {\n console.log('EverBee SDK is ready!');\n});\n\ncart.addToCart(opts)Adds a product variant to the current cart.
\nIf a cart_id exists in localStorage, it’s reused. Otherwise, a new cart is created.
Example Usage:
\nEverBeeAppAPI.cart.addToCart({\n variantId: 12345,\n quantity: 2,\n thumbnail: fileOrUrl,\n personalizations: [\n {\n optionId: 678,\n value: 'Custom Text',\n type: 'text'\n },\n {\n optionId: 910,\n file: fileInput.files[0],\n type: 'image'\n }\n ],\n meta: {\n engraving: 'Happy Birthday'\n }\n});\n\nForm Data Params:
\nResponse Example:
\n{\n \"cart_id\": \"7873d83d-8920-49de-a006-60d143886614\",\n \"cart_items_count\": 1,\n \"cart_item_id\": \"da1c36da-b8f9-4f6b-892a-1e960bfba42a\",\n \"notice\": \"Product added to cart successfully\"\n}\n\nEmitted Events:
\ncart.adding
cart.added
cart.updated
cart.error
Note:
\nIf the meta object includes a custom_personalisations field (as an array), it will be treated as a special personalization.
These values will automatically be included in the cart as user-entered personalisations, ensuring they appear within the cart UI alongside other personalization data.
\ncart.get(cartId)Fetches current cart details.
\nExample Usage:
\nEverBeeAppAPI.cart.get().then(cart => console.log(cart));\n\nResponse Example:
\n{\n \"data\": {\n \"id\": \"7873d83d-8920-49de-a006-60d143886614\",\n \"type\": \"cart\",\n \"attributes\": {\n \"total_price\": \"$50.00\",\n \"cart_items\": {\n \"data\": [\n {\n \"id\": \"da1c36da-b8f9-4f6b-892a-1e960bfba42a\",\n \"type\": \"cart_item\",\n \"attributes\": {\n \"quantity\": 1,\n \"cart_id\": \"7873d83d-8920-49de-a006-60d143886614\",\n \"personalisation_values\": [\n {\n \"id\": \"d342c0db-c6fd-4746-ab70-d3fa91186bf5\",\n \"instruction\": null,\n \"customer_id\": null,\n \"cart_item_id\": \"da1c36da-b8f9-4f6b-892a-1e960bfba42a\",\n \"personalisation_option_id\": \"1871f1f2-483e-479e-8148-cc0fc5b20459\",\n \"store_id\": \"06371bfe-7882-423b-9b90-7ee8debcb7c0\",\n \"created_at\": \"2025-10-29T14:46:12.108Z\",\n \"updated_at\": \"2025-10-29T14:46:12.124Z\",\n \"line_item_id\": null\n },\n {\n \"id\": \"5ff508c9-2a6e-466c-aaaf-19078bf9bbd6\",\n \"instruction\": \"Nikhil\",\n \"customer_id\": null,\n \"cart_item_id\": \"da1c36da-b8f9-4f6b-892a-1e960bfba42a\",\n \"personalisation_option_id\": \"16c31c23-0528-4502-81ca-8138cf44dc07\",\n \"store_id\": \"06371bfe-7882-423b-9b90-7ee8debcb7c0\",\n \"created_at\": \"2025-10-29T14:46:12.125Z\",\n \"updated_at\": \"2025-10-29T14:46:12.125Z\",\n \"line_item_id\": null\n }\n ],\n \"meta\": {},\n \"thumbnail_url\": null,\n \"currency_symbol\": \"$\",\n \"product_type\": \"physical\",\n \"variant\": {\n \"sku\": \"\",\n ...\n },\n \"available_quantity\": 10,\n \"total_price\": \"$50.00\",\n \"products\": {\n \"data\": {\n \"id\": \"b1e8eb32-1e4c-41dd-b648-1939107bc64b\",\n \"attributes\": {...}\n }\n },\n \"personalisations\": [\n {\n \"label\": \"Tshirt Front\",\n \"instruction\": null,\n \"personalisation_type\": \"image\",\n \"image_url\": \"https://stag-store.everbee.com/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWswWXpWbU9UWmhaUzFrWVRaaExUUTNaVEl0T0RReE1pMW1PRE5rTm1VeU9ERmhZekFHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--5640d4b24fd82d48f3435b474ef35e844fe58aaa/Hoodie size chart.png?disposition=attachment\",\n \"filename\": \"Hoodie size chart.png\"\n },\n {\n \"label\": \"Tshirt Back\",\n \"instruction\": \"Nikhil\",\n \"personalisation_type\": \"text\",\n \"image_url\": null,\n \"filename\": null\n }\n ]\n }\n }\n ]\n }\n }\n }\n}\n\nEmitted Events:
\ncart.fetching
cart.fetched
cart.updated
cart.error
cart.updateThumbnail(opts)Updates a cart item thumbnail (e.g., personalization preview).
\nFor this first cart_item should be created using addToCart method above.
\nExample Usage:
\nEverBeeAppAPI.cart.updateThumbnail({\n cartItemId: 'ci_456',\n variantId: 'variant_id',\n thumbnail: newImageFile\n});\n\nForm Data Params:
\nResponse Example:
\n{\n \"data\": {\n \"id\": \"7873d83d-8920-49de-a006-60d143886614\",\n \"type\": \"cart\",\n \"attributes\": {\n \"total_price\": \"$50.00\",\n \"cart_items\": {\n \"data\": [\n {\n \"id\": \"da1c36da-b8f9-4f6b-892a-1e960bfba42a\",\n \"type\": \"cart_item\",\n \"attributes\": {\n \"quantity\": 1,\n \"cart_id\": \"7873d83d-8920-49de-a006-60d143886614\",\n \"personalisation_values\": [\n ...\n ],\n \"meta\": {},\n \"thumbnail_url\": \"<Uploaded image url>\",\n \"variant\": {...},\n \"products\": {\n \"data\": {\n \"id\": \"b1e8eb32-1e4c-41dd-b648-1939107bc64b\",\n \"attributes\": {...}\n }\n },\n \"personalisations\": [...]\n }\n }\n ]\n }\n }\n },\n \"cart_items_count\": 1\n}\n\nEmitted Events:
\ncart.thumbnail.updating
cart.thumbnail.updated
cart.updated
cart.error
Note:
\nOnce a thumbnail is added, the cart will display the thumbnail image instead of the product image.
\nSimilarly, the thumbnail image will be used on the checkout page and in mailers when referencing the product.
\nproduct.setSelected(product, variant)Sets the current selected product and variant.
\nEverBeeAppAPI.product.setSelected(productData, variantData);\n\nproduct.setVariant(variant)Updates only the selected variant.
\nEverBeeAppAPI.product.setVariant(variant);\n\nproduct.getSelectedProduct()Returns the currently selected product object.
\nproduct.getSelectedVariant()Returns the currently selected variant object.
\nEmitted Events:
\nproduct.selected
variant.selected
product.updated
events.on(event, callback)Subscribes to any SDK event.
\nEverBeeAppAPI.events.on('cart.added', (data) => {\n console.log('Cart updated:', data);\n});\n\nCommon Events:
\nThe SDK automatically emits lifecycle events for all major actions.
\nYou can use EverBeeAppAPI.events.on to hook into cart or product changes.
LocalStorage key used for cart tracking: cart_id
API timeout: 12 seconds
\n<script>\n EverBeeAppAPI.ready(() => {\n EverBeeAppAPI.events.on('cart.added', (data) => {\n console.log('Added to cart:', data);\n });\n });\n</script>\n\nExplore our REST API endpoints to build powerful integrations and custom applications. Each collection provides full CRUD operations and is designed for flexibility and ease of use.
\nEach API endpoint is authenticated and requires two things.
\nX-Access-Token
\nThe token should be valid user token.
\nIt should contain the valid scopes.
\nStore-Id
\nThis endpoint allows you to create a new automatic collection with the specified details.
\nscope: \"collections:write\"
\n| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The name/title of the product (up to 150 characters) |
description | string | Yes | Details about description |
collection_type | string | Yes | Type of collection \"automatic\" or \"manual\" |
conditions | Array | Yes (if automatic) | Array of rules required for automatic collection |
product_ids | Array | Yes (if manual) | Array of product ids for manual collection |
is_seo_enabled | Boolean | No | Whether to make collection SEO searchable |
is_visible_on_catalog | Boolean | No | If Enabled it will be visible on catalog page |
is_visible_on_header | Boolean | No | If Enabled it will be visible on header menu |
meta_description | string | No | description meta field |
url_handle | string | No | Url for collection page |
attachment_ids[] | Object | No | Featured attachment to append |
attachment_ids[\"to_append\"] | String | No | Signed Id of uploaded image. view Here on how to upload an attachment |
visible | boolean | Yes | true/false |
| Parameter | Type | Required | Description |
|---|---|---|---|
conditions[][\"type\"] | string | Yes | following types of product selection are supported. \"title\", \"type\", \"category\", \"product_tag\", \"price\" |
conditions[][\"operator\"] | string | Yes | operator to choose from following - \"contains\", \"equals\", \"less_than\", \"greater_than\" |
conditions[][\"value\"] | string | Yes | Value for the selected rule. |
{\n \"notice\": \"Collection created successfully\",\n \"id\": \"collection_id_string\"\n}\n\n{\n \"error\": \"Error message\"\n}\n\nThis endpoint is used to add a new manual collection with the specified details.
\nscope: \"collections:write\"
\nUpon successful execution, the response will be:
\n{\n \"id\": \"Newly created collection Id\",\n \"notice\": \"Collection has been successfully added.\"\n}\n\nRetrieves a list of collections from the Everbee Store with pagination and optional filtering. This endpoint allows you to fetch collections with various query parameters to filter and sort the results.
\n{\n \"type\": \"object\",\n \"properties\": {\n \"data\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\" },\n \"type\": { \"type\": \"string\" },\n \"attributes\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\" },\n \"name\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"page_title\": { \"type\": \"string\" },\n \"meta_description\": { \"type\": \"string\" },\n \"url_handle\": { \"type\": \"string\" },\n \"collection_type\": { \"type\": \"string\" },\n \"conditions\": { \"type\": \"array\" },\n \"status\": { \"type\": \"string\" },\n \"visible\": { \"type\": \"boolean\" },\n \"slug\": { \"type\": \"string\" },\n \"variants_count\": { \"type\": \"integer\" },\n \"featured_attachment\": { \"type\": \"null\" },\n \"products\": { \"type\": \"array\" }\n }\n }\n }\n }\n }\n }\n}\n\nThis endpoint retrieves a list of collections based on the provided filter parameters.
\nMethod: GET
\nURL: https://store-open-api.everbee.com/open_api/v1/collections
\nType: Raw (JSON)
\n{ \"filter_params\": { \"combinator\": \"all\", \"conditions\": [ { \"field\": \"collection_type\", \"operator\": \"equals\", \"value\": \"manual\" } ] }}
\nThe response of this request can be described using the following JSON schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"data\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\" },\n \"type\": { \"type\": \"string\" },\n \"attributes\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\" },\n \"name\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"page_title\": { \"type\": \"string\" },\n \"meta_description\": { \"type\": \"string\" },\n \"url_handle\": { \"type\": \"string\" },\n \"collection_type\": { \"type\": \"string\" },\n \"conditions\": { \"type\": \"array\" },\n \"status\": { \"type\": \"string\" },\n \"visible\": { \"type\": \"boolean\" },\n \"slug\": { \"type\": \"string\" },\n \"variants_count\": { \"type\": \"integer\" },\n \"featured_attachment\": { \"type\": \"null\" },\n \"products\": { \"type\": \"array\" }\n }\n }\n }\n }\n }\n }\n}\n\nThe responses from other endpoints of this API are largely similar and include data such as redirect_url, message, notice, and more. These responses may contain additional attributes based on the specific endpoint being called.
\n","urlObject":{"path":["collections"],"host":["https://store-open-api.everbee.com/open_api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"c3c13037-0081-4a58-ba1e-8ad7634b80da"}],"id":"b52945b0-138a-4ce2-8a6b-1fbd231973c5","_postman_id":"b52945b0-138a-4ce2-8a6b-1fbd231973c5","description":""},{"name":"show","id":"ab164229-d657-4626-8b0a-94c38fe831d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Store-Id","value":"your_store_id","type":"text"},{"key":"X-Access-Token","value":"your_access_token","type":"text"}],"url":"https://store-open-api.everbee.com/open_api/v1/collections/id","description":"This endpoint retrieves collection details by Id.
\nThe response is a JSON object with a data array containing collection information. Each collection object in the array has the following attributes:
{\n \"type\": \"object\",\n \"properties\": {\n \"data\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\" },\n \"type\": { \"type\": \"string\" },\n \"attributes\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\" },\n \"name\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"page_title\": { \"type\": \"string\" },\n \"meta_description\": { \"type\": \"string\" },\n \"url_handle\": { \"type\": \"string\" },\n \"collection_type\": { \"type\": \"string\" },\n \"conditions\": { \"type\": \"array\" },\n \"status\": { \"type\": \"string\" },\n \"visible\": { \"type\": \"boolean\" },\n \"slug\": { \"type\": \"string\" },\n \"variants_count\": { \"type\": \"integer\" },\n \"featured_attachment\": { \"type\": \"object\" },\n \"products\": { \"type\": \"array\" }\n }\n }\n }\n }\n }\n }\n}\n\nThis endpoint deletes an existing App Store collection by its unique ID for a given store.
\nscope: \"collections:write\"
Success Response (HTTP 204)
\n{\n \"notice\": \"Collection deleted successfully\"\n}\n\nError Responses (HTTP 4xx/5xx)
\nContent-Type: JSON
\n{\n \"error\": \"Error message\"\n}\n\nEverbee supports two types of collections that help you organize and display products in your store: Automatic Collections and Manual Collections. Each type serves a different purpose depending on how you want products to be grouped and managed.
\n","_postman_id":"5ae6200f-512b-49ac-8582-b3ff337c9e77"},{"name":"Products","item":[{"name":"Create Product","id":"96b2f5cc-6a3a-4132-9e76-609d1781a41a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Access-Token","value":"your_access_token","type":"text"},{"key":"Store-Id","value":"your_store_id","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"product\": {\n \"name\": \"Product Name\",\n \"fields\": [\n {\n \"id\": \"description\",\n \"title\": \"Description\",\n \"content\": \"\"\n }\n ],\n \"product_type\": \"physical\",\n \"is_personalisation_required\": true,\n \"personalisation_options_attributes\": [\n {\n \"character_limit\": 20,\n \"label\": \"Enter the name you want to be printed\",\n \"is_optional_for_buyer\": false\n }\n ],\n \"category_id\": \"your_category_id\",\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ],\n \"variants_attributes\": [\n {\n \"is_master\": true,\n \"price\": 29.99,\n \"cost_per_item\": 12.50,\n \"profit\": 17.49,\n \"quantity\": 99,\n \"track_quantity\": false,\n \"public_metadata\": {\n \"sku\": \"PRODUCT-SKU-001\"\n }\n },\n {\n \"is_master\": false,\n \"price\": 29.99,\n \"cost_per_item\": 12.50,\n \"profit\": 17.49,\n \"quantity\": 99,\n \"track_quantity\": true,\n \"public_metadata\": {\n \"sku\": \"PRODUCT-SKU-002\"\n },\n \"image_attachment_ids\": {\n \"to_append\": [\n \"attachment_id_1\",\n \"attachment_id_2\"\n ]\n },\n \"options\": [\n {\n \"name\": \"Color\",\n \"values\": [\n \"Red\"\n ]\n },\n {\n \"name\": \"Size\",\n \"values\": [\n \"Small\"\n ]\n }\n ]\n }\n ],\n \"option_types_attributes\": [\n {\n \"name\": \"Color\",\n \"option_values_attributes\": [\n {\n \"name\": \"Red\"\n },\n {\n \"name\": \"Blue\"\n }\n ]\n },\n {\n \"name\": \"Size\",\n \"option_values_attributes\": [\n {\n \"name\": \"Small\"\n },\n {\n \"name\": \"Medium\"\n }\n ]\n }\n ],\n \"image_attachment_ids\": {\n \"to_append\": [\n {\n \"signed_id\": \"eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWt5TnpGbU56bGlNaTAxTlRrekxUUmxaalV0WWprNU1DMDVNMlUwWXpjd01HWTVNamtHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--986ccd06533c47b0f1f142b6d9cae30ed3066cde\",\n \"position\": 1\n },\n {\n \"signed_id\": \"eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWt5TnpGbU56bGlNaTAxTlRrekxUUmxaalV0WWprNU1DMDVNMlUwWXpjd01HWTVNamtHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--986ccd06533c47b0f1f142b6d9cae30ed3066cde\",\n \"position\": 2\n }\n ],\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://store-open-api.everbee.com/open_api/v1/products","description":"This API endpoint allows you to create a new product in the Everbee Store. The implementation uses the Everbee Store API to create products with detailed configuration options, including variants, images, and pricing information.
\n| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The name/title of the product (up to 150 characters) |
fields | object | Yes | An object containing the product description fields. Must include a unique id (string) to identify this description block, a title (string) which is the label shown in the admin product details page, and content (string) which is the actual product description text. |
product_type | string | Yes | Type of product, typically \"physical\" |
is_personalisation_required | boolean | Yes | Whether the product requires personalization |
category_id | string | Yes | The ID of the category this product belongs to |
tags | array | No | Array of strings representing product tags |
variants_attributes | array | Yes | Array of product variant objects (see below) |
option_types_attributes | array | No | Array of option type objects (e.g., Size, Color) |
image_attachment_ids | object | No | to_append : Include the signed_id (from image upload response) and position (display order) for each image you want to append |
personalisation_options_attributes | array | No | Array containing object of personalisation attributes |
source | string | Yes | Product source - e.g. - printify, etsy.It should be same as app mame provided when creating a third party app. |
public_metadata | object | No | Any choice of data that you want to add can be put here as object ex: { is_personslisable: true, extra_data: 'abc' } |
size_chart | Array | No | if size chart to be enabled for a product |
store_size_chart_attachments | Array | No | Attachments to add to store for size chart |
| Parameter | Type | Required | Description |
|---|---|---|---|
is_master | boolean | Yes | Whether this is the master variant |
price | number | Yes | The price of the variant |
cost_per_item | number | Yes | The cost per item |
profit | number | No | The profit margin |
quantity | integer | Yes | The available quantity |
track_quantity | boolean | Yes | Whether to track inventory quantity |
public_metadata | object | Yes | Contains SKU and other metadata |
image_attachment_ids | object | No | Images to append or delete for the variant |
options | array | No | Options associated with this variant (e.g., Color: Red, Size: Small) |
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Name of the option type (e.g., \"Color\") |
option_values_attributes | array | Yes | Array of option values for this type |
| Parameter | Type | Required | Description |
|---|---|---|---|
personalisation_type | String | Yes | Type of personalisation e.g. text / image |
character_limit | Integer | Yes (If text personalisation) | The maximum number of characters a buyer can enter for personalization. |
label | string | Yes | The label shown to the buyer (e.g. a message like “Enter name”). |
is_optional_for_buyer | boolean | Yes | Determines if the field is optional (true) or required (false) for the buyer. |
| Parameter | Type | Required | Description |
|---|---|---|---|
size_chart_toggle | Boolean | No | To enable size chart |
selected_images | Array | Yes (if enable size_chart is true) | Image attachment signed_ids to assign a size chart image to product. |
| Parameter | Type | Required | Description |
|---|---|---|---|
to_append | Array | No | signed ids to append to store size chart |
to_delete | Array | No | Image signed ids to delete from store |
{\n \"notice\": \"Product created successfully\",\n \"product_id\": \"product_id_string\"\n}\n\n{\n \"error\": \"Error message\"\n}\n\nBefore creating a product, you need to upload any product images using the attachments API and obtain attachment IDs.
\nThe master variant is the default variant shown when browsing the product.
\nMake sure to set appropriate pricing information (price, cost_per_item, profit).
\nFor variant-specific images, use the image_attachment_ids in each variant.
\nOption types and option values need to match the options specified in variants.
\nTo enable Size chart is 2 step process
\nAdd size chart attachment using attachments API.
\nProvide signed_id of uploaded attachment in
\nsize_chart ( in selected_images attribute )
\nstore_size_chart_attachments (in to_append attribute)
\nPlease refer to the Attachments folder for API usecase and payload
\nBefore creating a product, you'll need to upload images and get attachment IDs:
\nPOST https://store-open-api.everbee.com/open_api/v1/attachments
\nUpload the image to the returned direct upload URL.
\nUse the returned signed_id as the attachment ID in your product creation request.
\nRetrieves detailed information about a specific product by its ID from the Everbee Store. This endpoint returns comprehensive product data including variants, options, images, and metadata.
\n{\n \"data\": {\n \"id\": \"product_id_string\",\n \"type\": \"product\",\n \"attributes\": {\n \"name\": \"Product Name\",\n \"fields\": [\n {\n \"id\": \"description\",\n \"title\": \"Description\",\n \"content\": \"\"\n }\n ],\n \"available_on\": \"2024-01-01T00:00:00Z\",\n \"deleted_at\": null,\n \"slug\": \"product-name\",\n \"download_limit\": null,\n \"meta_title\": \"Product Name\",\n \"link\": \"https://store.example.com/products/product-name\",\n \"meta_description\": \"Product description for SEO\",\n \"meta_keywords\": null,\n \"tax_category_id\": null,\n \"shipping_category_id\": null,\n \"product_type\": \"physical\",\n \"promotionable\": true,\n \"discontinue_on\": null,\n \"public_metadata\": null,\n \"private_metadata\": null,\n \"status\": \"published\",\n \"make_active_at\": null,\n \"store_id\": \"store_id_string\",\n \"category_id\": \"category_id_string\",\n \"is_personalisation_required\": true,\n \"personalisation_options\": [\n {\n \"id\": \"e2edf3e5-ed47-43a7-bf10-fd355950665e\",\n \"character_limit\": 100,\n \"label\": \"This is custom text feel free to add.\",\n \"product_id\": \"fac22345-627e-4824-8465-633631a61274\",\n \"store_id\": \"506180fc-6405-421b-809d-d24977770605\",\n \"created_at\": \"2025-05-21T17:53:57.066Z\",\n \"updated_at\": \"2025-05-21T17:53:57.066Z\",\n \"is_optional_for_buyer\": false\n }\n ],\n \"personalisation_values\": [\n {\n \"id\": \"d3fc7494-1dc2-45b8-a704-1c9addcdfa5d\",\n \"instruction\": \"NICK\",\n \"customer_id\": null,\n \"cart_item_id\": null,\n \"personalisation_option_id\": \"e2edf3e5-ed47-43a7-bf10-fd355950665e\",\n \"store_id\": \"506180fc-6405-421b-809d-d24977770605\",\n \"created_at\": \"2025-05-21T17:55:03.226Z\",\n \"updated_at\": \"2025-05-21T17:55:03.226Z\",\n \"line_item_id\": \"7cab6897-6461-414e-8991-522b9c232315\"\n }\n ],\n \"visibility\": \"visible\",\n \"is_returnable\": null,\n \"days_for_delivery\": null,\n \"min_shipping_fee\": null,\n \"max_days_for_returns\": null,\n \"currency_symbol\": \"$\",\n \"updated_at\": \"2024-05-01T12:00:00Z\",\n \"orders_count\": 5,\n \"variants_count\": 3,\n \"tags\": [\"tag1\", \"tag2\", \"tag3\"],\n \"master_variant\": {\n \"sku\": \"MASTER-SKU-123\",\n \"deleted_at\": null,\n \"is_master\": true,\n \"cost_per_item\": \"10.00\",\n \"position\": null,\n \"cost_currency\": null,\n \"public_metadata\": {\n \"sku\": \"MASTER-SKU-123\"\n },\n \"private_metadata\": null,\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-05-01T12:00:00Z\",\n \"id\": \"master_variant_id\",\n \"product_id\": \"product_id_string\",\n \"compare_at_price\": \"39.99\",\n \"price\": \"29.99\",\n \"profit\": \"19.99\",\n \"margin\": \"66.66\",\n \"option_value_id\": null,\n \"store_id\": \"store_id_string\",\n \"digital_file_url\": null,\n \"etsy_meta_data\": {},\n \"upload_status\": \"completed\",\n \"track_quantity\": false,\n \"uuid\": null,\n \"available_quantity\": 99,\n \"collections\": [],\n \"files\": [],\n \"image_url\": [\n {\n \"id\": \"image_id_1\",\n \"image_url\": \"https://example.com/images/product_main.jpg\"\n }\n ],\n \"option_values\": []\n },\n \"can_buyer_buy_the_product\": true,\n \"product_belongs_to_buyers_migrated_subscription\": null,\n \"available_automatic_discount\": 0,\n \"option_types\": [\n {\n \"id\": \"option_type_id_1\",\n \"name\": \"Size\",\n \"position\": 1,\n \"filterable\": true,\n \"public_metadata\": null,\n \"private_metadata\": null,\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-05-01T12:00:00Z\",\n \"product_id\": \"product_id_string\",\n \"store_id\": \"store_id_string\",\n \"option_values\": [\n {\n \"id\": \"option_value_id_1\",\n \"name\": \"Small\",\n \"position\": 1,\n \"option_type_id\": \"option_type_id_1\",\n \"store_id\": \"store_id_string\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-05-01T12:00:00Z\"\n },\n {\n \"id\": \"option_value_id_2\",\n \"name\": \"Medium\",\n \"position\": 2,\n \"option_type_id\": \"option_type_id_1\",\n \"store_id\": \"store_id_string\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-05-01T12:00:00Z\"\n },\n {\n \"id\": \"option_value_id_3\",\n \"name\": \"Large\",\n \"position\": 3,\n \"option_type_id\": \"option_type_id_1\",\n \"store_id\": \"store_id_string\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-05-01T12:00:00Z\"\n }\n ]\n },\n {\n \"id\": \"option_type_id_2\",\n \"name\": \"Color\",\n \"position\": 2,\n \"filterable\": true,\n \"public_metadata\": null,\n \"private_metadata\": null,\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-05-01T12:00:00Z\",\n \"product_id\": \"product_id_string\",\n \"store_id\": \"store_id_string\",\n \"option_values\": [\n {\n \"id\": \"option_value_id_4\",\n \"name\": \"Red\",\n \"position\": 1,\n \"option_type_id\": \"option_type_id_2\",\n \"store_id\": \"store_id_string\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-05-01T12:00:00Z\"\n },\n {\n \"id\": \"option_value_id_5\",\n \"name\": \"Blue\",\n \"position\": 2,\n \"option_type_id\": \"option_type_id_2\",\n \"store_id\": \"store_id_string\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-05-01T12:00:00Z\"\n },\n {\n \"id\": \"option_value_id_6\",\n \"name\": \"Green\",\n \"position\": 3,\n \"option_type_id\": \"option_type_id_2\",\n \"store_id\": \"store_id_string\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-05-01T12:00:00Z\"\n }\n ]\n }\n ],\n \"variants\": [\n {\n \"id\": \"variant_id_1\",\n \"sku\": \"PROD-S-RED\",\n \"deleted_at\": null,\n \"is_master\": false,\n \"cost_per_item\": \"12.00\",\n \"position\": 1,\n \"cost_currency\": \"USD\",\n \"public_metadata\": {\n \"sku\": \"PROD-S-RED\"\n },\n \"private_metadata\": null,\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-05-01T12:00:00Z\",\n \"product_id\": \"product_id_string\",\n \"compare_at_price\": \"44.99\",\n \"price\": \"34.99\",\n \"profit\": \"22.99\",\n \"margin\": \"65.71\",\n \"store_id\": \"store_id_string\",\n \"digital_file_url\": null,\n \"etsy_meta_data\": {},\n \"upload_status\": \"completed\",\n \"track_quantity\": true,\n \"uuid\": null,\n \"available_quantity\": 25,\n \"quantity\": 25,\n \"collections\": [],\n \"files\": [],\n \"image_url\": [\n {\n \"id\": \"image_id_2\",\n \"image_url\": \"https://example.com/images/product_red_small.jpg\"\n }\n ],\n \"option_values\": [\n {\n \"id\": \"option_value_id_1\",\n \"name\": \"Small\",\n \"position\": 1,\n \"option_type_id\": \"option_type_id_1\",\n \"store_id\": \"store_id_string\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-05-01T12:00:00Z\"\n },\n {\n \"id\": \"option_value_id_4\",\n \"name\": \"Red\",\n \"position\": 1,\n \"option_type_id\": \"option_type_id_2\",\n \"store_id\": \"store_id_string\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-05-01T12:00:00Z\"\n }\n ],\n \"inventory\": {\n \"id\": \"inventory_id_1\",\n \"variant_id\": \"variant_id_1\",\n \"store_id\": \"store_id_string\",\n \"quantity\": 25,\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-05-01T12:00:00Z\"\n }\n },\n {\n \"id\": \"variant_id_2\",\n \"sku\": \"PROD-M-BLUE\",\n \"deleted_at\": null,\n \"is_master\": false,\n \"cost_per_item\": \"12.00\",\n \"position\": 2,\n \"cost_currency\": \"USD\",\n \"public_metadata\": {\n \"sku\": \"PROD-M-BLUE\"\n },\n \"private_metadata\": null,\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-05-01T12:00:00Z\",\n \"product_id\": \"product_id_string\",\n \"compare_at_price\": \"44.99\",\n \"price\": \"34.99\",\n \"profit\": \"22.99\",\n \"margin\": \"65.71\",\n \"store_id\": \"store_id_string\",\n \"digital_file_url\": null,\n \"etsy_meta_data\": {},\n \"upload_status\": \"completed\",\n \"track_quantity\": true,\n \"uuid\": null,\n \"available_quantity\": 15,\n \"quantity\": 15,\n \"collections\": [],\n \"files\": [],\n \"image_url\": [\n {\n \"id\": \"image_id_3\",\n \"image_url\": \"https://example.com/images/product_blue_medium.jpg\"\n }\n ],\n \"option_values\": [\n {\n \"id\": \"option_value_id_2\",\n \"name\": \"Medium\",\n \"position\": 2,\n \"option_type_id\": \"option_type_id_1\",\n \"store_id\": \"store_id_string\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-05-01T12:00:00Z\"\n },\n {\n \"id\": \"option_value_id_5\",\n \"name\": \"Blue\",\n \"position\": 2,\n \"option_type_id\": \"option_type_id_2\",\n \"store_id\": \"store_id_string\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-05-01T12:00:00Z\"\n }\n ],\n \"inventory\": {\n \"id\": \"inventory_id_2\",\n \"variant_id\": \"variant_id_2\",\n \"store_id\": \"store_id_string\",\n \"quantity\": 15,\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-05-01T12:00:00Z\"\n }\n }\n ],\n \"images\": [\n {\n \"id\": \"image_id_1\",\n \"image_url\": \"https://example.com/images/product_main.jpg\",\n \"position\": 1,\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-05-01T12:00:00Z\"\n },\n {\n \"id\": \"image_id_2\", \n \"image_url\": \"https://example.com/images/product_red_small.jpg\",\n \"position\": 2,\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-05-01T12:00:00Z\"\n }\n ],\n \"videos\": [\n {\n \"id\": \"video_id_1\",\n \"video_url\": \"https://example.com/videos/product_demo.mp4\",\n \"position\": 1,\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-05-01T12:00:00Z\"\n }\n ],\n \"collections\": [\n {\n \"id\": \"collection_id_1\",\n \"name\": \"Summer Collection\",\n \"slug\": \"summer-collection\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-05-01T12:00:00Z\"\n }\n ],\n \"category\": {\n \"id\": \"category_id_string\",\n \"name\": \"Clothing\",\n \"slug\": \"clothing\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-05-01T12:00:00Z\"\n },\n \"shipping_profiles\": [\n {\n \"id\": \"shipping_profile_id_1\",\n \"name\": \"Standard Shipping\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-05-01T12:00:00Z\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\"\n }\n }\n}\n\n| Parameter | Description |
|---|---|
id | The product ID to be updated |
| Field | Type | Description |
|---|---|---|
product.name | string | Product title (max 150 characters) |
product.fields | object | An object containing the product description fields. Must include a unique id (string) to identify this description block, a title (string) which is the label shown in the admin product details page, and content (string) which is the actual product description text. |
product.product_type | string | Must be \"physical\" for POD products |
product.is_personalisation_required | boolean | Whether product requires personalization |
product.category_id | string | Product category ID |
product.tags | array of strings | Product tags |
product.image_attachment_ids | object | to_append: Include the signed_id (from image upload response) and position (display order) for each image you want to append, to_delete: attach the array of string containing id from image_url field |
product.image_attachment_ids.to_append | array of strings | IDs of attachment images to add to product |
product.image_attachment_ids.to_delete | array of strings | IDs of product images to remove |
product.variants_attributes | array of objects | The product variants (existing ones to remove or new ones) |
product.option_types_attributes | array of objects | Product options like Size, Color, etc. |
| Field | Type | Description |
|---|---|---|
id | string | Existing variant ID |
_destroy | number | Set to 1 to delete the variant |
is_master | boolean | Whether this is a master variant |
price | string | Price of the variant |
cost_per_item | string | Cost per item |
track_quantity | boolean | Whether to track quantity |
| Field | Type | Description |
|---|---|---|
is_master | boolean | Whether this is a master variant |
price | number | Price of the variant |
cost_per_item | number | Cost per item |
profit | number | Profit margin |
quantity | number | Stock quantity |
track_quantity | boolean | Whether to track quantity |
public_metadata | object | Metadata like SKU |
public_metadata.sku | string | SKU value from source system |
image_attachment_ids | object | Variant-specific images |
options | array | Option combinations for this variant |
| Field | Type | Description |
|---|---|---|
name | string | Option type name (e.g., \"Size\") |
option_values_attributes | array | Available values for this option |
option_values_attributes.name | string | Option value (e.g., \"Small\") |
{\n \"notice\": \"Product was successfully updated\",\n \"product_id\": \"product_id_string\"\n}\n\n| Field | Type | Description |
|---|---|---|
notice | string | Success message |
product_id | string | ID of the updated product |
{\n \"error\": \"Error message description\"\n}\n\nOnly include the fields you want to update - partial updates are supported
\nWhen updating variants, you can:
\nRemove existing variants by setting _destroy: 1
Create new variants with appropriate attributes
\nThe API maintains SKU references in the public_metadata.sku field
The system handles token refresh automatically if needed
\nFor image management, you must use valid attachment IDs generated by the Create Attachment API
\nRetrieves a list of products from the Everbee Store with pagination and optional filtering. This endpoint allows you to fetch products with various query parameters to filter and sort the results.
\n| Parameter | Type | Description | Default |
|---|---|---|---|
page | integer | Page number to retrieve | 1 |
per_page | integer | Number of products per page | 10 |
filter_params[conditions][][field] | string | Field to filter on | - |
filter_params[conditions][][operator] | string | Filter operator (is, contains, etc.) | - |
filter_params[conditions][][value] | string | Filter value | - |
sort | string | Sort parameter (field) | created_at |
filter_params[conditions][][field]=migrated_from_etsy&filter_params[conditions][][operator]=is&filter_params[conditions][][value]=true\n\nfilter_params[conditions][][field]=status&filter_params[conditions][][operator]=is&filter_params[conditions][][value]=published\n\nfilter_params[conditions][][field]=name&filter_params[conditions][][operator]=contains&filter_params[conditions][][value]=shirt\n\n{\n \"data\": [\n {\n \"id\": \"product_id_1\",\n \"type\": \"product\",\n \"attributes\": {\n \"name\": \"Product Name\",\n\"fields\": [\n {\n \"id\": \"description\",\n \"title\": \"Description\",\n \"content\": \"\"\n }\n ],\n \"available_on\": \"2024-01-01T00:00:00Z\",\n \"deleted_at\": null,\n \"slug\": \"product-name\",\n \"download_limit\": null,\n \"meta_title\": \"Product Name\",\n \"link\": \"https://store.example.com/products/product-name\",\n \"meta_description\": \"Product description\",\n \"meta_keywords\": null,\n \"tax_category_id\": null,\n \"shipping_category_id\": null,\n \"product_type\": \"physical\",\n \"promotionable\": true,\n \"discontinue_on\": null,\n \"public_metadata\": null,\n \"private_metadata\": null,\n \"status\": \"published\",\n \"make_active_at\": null,\n \"store_id\": \"store_id_string\",\n \"category_id\": \"category_id\",\n \"is_personalisation_required\": true,\n \"personalisation_options\": [\n {\n \"id\": \"e2edf3e5-ed47-43a7-bf10-fd355950665e\",\n \"character_limit\": 100,\n \"label\": \"This is custom text feel free to add.\",\n \"product_id\": \"fac22345-627e-4824-8465-633631a61274\",\n \"store_id\": \"506180fc-6405-421b-809d-d24977770605\",\n \"created_at\": \"2025-05-21T17:53:57.066Z\",\n \"updated_at\": \"2025-05-21T17:53:57.066Z\",\n \"is_optional_for_buyer\": false\n }\n ],\n \"personalisation_values\": [\n {\n \"id\": \"d3fc7494-1dc2-45b8-a704-1c9addcdfa5d\",\n \"instruction\": \"NICK\",\n \"customer_id\": null,\n \"cart_item_id\": null,\n \"personalisation_option_id\": \"e2edf3e5-ed47-43a7-bf10-fd355950665e\",\n \"store_id\": \"506180fc-6405-421b-809d-d24977770605\",\n \"created_at\": \"2025-05-21T17:55:03.226Z\",\n \"updated_at\": \"2025-05-21T17:55:03.226Z\",\n \"line_item_id\": \"7cab6897-6461-414e-8991-522b9c232315\"\n }\n ]\n \"visibility\": \"visible\",\n \"is_returnable\": null,\n \"days_for_delivery\": null,\n \"min_shipping_fee\": null,\n \"max_days_for_returns\": null,\n \"currency_symbol\": \"$\",\n \"updated_at\": \"2024-05-01T12:00:00Z\",\n \"orders_count\": 0,\n \"variants_count\": 2,\n \"tags\": [\"tag1\", \"tag2\"],\n \"master_variant\": {\n \"sku\": \"MASTER-SKU-123\",\n \"deleted_at\": null,\n \"is_master\": true,\n \"cost_per_item\": \"10.00\",\n \"position\": null,\n \"cost_currency\": null,\n \"public_metadata\": {\n \"sku\": \"MASTER-SKU-123\"\n },\n \"private_metadata\": null,\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-05-01T12:00:00Z\",\n \"id\": \"variant_id_master\",\n \"product_id\": \"product_id_1\",\n \"compare_at_price\": null,\n \"price\": \"29.99\",\n \"profit\": \"19.99\",\n \"margin\": \"66.66\",\n \"option_value_id\": null,\n \"store_id\": \"store_id_string\",\n \"digital_file_url\": null,\n \"etsy_meta_data\": {},\n \"upload_status\": \"completed\",\n \"track_quantity\": false,\n \"uuid\": null,\n \"available_quantity\": 99,\n \"collections\": [],\n \"files\": [],\n \"image_url\": [\n {\n \"id\": \"image_id_1\",\n \"image_url\": \"https://example.com/images/product_1.jpg\"\n }\n ],\n \"option_values\": []\n },\n \"can_buyer_buy_the_product\": true,\n \"product_belongs_to_buyers_migrated_subscription\": null,\n \"available_automatic_discount\": 0,\n \"option_types\": [\n {\n \"id\": \"option_type_id_1\",\n \"name\": \"Size\",\n \"position\": 1,\n \"filterable\": true,\n \"public_metadata\": null,\n \"private_metadata\": null,\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-05-01T12:00:00Z\",\n \"product_id\": \"product_id_1\",\n \"store_id\": \"store_id_string\",\n \"option_values\": [\n {\n \"id\": \"option_value_id_1\",\n \"name\": \"Small\",\n \"position\": 1,\n \"option_type_id\": \"option_type_id_1\",\n \"store_id\": \"store_id_string\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-05-01T12:00:00Z\"\n },\n {\n \"id\": \"option_value_id_2\",\n \"name\": \"Medium\",\n \"position\": 2,\n \"option_type_id\": \"option_type_id_1\",\n \"store_id\": \"store_id_string\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-05-01T12:00:00Z\"\n }\n ]\n }\n ],\n \"variants\": [\n {\n \"sku\": \"VARIANT-SKU-123\",\n \"deleted_at\": null,\n \"is_master\": false,\n \"cost_per_item\": \"10.00\",\n \"position\": null,\n \"cost_currency\": null,\n \"public_metadata\": {\n \"sku\": \"VARIANT-SKU-123\"\n },\n \"private_metadata\": null,\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-05-01T12:00:00Z\",\n \"id\": \"variant_id_1\",\n \"product_id\": \"product_id_1\",\n \"compare_at_price\": null,\n \"price\": \"29.99\",\n \"profit\": \"19.99\",\n \"margin\": \"66.66\",\n \"option_value_id\": \"option_value_id_1\",\n \"store_id\": \"store_id_string\",\n \"digital_file_url\": null,\n \"etsy_meta_data\": {},\n \"upload_status\": \"completed\",\n \"track_quantity\": true,\n \"uuid\": null,\n \"available_quantity\": 99,\n \"collections\": [],\n \"files\": [],\n \"image_url\": [\n {\n \"id\": \"image_id_2\",\n \"image_url\": \"https://example.com/images/product_1_small.jpg\"\n }\n ],\n \"option_values\": [\n {\n \"id\": \"option_value_id_1\",\n \"name\": \"Small\",\n \"position\": 1,\n \"option_type_id\": \"option_type_id_1\",\n \"store_id\": \"store_id_string\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-05-01T12:00:00Z\"\n }\n ]\n }\n ],\n \"image_url\": [\n {\n \"id\": \"image_id_1\",\n \"image_url\": \"https://example.com/images/product_1.jpg\"\n }\n ]\n }\n }\n ],\n \"matched_digital_products_count\": 0,\n \"unmatched_digital_products_count\": 0,\n \"total_pages\": 5,\n \"total_count\": 42\n}\n\n| Field | Type | Description |
|---|---|---|
data | array | Array of product objects |
matched_digital_products_count | integer | Count of matching digital products |
unmatched_digital_products_count | integer | Count of non-matching digital products |
total_pages | integer | Total number of pages available |
total_count | integer | Total number of products matching the query |
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier for the product |
type | string | Resource type (always \"product\") |
attributes | object | Product attributes and details |
| Field | Type | Description |
|---|---|---|
name | string | Product title |
description | string | Product description |
available_on | string | Date when product became available |
deleted_at | string/null | Deletion date if applicable |
slug | string | URL-friendly product name |
status | string | Product status (published, draft) |
product_type | string | Type of product (physical, digital) |
is_personalisation_required | boolean | Whether product requires personalization |
variants_count | integer | Number of product variants |
tags | array | Product tags |
master_variant | object | Main product variant information |
option_types | array | Product option types (size, color, etc.) |
variants | array | Array of product variants |
image_url | array | Product images |
{\n \"error\": \"Error message description\",\n \"redirect_url\": \"https://example.com/redirect\" \n}\n\nThe endpoint supports advanced filtering with condition arrays
\nFor products with variants, all variant information is included in the response
\nThe response includes metadata such as SKUs in the public_metadata field
Authentication token is refreshed automatically when needed
\nPagination information is provided in the response for client-side navigation
\nPerforms bulk operations on multiple products simultaneously. This endpoint allows you to update product status or other attributes for a batch of products in a single API call
\n{\n \"product\": {\n \"ids\": [\"product_id_1\", \"product_id_2\", \"product_id_3\"],\n \"status\": \"published\"\n }\n}\n\n| Field | Type | Description | Required |
|---|---|---|---|
product.ids | array of strings | Array of product IDs to update | Yes |
product.status | string | Status to set for all specified products | Yes |
| Value | Description |
|---|---|
published | Makes products visible and available for purchase |
draft | Makes products invisible and unavailable |
{\n \"notice\": \"Products were successfully updated\",\n \"updated_products_count\": 3\n}\n\n| HTTP Status | Description |
|---|---|
400 | Bad request - Missing required parameters or invalid values |
401 | Unauthorized - Invalid access token |
404 | Not found - One or more products not found |
500 | Internal server error |
All specified products must exist in the store
\nThe operation is atomic - if any product update fails, the entire operation fails
\nThe status change affects product visibility in the storefront
\nThis endpoint is optimized for performance with large batches of products
\nThe system automatically handles token refresh if needed during the operation
\nEndpoints for managing products in the Everbee Store
\n","_postman_id":"f573bd92-2445-45ae-acfe-a8153db7f9e9"},{"name":"Categories","item":[{"name":"List","id":"39295739-0bc1-4c73-ab32-2bcc628b817f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Access-Token","value":"your_access_token","type":"text"},{"key":"Store-Id","value":"your_store_id","type":"text"}],"url":"https://store-open-api.everbee.com/open_api/v1/categories","description":"This API endpoint list all product categories present in store. which can be reused later by create product API.
\n{\n \"data\": [\n {\n \"id\": \"ee7d733d-7935-4884-ace7-7d7214bce8c1\",\n \"type\": \"category\",\n \"attributes\": {\n \"id\": \"ee7d733d-7935-4884-ace7-7d7214bce8c1\",\n \"name\": \"mobile\",\n \"parent_id\": null,\n \"level\": 0,\n \"full_path_category_ids\": [],\n \"childrens\": {\n \"data\": []\n }\n }\n }\n ]\n}\n\n{\n \"error\": \"Error message describing the issue\"\n}\n\n{\n \"error\": \"Insufficient permissions\"\n}\n\nThis API retrieves a specific category description by category_id
\n{\n \"data\": {\n \"id\": \"ee7d733d-7935-4884-ace7-7d7214bce8c1\",\n \"type\": \"category\",\n \"attributes\": {\n \"id\": \"ee7d733d-7935-4884-ace7-7d7214bce8c1\",\n \"name\": \"mobile\",\n \"parent_id\": null,\n \"level\": 0,\n \"full_path_category_ids\": [],\n \"childrens\": {\n \"data\": []\n }\n }\n }\n}\n\n{\n \"error\": \"Error message describing the issue\"\n}\n\n{\n \"error\": \"Insufficient permissions\"\n}\n\nThis API endpoint gives all product category ids supported in everbee OpoShop.
\n","_postman_id":"e00d162c-48de-4ce3-9ad7-d4f1c3566200"},{"name":"Orders","item":[{"name":"Get Orders","id":"68eabb34-ca83-498a-b718-ef0f125f8695","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Access-Token","value":"your_access_token","type":"text"},{"key":"Store-Id","value":"your_store_id","type":"text"}],"url":"https://store-open-api.everbee.com/open_api/v1/orders?page=1&per_page=20","description":"Retrieves a list of orders from the Everbee Store with pagination and optional filtering. This endpoint allows you to fetch orders with various query parameters to filter and sort the results.
\n| Parameter | Type | Description | Default |
|---|---|---|---|
page | integer | Page number to retrieve | 1 |
per_page | integer | Number of orders per page | 20 |
filter_params[conditions][][field] | string | Field to apply filter on | |
filter_params[conditions][][operator] | string | Comparison operator | |
filter_params[conditions][][value] | string | Value |
| Field | Operators | Type | Example |
|---|---|---|---|
orderId | is, equals, startsWith, endsWith, isAnyOf, isNot | String | filter_params[conditions][][field]=orderId&filter_params[conditions][][operator]=is&filter_params[conditions][][value]=HZL8GSF |
order_status | is, equals | String | filter_params[conditions][][field]=order_status&filter_params[conditions][][operator]=is&filter_params[conditions][][value]=placed |
items | =, !=, >, >=, <, <= | Integer | filter_params[conditions][][field]=items&filter_params[conditions][][operator]==&filter_params[conditions][][value]=1 |
customer | is, equals, startsWith, endsWith, isAnyOf, isNot | String | filter_params[conditions][][field]=customer&filter_params[conditions][][operator]=startsWith&filter_params[conditions][][value]=Nikhil |
amount | =, !=, >, >=, <, <= | Number | filter_params[conditions][][field]=amount&filter_params[conditions][][operator]=>&filter_params[conditions][][value]=10 |
orderDate | between, withinTheLast, moreThan | DateTime | See date examples below |
Between two dates:
\nfilter_params[conditions][][field]=orderDate\n&filter_params[conditions][][operator]=between\n&filter_params[conditions][][value][]=2025-05-21+01:00:00+GMT+5:30\n&filter_params[conditions][][value][]=2025-05-23+01:00:00+GMT+5:30\n\nWithin last period:
\nfilter_params[conditions][][field]=orderDate\n&filter_params[conditions][][operator]=withinTheLast\n&filter_params[conditions][][value][]=1\n&filter_params[conditions][][value][]=hours\n\nMore than period ago:
\nfilter_params[conditions][][field]=orderDate\n&filter_params[conditions][][operator]=moreThan\n&filter_params[conditions][][value][]=1\n&filter_params[conditions][][value][]=weeks\n\nTime Units: minutes, hours, days, weeks
\nCombine filters by repeating the parameter structure:
\nfilter_params[conditions][][field]=orderId&filter_params[conditions][][operator]=startsWith&filter_params[conditions][][value]=HZ\n&filter_params[conditions][][field]=order_status&filter_params[conditions][][operator]=is&filter_params[conditions][][value]=placed\n\n{\n \"data\": [\n {\n \"id\": \"order_id_1\",\n \"type\": \"order\",\n \"attributes\": {\n \"status\": \"placed\",\n \"canceled_at\": null,\n \"cancellation_reason\": null,\n \"total_line_items_price\": \"79.97\",\n \"created_at\": \"2024-05-01T15:30:00Z\",\n \"order_number\": \"EB-12345\",\n \"updated_at\": \"2024-05-01T15:30:00Z\",\n \"shipping_address\": {\n \"address\": {\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"country\": \"US\",\n \"zipcode\": \"10001\",\n \"address_line1\": \"123 Main St\",\n \"address_line2\": \"Apt 4B\"\n },\n \"created_at\": \"2024-05-01T15:30:00Z\",\n \"updated_at\": \"2024-05-01T15:30:00Z\",\n \"id\": \"address_id_1\",\n \"addressable_type\": \"Customer\",\n \"addressable_id\": \"customer_id_1\",\n \"address_type\": \"shipping\"\n },\n \"country\": \"US\",\n \"currency_symbol\": \"$\",\n \"total_discount_percentage\": \"0\",\n \"order_status\": \"placed\",\n \"total_price\": \"87.96\",\n \"total_discount\": null,\n \"only_digital_products\": false,\n \"line_items\": [\n {\n \"id\": \"line_item_id_1\",\n \"quantity\": 2,\n \"variant_id\": \"variant_id_1\",\n \"store_id\": \"store_id_1\",\n \"order_id\": \"order_id_1\",\n \"created_at\": \"2024-05-01T15:30:00Z\",\n \"updated_at\": \"2024-05-01T15:30:00Z\",\n \"selling_group_id\": null,\n \"variant\": {\n \"sku\": \"VARIANT-SKU-123\",\n \"deleted_at\": null,\n \"is_master\": false,\n \"cost_per_item\": \"10.00\",\n \"position\": null,\n \"cost_currency\": null,\n \"public_metadata\": {\n \"sku\": \"VARIANT-SKU-123\"\n },\n \"private_metadata\": null,\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-05-01T12:00:00Z\",\n \"id\": \"variant_id_1\",\n \"product_id\": \"product_id_1\",\n \"compare_at_price\": null,\n \"price\": \"29.99\",\n \"profit\": \"19.99\",\n \"margin\": \"66.66\",\n \"option_value_id\": \"option_value_id_1\",\n \"inventory_id\": \"inventory_id_1\",\n \"store_id\": \"store_id_1\",\n \"digital_file_url\": null,\n \"etsy_meta_data\": {},\n \"upload_status\": \"completed\",\n \"uuid\": null,\n \"available_quantity\": 48,\n \"image_url\": [\n {\n \"id\": \"image_id_1\",\n \"image_url\": \"https://example.com/images/product_1.jpg\"\n }\n ]\n },\n \"download_urls\": [],\n \"product\": {\n \"name\": \"Product Name 1\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-05-01T12:00:00Z\",\n \"description\": \"Product description\",\n \"available_on\": \"2024-01-01T00:00:00Z\",\n \"deleted_at\": null,\n \"slug\": \"product-name-1\",\n \"meta_description\": \"Product description for SEO\",\n \"meta_keywords\": null,\n \"tax_category_id\": null,\n \"shipping_category_id\": null,\n \"promotionable\": true,\n \"meta_title\": \"Product Name 1\",\n \"discontinue_on\": null,\n \"public_metadata\": null,\n \"private_metadata\": null,\n \"status\": \"published\",\n \"make_active_at\": null,\n \"id\": \"product_id_1\",\n \"category_id\": \"category_id_1\",\n \"store_id\": \"store_id_1\",\n \"product_type\": \"physical\",\n \"visibility\": \"visible\",\n \"available\": null,\n \"amount_at_hand\": null,\n \"link\": \"https://example.com/products/product-name-1\",\n \"is_personalisation_required\": false,\n \"download_limit\": null,\n \"is_featured\": false\n }\n },\n {\n \"id\": \"line_item_id_2\",\n \"quantity\": 1,\n \"variant_id\": \"variant_id_2\",\n \"store_id\": \"store_id_1\",\n \"order_id\": \"order_id_1\",\n \"created_at\": \"2024-05-01T15:30:00Z\",\n \"updated_at\": \"2024-05-01T15:30:00Z\",\n \"selling_group_id\": null,\n \"variant\": {\n \"sku\": \"VARIANT-SKU-456\",\n \"deleted_at\": null,\n \"is_master\": false,\n \"cost_per_item\": \"8.00\",\n \"position\": null,\n \"cost_currency\": null,\n \"public_metadata\": {\n \"sku\": \"VARIANT-SKU-456\"\n },\n \"private_metadata\": null,\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-05-01T12:00:00Z\",\n \"id\": \"variant_id_2\",\n \"product_id\": \"product_id_2\",\n \"compare_at_price\": null,\n \"price\": \"19.99\",\n \"profit\": \"11.99\",\n \"margin\": \"59.98\",\n \"option_value_id\": \"option_value_id_2\",\n \"inventory_id\": \"inventory_id_2\",\n \"store_id\": \"store_id_1\",\n \"digital_file_url\": null,\n \"etsy_meta_data\": {},\n \"upload_status\": \"completed\",\n \"uuid\": null,\n \"available_quantity\": 35,\n \"image_url\": [\n {\n \"id\": \"image_id_2\",\n \"image_url\": \"https://example.com/images/product_2.jpg\"\n }\n ]\n },\n \"download_urls\": [],\n \"product\": {\n \"name\": \"Product Name 2\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-05-01T12:00:00Z\",\n \"description\": \"Product description\",\n \"available_on\": \"2024-01-01T00:00:00Z\",\n \"deleted_at\": null,\n \"slug\": \"product-name-2\",\n \"meta_description\": \"Product description for SEO\",\n \"meta_keywords\": null,\n \"tax_category_id\": null,\n \"shipping_category_id\": null,\n \"promotionable\": true,\n \"meta_title\": \"Product Name 2\",\n \"discontinue_on\": null,\n \"public_metadata\": null,\n \"private_metadata\": null,\n \"status\": \"published\",\n \"make_active_at\": null,\n \"id\": \"product_id_2\",\n \"category_id\": \"category_id_1\",\n \"store_id\": \"store_id_1\",\n \"product_type\": \"physical\",\n \"visibility\": \"visible\",\n \"available\": null,\n \"amount_at_hand\": null,\n \"link\": \"https://example.com/products/product-name-2\",\n \"is_personalisation_required\": false,\n \"download_limit\": null,\n \"is_featured\": false\n }\n }\n ],\n \"selling_group\": [],\n \"discounts\": [],\n \"customer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@example.com\",\n \"phone_number\": \"+1234567890\",\n \"notes\": \"\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-05-01T15:30:00Z\",\n \"id\": \"customer_id_1\",\n \"store_id\": \"store_id_1\",\n \"password_digest\": null,\n \"guest\": true,\n \"password_reset_token\": null,\n \"password_reset_sent_at\": null,\n \"stripe_customer_id\": null,\n \"selling_group_version_id\": null,\n \"selling_group_id\": null,\n \"stripe_subscription_id\": null,\n \"migrated_selling_group_id\": null,\n \"is_subscriber\": false,\n \"addresses\": [\n {\n \"address\": {\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"country\": \"US\",\n \"zipcode\": \"10001\",\n \"address_line1\": \"123 Main St\",\n \"address_line2\": \"Apt 4B\"\n },\n \"created_at\": \"2024-05-01T15:30:00Z\",\n \"updated_at\": \"2024-05-01T15:30:00Z\",\n \"id\": \"address_id_1\",\n \"addressable_type\": \"Customer\",\n \"addressable_id\": \"customer_id_1\",\n \"address_type\": \"shipping\"\n }\n ]\n },\n \"items\": []\n }\n }\n ],\n \"total_pages\": 3,\n \"total_count\": 42\n}\n\n| Field | Type | Description |
|---|---|---|
data | array | Array of order objects |
total_pages | integer | Total number of pages available |
total_count | integer | Total number of orders matching the query |
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier for the order |
type | string | Resource type (always \"order\") |
attributes | object | Order attributes and details |
| Field | Type | Description |
|---|---|---|
status | string | Order status (placed, cancelled, etc.) |
canceled_at | string/null | Cancellation date if applicable |
total_line_items_price | string | Total price of all line items |
created_at | string | Order creation date |
order_number | string | Order reference number |
updated_at | string | Last update date |
shipping_address | object | Shipping address details |
country | string | Country code |
currency_symbol | string | Currency symbol |
total_price | string | Order total including shipping |
total_discount | string/null | Total discount amount |
line_items | array | Array of ordered items |
customer | object | Customer information |
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier for the line item |
quantity | integer | Quantity ordered |
variant_id | string | Variant ID |
order_id | string | Order ID |
variant | object | Complete variant information |
product | object | Product information |
| Field | Type | Description |
|---|---|---|
first_name | string | Customer's first name |
last_name | string | Customer's last name |
email | string | Customer's email address |
phone_number | string | Customer's phone number |
id | string | Customer ID |
guest | boolean | Whether customer is a guest |
addresses | array | Customer addresses |
\"is_personalisation_required\": true,\n\"personalisation_options\": [\n {\n \"id\": \"e2edf3e5-ed47-43a7-bf10-fd355950665e\",\n \"character_limit\": 100,\n \"label\": \"This is custom text feel free to add.\",\n \"product_id\": \"fac22345-627e-4824-8465-633631a61274\",\n \"store_id\": \"506180fc-6405-421b-809d-d24977770605\",\n \"created_at\": \"2025-05-21T17:53:57.066Z\",\n \"updated_at\": \"2025-05-21T17:53:57.066Z\",\n \"is_optional_for_buyer\": false\n }\n],\n\"personalisation_values\": [\n {\n \"id\": \"d3fc7494-1dc2-45b8-a704-1c9addcdfa5d\",\n \"instruction\": \"Sample Test\",\n \"customer_id\": null,\n \"cart_item_id\": null,\n \"personalisation_option_id\": \"e2edf3e5-ed47-43a7-bf10-fd355950665e\",\n \"store_id\": \"506180fc-6405-421b-809d-d24977770605\",\n \"created_at\": \"2025-05-21T17:55:03.226Z\",\n \"updated_at\": \"2025-05-21T17:55:03.226Z\",\n \"line_item_id\": \"7cab6897-6461-414e-8991-522b9c232315\"\n }\n]\n\nOrders are typically sorted by creation date (newest first)
\nLine items include full product and variant information
\nCustomer details are included with each order
\nFor POD products, SKUs can be found in the variant's public_metadata.sku field
The system automatically handles token refresh if needed
\nFor performance reasons with large orders, consider using a smaller per_page value
The Update Tracking API allows you to update order tracking information in the Everbee Store system. This API is used when shipping details become available for an order, such as when a carrier provides a tracking number and shipping status update.
\nOnce a tracking link is provided for an order line item, the line item's fulfillment status is automatically updated to shipped.
\nAdditionally, an order is automatically marked as shipped once tracking links have been added to all line items in the order. No additional API call is required to mark the order as shipped.
\nNote - Do not call the Order Update API separately to update the order status to shipped. Doing so may result in an error if all line items in the order do not have tracking links.
\n| Field | Type | Required | Description |
|---|---|---|---|
tracking.tracking_number | string | Yes | The tracking number provided by the carrier |
tracking.carrier | string | Yes | The name or code of the carrier (e.g., \"USPS\", \"FedEx\") |
tracking.tracking_link | string | Yes | The URL where the customer can track their shipment |
tracking.tracking_line_items_attributes | array | Yes | Array of line items to associate with this tracking |
tracking.tracking_line_items_attributes[].line_item_id | string | Yes | The ID of the line item in the Everbee Store |
{\n \"id\": \"string\",\n \"tracking_number\": \"string\",\n \"carrier\": \"string\",\n \"tracking_link\": \"string\",\n \"order_id\": \"string\",\n \"store_id\": \"string\",\n \"created_at\": \"2025-05-09T10:00:00.000Z\",\n \"updated_at\": \"2025-05-09T10:00:00.000Z\",\n \"shipping_label_id\": \"string\",\n \"fulfillment_id\": \"string\"\n}\n\n| Field | Type | Description |
|---|---|---|
id | string | Unique identifier for the tracking record |
tracking_number | string | The tracking number |
carrier | string | The carrier name/code |
tracking_link | string | URL for tracking the shipment |
order_id | string | The ID of the associated order |
store_id | string | The ID of the store |
created_at | string | ISO 8601 timestamp of when the tracking was created |
updated_at | string | ISO 8601 timestamp of when the tracking was last updated |
The Fulfillment Update API allows you to update the status of order line items (aka order fulfillment) and mark them as delivered after shipping is completed.
\nAn order is automatically marked as delivered once all order line_items are marked as delivered. no need to call additional api to update the status of order. direct order status update might give error if all order fulfillments in order are not updated to delivered. so its recommended to update status of individual line_items via fulfillment_update API
\n| Field | Type | Required | Description |
|---|---|---|---|
fulfillment.status | string | Yes | value should be \"delivered\" |
fulfillment.line_items | Array | Yes | All line_item ids of a order where status need to marked as delivered |
{\n \"notice\": \"Fulfillment status updated to delivered\"\n}\n\n| Field | Type | Description |
|---|---|---|
notice/error | string | message/error for delivered order status |
This documentation provides a comprehensive guide for using Postman to interact with the Everbee Store API endpoint for bulk updating order statuses. The API allows you to update the status of multiple orders in a single request, making it efficient for batch processing scenarios.
\nIt is recommended to use the Tracking API to mark individual line items as shipped and the Fulfillment Update API to mark individual line items as delivered.
\nIf all line items in an order are marked as shipped, the order status is automatically updated to shipped, so there is no need to update order status in bulk or indvidually.
\n| Name | Type | Required | Description |
|---|---|---|---|
order.ids | array of strings | Yes | Array of order IDs to update |
order.status | string | Yes | New status to set for all orders. Valid values: draft, placed, shipped, cancelled, delivered |
{\n \"notice\": \"Orders updated successfully\"\n}\n\n{\n \"error\": \"Error message describing the issue\"\n}\n\nThis endpoint supports updating multiple orders in a single request
\nAll provided order IDs must exist in the system
\nThe status value must be one of the valid status options
\nIf any order cannot be updated, the request will fail for all orders
\nToken refresh is handled automatically if the access token has expired
\nEndpoints for managing orders in the Everbee Store
\n","_postman_id":"612a4ff5-2486-4f20-9462-bd803c81e221"},{"name":"Attachments","item":[{"name":"Create Attachment","id":"b0eba975-eaef-4cef-aca0-cb418f2fd61b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Access-Token","value":"your_access_token","type":"text"},{"key":"Store-Id","value":"your_store_id","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"blob\": {\n \"filename\": \"product-image.jpg\",\n \"byte_size\": 12345,\n \"checksum\": \"md5checksum\",\n \"content_type\": \"image/jpeg\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://store-open-api.everbee.com/open_api/v1/attachments","description":"Creates a new attachment and returns a direct upload URL for uploading the image.
\n| Name | Type | Required | Description |
|---|---|---|---|
Authorization | string | Yes | Bearer token for authentication |
Content-Type | string | Yes | Must be application/json |
Store-Id | string | Yes | The Everbee store Id |
X-Access-Token | string | Yes | Access token obtained from Everbee authentication |
| Parameter | Type | Required | Description |
|---|---|---|---|
blob | object | Yes | Container for file metadata |
blob.filename | string | Yes | The name of the file to be uploaded |
blob.byte_size | integer | Yes | The size of the file in bytes |
blob.checksum | string | Yes | MD5 checksum of the file encoded in base64 |
blob.content_type | string | Yes | MIME type of the file (e.g., \"image/jpeg\", \"image/png\") |
| Field | Type | Description |
|---|---|---|
key | string | Unique identifier for the file in storage |
filename | string | The uploaded file's name |
content_type | string | MIME type of the file |
metadata | object | Optional metadata associated with the file |
service_name | string | Name of the storage service |
byte_size | integer | Size of the file in bytes |
checksum | string | MD5 checksum of the file |
created_at | string | ISO 8601 timestamp when the attachment was created |
id | string | Unique ID of the attachment |
signed_id | string | Secure reference to the attachment that can be used in subsequent API calls |
attachable_sgid | string | Globally unique identifier for the attachment |
blob_url | string | URL to access the file once uploaded |
direct_upload | object | Contains information needed to upload the file |
direct_upload.url | string | URL to which the file should be uploaded |
direct_upload.headers | object | HTTP headers to include in the upload request |
After receiving the response, you'll need to:
\nUpload the file to the URL specified in direct_upload.url
Include all headers specified in direct_upload.headers
Use the signed_id to reference the file in other API calls (e.g., when assigning images to products)
The maximum file size allowed is 10MB
\nSupported file formats: JPEG, PNG, GIF, SVG
\nThe presigned URL expires after 30 minutes
\nAfter uploading the file, the signed_id should be used when assigning the image to products or variants
Files that remain unreferenced for more than 24 hours may be automatically deleted
\nCreates a new attachment directly using a URL. URL should be accessible and shoulb be valid image url.
\n| Name | Type | Required | Description |
|---|---|---|---|
Authorization | string | Yes | Bearer token for authentication |
Content-Type | string | Yes | Must be application/json |
Store-Id | string | Yes | The Everbee Store Id |
X-Access-Token | string | Yes | Access token obtained from Everbee authentication |
| Parameter | Type | Required | Description |
|---|---|---|---|
media_url | string | Yes | Image URL for image upload |
| Field | Type | Description |
|---|---|---|
key | string | Unique identifier for the file in storage |
filename | string | The uploaded file's name |
content_type | string | MIME type of the file |
metadata | object | Optional metadata associated with the file |
service_name | string | Name of the storage service |
byte_size | integer | Size of the file in bytes |
checksum | string | MD5 checksum of the file |
created_at | string | ISO 8601 timestamp when the attachment was created |
id | string | Unique ID of the attachment |
signed_id | string | Secure reference to the attachment that can be used in subsequent API calls |
attachable_sgid | string | Globally unique identifier for the attachment |
blob_url | string | URL to access the file once uploaded |
After receiving the response, you can access the URL shared in response directly to view the image. no need for additional steps.
\nNote: It might take some time for image to fully upload, image upload process happens in background.
\nThe maximum file size allowed is 10MB
\nSupported file formats: JPEG, PNG, GIF, SVG
\nThe presigned URL expires after 30 minutes
\nAfter uploading the file, the signed_id should be used when assigning the image to products or variants
Files that remain unreferenced for more than 24 hours may be automatically deleted
\nCreates a new attachment using direct file blob
\n| Name | Type | Required | Description |
|---|---|---|---|
Authorization | string | Yes | Bearer token for authentication |
Content-Type | string | Yes | Must be application/json |
Store-Id | string | Yes | The Everbee store Id |
X-Access-Token | string | Yes | Access token obtained from Everbee authentication |
| Parameter | Type | Required | Description |
|---|---|---|---|
blob | object | Yes | File blob |
| Field | Type | Description |
|---|---|---|
key | string | Unique identifier for the file in storage |
filename | string | The uploaded file's name |
content_type | string | MIME type of the file |
metadata | object | Optional metadata associated with the file |
service_name | string | Name of the storage service |
byte_size | integer | Size of the file in bytes |
checksum | string | MD5 checksum of the file |
created_at | string | ISO 8601 timestamp when the attachment was created |
id | string | Unique ID of the attachment |
signed_id | string | Secure reference to the attachment that can be used in subsequent API calls |
attachable_sgid | string | Globally unique identifier for the attachment |
blob_url | string | URL to access the file once uploaded |
After receiving the response, you can access the URL shared in response directly to view the image. no need for additional steps.
\nThe maximum file size allowed is 10MB
\nSupported file formats: JPEG, PNG, GIF, SVG
\nThe presigned URL expires after 30 minutes
\nAfter uploading the file, the signed_id should be used when assigning the image to products or variants
Files that remain unreferenced for more than 24 hours may be automatically deleted
\nEndpoints for managing attachments and images in the Everbee Store.
\nEverbee supports 3 types of attachment uploads
\n2 Step upload using image signed_id.
\n1 Step upload using image URL.
\n1 Step upload using direct file blob.
\nAll 3 types are explained below -
\n","_postman_id":"53860a87-2bb7-4f6c-b241-1c2f2e8496c1"},{"name":"Locations","item":[{"name":"Index","id":"793c290b-6612-4d2c-80d1-4bdd5e48a1ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Access-Token","value":"eyJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJldmVyYmVlLXNzbyIsImlhdCI6MTc3OTEyMzQ1NCwiZXhwIjoxNzc5NzI4MjU0LCJqdGkiOiI2YTRkNDAxNDA5MzciLCJ1c2VyX2lkIjoiZjFjNDg5MzAtMjNlNi00NGVlLWFjM2EtZjY5NGNiNGQzZjU3IiwiZW1haWwiOiJuaWtoaWxAZXZlcmJlZS5pbyIsInR2IjoxMCwiaWJwIjpmYWxzZSwiaWJzIjp0cnVlLCJzb3MiOmZhbHNlLCJhY3QiOiIxIiwiYXVkIjoiN1pYX2lPTzFiM2tES3hWOWV5bDRadjhCaldpb1dqTU51eWU3aHB6amp0QSIsInNjb3BlcyI6WyJwcm9kdWN0czpyZWFkIiwicHJvZHVjdHM6d3JpdGUiLCJvcmRlcnM6cmVhZCIsIm9yZGVyczp3cml0ZSIsImF0dGFjaG1lbnRzOndyaXRlIiwic2hpcHBpbmdfcHJvZmlsZXM6d3JpdGUiLCJzaGlwcGluZ19wcm9maWxlczpyZWFkIiwiY29sbGVjdGlvbnM6cmVhZCIsImNvbGxlY3Rpb25zOndyaXRlIiwid2ViaG9va3M6cmVhZCIsIndlYmhvb2tzOndyaXRlIiwidXNlcnM6cmVhZCIsIm5vdGlmaWNhdGlvbnM6cmVhZCIsIm5vdGlmaWNhdGlvbnM6d3JpdGUiXX0.hf7p0s-YpLy1GQsQT6J7WQpwVHcapiSkVyLH_9mmdJJXqCpc9z9FKEQaDPxFMaR3FnVc6XxtB8dSswfY1i3Vkg","type":"text"},{"key":"Store-Id","value":"06371bfe-7882-423b-9b90-7ee8debcb7c0","type":"text"}],"url":"https://store-open-api.everbee.com/open_api/v1/api/v1/geographies","description":"GET https://store-open-api.everbee.com/open_api/v1/open_api/v1/locations/
Returns a paginated list of all locations associated with the authenticated store. Each location represents a physical or logical site — such as a warehouse, retail outlet, or fulfilment point — linked to the store's operational setup. Use this endpoint to retrieve location IDs for use in other API calls, populate location dropdowns in admin interfaces, or audit the store's location configuration.
\nGET https://store-open-api.everbee.com/open_api/v1/open_api/v1/locations/\nNone
\nNone — this is a GET request.
200 OK{\n \"locations\": [\n {\n \"id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"name\": \"Main Warehouse\",\n \"address1\": \"123 Fulfilment Ave\",\n \"address2\": null,\n \"city\": \"Austin\",\n \"state\": \"TX\",\n \"zip\": \"78701\",\n \"country\": \"US\",\n \"phone\": \"+15125550100\",\n \"active\": true,\n \"created_at\": \"2023-06-01T09:00:00.000Z\",\n \"updated_at\": \"2024-01-10T12:00:00.000Z\"\n },\n {\n \"id\": \"b2c3d4e5-f6a7-8901-bcde-f12345678901\",\n \"name\": \"East Coast Outlet\",\n \"address1\": \"456 Commerce St\",\n \"address2\": \"Suite 200\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zip\": \"10001\",\n \"country\": \"US\",\n \"phone\": null,\n \"active\": true,\n \"created_at\": \"2023-09-15T14:30:00.000Z\",\n \"updated_at\": \"2024-03-22T08:45:00.000Z\"\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"per_page\": 20,\n \"total_count\": 2,\n \"total_pages\": 1\n }\n}\n401 Unauthorized{\n \"error\": \"unauthorized\",\n \"message\": \"Invalid or expired access token.\"\n}\n403 Forbidden{\n \"error\": \"forbidden\",\n \"message\": \"You do not have permission to access locations for this store.\"\n}\n404 Not Found{\n \"error\": \"not_found\",\n \"message\": \"Store not found.\"\n}\ncurl --location 'https://store.everbee.com/open_api/v1/locations/?page=1&per_page=20' \\\n--header 'X-Access-Token: eyJhbGci...' \\\n--header 'Store-Id: e3596362-b83d-4149-bfd9-165a35572f19'\nX-Access-Token must be a valid, non-expired JWT.Store-Id must be a valid UUID corresponding to a store the authenticated user has access to.page must be a positive integer if provided.per_page must be a positive integer if provided; excessively large values may be capped by the server.Store-Id header — only locations belonging to that store are returned.active is false) may or may not be included depending on server configuration; check the active field on each result.id values returned here can be used in other API endpoints that require a location_id parameter (e.g., fulfilment location assignment, inventory management).locations array will be empty and total_count will be 0.Contains endpoints for querying store locations within the Everbee platform. A location represents a physical or logical place associated with a store — such as a warehouse, retail outlet, or fulfilment point — and is used to associate inventory, orders, and fulfilment operations with a specific geographic or operational site.
\nThis folder currently exposes a single endpoint:
\nGET https://store-open-api.everbee.com/open_api/v1/open_api/v1/fulfillment_locations
Retrieves a list of all fulfillment locations associated with the authenticated store. Use this endpoint to get an overview of all physical or third-party locations from which orders are fulfilled.
\nGET https://store-open-api.everbee.com/open_api/v1/open_api/v1/fulfillment_locations\nNone
\nNone
\nNone
\n200 OK{\n \"fulfillment_locations\": [\n {\n \"id\": \"514406bc-6602-4dee-a0ea-48dfd8d7849e\",\n \"name\": \"Main Warehouse\",\n \"address_line1\": \"123 Storage Lane\",\n \"address_line2\": \"Suite 100\",\n \"city\": \"Shipping City\",\n \"state\": \"ST\",\n \"country\": \"United States\",\n \"country_code\": \"US\",\n \"source\": \"printify\",\n \"source_type\": \"third_party\",\n \"active\": true,\n \"created_at\": \"2024-01-15T10:00:00.000Z\",\n \"updated_at\": \"2024-03-20T14:30:00.000Z\"\n }\n ],\n \"meta\": {\n \"total\": 1,\n \"page\": 1,\n \"per_page\": 25\n }\n}\n401 Unauthorized{\n \"error\": \"unauthorized\",\n \"message\": \"Invalid or expired access token.\"\n}\n403 Forbidden{\n \"error\": \"forbidden\",\n \"message\": \"You do not have permission to access this store's fulfillment locations.\"\n}\ncurl --location 'https://store.everbee.com/open_api/v1/fulfillment_locations' \\\n--header 'X-Access-Token: eyJhbGci...' \\\n--header 'Store-Id: e3596362-b83d-4149-bfd9-165a35572f19'\nX-Access-Token must be a valid, non-expired JWT.Store-Id must correspond to a store the authenticated user has access to.active status.source field reflects the third-party fulfillment provider integrated with the store.GET https://store-open-api.everbee.com/open_api/v1/open_api/v1/fulfillment_locations/{{fulfillmentLocationId}}
Retrieves the full details of a single fulfillment location by its unique ID. Use this endpoint to inspect the configuration and address details of a specific fulfillment location.
\nGET https://store-open-api.everbee.com/open_api/v1/open_api/v1/fulfillment_locations/{{fulfillmentLocationId}}\nNone
\nNone
\n200 OK{\n \"fulfillment_location\": {\n \"id\": \"514406bc-6602-4dee-a0ea-48dfd8d7849e\",\n \"name\": \"Main Warehouse\",\n \"address_line1\": \"123 Storage Lane\",\n \"address_line2\": \"Suite 100\",\n \"city\": \"Shipping City\",\n \"state\": \"ST\",\n \"country\": \"United States\",\n \"country_code\": \"US\",\n \"source\": \"printify\",\n \"source_type\": \"third_party\",\n \"active\": true,\n \"created_at\": \"2024-01-15T10:00:00.000Z\",\n \"updated_at\": \"2024-03-20T14:30:00.000Z\"\n }\n}\n401 Unauthorized{\n \"error\": \"unauthorized\",\n \"message\": \"Invalid or expired access token.\"\n}\n403 Forbidden{\n \"error\": \"forbidden\",\n \"message\": \"You do not have permission to access this fulfillment location.\"\n}\n404 Not Found{\n \"error\": \"not_found\",\n \"message\": \"Fulfillment location with the given ID does not exist.\"\n}\ncurl --location 'https://store.everbee.com/open_api/v1/fulfillment_locations/514406bc-6602-4dee-a0ea-48dfd8d7849e' \\\n--header 'X-Access-Token: eyJhbGci...' \\\n--header 'Store-Id: e3596362-b83d-4149-bfd9-165a35572f19'\nfulfillmentLocationId must be a valid UUID.X-Access-Token must be valid and non-expired.Store-Id must match the store that owns the fulfillment location.404 if the ID is valid UUID format but does not match any existing record.Store-Id header is used to scope the lookup — a location belonging to a different store will return 403.POST https://store-open-api.everbee.com/open_api/v1/open_api/v1/fulfillment_locations
Creates a new fulfillment location for the authenticated store. Use this endpoint to register a physical warehouse or a third-party fulfillment provider as a location from which orders can be shipped.
\nPOST https://store-open-api.everbee.com/open_api/v1/open_api/v1/fulfillment_locations\nNone
\nNone
\n{\n \"fulfillment_location\": {\n \"name\": \"Main Warehouse Testing\",\n \"address_line1\": \"123 Storage Lane\",\n \"address_line2\": \"Address line 2\",\n \"city\": \"Shipping City\",\n \"state\": \"ST\",\n \"country\": \"United States\",\n \"country_code\": \"US\",\n \"source\": \"printify\",\n \"source_type\": \"third_party\"\n }\n}\n201 Created{\n \"fulfillment_location\": {\n \"id\": \"514406bc-6602-4dee-a0ea-48dfd8d7849e\",\n \"name\": \"Main Warehouse Testing\",\n \"address_line1\": \"123 Storage Lane\",\n \"address_line2\": \"Address line 2\",\n \"city\": \"Shipping City\",\n \"state\": \"ST\",\n \"country\": \"United States\",\n \"country_code\": \"US\",\n \"source\": \"printify\",\n \"source_type\": \"third_party\",\n \"active\": true,\n \"created_at\": \"2024-05-06T10:00:00.000Z\",\n \"updated_at\": \"2024-05-06T10:00:00.000Z\"\n }\n}\n401 Unauthorized{\n \"error\": \"unauthorized\",\n \"message\": \"Invalid or expired access token.\"\n}\n403 Forbidden{\n \"error\": \"forbidden\",\n \"message\": \"You do not have permission to create fulfillment locations for this store.\"\n}\n422 Unprocessable Entity{\n \"error\": \"unprocessable_entity\",\n \"errors\": {\n \"name\": [\"can't be blank\"],\n \"address_line1\": [\"can't be blank\"],\n \"country_code\": [\"is not a valid ISO 3166-1 alpha-2 code\"],\n \"source_type\": [\"is not included in the list\"]\n }\n}\ncurl --location 'https://store.everbee.com/open_api/v1/fulfillment_locations' \\\n--header 'X-Access-Token: eyJhbGci...' \\\n--header 'Store-Id: e3596362-b83d-4149-bfd9-165a35572f19' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"fulfillment_location\": {\n \"name\": \"Main Warehouse Testing\",\n \"address_line1\": \"123 Storage Lane\",\n \"address_line2\": \"Address line 2\",\n \"city\": \"Shipping City\",\n \"state\": \"ST\",\n \"country\": \"United States\",\n \"country_code\": \"US\",\n \"source\": \"printify\",\n \"source_type\": \"third_party\"\n }\n}'\nGeneral
\nContent-Type header must be application/json.Field-Specific
\nname — Must be a non-empty string. Must be unique within the store.address_line1 — Required; cannot be blank.city — Required; cannot be blank.state — Required; should be a valid state/province abbreviation.country_code — Must be a valid ISO 3166-1 alpha-2 code (e.g., US, CA, GB).source_type — Must be one of: third_party, internal.active: true by default.id is system-generated and cannot be specified in the request.source field should match a supported fulfillment provider integrated with your store.address_line2 is optional and can be omitted or set to null.PUT https://store-open-api.everbee.com/open_api/v1/open_api/v1/fulfillment_locations/{{fulfillmentLocationId}}
Updates the details of an existing fulfillment location. Use this endpoint to modify the name, address, or source configuration of a fulfillment location that has already been created.
\nPUT https://store-open-api.everbee.com/open_api/v1/open_api/v1/fulfillment_locations/{{fulfillmentLocationId}}\nNone
\n{\n \"fulfillment_location\": {\n \"name\": \"Main Warehouse Testing\",\n \"address_line1\": \"123 Storage Lane\",\n \"address_line2\": \"Address line 2\",\n \"city\": \"Shipping City\",\n \"state\": \"ST\",\n \"country\": \"United States\",\n \"country_code\": \"US\",\n \"source\": \"printify\",\n \"source_type\": \"third_party\"\n }\n}\n200 OK{\n \"fulfillment_location\": {\n \"id\": \"514406bc-6602-4dee-a0ea-48dfd8d7849e\",\n \"name\": \"Main Warehouse Testing\",\n \"address_line1\": \"123 Storage Lane\",\n \"address_line2\": \"Address line 2\",\n \"city\": \"Shipping City\",\n \"state\": \"ST\",\n \"country\": \"United States\",\n \"country_code\": \"US\",\n \"source\": \"printify\",\n \"source_type\": \"third_party\",\n \"active\": true,\n \"created_at\": \"2024-01-15T10:00:00.000Z\",\n \"updated_at\": \"2024-05-06T14:30:00.000Z\"\n }\n}\n401 Unauthorized{\n \"error\": \"unauthorized\",\n \"message\": \"Invalid or expired access token.\"\n}\n403 Forbidden{\n \"error\": \"forbidden\",\n \"message\": \"You do not have permission to update this fulfillment location.\"\n}\n404 Not Found{\n \"error\": \"not_found\",\n \"message\": \"Fulfillment location with the given ID does not exist.\"\n}\n422 Unprocessable Entity{\n \"error\": \"unprocessable_entity\",\n \"errors\": {\n \"name\": [\"can't be blank\"],\n \"country_code\": [\"is not a valid ISO 3166-1 alpha-2 code\"],\n \"source_type\": [\"is not included in the list\"]\n }\n}\ncurl --location --request PUT 'https://store.everbee.com/open_api/v1/fulfillment_locations/514406bc-6602-4dee-a0ea-48dfd8d7849e' \\\n--header 'X-Access-Token: eyJhbGci...' \\\n--header 'Store-Id: e3596362-b83d-4149-bfd9-165a35572f19' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"fulfillment_location\": {\n \"name\": \"Main Warehouse Testing\",\n \"address_line1\": \"123 Storage Lane\",\n \"address_line2\": \"Address line 2\",\n \"city\": \"Shipping City\",\n \"state\": \"ST\",\n \"country\": \"United States\",\n \"country_code\": \"US\",\n \"source\": \"printify\",\n \"source_type\": \"third_party\"\n }\n}'\nGeneral
\nfulfillmentLocationId in the URL must be a valid UUID.Content-Type header must be application/json.fulfillment_location should be provided.Field-Specific
\nname — If provided, must be a non-empty string.country_code — If provided, must be a valid ISO 3166-1 alpha-2 code.source_type — If provided, must be one of: third_party, internal.state — If provided, should be a valid state/province abbreviation.id and created_at fields are immutable and cannot be changed via this endpoint.source or source_type may affect how orders are routed to this location.updated_at timestamp is automatically set to the current time on every successful update.source) when switching from one print-on-demand service to another.active to false.Contains endpoints for managing fulfillment locations within the Everbee platform. This folder covers the full lifecycle of a fulfillment location — listing all locations (Index), retrieving a specific location by ID (Show), creating a new fulfillment location (Create), and updating an existing one (Update). These endpoints are used to configure and maintain the physical or logical locations from which orders are fulfilled.
\n","_postman_id":"5b6b9eba-f5c4-4610-acf9-d802a8260488"},{"name":"Shipping Profiles V1 (Deprecated)","item":[{"name":"Get Shipping Profiles","id":"d9c26ac5-105b-4aa0-b67f-81e82b0b2812","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Access-Token","value":"your_access_token","type":"text"},{"key":"Store-Id","value":"your_store_id","type":"text"}],"url":"https://store-open-api.everbee.com/open_api/v1/shipping_profiles","description":"This API retrieves all shipping profiles configured for an Store. Shipping profiles define the shipping costs and delivery timeframes for products in the store.
\nNo request body or query parameters required.
\n{\n \"data\": [\n {\n \"id\": \"shipping_profile_123\",\n \"type\": \"shipping_profile\",\n \"attributes\": {\n \"name\": \"Default shipping fee\",\n \"fee_type\": \"flat\",\n \"min_shipping_period\": 5,\n \"max_shipping_period\": 7,\n \"amount\": \"4.99\"\n }\n },\n {\n \"id\": \"shipping_profile_456\",\n \"type\": \"shipping_profile\",\n \"attributes\": {\n \"name\": \"Free shipping\",\n \"fee_type\": \"free\",\n \"min_shipping_period\": 7,\n \"max_shipping_period\": 10,\n \"amount\": \"0.00\"\n }\n }\n ]\n}\n\n{\n \"error\": \"Error message describing the issue\"\n}\n\n{\n \"error\": \"Unauthorized access\",\n \"redirect_url\": \"https://auth.everbee.io/some-path\"\n}\n\n| Field | Type | Description |
|---|---|---|
data | array | List of shipping profiles |
data[].id | string | Unique identifier for the shipping profile |
data[].type | string | Resource type (always \"shipping_profile\") |
data[].attributes | object | Profile details |
data[].attributes.name | string | Name of the shipping profile |
data[].attributes.fee_type | string | Type of fee: \"flat\" or \"free\" |
data[].attributes.min_shipping_period | integer | Minimum shipping time in days |
data[].attributes.max_shipping_period | integer | Maximum shipping time in days |
data[].attributes.amount | string | Shipping fee amount (decimal string) |
This API returns all shipping profiles configured for the store, with no pagination or filtering options.
\nA store can have multiple shipping profiles, typically including at least one default profile.
\nThe fee_type can be either \"flat\" (fixed shipping fee) or \"free\" (no shipping charge).
For \"free\" shipping profiles, the amount will typically be \"0.00\".
\nShipping periods are expressed in business days.
\nThis API is read-only and does not modify any shipping profiles.
\nThe shipping profiles returned by this API are used to apply shipping costs to products when they are added to a customer's cart.
\nTo modify shipping profiles, use the Create or Update Shipping Profile APIs.
\nThis API creates a new shipping profile in the Everbee Store system. Shipping profiles define the shipping costs and delivery timeframes for products in the store.
\n{\n \"shipping_profile\": {\n \"amount\": 4.99,\n \"name\": \"Standard Shipping\",\n \"fee_type\": \"flat\",\n \"min_shipping_period\": 3,\n \"max_shipping_period\": 5\n }\n}\n\n| Name | Type | Required | Description |
|---|---|---|---|
shipping_profile.amount | number | Yes | Shipping fee amount (e.g., 4.99) |
shipping_profile.name | string | Yes | Name of the shipping profile |
shipping_profile.fee_type | string | Yes | Type of fee: \"flat\" or \"free\" |
shipping_profile.min_shipping_period | integer | Yes | Minimum shipping time in days |
shipping_profile.max_shipping_period | integer | Yes | Maximum shipping time in days |
{\n \"notice\": \"Shipping profile created successfully\"\n}\n\n{\n \"error\": \"Error message describing the issue\"\n}\n\n{\n \"error\": \"Unauthorized access\",\n \"redirect_url\": \"https://auth.everbee.io/some-path\"\n}\n\nProfile Types:
\n\"flat\" fee type charges a fixed amount for shipping
\n\"free\" fee type offers free shipping (set amount to 0)
\nDefault Profile:
\nEach store requires at least one shipping profile
\nThe first profile created automatically becomes the default
\nShipping Periods:
\nValues represent business days, not calendar days
\nMax period must be greater than or equal to min period
\nThese values are shown to customers during checkout
\nAmount Restrictions:
\nMust be a non-negative number
\nFor \"free\" fee type, amount should be 0
\nFor \"flat\" fee type, amount should be greater than 0
\nUsually formatted with 2 decimal places in the UI
\nName Guidelines:
\nShould be descriptive and customer-friendly
\nExamples: \"Standard Shipping\", \"Express Shipping\", \"Free Shipping\"
\nNames must be unique within a store
\nUsage:
\nShipping profiles apply to all products in a store
\nCreating multiple profiles doesn't automatically assign them to products
\nAdditional configuration may be needed to specify which products use which profile
\nLimitations:
\nMaximum of 5 shipping profiles per store
\nProfile names limited to 50 characters
\nCannot create profiles with duplicate names
\nBest Practices:
\nCreate profiles that reflect your actual shipping costs
\nSet realistic shipping periods to manage customer expectations
\nConsider offering a free shipping option when practical
\nUse clear, descriptive names that customers will understand
\nProfile Management:
\nOnce created, profiles can be updated but not deleted if in use
\nTo remove a profile, first ensure no products are using it
\nThe default profile cannot be deleted while other profiles exist
\nThis API updates an existing shipping profile in the Everbee Store system. It allows you to modify shipping costs, delivery timeframes, and other profile settings.
\n| Name | Required | Description |
|---|---|---|
shippingProfileId | Yes | ID of the shipping profile to update |
{\n \"shipping_profile\": {\n \"amount\": 5.99,\n \"fee_type\": \"flat\",\n \"name\": \"new Updated\"\n }\n}\n\n| Name | Type | Required | Description |
|---|---|---|---|
shipping_profile.amount | number | No | New shipping fee amount |
shipping_profile.fee_type | string | No | New fee type: \"flat\" or \"free\" |
shipping_profile.name | string | No | New name for the shipping profile |
shipping_profile.min_shipping_period | integer | No | New minimum shipping time in days |
shipping_profile.max_shipping_period | integer | No | New maximum shipping time in days |
Note: Include only the fields you want to update. Omitted fields will remain unchanged.
\n{\n \"notice\": \"Shipping profile updated successfully\"\n}\n\n{\n \"error\": \"Error message describing the issue\"\n}\n\n{\n \"error\": \"Unauthorized access\",\n \"redirect_url\": \"https://auth.everbee.io/some-path\"\n}\n\n{\n \"error\": \"Shipping profile not found\"\n}\n\nEndpoints for managing shipping profiles in the Everbee Oposhop.
\nNote - These endpoints are now deprecated on 29th May 2026. Please use updated V2 endpoints to manage shipping profile in OpoShop
\n","_postman_id":"1c52b6ab-f345-4612-ae41-fe5a1b3c6d35"},{"name":"Shipping Profiles V2","item":[{"name":"Index","id":"779f5901-161d-4930-9707-237a751f440e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Access-Token","value":"eyJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJldmVyYmVlLXNzbyIsImlhdCI6MTc3NjA3NzIzMywiZXhwIjoxNzc2NjgyMDMzLCJqdGkiOiIzYzAzMjk1ZDg2YTQiLCJ1c2VyX2lkIjoiZjFjNDg5MzAtMjNlNi00NGVlLWFjM2EtZjY5NGNiNGQzZjU3IiwiZW1haWwiOiJuaWtoaWxAZXZlcmJlZS5pbyIsInR2IjoxMCwiaWJwIjpmYWxzZSwiaWJzIjp0cnVlLCJzb3MiOmZhbHNlLCJhY3QiOiIxIiwiYXVkIjoiWXJibTM3RFN0akhxZWpuaWxaaUFVZ3pnZGYwYV8tT05uSnhRNUNINjZYOCIsInNjb3BlcyI6W119.axgESWVDng0kf8BmkRtKfdVU0E7Txf2FzwuX57GwPUBCkJIxlcDB-yHMs_VoYQ8WhEboHWgoey8aKzHB_6Ej4g","type":"text"},{"key":"Store-Id","value":"e3596362-b83d-4149-bfd9-165a35572f19","type":"text"}],"url":"https://store-open-api.everbee.com/open_api/v1/open_api/v2/shipping_profiles","description":"GET https://store-open-api.everbee.com/open_api/v1/open_api/v2/shipping_profiles
Retrieves a list of all shipping profiles associated with the authenticated store. Shipping profiles define how shipping is calculated and presented to buyers, including zones, rates, and linked fulfillment locations.
\nGET https://store-open-api.everbee.com/open_api/v1/open_api/v2/shipping_profiles\nNone
\nNone
\nNone
\n200 OK{\n \"shipping_profiles\": [\n {\n \"id\": \"06c045f3-6951-40fa-ba1c-727a3f761f9e\",\n \"name\": \"Standard Shipping\",\n \"fee_type\": \"flat\",\n \"amount\": 10.00,\n \"source\": \"Printify\",\n \"active\": true,\n \"variant_ids\": [\n \"f6537264-deae-4bcb-a7f0-4b5a57fd2266\",\n \"3d5a7a7c-a0b0-4489-b645-e8cee5966dd2\"\n ],\n \"shipping_zones\": [\n {\n \"id\": \"e7cefdda-5bde-4d88-80f3-cd3b8286839b\",\n \"name\": \"Domestic Shipping\",\n \"shipping_zone_locations\": [\n {\n \"location_type\": \"Country\",\n \"location_id\": \"99382f76-478d-4872-bb38-db8a76ae3d24\"\n }\n ],\n \"shipping_rates\": [\n {\n \"id\": \"f583f95d-bc10-49f4-a94a-8eb995a7db20\",\n \"name\": \"Standard Delivery\",\n \"rate\": 10.00,\n \"rate_type\": \"fixed_amount\",\n \"min_shipping_period\": 5,\n \"max_shipping_period\": 7,\n \"custom_delivery_description\": \"Standard delivery within 5-7 business days\"\n }\n ]\n }\n ],\n \"shipping_fulfillment_locations\": [\n {\n \"fulfillment_location\": {\n \"id\": \"514406bc-6602-4dee-a0ea-48dfd8d7849e\",\n \"name\": \"Main Warehouse\",\n \"city\": \"Shipping City\",\n \"country_code\": \"US\"\n }\n }\n ],\n \"created_at\": \"2024-01-15T10:00:00.000Z\",\n \"updated_at\": \"2024-03-20T14:30:00.000Z\"\n }\n ],\n \"meta\": {\n \"total\": 1,\n \"page\": 1,\n \"per_page\": 25\n }\n}\n401 Unauthorized{\n \"error\": \"unauthorized\",\n \"message\": \"Invalid or expired access token.\"\n}\n403 Forbidden{\n \"error\": \"forbidden\",\n \"message\": \"You do not have permission to access this store's shipping profiles.\"\n}\ncurl --location 'https://store.everbee.com/open_api/v2/shipping_profiles' \\\n--header 'X-Access-Token: eyJhbGci...' \\\n--header 'Store-Id: e3596362-b83d-4149-bfd9-165a35572f19'\nX-Access-Token must be a valid, non-expired JWT.Store-Id must correspond to a store the authenticated user has access to.active status.GET https://store-open-api.everbee.com/open_api/v1/open_api/v2/shipping_profiles/your_shipping_profile_id
Retrieves the full details of a single shipping profile by its unique ID. Use this endpoint to inspect the complete configuration of a shipping profile, including all zones, rates, zone locations, and linked fulfillment locations.
\nGET https://store-open-api.everbee.com/open_api/v1/open_api/v2/shipping_profiles/your_shipping_profile_id\nNone
\nNone
\n200 OK{\n \"shipping_profile\": {\n \"id\": \"06c045f3-6951-40fa-ba1c-727a3f761f9e\",\n \"name\": \"Standard Shipping\",\n \"fee_type\": \"flat\",\n \"amount\": 10.00,\n \"source\": \"Printify\",\n \"active\": true,\n \"variant_ids\": [\n \"f6537264-deae-4bcb-a7f0-4b5a57fd2266\",\n \"3d5a7a7c-a0b0-4489-b645-e8cee5966dd2\"\n ],\n \"shipping_zones\": [\n {\n \"id\": \"e7cefdda-5bde-4d88-80f3-cd3b8286839b\",\n \"name\": \"Domestic Shipping\",\n \"shipping_zone_locations\": [\n {\n \"location_type\": \"Country\",\n \"location_id\": \"99382f76-478d-4872-bb38-db8a76ae3d24\"\n }\n ],\n \"shipping_rates\": [\n {\n \"id\": \"f583f95d-bc10-49f4-a94a-8eb995a7db20\",\n \"name\": \"Standard Delivery\",\n \"rate\": 10.00,\n \"rate_type\": \"fixed_amount\",\n \"condition_based_on\": null,\n \"min_shipping_period\": 5,\n \"max_shipping_period\": 7,\n \"custom_delivery_description\": \"Standard delivery within 5-7 business days\",\n \"shipping_rate_conditions\": [\n {\n \"id\": \"bec0fcd8-591e-4133-af4e-39504dad15b9\",\n \"shipping_fee\": 10.00,\n \"min_value\": 0.00,\n \"max_value\": 50.00\n }\n ]\n }\n ]\n },\n {\n \"id\": \"a1b2c3d4-0000-4000-8000-000000000001\",\n \"name\": \"International Shipping\",\n \"shipping_zone_locations\": [\n {\n \"location_type\": \"rest_of_world\"\n }\n ],\n \"shipping_rates\": [\n {\n \"id\": \"a1b2c3d4-0000-4000-8000-000000000002\",\n \"name\": \"International Standard\",\n \"rate\": 35.00,\n \"rate_type\": \"fixed_amount\",\n \"condition_based_on\": null,\n \"min_shipping_period\": 10,\n \"max_shipping_period\": 15,\n \"custom_delivery_description\": \"International delivery within 10-15 business days\",\n \"shipping_rate_conditions\": [\n {\n \"shipping_fee\": 35.00,\n \"min_value\": 0.00,\n \"max_value\": null\n }\n ]\n }\n ]\n }\n ],\n \"shipping_fulfillment_locations\": [\n {\n \"fulfillment_location\": {\n \"id\": \"514406bc-6602-4dee-a0ea-48dfd8d7849e\",\n \"name\": \"Main Warehouse\",\n \"address_line1\": \"123 Storage Lane\",\n \"city\": \"Shipping City\",\n \"state\": \"ST\",\n \"country\": \"United States\",\n \"country_code\": \"US\",\n \"source\": \"manual\",\n \"source_type\": \"store\"\n }\n }\n ],\n \"created_at\": \"2024-01-15T10:00:00.000Z\",\n \"updated_at\": \"2024-03-20T14:30:00.000Z\"\n }\n}\n401 Unauthorized{\n \"error\": \"unauthorized\",\n \"message\": \"Invalid or expired access token.\"\n}\n403 Forbidden{\n \"error\": \"forbidden\",\n \"message\": \"You do not have permission to access this shipping profile.\"\n}\n404 Not Found{\n \"error\": \"not_found\",\n \"message\": \"Shipping profile with the given ID does not exist.\"\n}\ncurl --location 'https://store.everbee.com/open_api/v2/shipping_profiles/06c045f3-6951-40fa-ba1c-727a3f761f9e' \\\n--header 'X-Access-Token: eyJhbGci...' \\\n--header 'Store-Id: e3596362-b83d-4149-bfd9-165a35572f19'\nshippingProfileId must be a valid UUID.X-Access-Token must be valid and non-expired.Store-Id must match the store that owns the shipping profile.404 if the UUID is valid but does not match any existing record.Store-Id header scopes the lookup — a profile belonging to a different store returns 403.condition_based_on is null for fixed_amount rate types and populated for conditional rate types.POST https://store-open-api.everbee.com/open_api/v1/open_api/v2/shipping_profiles
Creates a new shipping profile for the authenticated store. A shipping profile defines how shipping fees are calculated and presented to buyers, and can include multiple zones, rates, rate conditions, and linked fulfillment locations.
\nPOST https://store-open-api.everbee.com/open_api/v1/open_api/v2/shipping_profiles\nNone
\nNone
\n{\n \"shipping_profile\": {\n \"name\": \"Standard Shipping 4\",\n \"fee_type\": \"flat\",\n \"amount\": 10.00,\n \"source\": \"Printify\",\n \"variant_ids\": [\n \"f6537264-deae-4bcb-a7f0-4b5a57fd2266\",\n \"3d5a7a7c-a0b0-4489-b645-e8cee5966dd2\"\n ],\n \"shipping_zones_attributes\": [\n {\n \"name\": \"Domestic Shipping\",\n \"shipping_zone_locations_attributes\": [\n {\n \"location_type\": \"Country\",\n \"location_id\": \"99382f76-478d-4872-bb38-db8a76ae3d24\"\n }\n ],\n \"shipping_rates_attributes\": [\n {\n \"name\": \"Standard Delivery\",\n \"rate\": 10.00,\n \"rate_type\": \"fixed_amount\",\n \"condition_based_on\": null,\n \"custom_delivery_description\": \"Standard delivery within 5-7 business days\",\n \"min_shipping_period\": 5,\n \"max_shipping_period\": 7,\n \"shipping_rate_conditions_attributes\": [\n {\n \"shipping_fee\": 10.00,\n \"min_value\": 0.00,\n \"max_value\": 50.00\n }\n ]\n },\n {\n \"name\": \"Express Delivery\",\n \"rate\": 25.00,\n \"rate_type\": \"fixed_amount\",\n \"condition_based_on\": null,\n \"custom_delivery_description\": \"Express delivery within 1-2 business days\",\n \"min_shipping_period\": 1,\n \"max_shipping_period\": 2,\n \"shipping_rate_conditions_attributes\": [\n {\n \"shipping_fee\": 25.00,\n \"min_value\": 0.00,\n \"max_value\": 100.00\n }\n ]\n }\n ]\n },\n {\n \"name\": \"International Shipping\",\n \"shipping_zone_locations_attributes\": [\n {\n \"location_type\": \"rest_of_world\"\n }\n ],\n \"shipping_rates_attributes\": [\n {\n \"name\": \"International Standard\",\n \"rate\": 35.00,\n \"rate_type\": \"fixed_amount\",\n \"condition_based_on\": null,\n \"custom_delivery_description\": \"International delivery within 10-15 business days\",\n \"min_shipping_period\": 10,\n \"max_shipping_period\": 15,\n \"shipping_rate_conditions_attributes\": [\n {\n \"shipping_fee\": 35.00,\n \"min_value\": 0.00,\n \"max_value\": null\n }\n ]\n }\n ]\n }\n ],\n \"shipping_fulfillment_locations_attributes\": [\n {\n \"fulfillment_location_attributes\": {\n \"name\": \"Main Warehouse\",\n \"address\": \"123 Storage Lane\",\n \"city\": \"Shipping City\",\n \"state\": \"ST\",\n \"country\": \"United States\",\n \"country_code\": \"US\",\n \"source\": \"manual\",\n \"source_type\": \"store\"\n }\n }\n ]\n }\n}\nshipping_zones_attributes Objectshipping_zone_locations_attributes Objectshipping_rates_attributes Objectshipping_rate_conditions_attributes Objectshipping_fulfillment_locations_attributes Object201 Created{\n \"shipping_profile\": {\n \"id\": \"06c045f3-6951-40fa-ba1c-727a3f761f9e\",\n \"name\": \"Standard Shipping 4\",\n \"fee_type\": \"flat\",\n \"amount\": 10.00,\n \"source\": \"Printify\",\n \"active\": true,\n \"variant_ids\": [\n \"f6537264-deae-4bcb-a7f0-4b5a57fd2266\",\n \"3d5a7a7c-a0b0-4489-b645-e8cee5966dd2\"\n ],\n \"shipping_zones\": [\n {\n \"id\": \"e7cefdda-5bde-4d88-80f3-cd3b8286839b\",\n \"name\": \"Domestic Shipping\",\n \"shipping_zone_locations\": [\n {\n \"location_type\": \"Country\",\n \"location_id\": \"99382f76-478d-4872-bb38-db8a76ae3d24\"\n }\n ],\n \"shipping_rates\": [\n {\n \"id\": \"f583f95d-bc10-49f4-a94a-8eb995a7db20\",\n \"name\": \"Standard Delivery\",\n \"rate\": 10.00,\n \"rate_type\": \"fixed_amount\",\n \"condition_based_on\": null,\n \"min_shipping_period\": 5,\n \"max_shipping_period\": 7,\n \"custom_delivery_description\": \"Standard delivery within 5-7 business days\",\n \"shipping_rate_conditions\": [\n {\n \"id\": \"bec0fcd8-591e-4133-af4e-39504dad15b9\",\n \"shipping_fee\": 10.00,\n \"min_value\": 0.00,\n \"max_value\": 50.00\n }\n ]\n }\n ]\n }\n ],\n \"shipping_fulfillment_locations\": [\n {\n \"fulfillment_location\": {\n \"id\": \"514406bc-6602-4dee-a0ea-48dfd8d7849e\",\n \"name\": \"Main Warehouse\",\n \"city\": \"Shipping City\",\n \"country_code\": \"US\"\n }\n }\n ],\n \"created_at\": \"2024-05-06T10:00:00.000Z\",\n \"updated_at\": \"2024-05-06T10:00:00.000Z\"\n }\n}\n401 Unauthorized{\n \"error\": \"unauthorized\",\n \"message\": \"Invalid or expired access token.\"\n}\n403 Forbidden{\n \"error\": \"forbidden\",\n \"message\": \"You do not have permission to create shipping profiles for this store.\"\n}\n422 Unprocessable Entity{\n \"error\": \"unprocessable_entity\",\n \"errors\": {\n \"name\": [\"can't be blank\"],\n \"shipping_zones_attributes\": [\"must have at least one zone\"],\n \"shipping_rates_attributes\": [\"must have at least one rate per zone\"],\n \"country_code\": [\"is not a valid ISO 3166-1 alpha-2 code\"]\n }\n}\ncurl --location 'https://store.everbee.com/open_api/v2/shipping_profiles' \\\n--header 'X-Access-Token: eyJhbGci...' \\\n--header 'Store-Id: e3596362-b83d-4149-bfd9-165a35572f19' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"shipping_profile\": {\n \"name\": \"Standard Shipping 4\",\n \"fee_type\": \"flat\",\n \"amount\": 10.00,\n \"source\": \"Printify\",\n \"variant_ids\": [\"f6537264-deae-4bcb-a7f0-4b5a57fd2266\"],\n \"shipping_zones_attributes\": [\n {\n \"name\": \"Domestic Shipping\",\n \"shipping_zone_locations_attributes\": [\n { \"location_type\": \"Country\", \"location_id\": \"99382f76-478d-4872-bb38-db8a76ae3d24\" }\n ],\n \"shipping_rates_attributes\": [\n {\n \"name\": \"Standard Delivery\",\n \"rate\": 10.00,\n \"rate_type\": \"fixed_amount\",\n \"condition_based_on\": null,\n \"min_shipping_period\": 5,\n \"max_shipping_period\": 7,\n \"custom_delivery_description\": \"Standard delivery within 5-7 business days\",\n \"shipping_rate_conditions_attributes\": [\n { \"shipping_fee\": 10.00, \"min_value\": 0.00, \"max_value\": 50.00 }\n ]\n }\n ]\n }\n ]\n }\n}'\nGeneral
\nContent-Type header must be application/json.shipping_zones_attributes entry is required.shipping_rates_attributes entry.Field-Specific
\nname — Must be a non-empty string.fee_type — Must be a recognized value (e.g., flat).rate_type — Must be one of: fixed_amount, conditional.condition_based_on — Must be null for fixed_amount; must be per_item or order_total for conditional.location_type — Must be Country or rest_of_world.location_id — Required when location_type is Country; must be a valid UUID.country_code — Must be a valid ISO 3166-1 alpha-2 code.source_type — Must be one of: store, third_party.active: true by default.id for the profile, zones, rates, and conditions is system-generated and cannot be specified in the request.location_type: \"rest_of_world\" to create a catch-all zone for all countries not covered by other zones.conditional rate types, set rate to null and define the fee logic inside shipping_rate_conditions_attributes.shipping_fulfillment_locations_attributes is optional — a profile can be created without a linked fulfillment location.POST https://store-open-api.everbee.com/open_api/v1/open_api/v2/shipping_profiles
Creates a new shipping profile for the authenticated store. A shipping profile defines how shipping fees are calculated and presented to buyers, and can include multiple zones, rates, rate conditions, and linked fulfillment locations.
\nPOST https://store-open-api.everbee.com/open_api/v1/open_api/v2/shipping_profiles\nNone
\nNone
\n{\n \"shipping_profile\": {\n \"name\": \"Standard Shipping 4\",\n \"fee_type\": \"flat\",\n \"amount\": 10.00,\n \"source\": \"Printify\",\n \"variant_ids\": [\n \"f6537264-deae-4bcb-a7f0-4b5a57fd2266\",\n \"3d5a7a7c-a0b0-4489-b645-e8cee5966dd2\"\n ],\n \"shipping_zones_attributes\": [\n {\n \"name\": \"Domestic Shipping\",\n \"shipping_zone_locations_attributes\": [\n {\n \"location_type\": \"Country\",\n \"location_id\": \"99382f76-478d-4872-bb38-db8a76ae3d24\"\n }\n ],\n \"shipping_rates_attributes\": [\n {\n \"name\": \"Standard Delivery\",\n \"rate\": 10.00,\n \"rate_type\": \"fixed_amount\",\n \"condition_based_on\": null,\n \"custom_delivery_description\": \"Standard delivery within 5-7 business days\",\n \"min_shipping_period\": 5,\n \"max_shipping_period\": 7,\n \"shipping_rate_conditions_attributes\": [\n {\n \"shipping_fee\": 10.00,\n \"min_value\": 0.00,\n \"max_value\": 50.00\n }\n ]\n },\n {\n \"name\": \"Express Delivery\",\n \"rate\": 25.00,\n \"rate_type\": \"fixed_amount\",\n \"condition_based_on\": null,\n \"custom_delivery_description\": \"Express delivery within 1-2 business days\",\n \"min_shipping_period\": 1,\n \"max_shipping_period\": 2,\n \"shipping_rate_conditions_attributes\": [\n {\n \"shipping_fee\": 25.00,\n \"min_value\": 0.00,\n \"max_value\": 100.00\n }\n ]\n }\n ]\n },\n {\n \"name\": \"International Shipping\",\n \"shipping_zone_locations_attributes\": [\n {\n \"location_type\": \"rest_of_world\"\n }\n ],\n \"shipping_rates_attributes\": [\n {\n \"name\": \"International Standard\",\n \"rate\": 35.00,\n \"rate_type\": \"fixed_amount\",\n \"condition_based_on\": null,\n \"custom_delivery_description\": \"International delivery within 10-15 business days\",\n \"min_shipping_period\": 10,\n \"max_shipping_period\": 15,\n \"shipping_rate_conditions_attributes\": [\n {\n \"shipping_fee\": 35.00,\n \"min_value\": 0.00,\n \"max_value\": null\n }\n ]\n }\n ]\n }\n ],\n \"shipping_fulfillment_locations_attributes\": [\n {\n \"fulfillment_location_attributes\": {\n \"name\": \"Main Warehouse\",\n \"address\": \"123 Storage Lane\",\n \"city\": \"Shipping City\",\n \"state\": \"ST\",\n \"country\": \"United States\",\n \"country_code\": \"US\",\n \"source\": \"manual\",\n \"source_type\": \"store\"\n }\n }\n ]\n }\n}\nshipping_zones_attributes Objectshipping_zone_locations_attributes Objectshipping_rates_attributes Objectshipping_rate_conditions_attributes Objectshipping_fulfillment_locations_attributes Object201 Created{\n \"shipping_profile\": {\n \"id\": \"06c045f3-6951-40fa-ba1c-727a3f761f9e\",\n \"name\": \"Standard Shipping 4\",\n \"fee_type\": \"flat\",\n \"amount\": 10.00,\n \"source\": \"Printify\",\n \"active\": true,\n \"variant_ids\": [\n \"f6537264-deae-4bcb-a7f0-4b5a57fd2266\",\n \"3d5a7a7c-a0b0-4489-b645-e8cee5966dd2\"\n ],\n \"shipping_zones\": [\n {\n \"id\": \"e7cefdda-5bde-4d88-80f3-cd3b8286839b\",\n \"name\": \"Domestic Shipping\",\n \"shipping_zone_locations\": [\n {\n \"location_type\": \"Country\",\n \"location_id\": \"99382f76-478d-4872-bb38-db8a76ae3d24\"\n }\n ],\n \"shipping_rates\": [\n {\n \"id\": \"f583f95d-bc10-49f4-a94a-8eb995a7db20\",\n \"name\": \"Standard Delivery\",\n \"rate\": 10.00,\n \"rate_type\": \"fixed_amount\",\n \"condition_based_on\": null,\n \"min_shipping_period\": 5,\n \"max_shipping_period\": 7,\n \"custom_delivery_description\": \"Standard delivery within 5-7 business days\",\n \"shipping_rate_conditions\": [\n {\n \"id\": \"bec0fcd8-591e-4133-af4e-39504dad15b9\",\n \"shipping_fee\": 10.00,\n \"min_value\": 0.00,\n \"max_value\": 50.00\n }\n ]\n }\n ]\n }\n ],\n \"shipping_fulfillment_locations\": [\n {\n \"fulfillment_location\": {\n \"id\": \"514406bc-6602-4dee-a0ea-48dfd8d7849e\",\n \"name\": \"Main Warehouse\",\n \"city\": \"Shipping City\",\n \"country_code\": \"US\"\n }\n }\n ],\n \"created_at\": \"2024-05-06T10:00:00.000Z\",\n \"updated_at\": \"2024-05-06T10:00:00.000Z\"\n }\n}\n401 Unauthorized{\n \"error\": \"unauthorized\",\n \"message\": \"Invalid or expired access token.\"\n}\n403 Forbidden{\n \"error\": \"forbidden\",\n \"message\": \"You do not have permission to create shipping profiles for this store.\"\n}\n422 Unprocessable Entity{\n \"error\": \"unprocessable_entity\",\n \"errors\": {\n \"name\": [\"can't be blank\"],\n \"shipping_zones_attributes\": [\"must have at least one zone\"],\n \"shipping_rates_attributes\": [\"must have at least one rate per zone\"],\n \"country_code\": [\"is not a valid ISO 3166-1 alpha-2 code\"]\n }\n}\ncurl --location 'https://store.everbee.com/open_api/v2/shipping_profiles' \\\n--header 'X-Access-Token: eyJhbGci...' \\\n--header 'Store-Id: e3596362-b83d-4149-bfd9-165a35572f19' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"shipping_profile\": {\n \"name\": \"Standard Shipping 4\",\n \"fee_type\": \"flat\",\n \"amount\": 10.00,\n \"source\": \"Printify\",\n \"variant_ids\": [\"f6537264-deae-4bcb-a7f0-4b5a57fd2266\"],\n \"shipping_zones_attributes\": [\n {\n \"name\": \"Domestic Shipping\",\n \"shipping_zone_locations_attributes\": [\n { \"location_type\": \"Country\", \"location_id\": \"99382f76-478d-4872-bb38-db8a76ae3d24\" }\n ],\n \"shipping_rates_attributes\": [\n {\n \"name\": \"Standard Delivery\",\n \"rate\": 10.00,\n \"rate_type\": \"fixed_amount\",\n \"condition_based_on\": null,\n \"min_shipping_period\": 5,\n \"max_shipping_period\": 7,\n \"custom_delivery_description\": \"Standard delivery within 5-7 business days\",\n \"shipping_rate_conditions_attributes\": [\n { \"shipping_fee\": 10.00, \"min_value\": 0.00, \"max_value\": 50.00 }\n ]\n }\n ]\n }\n ]\n }\n}'\nGeneral
\nContent-Type header must be application/json.shipping_zones_attributes entry is required.shipping_rates_attributes entry.Field-Specific
\nname — Must be a non-empty string.fee_type — Must be a recognized value (e.g., flat).rate_type — Must be one of: fixed_amount, conditional.condition_based_on — Must be null for fixed_amount; must be per_item or order_total for conditional.location_type — Must be Country or rest_of_world.location_id — Required when location_type is Country; must be a valid UUID.country_code — Must be a valid ISO 3166-1 alpha-2 code.source_type — Must be one of: store, third_party.active: true by default.id for the profile, zones, rates, and conditions is system-generated and cannot be specified in the request.location_type: \"rest_of_world\" to create a catch-all zone for all countries not covered by other zones.conditional rate types, set rate to null and define the fee logic inside shipping_rate_conditions_attributes.shipping_fulfillment_locations_attributes is optional — a profile can be created without a linked fulfillment location.PUT https://store-open-api.everbee.com/open_api/v1/open_api/v2/shipping_profiles/your_shipping_profile_id
Updates an existing shipping profile. Use this endpoint to modify the profile's name, variant assignments, or the configuration of its zones, rates, and rate conditions. Supports partial updates — only the fields included in the request body will be changed.
\nPUT https://store-open-api.everbee.com/open_api/v1/open_api/v2/shipping_profiles/your_shipping_profile_id\nNone
\n{\n \"shipping_profile\": {\n \"name\": \"Standard Shipping 4\",\n \"variant_ids\": [\n \"ffbd175d-bea0-4cf9-8e73-2f097730fcf8\"\n ],\n \"shipping_zones_attributes\": [\n {\n \"id\": \"e7cefdda-5bde-4d88-80f3-cd3b8286839b\",\n \"shipping_rates_attributes\": [\n {\n \"id\": \"f583f95d-bc10-49f4-a94a-8eb995a7db20\",\n \"name\": \"Standard Delivery\",\n \"rate\": null,\n \"rate_type\": \"conditional\",\n \"condition_based_on\": \"per_item\",\n \"min_shipping_period\": 5,\n \"max_shipping_period\": 7,\n \"custom_delivery_description\": \"5-7 days\",\n \"shipping_rate_conditions_attributes\": [\n {\n \"id\": \"bec0fcd8-591e-4133-af4e-39504dad15b9\",\n \"first_item_cost\": 5.00,\n \"additional_item_cost\": 2.00\n }\n ]\n }\n ]\n }\n ]\n }\n}\nshipping_zones_attributes Object (for updates)shipping_rates_attributes Object (for updates)shipping_rate_conditions_attributes Object (for updates)200 OK{\n \"shipping_profile\": {\n \"id\": \"06c045f3-6951-40fa-ba1c-727a3f761f9e\",\n \"name\": \"Standard Shipping 4\",\n \"fee_type\": \"flat\",\n \"amount\": 10.00,\n \"source\": \"Printify\",\n \"active\": true,\n \"variant_ids\": [\n \"ffbd175d-bea0-4cf9-8e73-2f097730fcf8\"\n ],\n \"shipping_zones\": [\n {\n \"id\": \"e7cefdda-5bde-4d88-80f3-cd3b8286839b\",\n \"name\": \"Domestic Shipping\",\n \"shipping_rates\": [\n {\n \"id\": \"f583f95d-bc10-49f4-a94a-8eb995a7db20\",\n \"name\": \"Standard Delivery\",\n \"rate\": null,\n \"rate_type\": \"conditional\",\n \"condition_based_on\": \"per_item\",\n \"min_shipping_period\": 5,\n \"max_shipping_period\": 7,\n \"custom_delivery_description\": \"5-7 days\",\n \"shipping_rate_conditions\": [\n {\n \"id\": \"bec0fcd8-591e-4133-af4e-39504dad15b9\",\n \"first_item_cost\": 5.00,\n \"additional_item_cost\": 2.00\n }\n ]\n }\n ]\n }\n ],\n \"created_at\": \"2024-01-15T10:00:00.000Z\",\n \"updated_at\": \"2024-05-06T14:30:00.000Z\"\n }\n}\n401 Unauthorized{\n \"error\": \"unauthorized\",\n \"message\": \"Invalid or expired access token.\"\n}\n403 Forbidden{\n \"error\": \"forbidden\",\n \"message\": \"You do not have permission to update this shipping profile.\"\n}\n404 Not Found{\n \"error\": \"not_found\",\n \"message\": \"Shipping profile with the given ID does not exist.\"\n}\n422 Unprocessable Entity{\n \"error\": \"unprocessable_entity\",\n \"errors\": {\n \"name\": [\"can't be blank\"],\n \"rate_type\": [\"is not included in the list\"],\n \"condition_based_on\": [\"must be present for conditional rate type\"]\n }\n}\ncurl --location --request PUT 'https://store.everbee.com/open_api/v2/shipping_profiles/06c045f3-6951-40fa-ba1c-727a3f761f9e' \\\n--header 'X-Access-Token: eyJhbGci...' \\\n--header 'Store-Id: e3596362-b83d-4149-bfd9-165a35572f19' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"shipping_profile\": {\n \"name\": \"Standard Shipping 4\",\n \"variant_ids\": [\"ffbd175d-bea0-4cf9-8e73-2f097730fcf8\"],\n \"shipping_zones_attributes\": [\n {\n \"id\": \"e7cefdda-5bde-4d88-80f3-cd3b8286839b\",\n \"shipping_rates_attributes\": [\n {\n \"id\": \"f583f95d-bc10-49f4-a94a-8eb995a7db20\",\n \"name\": \"Standard Delivery\",\n \"rate\": null,\n \"rate_type\": \"conditional\",\n \"condition_based_on\": \"per_item\",\n \"min_shipping_period\": 5,\n \"max_shipping_period\": 7,\n \"custom_delivery_description\": \"5-7 days\",\n \"shipping_rate_conditions_attributes\": [\n {\n \"id\": \"bec0fcd8-591e-4133-af4e-39504dad15b9\",\n \"first_item_cost\": 5.00,\n \"additional_item_cost\": 2.00\n }\n ]\n }\n ]\n }\n ]\n }\n}'\nGeneral
\nshippingProfileId in the URL must be a valid UUID.Content-Type header must be application/json.id of the existing record must be provided.Field-Specific
\nname — If provided, must be a non-empty string.rate_type — If provided, must be one of: fixed_amount, conditional.condition_based_on — Must be null for fixed_amount; must be per_item or order_total for conditional.variant_ids — If provided, replaces the entire existing list of variant IDs.first_item_cost / additional_item_cost — Required when condition_based_on is per_item.id. Without an id, a new zone or rate will be created instead.id, created_at, and source fields of the profile are immutable and cannot be changed via this endpoint.variant_ids replaces the entire existing list — include all desired variant IDs, not just the new ones.fixed_amount to conditional requires setting rate to null and providing a valid condition_based_on value.updated_at timestamp is automatically set to the current time on every successful update.Manage shipping profiles within the Everbee platform. This API supports the complete lifecycle of shipping profiles, including:
\nListing all shipping profiles
\nRetrieving a shipping profile by ID
\nCreating a shipping profile
\nUpdating a shipping profile
\nThe default shipping profile is automatically created for every store.
\nAll products are assigned to the default shipping profile unless another profile is explicitly assigned.
\nDefault shipping profiles cannot be edited or deleted.
\nIf a non-default shipping profile is deleted, all associated products are automatically reassigned to the default shipping profile.
\nShipping profiles created manually through the Store UI.
\nShipping profiles created through the Open API by third-party applications.
\nA third-party app can create only one fulfillment location per installed store.
\nThe same fulfillment location can be reused across multiple shipping profiles.
\nExample:
\nIf an app is installed in a store, it may create one fulfillment location, and that fulfillment location can be attached to multiple shipping profiles.
\nSupported rate_type values:
flat
conditional
When rate_type is set to conditional, the condition_based_on field determines the pricing logic.
Supported condition_based_on values:
order_weight
order_price
item_quantity
per_item
first_orders
Condition based on the total order weight.
\nCondition based on the total order price.
\nCondition based on the quantity of items in the order.
\nShipping cost calculated per item.
\ntotal_shipping_cost = first_item_cost + ((quantity - 1) * additional_item_cost)\n\nCondition based on customer order count.
\nRetrieve a paginated list of discounts available for the current store. This endpoint returns discount configurations such as percentage / fixed-amount discounts, their validity, and targeting rules.
\nGET https://store-open-api.everbee.com/open_api/v1/discounts\n\nX-Access-Token: your_access_token\nStore-Id: your_store_id\n\nAll query parameters are optional and can be combined.
\npage (number)
The page number for pagination.
Default: 1
per_page (number)
Number of records to return per page.
Common values: 10, 20, 50
Filtering uses nested structure with
\nfilter_params object:
\nfilter_params[combinator] (string)
Logical operator for combining multiple conditions (e.g., \"and\", \"or\")
filter_params[conditions][][field] (string)
Field to filter by. Supported fields:
name - Filter by discount code
value - Filter by discount value
status - Filter by status
type - Filter by discount type
activation_at - Filter by activation date
expiration_at - Filter by expiration date
used - Filter by usage count
filter_params[conditions][][operator] (string)
Comparison operator (e.g., \"eq\", \"gt\", \"lt\", \"contains\", \"in\")
filter_params[conditions][][value] (string/array)
Value to filter by. Can be string or array depending on operator.
Sorting uses nested structure with
\nsort_params object:
\nsort_params[field] (string)
Sort field. Supported fields:
name - Sort by discount code
value - Sort by discount value
type - Sort by discount type
status - Sort by status
activation_at - Sort by activation date
expiration_at - Sort by expiration date
Default: updated_at
sort_params[sort] (string)
Sort direction: \"asc\" or \"desc\"
Default: \"desc\"
On success, the API returns a JSON object containing:
\n{\n \"data\": [\n {\n \"id\": \"uuid\",\n \"type\": \"Discounts::Percentage\",\n \"code\": \"WELCOME10\",\n \"value\": 10.0,\n \"status\": \"active\",\n \"used\": 5,\n \"activation_at\": \"2024-01-01T00:00:00Z\",\n \"expiration_at\": \"2024-12-31T23:59:59Z\"\n }\n ],\n \"total_count\": 1\n}\n\nGET /discounts?page=1&per_page=20\n\nGET /discounts?search_term=WELCOME\n\nGET /discounts?filter_params[conditions][][field]=status&filter_params[conditions][][operator]=eq&filter_params[conditions][][value]=active\n\nGET /discounts?filter_params[conditions][][field]=status&filter_params[conditions][][operator]=in&filter_params[conditions][][value][]=active&filter_params[conditions][][value][]=published\n\nGET /discounts?filter_params[conditions][][field]=activation_at&filter_params[conditions][][operator]=gte&filter_params[conditions][][value]=2024-01-01\n\nGET /discounts?sort_params[field]=name&sort_params[sort]=asc\n\nGET /discounts?filter_params[combinator]=and&filter_params[conditions][][field]=status&filter_params[conditions][][operator]=eq&filter_params[conditions][][value]=active&filter_params[conditions][][field]=value&filter_params[conditions][][operator]=gt&filter_params[conditions][][value]=5\n\ndraft - Discount is in draft state
published - Discount is published but not active
active - Discount is currently active
archive - Discount is archived
Discounts::Percentage - Percentage-based discount
Discounts::FixedValue - Fixed amount discount
Discounts::FixedValue::ShippingProfile - Free shipping discount
Discounts::Percentage::SellingGroup - Selling group discount (excluded by default)
Display all discounts in an admin dashboard for the selected store
\nFilter active discounts to show only currently valid promotions
\nSearch discounts by code or name to manage a specific promotion
\nPaginate through a large number of discounts for reporting or export
\nFilter discounts by usage count to identify popular promotions
\nSort discounts by expiration date to prioritize expiring promotions
\nRetrieve detailed information about a specific discount, including all configuration rules and targeting criteria.
\nGET https://store-open-api.everbee.com/open_api/v1/discounts/{{discountId}}\n\nX-Access-Token: your_access_token\nStore-Id: your_store_id\n\nNone.
\nOn success, the API returns a JSON object containing complete discount details:
\n{\n \"data\": {\n \"id\": \"uuid\",\n \"code\": \"WELCOME10\",\n \"value\": 10.0,\n \"status\": \"active\",\n \"type\": \"Discounts::Percentage\",\n \"automatic\": false,\n \"combine_with_order\": true,\n \"combine_with_product\": true,\n \"combine_with_shipping\": false,\n \"usage_limit\": null,\n \"usage_limit_by\": null,\n \"activation_at\": \"2024-01-01T00:00:00Z\",\n \"expiration_at\": \"2024-12-31T23:59:59Z\",\n \"rules\": [\n {\n \"type\": \"variants\",\n \"operator\": \"in\",\n \"is_all_selected\": false,\n \"value\": [\n \"variant-uuid-1\",\n \"variant-uuid-2\"\n ]\n },\n {\n \"type\": \"collections\",\n \"operator\": \"in\",\n \"is_all_selected\": false,\n \"value\": [\n \"collection-uuid-1\"\n ]\n }\n ],\n \"collections\": [\n {\n \"id\": \"collection-uuid-1\",\n \"name\": \"Summer Collection\"\n }\n ]\n }\n}\n\nid (string) - Unique identifier of the discount
\ncode (string) - Discount code that customers enter
\nvalue (number) - Discount value (percentage or amount)
\nstatus (string) - Current status of the discount
\ntype (string) - Discount type class name
\nautomatic (boolean) - Whether discount is applied automatically
\ncombine_with_order (boolean) - Can be combined with order discounts
\ncombine_with_product (boolean) - Can be combined with product discounts
\ncombine_with_shipping (boolean) - Can be combined with shipping discounts
\nusage_limit (integer|null) - Maximum usage limit per customer
\nusage_limit_by (string|null) - Usage limit type (\"logged_in_buyer\" or \"email\")
\nactivation_at (datetime) - When discount becomes active (UTC)
\nexpiration_at (datetime|null) - When discount expires (UTC)
\nEach rule object contains:
\ntype (string) - Rule type (\"variants\", \"collections\", \"customer_groups\", etc.)
\noperator (string) - Comparison operator (\"in\", \"not_in\", \"eq\", etc.)
\nvalue (array|string) - Target values for the rule
\nOnly included for collection discount types:
\nid (string) - Collection identifier
\nname (string) - Collection display name
\n{ \"message\": \"Discount not found\"}\n\n{ \"error\": \"Authentication required\"}\n\n{ \"error\": \"Insufficient permissions\"}\n\nDisplay detailed discount configuration in admin interface
\nShow discount rules and targeting criteria for editing
\nRetrieve discount settings for validation before applying
\nDisplay discount details to customers on promotional pages
\nAudit discount configuration and usage rules
\nusage_limit_by settingCreate a new discount with specified configuration rules and targeting criteria.
\nPOST https://store-open-api.everbee.com/open_api/v1/discounts\n\nX-Access-Token: your_access_token\nStore-Id: your_store_id\nContent-Type: application/json\n\njson{ \"discount\": { // Discount configuration }}\n\n{ \"message\": \"Discount added successfully\"}\n\n{ \"error\": \"Code has already been taken, Value must be less than or equal to 100\"}\n\n{\n \"discount\": {\n \"type\": \"Discounts::Percentage\",\n \"code\": \"WELCOME10\",\n \"value\": 10,\n \"status\": \"active\",\n \"activation_at\": \"2024-01-01T00:00:00Z\",\n \"expiration_at\": \"2024-12-31T23:59:59Z\"\n }\n}\n\n{\n \"discount\": {\n \"type\": \"Discounts::Percentage\",\n \"code\": \"SUMMER20\",\n \"value\": 20,\n \"status\": \"active\",\n \"activation_at\": \"2024-06-01T00:00:00Z\",\n \"rules\": [\n {\n \"type\": \"variants\",\n \"operator\": \"in\",\n \"is_all_selected\": false,\n \"value\": [\n \"variant-uuid-1\",\n \"variant-uuid-2\"\n ]\n }\n ]\n }\n}\n\n{\n \"discount\": {\n \"type\": \"Discounts::Percentage\",\n \"code\": \"SUMMER20\",\n \"value\": 20,\n \"status\": \"active\",\n \"activation_at\": \"2024-06-01T00:00:00Z\",\n \"rules\": [\n {\n \"type\": \"variants\",\n \"operator\": \"in\",\n \"value\": [\n \"variant-uuid-1\",\n \"variant-uuid-2\"\n ]\n }\n ]\n }\n}\n\n{\n \"discount\": {\n \"type\": \"Discounts::FixedValue\",\n \"code\": \"COLLECTION10\",\n \"value\": 10.0,\n \"status\": \"active\",\n \"activation_at\": \"2024-01-01T00:00:00Z\",\n \"rules\": [\n {\n \"type\": \"collections\",\n \"operator\": \"in\",\n \"value\": []\n }\n ]\n }\n}\n\n{\n \"discount\": {\n \"type\": \"Discounts::Percentage::SellingGroup\",\n \"code\": \"VIP15\",\n \"value\": 15,\n \"status\": \"active\",\n \"activation_at\": \"2024-01-01T00:00:00Z\",\n \"automatic\": true,\n \"rules\": [\n {\n \"type\": \"selling_group\",\n \"operator\": \"eq\",\n \"value\": \"selling-group-uuid\"\n }\n ]\n }\n}\n\ncode: Required, unique per store (case-insensitive)
\nvalue: Required, numeric, type-specific range
\nactivation_at: Required, must be valid datetime
\nexpiration_at: Must be after activation_at if provided
\nPercentage: Value must be between 0-100
\nFixed Amount: Value must be positive number
\nSelling Group: Must be automatic, requires selling_group rule
\nusage_limit: Must be positive integer if provided
\nusage_limit_by: Required if usage_limit provided, must be \"logged_in_buyer\" or \"email\"
\n{ \"error\": \"Authentication required\"}\n\n{ \"error\": \"Insufficient permissions\"}\n\n{ \"error\": \"Code has already been taken\"}\n\nCache is automatically cleared after successful discount creation
\nSelling group discounts are automatically applied and cannot be combined with other discounts
\nFree shipping discounts use the fixed value type but apply to shipping costs only
\nUpdate an existing discount with new configuration.
\nPUT https://store-open-api.everbee.com/open_api/v1/discounts/{{discountId}}\n\nX-Access-Token: your_access_token\nStore-Id: your_store_id\nContent-Type: application/json\n\n{\n \"discount\": {\n \"type\": \"Discounts::Percentage\",\n \"code\": \"UPDATED15\",\n \"value\": 15,\n \"status\": \"active\",\n \"activation_at\": \"2024-01-01T00:00:00Z\",\n \"expiration_at\": \"2024-12-31T23:59:59Z\",\n \"automatic\": false,\n \"combine_with_order\": true,\n \"combine_with_product\": true,\n \"combine_with_shipping\": false,\n \"usage_limit\": 10,\n \"usage_limit_by\": \"logged_in_buyer\",\n \"rules\": [\n {\n \"type\": \"variants\",\n \"operator\": \"in\",\n \"value\": [\n \"variant-uuid-1\",\n \"variant-uuid-2\"\n ]\n }\n ]\n }\n}\n\n\njson{ \"message\": \"Discount updated successfully\"}\n\n{ \"error\": \"Code has already been taken, Value must be less than or equal to 100\"}\n\nAll fields from create endpoint are supported
\nPartial updates allowed - only include fields you want to change
\nSame validation rules as create endpoint apply
\nUpdate multiple discounts at once with the same configuration.
\nPUT https://store-open-api.everbee.com/open_api/v1/discounts/bulk_operation\n\nX-Access-Token: your_access_token\nStore-Id: your_store_id\nContent-Type: application/json\n\n{\n \"discount\": {\n \"ids\": [\n \"{{discountId}}\"\n ],\n \"status\": \"published\"\n }\n}\n\n\njson{ \"message\": \"Discounts updated successfully\"}\n\nPUT /discounts/bulk_operation\nContent-Type: application/json\n\n{\n \"discount\": {\n \"ids\": [\n \"550e8400-e29b-41d4-a716-446655440000\",\n \"550e8400-e29b-41d4-a716-446655440001\"\n ],\n \"status\": \"archive\"\n }\n}\n\n\nPUT /discounts/bulk_operation\nContent-Type: application/json\n\n{\n \"discount\": {\n \"ids\": [\n \"{{discountId}}\"\n ],\n \"status\": \"published\"\n }\n}\n\nstatus field in bulk operationsThis endpoint duplicates a existing discount created.
\nNo request body is required for this endpoint.
\nParameters
\nPath
\n8bb3583a-834c-4e6a-a065-062b9cf24eee (string, required) - The unique identifier for the duplication.The response for this request is in JSON format and follows the schema below:
\n{\n \"notice\": \"string\",\n}\n\nnotice (string) - A notice related to the duplication{\n \"notice\": \"Discount duplicated successfully\"\n}\n\nThis API retrieves one customer info present.
\n{\n \"data\": {\n \"id\": \"41565d42-f1dc-44fe-947d-c5c648b03acf\",\n \"type\": \"show\",\n \"attributes\": {\n \"id\": \"41565d42-f1dc-44fe-947d-c5c648b03acf\",\n \"first_name\": \"Customer1\",\n \"last_name\": \"sdf\",\n \"email\": \"nikhil@everbee.com\",\n \"phone_number\": \"+1\",\n \"notes\": \"\",\n \"addresses\": [\n {\n \"address\": {\n \"city\": \"\",\n \"country\": \"United States\",\n \"zipcode\": \"\",\n \"address_line1\": \"\",\n \"address_line2\": \"\"\n },\n \"created_at\": \"2025-06-05T16:49:38.370Z\",\n \"updated_at\": \"2025-06-05T16:49:38.370Z\",\n \"id\": \"f41bafc1-7aab-4c81-a4d5-f01693615585\",\n \"addressable_type\": \"Customer\",\n \"addressable_id\": \"41565d42-f1dc-44fe-947d-c5c648b03acf\",\n \"address_type\": null\n }\n ],\n \"orders_count\": 0,\n \"amount_spent\": \"$0.00\",\n \"created_at\": \"05-06-2025\",\n \"updated_at\": \"05-06-2025\"\n }\n }\n}\n\n{\n \"error\": \"Error message describing the issue\"\n}\n\n{\n \"error\": \"Insufficient permissions\"\n}\n\nThis API creates a new customer in the store.
\n{\n \"customer\": {\n \"first_name\": \"Nikhil B\",\n \"last_name\": \"Bhatt\",\n \"email\": \"nikhil+customer@everbee.io\",\n \"phone_number\": \"7817171728\",\n \"notes\": \"\",\n \"addresses_attributes\": [\n {\n \"address\": {\n \"city\": \"Bangalore\",\n \"country\": \"India\",\n \"zipcode\": \"560102\",\n \"address_line1\": \"Hsr Layout\",\n \"address_line2\": \"Bangalore\"\n }\n }\n ]\n }\n}\n\n{\n \"customer_id\": \"44bd6b62-cc5d-4898-a766-20d92a72c3e1\",\n \"notice\": \"Customer has been successfully added.\"\n}\n\n{\n \"error\": \"Error message describing the issue\"\n}\n\n{\n \"error\": \"Insufficient permissions\"\n}\n\nThis API updates an existing Customers in the system. It allows you to modify customer related data including addresses belonging to that customer.
\n{\n \"customer\": {\n \"first_name\": \"Nikhil B\",\n \"last_name\": \"Bhatt\",\n \"email\": \"nikhil+customer@everbee.io\",\n \"phone_number\": \"7817171728\",\n \"notes\": \"\",\n \"addresses_attributes\": [\n {\n \"address\": {\n \"city\": \"Bangalore\",\n \"country\": \"India\",\n \"zipcode\": \"560102\",\n \"address_line1\": \"Hsr Layout\",\n \"address_line2\": \"Bangalore\"\n }\n }\n ]\n }\n}\n\nNote: Include only the fields you want to update. Omitted fields will remain unchanged.
\n{\n \"notice\": \"Customer has been successfully updated.\"\n}\n\n{\n \"error\": \"Error message describing the issue\"\n}\n\n{\n \"error\": \"Insufficient permissions\"\n}\n\nEndpoint for managing customers in Everbee Store.
\n","_postman_id":"3571cc1d-458f-439e-94cd-9746c52aff28"},{"name":"Themes","item":[{"name":"List","id":"3c009ea4-fe42-43b9-b9b3-4b489f1a04d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Access-Token","value":"your_access_token","type":"text"},{"key":"Store-Id","value":"your_store_id","type":"text"}],"url":"https://store-open-api.everbee.com/open_api/v1/themes","description":"This API retrieves store frontend configurations.
\n{\n \"global_css\": {\n \"neutral-50\": \"#FFFFFF\",\n \"neutral-100\": \"#FAFAFA\",\n \"neutral-200\": \"#F7F7F7\",\n \"neutral-300\": \"#EDEDED\",\n \"neutral-400\": \"#E6E6E6\",\n \"neutral-500\": \"#B3B3B4\",\n \"neutral-600\": \"#8B8B8C\",\n \"neutral-700\": \"#6A6A6C\",\n \"neutral-800\": \"#505152\",\n \"neutral-900\": \"#2E2E2F\",\n \"neutral-950\": \"#19191A\",\n \"primary-50\": \"#F6FCFC\",\n \"primary-100\": \"#F2F9F9\",\n \"primary-200\": \"#C0DEE1\",\n \"primary-300\": \"#90C2C6\",\n \"primary-400\": \"#62A6AE\",\n \"primary-500\": \"#4D8790\",\n \"primary-600\": \"#3E717B\",\n \"primary-700\": \"#334F57\",\n \"primary-800\": \"#25363B\",\n \"primary-900\": \"#1D282B\",\n \"primary-950\": \"#1B2C31\",\n \"secondary-50\": \"#FFF9F9\",\n \"secondary-100\": \"#FAF6F6\",\n \"secondary-200\": \"#EFDBD9\",\n \"secondary-300\": \"#E7C4C2\",\n \"secondary-400\": \"#D09E9A\",\n \"secondary-500\": \"#B37772\",\n \"secondary-600\": \"#A6635C\",\n \"secondary-700\": \"#734641\",\n \"secondary-800\": \"#4A2E2C\",\n \"secondary-900\": \"#331E1C\",\n \"secondary-950\": \"#1A0F0E\",\n \"tertiary-50\": \"#FFF7FE\",\n \"tertiary-100\": \"#FFF2FE\",\n \"tertiary-200\": \"#FFC6FD\",\n \"tertiary-300\": \"#FF9EFA\",\n \"tertiary-400\": \"#FF5DEE\",\n \"tertiary-500\": \"#E632D6\",\n \"tertiary-600\": \"#FF00FF\",\n \"tertiary-700\": \"#A900A3\",\n \"tertiary-800\": \"#7A0075\",\n \"tertiary-900\": \"#5E005A\",\n \"tertiary-950\": \"#30002E\",\n \"primary-font\": \"PT sans narrow\",\n \"secondary-font\": \"Josefin Sans\",\n \"corner-radius\": \"20px\"\n },\n \"has_custom_settings\": true\n}\n\n{\n \"error\": \"Error message describing the issue\"\n}\n\n{\n \"error\": \"Insufficient permissions\"\n}\n\nThis API endpoint gives store theme setting info.
\nIt returns the complete theme configuration used by the store’s frontend, including color palettes, typography, and UI styling preferences.
\n","_postman_id":"e1bc96b7-ab9e-40d8-b495-2ab96a29ca7d"},{"name":"Webhooks","item":[{"name":"Introduction","item":[],"id":"88e0d759-3944-4db4-a541-c41dd2ec94a2","description":"This document provides comprehensive information about the webhooks available in the Everbee Store.
\nEverbee's webhook system is designed to provide real-time notifications about events happening in a store. Here's an overview of how it works:
\nApplications subscribe to supported webhook topics using the existing open API (mentioned below).
\nWebhooks are triggered for specific events in the store (e.g., order creation, product updates).
\nWhenever one of these events occurs in a store, and there is webhook subscription entry with URL. we trigger the registered URL endpoint with the event payload.
\nAn application can subscribe to only one webhook event per store.
\nAll webhook payloads include the following base structure:
\n{\n \"id\": \"resource-id\", # e.g. order_id / product_id \n \"store_id\": \"store-identifier\",\n \"topic\": \"event.topic\",\n \"data\": {\n // Event-specific data (only for 'created / updated' events)\n }\n}\n\nTriggered when a new order is created.
\n{\n \"id\": \"ed862725-3c1d-455e-92b1-286aad10943c\",\n \"store_id\": \"e3596362-b83d-4149-bfd9-165a35572f19\",\n \"topic\": \"order.created\",\n \"data\": {\n \"id\": \"ed862725-3c1d-455e-92b1-286aad10943c\"\n \"status\": \"placed\",\n \"total_line_items_price\": \"50.0\",\n \"order_number\": \"OAVCILI\",\n \"shipping_address\": null,\n \"shipping_label\": null,\n \"tax_amount\": \"0.0\",\n \"shipping_tax_amount\": \"0.0\",\n \"shipping_cost\": 0,\n \"created_at\": \"28-07-2025 02:09 AM\",\n \"total_price\": \"$50.00\",\n \"total_discount\": null,\n \"line_items\": [\n {\n \"id\": \"2e0962b8-3a3f-45a4-a040-01f5df37b066\",\n \"quantity\": 1,\n \"variant_id\": \"262fb3c4-d87a-4071-84c4-b22c66370d6b\",\n \"store_id\": \"e3596362-b83d-4149-bfd9-165a35572f19\",\n \"order_id\": \"ed862725-3c1d-455e-92b1-286aad10943c\",\n \"created_at\": \"2025-07-28T06:09:18.078Z\",\n \"updated_at\": \"2025-07-28T06:09:18.078Z\",\n \"selling_group_id\": null,\n \"variant\": {\n \"sku\": \"81558182161661132497\",\n \"deleted_at\": null,\n \"is_master\": false,\n \"cost_per_item\": null,\n \"position\": null,\n \"cost_currency\": null,\n \"public_metadata\": {\n \"sku\": \"81558182161661132497\"\n },\n \"private_metadata\": null,\n \"created_at\": \"2025-05-28T16:53:13.002Z\",\n \"updated_at\": \"2025-05-28T16:53:13.002Z\",\n \"id\": \"262fb3c4-d87a-4071-84c4-b22c66370d6b\",\n \"product_id\": \"fd072080-4b2f-4f39-85f4-35a116901459\",\n \"compare_at_price\": null,\n \"price\": \"50.0\",\n \"profit\": null,\n \"margin\": null,\n \"option_value_id\": null,\n \"store_id\": \"e3596362-b83d-4149-bfd9-165a35572f19\",\n \"digital_file_url\": null,\n \"etsy_meta_data\": {},\n \"upload_status\": \"unmatched\",\n \"track_quantity\": false,\n \"uuid\": null,\n \"available_quantity\": null\n },\n \"product\": {\n \"id\": \"fd072080-4b2f-4f39-85f4-35a116901459\",\n \"name\": \"Copy of Copy of Copy of Unisex Heavy Cotton Tee\",\n \"description\": \"The unisex heavy cotton tee is the basic staple of any wardrobe. It is the foundation upon which casual fashion grows. All it needs is a personalized design to elevate things to profitability. The specially spun fibers provide a smooth surface for premium printing vividity and sharpness. No side seams mean there are no itchy interruptions under the arms. The shoulders have tape for improved durability.\\\\n.: Made with medium fabric (5.3 oz/yd² (180 g/m²)) consisting of 100% cotton for year-round comfort that is sustainable and highly durable. \\\\n.: The classic fit of this shirt ensures a comfy, relaxed wear while the crew neckline adds that neat, timeless look that can blend into any occasion, casual or semi-formal.\\\\n.: The tear-away label means a scratch-free experience with no irritation or discomfort whatsoever.\\\\n.: Made using 100% US cotton that is ethically grown and harvested. Gildan is also a proud member of the US Cotton Trust Protocol ensuring ethical and sustainable means of production. This blank tee is certified by Oeko-Tex for safety and quality assurance.\",\n \"slug\": \"copy-of-copy-of-copy-of-unisex-heavy-cotton-tee-22\",\n \"product_type\": \"physical\"\n }\n }\n ],\n \"selling_group\": [],\n \"customer\": {\n \"id\": \"030426d4-0c44-4fb0-b89f-2c61e9165294\",\n \"first_name\": \"Nikhil\",\n \"last_name\": \"Bhatt\",\n \"email\": \"nikhil+web@everbee.io\",\n \"phone_number\": \"+1\",\n \"notes\": \"\",\n \"addresses\": [\n {\n \"address\": {\n \"city\": \"\",\n \"country\": \"United States\",\n \"zipcode\": \"\",\n \"address_line1\": \"\",\n \"address_line2\": \"\"\n },\n \"created_at\": \"2025-07-22T15:58:37.718Z\",\n \"updated_at\": \"2025-07-22T15:58:37.718Z\",\n \"id\": \"5bc577b6-b5d2-4172-aefc-b7235e037e11\",\n \"addressable_type\": \"Customer\",\n \"addressable_id\": \"030426d4-0c44-4fb0-b89f-2c61e9165294\",\n \"address_type\": null\n }\n ],\n \"created_at\": \"22-07-2025 11:58 AM\"\n }\n }\n\nTriggered when order status changes to cancelled.
\n{\n \"id\": \"order_123\",\n \"store_id\": \"store_abc123\",\n \"topic\": \"order.updated\",\n \"data\": {\n \"status\": \"cancelled\"\n }\n}\n\nTriggered when an order status is marked as shipped.
\n{\n \"id\": \"ed862725-3c1d-455e-92b1-286aad10943c\",\n \"store_id\": \"e3596362-b83d-4149-bfd9-165a35572f19\",\n \"topic\": \"order.shipped\",\n \"data\": {\n \"status\": \"shipped\",\n \"shipment_details\": [\n {\n \"carrier\": \"Ekart\",\n \"tracking_number\": \"123\",\n \"tracking_link\": \"https://example.com\"\n }\n ]\n }\n}\n\nTriggered when an order is permanently deleted.
\n{\n \"id\": \"evt_order_123_delete\",\n \"store_id\": \"store_abc123\",\n \"topic\": \"order.deleted\"\n}\n\nTriggered when an order status is marked as delivered.
\n{\n \"id\": \"ed862725-3c1d-455e-92b1-286aad10943c\",\n \"store_id\": \"e3596362-b83d-4149-bfd9-165a35572f19\",\n \"topic\": \"order.delivered\",\n \"data\": {\n \"status\": \"delivered\",\n \"shipment_details\": [\n {\n \"carrier\": \"Ekart\",\n \"tracking_number\": \"123\",\n \"tracking_link\": \"https://example.com\"\n }\n ]\n }\n}\n\nTriggered when a new product is created.
\n{\n \"id\": \"e8a1d868-1a5d-4282-a37f-f29100a60d32\",\n \"store_id\": \"e3596362-b83d-4149-bfd9-165a35572f19\",\n \"topic\": \"product.created\",\n \"data\": {\n \"id\": \"e8a1d868-1a5d-4282-a37f-f29100a60d32\",\n \"name\": \"Nik new\",\n \"description\": \"New prod\",\n \"slug\": \"nik-new-1\",\n \"download_limit\": null,\n \"status\": \"published\",\n \"product_type\": \"physical\",\n \"meta_title\": \"Nik new\",\n \"meta_description\": \"New prod\",\n \"meta_keywords\": null,\n \"link\": \"Nik-new\",\n \"available_on\": null,\n \"promotionable\": true,\n \"category_id\": \"ee7d733d-7935-4884-ace7-7d7214bce8c1\",\n \"public_metadata\": null,\n \"private_metadata\": null,\n \"make_active_at\": null,\n \"visibility\": \"visible\",\n \"tags\": [],\n \"is_personalisation_required\": true,\n \"personalisation_options\": [\n {\n \"id\": \"4d1fb86f-3da2-492b-8642-184729725511\",\n \"label\": \"personal\",\n \"character_limit\": 100,\n \"is_optional_for_buyer\": true\n }\n ],\n \"created_at\": \"28-07-2025 02:00 AM\",\n \"variants\": [\n {\n \"id\": \"86018a48-a40e-4609-bd6d-0c528973a5cd\",\n \"sku\": \"\",\n \"price\": \"0.0\",\n \"compare_at_price\": \"0.0\",\n \"option_values\": [],\n \"available_quantity\": null\n },\n {\n \"id\": \"b6a5e694-aa01-4767-9a6c-02123659b784\",\n \"sku\": \"\",\n \"price\": \"20.0\",\n \"compare_at_price\": \"50.0\",\n \"option_values\": [\n {\n \"id\": \"ce000539-a2b3-4499-b003-356a800c500a\",\n \"name\": \"M\",\n \"option_type_id\": \"1345b8f6-bbb5-42e6-ad9b-7df23dd247eb\"\n }\n ],\n \"available_quantity\": 10\n },\n {\n \"id\": \"507fd995-2566-4157-b0f6-6127764c6cf6\",\n \"sku\": \"\",\n \"price\": \"20.0\",\n \"compare_at_price\": \"50.0\",\n \"option_values\": [\n {\n \"id\": \"314f0ad2-a73a-48db-919c-dfa30579e435\",\n \"name\": \"S\",\n \"option_type_id\": \"1345b8f6-bbb5-42e6-ad9b-7df23dd247eb\"\n }\n ],\n \"available_quantity\": 10\n },\n {\n \"id\": \"a57e187e-21ca-4c66-9b7f-8dda99d96ff4\",\n \"sku\": \"\",\n \"price\": \"20.0\",\n \"compare_at_price\": \"50.0\",\n \"option_values\": [\n {\n \"id\": \"eeb8dbbd-2526-4a04-8afb-fc5dbfa30dd4\",\n \"name\": \"Xl\",\n \"option_type_id\": \"1345b8f6-bbb5-42e6-ad9b-7df23dd247eb\"\n }\n ],\n \"available_quantity\": 10\n },\n {\n \"id\": \"4b5257f9-eba4-4f2a-ba3b-13d9140a84bc\",\n \"sku\": \"\",\n \"price\": \"20.0\",\n \"compare_at_price\": \"50.0\",\n \"option_values\": [\n {\n \"id\": \"4fc1fa55-86da-4e2c-b6ca-f3974be7c694\",\n \"name\": \"XXL\",\n \"option_type_id\": \"1345b8f6-bbb5-42e6-ad9b-7df23dd247eb\"\n }\n ],\n \"available_quantity\": 10\n }\n ]\n }\n}\n\nTriggered when product status is updated.
\n{\n \"id\": \"prod_123\",\n \"store_id\": \"store_abc123\",\n \"topic\": \"product.updated\",\n \"data\": {\n \"status\": \"unavailable\"\n }\n}\n\nTriggered when a product is permanently deleted.
\n{\n \"id\": \"evt_prod_123_delete\",\n \"store_id\": \"store_abc123\",\n \"topic\": \"product.deleted\"\n}\n\nTriggered when a new customer is created.
\n{\n \"id\": \"034465e1-869e-48c5-9bcc-7a294be80258\",\n \"store_id\": \"e3596362-b83d-4149-bfd9-165a35572f19\",\n \"topic\": \"customer.created\",\n \"data\": {\n \"id\": \"034465e1-869e-48c5-9bcc-7a294be80258\",\n \"first_name\": \"Nik\",\n \"last_name\": \"Bh\",\n \"email\": \"nikbha@gmai.com\",\n \"phone_number\": \"+1\",\n \"notes\": \"\",\n \"addresses\": [\n {\n \"address\": {\n \"city\": \"\",\n \"country\": \"United States\",\n \"zipcode\": \"\",\n \"address_line1\": \"\",\n \"address_line2\": \"\"\n },\n \"created_at\": \"2025-07-28T06:12:17.579Z\",\n \"updated_at\": \"2025-07-28T06:12:17.579Z\",\n \"id\": \"af224aa6-ee17-4cbd-8c57-4cf2b5917d0b\",\n \"addressable_type\": \"Customer\",\n \"addressable_id\": \"034465e1-869e-48c5-9bcc-7a294be80258\",\n \"address_type\": null\n }\n ],\n \"created_at\": \"28-07-2025 02:12 AM\"\n }\n}\n\nTriggered when a new collection is created.
\n{\n \"id\": \"evt_coll_123\",\n \"store_id\": \"store_abc123\",\n \"topic\": \"collection.created\",\n \"data\": {\n \"id\": \"7e0ed2cf-dc74-4351-ad7a-36672d6e7cc4\",\n \"name\": \"Collection\",\n \"description\": \"collection of mobile covers\",\n \"page_title\": \"Collection\",\n \"meta_description\": \"collection of mobile covers\",\n \"url_handle\": \"Collection\",\n \"collection_type\": \"manual\",\n \"conditions\": [],\n \"status\": \"published\",\n \"visible\": false,\n \"slug\": \"collection\",\n \"is_visible_on_catalog\": false,\n \"is_visible_on_header\": false,\n \"created_at\": \"25-07-2025 04:28 PM\"\n }\n}\n\nTriggered when a collection status is updated.
\n{\n \"id\": \"coll_123\",\n \"store_id\": \"store_abc123\",\n \"topic\": \"collection.updated\",\n \"data\": {\n \"status\": \"published\"\n }\n}\n\nTriggered when a collection is deleted.
\n{\n \"id\": \"evt_coll_123_delete\",\n \"store_id\": \"store_abc123\",\n \"topic\": \"collection.deleted\",\n}\n\nCreate webhook_subscription using POST API as mentioned below for supported webhooks.
\nHandle Incoming Webhooks
Your endpoint should handle POST requests with the webhook payload and return a 2xx status code within 10 seconds.
Note that we will hit this URL only once, when an event gets triggered.
\nYou may encounter one of the following error messages:
\n{\n \"error\": \"Your session has expired. Please regenerate access token to continue.\"\n}\n\n{\n \"error\": \"Invalid authentication token format. Please ensure you're using a valid access token.\"\n}\n\nCommon Reasons:
\nThe token is malformed (e.g., copy/paste issue, extra characters).
\nYou're using an expired token (A token gets expired after 90 days if not reissued).
\nThe token was never valid or has been revoked.
\nAction Steps:
\nCheck token format – Ensure you're using a properly structured access token (e.g., JWT with three segments separated by dots).
\nGenerate a new token using refresh token mechanism.
\n/attachments?Answer:
\nYes. View here.
\nAll product images must be uploaded via the /attachments endpoint. This ensures:
Images are stored on our systems
\nThey are validated and optimized
\nServed via our CDN for consistent delivery and long-term access
\nYes. We support up to 1 + 6 developer stores per account.
\n","_postman_id":"5b3cb19d-a94f-472e-854e-0a25488f0b4f"},{"name":"Sales Tax","item":[],"id":"82dd40be-3beb-4d00-9b9a-cb293ad42454","description":"Sales tax is handled via Stripe.
\nTo enable tax collection:
\nConnect your Stripe account in your Everbee store settings.
\nConfigure your tax information (such as regions and rates) directly in the Everbee store settings.
\nTaxes will be automatically applied during checkout based on your setup in Stripe.
\nThe Master Variant is a special variant that every product must have in the system. It serves as the default or base variant for a product and has the following characteristics:
\nEvery product has exactly one master variant - identified by the is_master: true flag in the database.
Behavior based on product configuration:
\nProducts without additional variants: The master variant is visible and editable. It represents the single purchasable version of the product.
\nProducts with additional variants: The master variant is hidden from customers and serves only as a base template. Only the non-master variants are shown and purchasable.
\nUI behavior (store):
\nWhen a product has no additional variants, the master variant fields (price, inventory, etc.) are directly editable
\nWhen additional variants exist, the master variant is not displayed in the UI, and only the specific variants are shown
\nTo switch between these modes in the UI, you would toggle whether the product has variants, which determines if the master variant is editable or hidden
\nFind answers to commonly asked questions about our API. If you don't see your question here, feel free to contact our support team.
\n","_postman_id":"d4f4a248-0991-4ee8-9443-4a3a23515715"},{"name":"Changelog","item":[{"name":"[1.1.0] - 2026-05-29","item":[],"id":"251bb4f5-c621-450c-9bd6-dd4b8f2aecc1","description":"Manage shipping profiles within the Everbee platform. This release supports the complete lifecycle of shipping profiles
\nShipping Profile Types
\nDefault Shipping Profile — Automatically created for every store.
\nAll products are assigned to the default shipping profile unless another profile is explicitly assigned.
\nDefault shipping profiles cannot be edited or deleted.
\nIf a non-default shipping profile is deleted, all associated products are automatically reassigned to the default shipping profile.
\nGeneral Shipping Profile — Shipping profiles created manually through the Store UI.
\nApp Shipping Profile — Shipping profiles created through the Open API by third-party applications.
\nFulfillment Location Rules
\nA third-party app can create only one fulfillment location per installed store.
\nThe same fulfillment location can be reused across multiple shipping profiles.
\nExample: If an app is installed in a store, it may create one fulfillment location, and that fulfillment location can be attached to multiple shipping profiles.
\nThe Fulfillment Update API allows you to update the status of order line items (order fulfillment) and mark them as delivered after shipping is completed.
\nAn order is automatically marked as delivered once all order line items are marked as delivered — no additional API call is required.
\nDirect order status update may result in an error if all order fulfillments in the order are not updated to delivered.
\nIt is recommended to update the status of individual line items via the Fulfillment Update API.
\nDetails - https://documenter.getpostman.com/view/28506789/2sB2jAb8Hx#cda6cc73-5af1-4d17-b9bf-f0a345a64d38
\nThe Update Tracking API allows you to update order tracking information in the Everbee Oposhop system. This API is used when shipping details become available for an order, such as when a carrier provides a tracking number and shipping status update.
\nOnce a tracking link is provided for an order line item, the line item's fulfillment status is automatically updated to shipped.
\nAn order is automatically marked as shipped once tracking links have been added to all line items — no additional API call is required.
\nNote: Do not call the Order Update API separately to update the order status to shipped. Doing so may result in an error if all line items in the order do not have tracking links.
\nAll notable changes to the Everbee Oposhop API will be documented here.
\nThe format follows Keep a Changelog.
\n","_postman_id":"3a7846e3-9fb4-44e4-91cf-25090ec00ef1"}],"event":[{"listen":"prerequest","script":{"id":"75efa181-9474-49f6-ae0e-f3cfb0b8497d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"da76e658-a445-4779-bca5-baa2f2f5eb2b","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://store-open-api.everbee.com/open_api/v1","type":"string"},{"key":"accessToken","value":"your_access_token","type":"string"},{"key":"subdomain","value":"your_store_subdomain","type":"string"},{"key":"categoryId","value":"your_category_id","type":"string"},{"key":"productId","value":"your_product_id","type":"string"},{"key":"variantId","value":"your_variant_id","type":"string"},{"key":"orderId","value":"your_order_id","type":"string"},{"key":"shippingProfileId","value":"your_shipping_profile_id","type":"string"},{"key":"storeId","value":"your_store_id","type":"string"},{"key":"customerId","value":"034465e1-869e-48c5-9bcc-7a294be80258"},{"key":"webhook-subscription-id","value":"Your-webhook-subscription-id","type":"default"}]}