Shipping | Summary Value
The summary values end point allows to get information about shipping information like delayed ship and today ship.
Overview
| URL | api/{tenantKey}/{orgKey}/shipping/summaryValues |
| Methods Supported | GET |
All Operations
This service includes the following operations:
- GET:
All Resources
This service uses the following resources:
GET Get Delayed Ship Count
Custom operation 'GetDelayedShipCount'.
Response:
| When successful, the response body contains a resource of type 'SummaryValue'. See SummaryValue. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Get Non Stock Count
Custom operation 'GetNonStockCount'.
Response:
| When successful, the response body contains a resource of type 'SummaryValue'. See SummaryValue. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Get Today Ship Count Ship Count
Custom operation 'GetTodayShipCountShipCount'.
Response:
| When successful, the response body contains a resource of type 'SummaryValue'. See SummaryValue. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Get Trailling Sales Orders
Custom operation 'GetTraillingSalesOrders'.
Response:
| When successful, the response body contains a list of resources of type 'TraillingSalesValue'. See TraillingSalesValue. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Get Partial Ship Count
Custom operation 'GetPartialShipCount'.
Response:
| When successful, the response body contains a resource of type 'SummaryValue'. See SummaryValue. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
Resources
SummaryValue
The following elements are required:
| count | (int) Count. |
| link | (string) Link. |
The following elements are optional:
| optional | (int) Optional. |
TraillingSalesValue
The following elements are required:
| monthKey | (int) Month Key. |
| monthName | (string) Month Name. |
| created | (int) Created. |
| delivered | (int) Delivered. |
| open | (int) Open. |