ThirdParty

Fetch API (v3.0: 3.23.1.1)

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

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

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

Upserts Third Party Items (TPItems) in bulk

Request

This endpoint allows for bulk upserting of TPItems.

Creating a TPItems

The fields that are required to create a TPLocation are type and code

Updating a TPItems

include the query parameter, upsert=true

When a validation error occurs, the entire request will fail.

Additional Notes

Processing the item changes can take up to 10 minutes to process due to the amount of background processing that needs to be done.

Path
syncIdstring(uuid)required
Query
upsertboolean
Body
Array [
typestring or null

arbitrary item type from the third party

codestring or null
alternateCodestring or null
descriptionstring or null
canMapToRecipesboolean or null
canMapToTransactionsboolean or null
parentCodestring or null

Third Party's code for parent Third Party Item of this Third Party Item

]
curl -i -X POST \
  'https://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/third-party/{syncId}/items?upsert=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '[
    {
      "type": "string",
      "code": "string",
      "alternateCode": "string",
      "description": "string",
      "canMapToRecipes": true,
      "canMapToTransactions": true,
      "parentCode": "string"
    }
  ]'

Responses

Created

Body
Array [
idinteger or null(int32)read-only
codestring or nullread-only
typestring or nullread-only

arbitrary item type from the third party

descriptionstring or nullread-only
createdAtstring(date-time)read-only
updatedAtstring(date-time)read-only
canMapToRecipesbooleanread-only
canMapToTransactionsbooleanread-only
syncConfigobject(Dingo.GraphQL.ICreateTPItems_CreateThirdPartyItems_SyncConfig)
]
Response
No response example

Upserts Third Party Locations (TPLocations) in bulk

Request

This endpoint allows for bulk upserting of TPLocations.

Creating a TPLocations

The fields that are required to create a TPLocation are type and code

Updating a TPLocations

include the query parameter, upsert=true

When a validation error occurs, the entire request will fail.

Path
syncIdstring(uuid)required
Query
upsertboolean
Body
Array [
typestring or null
codestring or null
descriptionstring or null
parentCodestring or null

Third Party's code for parent location of this location

alternateCodestring or null
storeIdstring or null

YD Store ID

storeCodestring or null

YD Store Code for use with Import TP Locations

]
curl -i -X POST \
  'https://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/third-party/{syncId}/locations?upsert=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '[
    {
      "type": "string",
      "code": "string",
      "description": "string",
      "parentCode": "string",
      "alternateCode": "string",
      "storeId": "string",
      "storeCode": "string"
    }
  ]'

Responses

Created

Body
Array [
idinteger(int32)read-only
codestring or nullread-only
typestring or nullread-only
descriptionstring or nullread-only
createdAtstring(date-time)read-only
updatedAtstring(date-time)read-only
storeobject(Dingo.GraphQL.ICreateThirdPartyLocations_CreateThirdPartyLocations_Store)
syncConfigobject(Dingo.GraphQL.ICreateThirdPartyLocations_CreateThirdPartyLocations_SyncConfig)
]
Response
No response example

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