{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-rest/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Yellow Dog REST APIs","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"yellow-dog-rest-apis","__idx":0},"children":["Yellow Dog REST APIs"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"user-guide","__idx":1},"children":["User Guide"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/rest/user-guide/01-authentication"},"children":["Authentication"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/rest/user-guide/02-timestamps"},"children":["Timestamps (v2 vs. v3)"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/rest/user-guide/03-rate-limit"},"children":["Rate Limit"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/rest/user-guide/04-headers-params"},"children":["API Headers and Parameters"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/rest/user-guide/04-headers-params/req-headers"},"children":["Recommended Request Headers"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/rest/user-guide/04-headers-params/pagination"},"children":["Pagination"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/rest/user-guide/04-headers-params/filtering"},"children":["Filtering"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/rest/user-guide/04-headers-params/ordering"},"children":["Ordering"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/rest/user-guide/04-headers-params/field-expansion"},"children":["Field Expansion"]}]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/rest/user-guide/05-pos-integrations"},"children":["POS Integrations"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/rest/user-guide/05-pos-integrations/submit-sales"},"children":["Submit Sales"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/rest/user-guide/05-pos-integrations/pull-items"},"children":["Pull Items"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/rest/user-guide/05-pos-integrations/item-annotation"},"children":["POS Specific Item Annotations"]}]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/rest/user-guide/10-api-req-examples"},"children":["API Request Examples"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/rest/user-guide/11-testing-in-postman"},"children":["Testing in Postman"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/rest/user-guide/11-testing-in-postman#what-is-postman"},"children":["What is Postman"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/rest/user-guide/11-testing-in-postman#install-postman--import-collection/index.md"},"children":["Install Postman & Import Collection"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/rest/user-guide/11-testing-in-postman#adding-environment-and-variables"},"children":["Adding Environment and Variables"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/rest/user-guide/11-testing-in-postman#making-first-api-call"},"children":["Making First API Call"]}]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/rest/user-guide/12-validating-api-reqs"},"children":["Validating Fetch API Calls"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/rest/user-guide/13-rfid"},"children":["RFID API Guide"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/rest/user-guide/14-support"},"children":["Support Requests"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"api-endpoint-reference","__idx":2},"children":["API Endpoint Reference"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/rest/auth/api"},"children":["Auth API endpoints"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/rest/fetch/api"},"children":["Fetch API endpoints"]}]}]}]},"headings":[{"value":"Yellow Dog REST APIs","id":"yellow-dog-rest-apis","depth":4},{"value":"User Guide","id":"user-guide","depth":1},{"value":"API Endpoint Reference","id":"api-endpoint-reference","depth":1}],"frontmatter":{"seo":{"title":"Yellow Dog REST APIs"}},"lastModified":"2026-04-13T22:17:48.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/rest/user-guide","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}