Skip to content

Fetch API (v3.0: 3.25.0.4)

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

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

Getting Vendors

Request

Security
Auth API User Token
Query
FilterArray of strings

Filter Options:

  • code
  • description
  • url
  • collectsTax
  • notes
  • created
  • lastUpdated
OrderByArray of strings

Order By Options:

  • code
  • created
  • lastUpdated
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://fetch.yellowdogsoftware.com/api/v3/vendors?Filter=string&OrderBy=string&PageNumber=0&PageSize=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
idstring(uuid)

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

codestring or null

Main number associated with the vendor in the Yellow Dog UI; unique per database

descriptionstring or null

Main vendor description in Yellow Dog

urlstring or null

Vendors URL

collectsTaxboolean

Does the Vendor collect tax or not

notesstring or null

Additional about the vendor

approvedboolean

Is the vendor approved to be used by certain users/stores

currencyCodestring or null
createdstring(date-time)

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

lastUpdatedstring(date-time)
orderFromobject(Api.Models.Dto.VendorContact)
returnToobject(Api.Models.Dto.VendorContact)
storesArray of objects or null(Api.Models.Dto.Vendor2Store)
]
Response
application/json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "code": "string",
    "description": "string",
    "url": "string",
    "collectsTax": true,
    "notes": "string",
    "approved": true,
    "currencyCode": "string",
    "created": "2019-08-24T14:15:22Z",
    "lastUpdated": "2019-08-24T14:15:22Z",
    "orderFrom": { … },
    "returnTo": { … },
    "stores": [ … ]
  }
]

Creating new Vendors

Request

Security
Auth API User Token
Body

Object Used to Create Vendors

Array [
codestring[ 0 .. 256 ] charactersrequired

Main number associated with the vendor in the Yellow Dog UI; unique per database

descriptionstring[ 0 .. 256 ] charactersrequired

Main vendor description in Yellow Dog

urlstring or null[ 0 .. 256 ] characters

Vendors URL

collectsTaxboolean

Does the Vendor collect tax or not

notesstring or null

Additional about the vendor

approvedboolean

Is the vendor approved to be used by certain users/stores

currencyCodestring or null[ 0 .. 256 ] characters
orderFromobject(Api.Models.Dto.VendorContact)
returnToobject(Api.Models.Dto.VendorContact)
storesArray of objects or null(Api.Models.Dto.Vendor2Store)
]
curl -i -X POST \
  https://fetch.yellowdogsoftware.com/api/v3/vendors \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '[
    {
      "code": "string",
      "description": "string",
      "url": "string",
      "collectsTax": true,
      "notes": "string",
      "approved": true,
      "currencyCode": "string",
      "orderFrom": {
        "contact": "string",
        "phone": "string",
        "fax": "string",
        "mobile": "string",
        "email": "string",
        "street": "string",
        "city": "string",
        "state": "string",
        "zip": "string",
        "country": "string",
        "other": "string"
      },
      "returnTo": {
        "contact": "string",
        "phone": "string",
        "fax": "string",
        "mobile": "string",
        "email": "string",
        "street": "string",
        "city": "string",
        "state": "string",
        "zip": "string",
        "country": "string",
        "other": "string"
      },
      "stores": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "available": true,
          "accountingId": "string",
          "taxNumber": "string",
          "terms": "string",
          "reference": "string"
        }
      ]
    }
  ]'

Responses

OK

Bodyapplication/jsonArray [
idstring(uuid)

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

codestring or null

Main number associated with the vendor in the Yellow Dog UI; unique per database

descriptionstring or null

Main vendor description in Yellow Dog

urlstring or null

Vendors URL

collectsTaxboolean

Does the Vendor collect tax or not

notesstring or null

Additional about the vendor

approvedboolean

Is the vendor approved to be used by certain users/stores

currencyCodestring or null
createdstring(date-time)

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

lastUpdatedstring(date-time)
orderFromobject(Api.Models.Dto.VendorContact)
returnToobject(Api.Models.Dto.VendorContact)
storesArray of objects or null(Api.Models.Dto.Vendor2Store)
]
Response
application/json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "code": "string",
    "description": "string",
    "url": "string",
    "collectsTax": true,
    "notes": "string",
    "approved": true,
    "currencyCode": "string",
    "created": "2019-08-24T14:15:22Z",
    "lastUpdated": "2019-08-24T14:15:22Z",
    "orderFrom": { … },
    "returnTo": { … },
    "stores": [ … ]
  }
]

Updating existing Vendors

Request

If the stores array is null or empty, then Store associations will not be updated. If you want to set the availability of a store for a given vendor, add elements to the stores field, with the Available value set.

Security
Auth API User Token
Body

Object Used to update an existing Vendors

