Loading...
Cross shared collection | Cenit Admin

Basic info

Title
BrandLovers Marketplace API V1 1.0.0
Image
Thumb brand lovers marketplace api v1 1 0 0 logo
Name
brand_lovers_marketplace_api_v1_1_0_0
Tags
Summary
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.
Readme

These collection have been automatically generated from a swagger specification

API specs supplied by Image title

Categories
IdTitleDescriptionUpdated at
backendBackendDatabase and server-side technologiesDecember 01, 2016 17:06
ecommerceeCommerceFacilitation of trading in products or services using computer networksDecember 01, 2016 17:06
2 Categories
Authors
Name
Cenit Team
1 Cross collection authors
Pull count
1
Id
57b1ee7ead9815587a0003bb
Created at
August 15, 2016 16:31
Updated at
December 02, 2016 13:37

Compute

Snippets
NamespaceNameTypeDescriptionUpdated at
BrandLovers Marketplace API V1 1.0.0Address.jsonAuto detect - -
BrandLovers Marketplace API V1 1.0.0ControlledStock.jsonAuto detect - -
BrandLovers Marketplace API V1 1.0.0Courier.jsonAuto detect - -
BrandLovers Marketplace API V1 1.0.0Customer.jsonAuto detect - -
BrandLovers Marketplace API V1 1.0.0CustomerReference.jsonAuto detect - -
BrandLovers Marketplace API V1 1.0.0Dimensions.jsonAuto detect - -
BrandLovers Marketplace API V1 1.0.0Error.jsonAuto detect - -
BrandLovers Marketplace API V1 1.0.0Freight.jsonAuto detect - -
BrandLovers Marketplace API V1 1.0.0GetOrders.jsonAuto detect - -
BrandLovers Marketplace API V1 1.0.0GetOrdersShipments.jsonAuto detect - -
BrandLovers Marketplace API V1 1.0.0GetProduct.jsonAuto detect - -
BrandLovers Marketplace API V1 1.0.0GetProductsResponse.jsonAuto detect - -
BrandLovers Marketplace API V1 1.0.0GetProductsStatusSelling.jsonAuto detect - -
BrandLovers Marketplace API V1 1.0.0GetSellerProductStatus.jsonAuto detect - -
BrandLovers Marketplace API V1 1.0.0GetSellerProductsStatus.jsonAuto detect - -
BrandLovers Marketplace API V1 1.0.0GetTicketMessages.jsonAuto detect - -
BrandLovers Marketplace API V1 1.0.0GetTickets.jsonAuto detect - -
BrandLovers Marketplace API V1 1.0.0GiftCard.jsonAuto detect - -
BrandLovers Marketplace API V1 1.0.0GiftWrap.jsonAuto detect - -
BrandLovers Marketplace API V1 1.0.0Image.jsonAuto detect - -
BrandLovers Marketplace API V1 1.0.0Invoice.jsonAuto detect - -
BrandLovers Marketplace API V1 1.0.0Metadata.jsonAuto detect - -
BrandLovers Marketplace API V1 1.0.0NewTicket.jsonAuto detect - -
BrandLovers Marketplace API V1 1.0.0NewTicketMessage.jsonAuto detect - -
BrandLovers Marketplace API V1 1.0.0NewTrackingRefund.jsonAuto detect - -
BrandLovers Marketplace API V1 1.0.0Newshipmentstatus.jsonAuto detect - -
BrandLovers Marketplace API V1 1.0.0Order.jsonAuto detect - -
BrandLovers Marketplace API V1 1.0.0OrderGiftWrap.jsonAuto detect - -
BrandLovers Marketplace API V1 1.0.0OrderItem.jsonAuto detect - -
BrandLovers Marketplace API V1 1.0.0OrderItemReference.jsonAuto detect - -
BrandLovers Marketplace API V1 1.0.0OrderShippment.jsonAuto detect - -
BrandLovers Marketplace API V1 1.0.0OrderShippmentStatus.jsonAuto detect - -
BrandLovers Marketplace API V1 1.0.0OrdersShipments.jsonAuto detect - -
BrandLovers Marketplace API V1 1.0.0Phone.jsonAuto detect - -
BrandLovers Marketplace API V1 1.0.0Product.jsonAuto detect - -
52 Snippets (showing 35)

