| All Verbs | /service/QueryShipmentsYOYTotals |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ManagerId | query | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Skip | form | int? | No | |
| Take | form | int? | No | |
| OrderBy | form | string | No | |
| OrderByDesc | form | string | No | |
| Include | form | string | No | |
| Fields | form | string | No | |
| Meta | form | Dictionary<string, string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| VendorID | form | string | No | |
| VendorName | form | string | No | |
| VendorGroup | form | string | No | |
| RepGroupID | form | string | No | |
| RepGroupName | form | string | No | |
| SalesRepID | form | string | No | |
| SalesRepName | form | string | No | |
| SalesRepState | form | string | No | |
| SalesRepRegionID | form | string | No | |
| SalesRepRegion | form | string | No | |
| SalesRepUsername | form | string | No | |
| Source | form | string | No | |
| TotalShipmentsYearToDate | form | decimal | No | |
| TotalShipmentsLastYear | form | decimal | No | |
| TotalShipmentsYearToDateLastYear | form | decimal | No | |
| TotalShipmentsQuarterToDate | form | decimal | No | |
| TotalShipmentsLastQuarter | form | decimal | No | |
| TotalShipmentsQuarterToDateLastYear | form | decimal | No | |
| TotalShipmentsMonthToDate | form | decimal | No | |
| TotalShipmentsLastMonth | form | decimal | No | |
| TotalShipmentsMonthToDateLastYear | form | decimal | No | |
| TotalShipmentsWeekToDate | form | decimal | No | |
| TotalShipmentsWeekToDateLastYear | form | decimal | No | |
| TotalShipmentsToday | form | decimal | No | |
| TotalShipmentsYesterday | form | decimal | No | |
| TotalShipmentsCountYearToDate | form | int | No | |
| TotalShipmentsCountLastYear | form | int | No | |
| TotalShipmentsCountYearToDateLastYear | form | int | No | |
| TotalShipmentsCountQuarterToDate | form | int | No | |
| TotalShipmentsCountLastQuarter | form | int | No | |
| TotalShipmentsCountQuarterToDateLastYear | form | int | No | |
| TotalShipmentsCountMonthToDate | form | int | No | |
| TotalShipmentsCountLastMonth | form | int | No | |
| TotalShipmentsCountMonthToDateLastYear | form | int | No | |
| TotalShipmentsCountWeekToDate | form | int | No | |
| TotalShipmentsCountWeekToDateLastYear | form | int | No | |
| TotalShipmentsCountToday | form | int | No | |
| TotalShipmentsCountYesterday | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Offset | form | int | No | |
| Total | form | int | No | |
| Results | form | List<T> | No | |
| Meta | form | Dictionary<string, string> | No | |
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /service/QueryShipmentsYOYTotals HTTP/1.1
Host: www.bernhardthospitality.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"managerId":"String","skip":0,"take":0,"orderBy":"String","orderByDesc":"String","include":"String","fields":"String","meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"offset":0,"total":0,"results":[{"vendorID":"String","vendorName":"String","vendorGroup":"String","repGroupID":"String","repGroupName":"String","salesRepID":"String","salesRepName":"String","salesRepState":"String","salesRepRegionID":"String","salesRepRegion":"String","salesRepUsername":"String","source":"String","totalShipmentsYearToDate":0,"totalShipmentsLastYear":0,"totalShipmentsYearToDateLastYear":0,"totalShipmentsQuarterToDate":0,"totalShipmentsLastQuarter":0,"totalShipmentsQuarterToDateLastYear":0,"totalShipmentsMonthToDate":0,"totalShipmentsLastMonth":0,"totalShipmentsMonthToDateLastYear":0,"totalShipmentsWeekToDate":0,"totalShipmentsWeekToDateLastYear":0,"totalShipmentsToday":0,"totalShipmentsYesterday":0,"totalShipmentsCountYearToDate":0,"totalShipmentsCountLastYear":0,"totalShipmentsCountYearToDateLastYear":0,"totalShipmentsCountQuarterToDate":0,"totalShipmentsCountLastQuarter":0,"totalShipmentsCountQuarterToDateLastYear":0,"totalShipmentsCountMonthToDate":0,"totalShipmentsCountLastMonth":0,"totalShipmentsCountMonthToDateLastYear":0,"totalShipmentsCountWeekToDate":0,"totalShipmentsCountWeekToDateLastYear":0,"totalShipmentsCountToday":0,"totalShipmentsCountYesterday":0}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}