Skip to main content

Getting Started - 3Dsellers API

Learn how to integrate your online stores with the 3Dsellers API to automate tasks, manage listings programmatically, and synchronize data across multiple platforms.

Tony Adams avatar
Written by Tony Adams
Updated today

Overview

The 3Dsellers API empowers eBay sellers and developers to seamlessly integrate their online stores with the 3Dsellers platform. This RESTful API enables you to automate tasks, manage listings programmatically, synchronize data across multiple platforms, and build custom integrations that streamline your eCommerce operations. Whether you're a technical seller looking to automate workflows or a developer building custom solutions, the 3Dsellers API provides the tools you need to extend and enhance your selling capabilities.

Note: To access and utilize the 3Dsellers API, you must have administrative privileges within your 3Dsellers account.

API documentation

How to Enable the 3Dsellers API

  1. Log in to your 3Dsellers account

  2. Navigate to Settings from the main menu

  3. Click on Integrations in the settings menu

  4. Locate the 3Dsellers API section

  5. Click Generate API Key to create a new API key

  6. Copy the generated API key and store it securely - you will need it for authentication

API Authentication

Auth2 is not required if you generated your API token from the 3Dsellers app. In that case, simply send the header Authorization: Bearer <your_token> with each request.

The 3Dsellers API uses OAuth2 authentication. To authenticate your requests, you need to:

  1. Authorize your application using GET /auth/authorize

  2. Obtain an OAuth2 token using POST /auth/token with your API credentials

  3. Include the access token in the Authorization header of subsequent requests: Authorization: Bearer YOUR_ACCESS_TOKEN

  4. Verify token validity using GET /auth/me

For detailed OAuth2 flow instructions, refer to the API documentation.

Available API Endpoints

The 3Dsellers API provides endpoints for managing various aspects of your eCommerce operations:

Product Management

  • GET /v1/products: Retrieve all products from your catalog

  • POST /v1/products: Create new products in your catalog programmatically

  • PATCH /v1/products/{id}: Partially update existing product information, including inventory levels, pricing, and descriptions

  • GET /v1/products/categories: Retrieve all product categories

  • POST /v1/products/categories: Create new product categories

Authentication

  • GET /auth/authorize: Authorize OAuth2 requests

  • POST /auth/token: Get OAuth2 access token

  • GET /auth/me: Verify if the token is valid and get user information

Webhooks

  • POST /webhooks/subscribe: Subscribe to webhook events. Currently supported events include: order.created

  • POST /webhooks/unsubscribe: Unsubscribe from webhook notifications

Health Check

  • GET /health/live: Check if the API service is live

  • GET /health/ready: Check if the API service is ready to accept requests

API Documentation

For detailed information on available endpoints, request/response formats, and code examples, refer to the complete API documentation:

3Dsellers API Documentation

The documentation includes comprehensive details on:

  • Endpoint URLs and HTTP methods

  • Request parameters and body formats

  • Response schemas and status codes

  • Authentication requirements

  • Rate limits and best practices

Rate Limits

The 3Dsellers API enforces rate limits to ensure optimal performance and fair usage across all users. Specific rate limit details are available in the API documentation. It's important to:

  • Implement proper error handling for rate limit responses

  • Use exponential backoff strategies when rate limits are encountered

  • Monitor your API usage to stay within limits

  • Contact support if you need higher rate limits for your use case

Troubleshooting

I'm getting an "Invalid API Token" error. What should I do?

If you receive an invalid API token error:

  • Confirm that you copied the token correctly from the 3Dsellers Integrations page.​

  • Generate a new token from Settings → Integrations → 3Dsellers API, then update it in your integration.​

  • Make sure you include it in the request header as Authorization: Bearer <your_token>.​

Can I add variations to products and update inventory through the API?

Yes, the 3Dsellers API supports managing product variations and inventory updates. Refer to the API documentation for specific endpoints and parameters related to variations and inventory management.

Are there any limitations on what I can do with the API?

While the API provides extensive functionality, some features may have limitations or require specific permissions. Check the API documentation for endpoint-specific requirements and restrictions.

Best Practices

  • Keep your API key secure: Never share your API key publicly or commit it to version control. Use environment variables or secure credential storage.

  • Implement error handling: Always handle API errors gracefully, including rate limits, authentication failures, and validation errors.

  • Use webhooks when possible: Instead of polling for updates, subscribe to webhook events for real-time notifications.

  • Respect rate limits: Implement proper throttling and retry logic to stay within API rate limits.

  • Test in development: Use test accounts and development environments before deploying API integrations to production.

  • Monitor usage: Regularly review your API usage patterns and optimize requests to reduce unnecessary calls.

Related Articles

Related Articles
How to Add Multiple eBay Accounts & Regions to 3Dsellers | Troubleshooting Sync Issues
Zapier Integration
Did this answer your question?