← Back to catalog

E-commerce

BrandLovers Marketplace API V1

auto-generated
swirls add brandlovers
actionPOSTv1.0.0

Add new message to trouble ticket

Add a new message to this trouble ticket. Messages can be `CUSTOMER` (customer will be able to see it) or `INTERNAL`.

Source
actionPOSTv1.0.0

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

This 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 server will load each product as an individual item that can be manipulated using your own `skuSellerId`. All requests to This endpoint are idenpontent with respect of the `skuSellerId`, this means that once a `skuSellerId` is created it cannot be re-created using this tool. In order to update use the PUT method with the correct `skuSellerId`. You can also use the POST /product to create a single product per request

Source
actionPUTv1.0.0

Allows seller to update prices of a single SKU

Allows 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 dollar should be informed as 100. Same as $1,2345.67 must be informed solely as 1234567

Source
actionPOSTv1.0.0

Confirm item exchange

This enpoint to confirm item exchange when failure to deliver or requested by the customer. All customer requests are tracket via trouble tickets

Source
actionPOSTv1.0.0

Confirm order item return and refund

Use this endpoint to return and refund items froma a order. In order to fully return an order list all items and applicate quantity.

Source
actionPOSTv1.0.0

Confirms that a shipment was delivered

Confirms that a shipment was delivered. Must inform quantity of successfully deliverd items even if items deliverd was less than the original order

Source
actionPOSTv1.0.0

Create a new product to the marketplace

Use 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 products in a single API call use POST /products method. The server will load each product as an individual item that can be manipulated using your own `skuSellerId`. This system is idenpontent, this means that once a `skuSellerId` is created it cannot be re-created using this tool. In order to update, edit a product use the PUT method with the correct reference to your `skuSellerId`

Source
actionPOSTv1.0.0

Creates a new trouble ticket

Use this service to create a new trouble ticket. Use this to include relevant information about the order, comunicate with the customer or marketplace team. Whenever possible message will be pushed to Mobile first. This is the primary mean of comunicaiton with the customer regarding orders, shippments, shippments status. New tickets will be automatically be set to 'OPEN'. Trouble tickets need to be associated with a orderId or customer. New tickets can optionally include a new message.

Source
actionGETv1.0.0

Get customers trouble tickets

Allows seller to receive and status, queries, requests and complaints from customers. As well related messages

Source
actionGETv1.0.0

Get trouble ticket messages

Returns trouble ticket history with all messages exchanged. Only tickets related to your seller will be returned. Attempt to read other tickets will return 403 (acess denied).

Source
actionGETv1.0.0

Return list of approved orders

Returns a list of approved orders. Orders in the `approved` state must be fullfiled imediadetelly.

Source
actionGETv1.0.0

Returns a list of orders partially fullfiled

Returns 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 this service to track orders that need to be fullfiled.

Source
actionGETv1.0.0

Returns a list of partially deliverd orders

Returns a list of partially deliverd orders. This is a list of orders with items shipped but with not all items ackwlodged as deliverd

Source
actionGETv1.0.0

Returns a list of shipments shipped

Returns a list of shipments shipped. By Default returns items ordered by dateCreated folowed by last update

Source
actionGETv1.0.0

Returns a list with orders fully sent

Returns a list with orders completely fullfiled, this means orders with all items sent. Orders will ordered by dateCreated fowllowed by last update

Source
actionGETv1.0.0

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

Returns detailed information of a single product with the seller `skuSellerId`. This service will return a json document with product detail, status, price, invetory among other infomarion availble in the Brand Lovers marketplace

Source
actionGETv1.0.0

Returns list of shipments

Returns list of shipments. By default this will return list of the last shipments ordered by dateCreated, folowed by last update date.

Source
actionGETv1.0.0

Returns orders details

Retuns a list of orders associated with this seller. The list is ordered by dateCreated.

Source
actionGETv1.0.0

Returns seller products status in the marketplace

Returns 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 please note that this endpoint will return 250 products per call. For full details of a given procuct use GET /product/{skuSellerId}

Source
actionPUTv1.0.0

Update a single product stock

Update a single product inventory information. Products with zero stock will not be eligible for sale.

Source
actionPOSTv1.0.0

Update new order to include shipment information

Updates 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 inform that all items of a order where shipped list all of them, including applicable quantities in the payload.

Source
actionPUTv1.0.0

Update product details

Update a single product information such as name, brand, attribute, dimension, etc. Please note that data from your request will be merged with existing data. This allows you to easliy update only certain fields without the need to re-inform the other unchanged fields. For example in order to update just the field `title` simply send just this field with new information, remaining fields will not be changed. In order to erase an item the field must be informed as its default value, for example in order to erase the `videos` field must be sent as videos:[]. The `skuSellerId` field is always mandatory in the path and in the product json Object.

Source
Beyond the catalog

Any provider, on request.

01

Request it

Tell us which provider you need, and we will ship it in the registry.

02

Generate it

Point swirls add at an OpenAPI or GraphQL spec. Typed actions for any API you hold credentials for, today.

acme · integrations
terminal
~/acme $swirls add linear
✓ 12 typed actions · scopes and schemas included
 
~/acme $swirls add https://api.acme.dev/openapi.json
◆ Fetched spec · 38 operations
✓ 6 typed actions · generated from spec