Stores
/
Gets a Store's ThirdPartyCodes

Fetch API (v3.0: 3.22.2.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
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

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

Gets Stores

Request

Query
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
FilterArray of strings
OrderByArray of strings
curl -i -X GET \
  'https://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/stores?Expand=string&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 Store; always unique; formatted as GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)

codestring or null

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

namestring or null

Name of the store

noOnHandboolean

on hand counts are allowed or not allowed in the store (used for stores that are only transfer destinations to relieve inventory from another store)

revenueCenterstring or null

Code generated by the Point of Sale that is used to map transaction and adjustment data

notesstring or null

User-defined notes about the store

createdstring(date-time)

The date the store was created in Yellow Dog Inventory

accountingIDstring or null

Free text field used for identifying what the id for this store is in an accounting system. This is found in the Store Editor as the field called Accounting ID

companyIDstring or null

Free text field used for identifying what the ID of the company is. This is found in the Store Editor as the field called CompanyID.

]
Response
application/json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "code": "string",
    "name": "string",
    "noOnHand": true,
    "revenueCenter": "string",
    "notes": "string",
    "created": "2019-08-24T14:15:22Z",
    "accountingID": "string",
    "companyID": "string"
  }
]

Gets Store by Id

Request

Path
idstring(uuid)required

Store Id

Query
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
FilterArray of strings
OrderByArray of strings
curl -i -X GET \
  'https://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/stores/{id}?Expand=string&Filter=string&OrderBy=string&PageNumber=0&PageSize=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
idstring(uuid)

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

codestring or null

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

namestring or null

Name of the store

noOnHandboolean

on hand counts are allowed or not allowed in the store (used for stores that are only transfer destinations to relieve inventory from another store)

revenueCenterstring or null

Code generated by the Point of Sale that is used to map transaction and adjustment data

notesstring or null

User-defined notes about the store

createdstring(date-time)

The date the store was created in Yellow Dog Inventory

accountingIDstring or null

Free text field used for identifying what the id for this store is in an accounting system. This is found in the Store Editor as the field called Accounting ID

companyIDstring or null

Free text field used for identifying what the ID of the company is. This is found in the Store Editor as the field called CompanyID.

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "code": "string",
  "name": "string",
  "noOnHand": true,
  "revenueCenter": "string",
  "notes": "string",
  "created": "2019-08-24T14:15:22Z",
  "accountingID": "string",
  "companyID": "string"
}

Gets Items for a Specific Store

Request

The expected body payload change between the items endpoint and the stores items endpoint (this) is best described though the following examples. Note that by using this endpoint it will bring only the items that are available to this store and only include this store in the expanded stores section of the item.

