flowground für Geschäftskunden

Technische Spezifikationen

startFlow

OnInit
./lib/triggers/startFlow.js
OnStartup
-
OnClose
-

Attributes

-

get_order__orderId_

Returns all details of a single order, including last status, items shipped or not.

OnInit
./lib/actions/get_order__orderId_.js
OnStartup
-
OnClose
-

Attributes

-

post_order__orderId__shipment_cancel

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

OnInit
./lib/actions/post_order__orderId__shipment_cancel.js
OnStartup
-
OnClose
-

Attributes

-

post_order__orderId__shipment_delivered

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

OnInit
./lib/actions/post_order__orderId__shipment_delivered.js
OnStartup
-
OnClose
-

Attributes

-

post_order__orderId__shipment_exchange

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

OnInit
./lib/actions/post_order__orderId__shipment_exchange.js
OnStartup
-
OnClose
-

Attributes

-

post_order__orderId__shipment_return

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

OnInit
./lib/actions/post_order__orderId__shipment_return.js
OnStartup
-
OnClose
-

Attributes

-

post_order__orderId__shipment_sent

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.

OnInit
./lib/actions/post_order__orderId__shipment_sent.js
OnStartup
-
OnClose
-

Attributes

-

get_orders

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

OnInit
./lib/actions/get_orders.js
OnStartup
-
OnClose
-

Attributes

-

get_orders_shipments_delivered

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

OnInit
./lib/actions/get_orders_shipments_delivered.js
OnStartup
-
OnClose
-

Attributes

-

post_orders_shipments_delivered

Bulk update of order shipments status. This alows to inform multiple shipments status

OnInit
./lib/actions/post_orders_shipments_delivered.js
OnStartup
-
OnClose
-

Attributes

-

get_orders_shipments_shipped

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

OnInit
./lib/actions/get_orders_shipments_shipped.js
OnStartup
-
OnClose
-

Attributes

-

post_orders_shipments_shipped

Allows bulk updates of orders shippments.

OnInit
./lib/actions/post_orders_shipments_shipped.js
OnStartup
-
OnClose
-

Attributes

-

get_orders_status_approved

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

OnInit
./lib/actions/get_orders_status_approved.js
OnStartup
-
OnClose
-

Attributes

-

get_orders_status_canceled

Returns a list with canceled orders. Canceled orders should not be fullfiled.

OnInit
./lib/actions/get_orders_status_canceled.js
OnStartup
-
OnClose
-

Attributes

-

get_orders_status_delivered

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

OnInit
./lib/actions/get_orders_status_delivered.js
OnStartup
-
OnClose
-

Attributes

-

get_orders_status_new

Returns a list of orders flagged as new. New orders should not be fullfiled until marketplace flags them as approved.

OnInit
./lib/actions/get_orders_status_new.js
OnStartup
-
OnClose
-

Attributes

-

get_orders_status_partiallyDelivered

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

OnInit
./lib/actions/get_orders_status_partiallyDelivered.js
OnStartup
-
OnClose
-

Attributes

-

get_orders_status_partiallySent

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.

OnInit
./lib/actions/get_orders_status_partiallySent.js
OnStartup
-
OnClose
-

Attributes

-

get_orders_status_sent

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

OnInit
./lib/actions/get_orders_status_sent.js
OnStartup
-
OnClose
-

Attributes

-

post_product

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`

OnInit
./lib/actions/post_product.js
OnStartup
-
OnClose
-

Attributes

-

get_product__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

OnInit
./lib/actions/get_product__skuSellerId_.js
OnStartup
-
OnClose
-

Attributes

-

put_product__skuSellerId_

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.

OnInit
./lib/actions/put_product__skuSellerId_.js
OnStartup
-
OnClose
-

Attributes

-

put_product__skuSellerId__prices

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

OnInit
./lib/actions/put_product__skuSellerId__prices.js
OnStartup
-
OnClose
-

Attributes

-

put_product__skuSellerId__status

Update product status in the Marketplace. Set to `true` to enable, `false` to disable sale.

OnInit
./lib/actions/put_product__skuSellerId__status.js
OnStartup
-
OnClose
-

Attributes

-

put_product__skuSellerId__stock

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

OnInit
./lib/actions/put_product__skuSellerId__stock.js
OnStartup
-
OnClose
-

Attributes

-

get_products

Get 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.

OnInit
./lib/actions/get_products.js
OnStartup
-
OnClose
-

Attributes

-

post_products

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

OnInit
./lib/actions/post_products.js
OnStartup
-
OnClose
-

Attributes

-

put_products_prices

Allows 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

OnInit
./lib/actions/put_products_prices.js
OnStartup
-
OnClose
-

Attributes

-

get_products_status

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}

OnInit
./lib/actions/get_products_status.js
OnStartup
-
OnClose
-

Attributes

-

put_products_status

Bulk 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.

OnInit
./lib/actions/put_products_status.js
OnStartup
-
OnClose
-

Attributes

-

get_products_status_selling

Returns products that are successfully listed for sale.

OnInit
./lib/actions/get_products_status_selling.js
OnStartup
-
OnClose
-

Attributes

-

put_products_stocks

Bulk product stock update. This endpoint expect a array of products `skuSellerId` with new inventory data

OnInit
./lib/actions/put_products_stocks.js
OnStartup
-
OnClose
-

Attributes

-

post_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.

OnInit
./lib/actions/post_ticket.js
OnStartup
-
OnClose
-

Attributes

-

post_ticket__ticketId__message

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

OnInit
./lib/actions/post_ticket__ticketId__message.js
OnStartup
-
OnClose
-

Attributes

-

get_ticket__ticketId__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).

OnInit
./lib/actions/get_ticket__ticketId__messages.js
OnStartup
-
OnClose
-

Attributes

-

put_ticket__ticketId__status

Alows the seller to update the status of a trouble ticket

OnInit
./lib/actions/put_ticket__ticketId__status.js
OnStartup
-
OnClose
-

Attributes

-

get_tickets

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

OnInit
./lib/actions/get_tickets.js
OnStartup
-
OnClose
-

Attributes

-

Keine Daten für terms vorhanden

Keine Daten für environment vorhanden