Skip to main content

Run Free Vendor Product Import API

Jeremy avatar
Written by Jeremy
Updated over 3 weeks ago

The Run Free Vendor Product Import API allows brands to push product data (images, sizes, UPCs, inventory, etc.) into the Run Free platform. This enables participating stores to show brand inventory online or in-store when a size is out of stock locally.


Authentication

All API requests require a Run Free - issued secret key passed in the Authorization header as a Bearer token:

Authorization: Bearer YOUR_RUNFREE_SECRET_KEY

Base URL

https://dropship.runfreeproject.com/api/vendor

Submit Product

POST /api/vendor

Upload a product with its details and current inventory.

Headers

Content-Type: application/json  
Authorization: Bearer YOUR_RUNFREE_SECRET_KEY

Example Body

{
"sku": "ZOOT-123",
"name": "Zoot Suit",
"color": "Yellow",
"description": "Be the coolest cat on Jazz Street with this quality handmade Kazakhstani Zoot Suit.",
"price": 999.99,
"gender": "M",
"size": "L",
"width": "",
"upc": "ZOOT123-UPC34",
"qty": 22,
"image1": "https://m.media-amazon.com/images/I/616sMXavI8L._AC_SX679_.jpg",
"image2": "https://di2ponv0v5otw.cloudfront.net/posts/2021/10/31/617f02927f80d26d6987169e/m_617f02927f80d26d6987169f.jpg",
"image3": "https://di2ponv0v5otw.cloudfront.net/posts/2021/10/31/617f02927f80d26d6987169e/m_617f02937f80d26d698716aa.jpg"
}

Success Response

{
"success": true
}

Retrieve Product by SKU

GET /api/vendor/{SKU}

Retrieve full product information and inventory using its SKU.

Example

GET https://dropship.runfreeproject.com/api/vendor/ZOOT-123

Headers

Authorization: Bearer YOUR_RUNFREE_SECRET_KEY

Success Response

{
"sku": "ZOOT-123",
"name": "Zoot Suit",
"color": "Yellow",
"description": "Be the coolest cat on Jazz Street with this quality handmade Kazakhstani Zoot Suit.",
"price": 999.99,
"gender": "M",
"images": [
"/assets/products/68023-d_616sMXavI8L._AC_SX679_.jpg",
"/assets/products/68023-d_m_617f02927f80d26d6987169f.jpg",
"/assets/products/68023-d_m_617f02937f80d26d698716aa.jpg"
],
"inventory": [
{
"upc": "ZOOT123-UPC34",
"size": "L",
"width": "",
"quantity": 22
},
{
"upc": "ZOOT123-UPC31",
"size": "S",
"width": "",
"quantity": 22
},
{
"upc": "ZOOT123-UPC3S",
"size": "M",
"width": "",
"quantity": 22
}
]
}

Error Format

All errors return a 200 OK status with a JSON error message.

Example

{
"error": "Invalid authentication token"
}

Common Errors

  • Missing required field: sku

  • Invalid authentication token

  • Product not found

  • Internal server error

Did this answer your question?