/api/v2/items? Expand = Stores + filter = lastUpdated >= 2023 - 10 - 30T17:12:12.009Z

   	[
   	  {
   "id": "35542435-cf86-11eb-b6e8-8cae4ce6cd26",
   "description": "tesssst",
   "posDescription1": "tesssst",
   "posDescription2": null,
   "sku": "000000000471",
   "noCount": false,
   "shippingWeight": 0.0,
   "shippingHeight": 0.0,
   "shippingWidth": 0.0,
   "shippingLength": 0.0,
   "uom": null,
   "childCount": 1.0,
   "childUsage": 100.0,
   "upc": [],
   "active": true,
   "lastUpdated": "2023-10-30T17:12:12.009Z",
   "dimension1": null,
   "dimension2": null,
   "dimension3": null,
   "dimension4": null,
   "dimension5": null,
   "dimension6": null,
   "dimension7": null,
   "dimension8": null,
   "dimension9": null,
   "dimension10": null,
   "level": {
     "id": "07ab7a19-a9ea-11e3-9931-002590a52022",
     "code": "00010",
     "description": "RESTAURANT"
   },
   "level1": {
     "id": "07ab7a19-a9ea-11e3-9931-002590a52022",
     "code": "00010",
     "description": "RESTAURANT"
   },
   "level2": {
     "id": "00000000-0000-0000-0000-000000000000",
     "code": "",
     "description": ""
   },
   "level3": {
     "id": "00000000-0000-0000-0000-000000000000",
     "code": "",
     "description": ""
   },
   "level4": {
     "id": "00000000-0000-0000-0000-000000000000",
     "code": "",
     "description": ""
   },
   "parentItem": null,
   "recipe": null,
   "matrix": null,
   "webProperties": null,
   "stores": [
     {
       "id": "140e0635-b934-11e3-be42-002590a52022",
       "bin": null,
       "reorderPoint": 0.0,
       "parLevel": 0.0,
       "tariffCode": null,
       "description": "Mordor",
       "code": "1",
       "revenueCenterNumber": "1",
       "onHand": 0.0,
       "retailPrice1": 0.0,
       "retailPrice2": 0.0,
       "retailPrice3": 0.0,
       "retailPrice4": 0.0,
       "retailPrice5": 0.0,
       "retailPrice6": 0.0,
       "retailPrice7": 0.0,
       "retailPrice8": 0.0,
       "retailPrice9": 0.0,
       "retailPrice10": 0.0,
       "flags": [],
       "interfaces": {
         "AccountingGroup": "100",
         "COGS": "Food",
         "MicrosClass": "101",
         "MicrosCondimentsAllowed": "1001",
         "MicrosFamily": "301",
         "MicrosItemGroup": "101",
         "MicrosLevelClass": "999",
         "MicrosMajor": "101",
         "MicrosNLUGroup": "10",
         "MicrosPrintClass": "101",
         "Publish": "1",
         "RevenueCenter": "1",
         "StartingNumber": "950001",
         "GenericCodeA": "",
         "GenericCodeB": "",
         "GenericCodeC": "",
         "GenericCodeD": "",
         "GenericCodeE": "",
         "GenericCodeF": "",
         "GenericCodeG": "",
         "GenericLevelA": "",
         "GenericLevelB": "",
         "GenericLevelC": "",
         "ItemNumber": ""
       }
     }
   ],
 },
 {
   "id": "c81f9a9f-985e-11eb-b6e6-d89c672bbc04",
   "bin": null,
   "reorderPoint": 0.0,
   "parLevel": 0.0,
   "tariffCode": null,
   "description": "The Shire",
   "code": "11",
   "revenueCenterNumber": "1",
   "onHand": 0.0,
   "retailPrice1": 0.0,
   "retailPrice2": 0.0,
   "retailPrice3": 0.0,
   "retailPrice4": 0.0,
   "retailPrice5": 0.0,
   "retailPrice6": 0.0,
   "retailPrice7": 0.0,
   "retailPrice8": 0.0,
   "retailPrice9": 0.0,
   "retailPrice10": 0.0,
   "flags": [],
   "interfaces": {
   	"AccountingGroup": "",
     "GenericCodeA": "",
     "GenericCodeB": "",
     "GenericCodeC": "",
     "GenericCodeD": "",
     "GenericCodeE": "",
     "GenericCodeF": "",
     "GenericCodeG": "",
     "GenericLevelA": "",
     "GenericLevelB": "",
     "GenericLevelC": "",
     "ItemNumber": "",
     "Publish": ""

   	},

   }
]

pulling a single store at a time /api/v2/stores/c81f9a9f-985e-11eb-b6e6-d89c672bbc04/items?Expand=Stores+filter=lastUpdated>=2023-10-30T17:12:12.009Z

