{"@context": "https://schema.org", "@type": "WebAPI", "name": "BrandLovers Marketplace API V1 API", "description": "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 ", "provider": {"@type": "Organization", "name": "brandlovers.com"}, "documentation": "https://raw.githubusercontent.com/brandlovers/marketplace-api-documentation/master/brandlovers-marketplace-api-v1.json"}
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
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://api.brandlovers.com/marketplace/v1
auth: a p i k e y
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
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.
| method | path | what the vendor says it does |
|---|---|---|
GET | /order/{orderId} | Returns all details of a order Returns all details of a single order, including last status, items shipped or |
POST | /order/{orderId}/shipment/cancel | Confirm shipment canceletion (when requested by the customer) or failure to deliver Confirm shipment canceleti |
POST | /order/{orderId}/shipment/delivered | Confirms that a shipment was delivered Confirms that a shipment was delivered. Must inform quantity of success |
POST | /order/{orderId}/shipment/exchange | Confirm item exchange This enpoint to confirm item exchange when failure to deliver or requested by the custom |
POST | /order/{orderId}/shipment/return | Confirm order item return and refund Use this endpoint to return and refund items froma a order. In order to f |
POST | /order/{orderId}/shipment/sent | Update new order to include shipment information Updates order to include shipment shiped information. This en |
GET | /orders | Returns orders details Retuns a list of orders associated with this seller. The list is ordered by dateCreated |
GET | /orders/shipments/delivered | Returns list of shipments Returns list of shipments. By default this will return list of the last shipments or |
POST | /orders/shipments/delivered | Bulk update of order shipments Bulk update of order shipments status. This alows to inform multiple shipments |
GET | /orders/shipments/shipped | Returns a list of shipments shipped Returns a list of shipments shipped. By Default returns items ordered by d |
POST | /orders/shipments/shipped | Bulk update of order shipments Allows bulk updates of orders shippments. orders |
GET | /orders/status/approved | Return list of approved orders Returns a list of approved orders. Orders in the `approved` state must be fullf |
GET | /orders/status/canceled | Returns lists of canceled orders Returns a list with canceled orders. Canceled orders should not be fullfiled. |
GET | /orders/status/delivered | Returns a list of orders successfully delivered associated with this seller. Returns a list of orders successf |
GET | /orders/status/new | Returns a list of orders flagged as new. Returns a list of orders flagged as new. New orders should not be ful |
GET | /orders/status/partiallyDelivered | Returns a list of partially deliverd orders Returns a list of partially deliverd orders. This is a list of ord |
GET | /orders/status/partiallySent | Returns a list of orders partially fullfiled Returns a list of orders that contain one (or more) items that wh |
GET | /orders/status/sent | Returns a list with orders fully sent Returns a list with orders completely fullfiled, this means orders with |
POST | /product | Create a new product to the marketplace Use this enpoint to create a single new product to the Marketplace. Th |
GET | /product/{skuSellerId} | Returns details of a single product using the seller `skuSellerId` Returns detailed information of a single pr |
PUT | /product/{skuSellerId} | Update product details Update a single product information such as name, brand, attribute, dimension, etc. Ple |
PUT | /product/{skuSellerId}/prices | Allows seller to update prices of a single SKU Allows seller to set the SKU prices (MSRP and/or offer price). |
PUT | /product/{skuSellerId}/status | Enable/disable a single product in the Marketplace Update product status in the Marketplace. Set to `true` to |
PUT | /product/{skuSellerId}/stock | Update a single product stock Update a single product inventory information. Products with zero stock will not |
GET | /products | Returns a list of products loaded into BrandLovers Marketplace Get a list of my products loaded into the Marke |
POST | /products | Allows new products from the seller to be loaded into the marketplace This enpoint to creates new products in |
PUT | /products/prices | Allows bulk update of product prices. Allows bulk update of product prices. This endpoint expects a json docum |
GET | /products/status | Returns seller products status in the marketplace Returns a list with seller products status. Please note that |
PUT | /products/status | Bulk enable/disable products in the marketplace Bulk enable/disable products in the marketplace. This endpoint |
GET | /products/status/selling | Returns products that are successfully listed for sale. Returns products that are successfully listed for sale |
PUT | /products/stocks | Bulk product stock update Bulk product stock update. This endpoint expect a array of products `skuSellerId` wi |
POST | /ticket | Creates a new trouble ticket Use this service to create a new trouble ticket. Use this to include relevant inf |
POST | /ticket/{ticketId}/message | Add new message to trouble ticket Add a new message to this trouble ticket. Messages can be `CUSTOMER` (custom |
GET | /ticket/{ticketId}/messages | Get trouble ticket messages Returns trouble ticket history with all messages exchanged. Only tickets related t |
PUT | /ticket/{ticketId}/status | Update trouble ticket status Alows the seller to update the status of a trouble ticket tickets |
GET | /tickets | Get customers trouble tickets Allows seller to receive and status, queries, requests and complaints from custo |
specification origin: https://raw.githubusercontent.com/brandlovers/marketplace-api-documentation/master/brandlo
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.