API-Dokumentation

Erfahren Sie, wie Sie Ihr DropshippingXL-Konto optimal nutzen können. Gehen Sie jeden Schritt durch, von der Authentifizierung über die Verwaltung bezahlter und unbezahlter Bestellungen bis hin zur Produktsynchronisation.

vidaXL Dropshippers API (v2)

Download OpenAPI specification:Download

Authentication

ApiKeyAuth

Security Scheme Type API Key
Header parameter name: X-API-Key

Unpaid orders

Create an unpaid order

New orders will remain unpaid and available for payment in 'Unpaid orders' page. Automatic payment of orders through the API is not available yet.

Authorizations:
Request Body schema: application/json

Details of the order to create

order_reference
required
string
required
object (Address)
required
Array of objects non-empty [ items ]

Responses

Response Schema: application/json
id
string
customer_order_reference
string
status
string
Default: "unpaid"
creation_date
string <date-time>
currency
string
total
number
object (Address)
Array of objects (OrderProduct) non-empty [ items ]

Request samples

Content type
application/json
{
  • "order_reference": "70000001",
  • "address": {
    },
  • "products": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "e57fa646f3cd2090e8a710fcef",
  • "customer_order_reference": "70000001",
  • "status": "unpaid",
  • "creation_date": "2021-04-29T17:32:28Z",
  • "currency": "GBP",
  • "total": 98.98,
  • "shipping_address": {
    },
  • "products": [
    ]
}

Delete an unpaid order

You can only delete orders that have not been paid yet

Authorizations:
query Parameters
id
string
Example: id=b067546b1f3a00ec4edd657c5c

Order ID to delete

order_reference
string
Example: order_reference=70000001

Order reference to delete

Responses

Get all the unpaid orders

Displays all the orders which payment is still pending

Authorizations:
query Parameters
limit
integer [ 1 .. 50 ]
Default: 10

Number of items to return

offset
integer >= 0
Default: 0

Number of items to skip

Responses

Response Schema: application/json
required
Array of objects (UnpaidOrder) [ items ]
required
object (Pagination)

Response samples

Content type
application/json
{
  • "items": [
    ],
}

Get an unpaid order by reference

Authorizations:
query Parameters
order_reference
string
Example: order_reference=70000001

Responses

Response Schema: application/json
id
string
customer_order_reference
string
status
string
Default: "unpaid"
creation_date
string <date-time>
currency
string
total
number
object (Address)
Array of objects (OrderProduct) non-empty [ items ]

Response samples

Content type
application/json
{
  • "id": "e57fa646f3cd2090e8a710fcef",
  • "customer_order_reference": "70000001",
  • "status": "unpaid",
  • "creation_date": "2021-04-29T17:32:28Z",
  • "currency": "GBP",
  • "total": 98.98,
  • "shipping_address": {
    },
  • "products": [
    ]
}

Get an unpaid order by ID

Authorizations:
path Parameters
id
required
string

Responses

Response Schema: application/json
id
string
customer_order_reference
string
status
string
Default: "unpaid"
creation_date
string <date-time>
currency
string
total
number
object (Address)
Array of objects (OrderProduct) non-empty [ items ]

Response samples

Content type
application/json
{
  • "id": "e57fa646f3cd2090e8a710fcef",
  • "customer_order_reference": "70000001",
  • "status": "unpaid",
  • "creation_date": "2021-04-29T17:32:28Z",
  • "currency": "GBP",
  • "total": 98.98,
  • "shipping_address": {
    },
  • "products": [
    ]
}

Orders

Get all the paid orders

Authorizations:
query Parameters
from
string <date> ^\d{4}-\d{2}-\d{2}$
Example: from=2021-04-01

Retrieve items starting from this date

to
string <date> ^\d{4}-\d{2}-\d{2}$
Example: to=2021-04-30

Retrieve orders until this date

limit
integer [ 1 .. 50 ]
Default: 10

Number of items to return

offset
integer >= 0
Default: 0

Number of items to skip

Responses

Response Schema: application/json
required
Array of objects (Order) [ items ]
required
object (Pagination)

Response samples

Content type
application/json
{}

Get a paid order by reference

Authorizations:
query Parameters
order_reference
string
Example: order_reference=70000001

Responses

Response Schema: application/json
id
required
string
customer_order_reference
string
status
required
string
creation_date
required
string <date-time>
currency
required
string
required
object
required
object (Address)
required
Array of objects (OrderProduct) non-empty [ items ]
Array of objects[ items ]
documents_link
string^https?://

Link to the documents/invoices resource

Response samples

Content type
application/json
{
  • "id": "400000024005",
  • "customer_order_reference": "70000001",
  • "status": "string",
  • "creation_date": "2021-04-29T17:32:28Z",
  • "currency": "GBP",
  • "totals": {
    },