[
 {
   "id": "35542435-cf86-11eb-b6e8-8cae4ce6cd26",
   "description": "tesssst",
   "posDescription1": "tesssst",
   "posDescription2": null,
   "sku": "000000000471",
   "noCount": false,
   "shippingWeight": 0,
   "shippingHeight": 0,
   "shippingWidth": 0,
   "shippingLength": 0,
   "uom": null,
   "childCount": 1,
   "childUsage": 100,
   "upc": [],
   "active": true,
   "lastUpdated": "2023-10-30T17:12:12.009Z",
   "dimension1": null,
   "dimension2": null,
   "dimension3": null,
   "dimension4": null,
   "dimension5": null,
   "dimension6": null,
   "dimension7": null,
   "dimension8": null,
   "dimension9": null,
   "dimension10": null,
   "level": {
     "id": "07ab7a19-a9ea-11e3-9931-002590a52022",
     "code": "00010",
     "description": "RESTAURANT"
   },
   "level1": {
     "id": "07ab7a19-a9ea-11e3-9931-002590a52022",
     "code": "00010",
     "description": "RESTAURANT"
   },
   "level2": {
     "id": "00000000-0000-0000-0000-000000000000",
     "code": "",
     "description": ""
   },
   "level3": {
     "id": "00000000-0000-0000-0000-000000000000",
     "code": "",
     "description": ""
   },
   "level4": {
     "id": "00000000-0000-0000-0000-000000000000",
     "code": "",
     "description": ""
   },
   "parentItem": null,
   "recipe": null,
   "matrix": null,
   "webProperties": null,
   "stores": [
     {
       "id": "c81f9a9f-985e-11eb-b6e6-d89c672bbc04",
       "bin": null,
       "reorderPoint": 0,
       "parLevel": 0,
       "tariffCode": null,
       "description": "The Shire",
       "code": "11",
       "revenueCenterNumber": "1",
       "onHand": 0,
       "retailPrice1": 0,
       "retailPrice2": 0,
       "retailPrice3": 0,
       "retailPrice4": 0,
       "retailPrice5": 0,
       "retailPrice6": 0,
       "retailPrice7": 0,
       "retailPrice8": 0,
       "retailPrice9": 0,
       "retailPrice10": 0,
       "flags": [],
       "interfaces": {
         "AccountingGroup": "",
         "GenericCodeA": "",
         "GenericCodeB": "",
         "GenericCodeC": "",
         "GenericCodeD": "",
         "GenericCodeE": "",
         "GenericCodeF": "",
         "GenericCodeG": "",
         "GenericLevelA": "",
         "GenericLevelB": "",
         "GenericLevelC": "",
         "ItemNumber": "",
         "Publish": ""
       },
     }
   ],
   "vendors": [],
   "images": [],
   "shortDescription": null,
   "isEvergreen": null,
   "style": null,
   "expirationDays": null,
   "reference": null,
   "attributes": null
 }
]
Path
idstring(uuid)required
Query
FilterArray of strings

