Skip to content

Fetch API (v3.0: 3.26.2.5)

REST API logo


For differences between versions, see Changelog.

Download OpenAPI description
api.json
api.yaml
Overview
API Support Group

api@yellowdogsoftware.com

Languages
Servers
Production server

https://fetch.yellowdogsoftware.com/api/v3/

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

Creates Manual Adjustments

Request

Security
Auth API User Token
Body
Array [
itemIDstring(uuid)required

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

storeIDstring(uuid)required

Yellow Dog's primary key for the Store; always unique; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)

beanAccountIDstring(uuid)required

This is used to define the accounting reason for the adjustment. BeanAccountId can be retrieved from the /api/v3/accounting/{storeId}/codes/ManualAdjust endpoint, using the specified the storeId.

newOnHandnumber or null(double)

sets a new on hand value for given item at given store

adjustmentnumber or null(double)

The adjustment amount that will be added to current on-hand

  • sets the adjustment for the item at that store
  • NewOnHand takes precedence over Adjustment. If both are set, NewOnHand's Value will be used, not Adjustment
itemCostnumber or null(double)

The cost of the item New Item Cost (defaults to -1 if a value is not provided)

referencestring or null

User defined reason why the adjustment was performed

]
curl -i -X POST \
  https://fetch.yellowdogsoftware.com/api/v3/manualadjusts \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '[
    {
      "itemID": "f1f85a48-b9b1-447d-a06c-c1acf57ed3a8",
      "storeID": "b89b5309-e797-4390-b985-9bdc32523397",
      "beanAccountID": "1bb2de8e-f820-409b-9de9-2905e98c1cd1",
      "newOnHand": 0,
      "adjustment": 0,
      "itemCost": 0,
      "reference": "string"
    }
  ]'

Responses

OK

Response
No content

MetaInfo

Database specific configuration information

Operations

ProductionGroups

Collections of production groups.

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

RecipeTypes

Collections of RecipeTypes.

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

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