Requests

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

Requests

A requisition for purchasing or transfering an item.

Operations

Creates and commits a Request to be used in the Purchasing Document Workflow.

Request

Body

Object of the Request to be created

linesArray of objects or null(Api.Models.Dto.FetchAPICommdocLine)
doCommitboolean
RequestTypestring or null

Valid Request Types: "Purchase", "Transfer", null

commitboolean
idstring(uuid)
thirdPartyIDstring or null
docNumberstring or null
referencestring or null
descriptionstring or null
instructionsstring or null
totalAmountnumber(double)
createdstring(date-time)
lastUpdatedstring(date-time)
vendorstring or null
createdByUserstring or null
notesstring or null
storestring or null
committedstring or null(date-time)
committedByUserstring or null
needBystring or null(date-time)
curl -i -X POST \
  https://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/requests \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "lines": [
      {
        "commdocLineID": "9cb09c6a-a112-4d73-94fe-fbd96496e1dd",
        "commdocID": "cb99375d-6433-4b86-97cb-443f2b96b6b7",
        "backLinkLineID": "6e13b4f1-3f38-4d49-a5c5-95b5e01905d0",
        "itemID": "f1f85a48-b9b1-447d-a06c-c1acf57ed3a8",
        "vendorPrice": 0,
        "lastVendorPrice": 0,
        "quantity": 0,
        "lineNumber": 0,
        "notes": "string",
        "converted": "string",
        "computedCost": 0,
        "rowDeleted": true
      }
    ],
    "doCommit": true,
    "RequestType": "string",
    "commit": true,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "thirdPartyID": "string",
    "docNumber": "string",
    "reference": "string",
    "description": "string",
    "instructions": "string",
    "totalAmount": 0.1,
    "created": "2019-08-24T14:15:22Z",
    "lastUpdated": "2019-08-24T14:15:22Z",
    "vendor": "string",
    "createdByUser": "string",
    "notes": "string",
    "store": "string",
    "committed": "2019-08-24T14:15:22Z",
    "committedByUser": "string",
    "needBy": "2019-08-24T14:15:22Z"
  }'

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 response example

Commits a Request, this allows the Request to be used in future steps of the Purchasing Document Workflow

Request

Path
idstring(uuid)required

CommDoc Id of Request

curl -i -X PATCH \
  'https://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/requests/{id}/Commit' \
  -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 response example

Getting Request Details By ID

Request

Path
idstring(uuid)required

CommDoc ID of Request

Query
PageNumberinteger(int32)
  • PageNumber Starts at 1
PageSizeinteger(int32)
  • Default page size: 100
  • Max page size: 500
curl -i -X GET \
  'https://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/requests/{id}?PageNumber=0&PageSize=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
idstring or nullread-only
codestring or nullread-only
descriptionstring or nullread-only
dueAtstring or null(date-time)read-only
instructionsstring or nullread-only
notesstring or nullread-only
referencestring or nullread-only
requestedAtstring or null(date-time)read-only
createdAtstring(date-time)read-only
statusinteger(int32)(Dingo.GraphQL.RequestStatus)
Enum0123456789
storeobject(Dingo.GraphQL.IGetMyRequest_Me_Request_Store)
requestorobject(Dingo.GraphQL.IGetMyRequest_Me_Request_Requestor)
requestTypeinteger(int32)(Dingo.GraphQL.YdRequestType)
Enum012
linesobject(Dingo.GraphQL.IGetMyRequest_Me_Request_Lines)
Response
application/json
{
  "id": "string",
  "code": "string",
  "description": "string",
  "dueAt": "2019-08-24T14:15:22Z",
  "instructions": "string",
  "notes": "string",
  "reference": "string",
  "requestedAt": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z",
  "status": 0,
  "store": {
    "code": "string",
    "description": "string",
    "id": "string",
    "requestEmailAddress": "string"
  },
  "requestor": {
    "code": "string",
    "id": "string",
    "name": "string",
    "email": "string"
  },
  "requestType": 0,
  "lines": {
    "id": "string",
    "count": 0,
    "uniqueItemCount": 0,
    "totalQuantity": 0.1,
    "totalVendorPrice": 0.1,
    "nodes": [ … ]
  }
}

Updates an existing Request

Request

Path
idstring(uuid)required

CommDoc Id of Request

Body

Any alterations to the Request

linesArray of objects or null(Api.Models.Dto.FetchAPICommdocLine)
doCommitboolean
RequestTypestring or null

Valid Request Types: "Purchase", "Transfer", null

commitboolean
idstring(uuid)
thirdPartyIDstring or null
docNumberstring or null
referencestring or null
descriptionstring or null
instructionsstring or null
totalAmountnumber(double)
createdstring(date-time)
lastUpdatedstring(date-time)
vendorstring or null
createdByUserstring or null
notesstring or null
storestring or null
committedstring or null(date-time)
committedByUserstring or null
needBystring or null(date-time)
curl -i -X PATCH \
  'https://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/requests/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "lines": [
      {
        "commdocLineID": "9cb09c6a-a112-4d73-94fe-fbd96496e1dd",
        "commdocID": "cb99375d-6433-4b86-97cb-443f2b96b6b7",
        "backLinkLineID": "6e13b4f1-3f38-4d49-a5c5-95b5e01905d0",
        "itemID": "f1f85a48-b9b1-447d-a06c-c1acf57ed3a8",
        "vendorPrice": 0,
        "lastVendorPrice": 0,
        "quantity": 0,
        "lineNumber": 0,
        "notes": "string",
        "converted": "string",
        "computedCost": 0,
        "rowDeleted": true
      }
    ],
    "doCommit": true,
    "RequestType": "string",
    "commit": true,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "thirdPartyID": "string",
    "docNumber": "string",
    "reference": "string",
    "description": "string",
    "instructions": "string",
    "totalAmount": 0.1,
    "created": "2019-08-24T14:15:22Z",
    "lastUpdated": "2019-08-24T14:15:22Z",
    "vendor": "string",
    "createdByUser": "string",
    "notes": "string",
    "store": "string",
    "committed": "2019-08-24T14:15:22Z",
    "committedByUser": "string",
    "needBy": "2019-08-24T14:15:22Z"
  }'

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 response example

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.