Brandlovers

BrandLovers Marketplace API V1

Allows sellers to: 1) Load products definitions to the BrandLovers marktplace. 2) Receive and update orders status. 3) Receive and update shipping…

E-commerce#openapi#ecommerce

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Allows sellers to: 1) Load products definitions to the BrandLovers marktplace. 2) Receive and update orders status. 3) Receive and update shipping information. 4) Receive and update customer tickets. All requests consume and return application/json content. All request must be authenticated and use HTTPS.

Endpoints 36

products

  • PUTUpdate product details/product/:skuSellerIdUpdate a single product information such as name, brand, attribute, dimension, etc. Please note that data from your request will be merged with existing data.…
  • GETReturns a list of products loaded into BrandLovers Marketplace/products?offset=0&limit=0Get a list of my products loaded into the Marketplace. This dosen't means that products are eligible for sale, just that they are loaded in the database.
  • POSTAllows new products from the seller to be loaded into the marketplace/productsThis enpoint to creates new products in the Marketplace using skuSellerId as a primary key. This enpoint expects a json document with array of products. The…
  • PUTAllows bulk update of product prices./products/pricesAllows bulk update of product prices. This endpoint expects a json document with an array of products with the skuSellerId and the new price. Server will…
  • GETReturns seller products status in the marketplace/products/status?offset=0&limit=0Returns a list with seller products status. Please note that this endpoint will not return all details of each product, just the skuSellerId and status. Also…
  • PUTBulk enable/disable products in the marketplace/products/statusBulk enable/disable products in the marketplace. This endpoint requires an array of objects with the seller SKU skuSellerId and boolean value that defines if…
  • GETReturns products that are successfully listed for sale./products/status/selling?offset=0&limit=0Returns products that are successfully listed for sale.
  • PUTBulk product stock update/products/stocksBulk product stock update. This endpoint expect a array of products skuSellerId with new inventory data

product

  • POSTCreate a new product to the marketplace/productUse this enpoint to create a single new product to the Marketplace. This enpoint expects a json document with one product. If you whant to upload multiple…
  • GETReturns details of a single product using the seller `skuSellerId`/product/:skuSellerIdReturns detailed information of a single product with the seller skuSellerId. This service will return a json document with product detail, status, price,…
  • PUTAllows seller to update prices of a single SKU/product/:skuSellerId/pricesAllows seller to set the SKU prices (MSRP and/or offer price). All prices must be informed in cents. No commas or periods are accepeted. For example one…
  • PUTEnable/disable a single product in the Marketplace/product/:skuSellerId/statusUpdate product status in the Marketplace. Set to true to enable, false to disable sale.
  • PUTUpdate a single product stock/product/:skuSellerId/stockUpdate a single product inventory information. Products with zero stock will not be eligible for sale.

orders

  • GETReturns orders details/orders?offset=0&limit=0Retuns a list of orders associated with this seller. The list is ordered by dateCreated.
  • GETReturns list of shipments/orders/shipments/delivered?status=string&offset=0&limit=0Returns list of shipments. By default this will return list of the last shipments ordered by dateCreated, folowed by last update date.
  • POSTBulk update of order shipments/orders/shipments/deliveredBulk update of order shipments status. This alows to inform multiple shipments status
  • GETReturns a list of shipments shipped/orders/shipments/shipped?status=NEW&offset=0&limit=0Returns a list of shipments shipped. By Default returns items ordered by dateCreated folowed by last update
  • POSTBulk update of order shipments/orders/shipments/shippedAllows bulk updates of orders shippments.
  • GETReturn list of approved orders/orders/status/approved?offset=0&limit=0Returns a list of approved orders. Orders in the approved state must be fullfiled imediadetelly.
  • GETReturns lists of canceled orders/orders/status/canceled?offset=0&limit=100Returns a list with canceled orders. Canceled orders should not be fullfiled.
  • GETReturns a list of orders successfully delivered associated with this seller./orders/status/delivered?offset=0&limit=0Returns a list of orders successfully delivered associated with this seller.
  • GETReturns a list of orders flagged as new./orders/status/new?offset=0&limit=100Returns a list of orders flagged as new. New orders should not be fullfiled until marketplace flags them as approved.
  • GETReturns a list of partially deliverd orders/orders/status/partiallyDelivered?offset=0&limit=100Returns a list of partially deliverd orders. This is a list of orders with items shipped but with not all items ackwlodged as deliverd
  • GETReturns a list of orders partially fullfiled/orders/status/partiallySent?offset=0&limit=0Returns a list of orders that contain one (or more) items that where not shipped. This will list the entire order as well the items with peding shipment. Use…
  • GETReturns a list with orders fully sent/orders/status/sent?offset=0&limit=0Returns a list with orders completely fullfiled, this means orders with all items sent. Orders will ordered by dateCreated fowllowed by last update

