{"items":[{"type":"link","label":"Corksy API","link":"/openapi","routeSlug":"/openapi","content":{"contentType":"overview","meta":{"name":"Corksy API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://staging.corksy.io/connect-api/v1","description":"Staging Environment"},{"url":"https://connect-api.corksy.io","description":"Production Environment"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Corksy API (1.3.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API for retrieving orders, customers, inventory, wine-club data, and products."},"children":[]}]}]}]}],"sectionId":"/openapi"}],"sectionId":"/openapi"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API uses a two-step authentication process:"},"children":[]}]}]}]}],"sectionId":"/openapi/section/authentication"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/step-1:-generate-api-key"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step 1: Generate API Key"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"First, generate your API key from the Admin Settings API page:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Go to: https://admin.corksy.io/settings/apiaccess"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new API key for your application"},"children":[]}]}]}]}]}],"sectionId":"/openapi/section/step-1:-generate-api-key"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/step-2:-obtain-bearer-token"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step 2: Obtain Bearer Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your API key to obtain a bearer token by making a POST request to the authentication endpoint:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl --location 'https://connect-api.corksy.io/v1/auth/public/login' \\\n--header 'Content-Type: application/json' \\\n--data '{\n    \"apiKey\": \"your-api-key-here\"\n}'\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl --location 'https://connect-api.corksy.io/v1/auth/public/login' \\\n--header 'Content-Type: application/json' \\\n--data '{\n    \"apiKey\": \"your-api-key-here\"\n}'\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Staging:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl --location 'https://staging.corksy.io/connect-api/v1/auth/public/login' \\\n--header 'Content-Type: application/json' \\\n--data '{\n    \"apiKey\": \"your-api-key-here\"\n}'\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl --location 'https://staging.corksy.io/connect-api/v1/auth/public/login' \\\n--header 'Content-Type: application/json' \\\n--data '{\n    \"apiKey\": \"your-api-key-here\"\n}'\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n    \"accessToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\",\n    \"expiresIn\": 1800000\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n    \"accessToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\",\n    \"expiresIn\": 1800000\n}\n"},"children":[]}]}]}],"sectionId":"/openapi/section/step-2:-obtain-bearer-token"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/step-3:-use-bearer-token"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step 3: Use Bearer Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accessToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the response as a Bearer token in the Authorization header for all subsequent API requests:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example Requests:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get Orders:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl --location 'https://connect-api.corksy.io/v1/orders?modifiedFromDate=2025-05-01&modifiedToDate=2025-05-31' \\\n--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl --location 'https://connect-api.corksy.io/v1/orders?modifiedFromDate=2025-05-01&modifiedToDate=2025-05-31' \\\n--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get Customers:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl --location 'https://connect-api.corksy.io/v1/customers' \\\n--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl --location 'https://connect-api.corksy.io/v1/customers' \\\n--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get Inventory:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl --location 'https://connect-api.corksy.io/v1/inventory' \\\n--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl --location 'https://connect-api.corksy.io/v1/inventory' \\\n--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get Wine Clubs:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl --location 'https://connect-api.corksy.io/v1/wine-clubs' \\\n--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl --location 'https://connect-api.corksy.io/v1/wine-clubs' \\\n--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get Wine Club Members:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl --location 'https://connect-api.corksy.io/v1/wine-club-members' \\\n--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl --location 'https://connect-api.corksy.io/v1/wine-club-members' \\\n--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get Products:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl --location 'https://connect-api.corksy.io/v1/products?modifiedFromDate=2025-05-01&modifiedToDate=2025-05-31' \\\n--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl --location 'https://connect-api.corksy.io/v1/products?modifiedFromDate=2025-05-01&modifiedToDate=2025-05-31' \\\n--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The bearer token expires after 30 minutes (1,800,000 microseconds). You'll need to obtain a new token when it expires."},"children":[]}]}]}]}],"sectionId":"/openapi/section/step-3:-use-bearer-token"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/pagination"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All list endpoints support pagination to handle large datasets efficiently. The API uses offset-based pagination with the following parameters:"},"children":[]}]}]}]}],"sectionId":"/openapi/section/pagination"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/pagination-parameters"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination Parameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (optional): Number of records to skip. Default: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (optional): Number of records to return per page. Default: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Maximum: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1000"},"children":[]}]}]}]}]}],"sectionId":"/openapi/section/pagination-parameters"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/pagination-response"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination Response"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each paginated response includes a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pagination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object with the following information:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"data\": [...],\n  \"pagination\": {\n    \"current_offset\": 0,\n    \"page_size\": 50,\n    \"total_records\": 1250,\n    \"total_pages\": 25,\n    \"current_page\": 1,\n    \"pages_remaining\": 24,\n    \"has_next_page\": true,\n    \"has_previous_page\": false\n  }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"data\": [...],\n  \"pagination\": {\n    \"current_offset\": 0,\n    \"page_size\": 50,\n    \"total_records\": 1250,\n    \"total_pages\": 25,\n    \"current_page\": 1,\n    \"pages_remaining\": 24,\n    \"has_next_page\": true,\n    \"has_previous_page\": false\n  }\n}\n"},"children":[]}]}]}],"sectionId":"/openapi/section/pagination-response"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/pagination-examples"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination Examples"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"First Page (Default):"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl --location 'https://connect-api.corksy.io/v1/orders?modifiedFromDate=2025-05-01&modifiedToDate=2025-05-31' \\\n--header 'Authorization: Bearer YOUR_TOKEN'\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl --location 'https://connect-api.corksy.io/v1/orders?modifiedFromDate=2025-05-01&modifiedToDate=2025-05-31' \\\n--header 'Authorization: Bearer YOUR_TOKEN'\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Second Page (50 records per page):"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl --location 'https://connect-api.corksy.io/v1/orders?modifiedFromDate=2025-05-01&modifiedToDate=2025-05-31&offset=50&pageSize=50' \\\n--header 'Authorization: Bearer YOUR_TOKEN'\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl --location 'https://connect-api.corksy.io/v1/orders?modifiedFromDate=2025-05-01&modifiedToDate=2025-05-31&offset=50&pageSize=50' \\\n--header 'Authorization: Bearer YOUR_TOKEN'\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Page Size:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl --location 'https://connect-api.corksy.io/v1/orders?modifiedFromDate=2025-05-01&modifiedToDate=2025-05-31&pageSize=100' \\\n--header 'Authorization: Bearer YOUR_TOKEN'\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl --location 'https://connect-api.corksy.io/v1/orders?modifiedFromDate=2025-05-01&modifiedToDate=2025-05-31&pageSize=100' \\\n--header 'Authorization: Bearer YOUR_TOKEN'\n"},"children":[]}]}]}],"sectionId":"/openapi/section/pagination-examples"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/best-practices"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Best Practices"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start with the first page"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (no parameters or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset=0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"has_next_page"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to determine if more pages exist"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Increment "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page_size"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get the next page"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Choose appropriate "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page_size"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" based on your needs."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Handle rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - each page request counts toward your rate limit"},"children":[]}]}]}]}]}],"sectionId":"/openapi/section/best-practices"}]}]}},{"type":"link","label":"Authentication","link":"/openapi/section/authentication","routeSlug":"/openapi/section/authentication","content":null},{"type":"link","label":"Step 1: Generate API Key","link":"/openapi/section/step-1:-generate-api-key","routeSlug":"/openapi/section/step-1:-generate-api-key","content":null},{"type":"link","label":"Step 2: Obtain Bearer Token","link":"/openapi/section/step-2:-obtain-bearer-token","routeSlug":"/openapi/section/step-2:-obtain-bearer-token","content":null},{"type":"link","label":"Step 3: Use Bearer Token","link":"/openapi/section/step-3:-use-bearer-token","routeSlug":"/openapi/section/step-3:-use-bearer-token","content":null},{"type":"link","label":"Pagination","link":"/openapi/section/pagination","routeSlug":"/openapi/section/pagination","content":null},{"type":"link","label":"Pagination Parameters","link":"/openapi/section/pagination-parameters","routeSlug":"/openapi/section/pagination-parameters","content":null},{"type":"link","label":"Pagination Response","link":"/openapi/section/pagination-response","routeSlug":"/openapi/section/pagination-response","content":null},{"type":"link","label":"Pagination Examples","link":"/openapi/section/pagination-examples","routeSlug":"/openapi/section/pagination-examples","content":null},{"type":"link","label":"Best Practices","link":"/openapi/section/best-practices","routeSlug":"/openapi/section/best-practices","content":null},{"type":"group","label":"Authentication","link":"/openapi/authentication","routeSlug":"/openapi/authentication","items":[{"label":"Authenticate with API key to obtain bearer token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/authentication/authenticate","routeSlug":"/openapi/authentication/authenticate","metadata":{"seo":{"title":"Authenticate with API key to obtain bearer token","description":"Authenticate using your API key to obtain a JWT bearer token for accessing protected endpoints."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"authenticate","name":"Authenticate with API key to obtain bearer token","isWebhook":false,"pointer":"/paths/~1v1~1auth~1public~1login/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authenticate with API key to obtain bearer token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authenticate using your API key to obtain a JWT bearer token for accessing protected endpoints."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 10 requests / minute"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The returned token expires after 30 minutes. You'll need to call this endpoint again to get a new token."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_11","exampleIds":["paths/~1v1~1auth~1public~1login/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_11","exampleIds":["paths/~1v1~1auth~1public~1login/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1auth~1public~1login/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/public/login","servers":[{"url":"https://staging.corksy.io/connect-api/v1","description":"Staging Environment"},{"url":"https://connect-api.corksy.io","description":"Production Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_11","exampleIds":["paths/~1v1~1auth~1public~1login/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","429"],"pointer":"/v1/auth/public/login","href":"authentication/authenticate","openApiOperationId":"authenticate","summary":"Authenticate with API key to obtain bearer token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://staging.corksy.io/connect-api/v1","description":"Staging Environment"},{"url":"https://connect-api.corksy.io","description":"Production Environment"}],"schemaId":"schema_11","exampleIds":["paths/~1v1~1auth~1public~1login/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_11","exampleIds":["paths/~1v1~1auth~1public~1login/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Authentication successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12"}},"schemaId":"schema_12"},{"code":"400","description":"Invalid API key","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_13"}},"schemaId":"schema_13"},{"code":"429","description":"Rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_14"}},"schemaId":"schema_14"}],"pointer":"/paths/~1v1~1auth~1public~1login/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_12","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12"}}},{"code":"400","schemaId":"schema_13","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_13"}}},{"code":"429","schemaId":"schema_14","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_14"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authentication/authenticate"}],"panels":[]}]},"httpPath":"/v1/auth/public/login"}],"content":{"contentType":"group","meta":{"name":"Authentication"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authentication","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints related to authentication and authorization"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/auth/public/login","summary":"Authenticate with API key to obtain bearer token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authentication/authenticate","deprecated":false}]}]}]}]}},{"type":"group","label":"Orders","link":"/openapi/orders","routeSlug":"/openapi/orders","items":[{"label":"Retrieve a list of orders within a date range","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/orders/getorders","routeSlug":"/openapi/orders/getorders","metadata":{"seo":{"title":"Retrieve a list of orders within a date range","description":"🚦 Rate Limit: 100 requests / minute"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrders","name":"Retrieve a list of orders within a date range","isWebhook":false,"pointer":"/paths/~1orders/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a list of orders within a date range","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🚦 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 100 requests / minute"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer token obtained from the authentication endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token Format:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" JWT (JSON Web Token)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expiration:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 30 minutes (1,800,000 microseconds)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Header Format:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"modifiedFromDate","in":"query","schemaId":"schema_15","description":"Filter orders modified from this date (ISO 8601 format). If specified without modifiedToDate, current date will be used as end date."},{"name":"modifiedToDate","in":"query","schemaId":"schema_16","description":"Filter orders modified up to this date (ISO 8601 format). Cannot be specified without modifiedFromDate."},{"name":"offset","in":"query","schemaId":"schema_17","description":"Number of records to skip for pagination (default: 0)"},{"name":"pageSize","in":"query","schemaId":"schema_18","description":"Number of records to return per page (default: 1000, max: 1000)"},{"name":"orderNumber","in":"query","schemaId":"schema_19","description":"Fetch a single order by order number. When provided, the response will include only that order (if found)."}],"pointer":"/paths/~1orders/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orders","servers":[{"url":"https://staging.corksy.io/connect-api/v1","description":"Staging Environment"},{"url":"https://connect-api.corksy.io","description":"Production Environment"}],"parameters":{"path":[],"query":[{"name":"modifiedFromDate","in":"query","required":false,"example":"2026-01-01T00:00:00Z","schemaId":"schema_15"},{"name":"modifiedToDate","in":"query","required":false,"example":"2026-01-31T23:59:59Z","schemaId":"schema_16"},{"name":"offset","in":"query","required":false,"example":0,"schemaId":"schema_17"},{"name":"pageSize","in":"query","required":false,"example":50,"schemaId":"schema_18"},{"name":"orderNumber","in":"query","required":false,"example":21654,"schemaId":"schema_19"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/orders","href":"orders/getorders","openApiOperationId":"getOrders","summary":"Retrieve a list of orders within a date range"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://staging.corksy.io/connect-api/v1","description":"Staging Environment"},{"url":"https://connect-api.corksy.io","description":"Production Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of orders within the specified date range","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderResponse"}},"schemaId":"components/schemas/OrderResponse"}],"pointer":"/paths/~1orders/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/getorders"}],"panels":[]}]},"httpPath":"/orders"}],"content":{"contentType":"group","meta":{"name":"Orders"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Orders","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints related to orders"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/orders","summary":"Retrieve a list of orders within a date range","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/getorders","deprecated":false}]}]}]}]}},{"type":"group","label":"Customers","link":"/openapi/customers","routeSlug":"/openapi/customers","items":[{"label":"Retrieve a list of customers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customers/getcustomers","routeSlug":"/openapi/customers/getcustomers","metadata":{"seo":{"title":"Retrieve a list of customers","description":"🚦 Rate Limit: 100 requests / minute"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCustomers","name":"Retrieve a list of customers","isWebhook":false,"pointer":"/paths/~1customers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a list of customers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🚦 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 100 requests / minute"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer token obtained from the authentication endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token Format:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" JWT (JSON Web Token)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expiration:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 30 minutes (1,800,000 microseconds)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Header Format:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"modifiedFromDate","in":"query","schemaId":"schema_20","description":"Filter customers modified from this date (ISO 8601 format). Optional - if not provided, no date filtering is applied."},{"name":"modifiedToDate","in":"query","schemaId":"schema_21","description":"Filter customers modified up to this date (ISO 8601 format). Cannot be specified without modifiedFromDate."},{"name":"offset","in":"query","schemaId":"schema_17","description":"Number of records to skip for pagination (default: 0)"},{"name":"pageSize","in":"query","schemaId":"schema_18","description":"Number of records to return per page (default: 1000, max: 1000)"}],"pointer":"/paths/~1customers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customers","servers":[{"url":"https://staging.corksy.io/connect-api/v1","description":"Staging Environment"},{"url":"https://connect-api.corksy.io","description":"Production Environment"}],"parameters":{"path":[],"query":[{"name":"modifiedFromDate","in":"query","required":false,"example":"2025-05-01T00:00:00Z","schemaId":"schema_20"},{"name":"modifiedToDate","in":"query","required":false,"example":"2025-05-31T23:59:59Z","schemaId":"schema_21"},{"name":"offset","in":"query","required":false,"example":0,"schemaId":"schema_17"},{"name":"pageSize","in":"query","required":false,"example":50,"schemaId":"schema_18"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/customers","href":"customers/getcustomers","openApiOperationId":"getCustomers","summary":"Retrieve a list of customers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://staging.corksy.io/connect-api/v1","description":"Staging Environment"},{"url":"https://connect-api.corksy.io","description":"Production Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of customers","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerResponse"}},"schemaId":"components/schemas/CustomerResponse"}],"pointer":"/paths/~1customers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomerResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/getcustomers"}],"panels":[]}]},"httpPath":"/customers"}],"content":{"contentType":"group","meta":{"name":"Customers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Customers","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints related to customers"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/customers","summary":"Retrieve a list of customers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customers/getcustomers","deprecated":false}]}]}]}]}},{"type":"group","label":"Inventory","link":"/openapi/inventory","routeSlug":"/openapi/inventory","items":[{"label":"Retrieve a list of inventory items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/inventory/getinventory","routeSlug":"/openapi/inventory/getinventory","metadata":{"seo":{"title":"Retrieve a list of inventory items","description":"🚦 Rate Limit: 100 requests / minute"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInventory","name":"Retrieve a list of inventory items","isWebhook":false,"pointer":"/paths/~1inventory/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a list of inventory items","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🚦 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 100 requests / minute"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer token obtained from the authentication endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token Format:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" JWT (JSON Web Token)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expiration:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 30 minutes (1,800,000 microseconds)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Header Format:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_17","description":"Number of records to skip for pagination (default: 0)"},{"name":"pageSize","in":"query","schemaId":"schema_18","description":"Number of records to return per page (default: 1000, max: 1000)"}],"pointer":"/paths/~1inventory/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/inventory","servers":[{"url":"https://staging.corksy.io/connect-api/v1","description":"Staging Environment"},{"url":"https://connect-api.corksy.io","description":"Production Environment"}],"parameters":{"path":[],"query":[{"name":"offset","in":"query","required":false,"example":0,"schemaId":"schema_17"},{"name":"pageSize","in":"query","required":false,"example":50,"schemaId":"schema_18"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/inventory","href":"inventory/getinventory","openApiOperationId":"getInventory","summary":"Retrieve a list of inventory items"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://staging.corksy.io/connect-api/v1","description":"Staging Environment"},{"url":"https://connect-api.corksy.io","description":"Production Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of inventory items","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InventoryResponse"}},"schemaId":"components/schemas/InventoryResponse"}],"pointer":"/paths/~1inventory/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InventoryResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InventoryResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inventory/getinventory"}],"panels":[]}]},"httpPath":"/inventory"}],"content":{"contentType":"group","meta":{"name":"Inventory"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Inventory","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints related to inventory"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/inventory","summary":"Retrieve a list of inventory items","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inventory/getinventory","deprecated":false}]}]}]}]}},{"type":"group","label":"Wine Clubs","link":"/openapi/wine-clubs","routeSlug":"/openapi/wine-clubs","items":[{"label":"Retrieve a list of wine clubs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/wine-clubs/getwineclubs","routeSlug":"/openapi/wine-clubs/getwineclubs","metadata":{"seo":{"title":"Retrieve a list of wine clubs","description":"🚦 Rate Limit: 100 requests / minute"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWineClubs","name":"Retrieve a list of wine clubs","isWebhook":false,"pointer":"/paths/~1wine-clubs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a list of wine clubs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🚦 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 100 requests / minute"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer token obtained from the authentication endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token Format:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" JWT (JSON Web Token)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expiration:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 30 minutes (1,800,000 microseconds)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Header Format:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_17","description":"Number of records to skip for pagination (default: 0)"},{"name":"pageSize","in":"query","schemaId":"schema_18","description":"Number of records to return per page (default: 1000, max: 1000)"}],"pointer":"/paths/~1wine-clubs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/wine-clubs","servers":[{"url":"https://staging.corksy.io/connect-api/v1","description":"Staging Environment"},{"url":"https://connect-api.corksy.io","description":"Production Environment"}],"parameters":{"path":[],"query":[{"name":"offset","in":"query","required":false,"example":0,"schemaId":"schema_17"},{"name":"pageSize","in":"query","required":false,"example":50,"schemaId":"schema_18"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/wine-clubs","href":"wine-clubs/getwineclubs","openApiOperationId":"getWineClubs","summary":"Retrieve a list of wine clubs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://staging.corksy.io/connect-api/v1","description":"Staging Environment"},{"url":"https://connect-api.corksy.io","description":"Production Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of wine clubs","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WineClubResponse"}},"schemaId":"components/schemas/WineClubResponse"}],"pointer":"/paths/~1wine-clubs/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WineClubResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WineClubResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/wine-clubs/getwineclubs"}],"panels":[]}]},"httpPath":"/wine-clubs"}],"content":{"contentType":"group","meta":{"name":"Wine Clubs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Wine Clubs","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints related to wine clubs"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/wine-clubs","summary":"Retrieve a list of wine clubs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/wine-clubs/getwineclubs","deprecated":false}]}]}]}]}},{"type":"group","label":"Wine Club Members","link":"/openapi/wine-club-members","routeSlug":"/openapi/wine-club-members","items":[{"label":"Retrieve a list of wine-club members","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/wine-club-members/getwineclubmembers","routeSlug":"/openapi/wine-club-members/getwineclubmembers","metadata":{"seo":{"title":"Retrieve a list of wine-club members","description":"🚦 Rate Limit: 100 requests / minute"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWineClubMembers","name":"Retrieve a list of wine-club members","isWebhook":false,"pointer":"/paths/~1wine-club-members/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a list of wine-club members","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🚦 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 100 requests / minute"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer token obtained from the authentication endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token Format:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" JWT (JSON Web Token)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expiration:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 30 minutes (1,800,000 microseconds)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Header Format:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_17","description":"Number of records to skip for pagination (default: 0)"},{"name":"pageSize","in":"query","schemaId":"schema_18","description":"Number of records to return per page (default: 1000, max: 1000)"}],"pointer":"/paths/~1wine-club-members/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/wine-club-members","servers":[{"url":"https://staging.corksy.io/connect-api/v1","description":"Staging Environment"},{"url":"https://connect-api.corksy.io","description":"Production Environment"}],"parameters":{"path":[],"query":[{"name":"offset","in":"query","required":false,"example":0,"schemaId":"schema_17"},{"name":"pageSize","in":"query","required":false,"example":50,"schemaId":"schema_18"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/wine-club-members","href":"wine-club-members/getwineclubmembers","openApiOperationId":"getWineClubMembers","summary":"Retrieve a list of wine-club members"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://staging.corksy.io/connect-api/v1","description":"Staging Environment"},{"url":"https://connect-api.corksy.io","description":"Production Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of wine-club members","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WineClubMemberResponse"}},"schemaId":"components/schemas/WineClubMemberResponse"}],"pointer":"/paths/~1wine-club-members/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WineClubMemberResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WineClubMemberResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/wine-club-members/getwineclubmembers"}],"panels":[]}]},"httpPath":"/wine-club-members"}],"content":{"contentType":"group","meta":{"name":"Wine Club Members"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Wine Club Members","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints related to wine-club members"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/wine-club-members","summary":"Retrieve a list of wine-club members","prefix":{"name":"get","color":"get"},"badges":[],"link":"/wine-club-members/getwineclubmembers","deprecated":false}]}]}]}]}},{"type":"group","label":"Products","link":"/openapi/products","routeSlug":"/openapi/products","items":[{"label":"Retrieve a list of products","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/products/getproducts","routeSlug":"/openapi/products/getproducts","metadata":{"seo":{"title":"Retrieve a list of products","description":"🚦 Rate Limit: 100 requests / minute"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProducts","name":"Retrieve a list of products","isWebhook":false,"pointer":"/paths/~1products/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a list of products","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🚦 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 100 requests / minute"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer token obtained from the authentication endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token Format:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" JWT (JSON Web Token)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expiration:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 30 minutes (1,800,000 microseconds)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Header Format:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"modifiedFromDate","in":"query","schemaId":"schema_20","description":"Filter products modified from this date (ISO 8601 format). Optional - if not provided, no date filtering is applied."},{"name":"modifiedToDate","in":"query","schemaId":"schema_21","description":"Filter products modified up to this date (ISO 8601 format). Cannot be specified without modifiedFromDate."},{"name":"offset","in":"query","schemaId":"schema_17","description":"Number of records to skip for pagination (default: 0)"},{"name":"pageSize","in":"query","schemaId":"schema_18","description":"Number of records to return per page (default: 1000, max: 1000)"}],"pointer":"/paths/~1products/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/products","servers":[{"url":"https://staging.corksy.io/connect-api/v1","description":"Staging Environment"},{"url":"https://connect-api.corksy.io","description":"Production Environment"}],"parameters":{"path":[],"query":[{"name":"modifiedFromDate","in":"query","required":false,"example":"2025-05-01T00:00:00Z","schemaId":"schema_20"},{"name":"modifiedToDate","in":"query","required":false,"example":"2025-05-31T23:59:59Z","schemaId":"schema_21"},{"name":"offset","in":"query","required":false,"example":0,"schemaId":"schema_17"},{"name":"pageSize","in":"query","required":false,"example":50,"schemaId":"schema_18"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/products","href":"products/getproducts","openApiOperationId":"getProducts","summary":"Retrieve a list of products"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://staging.corksy.io/connect-api/v1","description":"Staging Environment"},{"url":"https://connect-api.corksy.io","description":"Production Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of products","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductResponse"}},"schemaId":"components/schemas/ProductResponse"}],"pointer":"/paths/~1products/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProductResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/getproducts"}],"panels":[]}]},"httpPath":"/products"}],"content":{"contentType":"group","meta":{"name":"Products"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Products","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints related to products"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/products","summary":"Retrieve a list of products","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/getproducts","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/PaginationInfo":{"id":"components/schemas/PaginationInfo","kind":"json-schema","title":"PaginationInfo","data":{"type":"object","properties":{"current_offset":{"type":"integer","example":0},"page_size":{"type":"integer","example":50},"total_records":{"type":"integer","example":1250},"total_pages":{"type":"integer","example":25},"current_page":{"type":"integer","example":1},"pages_remaining":{"type":"integer","example":24},"has_next_page":{"type":"boolean","example":true},"has_previous_page":{"type":"boolean","example":false}}}},"components/schemas/Customer":{"id":"components/schemas/Customer","kind":"json-schema","title":"Customer","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"f4a71b9d-17a9-4100-8110-46e133d6fc1b"},"first_name":{"type":"string","example":"Dale"},"last_name":{"type":"string","example":"Cooper"},"email":{"type":"string","example":"dcooper@fbi.gov"},"phone":{"type":"string","example":"+1-202-555-0123"},"shipping_preference_company":{"type":"string","example":"USPS"},"total_orders":{"type":"string","example":"23"},"total_spent":{"type":"number","example":2847.85},"average_order_value":{"type":"number","example":123.82},"date_of_birth":{"type":"string","example":"1960-04-19"},"created_at":{"type":"string","format":"date-time","example":"2023-01-15T10:30:00Z"},"customer_type":{"type":"string","example":"club_member"},"customer_tags":{"type":"string","example":"VIP,Black Lodge"},"class":{"type":"string","example":"Platinum"},"primary_card_expiry_date":{"type":"string","example":"12/26"},"memberships":{"type":"string","example":"Reserve Reds,White Lodge"},"has_password":{"type":"string","example":"true"},"accepts_marketing":{"type":"string","example":"true"},"note":{"type":"string","example":"Prefers cherry pie with orders"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/Address"}},"payment_methods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}}}}},"components/schemas/Address":{"id":"components/schemas/Address","kind":"json-schema","title":"Address","data":{"type":"object","properties":{"first_name":{"type":"string","example":"Dale"},"last_name":{"type":"string","example":"Cooper"},"address_line1":{"type":"string","example":"123 Twin Peaks Way"},"address_line2":{"type":"string","example":"Apt 302"},"city":{"type":"string","example":"Twin Peaks"},"state_name":{"type":"string","example":"Washington"},"state_code":{"type":"string","example":"WA"},"country_name":{"type":"string","example":"United States"},"country_code":{"type":"string","example":"US"},"zip_code":{"type":"string","example":"98065"},"is_primary":{"type":"boolean","example":true}}}},"components/schemas/PaymentMethod":{"id":"components/schemas/PaymentMethod","kind":"json-schema","title":"PaymentMethod","data":{"type":"object","properties":{"last4":{"type":"string","example":"1234"},"brand":{"type":"string","example":"Visa"},"exp_month":{"type":"string","example":"12"},"exp_year":{"type":"string","example":"2026"},"is_primary":{"type":"boolean","example":true},"billing_address":{"type":"object","properties":{"first_name":{"type":"string","example":"Dale"},"last_name":{"type":"string","example":"Cooper"},"address_line1":{"type":"string","example":"123 Twin Peaks Way"},"address_line2":{"type":"string","example":"Apt 302"},"city":{"type":"string","example":"Twin Peaks"},"state":{"type":"string","example":"Washington"},"state_code":{"type":"string","example":"WA"},"country":{"type":"string","example":"United States"},"country_code":{"type":"string","example":"US"},"zip_code":{"type":"string","example":"98065"},"is_primary":{"type":"boolean","example":true}}}}}},"components/schemas/CustomerResponse":{"id":"components/schemas/CustomerResponse","kind":"json-schema","title":"CustomerResponse","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Customer"}},"pagination":{"$ref":"#/components/schemas/PaginationInfo"}}}},"components/schemas/Order":{"id":"components/schemas/Order","kind":"json-schema","title":"Order","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"a6567875-2110-4552-82b9-1297c0287d34"},"customer_id":{"type":"string","format":"uuid","example":"9099eba7-57a9-47ad-bd96-6ea65f32f534"},"inventory_id":{"type":"string","format":"uuid","example":"a5df6eaa-8dc8-4bfb-ba89-9ce0b08a0f88"},"inventory_pool_name":{"type":"string","example":"PayEngine_1"},"is_migrated":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2026-01-22T11:06:15.75512Z"},"order_number":{"type":"integer","example":87452},"created_at":{"type":"string","format":"date-time","example":"2025-05-12T18:32:44Z"},"updated_at":{"type":"string","format":"date-time","example":"2025-05-12T18:32:44Z"},"order_date":{"type":"string","example":"2025-05-12T18:32:44Z"},"first_name":{"type":"string","example":"Dale"},"last_name":{"type":"string","example":"Cooper"},"date_of_birth":{"type":"string","example":"1960-04-19"},"phone":{"type":"string","example":"+1-202-555-0123"},"email":{"type":"string","example":"dcooper@fbi.gov"},"subtotal_price":{"type":"number","example":245},"total_discounts":{"type":"number","example":25},"shipping_price":{"type":"number","example":18.5},"sales_tax":{"type":"number","example":19.85},"crv":{"type":"number","example":1.2},"total_tax":{"type":"number","example":21.05},"total_price":{"type":"number","example":259.55},"tip":{"type":"number","example":10},"delivery_preference":{"type":"string","example":"shipping"},"order_type":{"type":"string","example":"ecommerce"},"order_subtype":{"type":"string","example":"wine_club"},"payment_status":{"type":"string","example":"paid"},"fulfillment_status":{"type":"string","example":"fulfilled"},"item_count":{"type":"integer","example":4},"order_items":{"type":"array","items":{"$ref":"#/components/schemas/OrderItem"},"description":"Array of order line items","example":[{"product_name":"Black Lodge Chardonnay 2022","variant_name":"750 ml Bottle","sku":"BL-CHA-2022-750","quantity":2,"price":38,"product_type":"Wine"},{"product_name":"Twin Peaks Merlot 2021","variant_name":"750 ml Bottle","sku":"TP-MER-2021-750","quantity":1,"price":42,"product_type":"Wine"},{"product_id":"2499c2ac-9486-4bc4-9033-f60450a39fc4","variant_id":"98de4681-da3e-4505-9ad9-425fd6ff1ad2","product_name":"Rush Honey A","variant_name":"1.5 lt","sku":"SOVOS","quantity":2,"price":50,"product_type":"Wine"}]},"order_discounts":{"$ref":"#/components/schemas/OrderDiscounts","description":"Object containing applied discounts","example":{"auto_discount":15,"promocode_discount":10,"pos_discount":null,"custom_discount":null,"discount_code":"AD_Product_Wine_20P","shipping_discount":0,"shipping_discount_code":null}},"shipping_first_name":{"type":"string","example":"Dale"},"shipping_last_name":{"type":"string","example":"Cooper"},"shipping_birth_date":{"type":"string","example":"1960-04-19"},"shipping_phone":{"type":"string","example":"+1-202-555-0123"},"shipping_address_line1":{"type":"string","example":"123 Twin Peaks Way"},"shipping_address_line2":{"type":"string","example":"Apt 302"},"shipping_address_city":{"type":"string","example":"Twin Peaks"},"shipping_address_state":{"type":"string","example":"Washington"},"shipping_address_zip_code":{"type":"string","example":"98065"},"billing_first_name":{"type":"string","example":"Dale"},"billing_last_name":{"type":"string","example":"Cooper"},"billing_birth_date":{"type":"string","example":"1960-04-19"},"billing_phone":{"type":"string","example":"+1-202-555-0123"},"billing_address_line1":{"type":"string","example":"123 Twin Peaks Way"},"billing_address_line2":{"type":"string","example":"Apt 302"},"billing_address_city":{"type":"string","example":"Twin Peaks"},"billing_address_state":{"type":"string","example":"Washington"},"billing_address_zip_code":{"type":"string","example":"98065"},"customer_type":{"type":"string","example":"club_member"},"customer_tags":{"type":"array","items":{"type":"string"},"example":["VIP","Black Lodge"]},"class":{"type":"string","example":"Platinum"},"notes":{"type":"string","example":"Leave with doorman at Great Northern Hotel"},"payment_type":{"type":"string","example":"credit_card"},"club_package_info":{"$ref":"#/components/schemas/ClubPackageInfo","description":"Wine club package details if applicable","example":{"wine_club_name":"Black Lodge Reserve","subscription_package_type":"quarterly","package_number":2025001,"package_type":"red_wine","package_status":"active","payment_date":"2025-01-15T00:00:00Z","open_at":"2025-01-01T00:00:00Z","closed_at":"2025-01-31T23:59:59Z","customer_package_status":"selection_completed","opened_date":"2025-01-01T00:00:00Z","closed_date":"2025-01-31T23:59:59Z","package_message":"Your wine selection has been confirmed","is_selection_completed":true,"wine_club_order_status":"fulfilled","compliance_status":"compliant","wine_club_message":"Package shipped successfully"}},"fulfillment_info":{"type":"array","items":{"$ref":"#/components/schemas/FulfillmentInfo"},"description":"Array of fulfillment tracking and shipping details","example":[{"fulfillment_id":"ful_123456789","fulfillment_number":"FUL-2025-001","status":"fulfilled","shipment_status":"delivered","service":"FedEx Ground","created_at":"2025-05-12T18:32:44Z","updated_at":"2025-05-13T10:15:30Z","tracking":{"company_name":"FedEx","tracking_number":"123456789012","tracking_numbers":["123456789012","123456789013"],"tracking_url":"https://www.fedex.com/tracking?action=track&tracknumbers=123456789012","tracking_urls":["https://www.fedex.com/tracking?action=track&tracknumbers=123456789012","https://www.fedex.com/tracking?action=track&tracknumbers=123456789013"]},"shipping_price":18.5,"fulfillment_type":"shipping","package_slip":"true","notify_customer":true,"history_created_at":"2025-05-12T18:32:44Z"}]},"tender_info":{"type":"array","items":{"$ref":"#/components/schemas/TenderInfo"},"description":"Array of payment tender records","example":[{"payment_type":"credit_card","card_type":"Visa","amount":259.55,"created_at":"2025-05-12T18:32:44Z","status":"paid","last_four":"4242","card_brand":"Visa","card_expiry":{"month":"12","year":"2026"}}]},"order_edit":{"type":"array","description":"Array of order edit records if applicable","items":{"$ref":"#/components/schemas/OrderEdit"}},"gift_card_payment":{"type":"string","enum":["none","partial","full"],"description":"Whether a gift card was used as payment, and how","example":"partial"},"gift_card_redemptions":{"type":"array","items":{"$ref":"#/components/schemas/GiftCardRedemption"},"description":"Array of gift-card redemption records","example":[{"transaction_id":"aded42fb-1032-4086-bbee-5932a7f29074","payment_reference_id":"314417295","product_name":"Gift Card Redeemed","product_type":"gift_card_redemption","quantity":1,"price":100,"created_at":"2025-10-03T15:58:20Z"}]}}}},"components/schemas/OrderResponse":{"id":"components/schemas/OrderResponse","kind":"json-schema","title":"OrderResponse","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Order"}},"pagination":{"$ref":"#/components/schemas/PaginationInfo"}}}},"components/schemas/OrderItem":{"id":"components/schemas/OrderItem","kind":"json-schema","title":"OrderItem","data":{"type":"object","properties":{"product_name":{"type":"string","example":"Black Lodge Chardonnay 2022"},"variant_name":{"type":"string","example":"750 ml Bottle"},"sku":{"type":"string","example":"BL-CHA-2022-750"},"quantity":{"type":"integer","example":2},"price":{"type":"number","example":38},"product_type":{"type":"string","example":"Wine"},"product_id":{"type":"string","format":"uuid","example":"2499c2ac-9486-4bc4-9033-f60450a39fc4"},"variant_id":{"type":"string","format":"uuid","example":"98de4681-da3e-4505-9ad9-425fd6ff1ad2"}}}},"components/schemas/OrderDiscounts":{"id":"components/schemas/OrderDiscounts","kind":"json-schema","title":"OrderDiscounts","data":{"type":"object","properties":{"auto_discount":{"type":"number","example":15,"description":"Wine club automatic discount amount"},"promocode_discount":{"type":"number","example":10,"description":"Promotional code discount amount"},"pos_discount":{"type":"number","example":5,"description":"Point of sale discount amount"},"custom_discount":{"type":"number","example":8.5,"description":"Custom discount amount"},"discount_code":{"type":"string","example":"AD_Product_Wine_20P"},"shipping_discount":{"type":"number","example":0},"shipping_discount_code":{"type":["string","null"],"example":null}}}},"components/schemas/RefundedTotals":{"id":"components/schemas/RefundedTotals","kind":"json-schema","title":"RefundedTotals","data":{"type":"object","description":"Amounts refunded by a single order edit","properties":{"subtotal":{"type":"number","example":205,"description":"Merchandise subtotal refunded"},"total_discounts":{"type":"number","example":20,"description":"Discounts refunded, including wine-club discounts"},"sales_tax":{"type":"number","example":15.89,"description":"Sales-tax amount refunded"},"crv":{"type":"number","example":0,"description":"CRV amount refunded"},"custom_tax":{"type":"number","example":0,"description":"Custom-tax amount refunded"},"total_tax":{"type":"number","example":15.89,"description":"Total tax refunded"},"shipping":{"type":"number","example":0,"description":"Shipping amount refunded"},"total":{"type":"number","example":220.89,"description":"Total amount refunded"}}}},"components/schemas/GiftCardRedemption":{"id":"components/schemas/GiftCardRedemption","kind":"json-schema","title":"GiftCardRedemption","data":{"type":"object","description":"A gift-card redemption applied to an order","properties":{"transaction_id":{"type":"string","format":"uuid","example":"aded42fb-1032-4086-bbee-5932a7f29074"},"payment_reference_id":{"type":["string","null"],"example":"314417295","description":"Processor reference for the redemption"},"product_name":{"type":"string","example":"Gift Card Redeemed"},"product_type":{"type":"string","example":"gift_card_redemption"},"quantity":{"type":"integer","example":1},"price":{"type":"number","example":100,"description":"Amount redeemed from the gift card"},"created_at":{"type":"string","format":"date-time","example":"2025-10-03T15:58:20Z"}}}},"components/schemas/OrderEditItemChange":{"id":"components/schemas/OrderEditItemChange","kind":"json-schema","title":"OrderEditItemChange","data":{"type":"object","properties":{"product_id":{"type":"string","format":"uuid","example":"2499c2ac-9486-4bc4-9033-f60450a39fc4"},"variant_id":{"type":"string","format":"uuid","example":"98de4681-da3e-4505-9ad9-425fd6ff1ad2"},"product_name":{"type":"string","example":"Rush Honey A"},"variant_name":{"type":"string","example":"1.5 lt"},"sku":{"type":"string","example":"SOVOS"},"quantity":{"type":"integer","example":1},"price":{"type":"number","example":50},"product_type":{"type":"string","example":"Wine"},"original_quantity":{"type":["integer","null"],"example":1},"quantity_change":{"type":["integer","null"],"example":1}}}},"components/schemas/OrderEditCurrentOperation":{"id":"components/schemas/OrderEditCurrentOperation","kind":"json-schema","title":"OrderEditCurrentOperation","data":{"type":"object","properties":{"newItems":{"type":"string","example":"0","description":"Number of new items added to the order"},"deletedItems":{"type":"string","example":"0","description":"Number of items removed from the order"},"updatedItems":{"type":"string","example":"0","description":"Number of items modified in the order"}}}},"components/schemas/OrderEdit":{"id":"components/schemas/OrderEdit","kind":"json-schema","title":"OrderEdit","data":{"type":"object","properties":{"order_number":{"type":"integer","example":87452},"order_edit_id":{"type":["string","null"],"format":"uuid","description":"Unique identifier for this order edit","example":"3238192e-9ea6-4ded-b605-cf9813a0d7c3"},"original_order_id":{"type":["string","null"],"format":"uuid","description":"Identifier of the order this edit belongs to","example":"9df22b57-af6e-4ee0-b498-5023b8860ea9"},"original_order_number":{"type":["integer","null"],"description":"Order number of the original order","example":3376},"refunded_totals":{"allOf":[{"$ref":"#/components/schemas/RefundedTotals"}],"description":"Amounts refunded by this order edit"},"created_at":{"type":"string","format":"date-time","example":"2025-05-12T18:32:44Z"},"current_operation":{"$ref":"#/components/schemas/OrderEditCurrentOperation"},"added_items":{"type":"array","description":"Items newly added in this order edit","items":{"$ref":"#/components/schemas/OrderEditItemChange"},"example":[{"product_id":"11111111-1111-1111-1111-111111111111","variant_id":"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa","product_name":"New Wine A","variant_name":"750 ml Bottle","sku":"NEW-WINE-A","quantity":1,"price":30,"product_type":"Wine","original_quantity":null,"quantity_change":null}]},"updated_items":{"type":"array","description":"Items updated in this order edit (quantity increased or decreased)","items":{"$ref":"#/components/schemas/OrderEditItemChange"},"example":[{"product_id":"2499c2ac-9486-4bc4-9033-f60450a39fc4","variant_id":"98de4681-da3e-4505-9ad9-425fd6ff1ad2","product_name":"Rush Honey A","variant_name":"1.5 lt","sku":"SOVOS","quantity":2,"price":50,"product_type":"Wine","original_quantity":1,"quantity_change":1}]},"deleted_items":{"type":"array","description":"Items removed from the order in this edit","items":{"$ref":"#/components/schemas/OrderEditItemChange"},"example":[{"product_id":"33333333-3333-3333-3333-333333333333","variant_id":"bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb","product_name":"Removed Wine B","variant_name":"750 ml Bottle","sku":"DEL-WINE-B","quantity":1,"price":42,"product_type":"Wine","original_quantity":null,"quantity_change":null}]},"summary":{"type":"object","additionalProperties":true,"description":"Summary of the order edit operation (JSON raw message)"},"custom_refund_amount":{"type":"number","example":25},"order_delivery_method":{"type":"string","example":"shipping"},"order_edit_type":{"type":"string","example":"refund"},"status":{"type":"string","example":"completed"},"activity":{"type":"string","example":"Order refunded due to customer request"},"notes":{"type":"string","description":"String containing order edit notes","example":"Customer requested refund for damaged item"}}}},"components/schemas/ClubPackageInfo":{"id":"components/schemas/ClubPackageInfo","kind":"json-schema","title":"ClubPackageInfo","data":{"type":"object","properties":{"wine_club_name":{"type":"string","example":"Black Lodge Reserve"},"subscription_package_type":{"type":"string","example":"quarterly"},"package_number":{"type":"integer","format":"int64","example":2025001},"package_type":{"type":"string","example":"red_wine"},"package_status":{"type":"string","example":"active"},"payment_date":{"type":"string","format":"date-time","example":"2025-01-15T00:00:00Z"},"open_at":{"type":"string","format":"date-time","example":"2025-01-01T00:00:00Z"},"closed_at":{"type":"string","format":"date-time","example":"2025-01-31T23:59:59Z"},"customer_package_status":{"type":"string","example":"selection_completed"},"opened_date":{"type":"string","format":"date-time","example":"2025-01-01T00:00:00Z"},"closed_date":{"type":"string","format":"date-time","example":"2025-01-31T23:59:59Z"},"package_message":{"type":"string","example":"Your wine selection has been confirmed"},"is_selection_completed":{"type":"boolean","example":true},"wine_club_order_status":{"type":"string","example":"fulfilled"},"compliance_status":{"type":"string","example":"compliant"},"wine_club_message":{"type":"string","example":"Package shipped successfully"}}}},"components/schemas/CardExpiry":{"id":"components/schemas/CardExpiry","kind":"json-schema","title":"CardExpiry","data":{"type":"object","properties":{"month":{"type":"string","example":"12"},"year":{"type":"string","example":"2026"}}}},"components/schemas/TenderInfo":{"id":"components/schemas/TenderInfo","kind":"json-schema","title":"TenderInfo","data":{"type":"object","properties":{"payment_type":{"type":"string","example":"credit_card"},"card_type":{"type":"string","example":"Visa"},"amount":{"type":"number","example":259.55},"created_at":{"type":"string","format":"date-time","example":"2025-05-12T18:32:44Z"},"status":{"type":"string","example":"paid"},"last_four":{"type":"string","example":"4242"},"card_brand":{"type":"string","example":"Visa"},"card_expiry":{"$ref":"#/components/schemas/CardExpiry"}}}},"components/schemas/FulfillmentTracking":{"id":"components/schemas/FulfillmentTracking","kind":"json-schema","title":"FulfillmentTracking","data":{"type":"object","properties":{"company_name":{"type":"string","example":"FedEx"},"tracking_number":{"type":"string","example":"123456789012"},"tracking_numbers":{"type":"array","items":{"type":"string"},"example":["123456789012","123456789013"]},"tracking_url":{"type":"string","example":"https://www.fedex.com/tracking?action=track&tracknumbers=123456789012"},"tracking_urls":{"type":"array","items":{"type":"string"},"example":["https://www.fedex.com/tracking?action=track&tracknumbers=123456789012","https://www.fedex.com/tracking?action=track&tracknumbers=123456789013"]}}}},"components/schemas/FulfillmentInfo":{"id":"components/schemas/FulfillmentInfo","kind":"json-schema","title":"FulfillmentInfo","data":{"type":"object","properties":{"fulfillment_id":{"type":"string","example":"ful_123456789"},"fulfillment_number":{"type":"string","example":"FUL-2025-001"},"status":{"type":"string","example":"fulfilled"},"shipment_status":{"type":"string","example":"delivered"},"service":{"type":"string","example":"FedEx Ground"},"created_at":{"type":"string","format":"date-time","example":"2025-05-12T18:32:44Z"},"updated_at":{"type":"string","format":"date-time","example":"2025-05-13T10:15:30Z"},"tracking":{"$ref":"#/components/schemas/FulfillmentTracking"},"shipping_price":{"type":"number","example":18.5},"fulfillment_type":{"type":"string","example":"shipping"},"package_slip":{"type":"string","example":"true"},"notify_customer":{"type":"boolean","example":true},"history_created_at":{"type":"string","format":"date-time","example":"2025-05-12T18:32:44Z"}}}},"components/schemas/Weight":{"id":"components/schemas/Weight","kind":"json-schema","title":"Weight","data":{"type":"object","properties":{"value":{"type":"number","example":1.4},"units":{"type":"string","example":"kg"}}}},"components/schemas/Inventory":{"id":"components/schemas/Inventory","kind":"json-schema","title":"Inventory","data":{"type":"object","properties":{"product_name":{"type":"string","example":"Black Lodge Chardonnay 2022"},"variant_name":{"type":"string","example":"750 ml Bottle"},"sku":{"type":"string","example":"BL-CHA-2022-750"},"product_type":{"type":"string","example":"Wine"},"price":{"type":"number","example":38},"discount_price":{"type":"number","example":34},"cost":{"type":"number","example":18.75},"upc":{"type":"string","example":"012345678905"},"weight":{"$ref":"#/components/schemas/Weight"},"available":{"type":"number","example":298},"available_by_locations":{"type":"object","additionalProperties":true,"description":"JSON object containing inventory levels by location"}}}},"components/schemas/InventoryResponse":{"id":"components/schemas/InventoryResponse","kind":"json-schema","title":"InventoryResponse","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Inventory"}},"pagination":{"$ref":"#/components/schemas/PaginationInfo"}}}},"components/schemas/WineClubProduct":{"id":"components/schemas/WineClubProduct","kind":"json-schema","title":"WineClubProduct","data":{"type":"object","properties":{"variant_id":{"type":"string","format":"uuid","example":"f4a71b9d-17a9-4100-8110-46e133d6fc1b"},"product_name":{"type":"string","example":"Black Lodge Chardonnay 2022"},"sku":{"type":"string","example":"BL-CHA-2022-750"},"default_quantity":{"type":"integer","example":2},"min_quantity":{"type":"integer","example":1},"max_quantity":{"type":"integer","example":6}}}},"components/schemas/Package":{"id":"components/schemas/Package","kind":"json-schema","title":"Package","data":{"type":"object","properties":{"package_id":{"type":"string","format":"uuid","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"package_number":{"type":"integer","example":2025001},"package_type":{"type":"string","example":"red_wine"},"status":{"type":"string","example":"active"},"payment_date":{"type":"string","example":"2025-01-15T00:00:00Z"},"opened_at":{"type":"string","example":"2025-01-01T00:00:00Z"},"closed_at":{"type":"string","example":"2025-01-31T23:59:59Z"},"products":{"type":"array","items":{"$ref":"#/components/schemas/WineClubProduct"}}}}},"components/schemas/WineClub":{"id":"components/schemas/WineClub","kind":"json-schema","title":"WineClub","data":{"type":"object","properties":{"wine_club_name":{"type":"string","example":"Black Lodge Reserve"},"short_description":{"type":"string","example":"Exclusive, limited-release wines from the mysterious Black Lodge collection."},"long_description":{"type":"string","example":"Members receive carefully curated wines from our most enigmatic vineyards—each bottle tells a story of the supernatural and the sublime. Includes exclusive tasting notes and pairing suggestions."},"number_of_shipment":{"type":"string","example":"4"},"frequency":{"type":"string","example":"quarterly"},"open_before_n_days":{"type":"integer","example":21},"close_after_n_days":{"type":"integer","example":7},"price_range":{"type":"string","example":"$220 – $280"},"status":{"type":"string","example":"active"},"publish_date":{"type":"string","example":"2024-11-01T00:00:00Z"},"created_at":{"type":"string","example":"2023-08-15T10:21:37Z"},"default_shipping_rate":{"type":"number","example":28},"active_members":{"type":"integer","example":156},"paused_members":{"type":"integer","example":12},"cancelled_members":{"type":"integer","example":23},"packages":{"type":"array","items":{"$ref":"#/components/schemas/Package"}}}}},"components/schemas/WineClubResponse":{"id":"components/schemas/WineClubResponse","kind":"json-schema","title":"WineClubResponse","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/WineClub"}},"pagination":{"$ref":"#/components/schemas/PaginationInfo"}}}},"components/schemas/WineClubPackageProduct":{"id":"components/schemas/WineClubPackageProduct","kind":"json-schema","title":"WineClubPackageProduct","data":{"type":"object","properties":{"variant_id":{"type":"string","format":"uuid","example":"f4a71b9d-17a9-4100-8110-46e133d6fc1b"},"variant_name":{"type":"string","example":"750 ml Bottle"},"product_id":{"type":"string","format":"uuid","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"product_name":{"type":"string","example":"Black Lodge Chardonnay 2022"},"quantity":{"type":"integer","example":2},"sku":{"type":"string","example":"BL-CHA-2022-750"}}}},"components/schemas/PackageDetails":{"id":"components/schemas/PackageDetails","kind":"json-schema","title":"PackageDetails","data":{"type":"object","properties":{"package_id":{"type":"string","format":"uuid","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"package_number":{"type":"integer","example":2025001},"package_type":{"type":"string","example":"red_wine"},"status":{"type":"string","example":"active"},"opened_date":{"type":"string","example":"2025-01-01"},"canceled_date":{"type":"string","example":"2025-01-01"},"hold_date":{"type":"string","example":"2025-01-01"},"skipped_date":{"type":"string","example":"2025-01-01"},"is_selection_completed":{"type":"boolean","example":true},"delivery_status":{"type":"string","example":"shipped"},"financial_status":{"type":"string","example":"paid"},"products":{"type":"array","items":{"$ref":"#/components/schemas/WineClubPackageProduct"}}}}},"components/schemas/WineClubMember":{"id":"components/schemas/WineClubMember","kind":"json-schema","title":"WineClubMember","data":{"type":"object","properties":{"customer_id":{"type":"string","format":"uuid","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"member_id":{"type":"integer","format":"int64","example":1001},"first_name":{"type":"string","example":"Audrey"},"last_name":{"type":"string","example":"Horne"},"email":{"type":"string","example":"audrey.horne@horneindustries.com"},"phone":{"type":"string","example":"+1-509-555-0198"},"date_of_birth":{"type":"string","example":"1973-08-15"},"club_details":{"type":"object","additionalProperties":true,"description":"JSON object containing wine club membership details"},"billing_address":{"type":"object","additionalProperties":true,"description":"JSON object containing billing address information"},"shipping_address":{"type":"object","additionalProperties":true,"description":"JSON object containing shipping address information"},"payment_method":{"type":"object","additionalProperties":true,"description":"JSON object containing payment method details"},"spouse_details":{"type":"object","additionalProperties":true,"description":"JSON object containing spouse information if applicable"},"status":{"type":"string","example":"active"},"order_delivery_method":{"type":"string","example":"shipping"},"location_details":{"type":"object","additionalProperties":true,"description":"JSON object containing location-specific details"},"package_type":{"type":"string","example":"6 bottles"},"associate":{"type":"string","example":""},"created_at":{"type":"string","example":"2023-09-03T14:57:02Z"},"signup_date":{"type":"string","example":"2023-09-01"},"cancel_date":{"type":"string","example":"2025-01-01"},"cancellation_reason":{"type":"string","example":"Customer requested cancellation"},"hold_date":{"type":"string","example":"2025-01-01"},"package_details":{"type":"array","items":{"$ref":"#/components/schemas/PackageDetails"}}}}},"components/schemas/WineClubMemberResponse":{"id":"components/schemas/WineClubMemberResponse","kind":"json-schema","title":"WineClubMemberResponse","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/WineClubMember"}},"pagination":{"$ref":"#/components/schemas/PaginationInfo"}}}},"components/schemas/Bundle":{"id":"components/schemas/Bundle","kind":"json-schema","title":"Bundle","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"f4a71b9d-17a9-4100-8110-46e133d6fc1b"},"quantity":{"type":"integer","example":2},"variants":{"type":"array","items":{"$ref":"#/components/schemas/Variant"}}}}},"components/schemas/Variant":{"id":"components/schemas/Variant","kind":"json-schema","title":"Variant","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"f4a71b9d-17a9-4100-8110-46e133d6fc1b"},"name":{"type":"string","example":"750ml Bottle"},"sku":{"type":"string","example":"BL-PN-2021-750"},"price":{"type":"number","format":"float","example":42}}}},"components/schemas/Size":{"id":"components/schemas/Size","kind":"json-schema","title":"Size","data":{"type":"object","properties":{"size":{"type":"string","example":"750"},"unit":{"type":"string","example":"ml"}}}},"components/schemas/Image":{"id":"components/schemas/Image","kind":"json-schema","title":"Image","data":{"type":"object","properties":{"src":{"type":"string","example":"https://example.com/images/product.jpg"}}}},"components/schemas/Product":{"id":"components/schemas/Product","kind":"json-schema","title":"Product","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"f4a71b9d-17a9-4100-8110-46e133d6fc1b"},"product_name":{"type":"string","example":"Black Lodge Pinot Noir 2021"},"created_at":{"type":"string","format":"date-time","example":"2024-08-20T10:30:00Z"},"updated_at":{"type":"string","format":"date-time","example":"2024-09-10T14:22:00Z"},"last_modified_at":{"type":"string","format":"date-time","example":"2024-09-10T14:22:00Z"},"product_description":{"type":"string","example":"Elegant aromas of cherry, raspberry, and subtle oak with notes of the supernatural. Aged in the mystical cellars of Twin Peaks."},"tags":{"type":"array","items":{"type":"string"},"example":["limited_release","black_lodge"]},"status":{"type":"string","example":"active"},"published_status":{"type":"string","example":"published"},"published_at_date":{"type":"string","example":"2024-09-10"},"published":{"type":"string","example":"true"},"alcohol_by_volume":{"type":"number","format":"float","example":14.2},"vintage":{"type":"string","example":"2021"},"varietal":{"type":"string","example":"Pinot Noir"},"harvest_date":{"type":"string","example":"2021-09-27"},"acid":{"type":"string","example":"5.8 g/L"},"bottle_date":{"type":"string","example":"2023-02-07"},"pairing_notes":{"type":"string","example":"Cherry pie, wild mushroom risotto, grilled salmon"},"tasting_notes":{"type":"string","example":"Velvety texture, bright red-fruit flavors, subtle spice finish with hints of the cherry"},"min_inventory":{"type":"integer","example":25},"page_title":{"type":"string","example":"Black Lodge Pinot Noir 2021 | Corksy Wines"},"meta_description":{"type":"string","example":"Discover our award-winning Black Lodge Pinot Noir 2021, crafted from premium Twin Peaks vineyards."},"url_handle":{"type":"string","example":"black-lodge-pinot-noir-2021"},"wine_making_notes":{"type":"string","example":"Fermented in small open-top tanks; 18 months in French oak (30% new). Aged in the mystical cellars of Twin Peaks."},"vintage_notes":{"type":"string","example":"Cool spring and warm summer resulted in balanced acidity and supernatural complexity."},"is_available_for_pos":{"type":"boolean","example":true},"is_available_for_online_store":{"type":"boolean","example":true},"exclusive_for_wine_club":{"type":"boolean","example":false},"pos_title":{"type":"string","example":"BL PN 2021"},"upc_code":{"type":"string","example":"012345678912"},"product_type_name":{"type":"string","example":"Wine"},"brand_name":{"type":"string","example":"Corksy"},"product_variants":{"type":"object","additionalProperties":true,"description":"JSON object containing product variant information"},"inventory_items":{"type":"object","additionalProperties":true,"description":"JSON object containing inventory item information"},"bundles":{"type":"array","items":{"$ref":"#/components/schemas/Bundle"},"description":"Array of product bundles"},"appellation":{"type":"string","example":"Willamette Valley AVA"},"sizes":{"type":"array","items":{"$ref":"#/components/schemas/Size"},"description":"Array of available sizes"},"images":{"type":"array","items":{"$ref":"#/components/schemas/Image"},"description":"Array of product images"}}}},"components/schemas/ProductResponse":{"id":"components/schemas/ProductResponse","kind":"json-schema","title":"ProductResponse","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"pagination":{"$ref":"#/components/schemas/PaginationInfo"}}}},"schema_11":{"kind":"json-schema","data":{"type":"object","required":["apiKey"],"properties":{"apiKey":{"type":"string","description":"Your API key obtained from the Admin Settings API page","example":"your-api-key-here"}}},"id":"schema_11"},"schema_12":{"kind":"json-schema","data":{"type":"object","properties":{"accessToken":{"type":"string","description":"JWT bearer token for API access","example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"},"expiresIn":{"type":"integer","description":"Token expiration time in microseconds","example":1800000}},"required":["accessToken","expiresIn"]},"id":"schema_12"},"schema_13":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string","example":"cipher: message authentication failed"}}},"id":"schema_13"},"schema_14":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Rate limit exceeded. Please try again later."}}},"id":"schema_14"},"schema_15":{"kind":"json-schema","data":{"type":"string","format":"date-time","example":"2026-01-01T00:00:00Z"},"id":"schema_15"},"schema_16":{"kind":"json-schema","data":{"type":"string","format":"date-time","example":"2026-01-31T23:59:59Z"},"id":"schema_16"},"schema_17":{"kind":"json-schema","data":{"type":"integer","minimum":0,"example":0},"id":"schema_17"},"schema_18":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":1000,"example":50},"id":"schema_18"},"schema_19":{"kind":"json-schema","data":{"type":"integer","example":21654},"id":"schema_19"},"schema_20":{"kind":"json-schema","data":{"type":"string","format":"date-time","example":"2025-05-01T00:00:00Z"},"id":"schema_20"},"schema_21":{"kind":"json-schema","data":{"type":"string","format":"date-time","example":"2025-05-31T23:59:59Z"},"id":"schema_21"}},"exampleStore":{"paths/~1v1~1auth~1public~1login/post/requestBody/content/application~1json/example":{"value":{"apiKey":"your-api-key-here"},"id":"paths/~1v1~1auth~1public~1login/post/requestBody/content/application~1json/example"}},"securitySchemeStore":{"BearerAuth":{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer token obtained from the authentication endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token Format:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" JWT (JSON Web Token)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expiration:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 30 minutes (1,800,000 microseconds)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Header Format:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\n"},"children":[]}]}]}},"servers":[{"url":"https://staging.corksy.io/connect-api/v1","description":"Staging Environment"},{"url":"https://connect-api.corksy.io","description":"Production Environment"}]},"options":{"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi.json?download"},{"url":"/_bundle/openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Corksy API","description":"API for retrieving orders, customers, inventory, wine-club data, and products.\n\n## Authentication\n\nThis API uses a two-step authentication process:\n\n### Step 1: Generate API Key\nFirst, generate your API key from the Admin Settings API page:\n- Go to: https://admin.corksy.io/settings/apiaccess\n- Create a new API key for your application\n\n### Step 2: Obtain Bearer Token\nUse your API key to obtain a bearer token by making a POST request to the authentication endpoint:\n\n**Production:**\n```bash\ncurl --location 'https://connect-api.corksy.io/v1/auth/public/login' \\\n--header 'Content-Type: application/json' \\\n--data '{\n    \"apiKey\": \"your-api-key-here\"\n}'\n```\n\n**Staging:**\n```bash\ncurl --location 'https://staging.corksy.io/connect-api/v1/auth/public/login' \\\n--header 'Content-Type: application/json' \\\n--data '{\n    \"apiKey\": \"your-api-key-here\"\n}'\n```\n\n**Response:**\n```json\n{\n    \"accessToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\",\n    \"expiresIn\": 1800000\n}\n```\n\n### Step 3: Use Bearer Token\nUse the `accessToken` from the response as a Bearer token in the Authorization header for all subsequent API requests:\n\n**Example Requests:**\n\n**Get Orders:**\n```bash\ncurl --location 'https://connect-api.corksy.io/v1/orders?modifiedFromDate=2025-05-01&modifiedToDate=2025-05-31' \\\n--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'\n```\n\n**Get Customers:**\n```bash\ncurl --location 'https://connect-api.corksy.io/v1/customers' \\\n--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'\n```\n\n**Get Inventory:**\n```bash\ncurl --location 'https://connect-api.corksy.io/v1/inventory' \\\n--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'\n```\n\n**Get Wine Clubs:**\n```bash\ncurl --location 'https://connect-api.corksy.io/v1/wine-clubs' \\\n--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'\n```\n\n**Get Wine Club Members:**\n```bash\ncurl --location 'https://connect-api.corksy.io/v1/wine-club-members' \\\n--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'\n```\n\n**Get Products:**\n```bash\ncurl --location 'https://connect-api.corksy.io/v1/products?modifiedFromDate=2025-05-01&modifiedToDate=2025-05-31' \\\n--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'\n```\n\n**Note:** The bearer token expires after 30 minutes (1,800,000 microseconds). You'll need to obtain a new token when it expires.\n\n## Pagination\n\nAll list endpoints support pagination to handle large datasets efficiently. The API uses offset-based pagination with the following parameters:\n\n### Pagination Parameters\n\n- **`offset`** (optional): Number of records to skip. Default: `0`\n- **`pageSize`** (optional): Number of records to return per page. Default: `1000`, Maximum: `1000`\n\n### Pagination Response\n\nEach paginated response includes a `pagination` object with the following information:\n\n```json\n{\n  \"data\": [...],\n  \"pagination\": {\n    \"current_offset\": 0,\n    \"page_size\": 50,\n    \"total_records\": 1250,\n    \"total_pages\": 25,\n    \"current_page\": 1,\n    \"pages_remaining\": 24,\n    \"has_next_page\": true,\n    \"has_previous_page\": false\n  }\n}\n```\n\n### Pagination Examples\n\n**First Page (Default):**\n```bash\ncurl --location 'https://connect-api.corksy.io/v1/orders?modifiedFromDate=2025-05-01&modifiedToDate=2025-05-31' \\\n--header 'Authorization: Bearer YOUR_TOKEN'\n```\n\n**Second Page (50 records per page):**\n```bash\ncurl --location 'https://connect-api.corksy.io/v1/orders?modifiedFromDate=2025-05-01&modifiedToDate=2025-05-31&offset=50&pageSize=50' \\\n--header 'Authorization: Bearer YOUR_TOKEN'\n```\n\n**Custom Page Size:**\n```bash\ncurl --location 'https://connect-api.corksy.io/v1/orders?modifiedFromDate=2025-05-01&modifiedToDate=2025-05-31&pageSize=100' \\\n--header 'Authorization: Bearer YOUR_TOKEN'\n```\n\n### Best Practices\n\n1. **Start with the first page** (no parameters or `offset=0`)\n2. **Use `has_next_page`** to determine if more pages exist\n3. **Increment `offset` by `page_size`** to get the next page\n4. **Choose appropriate `page_size`** based on your needs. \n5. **Handle rate limits** - each page request counts toward your rate limit\n"}},"baseSlug":"/openapi","routesMapping":{}}