Recipes

Fetch API (v3.0: 3.24.0.2)

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
https://developer.yellowdogsoftware.com/

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

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

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/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/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/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
No content

Gets Recipes

Request

This endpoint only returns the list of Recipes, without Ingredients, AttachedFiles, and Links. If the ingredients are needed, then make an another API call to GET Recipe By ID with the Expand=Ingredients option. If the attached files are needed, then make an another API call to GET Recipe By ID with the Expand=AttachedFiles option. If the links are needed, then make an another API call to GET Recipe By ID with the Expand=Links option. Multiple expand options can be used. For example: /recipes/:id?Expand=Ingredients&Expand=AttachedFiles&Expand=Links

Query
FilterArray of strings

Filter Options:

  • RecipeTypeID (UUID: This is the GUID of the RecipeType. Use GET RecipeType endpoint to get the GUID of RecipeType.)
  • LastUpdated (DateTime in v2, DateTimeOffset in v3: See Differences between v2 and v3 in Getting Started Section for more information.)
  • ProductionGroupID (UUID: This is the GUID of the ProductionGroup. Use GET ProductionGroup endpoint to get the GUID of ProductionGroup.)
OrderByArray of strings

OrderBy Options:

  • Description (String: This is the description of the Recipe.)
  • rowCreated (DateTime in v2, DateTimeOffset in v3: See Differences between v2 and v3 in Getting Started Section for more information)
  • LastUpdated (DateTime in v2, DateTimeOffset in v3: See Differences between v2 and v3 in Getting Started Section for more information)
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
curl -i -X GET \
  'https://developer.yellowdogsoftware.com/api/v3/recipes?Expand=string&Filter=string&OrderBy=string&PageNumber=0&PageSize=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
recipeIDstring or null(uuid)

Unique ID of the Yellow Dog Recipe; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)

descriptionstring or null

Description of the Recipe.

instructionsstring or null

Instruction of the Recipe.

recipeTypeIDstring or null(uuid)

Unique ID of the Yellow Dog RecipeType; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9) Show which type of recipe this is.

productionGroupIDstring or null(uuid)

Unique ID of the Yellow Dog ProductionGroup; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9) Assign Production Group to set a default value when the recipe is used in the Production Worksheet.

yieldobject(Api.Models.Dto.RecipeYield)
notesstring or null

Notes of the Recipe.

actualPricenumber or null(double)

Actual of the Recipe.

inactiveboolean

Show whether this recipe has been deactivated or not.

rowCreatedstring(date-time)

DateTime when the Recipe was created in Yellow Dog, in ISO 8601 format

lastUpdatedstring(date-time)

DateTime when the Recipe was last updated in Yellow Dog, in ISO 8601 format

]
Response
application/json
[
  {
    "recipeID": "3142c13e-04d8-465e-bca8-dec957ae61dd",
    "description": "string",
    "instructions": "string",
    "recipeTypeID": "b7bcc8c7-8fd3-4289-aa96-ddef2f3d525c",
    "productionGroupID": "f942ae99-5c88-4145-be4f-789be58a28d9",
    "yield": { … },
    "notes": "string",
    "actualPrice": 0,
    "inactive": true,
    "rowCreated": "2019-08-24T14:15:22Z",
    "lastUpdated": "2019-08-24T14:15:22Z"
  }
]

Gets a Recipe By ID

Request

Path
recipeIdstring(uuid)required
Query
ExpandArray of strings

Expand Options:

  • Ingredients
  • AttachedFiles
  • Links
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.

FilterArray of strings
OrderByArray of strings
curl -i -X GET \
  'https://developer.yellowdogsoftware.com/api/v3/recipes/{recipeId}?Expand=string&Filter=string&OrderBy=string&PageNumber=0&PageSize=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
recipeIDstring or null(uuid)

Unique ID of the Yellow Dog Recipe; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)

descriptionstring or null

Description of the Recipe.

instructionsstring or null

Instruction of the Recipe.

recipeTypeIDstring or null(uuid)

Unique ID of the Yellow Dog RecipeType; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9) Show which type of recipe this is.

productionGroupIDstring or null(uuid)

Unique ID of the Yellow Dog ProductionGroup; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9) Assign Production Group to set a default value when the recipe is used in the Production Worksheet.

yieldobject(Api.Models.Dto.RecipeYield)
notesstring or null

Notes of the Recipe.

actualPricenumber or null(double)

Actual of the Recipe.

inactiveboolean

Show whether this recipe has been deactivated or not.

rowCreatedstring(date-time)

DateTime when the Recipe was created in Yellow Dog, in ISO 8601 format

lastUpdatedstring(date-time)

DateTime when the Recipe was last updated in Yellow Dog, in ISO 8601 format

ingredientsobject(Api.Models.Dto.RecipeIngredients)
attachedFilesArray of objects or null(Api.Models.Dto.RecipeAttachedFile)

The list of the files attached to this recipe.

linksArray of objects or null(Api.Models.Dto.RecipeLink)

The list of links included in this recipe.

Response
application/json
{
  "recipeID": "3142c13e-04d8-465e-bca8-dec957ae61dd",
  "description": "string",
  "instructions": "string",
  "recipeTypeID": "b7bcc8c7-8fd3-4289-aa96-ddef2f3d525c",
  "productionGroupID": "f942ae99-5c88-4145-be4f-789be58a28d9",
  "yield": {
    "yieldID": "3f6d5f6b-bfa7-41a3-b80d-6ea7eaed2084",
    "netWeight": 0.1,
    "netWeightUnit": "string",
    "netVolume": 0.1,
    "netVolumeUnit": "string",
    "netPortion": 0.1,
    "netPortionUnit": "string"
  },
  "notes": "string",
  "actualPrice": 0,
  "inactive": true,
  "rowCreated": "2019-08-24T14:15:22Z",
  "lastUpdated": "2019-08-24T14:15:22Z",
  "ingredients": {
    "recipes": [ … ],
    "items": [ … ]
  },
  "attachedFiles": [
    { … }
  ],
  "links": [
    { … }
  ]
}

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