Fetch API (v3.0: 3.23.1.1)

For differences between versions, see Changelog.

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 and Recipes are able to have 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

Stores

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

Operations

ThirdPartyCodes

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

Operations

ThirdParty

Third Party Mappings with Yellow Dog Inventory

Operations

ThirdPartySessions

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

Operations

Gets all Third Party Sessions

Request

Query

FilterArray of strings

code
dateTime

OrderByArray of strings

Order By Options:

code
dateTime

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.

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

Responses

Bodyapplication/jsonArray [

idstring(uuid)

codestring or null

sourcestring or null

descriptionstringnon-emptyrequired

dateTimestring(date-time)

storeobject(Api.Models.Dto.TPStore)

linesArray of objects(Api.Models.Dto.TPSessionItem)required

lines[].flagstring or null

lines[].devicestring or null

lines[].dateTimestring(date-time)

lines[].itemobject(Api.Models.Dto.TPItem)required

lines[].item.idstring(uuid)

lines[].item.upcstring or null

lines[].item.skustring or null

lines[].item.descriptionstring or null

lines[].item.categorystring or null

lines[].item.subCategorystring or null

lines[].item.retailnumber or null(double)

lines[].item.unitstring or null

lines[].item.manufacturerobject(Api.Models.Dto.TPManufacturer)

lines[].item.vendorobject(Api.Models.Dto.TPVendor)

lines[].countednumber(double)required

lines[].countedWeightobject(Api.Models.Dto.TPGenericCount)

lines[].countedVolumeobject(Api.Models.Dto.TPGenericCount)

lines[].fullWeightobject(Api.Models.Dto.TPGenericCount)

lines[].tareWeightobject(Api.Models.Dto.TPGenericCount)

createdByUserobject(Api.Models.Dto.GenericObject)

]

Response

application/json

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "code": "string",
    "source": "string",
    "description": "string",
    "dateTime": "2019-08-24T14:15:22Z",
    "store": { … },
    "lines": [ … ],
    "createdByUser": { … }
  }
]

Creates Third Party Sessions

Request

Query

suppressOutputboolean

Default true

Body

Array [

codestring or null

sourcestring or null

descriptionstringnon-emptyrequired

dateTimestring(date-time)

storeobject(Api.Models.Dto.TPStore)

linesArray of objects(Api.Models.Dto.TPSessionItem)required

lines[].flagstring or null

lines[].devicestring or null

lines[].dateTimestring(date-time)

lines[].itemobject(Api.Models.Dto.TPItem)required

lines[].item.idstring(uuid)

lines[].item.upcstring or null

lines[].item.skustring or null

lines[].item.descriptionstring or null

lines[].item.categorystring or null

lines[].item.subCategorystring or null

lines[].item.retailnumber or null(double)

lines[].item.unitstring or null

lines[].item.manufacturerobject(Api.Models.Dto.TPManufacturer)

lines[].item.vendorobject(Api.Models.Dto.TPVendor)

lines[].countednumber(double)required

lines[].countedWeightobject(Api.Models.Dto.TPGenericCount)

lines[].countedVolumeobject(Api.Models.Dto.TPGenericCount)

lines[].fullWeightobject(Api.Models.Dto.TPGenericCount)

lines[].tareWeightobject(Api.Models.Dto.TPGenericCount)

]

curl -i -X POST \
  'https://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/thirdPartySessions?suppressOutput=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '[
    {
      "code": "string",
      "source": "string",
      "description": "string",
      "dateTime": "2019-08-24T14:15:22Z",
      "store": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "code": "string",
        "name": "string"
      },
      "lines": [
        {
          "flag": "string",
          "device": "string",
          "dateTime": "2019-08-24T14:15:22Z",
          "item": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "upc": "string",
            "sku": "string",
            "description": "string",
            "category": "string",
            "subCategory": "string",
            "retail": 0,
            "unit": "string",
            "manufacturer": {
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "sku": "string",
              "name": "string",
              "cost": 0
            },
            "vendor": {
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "sku": "string",
              "name": "string",
              "cost": 0
            }
          },
          "counted": 0.1,
          "countedWeight": {
            "value": 0,
            "unit": "string"
          },
          "countedVolume": {
            "value": 0,
            "unit": "string"
          },
          "fullWeight": {
            "value": 0,
            "unit": "string"
          },
          "tareWeight": {
            "value": 0,
            "unit": "string"
          }
        }
      ]
    }
  ]'

Responses

