Glass America Omega Dashboard Details - Revision history

Ashley DeBon: /* Successful Response (200) */

2026-07-21T14:31:17Z

‎Successful Response (200)

Ashley DeBon: /* Get Glass America Sale Item Dashboard Details */

2026-07-21T14:30:45Z

‎Get Glass America Sale Item Dashboard Details

Ashley DeBon at 14:30, 21 July 2026

2026-07-21T14:30:34Z

Ashley DeBon: /* Get Glass America Sale Item Dashboard Details */

2026-07-21T14:29:53Z

‎Get Glass America Sale Item Dashboard Details

Ashley DeBon: Created page with "== Get Glass America Sale Item Dashboard Details == === Base URL === https://apimobile.callproof.com === Endpoint === /api/glass-america/sale-items/omega-dashboard-details..."

2026-07-21T14:29:41Z

Created page with "== Get Glass America Sale Item Dashboard Details == === Base URL === https://apimobile.callproof.com === Endpoint === /api/glass-america/sale-items/omega-dashboard-details..."

New page

== Get Glass America Sale Item Dashboard Details ==

=== Base URL ===
https://apimobile.callproof.com

=== Endpoint ===
/api/glass-america/sale-items/omega-dashboard-details

=== Purpose ===
Retrieves Omega dashboard sales metrics for Glass America for a given date range, including net sales, total sales, average sales, gross margin, and sales by category. Optional filters (user, location, territory, salesman, date type) can be applied.

=== HTTP Method ===
POST

=== Headers ===
{| class="wikitable"
! Header !! Required !! Description
|-
| Authorization || Yes || Bearer access token
|}

=== Security ===
* '''Yes''' – Requires Bearer Token authentication.

=== Parameters ===

==== Path Parameters ====
None.

==== Query Parameters ====
None.

==== Request Body ====
{| class="wikitable"
! Parameter !! Type !! Required !! Description
|-
| from_date || date/string || Yes || Start date for the sales report
|-
| to_date || date/string || Yes || End date for the sales report
|-
| user || string || No || Filter by user
|-
| date_type || string || No || Date type filter for the Omega report
|-
| location_id || string || No || Filter by location
|-
| territory_id || string || No || Filter by territory
|-
| salesman_4_id || string || No || Filter by salesman
|}

=== Successful Response (200) ===
Returns aggregated sales metrics and day-by-day series for the requested range.

{| class="wikitable"
! Field !! Type !! Description
|-
| clientStatusCode || integer || Status indicator for the client (for example, 200)
|-
| user_id || integer || Identifier of the authenticated user
|-
| company_id || integer || Identifier of the authenticated user’s company
|-
| data || object || Dashboard sales payload
|-
| uri || string || Requested resource URI
|}

==== data ====
{| class="wikitable"
! Field !! Type !! Description
|-
| total_net_sales_count || string || Net sales total formatted with 2 decimal places (for display)
|-
| total_net_sales || number || Net sales total (numeric)
|-
| net_sales || object || Day-by-day net sales series grouped by source series keys
|-
| total_sales_count || number || Total sales count/sum used for averages
|-
| total_sales || object || Day-by-day total sales series
|-
| average_sales || number || Average sale amount (net sales ÷ total sales count), rounded to 2 decimals
|-
| total_gross_margin || number || Total gross margin amount
|-
| gross_margin || object || Day-by-day gross margin series
|-
| net_gross_margin || number || Gross margin as a percentage of net sales (0 when net sales is 0)
|-
| sales_by_category || object || Sales totals keyed by category name (lowercase, spaces replaced with underscores)
|}

==== data series format (net_sales / total_sales / gross_margin) ====
Each series value is an array of daily points:

{| class="wikitable"
! Field !! Type !! Description
|-
| [0] || string || Date in <code>Y-m-d</code> format
|-
| [1] || number || Metric value for that date (0 when no data)
|}

=== Error Responses ===
{| class="wikitable"
! Status Code !! Meaning
|-
| 200 || Validation failed – response body uses <code>clientStatusCode</code> 401 with the first validation error message
|-
| 400 || Bad Request – dashboard sale details could not be retrieved
|-
| 401 || Unauthorized – missing, invalid, or expired Bearer token
|}

* '''Validation (HTTP 200, clientStatusCode 401)''' – Missing or invalid <code>from_date</code> / <code>to_date</code>.
* '''400''' – Upstream Omega dashboard error or another failure while loading sale item details.
* '''401''' – Authentication failed or the access token is missing/expired.

← Older revision		Revision as of 14:30, 21 July 2026
Line 1:		Line 1:
−	== Get Glass America Sale Item Dashboard Details ==	+	==[[Mobile_API]] » Get Glass America Sale Item Dashboard Details ==

	=== Base URL ===		=== Base URL ===

@@ Line 49: / Line 49: @@
 | salesman_4_id || string || No || Filter by salesman
 |}
 === Successful Response (200) ===

@@ Line 1: / Line 1: @@
-== Get[[Mobile_API]] &#187;
+== Get Glass America Sale Item Dashboard Details ==
 === Endpoint ===
 /api/glass-america/sale-items/omega-dashboard-details