APIHub
Back to Explore

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 information. 4) Receive and update customer tickets. All requests consume and return application/json content. All request must be authenticated and use HTTPS.

Shopping
apiKeyHeader
HTTPS
CORS: Unknown
Visit official documentation

Latency

10309ms p95

Uptime

0.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
POST

/products

Allows new products from the seller to be loaded into the marketplace

  • authorization (header, required) — Authorization token. The Authorization token can be found in your Admin console.
PUT

/products/prices

Allows bulk update of product prices.

  • authorization (header, required) — Authorization token. The Authorization token can be found in your Admin console.
GET

/order/{orderId}

Returns all details of a order

  • authorization (header, required) — Authorization token. The Authorization token can be found in your Admin console.
  • orderId (path, required) — Unique Id of this order.
POST

/order/{orderId}/shipment/cancel

Confirm shipment canceletion (when requested by the customer) or failure to deliver

  • authorization (header, required) — Authorization token. The Authorization token can be found in your Admin console.
  • orderId (path, required) — Unique Order Id
POST

/order/{orderId}/shipment/delivered

Confirms that a shipment was delivered

  • authorization (header, required) — Authorization token. The Authorization token can be found in your Admin console.
  • orderId (path, required) — Unique Order Id
POST

/order/{orderId}/shipment/exchange

Confirm item exchange

  • authorization (header, required) — Authorization token. The Authorization token can be found in your Admin console.
  • orderId (path, required) — Unique Order Id
POST

/order/{orderId}/shipment/return

Confirm order item return and refund

  • authorization (header, required) — Authorization token. The Authorization token can be found in your Admin console.
  • orderId (path, required) — Order unique Id
POST

/order/{orderId}/shipment/sent

Update new order to include shipment information

  • authorization (header, required) — Authorization token. The Authorization token can be found in your Admin console.
  • orderId (path, required) — Unique Order Id
GET

/orders

Returns orders details

  • authorization (header, required) — Authorization token. The Authorization token can be found in your Admin console.
  • offset (query, offset) — Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results.
  • limit (query, limit) — Number or items to return when executing query. Defaults to 10. Use this conjuction with `offset` to paginate across the results.
GET

/orders/shipments/delivered

Returns list of shipments

  • authorization (header, required) — Authorization token. The Authorization token can be found in your Admin console.
  • status (query) — Query by shippment status.
  • offset (query, offset) — Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results.
  • limit (query, limit) — Number or items to return when executing query. Defaults to 10. Use this conjuction with `offset` to paginate across the results.
POST

/orders/shipments/delivered

Bulk update of order shipments

  • authorization (header, required) — Authorization token. The Authorization token can be found in your Admin console.
GET

/orders/shipments/shipped

Returns a list of shipments shipped

  • authorization (header, required) — Authorization token. The Authorization token can be found in your Admin console.
  • status (query) — Product status.
  • offset (query, offset) — Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results.
  • limit (query, limit) — Number or items to return when executing query. Defaults to 10. Use this conjuction with `offset` to paginate across the results.
POST

/orders/shipments/shipped

Bulk update of order shipments

GET

/orders/status/approved

Return list of approved orders

  • authorization (header, required) — Authorization token. The Authorization token can be found in your Admin console.
  • offset (query, offset) — Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results.
  • limit (query, limit) — Number or items to return when executing query. Defaults to 100, max 200. Use this in conjuction with `offset` to paginate across the results.
GET

/orders/status/canceled

Returns lists of canceled orders

  • authorization (header, required) — Authorization token. The Authorization token can be found in your Admin console.
  • offset (query, offset) — Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results.
  • limit (query, limit) — Number or items to return when executing query. Default 100, max 250. Use this conjuction with `offset` to paginate across the results.
GET

/orders/status/delivered

Returns a list of orders successfully delivered associated with this seller.

  • authorization (header, required) — Authorization token. The Authorization token can be found in your Admin console.
  • offset (query, offset) — Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results.
  • limit (query, limit) — Number or items to return when executing query. Defaults to 10. Use this conjuction with `offset` to paginate across the results.
GET

/orders/status/new

Returns a list of orders flagged as new.

  • authorization (header, required) — Authorization token. The Authorization token can be found in your Admin console.
  • offset (query, offset) — Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results.
  • limit (query, limit) — Number or items to return when executing query. Defaults to 100. Max 250. Use this conjuction with `offset` to paginate across the results.
GET

/orders/status/partiallyDelivered

Returns a list of partially deliverd orders

  • authorization (header, required) — Authorization token. The Authorization token can be found in your Admin console.
  • offset (query, offset) — Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results.
  • limit (query, limit) — Number or items to return when executing query. Defaults to 100. Max 250. Use this conjuction with `offset` to paginate across the results.
GET

/orders/status/partiallySent