Connectors

Connections
NamespaceNameUrlKeyTokenAuthorizationUpdated at
BrandLovers Marketplace API V1 1.0.0Connectionhttps://api.brandlovers.com/marketplace/v1 -
1 Connections
Webhooks
NamespaceNamePathMethodDescriptionAuthorizationUpdated at
BrandLovers Marketplace API V1 1.0.0GET Order {orderid}/order/{{orderId}}getReturns all details of a single order, including last status, items shipped or not. -
BrandLovers Marketplace API V1 1.0.0POST Order {orderid} Shipment Cancel/order/{{orderId}}/shipment/cancelpostConfirm shipment canceletion (when requested by the customer) or failure to deliver one shipment -
BrandLovers Marketplace API V1 1.0.0POST Order {orderid} Shipment Delivered/order/{{orderId}}/shipment/deliveredpostConfirms that a shipment was delivered. Must inform quantity of successfully deliverd items even if items deliverd was less than the original order -
BrandLovers Marketplace API V1 1.0.0POST Order {orderid} Shipment Exchange/order/{{orderId}}/shipment/exchangepostThis enpoint to confirm item exchange when failure to deliver or requested by the customer. All customer requests are tracket via trouble tickets -
BrandLovers Marketplace API V1 1.0.0POST Order {orderid} Shipment Return/order/{{orderId}}/shipment/returnpostUse this endpoint to return and refund items froma a order. In order to fully return an order list all items and applicate quantity. -
BrandLovers Marketplace API V1 1.0.0POST Order {orderid} Shipment Sent/order/{{orderId}}/shipment/sentpostUpdates 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. -
BrandLovers Marketplace API V1 1.0.0GET Orders/ordersgetRetuns a list of orders associated with this seller. The list is ordered by dateCreated. -
BrandLovers Marketplace API V1 1.0.0GET Orders Shipments Delivered/orders/shipments/deliveredgetReturns list of shipments. By default this will return list of the last shipments ordered by dateCreated, folowed by last update date. -
BrandLovers Marketplace API V1 1.0.0POST Orders Shipments Delivered/orders/shipments/deliveredpostBulk update of order shipments status. This alows to inform multiple shipments status -
BrandLovers Marketplace API V1 1.0.0GET Orders Shipments Shipped/orders/shipments/shippedgetReturns a list of shipments shipped. By Default returns items ordered by dateCreated folowed by last update -
BrandLovers Marketplace API V1 1.0.0POST Orders Shipments Shipped/orders/shipments/shippedpostAllows bulk updates of orders shippments. -
BrandLovers Marketplace API V1 1.0.0GET Orders Status Approved/orders/status/approvedgetReturns a list of approved orders. Orders in the `approved` state must be fullfiled imediadetelly. -
BrandLovers Marketplace API V1 1.0.0GET Orders Status Canceled/orders/status/canceledgetReturns a list with canceled orders. Canceled orders should not be fullfiled. -
BrandLovers Marketplace API V1 1.0.0GET Orders Status Delivered/orders/status/deliveredgetReturns a list of orders successfully delivered associated with this seller. -
BrandLovers Marketplace API V1 1.0.0GET Orders Status New/orders/status/newgetReturns a list of orders flagged as new. New orders should not be fullfiled until marketplace flags them as approved. -
BrandLovers Marketplace API V1 1.0.0GET Orders Status Partiallydelivered/orders/status/partiallyDeliveredgetReturns a list of partially deliverd orders. This is a list of orders with items shipped but with not all items ackwlodged as deliverd -
BrandLovers Marketplace API V1 1.0.0GET Orders Status Partiallysent/orders/status/partiallySentgetReturns 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. -
BrandLovers Marketplace API V1 1.0.0GET Orders Status Sent/orders/status/sentgetReturns a list with orders completely fullfiled, this means orders with all items sent. Orders will ordered by dateCreated fowllowed by last update -
BrandLovers Marketplace API V1 1.0.0POST Product/productpostUse 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` -
BrandLovers Marketplace API V1 1.0.0GET Product {skusellerid}/product/{{skuSellerId}}getReturns 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 -
BrandLovers Marketplace API V1 1.0.0PUT Product {skusellerid}/product/{{skuSellerId}}putUpdate 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. -
BrandLovers Marketplace API V1 1.0.0PUT Product {skusellerid} Prices/product/{{skuSellerId}}/pricesputAllows 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 -
BrandLovers Marketplace API V1 1.0.0PUT Product {skusellerid} Status/product/{{skuSellerId}}/statusputUpdate product status in the Marketplace. Set to `true` to enable, `false` to disable sale. -
BrandLovers Marketplace API V1 1.0.0PUT Product {skusellerid} Stock/product/{{skuSellerId}}/stockputUpdate a single product inventory information. Products with zero stock will not be eligible for sale. -
BrandLovers Marketplace API V1 1.0.0GET Products/productsgetGet 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. -
BrandLovers Marketplace API V1 1.0.0POST Products/productspostThis 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 -
BrandLovers Marketplace API V1 1.0.0PUT Products Prices/products/pricesputAllows 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 process each new product update individually and will ackwlodge as much updates as possible, even if a single product update fails. After this request you can query product final status with GET /product/status -
BrandLovers Marketplace API V1 1.0.0GET Products Status/products/statusgetReturns 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} -
BrandLovers Marketplace API V1 1.0.0PUT Products Status/products/statusputBulk enable/disable products in the marketplace. This endpoint requires an array of objects with the seller SKU `skuSellerId` and boolean value that defines if the product is enabled or not for sale. This endpoint can be used to set a single product or many products. -
BrandLovers Marketplace API V1 1.0.0GET Products Status Selling/products/status/sellinggetReturns products that are successfully listed for sale. -
BrandLovers Marketplace API V1 1.0.0PUT Products Stocks/products/stocksputBulk product stock update. This endpoint expect a array of products `skuSellerId` with new inventory data -
BrandLovers Marketplace API V1 1.0.0POST Ticket/ticketpostUse 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. -
BrandLovers Marketplace API V1 1.0.0POST Ticket {ticketid} Message/ticket/{{ticketId}}/messagepostAdd a new message to this trouble ticket. Messages can be `CUSTOMER` (customer will be able to see it) or `INTERNAL`. -
BrandLovers Marketplace API V1 1.0.0GET Ticket {ticketid} Messages/ticket/{{ticketId}}/messagesgetReturns 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). -
BrandLovers Marketplace API V1 1.0.0PUT Ticket {ticketid} Status/ticket/{{ticketId}}/statusputAlows the seller to update the status of a trouble ticket -
BrandLovers Marketplace API V1 1.0.0GET Tickets/ticketsgetAllows seller to receive and status, queries, requests and complaints from customers. As well related messages -
36 Webhooks
Connection Roles
NamespaceNameWebhooksConnectionsUpdated at
BrandLovers Marketplace API V1 1.0.0Connections -
1 Connection Roles

Data

Data Types
NamespaceNameSlugTypeStorage sizeUpdated at
BrandLovers Marketplace API V1 1.0.0AddressaddressJson Data Type0 Bytes -
BrandLovers Marketplace API V1 1.0.0ControlledStockcontrolled_stockJson Data Type0 Bytes -
BrandLovers Marketplace API V1 1.0.0CouriercourierJson Data Type0 Bytes -
BrandLovers Marketplace API V1 1.0.0CustomercustomerJson Data Type0 Bytes -
BrandLovers Marketplace API V1 1.0.0CustomerReferencecustomer_referenceJson Data Type0 Bytes -
BrandLovers Marketplace API V1 1.0.0DimensionsdimensionsJson Data Type0 Bytes -
BrandLovers Marketplace API V1 1.0.0ErrorerrorJson Data Type0 Bytes -
BrandLovers Marketplace API V1 1.0.0FreightfreightJson Data Type0 Bytes -
BrandLovers Marketplace API V1 1.0.0GetOrdersgetordersJson Data Type0 Bytes -
BrandLovers Marketplace API V1 1.0.0GetOrdersShipmentsget_orders_shipmentsJson Data Type0 Bytes -
BrandLovers Marketplace API V1 1.0.0GetProductgetproductJson Data Type0 Bytes -
BrandLovers Marketplace API V1 1.0.0GetProductsResponseget_products_responseJson Data Type0 Bytes -
BrandLovers Marketplace API V1 1.0.0GetProductsStatusSellingget_products_status_sellingJson Data Type0 Bytes -
BrandLovers Marketplace API V1 1.0.0GetSellerProductStatusget_seller_product_statusJson Data Type0 Bytes -
BrandLovers Marketplace API V1 1.0.0GetSellerProductsStatusget_seller_products_statusJson Data Type0 Bytes -
BrandLovers Marketplace API V1 1.0.0GetTicketMessagesget_ticket_messagesJson Data Type0 Bytes -
BrandLovers Marketplace API V1 1.0.0GetTicketsgetticketsJson Data Type0 Bytes -
BrandLovers Marketplace API V1 1.0.0GiftCardgiftcardJson Data Type0 Bytes -
BrandLovers Marketplace API V1 1.0.0GiftWrapgiftwrapJson Data Type0 Bytes -
BrandLovers Marketplace API V1 1.0.0ImageimageJson Data Type0 Bytes -
BrandLovers Marketplace API V1 1.0.0InvoiceinvoiceJson Data Type0 Bytes -
BrandLovers Marketplace API V1 1.0.0MetadatametadataJson Data Type0 Bytes -
BrandLovers Marketplace API V1 1.0.0NewTicketnewticketJson Data Type0 Bytes -
BrandLovers Marketplace API V1 1.0.0NewTicketMessagenew_ticket_messageJson Data Type0 Bytes -
BrandLovers Marketplace API V1 1.0.0NewTrackingRefundnew_tracking_refundJson Data Type0 Bytes -
BrandLovers Marketplace API V1 1.0.0NewshipmentstatusnewshipmentstatusJson Data Type0 Bytes -
BrandLovers Marketplace API V1 1.0.0OrderorderJson Data Type0 Bytes -
BrandLovers Marketplace API V1 1.0.0OrderGiftWraporder_gift_wrapJson Data Type0 Bytes -
BrandLovers Marketplace API V1 1.0.0OrderItemorderitemJson Data Type0 Bytes -
BrandLovers Marketplace API V1 1.0.0OrderItemReferenceorder_item_referenceJson Data Type0 Bytes -
BrandLovers Marketplace API V1 1.0.0OrderShippmentorder_shippmentJson Data Type0 Bytes -
BrandLovers Marketplace API V1 1.0.0OrderShippmentStatusorder_shippment_statusJson Data Type0 Bytes -
BrandLovers Marketplace API V1 1.0.0OrdersShipmentsorders_shipmentsJson Data Type0 Bytes -
BrandLovers Marketplace API V1 1.0.0PhonephoneJson Data Type0 Bytes -
BrandLovers Marketplace API V1 1.0.0ProductproductJson Data Type0 Bytes -
52 Data Types (showing 35)

Config

Namespaces
NameSlugUpdated at
BrandLovers Marketplace API V1 1.0.0brand_lovers_marketplace_api_v1_1_0_0 -
1 Namespaces

Metadata