Skip to content
/
Gets Third Party Code by...

Fetch API (v3.0: 3.27.0.1)

For differences between versions, see Changelog.

REST API logo

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

Gets all Third Party Codes

Request

Security
Auth API User Token
Query
FilterArray of strings

Filter Options:

  • code
  • type
OrderByArray of strings

Order By Options:

  • code
  • type
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/interfaces/thirdPartyCodes?Filter=string&OrderBy=string&PageNumber=0&PageSize=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
idstring(uuid)

A unique identifier for the TPCode Record

This is autogenerated by Yellow Dog on creation of the record.

typestringnon-emptyrequired

The Type of code being entered. This should be titled specifically for the third party integrator in Pascal case.

A common way to type specifically is to prepend the Type with the name of the integration.

This will be displayed in the Interfaces tab under the Accounting/Other section as "Integration Name Tax Grouping"

codestringnon-emptyrequired

Identifier used by the Integrator to match certain behavior on their side of the integration.

descriptionstringnon-emptyrequired

User friendly description that will be displayed to the user as part of a drop down box titled by the type

storeobject(Api.Models.Dto.TPStore)
]
Response
application/json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "type": "string",
    "code": "string",
    "description": "string",
    "store": { … }
  }
]

Creates Third Party Codes

Request

Security
Auth API User Token
Query
suppressOutputboolean
Default true
Body
Array [
idstring(uuid)

A unique identifier for the TPCode Record

This is autogenerated by Yellow Dog on creation of the record.

typestringnon-emptyrequired

The Type of code being entered. This should be titled specifically for the third party integrator in Pascal case.

A common way to type specifically is to prepend the Type with the name of the integration.

This will be displayed in the Interfaces tab under the Accounting/Other section as "Integration Name Tax Grouping"

codestringnon-emptyrequired

Identifier used by the Integrator to match certain behavior on their side of the integration.

descriptionstringnon-emptyrequired

User friendly description that will be displayed to the user as part of a drop down box titled by the type

storeobject(Api.Models.Dto.GenericObject)
]
curl -i -X POST \
  'https://fetch.yellowdogsoftware.com/api/v3/interfaces/thirdPartyCodes?suppressOutput=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '[
    {
      "type": "ACME_TaxCategory",
      "code": "county",
      "description": "sales tax collected by county",
      "store": {
        "id": "6a5386e3-f6f3-11e3-8ff2-000c29d58da6"
      }
    },
    {
      "type": "ACME_TaxCategory",
      "code": "state",
      "description": "sales tax collected by state",
      "store": {
        "id": "6a5386e3-f6f3-11e3-8ff2-000c29d58da6"
      }
    },
    {
      "type": "ACME_TaxCategory",
      "code": "untaxed",
      "description": "no applicable tax",
      "store": {
        "id": "6a5386e3-f6f3-11e3-8ff2-000c29d58da6"
      }
    }
  ]'

Responses

Received Request with no values in the body.

Response
No content

Updates Third Party Codes

Request

Security
Auth API User Token
Query
suppressOutputboolean
Default true
Body
Array [
idstring(uuid)

A unique identifier for the TPCode Record

This is autogenerated by Yellow Dog on creation of the record.

typestringnon-emptyrequired

The Type of code being entered. This should be titled specifically for the third party integrator in Pascal case.

A common way to type specifically is to prepend the Type with the name of the integration.

This will be displayed in the Interfaces tab under the Accounting/Other section as "Integration Name Tax Grouping"

codestringnon-emptyrequired

Identifier used by the Integrator to match certain behavior on their side of the integration.

descriptionstringnon-emptyrequired

User friendly description that will be displayed to the user as part of a drop down box titled by the type

storeobject(Api.Models.Dto.GenericObject)
]
curl -i -X PUT \
  'https://fetch.yellowdogsoftware.com/api/v3/interfaces/thirdPartyCodes?suppressOutput=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '[
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "type": "string",
      "code": "string",
      "description": "string",
      "store": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    }
  ]'

Responses

Returns the updated ThirdPartyCodes, if suppressOutput parameter is set to false.

Bodyapplication/jsonArray [
idstring(uuid)

A unique identifier for the TPCode Record

This is autogenerated by Yellow Dog on creation of the record.

typestringnon-emptyrequired

The Type of code being entered. This should be titled specifically for the third party integrator in Pascal case.

A common way to type specifically is to prepend the Type with the name of the integration.

This will be displayed in the Interfaces tab under the Accounting/Other section as "Integration Name Tax Grouping"

codestringnon-emptyrequired

Identifier used by the Integrator to match certain behavior on their side of the integration.

descriptionstringnon-emptyrequired

User friendly description that will be displayed to the user as part of a drop down box titled by the type

storeobject(Api.Models.Dto.TPStore)
]
Response
application/json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "type": "string",
    "code": "string",
    "description": "string",
    "store": { … }
  }
]

Bulk delete Third Party Codes

Request

Security
Auth API User Token
Query
suppressOutputboolean
Default true
Body
Array [
string(uuid)
]
curl -i -X DELETE \
  'https://fetch.yellowdogsoftware.com/api/v3/interfaces/thirdPartyCodes?suppressOutput=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '[
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ]'

Responses

OK

Response
No content

Gets Third Party Code by Id

Request

Security
Auth API User Token
Path
idstring(uuid)required
curl -i -X GET \
  'https://fetch.yellowdogsoftware.com/api/v3/interfaces/thirdPartyCodes/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
idstring(uuid)

A unique identifier for the TPCode Record

This is autogenerated by Yellow Dog on creation of the record.

typestringnon-emptyrequired

The Type of code being entered. This should be titled specifically for the third party integrator in Pascal case.

A common way to type specifically is to prepend the Type with the name of the integration.

This will be displayed in the Interfaces tab under the Accounting/Other section as "Integration Name Tax Grouping"

codestringnon-emptyrequired

Identifier used by the Integrator to match certain behavior on their side of the integration.

descriptionstringnon-emptyrequired

User friendly description that will be displayed to the user as part of a drop down box titled by the type

storeobject(Api.Models.Dto.TPStore)
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "type": "string",
  "code": "string",
  "description": "string",
  "store": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "code": "string",
    "name": "string"
  }
}

Deleting a Third Party Code

Request

Security
Auth API User Token
Path
idstring(uuid)required

Third Party Code Id

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

Responses

OK

Response
No content

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