Array [
idstring(uuid)required

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

codestring[ 0 .. 256 ] charactersrequired

Main number associated with the vendor in the Yellow Dog UI; unique per database

descriptionstring[ 0 .. 256 ] charactersrequired

Main vendor description in Yellow Dog

urlstring or null[ 0 .. 256 ] characters

Vendors URL

collectsTaxboolean

Does the Vendor collect tax or not

notesstring or null

Additional about the vendor

approvedboolean

Is the vendor approved to be used by certain users/stores

currencyCodestring or null[ 0 .. 256 ] characters
orderFromobject(Api.Models.Dto.VendorContact)
returnToobject(Api.Models.Dto.VendorContact)
storesArray of objects or null(Api.Models.Dto.Vendor2Store)
]
curl -i -X PUT \
  https://fetch.yellowdogsoftware.com/api/v3/vendors \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '[
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "code": "string",
      "description": "string",
      "url": "string",
      "collectsTax": true,
      "notes": "string",
      "approved": true,
      "currencyCode": "string",
      "orderFrom": {
        "contact": "string",
        "phone": "string",
        "fax": "string",
        "mobile": "string",
        "email": "string",
        "street": "string",
        "city": "string",
        "state": "string",
        "zip": "string",
        "country": "string",
        "other": "string"
      },
      "returnTo": {
        "contact": "string",
        "phone": "string",
        "fax": "string",
        "mobile": "string",
        "email": "string",
        "street": "string",
        "city": "string",
        "state": "string",
        "zip": "string",
        "country": "string",
        "other": "string"
      },
      "stores": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "available": true,
          "accountingId": "string",
          "taxNumber": "string",
          "terms": "string",
          "reference": "string"
        }
      ]
    }
  ]'

Responses

OK

Bodyapplication/jsonArray [
idstring(uuid)

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

codestring or null

Main number associated with the vendor in the Yellow Dog UI; unique per database

descriptionstring or null

Main vendor description in Yellow Dog

urlstring or null

Vendors URL

collectsTaxboolean

Does the Vendor collect tax or not

notesstring or null

Additional about the vendor

approvedboolean

Is the vendor approved to be used by certain users/stores

currencyCodestring or null
createdstring(date-time)

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

lastUpdatedstring(date-time)
orderFromobject(Api.Models.Dto.VendorContact)
returnToobject(Api.Models.Dto.VendorContact)
storesArray of objects or null(Api.Models.Dto.Vendor2Store)
]
Response
application/json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "code": "string",
    "description": "string",
    "url": "string",
    "collectsTax": true,
    "notes": "string",
    "approved": true,
    "currencyCode": "string",
    "created": "2019-08-24T14:15:22Z",
    "lastUpdated": "2019-08-24T14:15:22Z",
    "orderFrom": { … },
    "returnTo": { … },
    "stores": [ … ]
  }
]

Bulk delete Vendors

Request

Security
Auth API User Token
Body

List of Vendor Ids to be deleted

Array [
string(uuid)
]
curl -i -X DELETE \
  https://fetch.yellowdogsoftware.com/api/v3/vendors \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '[
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ]'

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

Getting Vendor by Id

Request

Security
Auth API User Token
Path
idstring(uuid)required

Vendor Id

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

Responses

OK

Bodyapplication/json
idstring(uuid)

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

codestring or null

Main number associated with the vendor in the Yellow Dog UI; unique per database

descriptionstring or null

Main vendor description in Yellow Dog

urlstring or null

Vendors URL

collectsTaxboolean

Does the Vendor collect tax or not

notesstring or null

Additional about the vendor

approvedboolean

Is the vendor approved to be used by certain users/stores

currencyCodestring or null
createdstring(date-time)

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

lastUpdatedstring(date-time)
orderFromobject(Api.Models.Dto.VendorContact)
returnToobject(Api.Models.Dto.VendorContact)
storesArray of objects or null(Api.Models.Dto.Vendor2Store)
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "code": "string",
  "description": "string",
  "url": "string",
  "collectsTax": true,
  "notes": "string",
  "approved": true,
  "currencyCode": "string",
  "created": "2019-08-24T14:15:22Z",
  "lastUpdated": "2019-08-24T14:15:22Z",
  "orderFrom": {
    "contact": "string",
    "phone": "string",
    "fax": "string",
    "mobile": "string",
    "email": "string",
    "street": "string",
    "city": "string",
    "state": "string",
    "zip": "string",
    "country": "string",
    "other": "string"
  },
  "returnTo": {
    "contact": "string",
    "phone": "string",
    "fax": "string",
    "mobile": "string",
    "email": "string",
    "street": "string",
    "city": "string",
    "state": "string",
    "zip": "string",
    "country": "string",
    "other": "string"
  },
  "stores": [
    { … }
  ]
}

Deleting a Vendor

Request

Security
Auth API User Token
Path
idstring(uuid)required

Vendor Id

curl -i -X DELETE \
  'https://fetch.yellowdogsoftware.com/api/v3/vendors/{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 content