API: Introduction

API: Introduction

What's an API?

We recommend integrating your systems using our API by following our detailed guide. You can also use the file upload method. It's easy and requires little to no technical skills.

Go to Import orders page

How to find the API key in production

You can find the API token and all related information under the 'Account Details' tab on your 'My Account' page. Alternatively, you can access it directly by clicking on the button below.

Access API Key

Request sandbox API

Here's how to request a sandbox API:

 
  1. Request the creation of a Sandbox account by emailing: support@dropxl.com
  2. Once confirmed, you'll receive the login details for sandbox.b2b.dropxl.com. You can find the sandbox API token by clicking on 'My account'.
  3. Build and test your integration application using the provided sandbox credentials.

Introduction to requesting API access

Dropshippers can use our Order API to create and retrieve real-time order information. Below are the URLs for both the production and test environments:

Production environment: https://b2b.vidaxl.com
Test Environment: https://sandbox.b2b.dropxl.com

Available order status 

To retrieve the latest order status, please schedule a "Get Order" call. When the order status is 5, both the tracking number and the tracking URL will be available. It is common for sellers to encounter a 422 error with various error messages.

Carrier and shipping ID mapping

This table displays the mapping of shipping IDs to carriers. Use this information to identify the shipping service by its unique ID. If errors occur during shipment processing, verify that the specified IDs are correct.

Mapping IDOrder Status
  • 1Temporary (order placed, but not paid yet)
  • 2Submitted (order paid)
  • 4Being Prepared (order acknowledged by dropXL)
  • 5Sent (order shipped and invoice sent)
  • 7Cancelled
  • 8Refunded
  • 9Replaced

 

Mapping IDCarrier
 

Error codes

  • 1

    Active product check

    Ensure the product you are ordering is active, meaning both its price and stock are available in the offer feed.

  • 2

    Allowed country codes

    Create orders only with a country code where you are authorized to dropship. For example, if your account is registered to dropship in GB, but you attempt to create an order with DE, you will receive the error message: "Could not create order.”