API: Product Feed

This API is to be used by you to add new products and variants to The Range Marketplace or update existing products and variants on The Range Marketplace. You are required to provide a list of products to import. You are also expected to have made a request to the authenticate API beforehand to have successfully logged in, and to provide the session cookie given in the authenticate response in the request to this API.

Parameters

Name	Notes
supplier_id	(required) your id, passed to you from the authenticate api, to confirm who you are.
product_arr	(required) list of products to import.

Example Request

https://supplier.rstore.com/rest/product_feed.api?supplier_id=1

With JSON Content:
{
"product_arr":[
{
"vendor_sku":"ABC 123",
"related_product":"M1234567" ,#Optional- will generate own unique product code if not provided
"title":"Test Shoe", # Title limited to maximum of 80 characters
"brand":"The Range",
"gtin":"12345678901", #Optional
"price_arr":[
{
"price":"49.50", #No currency symbol expected
"currency":"GBP", #Not supporting other currencies currently
"effective_from":"2019-05-10" #Current or future price changes
}
],
"product_category":"Shoes" ,#Must be category you applied to
"description":"A Shoe Test" ,#We allow for HTML - excluding script/embed/iframe tags
"feature_arr":[  #Optional not to be confused with attributes
"Includes Sole",
"Prevents falling over",
"Waterproof"
],
"child_hazard":0,  #Optional
"age_restriction":"16" ,  #Optional
"image_url_arr":[
"https://www.therange.co.uk/example1.jpg",
"https://www.therange.co.uk/example2.jpg",
"https://www.therange.co.uk/example3.jpg"
],
"youtube_url_arr":[
"https://www.youtube.com/watch?v=Zhr1uk_O-so",
"https://www.youtube.com/watch?v=Zhr1uk_O-so"
],
"fulfilment_class":"Small",  #Our supported size classes Small/Regular/Fragile/Medium/Large/Extra Large)
"product_attribute":{  #Optional
"colour":"#8B4513",  #Only required if colour_name present
"colour_name":"Saddle Brown",
"colour_group":"Brown",
"length":"1m",
"width":"5mm",
"height":"10cm",
"weight":"9kg",
#Attributes depends on category
"other_attribute":{  #Optional list
"ATTR_NAME":"ATTR_VALUE",
"ATTR_NAME":"ATTR_VALUE"
}
},
"launch_date":"2019-05-30", #Optional when the SKU will automatically be activated (if completed the onboarding process)
"active": 1,  #Optional only to be used once the product is already Live, allows it to be deactivated/discontinued (still visible but not saleable), or later be re-activated
"visible": 1  #Optional only to be used once the product is already Live, allows it to be hidden from the website
}
]
}

Amend price
{
"product_arr":[
{
"vendor_sku":"ABC 123",
"price_arr":[
{
"price":"999.99",
"currency":"GBP",
"effective_from":"2099-12-01" #date must be in the future
}
]
},
{
"vendor_sku":"DEF 456",
"price_arr":[
{
"price":"999.99",
"currency":"GBP",
"effective_from":"2099-12-01" #date must be in the future
}
]
}
]

With Cookie Header:

Cookie: "ksi=abcdefghijklmnopqrstuvwxyz123"

Responses

On Success:

{"result":[{"label": "product_feed", "sku_list":"ABC 123"}]}

On Missing Cookie, or Not Logged In:

HTTP/1.0 401 Not Authenticated
User not authenticated

On Missing/Incorrect Supplier Param:

HTTP/1.0 400 Invalid Request
User not authorised to send product feeds for this supplier

On Invalid JSON (missing product_arr):

HTTP/1.0 400 Invalid Request
Invalid JSON provided

On Invalid JSON (missing vendor_sku) – similar to other missing required fields:

HTTP/1.0 400 Invalid Request Invalid JSON: No Vendor SKU found for this product

On Invalid JSON (exceeds product title character limit):

HTTP/1.0 400 Invalid Request Invalid JSON: Title for this product exceeds 80 character limit