Filter Options:

  • active (boolean: when this is not passed in as a filter option it will present both active and non-active Items)
  • lastUpdated (DateTime in v2, DateTimeOffset in v3: See Differences between v2 and v3 in Getting Started Section for more information)
  • levelId (UUID: This is the items level.id property for requesting only a certain type of item)
  • sku (string: When passed in it will allow lookup of an item using the Item's sku)
  • webAvailable (boolean: when this is not passed in as a filter option it will present both true and false values)
ExpandArray of strings

Expand Options:

  • stores
  • vendors
  • images (available on database versions above 366)
  • extended-item (shortDescription, isEvergreen, style, expirationDays, reference, attributes, etc...)
OrderByArray of strings

Order By Options:

  • sku
  • description
  • itemId
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://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/stores/{id}/items?Expand=string&Filter=string&OrderBy=string&PageNumber=0&PageSize=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
idstring(uuid)required

Yellow Dog's primary key for the Item; always unique. When pushing items to the API, if an ItemID is present, Yellow Dog will update or create an item. If ItemID is not present, Yellow Dog will create an item and provide the ItemID in response. ItemID is formatted as a GUID (example: 433ef432-f63e-4c26-a29f-39d4079d9fc9)

descriptionstring or null

Main item description in Yellow Dog

posDescription1string or null

Shorter item description for POS terminals; usually limited to 16 characters

posDescription2string or null

Shorter item description for POS terminals; usually limited to 12 characters

skustring or null

Main number associated with the item in the Yellow Dog UI; auto generated by Yellow Dog when the item is created; unique per database

noCountboolean

When true, this item's on hand will always report as zero, and no costs or inventory adjustments will be stored.

shippingWeightnumber(double)

Shipping Weight of the item. The unit of measure is not specified; this field contains a number only.

shippingHeightnumber(double)

Shipping Height of the item. The unit of measure is not specified; this field contains a number only.

shippingWidthnumber(double)

Shipping Width of the item. The unit of measure is not specified; this field contains a number only.

shippingLengthnumber(double)

Shipping Length of the item. The unit of measure is not specified; this field contains a number only.

uomstring or null

Unit of Measure; additional text field used to describe the way an item is measured; not often used because we use Dimension 1 for item size

childCountnumber(double)

Set how much the parent the Child Item of a Parent/Child relationship. Examples:

  • Parent Child where the Parent is an Each and the Child is a 2 Pack of the Parent the childCount is .5 (1/2).
  • Parent Child where the Parent is an Each and the Child is a Case Size of 24 the childCount is 0.041666666667 (1/24)
childUsagenumber(double)

This is the expected usage amount of a child item. This should be the decimal representation of the percentage.This defaults to 1.0 (100%)

upcArray of strings or nullread-only
activeboolean

True=Item is active in Yellow Dog; False=Item is inactive in Yellow Dog; inactive items can have an on hand count, but are not sold at the POS; this is generally used for seasonal or special event items that are only sold at specific times

lastUpdatedstring or null(date-time)

DateTime when this item was last updated in Yellow Dog, in ISO 8601 format. This is not impacted by changes of an Item's onhand value. This is used to indicate when a change to an items configuration has been adjusted.

Example Scenarios that would trigger a lastUpdated value change:

  • Changing an Item's Dimension
  • Making an Item available to a Store
  • Adjusting the Item's Retail Price for a Store
  • Adjusting the Item's Default Retail Price
  • Changing the Item's Level Assignment
  • Adjusting an Interface for an Item's Store

Example Scenarios that would not trigger a lastUpdated value change:

  • Item being Sold as part of a Transaction
  • Item included on an Invoice, Receipt, Purchasing Order Document
dimension1object(Api.Models.Dto.Item.ItemDimension)
dimension2object(Api.Models.Dto.Item.ItemDimension)
dimension3object(Api.Models.Dto.Item.ItemDimension)
dimension4object(Api.Models.Dto.Item.ItemDimension)
dimension5object(Api.Models.Dto.Item.ItemDimension)
dimension6object(Api.Models.Dto.Item.ItemDimension)
dimension7object(Api.Models.Dto.Item.ItemDimension)
dimension8object(Api.Models.Dto.Item.ItemDimension)
dimension9object(Api.Models.Dto.Item.ItemDimension)
dimension10object(Api.Models.Dto.Item.ItemDimension)
levelobject(Api.Models.Dto.Item.ItemLevel)

Level is a hierarchy of groupings that are used for reporting and third party interface purposes

level1object(Api.Models.Dto.Item.ItemLevel)

Level is a hierarchy of groupings that are used for reporting and third party interface purposes

level2object(Api.Models.Dto.Item.ItemLevel)

Level is a hierarchy of groupings that are used for reporting and third party interface purposes

level3object(Api.Models.Dto.Item.ItemLevel)

Level is a hierarchy of groupings that are used for reporting and third party interface purposes

level4object(Api.Models.Dto.Item.ItemLevel)

Level is a hierarchy of groupings that are used for reporting and third party interface purposes

parentItemobject(Api.Models.Dto.GenericObject)
recipeobject(Api.Models.Dto.GenericObject)
matrixobject(Api.Models.Dto.GenericObject)
webPropertiesobject(Api.Models.Dto.Item.WebProperties)
storesArray of objects or null(Api.Models.Dto.Item.Item2StoreGet)

Items have specific store availability and can have different on hand counts, retail prices, and costs per store

This is only available when expand vendors is passed in the query string. example: /items?Expand=Stores

vendorsArray of objects or null(Api.Models.Dto.Item.Item2VendorGet)

Items are assigned to at least one specific vendor in Yellow Dog.

This is only available when expand vendors is passed in the query string. example: /items?Expand=Vendors

imagesArray of objects or null(Api.Models.Dto.Item.ItemImage)
shortDescriptionstring or null

Short Description of the item; this is a free form text field that should describe the item in less characters than the item.Description.

This is commonly used for smaller screen devices or when a more concise description is needed.

This value is only available when the expand option extended-item is passed in the query string example: /items?Expand=extended-item

isEvergreenboolean or null

Evergreen items are items that do not expire or do not "Age". This indicator is used to help manage the items that are always good for inventory or do not turn by season/year.

This value is only available when the expand option extended-item is passed in the query string example: /items?Expand=extended-item

stylestring or null

Style code of the item. This is used to group like items together, such as a matrix of shirts that all have the same Style code/number.

This value is only available when the expand option extended-item is passed in the query string example: /items?Expand=extended-item

expirationDaysnumber or null(double)

Generally, how many days before this type of item expires once added to inventory.

This value is only available when the expand option extended-item is passed in the query string example: /items?Expand=extended-item

referencestring or null

Free text field for additional reference notes or identifiers. Reference has no specific business use within YDI. Use this field to record other necessary, customer-specific information.

This value is only available when the expand option extended-item is passed in the query string example: /items?Expand=extended-item

attributesstring or null

This value is only available when the expand option extended-item is passed in the query string example: /items?Expand=extended-item

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "description": "string",
  "posDescription1": "string",
  "posDescription2": "string",
  "sku": "string",
  "noCount": true,
  "shippingWeight": 0.1,
  "shippingHeight": 0.1,
  "shippingWidth": 0.1,
  "shippingLength": 0.1,
  "uom": "string",
  "childCount": 0.1,
  "childUsage": 0.1,
  "upc": [
    "string"
  ],
  "active": true,
  "lastUpdated": "2019-08-24T14:15:22Z",
  "dimension1": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "description": "string"
  },
  "dimension2": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "description": "string"
  },
  "dimension3": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "description": "string"
  },
  "dimension4": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "description": "string"
  },
  "dimension5": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "description": "string"
  },
  "dimension6": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "description": "string"
  },
  "dimension7": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "description": "string"
  },
  "dimension8": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "description": "string"
  },
  "dimension9": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "description": "string"
  },
  "dimension10": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "description": "string"
  },
  "level": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "code": "string",
    "description": "string"
  },
  "level1": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "code": "string",
    "description": "string"
  },
  "level2": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "code": "string",
    "description": "string"
  },
  "level3": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "code": "string",
    "description": "string"
  },
  "level4": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "code": "string",
    "description": "string"
  },
  "parentItem": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "recipe": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "matrix": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "webProperties": {
    "title": "string",
    "description": "string",
    "extendedDescription": "string",
    "availableDate": "2019-08-24T14:15:22Z",
    "expiresDate": "2019-08-24T14:15:22Z",
    "sale": true,
    "itemSaleRetail": 0,
    "itemSalePercentOff": 0,
    "saleBegins": "2019-08-24T14:15:22Z",
    "saleEnds": "2019-08-24T14:15:22Z",
    "available": true,
    "flagA": true,
    "flagB": true,
    "flagC": true,
    "tags": "string",
    "productType": "string"
  },
  "stores": [
    { … }
  ],
  "vendors": [
    { … }
  ],
  "images": [
    { … }
  ],
  "shortDescription": "string",
  "isEvergreen": true,
  "style": "string",
  "expirationDays": 0,
  "reference": "string",
  "attributes": "string"
}

Gets a Store's ThirdPartyCodes

Request

Path
idstring(uuid)required

Store Id

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://developer.yellowdogsoftware.com/_mock/fetch/api/api/v3/stores/{id}/interfaces/ThirdPartyCodes?Filter=string&OrderBy=string&PageNumber=0&PageSize=0' \
  -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"
  }
}

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