Adding a Session Item to a Session

Fetch API (v3.0: 3.21.3.0)

Download OpenAPI description

api.json

api.yaml

Overview

API Support Group api@yellowdogsoftware.com

Servers

Mock server

https://developer.yellowdogsoftware.com/_mock/fetch/api/

Accounting

Accounting Export Reports that can be consumed by 3rd Party accounting systems

Operations

AttachedFiles

Items, Recipes, and Purchasing Documents are able to have files of record or images associated to them.

Operations

CountSheets

A dynamic list of Items that are designed to aide with physical inventories. Countsheets are based on a static list of items, Levels, and Flags

Operations

Currency

Operations used to manage currency conversion for the database. These are used when multiple currencies are used in a database.

Operations

Dimensions

Attributes that are available for assigning to an Item. Attributes can be like a Size or Color.

Operations

Flags

Flags allow you to indicate storage locations, making ordering and physical inventories easier.

Operations

Inventory

Item Inventory OnHand information.

Operations

Invoices

A Purchasing document

Operations

ItemAliases

UPCs or additional SKUs to for an Item.

Operations

Items

Product information that is tracked in Yellow Dog Inventory.

Operations

ManualAdjusts

A Manual Adjustment will affect an Item's OnHand.

Operations

MetaInfo

Database specific configuration information

Operations

PurchaseOrders

A Purchasing document

Operations

Receipts

A Receiving document

Operations

Recipes

Collections of items and recipes, with quantities, that are used to create other items.

Operations

Requests

A requisition for purchasing or transfering an item.

Operations

Sessions

Associate a count to an Item, these sessions can be used for Purchasing Documents or Physical Inventories.

Operations

Getting Sessions

Request

Query

PageNumberinteger(int32)

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.

PageSizeinteger(int32)

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.

ExpandArray of strings

FilterArray of strings

OrderByArray of strings

enableSessionItemCountNullCoalescenceboolean

Default true

curl -i -X GET \
  'https://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/sessions?Expand=string&Filter=string&OrderBy=string&PageNumber=0&PageSize=0&enableSessionItemCountNullCoalescence=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/jsonArray [

sessionIDstring(uuid)

Yellow Dog's SessionID for the Session; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)

storeIDstring or null(uuid)

Unique ID of the Yellow Dog store where the item was counted; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)

descriptionstring or null

Description of the Session (I.E. January Inventory)

userIDstring(uuid)

Yellow Dog's UserID for the User; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)

devicestring or null

The device used to perform the count session

lastUpdatedstring(date-time)

DateTime when this item was last updated in Yellow Dog, in ISO 8601 format

countSheetIDstring or null(uuid)

Yellow Dog's CountSheetID for the Session; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)

sessionItemsArray of objects or null(Api.Models.Dto.SessionItemGet)

]

Response

application/json

[
  {
    "sessionID": "f64470cf-3860-4029-b905-d576bb175df4",
    "storeID": "b89b5309-e797-4390-b985-9bdc32523397",
    "description": "string",
    "userID": "2c3821b8-1cdb-4b77-bcd8-a1da701e46aa",
    "device": "string",
    "lastUpdated": "2019-08-24T14:15:22Z",
    "countSheetID": "ed1497be-add9-44eb-9bd3-3df7ef2126f7",
    "sessionItems": [ … ]
  }
]

Creating new Sessions

Request

Body

Array [

sessionIDstring(uuid)

Yellow Dog's SessionID for the Session; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)

storeIDstring or null(uuid)

Unique ID of the Yellow Dog store where the item was counted; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)

descriptionstring or null

Description of the Session (I.E. January Inventory)

userIDstring(uuid)

Yellow Dog's UserID for the User; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)

devicestring or null

The device used to perform the count session

countSheetIDstring or null(uuid)

Yellow Dog's CountSheetID for the Session; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)

mobileStatusinteger(int32)(Api.Helpers.MobileStatus)

Enum0123

sessionItemsArray of objects or null(Api.Models.Dto.SessionItemCreate)

]

curl -i -X POST \
  https://developer.yellowdogsoftware.com/_mock/fetch/api/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"
        }
      ]
    }
  ]'

Responses

Bodyapplication/jsonArray [

string(uuid)

]

Response

application/json

[
  "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Updating existing Sessions

Request

Body

Array [

sessionIDstring(uuid)

Yellow Dog's SessionID for the Session; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)

storeIDstring or null(uuid)

Unique ID of the Yellow Dog store where the item was counted; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)

descriptionstring or null

Description of the Session (I.E. January Inventory)

userIDstring(uuid)

Yellow Dog's UserID for the User; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)

devicestring or null

The device used to perform the count session

countSheetIDstring or null(uuid)

Yellow Dog's CountSheetID for the Session; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)

mobileStatusinteger(int32)(Api.Helpers.MobileStatus)

Enum0123

sessionItemsArray of objects or null(Api.Models.Dto.SessionItemCreate)

]

curl -i -X PUT \
  https://developer.yellowdogsoftware.com/_mock/fetch/api/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"
        }
      ]
    }
  ]'

Responses

Rate limiting quota exceeded

Apply pause on further requests to the api using a wait method for the amount of seconds presented in the Response Header Key 'Retry-After'.

To prevent running into further instances of this rate limiting, use the Response Headers returned back from all other requests to ensure there is enough buffer.

For further information see Rate Limiting Section of Getting Started of api documentation site.

Response

No response example

Getting Session by Id

