GET v1​/ sell​/shop​/dashboard

Endpoint to get shop dashboard details, that are products count, orders count and total revenue.

Instant gratification

Do it yourself from console!

Assuming that you have a valid token previously exported into BEARER env variable

Try to get dashboard info about the current User
curl -i -H "Authorization: Bearer $BEARER" \
https://api.blomming.com/v1/sell/shop/dashboard

Request

Example Request

{
  "locale": "es"
}

Request Parameters

  • locale

    The locale used in the results.

    • Required: no
    • Type: string
    • Example: "es"

Response

Example Response

{
  "products_num": 21,
  "orders_num": 57,
  "total_revenue": 3750.0
}

Response Parameters

  • products_num

    Cardinality of products uploaded on the shop.

    • Required: yes
    • Type: integer
    • Example: 21
  • orders_num

    Cardinality of Orders the shop received (excluded those that have been cancelled of that have failed).

    • Required: yes
    • Type: integer
    • Example: 57
  • total_revenue

    The sum of all the Orders total (shipping cost excluded, excluded Orders that have been cancelled of that have failed).

    • Required: yes
    • Type: number
    • Example: 3750.0

Response Codes

Successful Response Codes

Failure Response Codes