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:

ApiKeyAuth

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": {"first_name": "John",
"last_name": "Doe",
"street": "Schulerstraße",
"house_number": "25B",
"city": "Wien",
"postal_code": "1010",
"country": "AT",
"phone": "0684541247"
},
"products": [{"product_code": "274181",
"quantity": 10
}
]
}

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": {"first_name": "John",
"last_name": "Doe",
"street": "Schulerstraße",
"house_number": "25B",
"city": "Wien",
"postal_code": "1010",
"country": "AT",
"phone": "0684541247"
},
"products": [{"id": "274181",
"ean": "8718475569039",
"sku": "274181",
"name": "vidaXL Cat Tree 182 cm Beige Plush",
"brand": "vidaXL",
"quantity": 0,
"price": 95.99,
"currency": "GBP"
}
]
}

Delete an unpaid order

You can only delete orders that have not been paid yet

Authorizations:

ApiKeyAuth

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:

ApiKeyAuth

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": [{"id": "e57fa646f3cd2090e8a710fcef",
"customer_order_reference": "70000001",
"status": "unpaid",
"creation_date": "2021-04-29T17:32:28Z",
"currency": "GBP",
"total": 98.98,
"shipping_address": {"first_name": "John",
"last_name": "Doe",
"street": "Schulerstraße",
"house_number": "25B",
"city": "Wien",
"postal_code": "1010",
"country": "AT",
"phone": "0684541247"
},
"products": [{"id": "274181",
"ean": "8718475569039",
"sku": "274181",
"name": "vidaXL Cat Tree 182 cm Beige Plush",
"brand": "vidaXL",
"quantity": 0,
"price": 95.99,
"currency": "GBP"
}
]
}
],
"pagination": {"total": 25000,
"previous_page": "https://b2b.vidaxl.com/api/v2/...?limit=10&offset=10",
"next_page": "https://b2b.vidaxl.com/api/v2/...?limit=10&offset=30"
}
}

Get an unpaid order by reference

Authorizations:

ApiKeyAuth

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": {"first_name": "John",
"last_name": "Doe",
"street": "Schulerstraße",
"house_number": "25B",
"city": "Wien",
"postal_code": "1010",
"country": "AT",
"phone": "0684541247"
},
"products": [{"id": "274181",
"ean": "8718475569039",
"sku": "274181",
"name": "vidaXL Cat Tree 182 cm Beige Plush",
"brand": "vidaXL",
"quantity": 0,
"price": 95.99,
"currency": "GBP"
}
]
}

Get an unpaid order by ID

Authorizations:

ApiKeyAuth

path Parameters

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": {"first_name": "John",
"last_name": "Doe",
"street": "Schulerstraße",
"house_number": "25B",
"city": "Wien",
"postal_code": "1010",
"country": "AT",
"phone": "0684541247"
},
"products": [{"id": "274181",
"ean": "8718475569039",
"sku": "274181",
"name": "vidaXL Cat Tree 182 cm Beige Plush",
"brand": "vidaXL",
"quantity": 0,
"price": 95.99,
"currency": "GBP"
}
]
}

Orders

Get all the paid orders

Authorizations:

ApiKeyAuth

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

{"items": [{"id": "400000024005",
"customer_order_reference": "70000001",
"status": "string",
"creation_date": "2021-04-29T17:32:28Z",
"currency": "GBP",
"totals": {"order": 98.98,
"products": 95.99,
"shipping": 2.99,
"tax": 16.66
},
"shipping_address": {"first_name": "John",
"last_name": "Doe",
"street": "Schulerstraße",
"house_number": "25B",
"city": "Wien",
"postal_code": "1010",
"country": "AT",
"phone": "0684541247"
},
"products": [{"id": "274181",
"ean": "8718475569039",
"sku": "274181",
"name": "vidaXL Cat Tree 182 cm Beige Plush",
"brand": "vidaXL",
"quantity": 0,
"price": 95.99,
"currency": "GBP"
}
],
"tracking": [{"name": "PostNL",
"link": "https://postnl.post/details/?barcodes=123456789"
}
],
"documents_link": "https://b2b.vidaxl.com/api/v2/orders/70000001/documents"
}
],
"pagination": {"total": 25000,
"previous_page": "https://b2b.vidaxl.com/api/v2/...?limit=10&offset=10",
"next_page": "https://b2b.vidaxl.com/api/v2/...?limit=10&offset=30"
}
}

Get a paid order by reference

Authorizations:

ApiKeyAuth

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": {"order": 98.98,
"products": 95.99,
"shipping": 2.99,
"tax": 16.66
},