# BrandLovers Marketplace API V1 API

> BrandLovers Marketplace API V1 API on Apizie: 36 endpoints (Returns all details of a order, Confirm shipment canceletion (when requested by the customer) or failure to deliver, Confirms that a shipment was delivered, Confirm item exchange, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/ecommerce:brandlovers/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `ecommerce:brandlovers`
- Category: E-commerce
- Status: byok
- Source: https://brandlovers.com
- Page: https://zieapi.vercel.app/api/ecommerce/brandlovers
- OpenAPI: https://zieapi.vercel.app/api/ecommerce/brandlovers/openapi.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…

## Endpoints

### Returns all details of a order
`GET https://zieapi.vercel.app/v1/ecommerce:brandlovers/get-order-order-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| orderId | string | yes | Unique Id of this order. |

### Confirm shipment canceletion (when requested by the customer) or failure to deliver
`POST https://zieapi.vercel.app/v1/ecommerce:brandlovers/post-order-order-id-shipment-cancel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| orderId | string | yes | Unique Order Id |
| body | object | yes | JSON request body |

### Confirms that a shipment was delivered
`POST https://zieapi.vercel.app/v1/ecommerce:brandlovers/post-order-order-id-shipment-delivered` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| orderId | string | yes | Unique Order Id |
| body | object | yes | JSON request body |

### Confirm item exchange
`POST https://zieapi.vercel.app/v1/ecommerce:brandlovers/post-order-order-id-shipment-exchange` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| orderId | string | yes | Unique Order Id |
| body | object | yes | JSON request body |

### Confirm order item return and refund
`POST https://zieapi.vercel.app/v1/ecommerce:brandlovers/post-order-order-id-shipment-return` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| orderId | string | yes | Order unique Id |
| body | object | yes | JSON request body |

### Update new order to include shipment information
`POST https://zieapi.vercel.app/v1/ecommerce:brandlovers/post-order-order-id-shipment-sent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| orderId | string | yes | Unique Order Id |
| body | object | yes | JSON request body |

### Returns orders details
`GET https://zieapi.vercel.app/v1/ecommerce:brandlovers/get-orders` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| offset | integer | no | Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to… |
| limit | integer | no | Number or items to return when executing query. Defaults to 10. Use this conjuction with `offset` to paginate across the results. |

### Returns list of shipments
`GET https://zieapi.vercel.app/v1/ecommerce:brandlovers/get-orders-shipments-delivered` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| status | string | no | Query by shippment status. |
| offset | integer | no | Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to… |
| limit | integer | no | Number or items to return when executing query. Defaults to 10. Use this conjuction with `offset` to paginate across the results. |

### Bulk update of order shipments
`POST https://zieapi.vercel.app/v1/ecommerce:brandlovers/post-orders-shipments-delivered` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Returns a list of shipments shipped
`GET https://zieapi.vercel.app/v1/ecommerce:brandlovers/get-orders-shipments-shipped` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| status | string | no | Product status. |
| offset | integer | no | Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to… |
| limit | integer | no | Number or items to return when executing query. Defaults to 10. Use this conjuction with `offset` to paginate across the results. |

### Bulk update of order shipments
`POST https://zieapi.vercel.app/v1/ecommerce:brandlovers/post-orders-shipments-shipped` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Return list of approved orders
`GET https://zieapi.vercel.app/v1/ecommerce:brandlovers/get-orders-status-approved` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| offset | integer | no | Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to… |
| limit | integer | no | Number or items to return when executing query. Defaults to 100, max 200. Use this in conjuction with `offset` to paginate across the… |

### Returns lists of canceled orders
`GET https://zieapi.vercel.app/v1/ecommerce:brandlovers/get-orders-status-canceled` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| offset | integer | no | Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to… |
| limit | integer | no | Number or items to return when executing query. Default 100, max 250. Use this conjuction with `offset` to paginate across the results. |

### Returns a list of orders successfully delivered associated with this seller.
`GET https://zieapi.vercel.app/v1/ecommerce:brandlovers/get-orders-status-delivered` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| offset | integer | no | Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to… |
| limit | integer | no | Number or items to return when executing query. Defaults to 10. Use this conjuction with `offset` to paginate across the results. |

### Returns a list of orders flagged as new.
`GET https://zieapi.vercel.app/v1/ecommerce:brandlovers/get-orders-status-new` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| offset | integer | no | Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to… |
| limit | integer | no | Number or items to return when executing query. Defaults to 100. Max 250. Use this conjuction with `offset` to paginate across the results. |

### Returns a list of partially deliverd orders
`GET https://zieapi.vercel.app/v1/ecommerce:brandlovers/get-orders-status-partially-delivered` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| offset | integer | no | Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to… |
| limit | integer | no | Number or items to return when executing query. Defaults to 100. Max 250. Use this conjuction with `offset` to paginate across the results. |

### Returns a list of orders partially fullfiled
`GET https://zieapi.vercel.app/v1/ecommerce:brandlovers/get-orders-status-partially-sent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| offset | integer | no | Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to… |
| limit | integer | no | Number or items to return when executing query. Defaults to 100. Use this conjuction with `offset` to paginate across the results. |

### Returns a list with orders fully sent
`GET https://zieapi.vercel.app/v1/ecommerce:brandlovers/get-orders-status-sent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| offset | integer | no | Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to… |
| limit | integer | no | Number or items to return when executing query. Defaults to 10. Use this conjuction with `offset` to paginate across the results. |

### Create a new product to the marketplace
`POST https://zieapi.vercel.app/v1/ecommerce:brandlovers/post-product` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Returns details of a single product using the seller `skuSellerId`
`GET https://zieapi.vercel.app/v1/ecommerce:brandlovers/get-product-sku-seller-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| skuSellerId | string | yes | SKU ID do Lojista. |

### Update product details
`POST https://zieapi.vercel.app/v1/ecommerce:brandlovers/put-product-sku-seller-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| skuSellerId | string | yes | Unique Product Id (SKU) in the seller system that will be updated. |
| body | object | yes | JSON request body |

### Allows seller to update prices of a single SKU
`POST https://zieapi.vercel.app/v1/ecommerce:brandlovers/put-product-sku-seller-id-prices` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| skuSellerId | string | yes | Product SKU |
| body | object | yes | JSON request body |

### Enable/disable a single product in the Marketplace
`POST https://zieapi.vercel.app/v1/ecommerce:brandlovers/put-product-sku-seller-id-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| skuSellerId | string | yes | Unique Product Id (SKU) in the seller system |
| body | object | yes | JSON request body |

### Update a single product stock
`POST https://zieapi.vercel.app/v1/ecommerce:brandlovers/put-product-sku-seller-id-stock` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| skuSellerId | string | yes | Unique Product Id (SKU) in the seller system that will be updated |
| body | object | yes | JSON request body |

### Returns a list of products loaded into BrandLovers Marketplace
`GET https://zieapi.vercel.app/v1/ecommerce:brandlovers/get-products` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| offset | integer | no | Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to… |
| limit | integer | no | Number of items to retun. Defaults to 100. Max alowed is 200. Use this conjuction with `offset` to paginate across the results. |

### Allows new products from the seller to be loaded into the marketplace
`POST https://zieapi.vercel.app/v1/ecommerce:brandlovers/post-products` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Allows bulk update of product prices.
`POST https://zieapi.vercel.app/v1/ecommerce:brandlovers/put-products-prices` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Returns seller products status in the marketplace
`GET https://zieapi.vercel.app/v1/ecommerce:brandlovers/get-products-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| offset | integer | no | Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to… |
| limit | integer | no | Number of items to return in this query. Defaults to 250. Maximum 1000. Use this conjuction with `offset` to paginate across the results. |

### Bulk enable/disable products in the marketplace
`POST https://zieapi.vercel.app/v1/ecommerce:brandlovers/put-products-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Returns products that are successfully listed for sale.
`GET https://zieapi.vercel.app/v1/ecommerce:brandlovers/get-products-status-selling` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| offset | integer | no | Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to… |
| limit | integer | no | Number or items to return when executing query. Defaults to 10. Use this conjuction with `offset` to paginate across the results. |

### Bulk product stock update
`POST https://zieapi.vercel.app/v1/ecommerce:brandlovers/put-products-stocks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Creates a new trouble ticket
`POST https://zieapi.vercel.app/v1/ecommerce:brandlovers/post-ticket` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Add new message to trouble ticket
`POST https://zieapi.vercel.app/v1/ecommerce:brandlovers/post-ticket-ticket-id-message` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ticketId | string | yes | Trouble ticket ID. |
| body | object | yes | JSON request body |

### Get trouble ticket messages
`GET https://zieapi.vercel.app/v1/ecommerce:brandlovers/get-ticket-ticket-id-messages` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ticketId | string | yes | Trouble ticket ID. |
| offset | integer | no | Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to… |
| limit | integer | no | Number or items to return when executing query. Defaults to 10. Use this conjuction with `offset` to paginate across the results. |

### Update trouble ticket status
`POST https://zieapi.vercel.app/v1/ecommerce:brandlovers/put-ticket-ticket-id-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ticketId | string | yes | Trouble ticket unique identification |
| body | object | yes | JSON request body |

### Get customers trouble tickets
`GET https://zieapi.vercel.app/v1/ecommerce:brandlovers/get-tickets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| status | string | no | Query by trouble ticket status |
| offset | integer | no | Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to… |
| limit | integer | no | Number or items to return when executing query. Defaults to 10. Use this conjuction with `offset` to paginate across the results. |

## Example
```
curl "https://zieapi.vercel.app/v1/ecommerce:brandlovers/get-order-order-id" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the BrandLovers Marketplace API V1 API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/ecommerce:brandlovers/get-order-order-id with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the BrandLovers Marketplace API V1 API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. BrandLovers Marketplace API V1 itself also needs your own key from brandlovers.com.

### Can AI agents use the BrandLovers Marketplace API V1 API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key ecommerce:brandlovers.

### What is the status of the BrandLovers Marketplace API V1 API?
Needs your own provider key (bring your own key)