Recipes

Fetch API (v3.0: 3.21.3.0)

Download OpenAPI description
api.json
api.yaml
Overview
API Support Group api@yellowdogsoftware.com
Languages
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

Adds an Image as an Attached File to a recipe User's client *MUST* be 366+ with cloud storage enabled

Request

Path
recipeIdstring(uuid)required
Query
descriptionstring

Description or Title of the Image file

Bodymultipart/form-data
filestring(binary)
curl -i -X POST \
  'https://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/recipes/{recipeId}/images?description=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F file=string

Responses

OK

Bodyapplication/json
idstring(uuid)
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Updates image details of a recipe

Request

Path
recipeIdstring(uuid)required
imageIdstring(uuid)required
Body
descriptionstringnon-emptyrequired
curl -i -X PATCH \
  'https://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/recipes/{recipeId}/images/{imageId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "description": "string"
  }'

Responses

OK

Bodyapplication/json
placementinteger(int32)
rowDeletedboolean
attachedFileIDstring or null(uuid)
ownerIDstring(uuid)
descriptionstring or null
fileDatastring or null
isPictureboolean
originalFilestring or null
imageURLstring or null
mimeTypestring or null

Content type of the file that is being used on upload of an image.

This is expected to be blank when it is coming from the database.

Response
application/json
{
  "placement": 0,
  "rowDeleted": true,
  "attachedFileID": "c1e2a223-7d63-43d0-bb89-e518e85ce912",
  "ownerID": "4d1ec274-d781-4778-8ffc-812e9ab43c0c",
  "description": "string",
  "fileData": "string",
  "isPicture": true,
  "originalFile": "string",
  "imageURL": "string",
  "mimeType": "string"
}

Deletes a recipe's image

Request

Path
recipeIdstring(uuid)required
imageIdstring(uuid)required
curl -i -X DELETE \
  'https://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/recipes/{recipeId}/images/{imageId}' \
  -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
application/json
{
  "message": "string",
  "errors": [
    { … }
  ]
}

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.

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.