Bodyapplication/jsonArray [

idstring(uuid)

codestring or null

sourcestring or null

descriptionstringnon-emptyrequired

dateTimestring(date-time)

storeobject(Api.Models.Dto.TPStore)

linesArray of objects(Api.Models.Dto.TPSessionItem)required

lines[].flagstring or null

lines[].devicestring or null

lines[].dateTimestring(date-time)

lines[].itemobject(Api.Models.Dto.TPItem)required

lines[].item.idstring(uuid)

lines[].item.upcstring or null

lines[].item.skustring or null

lines[].item.descriptionstring or null

lines[].item.categorystring or null

lines[].item.subCategorystring or null

lines[].item.retailnumber or null(double)

lines[].item.unitstring or null

lines[].item.manufacturerobject(Api.Models.Dto.TPManufacturer)

lines[].item.vendorobject(Api.Models.Dto.TPVendor)

lines[].countednumber(double)required

lines[].countedWeightobject(Api.Models.Dto.TPGenericCount)

lines[].countedVolumeobject(Api.Models.Dto.TPGenericCount)

lines[].fullWeightobject(Api.Models.Dto.TPGenericCount)

lines[].tareWeightobject(Api.Models.Dto.TPGenericCount)

createdByUserobject(Api.Models.Dto.GenericObject)

]

Response

application/json

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "code": "string",
    "source": "string",
    "description": "string",
    "dateTime": "2019-08-24T14:15:22Z",
    "store": { … },
    "lines": [ … ],
    "createdByUser": { … }
  }
]

Gets Third Party Session by Id

Request

Path

idstring(uuid)required

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

Responses

Bodyapplication/json

idstring(uuid)

codestring or null

sourcestring or null

descriptionstringnon-emptyrequired

dateTimestring(date-time)

storeobject(Api.Models.Dto.TPStore)

linesArray of objects(Api.Models.Dto.TPSessionItem)required

lines[].flagstring or null

lines[].devicestring or null

lines[].dateTimestring(date-time)

lines[].itemobject(Api.Models.Dto.TPItem)required

lines[].item.idstring(uuid)

lines[].item.upcstring or null

lines[].item.skustring or null

lines[].item.descriptionstring or null

lines[].item.categorystring or null

lines[].item.subCategorystring or null

lines[].item.retailnumber or null(double)

lines[].item.unitstring or null

lines[].item.manufacturerobject(Api.Models.Dto.TPManufacturer)

lines[].item.vendorobject(Api.Models.Dto.TPVendor)

lines[].countednumber(double)required

lines[].countedWeightobject(Api.Models.Dto.TPGenericCount)

lines[].countedVolumeobject(Api.Models.Dto.TPGenericCount)

lines[].fullWeightobject(Api.Models.Dto.TPGenericCount)

lines[].tareWeightobject(Api.Models.Dto.TPGenericCount)

createdByUserobject(Api.Models.Dto.GenericObject)

Response

application/json

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "code": "string",
  "source": "string",
  "description": "string",
  "dateTime": "2019-08-24T14:15:22Z",
  "store": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "code": "string",
    "name": "string"
  },
  "lines": [
    { … }
  ],
  "createdByUser": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}

Transactions

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

Operations

Transfers

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

Operations

Vendors

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

Operations

Fetch API (v3.0: 3.23.1.1)

Accounting

AttachedFiles

CountSheets

Currency

Dimensions

Flags

Inventory

Invoices

ItemAliases

Items

ManualAdjusts

MetaInfo

PurchaseOrders

Receipts

Recipes

Requests

Sessions

Stores

ThirdPartyCodes

ThirdParty

ThirdPartySessions

Gets all Third Party Sessions

Request

Order By Options:

Responses

Was this page helpful?

Creates Third Party Sessions

Request

Responses

Was this page helpful?

Gets Third Party Session by Id

Request

Responses

Was this page helpful?

Transactions

Transfers

Vendors

Fetch API (v3.0: 3.23.1.1)

Accounting

AttachedFiles

CountSheets

Currency

Dimensions

Flags

Inventory

Invoices

ItemAliases

Items

ManualAdjusts

MetaInfo

PurchaseOrders

Receipts

Recipes

Requests

Sessions

Stores

ThirdPartyCodes

ThirdParty

ThirdPartySessions

Gets all Third Party Sessions

Request

Filter Options:

Order By Options:

Responses

Was this page helpful?

Creates Third Party Sessions

Request

Responses

Was this page helpful?

Gets Third Party Session by Id

Request

Responses

Was this page helpful?

Transactions

Transfers

Vendors