Returns a list of orders partially fullfiled

  • authorization (header, required) — Authorization token. The Authorization token can be found in your Admin console.
  • offset (query, offset) — Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results.
  • limit (query, limit) — Number or items to return when executing query. Defaults to 100. Use this conjuction with `offset` to paginate across the results.
GET

/orders/status/sent

Returns a list with orders fully sent

  • authorization (header, required) — Authorization token. The Authorization token can be found in your Admin console.
  • offset (query, offset) — Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results.
  • limit (query, limit) — Number or items to return when executing query. Defaults to 10. Use this conjuction with `offset` to paginate across the results.
POST

/product

Create a new product to the marketplace

  • authorization (header, required) — Authorization token. The Authorization token can be found in your Admin console.
GET

/product/{skuSellerId}

Returns details of a single product using the seller `skuSellerId`

  • authorization (header, required) — Authorization token. The Authorization token can be found in your Admin console.
  • skuSellerId (path, required) — SKU ID do Lojista.
PUT

/product/{skuSellerId}

Update product details

  • authorization (header, required) — Authorization token. The Authorization token can be found in your Admin console.
  • skuSellerId (path, required) — Unique Product Id (SKU) in the seller system that will be updated.
PUT

/product/{skuSellerId}/prices

Allows seller to update prices of a single SKU

  • authorization (header, required) — Authorization token. The Authorization token can be found in your Admin console.
  • skuSellerId (path, required) — Product SKU
PUT

/product/{skuSellerId}/status

Enable/disable a single product in the Marketplace

  • authorization (header, required) — Authorization token. The Authorization token can be found in your Admin console.
  • skuSellerId (path, required) — Unique Product Id (SKU) in the seller system
PUT

/product/{skuSellerId}/stock

Update a single product stock

  • authorization (header, required) — Authorization token. The Authorization token can be found in your Admin console.
  • skuSellerId (path, required) — Unique Product Id (SKU) in the seller system that will be updated
GET

/products

Returns a list of products loaded into BrandLovers Marketplace

  • authorization (header, required) — Authorization token. The Authorization token can be found in your Admin console.
  • offset (query, offset) — Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results.
  • limit (query, limit) — Number of items to retun. Defaults to 100. Max alowed is 200. Use this conjuction with `offset` to paginate across the results.
GET

/products/status

Returns seller products status in the marketplace

  • authorization (header, required) — Authorization token. The Authorization token can be found in your Admin console.
  • offset (query, offset) — Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results.
  • limit (query, limit) — Number of items to return in this query. Defaults to 250. Maximum 1000. Use this conjuction with `offset` to paginate across the results.
PUT

/products/status

Bulk enable/disable products in the marketplace

  • authorization (header, required) — Authorization token. The Authorization token can be found in your Admin console.
GET

/products/status/selling

Returns products that are successfully listed for sale.

  • authorization (header, required) — Authorization token. The Authorization token can be found in your Admin console.
  • offset (query, offset) — Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results.
  • limit (query, limit) — Number or items to return when executing query. Defaults to 10. Use this conjuction with `offset` to paginate across the results.
PUT

/products/stocks

Bulk product stock update

  • authorization (header, required) — Authorization token. The Authorization token can be found in your Admin console.
POST

/ticket

Creates a new trouble ticket

  • authorization (header, required) — Authorization token. The Authorization token can be found in your Admin console.
POST

/ticket/{ticketId}/message

Add new message to trouble ticket

  • authorization (header, required) — Authorization token. The Authorization token can be found in your Admin console.
  • ticketId (path, required) — Trouble ticket ID.
GET

/ticket/{ticketId}/messages

Get trouble ticket messages

  • authorization (header, required) — Authorization token. The Authorization token can be found in your Admin console.
  • ticketId (path, required) — Trouble ticket ID.
  • offset (query, offset) — Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results.
  • limit (query, limit) — Number or items to return when executing query. Defaults to 10. Use this conjuction with `offset` to paginate across the results.
PUT

/ticket/{ticketId}/status

Update trouble ticket status

  • authorization (header, required) — Authorization token. The Authorization token can be found in your Admin console.
  • ticketId (path, required) — Trouble ticket unique identification
GET

/tickets

Get customers trouble tickets

  • authorization (header, required) — Authorization token. The Authorization token can be found in your Admin console.
  • status (query) — Query by trouble ticket status
  • offset (query, offset) — Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results.
  • limit (query, limit) — Number or items to return when executing query. Defaults to 10. Use this conjuction with `offset` to paginate across the results.

36 endpoints auto-detected

Authentication

This API uses an API key, passed in the "authorization" header. No OAuth required.

curl -X POST \
  "https://api.brandlovers.com/marketplace/v1/products" \
  -H "authorization: YOUR_API_KEY"

api.brandlovers.com · HTTPS only