Request

Path

idstring(uuid)required

Session Id

Query

PageNumberinteger(int32)

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.

PageSizeinteger(int32)

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.

ExpandArray of strings

FilterArray of strings

OrderByArray of strings

enableSessionItemCountNullCoalescenceboolean

Default true

curl -i -X GET \
  'https://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/sessions/{id}?Expand=string&Filter=string&OrderBy=string&PageNumber=0&PageSize=0&enableSessionItemCountNullCoalescence=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

sessionIDstring(uuid)

Yellow Dog's SessionID for the Session; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)

storeIDstring or null(uuid)

Unique ID of the Yellow Dog store where the item was counted; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)

descriptionstring or null

Description of the Session (I.E. January Inventory)

userIDstring(uuid)

Yellow Dog's UserID for the User; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)

devicestring or null

The device used to perform the count session

lastUpdatedstring(date-time)

DateTime when this item was last updated in Yellow Dog, in ISO 8601 format

countSheetIDstring or null(uuid)

Yellow Dog's CountSheetID for the Session; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)

sessionItemsArray of objects or null(Api.Models.Dto.SessionItemGet)

Response

application/json

{
  "sessionID": "f64470cf-3860-4029-b905-d576bb175df4",
  "storeID": "b89b5309-e797-4390-b985-9bdc32523397",
  "description": "string",
  "userID": "2c3821b8-1cdb-4b77-bcd8-a1da701e46aa",
  "device": "string",
  "lastUpdated": "2019-08-24T14:15:22Z",
  "countSheetID": "ed1497be-add9-44eb-9bd3-3df7ef2126f7",
  "sessionItems": [
    { … }
  ]
}

Deleting a Session

Request

Path

idstring(uuid)required

Session Id

curl -i -X DELETE \
  'https://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/sessions/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Rate limiting quota exceeded

Apply pause on further requests to the api using a wait method for the amount of seconds presented in the Response Header Key 'Retry-After'.

To prevent running into further instances of this rate limiting, use the Response Headers returned back from all other requests to ensure there is enough buffer.

For further information see Rate Limiting Section of Getting Started of api documentation site.

Response

No response example

Adding a Session Item to a Session

Request

Path

idstring(uuid)required

Session Id

Body

creation params

itemIDstring(uuid)required

countnumber(double)required

curl -i -X POST \
  'https://developer.yellowdogsoftware.com/_mock/fetch/api/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
  }'

Responses

Bodyapplication/json

sessionItemIDstring(uuid)

Yellow Dog's SessionID for the Item Counted in the Session; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)

sessionIDstring(uuid)

Yellow Dog's SessionID for the Session; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)

itemIDstring or null(uuid)

Yellow Dog's Item ID for the item; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)

countnumber or null(double)

Response

application/json

{
  "sessionItemID": "4a848e0e-fb7d-4b49-85bb-3c47cb68c099",
  "sessionID": "f64470cf-3860-4029-b905-d576bb175df4",
  "itemID": "f1f85a48-b9b1-447d-a06c-c1acf57ed3a8",
  "count": 0
}

Updating values of a Session Item

Request

Path

idstring(uuid)required

Session Id

sessionItemIdstring(uuid)required

Session Item Id

Body

update params

countnumber(double)required

curl -i -X PUT \
  'https://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/sessions/{id}/sessionItems/{sessionItemId}/count' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "count": 0.1
  }'

Responses

Bodyapplication/json

sessionItemIDstring(uuid)

Yellow Dog's SessionID for the Item Counted in the Session; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)

sessionIDstring(uuid)

Yellow Dog's SessionID for the Session; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)

itemIDstring or null(uuid)

Yellow Dog's Item ID for the item; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)

countnumber or null(double)

Response

application/json

{
  "sessionItemID": "4a848e0e-fb7d-4b49-85bb-3c47cb68c099",
  "sessionID": "f64470cf-3860-4029-b905-d576bb175df4",
  "itemID": "f1f85a48-b9b1-447d-a06c-c1acf57ed3a8",
  "count": 0
}

Stores

Business Entities or locations of a single business entity that need to maintain their own inventory records.

ThirdPartyCodes

Additional configuration options that control item, store or level behavior with third-party integrations

ThirdParty

Third Party Mappings with Yellow Dog Inventory

ThirdPartySessions

Records that increment or decrement inventory based on customer interactions with a store

Transactions

Records that increment or decrement inventory based on customer interactions with a store

Transfers

A record of movement of Items from one Store to another.

Vendors

Vendors, Suppliers, Distributors, or Manufacturors that provide Items into the Inventory.

Fetch API (v3.0: 3.21.3.0)

Accounting

AttachedFiles

CountSheets

Currency

Dimensions

Flags

Inventory

Invoices

ItemAliases

Items

ManualAdjusts

MetaInfo

PurchaseOrders

Receipts

Recipes

Requests

Sessions

Getting Sessions

Request

Responses

Was this page helpful?

Creating new Sessions

Request

Responses

Was this page helpful?

Updating existing Sessions

Request

Responses

Was this page helpful?

Getting Session by Id

Request

Responses

Was this page helpful?

Deleting a Session

Request

Responses

Was this page helpful?

Adding a Session Item to a Session

Request

Responses

Was this page helpful?

Updating values of a Session Item

Request

Responses

Was this page helpful?

Stores

ThirdPartyCodes

ThirdParty

ThirdPartySessions

Transactions

Transfers

Vendors