{"items":[{"type":"group","fsPath":"rest/user-guide/index.md","metadata":{"type":"markdown"},"label":"User Guide","link":"/rest/user-guide","routeSlug":"/rest/user-guide","items":[{"type":"link","fsPath":"rest/user-guide/01-authentication/index.md","metadata":{"type":"markdown"},"label":"Authentication","link":"/rest/user-guide/01-authentication","routeSlug":"/rest/user-guide/01-authentication"},{"type":"link","fsPath":"rest/user-guide/02-timestamps/index.md","metadata":{"type":"markdown"},"label":"Timestamps (v2 vs. v3)","link":"/rest/user-guide/02-timestamps","routeSlug":"/rest/user-guide/02-timestamps"},{"type":"link","fsPath":"rest/user-guide/03-rate-limit/index.md","metadata":{"type":"markdown"},"label":"Rate Limit","link":"/rest/user-guide/03-rate-limit","routeSlug":"/rest/user-guide/03-rate-limit"},{"type":"group","fsPath":"rest/user-guide/04-headers-params/index.md","metadata":{"type":"markdown"},"label":"API Headers and Parameters","link":"/rest/user-guide/04-headers-params","routeSlug":"/rest/user-guide/04-headers-params","items":[{"type":"link","fsPath":"rest/user-guide/04-headers-params/req-headers/index.md","metadata":{"type":"markdown"},"label":"Recommended Request Headers","link":"/rest/user-guide/04-headers-params/req-headers","routeSlug":"/rest/user-guide/04-headers-params/req-headers"},{"type":"link","fsPath":"rest/user-guide/04-headers-params/pagination/index.md","metadata":{"type":"markdown"},"label":"Pagination","link":"/rest/user-guide/04-headers-params/pagination","routeSlug":"/rest/user-guide/04-headers-params/pagination"},{"type":"link","fsPath":"rest/user-guide/04-headers-params/filtering/index.md","metadata":{"type":"markdown"},"label":"Filtering Collections","link":"/rest/user-guide/04-headers-params/filtering","routeSlug":"/rest/user-guide/04-headers-params/filtering"},{"type":"link","fsPath":"rest/user-guide/04-headers-params/ordering/index.md","metadata":{"type":"markdown"},"label":"Ordering Collections","link":"/rest/user-guide/04-headers-params/ordering","routeSlug":"/rest/user-guide/04-headers-params/ordering"},{"type":"link","fsPath":"rest/user-guide/04-headers-params/field-expansion/index.md","metadata":{"type":"markdown"},"label":"Field Expansion","link":"/rest/user-guide/04-headers-params/field-expansion","routeSlug":"/rest/user-guide/04-headers-params/field-expansion"}]},{"type":"group","fsPath":"rest/user-guide/05-pos-integrations/index.md","metadata":{"type":"markdown"},"label":"POS Integrations","link":"/rest/user-guide/05-pos-integrations","routeSlug":"/rest/user-guide/05-pos-integrations","items":[{"type":"link","fsPath":"rest/user-guide/05-pos-integrations/submit-sales/index.md","metadata":{"type":"markdown"},"label":"Submit Sales via API","link":"/rest/user-guide/05-pos-integrations/submit-sales","routeSlug":"/rest/user-guide/05-pos-integrations/submit-sales"},{"type":"link","fsPath":"rest/user-guide/05-pos-integrations/pull-items/index.md","metadata":{"type":"markdown"},"label":"Pull Items via API","link":"/rest/user-guide/05-pos-integrations/pull-items","routeSlug":"/rest/user-guide/05-pos-integrations/pull-items"},{"type":"link","fsPath":"rest/user-guide/05-pos-integrations/item-annotation/index.md","metadata":{"type":"markdown"},"label":"Third Party Codes / Interfaces","link":"/rest/user-guide/05-pos-integrations/item-annotation","routeSlug":"/rest/user-guide/05-pos-integrations/item-annotation"}]},{"type":"link","fsPath":"rest/user-guide/10-api-req-examples/index.md","metadata":{"type":"markdown"},"label":"API Request Examples","link":"/rest/user-guide/10-api-req-examples","routeSlug":"/rest/user-guide/10-api-req-examples"},{"type":"link","fsPath":"rest/user-guide/11-testing-in-postman/index.md","metadata":{"type":"markdown"},"label":"Testing in Postman","link":"/rest/user-guide/11-testing-in-postman","routeSlug":"/rest/user-guide/11-testing-in-postman"},{"type":"link","fsPath":"rest/user-guide/12-validating-api-reqs/index.md","metadata":{"type":"markdown"},"label":"Validating Fetch API Calls","link":"/rest/user-guide/12-validating-api-reqs","routeSlug":"/rest/user-guide/12-validating-api-reqs"},{"type":"link","fsPath":"rest/user-guide/13-rfid/index.md","metadata":{"type":"markdown"},"label":"RFID API Guide","link":"/rest/user-guide/13-rfid","routeSlug":"/rest/user-guide/13-rfid"},{"type":"link","fsPath":"rest/user-guide/14-support/index.md","metadata":{"type":"markdown"},"label":"Support Requests","link":"/rest/user-guide/14-support","routeSlug":"/rest/user-guide/14-support"}]},{"type":"separator","separatorLine":true},{"type":"link","label":"Auth API","link":"/rest/auth/api","routeSlug":"/rest/auth/api"},{"type":"link","label":"","link":"/rest/auth/api/section/","routeSlug":"/rest/auth/api/section/"},{"type":"group","label":"Authentication Tokens","link":"/rest/auth/api/authentication-tokens","routeSlug":"/rest/auth/api/authentication-tokens","items":[{"label":"Get token via credential","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/auth/api/authentication-tokens/get-token","routeSlug":"/rest/auth/api/authentication-tokens/get-token","metadata":{"seo":{"title":"Get token via credential","description":"Get token via credential"}},"httpPath":"/token"},{"label":"Get token via refresh token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/auth/api/authentication-tokens/get-refreshtoken","routeSlug":"/rest/auth/api/authentication-tokens/get-refreshtoken","metadata":{"seo":{"title":"Get token via refresh token","description":"Get token via refresh token"}},"httpPath":"/refreshToken"}]},{"type":"separator","separatorLine":true},{"type":"link","label":"Fetch API","link":"/rest/fetch/api","routeSlug":"/rest/fetch/api"},{"type":"link","label":"","link":"/rest/fetch/api/section/","routeSlug":"/rest/fetch/api/section/"},{"type":"group","label":"Accounting","link":"/rest/fetch/api/accounting","routeSlug":"/rest/fetch/api/accounting","items":[{"label":"Gets a listing of Return to Vendors based on Store","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/accounting/get-returntovendors","routeSlug":"/rest/fetch/api/accounting/get-returntovendors","metadata":{"seo":{"title":"Gets a listing of Return to Vendors based on Store","description":"Permission Requirements"}},"httpPath":"/accounting/{storeId}/{date}/returnToVendors"},{"label":"Gets a listing of invoices of a store on a given date","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/accounting/get-invoices","routeSlug":"/rest/fetch/api/accounting/get-invoices","metadata":{"seo":{"title":"Gets a listing of invoices of a store on a given date","description":"Permission Requirements"}},"httpPath":"/accounting/{storeId}/{date}/invoices"},{"label":"Gets revenue of a store on a given date","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/accounting/get-revenue","routeSlug":"/rest/fetch/api/accounting/get-revenue","metadata":{"seo":{"title":"Gets revenue of a store on a given date","description":"Gets revenue of a store on a given date, summarized by GL Account."}},"httpPath":"/accounting/{storeId}/{date}/revenue"},{"label":"Journal Entries for a store","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/accounting/get-journalentry","routeSlug":"/rest/fetch/api/accounting/get-journalentry","metadata":{"seo":{"title":"Journal Entries for a store","description":"Gets a listing of journal entries of a store on a given date, summarized by GL Account."}},"httpPath":"/accounting/{storeId}/{date}/journalEntry"},{"label":"Gets a listing of accounts and their code data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/accounting/get-codes","routeSlug":"/rest/fetch/api/accounting/get-codes","metadata":{"seo":{"title":"Gets a listing of accounts and their code data","description":"Permission Requirements"}},"httpPath":"/accounting/{storeId}/codes/{codeType}"}]},{"type":"group","label":"AttachedFiles","link":"/rest/fetch/api/attachedfiles","routeSlug":"/rest/fetch/api/attachedfiles","items":[{"label":"Gets image based on Id. This image can be associated to an Item or a Recipe.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/attachedfiles/get-attachedfiles-byid","routeSlug":"/rest/fetch/api/attachedfiles/get-attachedfiles-byid","metadata":{"seo":{"title":"Gets image based on Id. This image can be associated to an Item or a Recipe.","description":"Gets image based on Id. This image can be associated to an Item or a Recipe."}},"httpPath":"/attachedFiles/{id}"}]},{"type":"group","label":"CountSheets","link":"/rest/fetch/api/countsheets","routeSlug":"/rest/fetch/api/countsheets","items":[{"label":"Getting Count Sheets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/countsheets/get-countsheets-all","routeSlug":"/rest/fetch/api/countsheets/get-countsheets-all","metadata":{"seo":{"title":"Getting Count Sheets","description":"Getting Count Sheets"}},"httpPath":"/countsheets"},{"label":"Getting a Count Sheet by Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/countsheets/get-countsheets-byid","routeSlug":"/rest/fetch/api/countsheets/get-countsheets-byid","metadata":{"seo":{"title":"Getting a Count Sheet by Id","description":"Getting a Count Sheet by Id"}},"httpPath":"/countsheets/{id}"}]},{"type":"group","label":"Currency","link":"/rest/fetch/api/currency","routeSlug":"/rest/fetch/api/currency","items":[{"label":"Getting Currency","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/currency/get-currency","routeSlug":"/rest/fetch/api/currency/get-currency","metadata":{"seo":{"title":"Getting Currency","description":"Getting Currency"}},"httpPath":"/currency"},{"label":"Creating new Currency Exchange Rate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/currency/post-currency","routeSlug":"/rest/fetch/api/currency/post-currency","metadata":{"seo":{"title":"Creating new Currency Exchange Rate","description":"Creating new Currency Exchange Rate"}},"httpPath":"/currency"},{"label":"Updating existing Currency Exchange Rate","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/currency/put-currency","routeSlug":"/rest/fetch/api/currency/put-currency","metadata":{"seo":{"title":"Updating existing Currency Exchange Rate","description":"Updating existing Currency Exchange Rate"}},"httpPath":"/currency"},{"label":"Bulk delete Currency Exchange Rates","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/currency/delete-currency","routeSlug":"/rest/fetch/api/currency/delete-currency","metadata":{"seo":{"title":"Bulk delete Currency Exchange Rates","description":"Bulk delete Currency Exchange Rates"}},"httpPath":"/currency"},{"label":"Getting Effective Exchange Rate","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/currency/get-currency-exchange","routeSlug":"/rest/fetch/api/currency/get-currency-exchange","metadata":{"seo":{"title":"Getting Effective Exchange Rate","description":"Getting Effective Exchange Rate"}},"httpPath":"/currency/effectiveExchangeRate/{currencyCode}"},{"label":"Getting Currency by Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/currency/get-currency-byid","routeSlug":"/rest/fetch/api/currency/get-currency-byid","metadata":{"seo":{"title":"Getting Currency by Id","description":"Getting Currency by Id"}},"httpPath":"/currency/{id}"},{"label":"Deleting a Currency Exchange Rate","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/currency/delete-currency-byid","routeSlug":"/rest/fetch/api/currency/delete-currency-byid","metadata":{"seo":{"title":"Deleting a Currency Exchange Rate","description":"Deleting a Currency Exchange Rate"}},"httpPath":"/currency/{id}"}]},{"type":"group","label":"Dimensions","link":"/rest/fetch/api/dimensions","routeSlug":"/rest/fetch/api/dimensions","items":[{"label":"Getting Dimensions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/dimensions/get-dimensions","routeSlug":"/rest/fetch/api/dimensions/get-dimensions","metadata":{"seo":{"title":"Getting Dimensions","description":"Getting Dimensions"}},"httpPath":"/dimensions"},{"label":"Creating new Dimensions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/dimensions/post-dimensions","routeSlug":"/rest/fetch/api/dimensions/post-dimensions","metadata":{"seo":{"title":"Creating new Dimensions","description":"Creating new Dimensions"}},"httpPath":"/dimensions"},{"label":"Creating new Dimensions","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/dimensions/put-dimensions","routeSlug":"/rest/fetch/api/dimensions/put-dimensions","metadata":{"seo":{"title":"Creating new Dimensions","description":"Creating new Dimensions"}},"httpPath":"/dimensions"},{"label":"Getting Dimension by Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/dimensions/get-dimensions-byid","routeSlug":"/rest/fetch/api/dimensions/get-dimensions-byid","metadata":{"seo":{"title":"Getting Dimension by Id","description":"Getting Dimension by Id"}},"httpPath":"/dimensions/{id}"},{"label":"Deleting a Dimension","deprecated":true,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/dimensions/delete-dimensions-byid","routeSlug":"/rest/fetch/api/dimensions/delete-dimensions-byid","metadata":{"seo":{"title":"Deleting a Dimension","description":"Deleting a Dimension"}},"httpPath":"/dimensions/{id}"}]},{"type":"group","label":"Flags","link":"/rest/fetch/api/flags","routeSlug":"/rest/fetch/api/flags","items":[{"label":"Getting Flags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/flags/get-flags","routeSlug":"/rest/fetch/api/flags/get-flags","metadata":{"seo":{"title":"Getting Flags","description":"Getting Flags"}},"httpPath":"/flags"},{"label":"Getting Flag by Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/flags/get-flags-byid","routeSlug":"/rest/fetch/api/flags/get-flags-byid","metadata":{"seo":{"title":"Getting Flag by Id","description":"Getting Flag by Id"}},"httpPath":"/flags/{id}"}]},{"type":"group","label":"Inventory","link":"/rest/fetch/api/inventory","routeSlug":"/rest/fetch/api/inventory","items":[{"label":"Gets all Inventory","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/inventory/post-track-inventory","routeSlug":"/rest/fetch/api/inventory/post-track-inventory","metadata":{"seo":{"title":"Gets all Inventory","description":"This endpoint is recommended for any frequent polling of item onhands. Although the GET   Items endpoint includes a stores onhand value, the onhand value being changed does nottrigger an update of the rowUpdated for that endpoint."}},"httpPath":"/inventory"}]},{"type":"group","label":"Invoices","link":"/rest/fetch/api/invoices","routeSlug":"/rest/fetch/api/invoices","items":[{"label":"Create a Staged Invoice via a file upload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/invoices/post-invoices-ocr","routeSlug":"/rest/fetch/api/invoices/post-invoices-ocr","metadata":{"seo":{"title":"Create a Staged Invoice via a file upload","description":"Create a Staged Invoice via a file upload"}},"httpPath":"/invoices/ocr"},{"label":"Creates new staged invoice lines for a given staged invoice.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/invoices/post-invoices-staged-byid-lines","routeSlug":"/rest/fetch/api/invoices/post-invoices-staged-byid-lines","metadata":{"seo":{"title":"Creates new staged invoice lines for a given staged invoice.","description":"Creates new staged invoice lines for a given staged invoice."}},"httpPath":"/invoices/staged/{stagedInvoiceId}/lines"},{"label":"Find the original document for a staged invoice with the specified ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/invoices/get-invoices-staged-byid-original-document","routeSlug":"/rest/fetch/api/invoices/get-invoices-staged-byid-original-document","metadata":{"seo":{"title":"Find the original document for a staged invoice with the specified ID.","description":"Find the original document for a staged invoice with the specified ID."}},"httpPath":"/invoices/staged/{stagedInvoiceId}/original-document"},{"label":"Updates a staged invoice with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/invoices/put-invoices-staged-byid","routeSlug":"/rest/fetch/api/invoices/put-invoices-staged-byid","metadata":{"seo":{"title":"Updates a staged invoice with the specified ID.","description":"This endpoint requires the user to be authenticated and have the Api.Helpers.YdPolicyName.atLeast377 policy. The updated staged invoice is returned in the response body if the operation is successful. If the staged invoice was not modified, a 304 Not Modified status code is returned. If a validation error occurs, a 422 Unprocessable Entity status code is returned. If the database schema version is not version 377 or greater, a 403 Forbidden status code is returned."}},"httpPath":"/invoices/staged/{stagedInvoiceId}"},{"label":"Updates a staged invoice with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/invoices/patch-invoices-staged-byid","routeSlug":"/rest/fetch/api/invoices/patch-invoices-staged-byid","metadata":{"seo":{"title":"Updates a staged invoice with the specified ID.","description":"Updates a staged invoice with the specified ID."}},"httpPath":"/invoices/staged/{stagedInvoiceId}"}]},{"type":"group","label":"ItemAliases","link":"/rest/fetch/api/itemaliases","routeSlug":"/rest/fetch/api/itemaliases","items":[{"label":"Adding Item Aliases","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/itemaliases/post-itemaliases","routeSlug":"/rest/fetch/api/itemaliases/post-itemaliases","metadata":{"seo":{"title":"Adding Item Aliases","description":"Permission Requirements"}},"httpPath":"/itemaliases"}]},{"type":"group","label":"Items","link":"/rest/fetch/api/items","routeSlug":"/rest/fetch/api/items","items":[{"label":"Gets all Items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/items/get-items","routeSlug":"/rest/fetch/api/items/get-items","metadata":{"seo":{"title":"Gets all Items","description":"<details id=\"GetItems-ReqDesc-OneOfThreeEp\"><summary> Three Endpoints Retrieve Item Data </summary>"}},"httpPath":"/items"},{"label":"Upserts Items in bulk","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/items/patch-items","routeSlug":"/rest/fetch/api/items/patch-items","metadata":{"seo":{"title":"Upserts Items in bulk","description":"This endpoint allows for bulk upserting of item configuration changes."}},"httpPath":"/items"},{"label":"Gets an Item by Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/items/get-items-byid","routeSlug":"/rest/fetch/api/items/get-items-byid","metadata":{"seo":{"title":"Gets an Item by Id","description":"<details id=\"GetItemsByid-ReqDesc-OneOfThreeEp\"><summary> Three Endpoints Retrieve Item Data </summary>"}},"httpPath":"/items/{id}"},{"label":"Upserts Item Store Configs","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/items/patch-items-store-configs","routeSlug":"/rest/fetch/api/items/patch-items-store-configs","metadata":{"seo":{"title":"Upserts Item Store Configs","description":"Upserts Item Store Configs"}},"httpPath":"/items/store-configs"},{"label":"Adds an Image as an Attached File to an Item.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/items/post-items-images","routeSlug":"/rest/fetch/api/items/post-items-images","metadata":{"seo":{"title":"Adds an Image as an Attached File to an Item.","description":"User's client MUST be 366+ with cloud storage enabled."}},"httpPath":"/items/{itemId}/images"},{"label":"Updates the Description of an Items Attached File","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/items/patch-items-images-byid","routeSlug":"/rest/fetch/api/items/patch-items-images-byid","metadata":{"seo":{"title":"Updates the Description of an Items Attached File","description":"Permission Requirements"}},"httpPath":"/items/{itemId}/images/{imageId}"},{"label":"Deletes an item's image","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/items/delete-items-images-byid","routeSlug":"/rest/fetch/api/items/delete-items-images-byid","metadata":{"seo":{"title":"Deletes an item's image","description":"Permission Requirements"}},"httpPath":"/items/{itemId}/images/{imageId}"},{"label":"Adds a new record for an item's retail","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/items/post-items-retails","routeSlug":"/rest/fetch/api/items/post-items-retails","metadata":{"seo":{"title":"Adds a new record for an item's retail","description":"This endpoint allows you to set a new retail price for an item in a store to take effect at a scheduled future time.It will respond with an error if the given timestamp refers to a time in the past. Please use ISO 8601 compliant timestamps including a timezone suffix of \"Z\" for UTC or an offset to a local timezone as described in the Getting Started --> Timestamps documentation."}},"httpPath":"/items/{id}/retails"}]},{"type":"group","label":"ManualAdjusts","link":"/rest/fetch/api/manualadjusts","routeSlug":"/rest/fetch/api/manualadjusts","items":[{"label":"Creates Manual Adjustments","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/manualadjusts/post-manualadjusts","routeSlug":"/rest/fetch/api/manualadjusts/post-manualadjusts","metadata":{"seo":{"title":"Creates Manual Adjustments","description":"Permission Requirements"}},"httpPath":"/manualadjusts"}]},{"type":"group","label":"MetaInfo","link":"/rest/fetch/api/metainfo","routeSlug":"/rest/fetch/api/metainfo","items":[{"label":"Get all Meta Information for YDI Interface","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/metainfo/get-metainfo","routeSlug":"/rest/fetch/api/metainfo/get-metainfo","metadata":{"seo":{"title":"Get all Meta Information for YDI Interface","description":"In Yellow Dog, the user is able to configure the Names that are used on buttons to make the user interface more friendly for their particular use. This endpoint will display the values of these name changes. Common examples of this are: - Dimension 1 is named Size in the Yellow Dog Interface, Dimension 1 (Size) will be index 0 of the dimensions array. - Flag is named Location"}},"httpPath":"/metainfo"}]},{"type":"group","label":"ProductionGroups","link":"/rest/fetch/api/productiongroups","routeSlug":"/rest/fetch/api/productiongroups","items":[{"label":"Get ProductionGroups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/productiongroups/get-productiongroups","routeSlug":"/rest/fetch/api/productiongroups/get-productiongroups","metadata":{"seo":{"title":"Get ProductionGroups","description":"Production Groups indicate which team produces the recipe."}},"httpPath":"/productiongroups"}]},{"type":"group","label":"PurchaseOrders","link":"/rest/fetch/api/purchaseorders","routeSlug":"/rest/fetch/api/purchaseorders","items":[{"label":"Starts the Tiered Purchase Order Approval process","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/purchaseorders/post-purchaseorders-tieredapproval-request","routeSlug":"/rest/fetch/api/purchaseorders/post-purchaseorders-tieredapproval-request","metadata":{"seo":{"title":"Starts the Tiered Purchase Order Approval process","description":"Starts the Tiered Purchase Order Approval process"}},"httpPath":"/purchaseOrders/{id}/requestTieredApproval"},{"label":"Approves a Purchase Order Tier","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/purchaseorders/put-purchaseorders-tieredapproval","routeSlug":"/rest/fetch/api/purchaseorders/put-purchaseorders-tieredapproval","metadata":{"seo":{"title":"Approves a Purchase Order Tier","description":"Approves a Purchase Order Tier"}},"httpPath":"/purchaseOrders/tieredApproval"},{"label":"Gets Purchase Orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/purchaseorders/get-purchaseorders","routeSlug":"/rest/fetch/api/purchaseorders/get-purchaseorders","metadata":{"seo":{"title":"Gets Purchase Orders","description":"Example use casesapi/v2/purchaseOrders?pageNumber=1&pageSize=100&Filter=committed>2024-03-05T06:06:58.529Z&Filter=lastUpdated>2024-03-06&orderBy=committedwill get the first page of purchase orders where the committed date is later than 2024-03-05T06:06:58.529Z AND the lastUpdated date is later than 2024-03-06T00:00:00Z, ordering by the committed date/api/v2/purchaseOrders?pageNumber=1&pageSize=100&Filter=committed>2024-03-05T06:06:58.529Z&orderBy=committedwill get the first page of purchase orders where the committed date is later than 2024-03-05T06:06:58.529Z ordering by the committed date."}},"httpPath":"/purchaseOrders"},{"label":"Creates Purchase Orders.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/purchaseorders/post-purchaseorders","routeSlug":"/rest/fetch/api/purchaseorders/post-purchaseorders","metadata":{"seo":{"title":"Creates Purchase Orders.","description":"Permission Requirements"}},"httpPath":"/purchaseOrders"},{"label":"Get Purchase Order by Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/purchaseorders/get-purchaseorders-byid","routeSlug":"/rest/fetch/api/purchaseorders/get-purchaseorders-byid","metadata":{"seo":{"title":"Get Purchase Order by Id","description":"Get Purchase Order by Id"}},"httpPath":"/purchaseOrders/{id}"},{"label":"Get Purchase Order by token","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/purchaseorders/get-purchaseorders-bytoken","routeSlug":"/rest/fetch/api/purchaseorders/get-purchaseorders-bytoken","metadata":{"seo":{"title":"Get Purchase Order by token","description":"Get Purchase Order by token"}},"httpPath":"/purchaseOrders/byToken"},{"label":"Get Purchase Order Approval Status by Id of Purchase Order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/purchaseorders/get-purchaseorders-approvalstatus-byid","routeSlug":"/rest/fetch/api/purchaseorders/get-purchaseorders-approvalstatus-byid","metadata":{"seo":{"title":"Get Purchase Order Approval Status by Id of Purchase Order","description":"Get Purchase Order Approval Status by Id of Purchase Order"}},"httpPath":"/purchaseOrders/{id}/approvalStatus"},{"label":"Get Purchase Order Approval Status using token","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/purchaseorders/get-purchaseorders-approvalstatus-bytoken","routeSlug":"/rest/fetch/api/purchaseorders/get-purchaseorders-approvalstatus-bytoken","metadata":{"seo":{"title":"Get Purchase Order Approval Status using token","description":"Get Purchase Order Approval Status using token"}},"httpPath":"/purchaseOrders/approvalStatusByToken"},{"label":"Update Committed Purchase orders","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/purchaseorders/patch-leafroute","routeSlug":"/rest/fetch/api/purchaseorders/patch-leafroute","metadata":{"seo":{"title":"Update Committed Purchase orders","description":"Infrequently there are use cases where a previously committed purchase order would be allowed to have new lines added or other adjustments to the document.The following properties of a committed purchase order are prohibited from being updated: - Commdoc - Committed Status - Committed Date Time - Vendor - Store - Arrival LogOnly purchase orders that have been committed but do not have any kind of purchasing activity against them will be allowed to be edited."}},"httpPath":"/purchaseOrders/updateCommitted"}]},{"type":"group","label":"Receipts","link":"/rest/fetch/api/receipts","routeSlug":"/rest/fetch/api/receipts","items":[{"label":"Gets Receipts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/receipts/get-receipts","routeSlug":"/rest/fetch/api/receipts/get-receipts","metadata":{"seo":{"title":"Gets Receipts","description":"Permission Requirements"}},"httpPath":"/receipts"},{"label":"Create Receipts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/receipts/post-receipts","routeSlug":"/rest/fetch/api/receipts/post-receipts","metadata":{"seo":{"title":"Create Receipts","description":"Using this endpoint will create uncommitted receipts.Marking a receipt as committed and thus making the associated adjustments to the item inventory will need to be performed using the Yellow Dog Inventory Client."}},"httpPath":"/receipts"},{"label":"Get Receipt by Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/receipts/get-receipts-byid","routeSlug":"/rest/fetch/api/receipts/get-receipts-byid","metadata":{"seo":{"title":"Get Receipt by Id","description":"Get Receipt by Id"}},"httpPath":"/receipts/{id}"}]},{"type":"group","label":"Recipes","link":"/rest/fetch/api/recipes","routeSlug":"/rest/fetch/api/recipes","items":[{"label":"Adds an Image as an Attached File to a recipe\r\n\r\nUser's client *MUST* be 366+ with cloud storage enabled","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/recipes/post-recipes-images","routeSlug":"/rest/fetch/api/recipes/post-recipes-images","metadata":{"seo":{"title":"Adds an Image as an Attached File to a recipe\r\n\r\nUser's client *MUST* be 366+ with cloud storage enabled","description":"Permission Requirements"}},"httpPath":"/recipes/{recipeId}/images"},{"label":"Updates image details of a recipe","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/recipes/op-recipes-images-byid","routeSlug":"/rest/fetch/api/recipes/op-recipes-images-byid","metadata":{"seo":{"title":"Updates image details of a recipe","description":"Permission Requirements"}},"httpPath":"/recipes/{recipeId}/images/{imageId}"},{"label":"Deletes a recipe's image","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/recipes/delete-recipes-images-byid","routeSlug":"/rest/fetch/api/recipes/delete-recipes-images-byid","metadata":{"seo":{"title":"Deletes a recipe's image","description":"Permission Requirements"}},"httpPath":"/recipes/{recipeId}/images/{imageId}"},{"label":"Gets Recipes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/recipes/get-recipes","routeSlug":"/rest/fetch/api/recipes/get-recipes","metadata":{"seo":{"title":"Gets Recipes","description":"This endpoint only returns the list of Recipes, without Ingredients, AttachedFiles, and Links.If the ingredients are needed, then make an another API call to GET Recipe By ID with the Expand=Ingredients option.If the attached files are needed, then make an another API call to GET Recipe By ID with the Expand=AttachedFiles option.If the links are needed, then make an another API call to GET Recipe By ID with the Expand=Links option.Multiple expand options can be used. For example: /recipes/:id?Expand=Ingredients&Expand=AttachedFiles&Expand=Links"}},"httpPath":"/recipes"},{"label":"Gets a Recipe By ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/recipes/get-recipes-byid","routeSlug":"/rest/fetch/api/recipes/get-recipes-byid","metadata":{"seo":{"title":"Gets a Recipe By ID","description":"Gets a Recipe By ID"}},"httpPath":"/recipes/{recipeId}"}]},{"type":"group","label":"RecipeTypes","link":"/rest/fetch/api/recipetypes","routeSlug":"/rest/fetch/api/recipetypes","items":[{"label":"Get RecipeTypes.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/recipetypes/get-recipetypes","routeSlug":"/rest/fetch/api/recipetypes/get-recipetypes","metadata":{"seo":{"title":"Get RecipeTypes.","description":"RecipeType is a way to organize recipes into groups."}},"httpPath":"/recipetypes"}]},{"type":"group","label":"Requests","link":"/rest/fetch/api/requests","routeSlug":"/rest/fetch/api/requests","items":[{"label":"Creates and commits a Request to be used in the Purchasing Document Workflow.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/requests/post-requests","routeSlug":"/rest/fetch/api/requests/post-requests","metadata":{"seo":{"title":"Creates and commits a Request to be used in the Purchasing Document Workflow.","description":"Permission Requirements"}},"httpPath":"/requests"},{"label":"Commits a Request, this allows the Request to be used in future steps of the Purchasing Document Workflow","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/requests/patch-requests-commit","routeSlug":"/rest/fetch/api/requests/patch-requests-commit","metadata":{"seo":{"title":"Commits a Request, this allows the Request to be used in future steps of the Purchasing Document Workflow","description":"Commits a Request, this allows the Request to be used in future steps of the Purchasing Document Workflow"}},"httpPath":"/requests/{id}/Commit"},{"label":"Getting Request Details By ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/requests/get-requests-byid","routeSlug":"/rest/fetch/api/requests/get-requests-byid","metadata":{"seo":{"title":"Getting Request Details By ID","description":"Getting Request Details By ID"}},"httpPath":"/requests/{id}"},{"label":"Updates an existing Request","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/requests/patch-requests-byid","routeSlug":"/rest/fetch/api/requests/patch-requests-byid","metadata":{"seo":{"title":"Updates an existing Request","description":"Updates an existing Request"}},"httpPath":"/requests/{id}"}]},{"type":"group","label":"Sessions","link":"/rest/fetch/api/sessions","routeSlug":"/rest/fetch/api/sessions","items":[{"label":"Getting Sessions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/sessions/get-sessions","routeSlug":"/rest/fetch/api/sessions/get-sessions","metadata":{"seo":{"title":"Getting Sessions","description":"Getting Sessions"}},"httpPath":"/sessions"},{"label":"Creating new Sessions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/sessions/post-sessions","routeSlug":"/rest/fetch/api/sessions/post-sessions","metadata":{"seo":{"title":"Creating new Sessions","description":"Creating new Sessions"}},"httpPath":"/sessions"},{"label":"Updating existing Sessions","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/sessions/put-sessions","routeSlug":"/rest/fetch/api/sessions/put-sessions","metadata":{"seo":{"title":"Updating existing Sessions","description":"Updating existing Sessions"}},"httpPath":"/sessions"},{"label":"Getting Session by Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/sessions/get-sessions-byid","routeSlug":"/rest/fetch/api/sessions/get-sessions-byid","metadata":{"seo":{"title":"Getting Session by Id","description":"Getting Session by Id"}},"httpPath":"/sessions/{id}"},{"label":"Deleting a Session","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/sessions/delete-sessions-byid","routeSlug":"/rest/fetch/api/sessions/delete-sessions-byid","metadata":{"seo":{"title":"Deleting a Session","description":"Deleting a Session"}},"httpPath":"/sessions/{id}"},{"label":"Adding a Session Item to a Session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/sessions/post-sessions-sessionitems","routeSlug":"/rest/fetch/api/sessions/post-sessions-sessionitems","metadata":{"seo":{"title":"Adding a Session Item to a Session","description":"Adding a Session Item to a Session"}},"httpPath":"/sessions/{id}/sessionItems"},{"label":"Updating values of a Session Item","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/sessions/put-sessions-sessionitems-count","routeSlug":"/rest/fetch/api/sessions/put-sessions-sessionitems-count","metadata":{"seo":{"title":"Updating values of a Session Item","description":"Updating values of a Session Item"}},"httpPath":"/sessions/{id}/sessionItems/{sessionItemId}/count"}]},{"type":"group","label":"Stores","link":"/rest/fetch/api/stores","routeSlug":"/rest/fetch/api/stores","items":[{"label":"Gets Stores","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/stores/get-stores","routeSlug":"/rest/fetch/api/stores/get-stores","metadata":{"seo":{"title":"Gets Stores","description":"Gets Stores"}},"httpPath":"/stores"},{"label":"Gets Store by Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/stores/get-stores-byid","routeSlug":"/rest/fetch/api/stores/get-stores-byid","metadata":{"seo":{"title":"Gets Store by Id","description":"Gets Store by Id"}},"httpPath":"/stores/{id}"},{"label":"Gets Items for a Specific Store","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/stores/get-stores-items","routeSlug":"/rest/fetch/api/stores/get-stores-items","metadata":{"seo":{"title":"Gets Items for a Specific Store","description":"<details id=\"GetstoreItems-ReqDesc-OneOfThreeEp\"><summary> Three Endpoints Retrieve Item Data </summary>"}},"httpPath":"/stores/{id}/items"},{"label":"Gets a Store's ThirdPartyCodes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/stores/get-stores-interfaces","routeSlug":"/rest/fetch/api/stores/get-stores-interfaces","metadata":{"seo":{"title":"Gets a Store's ThirdPartyCodes","description":"Gets a Store's ThirdPartyCodes"}},"httpPath":"/stores/{id}/interfaces/ThirdPartyCodes"}]},{"type":"group","label":"ThirdPartyCodes","link":"/rest/fetch/api/thirdpartycodes","routeSlug":"/rest/fetch/api/thirdpartycodes","items":[{"label":"Gets all Third Party Codes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/thirdpartycodes/op-interfaces-thirdpartycodes","routeSlug":"/rest/fetch/api/thirdpartycodes/op-interfaces-thirdpartycodes","metadata":{"seo":{"title":"Gets all Third Party Codes","description":"Gets all Third Party Codes"}},"httpPath":"/interfaces/thirdPartyCodes"},{"label":"Creates Third Party Codes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/thirdpartycodes/post-interfaces-thirdpartycodes","routeSlug":"/rest/fetch/api/thirdpartycodes/post-interfaces-thirdpartycodes","metadata":{"seo":{"title":"Creates Third Party Codes","description":"About Third-Party Interface Codes"}},"httpPath":"/interfaces/thirdPartyCodes"},{"label":"Updates Third Party Codes","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/thirdpartycodes/put-interfaces-thirdpartycodes","routeSlug":"/rest/fetch/api/thirdpartycodes/put-interfaces-thirdpartycodes","metadata":{"seo":{"title":"Updates Third Party Codes","description":"Updates Third Party Codes"}},"httpPath":"/interfaces/thirdPartyCodes"},{"label":"Bulk delete Third Party Codes","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/thirdpartycodes/delete-interfaces-thirdpartycodes","routeSlug":"/rest/fetch/api/thirdpartycodes/delete-interfaces-thirdpartycodes","metadata":{"seo":{"title":"Bulk delete Third Party Codes","description":"Bulk delete Third Party Codes"}},"httpPath":"/interfaces/thirdPartyCodes"},{"label":"Gets Third Party Code by Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/thirdpartycodes/get-interfaces-thirdpartycodes-byid","routeSlug":"/rest/fetch/api/thirdpartycodes/get-interfaces-thirdpartycodes-byid","metadata":{"seo":{"title":"Gets Third Party Code by Id","description":"Gets Third Party Code by Id"}},"httpPath":"/interfaces/thirdPartyCodes/{id}"},{"label":"Deleting a Third Party Code","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/thirdpartycodes/delete-interfaces-thirdpartycodes-byid","routeSlug":"/rest/fetch/api/thirdpartycodes/delete-interfaces-thirdpartycodes-byid","metadata":{"seo":{"title":"Deleting a Third Party Code","description":"Deleting a Third Party Code"}},"httpPath":"/interfaces/thirdPartyCodes/{id}"}]},{"type":"group","label":"ThirdParty","link":"/rest/fetch/api/thirdparty","routeSlug":"/rest/fetch/api/thirdparty","items":[{"label":"Upserts Third Party Items (TPItems) in bulk","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/thirdparty/post-third-party-items","routeSlug":"/rest/fetch/api/thirdparty/post-third-party-items","metadata":{"seo":{"title":"Upserts Third Party Items (TPItems) in bulk","description":"This endpoint allows for bulk upserting of TPItems."}},"httpPath":"/third-party/{syncId}/items"},{"label":"Upserts Third Party Locations (TPLocations) in bulk","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/thirdparty/post-third-party-locations","routeSlug":"/rest/fetch/api/thirdparty/post-third-party-locations","metadata":{"seo":{"title":"Upserts Third Party Locations (TPLocations) in bulk","description":"This endpoint allows for bulk upserting of TPLocations."}},"httpPath":"/third-party/{syncId}/locations"}]},{"type":"group","label":"ThirdPartySessions","link":"/rest/fetch/api/thirdpartysessions","routeSlug":"/rest/fetch/api/thirdpartysessions","items":[{"label":"Gets all Third Party Sessions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/thirdpartysessions/get-thirdpartysessions","routeSlug":"/rest/fetch/api/thirdpartysessions/get-thirdpartysessions","metadata":{"seo":{"title":"Gets all Third Party Sessions","description":"Gets all Third Party Sessions"}},"httpPath":"/thirdPartySessions"},{"label":"Creates Third Party Sessions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/thirdpartysessions/post-thirdpartysessions","routeSlug":"/rest/fetch/api/thirdpartysessions/post-thirdpartysessions","metadata":{"seo":{"title":"Creates Third Party Sessions","description":"Creates Third Party Sessions"}},"httpPath":"/thirdPartySessions"},{"label":"Gets Third Party Session by Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/thirdpartysessions/get-thirdpartysessions-byid","routeSlug":"/rest/fetch/api/thirdpartysessions/get-thirdpartysessions-byid","metadata":{"seo":{"title":"Gets Third Party Session by Id","description":"Gets Third Party Session by Id"}},"httpPath":"/thirdPartySessions/{id}"}]},{"type":"group","label":"Transactions","link":"/rest/fetch/api/transactions","routeSlug":"/rest/fetch/api/transactions","items":[{"label":"Getting all Transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/transactions/get-transactions","routeSlug":"/rest/fetch/api/transactions/get-transactions","metadata":{"seo":{"title":"Getting all Transactions","description":"This endpoint allows for pulling of raw transaction information that is stored in the Yellow Dog Database. As this data is considered to be raw and not processed there is not a way to determine directly with certainty what items or recipes had inventory adjustments from this endpoint. Due to the various Point of Sale integrations that may be connected with the database instance, there is not a guarentee that all transactions will match using the criteria represented in the POST /transactions Endpoint documentation."}},"httpPath":"/transactions"},{"label":"Creates or Updates Transactions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/transactions/post-transactions","routeSlug":"/rest/fetch/api/transactions/post-transactions","metadata":{"seo":{"title":"Creates or Updates Transactions","description":"Matching and Processing"}},"httpPath":"/transactions"},{"label":"Gets Transactions by Store","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/transactions/get-transactions-store","routeSlug":"/rest/fetch/api/transactions/get-transactions-store","metadata":{"seo":{"title":"Gets Transactions by Store","description":"Gets Transactions by Store"}},"httpPath":"/transactions/store/{storeId}"},{"label":"Gets Transaction by ThirdPartyId","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/transactions/get-transactions-byid","routeSlug":"/rest/fetch/api/transactions/get-transactions-byid","metadata":{"seo":{"title":"Gets Transaction by ThirdPartyId","description":"This endpoint is intended to be used for looking up a specific Transaction record."}},"httpPath":"/transactions/{thirdPartyId}"}]},{"type":"group","label":"Transfers","link":"/rest/fetch/api/transfers","routeSlug":"/rest/fetch/api/transfers","items":[{"label":"Accepts a Transfer","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/transfers/patch-transfers-accept","routeSlug":"/rest/fetch/api/transfers/patch-transfers-accept","metadata":{"seo":{"title":"Accepts a Transfer","description":"Accepting a Transfer is an indication that the Store on the receiving side of the Item movement has been received at the quantities indicated by the accepting quantity."}},"httpPath":"/transfers/{id}/Accept"},{"label":"Issues a Transfer","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/transfers/patch-transfers-issue","routeSlug":"/rest/fetch/api/transfers/patch-transfers-issue","metadata":{"seo":{"title":"Issues a Transfer","description":"Issuing a Transfer is an indication that the Store on the sending side of the Item movement has been sent to the Store on the receiving side."}},"httpPath":"/transfers/{id}/Issue"},{"label":"Gets Transfers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/transfers/get-transfers","routeSlug":"/rest/fetch/api/transfers/get-transfers","metadata":{"seo":{"title":"Gets Transfers","description":"Example use casesapi/v2/transfers?pageNumber=1&pageSize=100&Filter=committed>2024-03-05T06:06:58.529Z&Filter=lastUpdated>2024-03-06&orderBy=committedwill get the first page of transfers where the committed date is later than 2024-03-05T06:06:58.529Z AND the lastUpdated date is later than 2024-03-06T00:00:00Z, ordering by the committed date/api/v2/transfers?pageNumber=1&pageSize=100&Filter=committed>2024-03-05T06:06:58.529Z&orderBy=committedwill get the first page of transfers where the committed date is later than 2024-03-05T06:06:58.529Z ordering by the committed date."}},"httpPath":"/transfers"},{"label":"Creates a Transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/transfers/post-transfers","routeSlug":"/rest/fetch/api/transfers/post-transfers","metadata":{"seo":{"title":"Creates a Transfer","description":"Permission Requirements"}},"httpPath":"/transfers"},{"label":"Add Additional lines to an existing Transfer that has not been committed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/transfers/post-transfers-lines","routeSlug":"/rest/fetch/api/transfers/post-transfers-lines","metadata":{"seo":{"title":"Add Additional lines to an existing Transfer that has not been committed","description":"Permission Requirements"}},"httpPath":"/transfers/{id}/lines"},{"label":"Updates existing lines of a given Transfer","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/transfers/patch-transfers-lines","routeSlug":"/rest/fetch/api/transfers/patch-transfers-lines","metadata":{"seo":{"title":"Updates existing lines of a given Transfer","description":"Permission Requirements"}},"httpPath":"/transfers/{id}/lines"},{"label":"Delete existing lines from a Transfer","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/transfers/delete-transfers-lines","routeSlug":"/rest/fetch/api/transfers/delete-transfers-lines","metadata":{"seo":{"title":"Delete existing lines from a Transfer","description":"Permission Requirements"}},"httpPath":"/transfers/{id}/lines"},{"label":"Gets a Transfer By ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/transfers/get-transfers-byid","routeSlug":"/rest/fetch/api/transfers/get-transfers-byid","metadata":{"seo":{"title":"Gets a Transfer By ID","description":"Gets a Transfer By ID"}},"httpPath":"/transfers/{id}"},{"label":"Updates an existing Transfer","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/transfers/patch-transfers-byid","routeSlug":"/rest/fetch/api/transfers/patch-transfers-byid","metadata":{"seo":{"title":"Updates an existing Transfer","description":"Permission Requirements"}},"httpPath":"/transfers/{id}"}]},{"type":"group","label":"Vendors","link":"/rest/fetch/api/vendors","routeSlug":"/rest/fetch/api/vendors","items":[{"label":"Getting Vendors","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/vendors/get-vendors","routeSlug":"/rest/fetch/api/vendors/get-vendors","metadata":{"seo":{"title":"Getting Vendors","description":"Getting Vendors"}},"httpPath":"/vendors"},{"label":"Creating new Vendors","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/vendors/post-vendors","routeSlug":"/rest/fetch/api/vendors/post-vendors","metadata":{"seo":{"title":"Creating new Vendors","description":"Creating new Vendors"}},"httpPath":"/vendors"},{"label":"Updating existing Vendors","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/vendors/put-vendors","routeSlug":"/rest/fetch/api/vendors/put-vendors","metadata":{"seo":{"title":"Updating existing Vendors","description":"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."}},"httpPath":"/vendors"},{"label":"Getting Vendor by Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/vendors/get-vendors-byid","routeSlug":"/rest/fetch/api/vendors/get-vendors-byid","metadata":{"seo":{"title":"Getting Vendor by Id","description":"Getting Vendor by Id"}},"httpPath":"/vendors/{id}"},{"label":"Bulk delete Vendors","deprecated":true,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/vendors/delete-vendors","routeSlug":"/rest/fetch/api/vendors/delete-vendors","metadata":{"seo":{"title":"Bulk delete Vendors","description":"Bulk delete Vendors"}},"httpPath":"/vendors"},{"label":"Deleting a Vendor","deprecated":true,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest/fetch/api/vendors/delete-vendors-byid","routeSlug":"/rest/fetch/api/vendors/delete-vendors-byid","metadata":{"seo":{"title":"Deleting a Vendor","description":"Deleting a Vendor"}},"httpPath":"/vendors/{id}"}]}]}