Accounting Export Reports that can be consumed by 3rd Party accounting systems
- Adding a Session Item to a Session
Fetch API (v3.0: 3.26.2.2)
For differences between versions, see Changelog.
https://fetch.yellowdogsoftware.com/api/v3/
Filter results by MobileStatus. Accepts string values like "Finalized" and maps to enum value for DB. (Active = 1, Finalized = 2, Recount = 3, Processed = 4)
Page Number for the result set.
This is expected to be an integer value greater than 0. Defaults to 1 when not passed in.
For more information see the Getting Started Section for Pagination.
Page Size
- Default page size: 100
- Max page size: 500
This is expected to be an integer value greater than 0. Defaults to 100 when not passed in.
For more information see the Getting Started Section for Pagination.
- Production server
https://fetch.yellowdogsoftware.com/api/v3/sessions
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://fetch.yellowdogsoftware.com/api/v3/sessions?Filter=string&PageNumber=0&PageSize=0&Expand=string&OrderBy=string&enableSessionItemCountNullCoalescence=true' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'
OK
Yellow Dog's SessionID for the Session; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)
Unique ID of the Yellow Dog store where the item was counted; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)
Yellow Dog's UserID for the User; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)
DateTime when this item was last updated in Yellow Dog, in ISO 8601 format
Yellow Dog's CountSheetID for the Session; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)
[ { "sessionID": "f64470cf-3860-4029-b905-d576bb175df4", "storeID": "b89b5309-e797-4390-b985-9bdc32523397", "description": "string", "userID": "2c3821b8-1cdb-4b77-bcd8-a1da701e46aa", "device": "string", "mobileStatus": 0, "lastUpdated": "2019-08-24T14:15:22Z", "countSheetID": "ed1497be-add9-44eb-9bd3-3df7ef2126f7", "sessionItems": [ … ] } ]
- application/json-patch+json
- application/json
- text/json
- application/*+json
Yellow Dog's SessionID for the Session; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)
Unique ID of the Yellow Dog store where the item was counted; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)
Yellow Dog's UserID for the User; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)
Yellow Dog's CountSheetID for the Session; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)
- Production server
https://fetch.yellowdogsoftware.com/api/v3/sessions
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://fetch.yellowdogsoftware.com/api/v3/sessions \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json-patch+json' \
-d '[
{
"sessionID": "f64470cf-3860-4029-b905-d576bb175df4",
"storeID": "b89b5309-e797-4390-b985-9bdc32523397",
"description": "string",
"userID": "2c3821b8-1cdb-4b77-bcd8-a1da701e46aa",
"device": "string",
"countSheetID": "ed1497be-add9-44eb-9bd3-3df7ef2126f7",
"mobileStatus": 0,
"sessionItems": [
{
"sessionItemID": "4a848e0e-fb7d-4b49-85bb-3c47cb68c099",
"sessionID": "f64470cf-3860-4029-b905-d576bb175df4",
"itemID": "f1f85a48-b9b1-447d-a06c-c1acf57ed3a8",
"count": -99999999999.9999,
"flagID": "886f4211-412a-458d-b966-1bb8f3c8a384",
"levelID": "a7f1bc8a-b57c-4783-8f8c-e2c8857627cb"
}
]
}
]'
[ "497f6eca-6276-4993-bfeb-53cbbbba6f08" ]
- application/json-patch+json
- application/json
- text/json
- application/*+json
Yellow Dog's SessionID for the Session; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)
Unique ID of the Yellow Dog store where the item was counted; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)
Yellow Dog's UserID for the User; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)
Yellow Dog's CountSheetID for the Session; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)
- Production server
https://fetch.yellowdogsoftware.com/api/v3/sessions
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
https://fetch.yellowdogsoftware.com/api/v3/sessions \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json-patch+json' \
-d '[
{
"sessionID": "f64470cf-3860-4029-b905-d576bb175df4",
"storeID": "b89b5309-e797-4390-b985-9bdc32523397",
"description": "string",
"userID": "2c3821b8-1cdb-4b77-bcd8-a1da701e46aa",
"device": "string",
"countSheetID": "ed1497be-add9-44eb-9bd3-3df7ef2126f7",
"mobileStatus": 0,
"sessionItems": [
{
"sessionItemID": "4a848e0e-fb7d-4b49-85bb-3c47cb68c099",
"sessionID": "f64470cf-3860-4029-b905-d576bb175df4",
"itemID": "f1f85a48-b9b1-447d-a06c-c1acf57ed3a8",
"count": -99999999999.9999,
"flagID": "886f4211-412a-458d-b966-1bb8f3c8a384",
"levelID": "a7f1bc8a-b57c-4783-8f8c-e2c8857627cb"
}
]
}
]'
Page Number for the result set.
This is expected to be an integer value greater than 0. Defaults to 1 when not passed in.
For more information see the Getting Started Section for Pagination.
Page Size
- Default page size: 100
- Max page size: 500
This is expected to be an integer value greater than 0. Defaults to 100 when not passed in.
For more information see the Getting Started Section for Pagination.
- Production server
https://fetch.yellowdogsoftware.com/api/v3/sessions/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://fetch.yellowdogsoftware.com/api/v3/sessions/{id}?PageNumber=0&PageSize=0&Expand=string&Filter=string&OrderBy=string&enableSessionItemCountNullCoalescence=true' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'
OK
Yellow Dog's SessionID for the Session; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)
Unique ID of the Yellow Dog store where the item was counted; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)
Yellow Dog's UserID for the User; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)
DateTime when this item was last updated in Yellow Dog, in ISO 8601 format
Yellow Dog's CountSheetID for the Session; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)
{ "sessionID": "f64470cf-3860-4029-b905-d576bb175df4", "storeID": "b89b5309-e797-4390-b985-9bdc32523397", "description": "string", "userID": "2c3821b8-1cdb-4b77-bcd8-a1da701e46aa", "device": "string", "mobileStatus": 0, "lastUpdated": "2019-08-24T14:15:22Z", "countSheetID": "ed1497be-add9-44eb-9bd3-3df7ef2126f7", "sessionItems": [ { … } ] }
- Production server
https://fetch.yellowdogsoftware.com/api/v3/sessions/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://fetch.yellowdogsoftware.com/api/v3/sessions/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'
- Production server
https://fetch.yellowdogsoftware.com/api/v3/sessions/{id}/sessionItems
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://fetch.yellowdogsoftware.com/api/v3/sessions/{id}/sessionItems' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json-patch+json' \
-d '{
"itemID": "f1f85a48-b9b1-447d-a06c-c1acf57ed3a8",
"count": 0.1
}'
OK
Yellow Dog's SessionID for the Item Counted in the Session; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)
Yellow Dog's SessionID for the Session; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)
Yellow Dog's Item ID for the item; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)
{ "sessionItemID": "4a848e0e-fb7d-4b49-85bb-3c47cb68c099", "sessionID": "f64470cf-3860-4029-b905-d576bb175df4", "itemID": "f1f85a48-b9b1-447d-a06c-c1acf57ed3a8", "count": 0 }
- Production server
https://fetch.yellowdogsoftware.com/api/v3/sessions/{id}/sessionItems/{sessionItemId}/count
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://fetch.yellowdogsoftware.com/api/v3/sessions/{id}/sessionItems/{sessionItemId}/count' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json-patch+json' \
-d '{
"count": 0.1
}'
OK
Yellow Dog's SessionID for the Item Counted in the Session; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)
Yellow Dog's SessionID for the Session; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)
Yellow Dog's Item ID for the item; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)
{ "sessionItemID": "4a848e0e-fb7d-4b49-85bb-3c47cb68c099", "sessionID": "f64470cf-3860-4029-b905-d576bb175df4", "itemID": "f1f85a48-b9b1-447d-a06c-c1acf57ed3a8", "count": 0 }