order

  • GETReturns all details of a order/order/:orderIdReturns all details of a single order, including last status, items shipped or not.
  • POSTConfirm shipment canceletion (when requested by the customer) or failure to deliver/order/:orderId/shipment/cancelConfirm shipment canceletion (when requested by the customer) or failure to deliver one shipment
  • POSTConfirms that a shipment was delivered/order/:orderId/shipment/deliveredConfirms that a shipment was delivered. Must inform quantity of successfully deliverd items even if items deliverd was less than the original order
  • POSTConfirm item exchange/order/:orderId/shipment/exchangeThis enpoint to confirm item exchange when failure to deliver or requested by the customer. All customer requests are tracket via trouble tickets
  • POSTConfirm order item return and refund/order/:orderId/shipment/returnUse this endpoint to return and refund items froma a order. In order to fully return an order list all items and applicate quantity.
  • POSTUpdate new order to include shipment information/order/:orderId/shipment/sentUpdates order to include shipment shiped information. This endpoint can be used to include a single or multiple shipments for any give order. In order to…

tickets

  • POSTCreates a new trouble ticket/ticketUse this service to create a new trouble ticket. Use this to include relevant information about the order, comunicate with the customer or marketplace team.…
  • POSTAdd new message to trouble ticket/ticket/:ticketId/messageAdd a new message to this trouble ticket. Messages can be CUSTOMER (customer will be able to see it) or INTERNAL.
  • GETGet trouble ticket messages/ticket/:ticketId/messages?offset=0&limit=0Returns trouble ticket history with all messages exchanged. Only tickets related to your seller will be returned. Attempt to read other tickets will return…
  • PUTUpdate trouble ticket status/ticket/:ticketId/statusAlows the seller to update the status of a trouble ticket
  • GETGet customers trouble tickets/tickets?status=OPEN&offset=0&limit=0Allows seller to receive and status, queries, requests and complaints from customers. As well related messages

API details

Base URL
https://api.brandlovers.com/marketplace/v1
Authentication
An API key in the authorization header
Operations
36 operations on 31 pathsGET 17POST 11PUT 8
Main resources
orders 12products 8order 6product 5tickets 5
Response formats
application/json
Description format
Swagger 2.0, API version 1.0.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the BrandLovers Marketplace API V1 in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the BrandLovers Marketplace API V1 collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Update product details” (PUT /product/:skuSellerId), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the BrandLovers Marketplace API V1?

Allows sellers to: 1) Load products definitions to the BrandLovers marktplace. 2) Receive and update orders status. 3) Receive and update shipping… It is listed under E-commerce and has 36 endpoints.

Who publishes the BrandLovers Marketplace API V1?

It is listed from Brandlovers's public API description (an OpenAPI document), not published by Brandlovers on Swastik Codes. Anyone who controls brandlovers.com can claim the profile by adding a DNS TXT record.

What is the base URL of the BrandLovers Marketplace API V1?

Requests go to https://api.brandlovers.com/marketplace/v1. Endpoint paths are added to this base URL.

How do I authenticate with the BrandLovers Marketplace API V1?

With an API key in the authorization header.

How many endpoints does the BrandLovers Marketplace API V1 have?

36 operations on 31 paths (17 GET, 11 POST, 8 PUT). The largest groups are orders, products, order, product.

Is forking the BrandLovers Marketplace API V1 free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.