{"openapi":"3.1.0","paths":{"/v1/catalogue":{"get":{"description":"Retrieves products based on top categories and top products within a category.","operationId":"catalogue","parameters":[{"name":"page","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"type":"integer","minimum":0,"exclusiveMinimum":true,"description":"Page number","default":1}},{"name":"limit","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"type":"integer","minimum":0,"exclusiveMinimum":true,"maximum":200,"description":"Page size","default":20}},{"name":"search","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"type":"string","description":"Search query"}},{"name":"filters","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"type":"object","properties":{"price":{"type":"object","properties":{"eq":{"type":"number"},"gt":{"type":"number"},"lt":{"type":"number"}}},"tag":{"type":"object","properties":{"eq":{"type":"string"},"neq":{"type":"string"}}}}}},{"name":"sort","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"type":"object","properties":{"asc":{"type":"string","enum":["price"]},"desc":{"type":"string","enum":["price"]}},"additionalProperties":false}},{"name":"latLng","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"type":"string","example":"-1.2944722,36.8218611","description":"Latitude and longitude of the location, comma separated (Lat,Lng)"}},{"name":"deliveryMethod","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"type":"string","enum":["pickup","delivery"],"default":"pickup"}}],"responses":{"200":{"description":"Success. Returns the home catalogue","content":{"application/json":{"schema":{"type":"object","properties":{"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":["string","null"]},"imageUrl":{"type":["string","null"]},"parentId":{"type":["string","null"]},"children":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":["string","null"]},"imageUrl":{"type":["string","null"]},"parentId":{"type":["string","null"]}},"required":["id","name","parentId"]}}},"required":["id","name","parentId","children"]}},"selectedCategory":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"products":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string","minLength":1},"unitPrice":{"type":"number"},"metadata":{"type":"object","properties":{"batchSize":{"type":"number"},"minimumOrder":{"type":"number"},"unitOfMeasure":{"type":"string","minLength":1},"weight":{"type":"number"},"category":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string","minLength":1},"description":{"type":["string","null"]}},"required":["id","name"]},"brand":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string","minLength":1},"image":{"type":["string","null"],"format":"uri"}},"required":["id","name"]},"description":{"type":["string","null"]},"minPrice":{"type":"number"},"maxPrice":{"type":"number"},"locationPrices":{"type":["array","null"],"items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"unitPrice":{"type":"number"},"priceBookId":{"type":"string","description":"The price book that the price is associated with"},"priceBookEntryId":{"type":"string","description":"The price book entry that the price is associated with"},"type":{"type":"string","enum":["warehouse","dropship","virtual"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["platform_fulfilled"],"default":"platform_fulfilled"},"deliveryRadiusMeters":{"type":["number","null"]},"minimumOrderQty":{"type":"number","default":1},"address":{"type":["object","null"],"properties":{"id":{"type":["string","null"]},"addressLine1":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":["string","null"]},"latLng":{"type":["object","null"],"properties":{"lat":{"type":["number","null"]},"lng":{"type":["number","null"]}}},"distance":{"type":"number"}}},"priceBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string"},"sortOrder":{"type":"number"},"type":{"type":["string","null"],"enum":["featured",null]}},"required":["id"]}},"required":["id","name","unitPrice","priceBookId","priceBookEntryId","type","fulfillmentType","minimumOrderQty"]}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","minLength":1}},"required":["id","name"]},"default":[]},"media":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":["string","null"],"format":"uri"},"altText":{"type":["string","null"]}},"required":["id"]},"default":[]},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"position":{"type":"number"},"values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string","minLength":1},"isAvailable":{"type":"boolean","default":false}},"required":["id","value","isAvailable"]}}},"required":["id","name","position","values"]},"default":[]},"variants":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"sku":{"type":["string","null"]},"title":{"type":"string","minLength":1},"price":{"type":"number"},"cost":{"type":["number","null"]},"compareAtPrice":{"type":["number","null"]},"weight":{"type":"number"},"selectedOptions":{"type":"array","items":{"type":"object","properties":{"optionId":{"type":"string"},"optionName":{"type":"string"},"optionValueId":{"type":"string"},"optionValue":{"type":"string"}},"required":["optionId","optionName","optionValueId","optionValue"]}},"locationPrices":{"type":["array","null"],"items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"unitPrice":{"type":"number"},"priceBookId":{"type":"string","description":"The price book that the price is associated with"},"priceBookEntryId":{"type":"string","description":"The price book entry that the price is associated with"},"type":{"type":"string","enum":["warehouse","dropship","virtual"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["platform_fulfilled"],"default":"platform_fulfilled"},"deliveryRadiusMeters":{"type":["number","null"]},"minimumOrderQty":{"type":"number","default":1},"address":{"type":["object","null"],"properties":{"id":{"type":["string","null"]},"addressLine1":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":["string","null"]},"latLng":{"type":["object","null"],"properties":{"lat":{"type":["number","null"]},"lng":{"type":["number","null"]}}},"distance":{"type":"number"}}},"priceBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string"},"sortOrder":{"type":"number"},"type":{"type":["string","null"],"enum":["featured",null]}},"required":["id"]}},"required":["id","name","unitPrice","priceBookId","priceBookEntryId","type","fulfillmentType","minimumOrderQty"]}},"offers":{"type":"array","items":{"type":"object","properties":{"seller":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"location":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"price":{"type":["number","null"]},"minimumOrderQty":{"type":["number","null"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["seller_fulfilled","platform_fulfilled"]},"deliveryRadiusMeters":{"type":["number","null"]},"address":{"type":["object","null"],"properties":{"id":{"type":"string"},"addressLine1":{"type":"string"},"addressLine2":{"type":["string","null"]},"city":{"type":["string","null"]},"country":{"type":"string"},"latLng":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"distance":{"type":["number","null"]}},"required":["id","addressLine1","addressLine2","city","country","latLng"]},"distance":{"type":["number","null"]}},"required":["id","name","price","fulfillmentType","address"]},"priceBookId":{"type":["string","null"]}},"required":["seller","location"]},"default":[]},"cheapestOffer":{"type":["object","null"],"properties":{"seller":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"location":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"address":{"type":["object","null"],"properties":{"id":{"type":"string"},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":"string"},"latLng":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"addressLine1":{"type":"string"},"addressLine2":{"type":["string","null"]},"distance":{"type":["number","null"]}},"required":["id","city","state","country","latLng","addressLine1","addressLine2"]},"distance":{"type":["number","null"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["seller_fulfilled","platform_fulfilled"],"default":"platform_fulfilled"},"deliveryRadiusMeters":{"type":["number","null"]},"minimumOrderQty":{"type":"number","default":1}},"required":["id","name","fulfillmentType","minimumOrderQty"]},"price":{"type":"number"},"priceBookId":{"type":"string"},"locationId":{"type":"string"},"productId":{"type":"string"},"productVariantId":{"type":["string","null"]},"priceBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string"},"sortOrder":{"type":"number"},"type":{"type":["string","null"],"enum":["featured",null]}},"required":["id"]}},"required":["seller","location","price","priceBookId","locationId","productId"]},"bestOffer":{"type":["object","null"],"properties":{"seller":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"location":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"address":{"type":["object","null"],"properties":{"id":{"type":"string"},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":"string"},"latLng":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"addressLine1":{"type":"string"},"addressLine2":{"type":["string","null"]},"distance":{"type":["number","null"]}},"required":["id","city","state","country","latLng","addressLine1","addressLine2"]},"distance":{"type":["number","null"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["seller_fulfilled","platform_fulfilled"],"default":"platform_fulfilled"},"deliveryRadiusMeters":{"type":["number","null"]},"minimumOrderQty":{"type":"number","default":1}},"required":["id","name","fulfillmentType","minimumOrderQty"]},"price":{"type":"number"},"priceBookId":{"type":"string"},"locationId":{"type":"string"},"productId":{"type":"string"},"productVariantId":{"type":["string","null"]},"priceBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string"},"sortOrder":{"type":"number"},"type":{"type":["string","null"],"enum":["featured",null]}},"required":["id"]}},"required":["seller","location","price","priceBookId","locationId","productId"]},"hasCheaperOffer":{"type":"boolean","default":false}},"required":["id","title","price","selectedOptions","offers","hasCheaperOffer"]},"default":[]},"priceBookId":{"type":"string"},"offers":{"type":"array","items":{"type":"object","properties":{"seller":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"location":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"price":{"type":["number","null"]},"minimumOrderQty":{"type":["number","null"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["seller_fulfilled","platform_fulfilled"]},"deliveryRadiusMeters":{"type":["number","null"]},"address":{"type":["object","null"],"properties":{"id":{"type":"string"},"addressLine1":{"type":"string"},"addressLine2":{"type":["string","null"]},"city":{"type":["string","null"]},"country":{"type":"string"},"latLng":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"distance":{"type":["number","null"]}},"required":["id","addressLine1","addressLine2","city","country","latLng"]},"distance":{"type":["number","null"]}},"required":["id","name","price","fulfillmentType","address"]},"priceBookId":{"type":["string","null"]}},"required":["seller","location"]},"default":[]},"cheapestOffer":{"type":["object","null"],"properties":{"seller":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"location":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"address":{"type":["object","null"],"properties":{"id":{"type":"string"},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":"string"},"latLng":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"addressLine1":{"type":"string"},"addressLine2":{"type":["string","null"]},"distance":{"type":["number","null"]}},"required":["id","city","state","country","latLng","addressLine1","addressLine2"]},"distance":{"type":["number","null"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["seller_fulfilled","platform_fulfilled"],"default":"platform_fulfilled"},"deliveryRadiusMeters":{"type":["number","null"]},"minimumOrderQty":{"type":"number","default":1}},"required":["id","name","fulfillmentType","minimumOrderQty"]},"price":{"type":"number"},"priceBookId":{"type":"string"},"locationId":{"type":"string"},"productId":{"type":"string"},"productVariantId":{"type":["string","null"]},"priceBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string"},"sortOrder":{"type":"number"},"type":{"type":["string","null"],"enum":["featured",null]}},"required":["id"]}},"required":["seller","location","price","priceBookId","locationId","productId"]},"bestOffer":{"type":["object","null"],"properties":{"seller":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"location":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"address":{"type":["object","null"],"properties":{"id":{"type":"string"},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":"string"},"latLng":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"addressLine1":{"type":"string"},"addressLine2":{"type":["string","null"]},"distance":{"type":["number","null"]}},"required":["id","city","state","country","latLng","addressLine1","addressLine2"]},"distance":{"type":["number","null"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["seller_fulfilled","platform_fulfilled"],"default":"platform_fulfilled"},"deliveryRadiusMeters":{"type":["number","null"]},"minimumOrderQty":{"type":"number","default":1}},"required":["id","name","fulfillmentType","minimumOrderQty"]},"price":{"type":"number"},"priceBookId":{"type":"string"},"locationId":{"type":"string"},"productId":{"type":"string"},"productVariantId":{"type":["string","null"]},"priceBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string"},"sortOrder":{"type":"number"},"type":{"type":["string","null"],"enum":["featured",null]}},"required":["id"]}},"required":["seller","location","price","priceBookId","locationId","productId"]},"hasCheaperOffer":{"type":"boolean","default":false}},"required":["unitOfMeasure","tags","media","options","variants","offers","hasCheaperOffer"]}},"required":["id","title","unitPrice","metadata"]}}},"required":["id","name","products"]}},"required":["categories","selectedCategory"]}}}}},"summary":"Get home catalogue","tags":["Catalogue"],"x-speakeasy-name-override":"getHomeCatalogue"}},"/v1/catalogue/featured":{"get":{"description":"Retrieves products from featured price book entries.","operationId":"featured-catalogue","parameters":[{"name":"page","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"type":"integer","minimum":0,"exclusiveMinimum":true,"description":"Page number","default":1}},{"name":"limit","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"type":"integer","minimum":0,"exclusiveMinimum":true,"maximum":200,"description":"Page size","default":20}},{"name":"search","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"type":"string","description":"Search query"}},{"name":"filters","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"type":"object","properties":{"price":{"type":"object","properties":{"eq":{"type":"number"},"gt":{"type":"number"},"lt":{"type":"number"}}},"tag":{"type":"object","properties":{"eq":{"type":"string"},"neq":{"type":"string"}}}}}},{"name":"sort","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"type":"object","properties":{"asc":{"type":"string","enum":["price"]},"desc":{"type":"string","enum":["price"]}},"additionalProperties":false}},{"name":"latLng","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"type":"string","example":"-1.2944722,36.8218611","description":"Latitude and longitude of the location, comma separated (Lat,Lng)"}},{"name":"deliveryMethod","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"type":"string","enum":["pickup","delivery"],"default":"pickup"}}],"responses":{"200":{"description":"Success. Returns the featured catalogue","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"products":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string","minLength":1},"unitPrice":{"type":"number"},"metadata":{"type":"object","properties":{"batchSize":{"type":"number"},"minimumOrder":{"type":"number"},"unitOfMeasure":{"type":"string","minLength":1},"weight":{"type":"number"},"category":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string","minLength":1},"description":{"type":["string","null"]}},"required":["id","name"]},"brand":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string","minLength":1},"image":{"type":["string","null"],"format":"uri"}},"required":["id","name"]},"description":{"type":["string","null"]},"minPrice":{"type":"number"},"maxPrice":{"type":"number"},"locationPrices":{"type":["array","null"],"items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"unitPrice":{"type":"number"},"priceBookId":{"type":"string","description":"The price book that the price is associated with"},"priceBookEntryId":{"type":"string","description":"The price book entry that the price is associated with"},"type":{"type":"string","enum":["warehouse","dropship","virtual"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["platform_fulfilled"],"default":"platform_fulfilled"},"deliveryRadiusMeters":{"type":["number","null"]},"minimumOrderQty":{"type":"number","default":1},"address":{"type":["object","null"],"properties":{"id":{"type":["string","null"]},"addressLine1":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":["string","null"]},"latLng":{"type":["object","null"],"properties":{"lat":{"type":["number","null"]},"lng":{"type":["number","null"]}}},"distance":{"type":"number"}}},"priceBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string"},"sortOrder":{"type":"number"},"type":{"type":["string","null"],"enum":["featured",null]}},"required":["id"]}},"required":["id","name","unitPrice","priceBookId","priceBookEntryId","type","fulfillmentType","minimumOrderQty"]}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","minLength":1}},"required":["id","name"]},"default":[]},"media":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":["string","null"],"format":"uri"},"altText":{"type":["string","null"]}},"required":["id"]},"default":[]},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"position":{"type":"number"},"values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string","minLength":1},"isAvailable":{"type":"boolean","default":false}},"required":["id","value","isAvailable"]}}},"required":["id","name","position","values"]},"default":[]},"variants":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"sku":{"type":["string","null"]},"title":{"type":"string","minLength":1},"price":{"type":"number"},"cost":{"type":["number","null"]},"compareAtPrice":{"type":["number","null"]},"weight":{"type":"number"},"selectedOptions":{"type":"array","items":{"type":"object","properties":{"optionId":{"type":"string"},"optionName":{"type":"string"},"optionValueId":{"type":"string"},"optionValue":{"type":"string"}},"required":["optionId","optionName","optionValueId","optionValue"]}},"locationPrices":{"type":["array","null"],"items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"unitPrice":{"type":"number"},"priceBookId":{"type":"string","description":"The price book that the price is associated with"},"priceBookEntryId":{"type":"string","description":"The price book entry that the price is associated with"},"type":{"type":"string","enum":["warehouse","dropship","virtual"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["platform_fulfilled"],"default":"platform_fulfilled"},"deliveryRadiusMeters":{"type":["number","null"]},"minimumOrderQty":{"type":"number","default":1},"address":{"type":["object","null"],"properties":{"id":{"type":["string","null"]},"addressLine1":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":["string","null"]},"latLng":{"type":["object","null"],"properties":{"lat":{"type":["number","null"]},"lng":{"type":["number","null"]}}},"distance":{"type":"number"}}},"priceBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string"},"sortOrder":{"type":"number"},"type":{"type":["string","null"],"enum":["featured",null]}},"required":["id"]}},"required":["id","name","unitPrice","priceBookId","priceBookEntryId","type","fulfillmentType","minimumOrderQty"]}},"offers":{"type":"array","items":{"type":"object","properties":{"seller":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"location":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"price":{"type":["number","null"]},"minimumOrderQty":{"type":["number","null"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["seller_fulfilled","platform_fulfilled"]},"deliveryRadiusMeters":{"type":["number","null"]},"address":{"type":["object","null"],"properties":{"id":{"type":"string"},"addressLine1":{"type":"string"},"addressLine2":{"type":["string","null"]},"city":{"type":["string","null"]},"country":{"type":"string"},"latLng":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"distance":{"type":["number","null"]}},"required":["id","addressLine1","addressLine2","city","country","latLng"]},"distance":{"type":["number","null"]}},"required":["id","name","price","fulfillmentType","address"]},"priceBookId":{"type":["string","null"]}},"required":["seller","location"]},"default":[]},"cheapestOffer":{"type":["object","null"],"properties":{"seller":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"location":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"address":{"type":["object","null"],"properties":{"id":{"type":"string"},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":"string"},"latLng":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"addressLine1":{"type":"string"},"addressLine2":{"type":["string","null"]},"distance":{"type":["number","null"]}},"required":["id","city","state","country","latLng","addressLine1","addressLine2"]},"distance":{"type":["number","null"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["seller_fulfilled","platform_fulfilled"],"default":"platform_fulfilled"},"deliveryRadiusMeters":{"type":["number","null"]},"minimumOrderQty":{"type":"number","default":1}},"required":["id","name","fulfillmentType","minimumOrderQty"]},"price":{"type":"number"},"priceBookId":{"type":"string"},"locationId":{"type":"string"},"productId":{"type":"string"},"productVariantId":{"type":["string","null"]},"priceBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string"},"sortOrder":{"type":"number"},"type":{"type":["string","null"],"enum":["featured",null]}},"required":["id"]}},"required":["seller","location","price","priceBookId","locationId","productId"]},"bestOffer":{"type":["object","null"],"properties":{"seller":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"location":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"address":{"type":["object","null"],"properties":{"id":{"type":"string"},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":"string"},"latLng":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"addressLine1":{"type":"string"},"addressLine2":{"type":["string","null"]},"distance":{"type":["number","null"]}},"required":["id","city","state","country","latLng","addressLine1","addressLine2"]},"distance":{"type":["number","null"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["seller_fulfilled","platform_fulfilled"],"default":"platform_fulfilled"},"deliveryRadiusMeters":{"type":["number","null"]},"minimumOrderQty":{"type":"number","default":1}},"required":["id","name","fulfillmentType","minimumOrderQty"]},"price":{"type":"number"},"priceBookId":{"type":"string"},"locationId":{"type":"string"},"productId":{"type":"string"},"productVariantId":{"type":["string","null"]},"priceBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string"},"sortOrder":{"type":"number"},"type":{"type":["string","null"],"enum":["featured",null]}},"required":["id"]}},"required":["seller","location","price","priceBookId","locationId","productId"]},"hasCheaperOffer":{"type":"boolean","default":false}},"required":["id","title","price","selectedOptions","offers","hasCheaperOffer"]},"default":[]},"priceBookId":{"type":"string"},"offers":{"type":"array","items":{"type":"object","properties":{"seller":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"location":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"price":{"type":["number","null"]},"minimumOrderQty":{"type":["number","null"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["seller_fulfilled","platform_fulfilled"]},"deliveryRadiusMeters":{"type":["number","null"]},"address":{"type":["object","null"],"properties":{"id":{"type":"string"},"addressLine1":{"type":"string"},"addressLine2":{"type":["string","null"]},"city":{"type":["string","null"]},"country":{"type":"string"},"latLng":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"distance":{"type":["number","null"]}},"required":["id","addressLine1","addressLine2","city","country","latLng"]},"distance":{"type":["number","null"]}},"required":["id","name","price","fulfillmentType","address"]},"priceBookId":{"type":["string","null"]}},"required":["seller","location"]},"default":[]},"cheapestOffer":{"type":["object","null"],"properties":{"seller":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"location":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"address":{"type":["object","null"],"properties":{"id":{"type":"string"},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":"string"},"latLng":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"addressLine1":{"type":"string"},"addressLine2":{"type":["string","null"]},"distance":{"type":["number","null"]}},"required":["id","city","state","country","latLng","addressLine1","addressLine2"]},"distance":{"type":["number","null"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["seller_fulfilled","platform_fulfilled"],"default":"platform_fulfilled"},"deliveryRadiusMeters":{"type":["number","null"]},"minimumOrderQty":{"type":"number","default":1}},"required":["id","name","fulfillmentType","minimumOrderQty"]},"price":{"type":"number"},"priceBookId":{"type":"string"},"locationId":{"type":"string"},"productId":{"type":"string"},"productVariantId":{"type":["string","null"]},"priceBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string"},"sortOrder":{"type":"number"},"type":{"type":["string","null"],"enum":["featured",null]}},"required":["id"]}},"required":["seller","location","price","priceBookId","locationId","productId"]},"bestOffer":{"type":["object","null"],"properties":{"seller":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"location":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"address":{"type":["object","null"],"properties":{"id":{"type":"string"},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":"string"},"latLng":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"addressLine1":{"type":"string"},"addressLine2":{"type":["string","null"]},"distance":{"type":["number","null"]}},"required":["id","city","state","country","latLng","addressLine1","addressLine2"]},"distance":{"type":["number","null"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["seller_fulfilled","platform_fulfilled"],"default":"platform_fulfilled"},"deliveryRadiusMeters":{"type":["number","null"]},"minimumOrderQty":{"type":"number","default":1}},"required":["id","name","fulfillmentType","minimumOrderQty"]},"price":{"type":"number"},"priceBookId":{"type":"string"},"locationId":{"type":"string"},"productId":{"type":"string"},"productVariantId":{"type":["string","null"]},"priceBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string"},"sortOrder":{"type":"number"},"type":{"type":["string","null"],"enum":["featured",null]}},"required":["id"]}},"required":["seller","location","price","priceBookId","locationId","productId"]},"hasCheaperOffer":{"type":"boolean","default":false}},"required":["unitOfMeasure","tags","media","options","variants","offers","hasCheaperOffer"]}},"required":["id","title","unitPrice","metadata"]}},"metadata":{"type":"object","properties":{"pagination":{"type":"object","properties":{"total":{"type":"number","description":"Total number of results"},"page":{"type":"number","description":"Current page number"},"limit":{"type":"number","description":"Page size"},"hasNextPage":{"type":"boolean","description":"Whether or not there is a next page"}},"required":["total","page","limit","hasNextPage"]},"sortedBy":{"type":"object","additionalProperties":{"type":"string","enum":["asc","desc"]}},"filteredBy":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{}}}}}},"required":["name","products","metadata"]}}}}},"summary":"Get featured catalogue","tags":["Catalogue"],"x-speakeasy-name-override":"getFeaturedCatalogue"}},"/v1/catalogue/{id}":{"get":{"description":"Retrieves top products for a specific category.","operationId":"catalogue-by-category","parameters":[{"name":"id","required":true,"in":"path","description":"Category ID","schema":{"type":"string"}},{"name":"page","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"type":"integer","minimum":0,"exclusiveMinimum":true,"description":"Page number","default":1}},{"name":"limit","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"type":"integer","minimum":0,"exclusiveMinimum":true,"maximum":200,"description":"Page size","default":20}},{"name":"search","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"type":"string","description":"Search query"}},{"name":"filters","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"type":"object","properties":{"price":{"type":"object","properties":{"eq":{"type":"number"},"gt":{"type":"number"},"lt":{"type":"number"}}},"tag":{"type":"object","properties":{"eq":{"type":"string"},"neq":{"type":"string"}}}}}},{"name":"sort","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"type":"object","properties":{"asc":{"type":"string","enum":["price"]},"desc":{"type":"string","enum":["price"]}},"additionalProperties":false}},{"name":"latLng","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"type":"string","example":"-1.2944722,36.8218611","description":"Latitude and longitude of the location, comma separated (Lat,Lng)"}},{"name":"deliveryMethod","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"type":"string","enum":["pickup","delivery"],"default":"pickup"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"products":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string","minLength":1},"unitPrice":{"type":"number"},"metadata":{"type":"object","properties":{"batchSize":{"type":"number"},"minimumOrder":{"type":"number"},"unitOfMeasure":{"type":"string","minLength":1},"weight":{"type":"number"},"category":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string","minLength":1},"description":{"type":["string","null"]}},"required":["id","name"]},"brand":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string","minLength":1},"image":{"type":["string","null"],"format":"uri"}},"required":["id","name"]},"description":{"type":["string","null"]},"minPrice":{"type":"number"},"maxPrice":{"type":"number"},"locationPrices":{"type":["array","null"],"items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"unitPrice":{"type":"number"},"priceBookId":{"type":"string","description":"The price book that the price is associated with"},"priceBookEntryId":{"type":"string","description":"The price book entry that the price is associated with"},"type":{"type":"string","enum":["warehouse","dropship","virtual"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["platform_fulfilled"],"default":"platform_fulfilled"},"deliveryRadiusMeters":{"type":["number","null"]},"minimumOrderQty":{"type":"number","default":1},"address":{"type":["object","null"],"properties":{"id":{"type":["string","null"]},"addressLine1":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":["string","null"]},"latLng":{"type":["object","null"],"properties":{"lat":{"type":["number","null"]},"lng":{"type":["number","null"]}}},"distance":{"type":"number"}}},"priceBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string"},"sortOrder":{"type":"number"},"type":{"type":["string","null"],"enum":["featured",null]}},"required":["id"]}},"required":["id","name","unitPrice","priceBookId","priceBookEntryId","type","fulfillmentType","minimumOrderQty"]}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","minLength":1}},"required":["id","name"]},"default":[]},"media":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":["string","null"],"format":"uri"},"altText":{"type":["string","null"]}},"required":["id"]},"default":[]},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"position":{"type":"number"},"values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string","minLength":1},"isAvailable":{"type":"boolean","default":false}},"required":["id","value","isAvailable"]}}},"required":["id","name","position","values"]},"default":[]},"variants":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"sku":{"type":["string","null"]},"title":{"type":"string","minLength":1},"price":{"type":"number"},"cost":{"type":["number","null"]},"compareAtPrice":{"type":["number","null"]},"weight":{"type":"number"},"selectedOptions":{"type":"array","items":{"type":"object","properties":{"optionId":{"type":"string"},"optionName":{"type":"string"},"optionValueId":{"type":"string"},"optionValue":{"type":"string"}},"required":["optionId","optionName","optionValueId","optionValue"]}},"locationPrices":{"type":["array","null"],"items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"unitPrice":{"type":"number"},"priceBookId":{"type":"string","description":"The price book that the price is associated with"},"priceBookEntryId":{"type":"string","description":"The price book entry that the price is associated with"},"type":{"type":"string","enum":["warehouse","dropship","virtual"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["platform_fulfilled"],"default":"platform_fulfilled"},"deliveryRadiusMeters":{"type":["number","null"]},"minimumOrderQty":{"type":"number","default":1},"address":{"type":["object","null"],"properties":{"id":{"type":["string","null"]},"addressLine1":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":["string","null"]},"latLng":{"type":["object","null"],"properties":{"lat":{"type":["number","null"]},"lng":{"type":["number","null"]}}},"distance":{"type":"number"}}},"priceBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string"},"sortOrder":{"type":"number"},"type":{"type":["string","null"],"enum":["featured",null]}},"required":["id"]}},"required":["id","name","unitPrice","priceBookId","priceBookEntryId","type","fulfillmentType","minimumOrderQty"]}},"offers":{"type":"array","items":{"type":"object","properties":{"seller":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"location":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"price":{"type":["number","null"]},"minimumOrderQty":{"type":["number","null"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["seller_fulfilled","platform_fulfilled"]},"deliveryRadiusMeters":{"type":["number","null"]},"address":{"type":["object","null"],"properties":{"id":{"type":"string"},"addressLine1":{"type":"string"},"addressLine2":{"type":["string","null"]},"city":{"type":["string","null"]},"country":{"type":"string"},"latLng":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"distance":{"type":["number","null"]}},"required":["id","addressLine1","addressLine2","city","country","latLng"]},"distance":{"type":["number","null"]}},"required":["id","name","price","fulfillmentType","address"]},"priceBookId":{"type":["string","null"]}},"required":["seller","location"]},"default":[]},"cheapestOffer":{"type":["object","null"],"properties":{"seller":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"location":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"address":{"type":["object","null"],"properties":{"id":{"type":"string"},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":"string"},"latLng":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"addressLine1":{"type":"string"},"addressLine2":{"type":["string","null"]},"distance":{"type":["number","null"]}},"required":["id","city","state","country","latLng","addressLine1","addressLine2"]},"distance":{"type":["number","null"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["seller_fulfilled","platform_fulfilled"],"default":"platform_fulfilled"},"deliveryRadiusMeters":{"type":["number","null"]},"minimumOrderQty":{"type":"number","default":1}},"required":["id","name","fulfillmentType","minimumOrderQty"]},"price":{"type":"number"},"priceBookId":{"type":"string"},"locationId":{"type":"string"},"productId":{"type":"string"},"productVariantId":{"type":["string","null"]},"priceBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string"},"sortOrder":{"type":"number"},"type":{"type":["string","null"],"enum":["featured",null]}},"required":["id"]}},"required":["seller","location","price","priceBookId","locationId","productId"]},"bestOffer":{"type":["object","null"],"properties":{"seller":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"location":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"address":{"type":["object","null"],"properties":{"id":{"type":"string"},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":"string"},"latLng":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"addressLine1":{"type":"string"},"addressLine2":{"type":["string","null"]},"distance":{"type":["number","null"]}},"required":["id","city","state","country","latLng","addressLine1","addressLine2"]},"distance":{"type":["number","null"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["seller_fulfilled","platform_fulfilled"],"default":"platform_fulfilled"},"deliveryRadiusMeters":{"type":["number","null"]},"minimumOrderQty":{"type":"number","default":1}},"required":["id","name","fulfillmentType","minimumOrderQty"]},"price":{"type":"number"},"priceBookId":{"type":"string"},"locationId":{"type":"string"},"productId":{"type":"string"},"productVariantId":{"type":["string","null"]},"priceBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string"},"sortOrder":{"type":"number"},"type":{"type":["string","null"],"enum":["featured",null]}},"required":["id"]}},"required":["seller","location","price","priceBookId","locationId","productId"]},"hasCheaperOffer":{"type":"boolean","default":false}},"required":["id","title","price","selectedOptions","offers","hasCheaperOffer"]},"default":[]},"priceBookId":{"type":"string"},"offers":{"type":"array","items":{"type":"object","properties":{"seller":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"location":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"price":{"type":["number","null"]},"minimumOrderQty":{"type":["number","null"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["seller_fulfilled","platform_fulfilled"]},"deliveryRadiusMeters":{"type":["number","null"]},"address":{"type":["object","null"],"properties":{"id":{"type":"string"},"addressLine1":{"type":"string"},"addressLine2":{"type":["string","null"]},"city":{"type":["string","null"]},"country":{"type":"string"},"latLng":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"distance":{"type":["number","null"]}},"required":["id","addressLine1","addressLine2","city","country","latLng"]},"distance":{"type":["number","null"]}},"required":["id","name","price","fulfillmentType","address"]},"priceBookId":{"type":["string","null"]}},"required":["seller","location"]},"default":[]},"cheapestOffer":{"type":["object","null"],"properties":{"seller":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"location":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"address":{"type":["object","null"],"properties":{"id":{"type":"string"},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":"string"},"latLng":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"addressLine1":{"type":"string"},"addressLine2":{"type":["string","null"]},"distance":{"type":["number","null"]}},"required":["id","city","state","country","latLng","addressLine1","addressLine2"]},"distance":{"type":["number","null"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["seller_fulfilled","platform_fulfilled"],"default":"platform_fulfilled"},"deliveryRadiusMeters":{"type":["number","null"]},"minimumOrderQty":{"type":"number","default":1}},"required":["id","name","fulfillmentType","minimumOrderQty"]},"price":{"type":"number"},"priceBookId":{"type":"string"},"locationId":{"type":"string"},"productId":{"type":"string"},"productVariantId":{"type":["string","null"]},"priceBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string"},"sortOrder":{"type":"number"},"type":{"type":["string","null"],"enum":["featured",null]}},"required":["id"]}},"required":["seller","location","price","priceBookId","locationId","productId"]},"bestOffer":{"type":["object","null"],"properties":{"seller":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"location":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"address":{"type":["object","null"],"properties":{"id":{"type":"string"},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":"string"},"latLng":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"addressLine1":{"type":"string"},"addressLine2":{"type":["string","null"]},"distance":{"type":["number","null"]}},"required":["id","city","state","country","latLng","addressLine1","addressLine2"]},"distance":{"type":["number","null"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["seller_fulfilled","platform_fulfilled"],"default":"platform_fulfilled"},"deliveryRadiusMeters":{"type":["number","null"]},"minimumOrderQty":{"type":"number","default":1}},"required":["id","name","fulfillmentType","minimumOrderQty"]},"price":{"type":"number"},"priceBookId":{"type":"string"},"locationId":{"type":"string"},"productId":{"type":"string"},"productVariantId":{"type":["string","null"]},"priceBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string"},"sortOrder":{"type":"number"},"type":{"type":["string","null"],"enum":["featured",null]}},"required":["id"]}},"required":["seller","location","price","priceBookId","locationId","productId"]},"hasCheaperOffer":{"type":"boolean","default":false}},"required":["unitOfMeasure","tags","media","options","variants","offers","hasCheaperOffer"]}},"required":["id","title","unitPrice","metadata"]}},"metadata":{"type":"object","properties":{"pagination":{"type":"object","properties":{"total":{"type":"number","description":"Total number of results"},"page":{"type":"number","description":"Current page number"},"limit":{"type":"number","description":"Page size"},"hasNextPage":{"type":"boolean","description":"Whether or not there is a next page"}},"required":["total","page","limit","hasNextPage"]},"sortedBy":{"type":"object","additionalProperties":{"type":"string","enum":["asc","desc"]}},"filteredBy":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{}}}}}},"required":["products","metadata"]}}}}},"summary":"Get catogue by category","tags":["Catalogue"],"x-speakeasy-name-override":"getCatalogueByCategory"}},"/v1/products/{id}":{"get":{"description":"Retrieves a single product details.","operationId":"getProduct","parameters":[{"name":"id","required":true,"in":"path","description":"Product ID","schema":{"type":"string"}},{"name":"deliveryMethod","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"type":"string","enum":["pickup","delivery"],"default":"pickup"}},{"name":"latLng","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"type":"string","example":"-1.2944722,36.8218611","description":"Latitude and longitude of the location, comma separated (Lat,Lng)"}},{"name":"x-api-key","in":"header","description":"API key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Returns a product details","content":{"application/json":{"schema":{"type":"object","properties":{"product":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string","minLength":1},"unitPrice":{"type":"number"},"metadata":{"type":"object","properties":{"batchSize":{"type":"number"},"minimumOrder":{"type":"number"},"unitOfMeasure":{"type":"string","minLength":1},"weight":{"type":"number"},"category":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string","minLength":1},"description":{"type":["string","null"]}},"required":["id","name"]},"brand":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string","minLength":1},"image":{"type":["string","null"],"format":"uri"}},"required":["id","name"]},"description":{"type":["string","null"]},"minPrice":{"type":"number"},"maxPrice":{"type":"number"},"locationPrices":{"type":["array","null"],"items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"unitPrice":{"type":"number"},"priceBookId":{"type":"string","description":"The price book that the price is associated with"},"priceBookEntryId":{"type":"string","description":"The price book entry that the price is associated with"},"type":{"type":"string","enum":["warehouse","dropship","virtual"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["platform_fulfilled"],"default":"platform_fulfilled"},"deliveryRadiusMeters":{"type":["number","null"]},"minimumOrderQty":{"type":"number","default":1},"address":{"type":["object","null"],"properties":{"id":{"type":["string","null"]},"addressLine1":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":["string","null"]},"latLng":{"type":["object","null"],"properties":{"lat":{"type":["number","null"]},"lng":{"type":["number","null"]}}},"distance":{"type":"number"}}},"priceBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string"},"sortOrder":{"type":"number"},"type":{"type":["string","null"],"enum":["featured",null]}},"required":["id"]}},"required":["id","name","unitPrice","priceBookId","priceBookEntryId","type","fulfillmentType","minimumOrderQty"]}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","minLength":1}},"required":["id","name"]},"default":[]},"media":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":["string","null"],"format":"uri"},"altText":{"type":["string","null"]}},"required":["id"]},"default":[]},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"position":{"type":"number"},"values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string","minLength":1},"isAvailable":{"type":"boolean","default":false}},"required":["id","value","isAvailable"]}}},"required":["id","name","position","values"]},"default":[]},"variants":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"sku":{"type":["string","null"]},"title":{"type":"string","minLength":1},"price":{"type":"number"},"cost":{"type":["number","null"]},"compareAtPrice":{"type":["number","null"]},"weight":{"type":"number"},"selectedOptions":{"type":"array","items":{"type":"object","properties":{"optionId":{"type":"string"},"optionName":{"type":"string"},"optionValueId":{"type":"string"},"optionValue":{"type":"string"}},"required":["optionId","optionName","optionValueId","optionValue"]}},"locationPrices":{"type":["array","null"],"items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"unitPrice":{"type":"number"},"priceBookId":{"type":"string","description":"The price book that the price is associated with"},"priceBookEntryId":{"type":"string","description":"The price book entry that the price is associated with"},"type":{"type":"string","enum":["warehouse","dropship","virtual"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["platform_fulfilled"],"default":"platform_fulfilled"},"deliveryRadiusMeters":{"type":["number","null"]},"minimumOrderQty":{"type":"number","default":1},"address":{"type":["object","null"],"properties":{"id":{"type":["string","null"]},"addressLine1":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":["string","null"]},"latLng":{"type":["object","null"],"properties":{"lat":{"type":["number","null"]},"lng":{"type":["number","null"]}}},"distance":{"type":"number"}}},"priceBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string"},"sortOrder":{"type":"number"},"type":{"type":["string","null"],"enum":["featured",null]}},"required":["id"]}},"required":["id","name","unitPrice","priceBookId","priceBookEntryId","type","fulfillmentType","minimumOrderQty"]}},"offers":{"type":"array","items":{"type":"object","properties":{"seller":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"location":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"price":{"type":["number","null"]},"minimumOrderQty":{"type":["number","null"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["seller_fulfilled","platform_fulfilled"]},"deliveryRadiusMeters":{"type":["number","null"]},"address":{"type":["object","null"],"properties":{"id":{"type":"string"},"addressLine1":{"type":"string"},"addressLine2":{"type":["string","null"]},"city":{"type":["string","null"]},"country":{"type":"string"},"latLng":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"distance":{"type":["number","null"]}},"required":["id","addressLine1","addressLine2","city","country","latLng"]},"distance":{"type":["number","null"]}},"required":["id","name","price","fulfillmentType","address"]},"priceBookId":{"type":["string","null"]}},"required":["seller","location"]},"default":[]},"cheapestOffer":{"type":["object","null"],"properties":{"seller":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"location":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"address":{"type":["object","null"],"properties":{"id":{"type":"string"},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":"string"},"latLng":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"addressLine1":{"type":"string"},"addressLine2":{"type":["string","null"]},"distance":{"type":["number","null"]}},"required":["id","city","state","country","latLng","addressLine1","addressLine2"]},"distance":{"type":["number","null"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["seller_fulfilled","platform_fulfilled"],"default":"platform_fulfilled"},"deliveryRadiusMeters":{"type":["number","null"]},"minimumOrderQty":{"type":"number","default":1}},"required":["id","name","fulfillmentType","minimumOrderQty"]},"price":{"type":"number"},"priceBookId":{"type":"string"},"locationId":{"type":"string"},"productId":{"type":"string"},"productVariantId":{"type":["string","null"]},"priceBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string"},"sortOrder":{"type":"number"},"type":{"type":["string","null"],"enum":["featured",null]}},"required":["id"]}},"required":["seller","location","price","priceBookId","locationId","productId"]},"bestOffer":{"type":["object","null"],"properties":{"seller":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"location":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"address":{"type":["object","null"],"properties":{"id":{"type":"string"},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":"string"},"latLng":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"addressLine1":{"type":"string"},"addressLine2":{"type":["string","null"]},"distance":{"type":["number","null"]}},"required":["id","city","state","country","latLng","addressLine1","addressLine2"]},"distance":{"type":["number","null"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["seller_fulfilled","platform_fulfilled"],"default":"platform_fulfilled"},"deliveryRadiusMeters":{"type":["number","null"]},"minimumOrderQty":{"type":"number","default":1}},"required":["id","name","fulfillmentType","minimumOrderQty"]},"price":{"type":"number"},"priceBookId":{"type":"string"},"locationId":{"type":"string"},"productId":{"type":"string"},"productVariantId":{"type":["string","null"]},"priceBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string"},"sortOrder":{"type":"number"},"type":{"type":["string","null"],"enum":["featured",null]}},"required":["id"]}},"required":["seller","location","price","priceBookId","locationId","productId"]},"hasCheaperOffer":{"type":"boolean","default":false}},"required":["id","title","price","selectedOptions","offers","hasCheaperOffer"]},"default":[]},"priceBookId":{"type":"string"},"offers":{"type":"array","items":{"type":"object","properties":{"seller":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"location":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"price":{"type":["number","null"]},"minimumOrderQty":{"type":["number","null"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["seller_fulfilled","platform_fulfilled"]},"deliveryRadiusMeters":{"type":["number","null"]},"address":{"type":["object","null"],"properties":{"id":{"type":"string"},"addressLine1":{"type":"string"},"addressLine2":{"type":["string","null"]},"city":{"type":["string","null"]},"country":{"type":"string"},"latLng":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"distance":{"type":["number","null"]}},"required":["id","addressLine1","addressLine2","city","country","latLng"]},"distance":{"type":["number","null"]}},"required":["id","name","price","fulfillmentType","address"]},"priceBookId":{"type":["string","null"]}},"required":["seller","location"]},"default":[]},"cheapestOffer":{"type":["object","null"],"properties":{"seller":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"location":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"address":{"type":["object","null"],"properties":{"id":{"type":"string"},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":"string"},"latLng":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"addressLine1":{"type":"string"},"addressLine2":{"type":["string","null"]},"distance":{"type":["number","null"]}},"required":["id","city","state","country","latLng","addressLine1","addressLine2"]},"distance":{"type":["number","null"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["seller_fulfilled","platform_fulfilled"],"default":"platform_fulfilled"},"deliveryRadiusMeters":{"type":["number","null"]},"minimumOrderQty":{"type":"number","default":1}},"required":["id","name","fulfillmentType","minimumOrderQty"]},"price":{"type":"number"},"priceBookId":{"type":"string"},"locationId":{"type":"string"},"productId":{"type":"string"},"productVariantId":{"type":["string","null"]},"priceBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string"},"sortOrder":{"type":"number"},"type":{"type":["string","null"],"enum":["featured",null]}},"required":["id"]}},"required":["seller","location","price","priceBookId","locationId","productId"]},"bestOffer":{"type":["object","null"],"properties":{"seller":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"location":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"address":{"type":["object","null"],"properties":{"id":{"type":"string"},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":"string"},"latLng":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"addressLine1":{"type":"string"},"addressLine2":{"type":["string","null"]},"distance":{"type":["number","null"]}},"required":["id","city","state","country","latLng","addressLine1","addressLine2"]},"distance":{"type":["number","null"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["seller_fulfilled","platform_fulfilled"],"default":"platform_fulfilled"},"deliveryRadiusMeters":{"type":["number","null"]},"minimumOrderQty":{"type":"number","default":1}},"required":["id","name","fulfillmentType","minimumOrderQty"]},"price":{"type":"number"},"priceBookId":{"type":"string"},"locationId":{"type":"string"},"productId":{"type":"string"},"productVariantId":{"type":["string","null"]},"priceBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string"},"sortOrder":{"type":"number"},"type":{"type":["string","null"],"enum":["featured",null]}},"required":["id"]}},"required":["seller","location","price","priceBookId","locationId","productId"]},"hasCheaperOffer":{"type":"boolean","default":false}},"required":["unitOfMeasure","tags","media","options","variants","offers","hasCheaperOffer"]}},"required":["id","title","unitPrice","metadata"]}},"required":["product"]}}}}},"summary":"Get product by ID","tags":["Products"],"x-speakeasy-name-override":"getProduct"}},"/v2/products/{id}":{"get":{"description":"Retrieves a single product details.","operationId":"getProductV2","parameters":[{"name":"id","required":true,"in":"path","description":"Product ID","schema":{"type":"string"}},{"name":"deliveryMethod","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"type":"string","enum":["pickup","delivery"],"default":"pickup"}},{"name":"latLng","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"type":"string","example":"-1.2944722,36.8218611","description":"Latitude and longitude of the location, comma separated (Lat,Lng)"}},{"name":"x-api-key","in":"header","description":"API key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Returns a product details","content":{"application/json":{"schema":{"type":"object","properties":{"product":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string","minLength":1},"unitPrice":{"type":"number"},"metadata":{"type":"object","properties":{"batchSize":{"type":"number"},"minimumOrder":{"type":"number"},"unitOfMeasure":{"type":"string","minLength":1},"weight":{"type":"number"},"category":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string","minLength":1},"description":{"type":["string","null"]}},"required":["id","name"]},"brand":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string","minLength":1},"image":{"type":["string","null"],"format":"uri"}},"required":["id","name"]},"description":{"type":["string","null"]},"minPrice":{"type":"number"},"maxPrice":{"type":"number"},"locationPrices":{"type":["array","null"],"items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"unitPrice":{"type":"number"},"priceBookId":{"type":"string","description":"The price book that the price is associated with"},"priceBookEntryId":{"type":"string","description":"The price book entry that the price is associated with"},"type":{"type":"string","enum":["warehouse","dropship","virtual"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["platform_fulfilled"],"default":"platform_fulfilled"},"deliveryRadiusMeters":{"type":["number","null"]},"minimumOrderQty":{"type":"number","default":1},"address":{"type":["object","null"],"properties":{"id":{"type":["string","null"]},"addressLine1":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":["string","null"]},"latLng":{"type":["object","null"],"properties":{"lat":{"type":["number","null"]},"lng":{"type":["number","null"]}}},"distance":{"type":"number"}}},"priceBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string"},"sortOrder":{"type":"number"},"type":{"type":["string","null"],"enum":["featured",null]}},"required":["id"]}},"required":["id","name","unitPrice","priceBookId","priceBookEntryId","type","fulfillmentType","minimumOrderQty"]}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","minLength":1}},"required":["id","name"]},"default":[]},"media":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":["string","null"],"format":"uri"},"altText":{"type":["string","null"]}},"required":["id"]},"default":[]},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"position":{"type":"number"},"values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string","minLength":1},"isAvailable":{"type":"boolean","default":false}},"required":["id","value","isAvailable"]}}},"required":["id","name","position","values"]},"default":[]},"variants":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"sku":{"type":["string","null"]},"title":{"type":"string","minLength":1},"price":{"type":"number"},"cost":{"type":["number","null"]},"compareAtPrice":{"type":["number","null"]},"weight":{"type":"number"},"selectedOptions":{"type":"array","items":{"type":"object","properties":{"optionId":{"type":"string"},"optionName":{"type":"string"},"optionValueId":{"type":"string"},"optionValue":{"type":"string"}},"required":["optionId","optionName","optionValueId","optionValue"]}},"locationPrices":{"type":["array","null"],"items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"unitPrice":{"type":"number"},"priceBookId":{"type":"string","description":"The price book that the price is associated with"},"priceBookEntryId":{"type":"string","description":"The price book entry that the price is associated with"},"type":{"type":"string","enum":["warehouse","dropship","virtual"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["platform_fulfilled"],"default":"platform_fulfilled"},"deliveryRadiusMeters":{"type":["number","null"]},"minimumOrderQty":{"type":"number","default":1},"address":{"type":["object","null"],"properties":{"id":{"type":["string","null"]},"addressLine1":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":["string","null"]},"latLng":{"type":["object","null"],"properties":{"lat":{"type":["number","null"]},"lng":{"type":["number","null"]}}},"distance":{"type":"number"}}},"priceBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string"},"sortOrder":{"type":"number"},"type":{"type":["string","null"],"enum":["featured",null]}},"required":["id"]}},"required":["id","name","unitPrice","priceBookId","priceBookEntryId","type","fulfillmentType","minimumOrderQty"]}},"offers":{"type":"array","items":{"type":"object","properties":{"seller":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"location":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"price":{"type":["number","null"]},"minimumOrderQty":{"type":["number","null"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["seller_fulfilled","platform_fulfilled"]},"deliveryRadiusMeters":{"type":["number","null"]},"address":{"type":["object","null"],"properties":{"id":{"type":"string"},"addressLine1":{"type":"string"},"addressLine2":{"type":["string","null"]},"city":{"type":["string","null"]},"country":{"type":"string"},"latLng":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"distance":{"type":["number","null"]}},"required":["id","addressLine1","addressLine2","city","country","latLng"]},"distance":{"type":["number","null"]}},"required":["id","name","price","fulfillmentType","address"]},"priceBookId":{"type":["string","null"]}},"required":["seller","location"]},"default":[]},"cheapestOffer":{"type":["object","null"],"properties":{"seller":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"location":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"address":{"type":["object","null"],"properties":{"id":{"type":"string"},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":"string"},"latLng":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"addressLine1":{"type":"string"},"addressLine2":{"type":["string","null"]},"distance":{"type":["number","null"]}},"required":["id","city","state","country","latLng","addressLine1","addressLine2"]},"distance":{"type":["number","null"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["seller_fulfilled","platform_fulfilled"],"default":"platform_fulfilled"},"deliveryRadiusMeters":{"type":["number","null"]},"minimumOrderQty":{"type":"number","default":1}},"required":["id","name","fulfillmentType","minimumOrderQty"]},"price":{"type":"number"},"priceBookId":{"type":"string"},"locationId":{"type":"string"},"productId":{"type":"string"},"productVariantId":{"type":["string","null"]},"priceBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string"},"sortOrder":{"type":"number"},"type":{"type":["string","null"],"enum":["featured",null]}},"required":["id"]}},"required":["seller","location","price","priceBookId","locationId","productId"]},"bestOffer":{"type":["object","null"],"properties":{"seller":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"location":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"address":{"type":["object","null"],"properties":{"id":{"type":"string"},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":"string"},"latLng":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"addressLine1":{"type":"string"},"addressLine2":{"type":["string","null"]},"distance":{"type":["number","null"]}},"required":["id","city","state","country","latLng","addressLine1","addressLine2"]},"distance":{"type":["number","null"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["seller_fulfilled","platform_fulfilled"],"default":"platform_fulfilled"},"deliveryRadiusMeters":{"type":["number","null"]},"minimumOrderQty":{"type":"number","default":1}},"required":["id","name","fulfillmentType","minimumOrderQty"]},"price":{"type":"number"},"priceBookId":{"type":"string"},"locationId":{"type":"string"},"productId":{"type":"string"},"productVariantId":{"type":["string","null"]},"priceBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string"},"sortOrder":{"type":"number"},"type":{"type":["string","null"],"enum":["featured",null]}},"required":["id"]}},"required":["seller","location","price","priceBookId","locationId","productId"]},"hasCheaperOffer":{"type":"boolean","default":false}},"required":["id","title","price","selectedOptions","offers","hasCheaperOffer"]},"default":[]},"priceBookId":{"type":"string"},"offers":{"type":"array","items":{"type":"object","properties":{"seller":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"location":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"price":{"type":["number","null"]},"minimumOrderQty":{"type":["number","null"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["seller_fulfilled","platform_fulfilled"]},"deliveryRadiusMeters":{"type":["number","null"]},"address":{"type":["object","null"],"properties":{"id":{"type":"string"},"addressLine1":{"type":"string"},"addressLine2":{"type":["string","null"]},"city":{"type":["string","null"]},"country":{"type":"string"},"latLng":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"distance":{"type":["number","null"]}},"required":["id","addressLine1","addressLine2","city","country","latLng"]},"distance":{"type":["number","null"]}},"required":["id","name","price","fulfillmentType","address"]},"priceBookId":{"type":["string","null"]}},"required":["seller","location"]},"default":[]},"cheapestOffer":{"type":["object","null"],"properties":{"seller":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"location":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"address":{"type":["object","null"],"properties":{"id":{"type":"string"},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":"string"},"latLng":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"addressLine1":{"type":"string"},"addressLine2":{"type":["string","null"]},"distance":{"type":["number","null"]}},"required":["id","city","state","country","latLng","addressLine1","addressLine2"]},"distance":{"type":["number","null"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["seller_fulfilled","platform_fulfilled"],"default":"platform_fulfilled"},"deliveryRadiusMeters":{"type":["number","null"]},"minimumOrderQty":{"type":"number","default":1}},"required":["id","name","fulfillmentType","minimumOrderQty"]},"price":{"type":"number"},"priceBookId":{"type":"string"},"locationId":{"type":"string"},"productId":{"type":"string"},"productVariantId":{"type":["string","null"]},"priceBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string"},"sortOrder":{"type":"number"},"type":{"type":["string","null"],"enum":["featured",null]}},"required":["id"]}},"required":["seller","location","price","priceBookId","locationId","productId"]},"bestOffer":{"type":["object","null"],"properties":{"seller":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"location":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"address":{"type":["object","null"],"properties":{"id":{"type":"string"},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":"string"},"latLng":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"addressLine1":{"type":"string"},"addressLine2":{"type":["string","null"]},"distance":{"type":["number","null"]}},"required":["id","city","state","country","latLng","addressLine1","addressLine2"]},"distance":{"type":["number","null"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["seller_fulfilled","platform_fulfilled"],"default":"platform_fulfilled"},"deliveryRadiusMeters":{"type":["number","null"]},"minimumOrderQty":{"type":"number","default":1}},"required":["id","name","fulfillmentType","minimumOrderQty"]},"price":{"type":"number"},"priceBookId":{"type":"string"},"locationId":{"type":"string"},"productId":{"type":"string"},"productVariantId":{"type":["string","null"]},"priceBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string"},"sortOrder":{"type":"number"},"type":{"type":["string","null"],"enum":["featured",null]}},"required":["id"]}},"required":["seller","location","price","priceBookId","locationId","productId"]},"hasCheaperOffer":{"type":"boolean","default":false}},"required":["unitOfMeasure","tags","media","options","variants","offers","hasCheaperOffer"]}},"required":["id","title","unitPrice","metadata"]}},"required":["product"]}}}}},"summary":"Get product by ID","tags":["Products"],"x-speakeasy-name-override":"getProductV2"}},"/v1/categories":{"get":{"operationId":"CategoriesController_getCategories_v1","parameters":[],"responses":{"200":{"description":""}}}},"/v1/search":{"get":{"description":"Search products by query","operationId":"SearchController_searchProducts_v1","parameters":[{"name":"x-api-key","in":"header","description":"API key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Returns the search results","content":{"application/json":{"schema":{"type":"object","properties":{"products":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string","minLength":1},"unitPrice":{"type":"number"},"metadata":{"type":"object","properties":{"batchSize":{"type":"number"},"minimumOrder":{"type":"number"},"unitOfMeasure":{"type":"string","minLength":1},"weight":{"type":"number"},"category":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string","minLength":1},"description":{"type":["string","null"]}},"required":["id","name"]},"brand":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string","minLength":1},"image":{"type":["string","null"],"format":"uri"}},"required":["id","name"]},"description":{"type":["string","null"]},"minPrice":{"type":"number"},"maxPrice":{"type":"number"},"locationPrices":{"type":["array","null"],"items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"unitPrice":{"type":"number"},"priceBookId":{"type":"string","description":"The price book that the price is associated with"},"priceBookEntryId":{"type":"string","description":"The price book entry that the price is associated with"},"type":{"type":"string","enum":["warehouse","dropship","virtual"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["platform_fulfilled"],"default":"platform_fulfilled"},"deliveryRadiusMeters":{"type":["number","null"]},"minimumOrderQty":{"type":"number","default":1},"address":{"type":["object","null"],"properties":{"id":{"type":["string","null"]},"addressLine1":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":["string","null"]},"latLng":{"type":["object","null"],"properties":{"lat":{"type":["number","null"]},"lng":{"type":["number","null"]}}},"distance":{"type":"number"}}},"priceBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string"},"sortOrder":{"type":"number"},"type":{"type":["string","null"],"enum":["featured",null]}},"required":["id"]}},"required":["id","name","unitPrice","priceBookId","priceBookEntryId","type","fulfillmentType","minimumOrderQty"]}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","minLength":1}},"required":["id","name"]},"default":[]},"media":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":["string","null"],"format":"uri"},"altText":{"type":["string","null"]}},"required":["id"]},"default":[]},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"position":{"type":"number"},"values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string","minLength":1},"isAvailable":{"type":"boolean","default":false}},"required":["id","value","isAvailable"]}}},"required":["id","name","position","values"]},"default":[]},"variants":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"sku":{"type":["string","null"]},"title":{"type":"string","minLength":1},"price":{"type":"number"},"cost":{"type":["number","null"]},"compareAtPrice":{"type":["number","null"]},"weight":{"type":"number"},"selectedOptions":{"type":"array","items":{"type":"object","properties":{"optionId":{"type":"string"},"optionName":{"type":"string"},"optionValueId":{"type":"string"},"optionValue":{"type":"string"}},"required":["optionId","optionName","optionValueId","optionValue"]}},"locationPrices":{"type":["array","null"],"items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"unitPrice":{"type":"number"},"priceBookId":{"type":"string","description":"The price book that the price is associated with"},"priceBookEntryId":{"type":"string","description":"The price book entry that the price is associated with"},"type":{"type":"string","enum":["warehouse","dropship","virtual"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["platform_fulfilled"],"default":"platform_fulfilled"},"deliveryRadiusMeters":{"type":["number","null"]},"minimumOrderQty":{"type":"number","default":1},"address":{"type":["object","null"],"properties":{"id":{"type":["string","null"]},"addressLine1":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":["string","null"]},"latLng":{"type":["object","null"],"properties":{"lat":{"type":["number","null"]},"lng":{"type":["number","null"]}}},"distance":{"type":"number"}}},"priceBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string"},"sortOrder":{"type":"number"},"type":{"type":["string","null"],"enum":["featured",null]}},"required":["id"]}},"required":["id","name","unitPrice","priceBookId","priceBookEntryId","type","fulfillmentType","minimumOrderQty"]}},"offers":{"type":"array","items":{"type":"object","properties":{"seller":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"location":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"price":{"type":["number","null"]},"minimumOrderQty":{"type":["number","null"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["seller_fulfilled","platform_fulfilled"]},"deliveryRadiusMeters":{"type":["number","null"]},"address":{"type":["object","null"],"properties":{"id":{"type":"string"},"addressLine1":{"type":"string"},"addressLine2":{"type":["string","null"]},"city":{"type":["string","null"]},"country":{"type":"string"},"latLng":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"distance":{"type":["number","null"]}},"required":["id","addressLine1","addressLine2","city","country","latLng"]},"distance":{"type":["number","null"]}},"required":["id","name","price","fulfillmentType","address"]},"priceBookId":{"type":["string","null"]}},"required":["seller","location"]},"default":[]},"cheapestOffer":{"type":["object","null"],"properties":{"seller":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"location":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"address":{"type":["object","null"],"properties":{"id":{"type":"string"},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":"string"},"latLng":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"addressLine1":{"type":"string"},"addressLine2":{"type":["string","null"]},"distance":{"type":["number","null"]}},"required":["id","city","state","country","latLng","addressLine1","addressLine2"]},"distance":{"type":["number","null"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["seller_fulfilled","platform_fulfilled"],"default":"platform_fulfilled"},"deliveryRadiusMeters":{"type":["number","null"]},"minimumOrderQty":{"type":"number","default":1}},"required":["id","name","fulfillmentType","minimumOrderQty"]},"price":{"type":"number"},"priceBookId":{"type":"string"},"locationId":{"type":"string"},"productId":{"type":"string"},"productVariantId":{"type":["string","null"]},"priceBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string"},"sortOrder":{"type":"number"},"type":{"type":["string","null"],"enum":["featured",null]}},"required":["id"]}},"required":["seller","location","price","priceBookId","locationId","productId"]},"bestOffer":{"type":["object","null"],"properties":{"seller":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"location":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"address":{"type":["object","null"],"properties":{"id":{"type":"string"},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":"string"},"latLng":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"addressLine1":{"type":"string"},"addressLine2":{"type":["string","null"]},"distance":{"type":["number","null"]}},"required":["id","city","state","country","latLng","addressLine1","addressLine2"]},"distance":{"type":["number","null"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["seller_fulfilled","platform_fulfilled"],"default":"platform_fulfilled"},"deliveryRadiusMeters":{"type":["number","null"]},"minimumOrderQty":{"type":"number","default":1}},"required":["id","name","fulfillmentType","minimumOrderQty"]},"price":{"type":"number"},"priceBookId":{"type":"string"},"locationId":{"type":"string"},"productId":{"type":"string"},"productVariantId":{"type":["string","null"]},"priceBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string"},"sortOrder":{"type":"number"},"type":{"type":["string","null"],"enum":["featured",null]}},"required":["id"]}},"required":["seller","location","price","priceBookId","locationId","productId"]},"hasCheaperOffer":{"type":"boolean","default":false}},"required":["id","title","price","selectedOptions","offers","hasCheaperOffer"]},"default":[]},"priceBookId":{"type":"string"},"offers":{"type":"array","items":{"type":"object","properties":{"seller":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"location":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"price":{"type":["number","null"]},"minimumOrderQty":{"type":["number","null"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["seller_fulfilled","platform_fulfilled"]},"deliveryRadiusMeters":{"type":["number","null"]},"address":{"type":["object","null"],"properties":{"id":{"type":"string"},"addressLine1":{"type":"string"},"addressLine2":{"type":["string","null"]},"city":{"type":["string","null"]},"country":{"type":"string"},"latLng":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"distance":{"type":["number","null"]}},"required":["id","addressLine1","addressLine2","city","country","latLng"]},"distance":{"type":["number","null"]}},"required":["id","name","price","fulfillmentType","address"]},"priceBookId":{"type":["string","null"]}},"required":["seller","location"]},"default":[]},"cheapestOffer":{"type":["object","null"],"properties":{"seller":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"location":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"address":{"type":["object","null"],"properties":{"id":{"type":"string"},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":"string"},"latLng":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"addressLine1":{"type":"string"},"addressLine2":{"type":["string","null"]},"distance":{"type":["number","null"]}},"required":["id","city","state","country","latLng","addressLine1","addressLine2"]},"distance":{"type":["number","null"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["seller_fulfilled","platform_fulfilled"],"default":"platform_fulfilled"},"deliveryRadiusMeters":{"type":["number","null"]},"minimumOrderQty":{"type":"number","default":1}},"required":["id","name","fulfillmentType","minimumOrderQty"]},"price":{"type":"number"},"priceBookId":{"type":"string"},"locationId":{"type":"string"},"productId":{"type":"string"},"productVariantId":{"type":["string","null"]},"priceBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string"},"sortOrder":{"type":"number"},"type":{"type":["string","null"],"enum":["featured",null]}},"required":["id"]}},"required":["seller","location","price","priceBookId","locationId","productId"]},"bestOffer":{"type":["object","null"],"properties":{"seller":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"location":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"address":{"type":["object","null"],"properties":{"id":{"type":"string"},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":"string"},"latLng":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"addressLine1":{"type":"string"},"addressLine2":{"type":["string","null"]},"distance":{"type":["number","null"]}},"required":["id","city","state","country","latLng","addressLine1","addressLine2"]},"distance":{"type":["number","null"]},"quantityAvailable":{"type":["number","null"]},"fulfillmentType":{"type":"string","enum":["seller_fulfilled","platform_fulfilled"],"default":"platform_fulfilled"},"deliveryRadiusMeters":{"type":["number","null"]},"minimumOrderQty":{"type":"number","default":1}},"required":["id","name","fulfillmentType","minimumOrderQty"]},"price":{"type":"number"},"priceBookId":{"type":"string"},"locationId":{"type":"string"},"productId":{"type":"string"},"productVariantId":{"type":["string","null"]},"priceBookEntry":{"type":["object","null"],"properties":{"id":{"type":"string"},"sortOrder":{"type":"number"},"type":{"type":["string","null"],"enum":["featured",null]}},"required":["id"]}},"required":["seller","location","price","priceBookId","locationId","productId"]},"hasCheaperOffer":{"type":"boolean","default":false}},"required":["unitOfMeasure","tags","media","options","variants","offers","hasCheaperOffer"]}},"required":["id","title","unitPrice","metadata"]}},"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":["string","null"]},"imageUrl":{"type":["string","null"]},"media":{"type":["array","null"],"items":{"type":"object","properties":{"id":{"type":"string"},"altText":{"type":["string","null"]},"url":{"type":["string","null"]},"thumbnailUrl":{"type":["string","null"]},"previewUrl":{"type":["string","null"]}},"required":["id"]}},"parentId":{"type":["string","null"]}},"required":["id","name","parentId"]}},"brands":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"imageUrl":{"type":["string","null"]}},"required":["id","name"]}},"discount":{"type":"number"},"metadata":{"type":"object","properties":{"pagination":{"type":"object","properties":{"total":{"type":"number","description":"Total number of results"},"page":{"type":"number","description":"Current page number"},"limit":{"type":"number","description":"Page size"},"hasNextPage":{"type":"boolean","description":"Whether or not there is a next page"}},"required":["total","page","limit","hasNextPage"]},"sortedBy":{"type":"object","additionalProperties":{"type":"string","enum":["asc","desc"]}},"filteredBy":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{}}}}}},"required":["products","categories","brands","discount","metadata"]}}}}},"summary":"Search products","tags":["Search"]}},"/v1/orders":{"get":{"description":"Retrieves a paginated list of all past orders placed by the authenticated customer.","operationId":"OrdersController_findAll_v1","parameters":[{"name":"Cookie","in":"header","description":"Cookie","required":true,"schema":{"type":"string","format":"cookie"}},{"name":"x-api-key","in":"header","description":"API key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Returns the list of orders","content":{"application/json":{"schema":{"type":"object","properties":{"orders":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"orderNumber":{"type":"integer","minimum":-2147483648,"maximum":2147483647},"invoiceNumber":{"type":["string","null"]},"quotationId":{"type":["string","null"]},"inventoryLocationId":{"type":["string","null"]},"inventoryLocationGroupId":{"type":["string","null"]},"deliveryMethod":{"type":"string","enum":["pickup","delivery","drop_ship"]},"totalWeight":{"type":["string","null"]},"customerId":{"type":"string"},"contactPersonId":{"type":["string","null"]},"placedBy":{"type":"string"},"placedByType":{"type":"string","enum":["user","system","customer","integration"]},"salesRepId":{"type":["string","null"]},"salesChannelId":{"type":["string","null"]},"subtotalPrice":{"type":"string"},"totalPrice":{"type":"string"},"totalTax":{"type":["string","null"]},"totalShipping":{"type":["string","null"]},"totalWithheldTaxAmount":{"type":["string","null"]},"orderDiscount":{"type":["string","null"]},"totalDiscount":{"type":["string","null"]},"discountPercentage":{"type":["string","null"]},"discountType":{"type":["string","null"],"enum":["percentage","fixed",null]},"discountReason":{"type":["string","null"]},"status":{"type":"string","enum":["draft","pending","processing","ready_for_pickup","shipped","delivered","cancelled","refunded","completed","on_hold","invoiced"]},"approvalStatus":{"type":"string","enum":["not_required","pending","approved","rejected","escalated","outdated"]},"paymentStatus":{"type":"string","enum":["pending","authorized","paid","partially_paid","awaiting_withholding_tax_cert","refunded","failed","disputed"]},"paymentTerms":{"type":["string","null"]},"paymentDueDate":{"type":["string","null"]},"billingAddressId":{"type":["string","null"]},"shippingAddressId":{"type":["string","null"]},"trackingNumber":{"type":["string","null"]},"shippingCarrier":{"type":["string","null"]},"shippingMethod":{"type":["string","null"]},"estimatedDeliveryDate":{"type":["string","null"]},"actualDeliveryDate":{"type":["string","null"]},"confirmedAt":{"type":["string","null"]},"shippedAt":{"type":["string","null"]},"deliveredAt":{"type":["string","null"]},"closedAt":{"type":["string","null"]},"cancelledAt":{"type":["string","null"]},"externalId":{"type":["string","null"]},"externalSystem":{"type":["string","null"]},"externalDocumentNumber":{"type":["string","null"]},"syncStatus":{"type":["string","null"]},"syncError":{"type":["string","null"]},"lastSyncAt":{"type":["string","null"]},"notes":{"type":["string","null"]},"tags":{"type":["array","null"],"items":{"type":"string"}},"metadata":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"metrics":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"branchId":{"type":["string","null"]},"organizationId":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":["string","null"]},"deletedAt":{"type":["string","null"]},"paidAmount":{"type":["number","null"]},"balanceAmount":{"type":["number","null"]},"amountPendingApproval":{"type":["number","null"]},"totalPendingAmount":{"type":["number","null"]},"amountUnderProcessing":{"type":["number","null"]},"effectiveBalance":{"type":["number","null"]},"effectiveStatus":{"type":"string","enum":["verifying_payment","partially_paid","awaiting_payment","partially_paid_verifying","awaiting_withholding_tax_cert","paid","draft","pending","processing","ready_for_pickup","shipped","delivered","cancelled","refunded","completed","on_hold","invoiced"]},"lineItems":{"type":"array","items":{"type":"object","properties":{"productId":{"type":"string"},"purchaseOrderNumber":{"type":["string","null"]},"variantId":{"type":["string","null"]},"quantity":{"type":"string"},"unitPrice":{"type":"string"},"totalAmount":{"type":"string"},"costPrice":{"type":["string","null"]},"discountAmount":{"type":["string","null"]},"discountPercentage":{"type":["string","null"]},"inventoryLocationId":{"type":"string"},"name":{"type":"string"},"unitOfMeasure":{"type":"string"},"title":{"type":"string"},"variantTitle":{"type":["string","null"]},"inventoryLocation":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"type":["string","null"]},"isDefault":{"type":"boolean"},"status":{"type":["string","null"],"enum":["active","inactive",null]},"type":{"type":"string","enum":["warehouse","dropship","virtual"]},"priority":{"type":"integer","minimum":-2147483648,"maximum":2147483647},"deliveryRadiusMeters":{"type":["integer","null"],"minimum":-2147483648,"maximum":2147483647},"externalId":{"type":["string","null"]},"externalSystem":{"type":["string","null"]},"addressId":{"type":["string","null"]},"sellerId":{"type":["string","null"]},"supplierId":{"type":["string","null"]},"supplierContactId":{"type":["string","null"]},"supplierAddressId":{"type":["string","null"]},"groupId":{"type":["string","null"]},"organizationId":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":["string","null"]},"deletedAt":{"type":["string","null"]}},"required":["id","name","slug","isDefault","status","type","priority","deliveryRadiusMeters","externalId","externalSystem","addressId","sellerId","supplierId","supplierContactId","supplierAddressId","groupId","organizationId","createdAt","updatedAt","deletedAt"]},"product":{"type":"object","properties":{"weight":{"type":["string","null"]}},"required":["weight"]}},"required":["productId","quantity","unitPrice","totalAmount","costPrice","discountAmount","discountPercentage","inventoryLocationId","name","unitOfMeasure","title","variantTitle","inventoryLocation","product"]},"default":[]},"customer":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"phoneNumber":{"type":["string","null"]},"email":{"type":["string","null"]},"taxPin":{"type":["string","null"]},"externalId":{"type":["string","null"]},"creditMetadata":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]}},"required":["id","name","phoneNumber","email","taxPin","externalId","creditMetadata"]},"contactPerson":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"contactMethod":{"type":"string","enum":["whatsapp","email"]},"isPrimary":{"type":["boolean","null"]}},"required":["id","name","email","phone","contactMethod","isPrimary"]},"shippingAddress":{"type":["object","null"],"properties":{"id":{"type":"string"},"addressLine1":{"type":"string"},"addressLine2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":"string"},"latLng":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]}},"required":["id","addressLine1","addressLine2","city","state","country","latLng"]},"payments":{"type":"array","items":{"type":"object","properties":{"amount":{"type":"string"}},"required":["amount"]},"default":[]},"quotation":{"type":["object","null"],"properties":{"id":{"type":"string"},"quotationNumber":{"type":"integer","minimum":-2147483648,"maximum":2147483647}},"required":["id","quotationNumber"]},"attachments":{"type":["array","null"],"items":{"type":"object","properties":{"id":{"type":"string"},"documentType":{"type":"string","enum":["invoice","credit_note","delivery_note","proof_of_payment","purchase_order","withholding_tax_certificate","packing_list","order_receipt"]},"documentId":{"type":"string"},"fileName":{"type":"string"},"mimeType":{"type":["string","null"]},"fileKey":{"type":"string"},"fileSize":{"type":["integer","null"],"minimum":-2147483648,"maximum":2147483647},"createdAt":{"type":"string"},"updatedAt":{"type":["string","null"]}},"required":["id","documentType","documentId","fileName","mimeType","fileKey","fileSize","createdAt","updatedAt"]},"default":[]}},"required":["id","orderNumber","invoiceNumber","quotationId","inventoryLocationId","inventoryLocationGroupId","deliveryMethod","totalWeight","customerId","contactPersonId","placedBy","placedByType","salesRepId","salesChannelId","subtotalPrice","totalPrice","totalTax","totalShipping","totalWithheldTaxAmount","orderDiscount","totalDiscount","discountPercentage","discountType","discountReason","status","paymentStatus","paymentTerms","paymentDueDate","billingAddressId","shippingAddressId","trackingNumber","shippingCarrier","shippingMethod","confirmedAt","shippedAt","deliveredAt","closedAt","cancelledAt","externalId","externalSystem","externalDocumentNumber","syncStatus","syncError","lastSyncAt","notes","tags","metadata","metrics","branchId","organizationId","createdAt","updatedAt","deletedAt","effectiveStatus","lineItems","customer","payments","attachments"]}},"pagination":{"type":"object","properties":{"total":{"type":"number","description":"Total number of results"},"page":{"type":"number","description":"Current page number"},"limit":{"type":"number","description":"Page size"},"hasNextPage":{"type":"boolean","description":"Whether or not there is a next page"}},"required":["total","page","limit","hasNextPage"]}},"required":["orders","pagination"]}}}}},"summary":"List customer's orders","tags":["Orders"]}},"/v1/orders/{id}":{"get":{"description":"Retrieves details for a specific order using its ID. This includes items, shipping information, payment status, etc.","operationId":"OrdersController_getOrderDetails_v1","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Cookie","required":true,"schema":{"type":"string"}},{"name":"x-api-key","in":"header","description":"API key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Returns the order details","content":{"application/json":{"schema":{"type":"object","properties":{"order":{"type":"object","properties":{"id":{"type":"string"},"orderNumber":{"type":"integer","minimum":-2147483648,"maximum":2147483647},"invoiceNumber":{"type":["string","null"]},"quotationId":{"type":["string","null"]},"inventoryLocationId":{"type":["string","null"]},"inventoryLocationGroupId":{"type":["string","null"]},"deliveryMethod":{"type":"string","enum":["pickup","delivery","drop_ship"]},"totalWeight":{"type":["string","null"]},"customerId":{"type":"string"},"contactPersonId":{"type":["string","null"]},"placedBy":{"type":"string"},"placedByType":{"type":"string","enum":["user","system","customer","integration"]},"salesRepId":{"type":["string","null"]},"salesChannelId":{"type":["string","null"]},"subtotalPrice":{"type":"string"},"totalPrice":{"type":"string"},"totalTax":{"type":["string","null"]},"totalShipping":{"type":["string","null"]},"totalWithheldTaxAmount":{"type":["string","null"]},"orderDiscount":{"type":["string","null"]},"totalDiscount":{"type":["string","null"]},"discountPercentage":{"type":["string","null"]},"discountType":{"type":["string","null"],"enum":["percentage","fixed",null]},"discountReason":{"type":["string","null"]},"status":{"type":"string","enum":["draft","pending","processing","ready_for_pickup","shipped","delivered","cancelled","refunded","completed","on_hold","invoiced"]},"approvalStatus":{"type":"string","enum":["not_required","pending","approved","rejected","escalated","outdated"]},"paymentStatus":{"type":"string","enum":["pending","authorized","paid","partially_paid","awaiting_withholding_tax_cert","refunded","failed","disputed"]},"paymentTerms":{"type":["string","null"]},"paymentDueDate":{"type":["string","null"]},"billingAddressId":{"type":["string","null"]},"shippingAddressId":{"type":["string","null"]},"trackingNumber":{"type":["string","null"]},"shippingCarrier":{"type":["string","null"]},"shippingMethod":{"type":["string","null"]},"estimatedDeliveryDate":{"type":["string","null"]},"actualDeliveryDate":{"type":["string","null"]},"confirmedAt":{"type":["string","null"]},"shippedAt":{"type":["string","null"]},"deliveredAt":{"type":["string","null"]},"closedAt":{"type":["string","null"]},"cancelledAt":{"type":["string","null"]},"externalId":{"type":["string","null"]},"externalSystem":{"type":["string","null"]},"externalDocumentNumber":{"type":["string","null"]},"syncStatus":{"type":["string","null"]},"syncError":{"type":["string","null"]},"lastSyncAt":{"type":["string","null"]},"notes":{"type":["string","null"]},"tags":{"type":["array","null"],"items":{"type":"string"}},"metadata":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"metrics":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"branchId":{"type":["string","null"]},"organizationId":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":["string","null"]},"deletedAt":{"type":["string","null"]},"paidAmount":{"type":["number","null"]},"balanceAmount":{"type":["number","null"]},"amountPendingApproval":{"type":["number","null"]},"totalPendingAmount":{"type":["number","null"]},"amountUnderProcessing":{"type":["number","null"]},"effectiveBalance":{"type":["number","null"]},"effectiveStatus":{"type":"string","enum":["verifying_payment","partially_paid","awaiting_payment","partially_paid_verifying","awaiting_withholding_tax_cert","paid","draft","pending","processing","ready_for_pickup","shipped","delivered","cancelled","refunded","completed","on_hold","invoiced"]},"lineItems":{"type":"array","items":{"type":"object","properties":{"productId":{"type":"string"},"purchaseOrderNumber":{"type":["string","null"]},"variantId":{"type":["string","null"]},"quantity":{"type":"string"},"unitPrice":{"type":"string"},"totalAmount":{"type":"string"},"costPrice":{"type":["string","null"]},"discountAmount":{"type":["string","null"]},"discountPercentage":{"type":["string","null"]},"inventoryLocationId":{"type":"string"},"name":{"type":"string"},"unitOfMeasure":{"type":"string"},"title":{"type":"string"},"variantTitle":{"type":["string","null"]},"inventoryLocation":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"type":["string","null"]},"isDefault":{"type":"boolean"},"status":{"type":["string","null"],"enum":["active","inactive",null]},"type":{"type":"string","enum":["warehouse","dropship","virtual"]},"priority":{"type":"integer","minimum":-2147483648,"maximum":2147483647},"deliveryRadiusMeters":{"type":["integer","null"],"minimum":-2147483648,"maximum":2147483647},"externalId":{"type":["string","null"]},"externalSystem":{"type":["string","null"]},"addressId":{"type":["string","null"]},"sellerId":{"type":["string","null"]},"supplierId":{"type":["string","null"]},"supplierContactId":{"type":["string","null"]},"supplierAddressId":{"type":["string","null"]},"groupId":{"type":["string","null"]},"organizationId":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":["string","null"]},"deletedAt":{"type":["string","null"]}},"required":["id","name","slug","isDefault","status","type","priority","deliveryRadiusMeters","externalId","externalSystem","addressId","sellerId","supplierId","supplierContactId","supplierAddressId","groupId","organizationId","createdAt","updatedAt","deletedAt"]},"product":{"type":"object","properties":{"weight":{"type":["string","null"]}},"required":["weight"]}},"required":["productId","quantity","unitPrice","totalAmount","costPrice","discountAmount","discountPercentage","inventoryLocationId","name","unitOfMeasure","title","variantTitle","inventoryLocation","product"]},"default":[]},"customer":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"phoneNumber":{"type":["string","null"]},"email":{"type":["string","null"]},"taxPin":{"type":["string","null"]},"externalId":{"type":["string","null"]},"creditMetadata":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]}},"required":["id","name","phoneNumber","email","taxPin","externalId","creditMetadata"]},"contactPerson":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"contactMethod":{"type":"string","enum":["whatsapp","email"]},"isPrimary":{"type":["boolean","null"]}},"required":["id","name","email","phone","contactMethod","isPrimary"]},"shippingAddress":{"type":["object","null"],"properties":{"id":{"type":"string"},"addressLine1":{"type":"string"},"addressLine2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":"string"},"latLng":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]}},"required":["id","addressLine1","addressLine2","city","state","country","latLng"]},"payments":{"type":"array","items":{"type":"object","properties":{"amount":{"type":"string"}},"required":["amount"]},"default":[]},"quotation":{"type":["object","null"],"properties":{"id":{"type":"string"},"quotationNumber":{"type":"integer","minimum":-2147483648,"maximum":2147483647}},"required":["id","quotationNumber"]},"attachments":{"type":["array","null"],"items":{"type":"object","properties":{"id":{"type":"string"},"documentType":{"type":"string","enum":["invoice","credit_note","delivery_note","proof_of_payment","purchase_order","withholding_tax_certificate","packing_list","order_receipt"]},"documentId":{"type":"string"},"fileName":{"type":"string"},"mimeType":{"type":["string","null"]},"fileKey":{"type":"string"},"fileSize":{"type":["integer","null"],"minimum":-2147483648,"maximum":2147483647},"createdAt":{"type":"string"},"updatedAt":{"type":["string","null"]}},"required":["id","documentType","documentId","fileName","mimeType","fileKey","fileSize","createdAt","updatedAt"]},"default":[]}},"required":["id","orderNumber","invoiceNumber","quotationId","inventoryLocationId","inventoryLocationGroupId","deliveryMethod","totalWeight","customerId","contactPersonId","placedBy","placedByType","salesRepId","salesChannelId","subtotalPrice","totalPrice","totalTax","totalShipping","totalWithheldTaxAmount","orderDiscount","totalDiscount","discountPercentage","discountType","discountReason","status","paymentStatus","paymentTerms","paymentDueDate","billingAddressId","shippingAddressId","trackingNumber","shippingCarrier","shippingMethod","confirmedAt","shippedAt","deliveredAt","closedAt","cancelledAt","externalId","externalSystem","externalDocumentNumber","syncStatus","syncError","lastSyncAt","notes","tags","metadata","metrics","branchId","organizationId","createdAt","updatedAt","deletedAt","effectiveStatus","lineItems","customer","payments","attachments"]}},"required":["order"]}}}}},"summary":"Get order details","tags":["Orders"],"x-speakeasy-name-override":"getOrderDetails"}},"/v1/orders/{id}/bank-payment-reference":{"post":{"description":"Submit a bank transfer reference to claim a payment for an order. The reference is matched against received bank transactions. Returns status: 'fully_paid', 'partially_paid', or 'transaction_not_found'.","operationId":"claimBankPayment","parameters":[{"name":"id","required":true,"in":"path","description":"Order ID","schema":{"type":"string"}},{"name":"Cookie","in":"header","description":"Cookie","required":true,"schema":{"type":"string"}},{"name":"x-api-key","in":"header","description":"API key","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Bank reference from the transfer","content":{"application/json":{"schema":{"type":"object","properties":{"bankReference":{"type":"string","minLength":1}},"required":["bankReference"]}}}},"responses":{"200":{"description":"Payment claim result. Status can be 'fully_paid', 'partially_paid', or 'transaction_not_found'.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["fully_paid","partially_paid","transaction_not_found","confirmed","pending","authorized","paid","partially_paid","awaiting_withholding_tax_cert","refunded","failed","disputed"]},"message":{"type":"string"},"payment":{"type":"object","properties":{"id":{"type":"string"},"amount":{"type":"number"}},"required":["id","amount"]},"order":{"type":"object","properties":{"id":{"type":"string"},"orderNumber":{"type":"integer","minimum":-2147483648,"maximum":2147483647},"invoiceNumber":{"type":["string","null"]},"quotationId":{"type":["string","null"]},"inventoryLocationId":{"type":["string","null"]},"inventoryLocationGroupId":{"type":["string","null"]},"deliveryMethod":{"type":"string","enum":["pickup","delivery","drop_ship"]},"totalWeight":{"type":["string","null"]},"customerId":{"type":"string"},"contactPersonId":{"type":["string","null"]},"placedBy":{"type":"string"},"placedByType":{"type":"string","enum":["user","system","customer","integration"]},"salesRepId":{"type":["string","null"]},"salesChannelId":{"type":["string","null"]},"subtotalPrice":{"type":"string"},"totalPrice":{"type":"string"},"totalTax":{"type":["string","null"]},"totalShipping":{"type":["string","null"]},"totalWithheldTaxAmount":{"type":["string","null"]},"orderDiscount":{"type":["string","null"]},"totalDiscount":{"type":["string","null"]},"discountPercentage":{"type":["string","null"]},"discountType":{"type":["string","null"],"enum":["percentage","fixed",null]},"discountReason":{"type":["string","null"]},"status":{"type":"string","enum":["draft","pending","processing","ready_for_pickup","shipped","delivered","cancelled","refunded","completed","on_hold","invoiced"]},"approvalStatus":{"type":"string","enum":["not_required","pending","approved","rejected","escalated","outdated"]},"paymentStatus":{"type":"string","enum":["pending","authorized","paid","partially_paid","awaiting_withholding_tax_cert","refunded","failed","disputed"]},"paymentTerms":{"type":["string","null"]},"paymentDueDate":{"type":["string","null"]},"billingAddressId":{"type":["string","null"]},"shippingAddressId":{"type":["string","null"]},"trackingNumber":{"type":["string","null"]},"shippingCarrier":{"type":["string","null"]},"shippingMethod":{"type":["string","null"]},"estimatedDeliveryDate":{"type":["string","null"]},"actualDeliveryDate":{"type":["string","null"]},"confirmedAt":{"type":["string","null"]},"shippedAt":{"type":["string","null"]},"deliveredAt":{"type":["string","null"]},"closedAt":{"type":["string","null"]},"cancelledAt":{"type":["string","null"]},"externalId":{"type":["string","null"]},"externalSystem":{"type":["string","null"]},"externalDocumentNumber":{"type":["string","null"]},"syncStatus":{"type":["string","null"]},"syncError":{"type":["string","null"]},"lastSyncAt":{"type":["string","null"]},"notes":{"type":["string","null"]},"tags":{"type":["array","null"],"items":{"type":"string"}},"metadata":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"metrics":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"branchId":{"type":["string","null"]},"organizationId":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":["string","null"]},"deletedAt":{"type":["string","null"]},"paidAmount":{"type":["number","null"]},"balanceAmount":{"type":["number","null"]},"amountPendingApproval":{"type":["number","null"]},"totalPendingAmount":{"type":["number","null"]},"amountUnderProcessing":{"type":["number","null"]},"effectiveBalance":{"type":["number","null"]},"effectiveStatus":{"type":"string","enum":["verifying_payment","partially_paid","awaiting_payment","partially_paid_verifying","awaiting_withholding_tax_cert","paid","draft","pending","processing","ready_for_pickup","shipped","delivered","cancelled","refunded","completed","on_hold","invoiced"]},"lineItems":{"type":"array","items":{"type":"object","properties":{"productId":{"type":"string"},"purchaseOrderNumber":{"type":["string","null"]},"variantId":{"type":["string","null"]},"quantity":{"type":"string"},"unitPrice":{"type":"string"},"totalAmount":{"type":"string"},"costPrice":{"type":["string","null"]},"discountAmount":{"type":["string","null"]},"discountPercentage":{"type":["string","null"]},"inventoryLocationId":{"type":"string"},"name":{"type":"string"},"unitOfMeasure":{"type":"string"},"title":{"type":"string"},"variantTitle":{"type":["string","null"]},"inventoryLocation":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"type":["string","null"]},"isDefault":{"type":"boolean"},"status":{"type":["string","null"],"enum":["active","inactive",null]},"type":{"type":"string","enum":["warehouse","dropship","virtual"]},"priority":{"type":"integer","minimum":-2147483648,"maximum":2147483647},"deliveryRadiusMeters":{"type":["integer","null"],"minimum":-2147483648,"maximum":2147483647},"externalId":{"type":["string","null"]},"externalSystem":{"type":["string","null"]},"addressId":{"type":["string","null"]},"sellerId":{"type":["string","null"]},"supplierId":{"type":["string","null"]},"supplierContactId":{"type":["string","null"]},"supplierAddressId":{"type":["string","null"]},"groupId":{"type":["string","null"]},"organizationId":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":["string","null"]},"deletedAt":{"type":["string","null"]}},"required":["id","name","slug","isDefault","status","type","priority","deliveryRadiusMeters","externalId","externalSystem","addressId","sellerId","supplierId","supplierContactId","supplierAddressId","groupId","organizationId","createdAt","updatedAt","deletedAt"]},"product":{"type":"object","properties":{"weight":{"type":["string","null"]}},"required":["weight"]}},"required":["productId","quantity","unitPrice","totalAmount","costPrice","discountAmount","discountPercentage","inventoryLocationId","name","unitOfMeasure","title","variantTitle","inventoryLocation","product"]},"default":[]},"customer":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"phoneNumber":{"type":["string","null"]},"email":{"type":["string","null"]},"taxPin":{"type":["string","null"]},"externalId":{"type":["string","null"]},"creditMetadata":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]}},"required":["id","name","phoneNumber","email","taxPin","externalId","creditMetadata"]},"contactPerson":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"contactMethod":{"type":"string","enum":["whatsapp","email"]},"isPrimary":{"type":["boolean","null"]}},"required":["id","name","email","phone","contactMethod","isPrimary"]},"shippingAddress":{"type":["object","null"],"properties":{"id":{"type":"string"},"addressLine1":{"type":"string"},"addressLine2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":"string"},"latLng":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]}},"required":["id","addressLine1","addressLine2","city","state","country","latLng"]},"payments":{"type":"array","items":{"type":"object","properties":{"amount":{"type":"string"}},"required":["amount"]},"default":[]},"quotation":{"type":["object","null"],"properties":{"id":{"type":"string"},"quotationNumber":{"type":"integer","minimum":-2147483648,"maximum":2147483647}},"required":["id","quotationNumber"]},"attachments":{"type":["array","null"],"items":{"type":"object","properties":{"id":{"type":"string"},"documentType":{"type":"string","enum":["invoice","credit_note","delivery_note","proof_of_payment","purchase_order","withholding_tax_certificate","packing_list","order_receipt"]},"documentId":{"type":"string"},"fileName":{"type":"string"},"mimeType":{"type":["string","null"]},"fileKey":{"type":"string"},"fileSize":{"type":["integer","null"],"minimum":-2147483648,"maximum":2147483647},"createdAt":{"type":"string"},"updatedAt":{"type":["string","null"]}},"required":["id","documentType","documentId","fileName","mimeType","fileKey","fileSize","createdAt","updatedAt"]},"default":[]}},"required":["id","orderNumber","invoiceNumber","quotationId","inventoryLocationId","inventoryLocationGroupId","deliveryMethod","totalWeight","customerId","contactPersonId","placedBy","placedByType","salesRepId","salesChannelId","subtotalPrice","totalPrice","totalTax","totalShipping","totalWithheldTaxAmount","orderDiscount","totalDiscount","discountPercentage","discountType","discountReason","status","paymentStatus","paymentTerms","paymentDueDate","billingAddressId","shippingAddressId","trackingNumber","shippingCarrier","shippingMethod","confirmedAt","shippedAt","deliveredAt","closedAt","cancelledAt","externalId","externalSystem","externalDocumentNumber","syncStatus","syncError","lastSyncAt","notes","tags","metadata","metrics","branchId","organizationId","createdAt","updatedAt","deletedAt","effectiveStatus","lineItems","customer","payments","attachments"]}},"required":["status","message"]}}}}},"summary":"Claim bank payment","tags":["Orders"],"x-speakeasy-name-override":"claimBankPayment"}},"/v1/orders/{id}/withholding-tax/claim":{"post":{"description":"Submit a withholding tax reference to reconcile withholding tax for an order.","operationId":"claimWithholdingTax","parameters":[{"name":"id","required":true,"in":"path","description":"Order ID","schema":{"type":"string"}},{"name":"Cookie","in":"header","required":true,"schema":{"type":"string"}},{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Withholding tax reference number","content":{"application/json":{"schema":{"type":"object","properties":{"certificateNumber":{"type":"string"}},"required":["certificateNumber"]}}}},"responses":{"200":{"description":"Withholding tax claim result. Status can be 'withholding_tax_reconciled' or 'withholding_tax_not_found'.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["withholding_tax_not_found","withholding_tax_reconciled"]},"data":{"anyOf":[{"type":"object","properties":{"order":{"type":"object","properties":{"id":{"type":"string"},"orderNumber":{"type":"integer","minimum":-2147483648,"maximum":2147483647},"invoiceNumber":{"type":["string","null"]},"quotationId":{"type":["string","null"]},"inventoryLocationId":{"type":["string","null"]},"inventoryLocationGroupId":{"type":["string","null"]},"deliveryMethod":{"type":"string","enum":["pickup","delivery","drop_ship"]},"totalWeight":{"type":["string","null"]},"customerId":{"type":"string"},"contactPersonId":{"type":["string","null"]},"placedBy":{"type":"string"},"placedByType":{"type":"string","enum":["user","system","customer","integration"]},"salesRepId":{"type":["string","null"]},"salesChannelId":{"type":["string","null"]},"subtotalPrice":{"type":"string"},"totalPrice":{"type":"string"},"totalTax":{"type":["string","null"]},"totalShipping":{"type":["string","null"]},"totalWithheldTaxAmount":{"type":["string","null"]},"orderDiscount":{"type":["string","null"]},"totalDiscount":{"type":["string","null"]},"discountPercentage":{"type":["string","null"]},"discountType":{"type":["string","null"],"enum":["percentage","fixed",null]},"discountReason":{"type":["string","null"]},"status":{"type":"string","enum":["draft","pending","processing","ready_for_pickup","shipped","delivered","cancelled","refunded","completed","on_hold","invoiced"]},"approvalStatus":{"type":"string","enum":["not_required","pending","approved","rejected","escalated","outdated"]},"paymentStatus":{"type":"string","enum":["pending","authorized","paid","partially_paid","awaiting_withholding_tax_cert","refunded","failed","disputed"]},"paymentTerms":{"type":["string","null"]},"paymentDueDate":{"type":["string","null"]},"billingAddressId":{"type":["string","null"]},"shippingAddressId":{"type":["string","null"]},"trackingNumber":{"type":["string","null"]},"shippingCarrier":{"type":["string","null"]},"shippingMethod":{"type":["string","null"]},"estimatedDeliveryDate":{"type":["string","null"]},"actualDeliveryDate":{"type":["string","null"]},"confirmedAt":{"type":["string","null"]},"shippedAt":{"type":["string","null"]},"deliveredAt":{"type":["string","null"]},"closedAt":{"type":["string","null"]},"cancelledAt":{"type":["string","null"]},"externalId":{"type":["string","null"]},"externalSystem":{"type":["string","null"]},"externalDocumentNumber":{"type":["string","null"]},"syncStatus":{"type":["string","null"]},"syncError":{"type":["string","null"]},"lastSyncAt":{"type":["string","null"]},"notes":{"type":["string","null"]},"tags":{"type":["array","null"],"items":{"type":"string"}},"metadata":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"metrics":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]},"branchId":{"type":["string","null"]},"organizationId":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":["string","null"]},"deletedAt":{"type":["string","null"]},"paidAmount":{"type":["number","null"]},"balanceAmount":{"type":["number","null"]},"amountPendingApproval":{"type":["number","null"]},"totalPendingAmount":{"type":["number","null"]},"amountUnderProcessing":{"type":["number","null"]},"effectiveBalance":{"type":["number","null"]},"effectiveStatus":{"type":"string","enum":["verifying_payment","partially_paid","awaiting_payment","partially_paid_verifying","awaiting_withholding_tax_cert","paid","draft","pending","processing","ready_for_pickup","shipped","delivered","cancelled","refunded","completed","on_hold","invoiced"]},"lineItems":{"type":"array","items":{"type":"object","properties":{"productId":{"type":"string"},"purchaseOrderNumber":{"type":["string","null"]},"variantId":{"type":["string","null"]},"quantity":{"type":"string"},"unitPrice":{"type":"string"},"totalAmount":{"type":"string"},"costPrice":{"type":["string","null"]},"discountAmount":{"type":["string","null"]},"discountPercentage":{"type":["string","null"]},"inventoryLocationId":{"type":"string"},"name":{"type":"string"},"unitOfMeasure":{"type":"string"},"title":{"type":"string"},"variantTitle":{"type":["string","null"]},"inventoryLocation":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"type":["string","null"]},"isDefault":{"type":"boolean"},"status":{"type":["string","null"],"enum":["active","inactive",null]},"type":{"type":"string","enum":["warehouse","dropship","virtual"]},"priority":{"type":"integer","minimum":-2147483648,"maximum":2147483647},"deliveryRadiusMeters":{"type":["integer","null"],"minimum":-2147483648,"maximum":2147483647},"externalId":{"type":["string","null"]},"externalSystem":{"type":["string","null"]},"addressId":{"type":["string","null"]},"sellerId":{"type":["string","null"]},"supplierId":{"type":["string","null"]},"supplierContactId":{"type":["string","null"]},"supplierAddressId":{"type":["string","null"]},"groupId":{"type":["string","null"]},"organizationId":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":["string","null"]},"deletedAt":{"type":["string","null"]}},"required":["id","name","slug","isDefault","status","type","priority","deliveryRadiusMeters","externalId","externalSystem","addressId","sellerId","supplierId","supplierContactId","supplierAddressId","groupId","organizationId","createdAt","updatedAt","deletedAt"]},"product":{"type":"object","properties":{"weight":{"type":["string","null"]}},"required":["weight"]}},"required":["productId","quantity","unitPrice","totalAmount","costPrice","discountAmount","discountPercentage","inventoryLocationId","name","unitOfMeasure","title","variantTitle","inventoryLocation","product"]},"default":[]},"customer":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"phoneNumber":{"type":["string","null"]},"email":{"type":["string","null"]},"taxPin":{"type":["string","null"]},"externalId":{"type":["string","null"]},"creditMetadata":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]}},"required":["id","name","phoneNumber","email","taxPin","externalId","creditMetadata"]},"contactPerson":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"contactMethod":{"type":"string","enum":["whatsapp","email"]},"isPrimary":{"type":["boolean","null"]}},"required":["id","name","email","phone","contactMethod","isPrimary"]},"shippingAddress":{"type":["object","null"],"properties":{"id":{"type":"string"},"addressLine1":{"type":"string"},"addressLine2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":"string"},"latLng":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},{"type":"object","additionalProperties":{}},{"type":"array","items":{}},{"type":"null"}]}},"required":["id","addressLine1","addressLine2","city","state","country","latLng"]},"payments":{"type":"array","items":{"type":"object","properties":{"amount":{"type":"string"}},"required":["amount"]},"default":[]},"quotation":{"type":["object","null"],"properties":{"id":{"type":"string"},"quotationNumber":{"type":"integer","minimum":-2147483648,"maximum":2147483647}},"required":["id","quotationNumber"]},"attachments":{"type":["array","null"],"items":{"type":"object","properties":{"id":{"type":"string"},"documentType":{"type":"string","enum":["invoice","credit_note","delivery_note","proof_of_payment","purchase_order","withholding_tax_certificate","packing_list","order_receipt"]},"documentId":{"type":"string"},"fileName":{"type":"string"},"mimeType":{"type":["string","null"]},"fileKey":{"type":"string"},"fileSize":{"type":["integer","null"],"minimum":-2147483648,"maximum":2147483647},"createdAt":{"type":"string"},"updatedAt":{"type":["string","null"]}},"required":["id","documentType","documentId","fileName","mimeType","fileKey","fileSize","createdAt","updatedAt"]},"default":[]}},"required":["id","orderNumber","invoiceNumber","quotationId","inventoryLocationId","inventoryLocationGroupId","deliveryMethod","totalWeight","customerId","contactPersonId","placedBy","placedByType","salesRepId","salesChannelId","subtotalPrice","totalPrice","totalTax","totalShipping","totalWithheldTaxAmount","orderDiscount","totalDiscount","discountPercentage","discountType","discountReason","status","paymentStatus","paymentTerms","paymentDueDate","billingAddressId","shippingAddressId","trackingNumber","shippingCarrier","shippingMethod","confirmedAt","shippedAt","deliveredAt","closedAt","cancelledAt","externalId","externalSystem","externalDocumentNumber","syncStatus","syncError","lastSyncAt","notes","tags","metadata","metrics","branchId","organizationId","createdAt","updatedAt","deletedAt","effectiveStatus","lineItems","customer","payments","attachments"]}},"required":["order"]},{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}]}},"required":["status","data"]}}}}},"summary":"Claim withholding tax","tags":["Orders"],"x-speakeasy-name-override":"claimWithholdingTax"}},"/v1/orders/{id}/attachments":{"post":{"description":"Finalizes the attachment record and triggers automated processing ","operationId":"OrdersController_create_v1","parameters":[{"name":"id","required":true,"in":"path","description":"Order ID","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"documentType":{"type":"string","enum":["invoice","credit_note","delivery_note","proof_of_payment","purchase_order","withholding_tax_certificate","packing_list","order_receipt"]},"documentId":{"type":"string","minLength":1},"fileName":{"type":"string","minLength":1},"mimeType":{"type":"string","minLength":1},"fileKey":{"type":"string","minLength":1},"fileSize":{"type":["integer","null"],"minimum":-2147483648,"maximum":2147483647}},"required":["documentType","documentId","fileName","mimeType","fileKey"]}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"orderAttachment":{"type":"object","properties":{"id":{"type":"string"},"orderId":{"type":"string"},"documentType":{"type":"string","enum":["invoice","credit_note","delivery_note","proof_of_payment","purchase_order","withholding_tax_certificate","packing_list","order_receipt"]},"documentId":{"type":"string"},"status":{"type":"string","enum":["uploaded","sent"]},"fileName":{"type":"string"},"fileSize":{"type":["integer","null"],"minimum":-2147483648,"maximum":2147483647},"mimeType":{"type":["string","null"]},"fileKey":{"type":"string"},"sentAt":{"type":["string","null"]},"failureReason":{"type":["string","null"]},"createdAt":{"type":"string"},"updatedAt":{"type":["string","null"]},"deletedAt":{"type":["string","null"]}},"required":["id","orderId","documentType","documentId","status","fileName","fileSize","mimeType","fileKey","sentAt","failureReason","createdAt","updatedAt","deletedAt"]}},"required":["orderAttachment"]}}}}},"summary":"Create order attachment","tags":["Orders"]},"get":{"operationId":"listOrderAttachments","parameters":[{"name":"id","required":true,"in":"path","description":"Order ID","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"attachments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"orderId":{"type":"string"},"documentType":{"type":"string","enum":["invoice","credit_note","delivery_note","proof_of_payment","purchase_order","withholding_tax_certificate","packing_list","order_receipt"]},"documentId":{"type":"string"},"status":{"type":"string","enum":["uploaded","sent"]},"fileName":{"type":"string"},"fileSize":{"type":["integer","null"],"minimum":-2147483648,"maximum":2147483647},"mimeType":{"type":["string","null"]},"fileKey":{"type":"string"},"sentAt":{"type":["string","null"]},"failureReason":{"type":["string","null"]},"createdAt":{"type":"string"},"updatedAt":{"type":["string","null"]},"deletedAt":{"type":["string","null"]}},"required":["id","orderId","documentType","documentId","status","fileName","fileSize","mimeType","fileKey","sentAt","failureReason","createdAt","updatedAt","deletedAt"]}},"pagination":{"type":"object","properties":{"total":{"type":"number","description":"Total number of results"},"page":{"type":"number","description":"Current page number"},"limit":{"type":"number","description":"Page size"},"hasNextPage":{"type":"boolean","description":"Whether or not there is a next page"}},"required":["total","page","limit","hasNextPage"]}},"required":["attachments","pagination"]}}}}},"summary":"List all attachments for an order","tags":["Orders"]}},"/v1/orders/{id}/attachments/presign-upload":{"post":{"description":"Generates a presigned URL for uploading a customer document with type-based storage paths","operationId":"presignCustomerDocumentUpload","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"fileName":{"type":"string","minLength":1},"mimeType":{"type":"string","minLength":1},"documentType":{"type":"string","enum":["invoice","credit_note","delivery_note","proof_of_payment","purchase_order","withholding_tax_certificate","packing_list","order_receipt"]},"documentId":{"type":"string","minLength":1}},"required":["fileName","mimeType","documentType","documentId"]}}}},"responses":{"201":{"description":"Success. Returns presigned URL and file details","content":{"application/json":{"schema":{"type":"object","properties":{"fileKey":{"type":"string"},"url":{"type":"string"},"fileId":{"type":"string"}},"required":["fileKey","url","fileId"]}}}}},"summary":"Generate presigned URL for customer document upload","tags":["Orders"]}},"/v1/orders/{id}/attachments/type/{documentType}":{"get":{"operationId":"listAttachmentsByType","parameters":[{"name":"id","required":true,"in":"path","description":"Order ID","schema":{"type":"string"}},{"name":"documentType","required":true,"in":"path","schema":{"enum":["invoice","credit_note","delivery_note","proof_of_payment","purchase_order","withholding_tax_certificate","packing_list","order_receipt"],"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"attachments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"orderId":{"type":"string"},"documentType":{"type":"string","enum":["invoice","credit_note","delivery_note","proof_of_payment","purchase_order","withholding_tax_certificate","packing_list","order_receipt"]},"documentId":{"type":"string"},"status":{"type":"string","enum":["uploaded","sent"]},"fileName":{"type":"string"},"fileSize":{"type":["integer","null"],"minimum":-2147483648,"maximum":2147483647},"mimeType":{"type":["string","null"]},"fileKey":{"type":"string"},"sentAt":{"type":["string","null"]},"failureReason":{"type":["string","null"]},"createdAt":{"type":"string"},"updatedAt":{"type":["string","null"]},"deletedAt":{"type":["string","null"]}},"required":["id","orderId","documentType","documentId","status","fileName","fileSize","mimeType","fileKey","sentAt","failureReason","createdAt","updatedAt","deletedAt"]}},"pagination":{"type":"object","properties":{"total":{"type":"number","description":"Total number of results"},"page":{"type":"number","description":"Current page number"},"limit":{"type":"number","description":"Page size"},"hasNextPage":{"type":"boolean","description":"Whether or not there is a next page"}},"required":["total","page","limit","hasNextPage"]}},"required":["attachments","pagination"]}}}}},"summary":"Filter attachments by document type","tags":["Orders"]}},"/v1/orders/{id}/attachments/{attachmentId}":{"get":{"operationId":"getAttachmentById","parameters":[{"name":"id","required":true,"in":"path","description":"Order ID","schema":{"type":"string"}},{"name":"attachmentId","required":true,"in":"path","description":"Attachment ID","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"orderAttachment":{"type":"object","properties":{"id":{"type":"string"},"orderId":{"type":"string"},"documentType":{"type":"string","enum":["invoice","credit_note","delivery_note","proof_of_payment","purchase_order","withholding_tax_certificate","packing_list","order_receipt"]},"documentId":{"type":"string"},"status":{"type":"string","enum":["uploaded","sent"]},"fileName":{"type":"string"},"fileSize":{"type":["integer","null"],"minimum":-2147483648,"maximum":2147483647},"mimeType":{"type":["string","null"]},"fileKey":{"type":"string"},"sentAt":{"type":["string","null"]},"failureReason":{"type":["string","null"]},"createdAt":{"type":"string"},"updatedAt":{"type":["string","null"]},"deletedAt":{"type":["string","null"]}},"required":["id","orderId","documentType","documentId","status","fileName","fileSize","mimeType","fileKey","sentAt","failureReason","createdAt","updatedAt","deletedAt"]}},"required":["orderAttachment"]}}}}},"summary":"Get specific attachment metadata","tags":["Orders"]},"delete":{"operationId":"OrdersController_remove_v1","parameters":[{"name":"id","required":true,"in":"path","description":"Order ID","schema":{"type":"string"}},{"name":"attachmentId","required":true,"in":"path","description":"Attachment ID","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"Delete an attachment and its associated file","tags":["Orders"]}},"/v1/orders/{id}/attachments/{attachmentId}/download":{"get":{"operationId":"downloadAttachment","parameters":[{"name":"id","required":true,"in":"path","description":"Order ID","schema":{"type":"string"}},{"name":"attachmentId","required":true,"in":"path","description":"Attachment ID","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"Get a temporary download URL for an attachment","tags":["Orders"]}},"/v1/feed/home":{"get":{"description":"Retrieves a personalized feed of products and content for the authenticated user's / anonymous user home page.","operationId":"FeedController_getHomeFeed_v1","parameters":[{"name":"page","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"type":"integer","minimum":0,"exclusiveMinimum":true,"description":"Page number","default":1}},{"name":"limit","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"type":"integer","minimum":0,"exclusiveMinimum":true,"maximum":200,"description":"Page size","default":20}},{"name":"search","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"type":"string","description":"Search query"}},{"name":"filters","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"type":"object","properties":{"price":{"type":"object","properties":{"eq":{"type":"number"},"gt":{"type":"number"},"lt":{"type":"number"}}},"tag":{"type":"object","properties":{"eq":{"type":"string"},"neq":{"type":"string"}}}}}},{"name":"sort","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"type":"object","properties":{"asc":{"type":"string","enum":["price"]},"desc":{"type":"string","enum":["price"]}},"additionalProperties":false}},{"name":"latLng","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"type":"string","example":"-1.2944722,36.8218611","description":"Latitude and longitude of the location, comma separated (Lat,Lng)"}},{"name":"deliveryMethod","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"type":"string","enum":["pickup","delivery"],"default":"pickup"}}],"responses":{"200":{"description":""}},"summary":"Personalized home feed","tags":["Feed"]}},"/v1/checkout/initiate":{"post":{"description":"Provides a preview of the order details, including estimated shipping costs, payment options, and total amount.","operationId":"CheckoutController_initiateCheckout_v1","parameters":[],"requestBody":{"required":true,"description":"The items to preview the checkout for","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"productId":{"type":"string","example":"l4mzkppns5ppc8945entftmr"},"variantId":{"type":"string","example":"l4mzkppns5ppc8945entftmr"},"quantity":{"type":"integer","exclusiveMinimum":0,"example":2},"locationPriceId":{"type":"string","example":"ko59jdz7s6ay1r9lpczrbihd"},"priceBookId":{"type":"string","example":"ko59jdz7s6ay1r9lpczrbihd"}},"required":["productId","quantity","locationPriceId","priceBookId"]},"description":"Array of checkout items"}},"required":["items"]}}}},"responses":{"201":{"description":""}},"summary":"Initiate checkout","tags":["Checkout"]}},"/v1/checkout/submit":{"post":{"description":"Finalizes the order and initiates the payment process.","operationId":"CheckoutController_submitOrder_v1","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"notes":{"type":"string"},"contactPersonId":{"type":"string"},"deliveryMethod":{"type":"string","enum":["pickup","delivery","drop_ship"]},"shippingAddressId":{"type":"string"},"salesChannelId":{"type":"string"},"lineItems":{"type":"array","items":{"type":"object","properties":{"productId":{"type":"string"},"variantId":{"type":"string","minLength":1},"inventoryLocationId":{"type":"string"},"quantity":{"type":"integer"},"priceBookId":{"type":"string"},"priceBookEntryId":{"type":"string"}},"required":["productId","inventoryLocationId","quantity","priceBookId"]},"minItems":1}},"required":["deliveryMethod","salesChannelId","lineItems"]}}}},"responses":{"201":{"description":""}},"summary":"Submit final order","tags":["Checkout"]}},"/v1/profile":{"get":{"operationId":"getCustomer","parameters":[],"responses":{"200":{"description":"Customer documents.","content":{"application/json":{"schema":{"type":"object","properties":{"customer":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":["string","null"]},"avatarUrl":{"type":["string","null"]},"phoneNumber":{"type":["string","null"]},"groupId":{"type":["string","null"]},"type":{"type":["string","null"],"enum":["individual","company",null]},"status":{"type":["string","null"],"enum":["active","inactive",null]},"externalId":{"type":["string","null"]},"externalSource":{"type":["string","null"]},"source":{"type":["string","null"]},"taxPin":{"type":["string","null"]},"withholdingTaxStatus":{"type":["string","null"],"enum":["pending","approved","rejected",null]},"creditLimit":{"type":["number","null"]},"creditMetadata":{"type":["object","null"],"additionalProperties":{}},"paymentTerms":{"type":["string","null"]},"accountBalance":{"type":["number","null"]},"openOrdersBalance":{"type":["number","null"]},"discountPercentage":{"type":["number","null"]},"salesPersonId":{"type":["string","null"]},"organizationId":{"type":"string"},"emailVerified":{"type":["boolean","null"]},"image":{"type":["string","null"]},"banned":{"type":["boolean","null"]},"banReason":{"type":["string","null"]},"banExpires":{"type":["string","null"]},"isAnonymous":{"type":["boolean","null"]},"phoneNumberVerified":{"type":["boolean","null"]},"numberOfOrders":{"type":["number","null"]},"totalSpent":{"type":["string","null"]},"averageOrderValue":{"type":["string","null"]},"lastOrderDate":{"type":["string","null"]},"createdAt":{"type":"string"},"updatedAt":{"type":["string","null"]},"deletedAt":{"type":["string","null"]},"notes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"content":{"type":"string"},"documentType":{"type":"string","enum":["customer","order","quotation"]},"documentId":{"type":"string"},"organizationId":{"type":"string"},"createdBy":{"type":"string"},"createdByType":{"type":"string","enum":["user","integration","customer"]},"createdAt":{"type":"string"},"updatedAt":{"type":["string","null"]},"deletedAt":{"type":["string","null"]},"author":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"image":{"type":["string","null"]},"email":{"type":"string"}},"required":["id","name","email"]}},"required":["id","content","documentType","documentId","organizationId","createdBy","createdByType","createdAt","updatedAt","deletedAt"]}},"contacts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"isPrimary":{"type":["boolean","null"]},"contactMethod":{"type":"string","enum":["whatsapp","email"]},"createdAt":{"type":"string"},"updatedAt":{"type":["string","null"]}},"required":["id","name","email","phone","isPrimary","contactMethod","createdAt","updatedAt"]},"default":[]},"statuses":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"},"customerId":{"type":"string"},"isActive":{"type":["boolean","null"]},"organizationId":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":["string","null"]},"deletedAt":{"type":["string","null"]}},"required":["id","status","customerId","isActive","organizationId","createdAt","updatedAt","deletedAt"]},"default":[]},"group":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"type":["string","null"]},"description":{"type":["string","null"]},"externalId":{"type":["string","null"]},"externalSource":{"type":["string","null"]},"organizationId":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":["string","null"]},"deletedAt":{"type":["string","null"]}},"required":["id","name","slug","description","externalId","externalSource","organizationId","createdAt","updatedAt","deletedAt"]},"addresses":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"addressType":{"type":"string"},"addressLine1":{"type":"string"},"addressLine2":{"type":["string","null"]},"state":{"type":["string","null"]},"postalCode":{"type":["string","null"]},"city":{"type":["string","null"]},"country":{"type":"string"},"latLng":{"type":["object","null"],"properties":{"lat":{"type":"number"},"lng":{"type":"number"}},"required":["lat","lng"]},"entityId":{"type":"string"},"entityType":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":["string","null"]}},"required":["id","addressType","addressLine1","addressLine2","state","postalCode","city","country","entityId","entityType","createdAt","updatedAt"]},"default":[]},"documents":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"customerId":{"type":"string"},"type":{"type":"string","enum":["tax_certificate","business_permit","id_card","withholding_tax_appointment_letter"]},"variant":{"type":["string","null"]},"status":{"type":"string","enum":["pending","verified","expired","rejected"]},"fileName":{"type":"string"},"fileSize":{"type":"integer","minimum":-2147483648,"maximum":2147483647},"mimeType":{"type":"string"},"verifiedAt":{"type":["string","null"]},"rejectedAt":{"type":["string","null"]},"rejectionReason":{"type":["string","null"]},"expiresAt":{"type":["string","null"]},"createdAt":{"type":"string"},"updatedAt":{"type":["string","null"]},"deletedAt":{"type":["string","null"]}},"required":["id","customerId","type","variant","status","fileName","fileSize","mimeType","verifiedAt","rejectedAt","rejectionReason","expiresAt","createdAt","updatedAt","deletedAt"]},"default":[]},"salesPerson":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":["string","null"]},"emailVerified":{"type":["boolean","null"]},"image":{"type":["string","null"]},"role":{"type":["string","null"]},"banned":{"type":["boolean","null"]},"banReason":{"type":["string","null"]},"banExpires":{"type":["string","null"]},"twoFactorEnabled":{"type":["boolean","null"]},"twoFactorMethods":{"type":["array","null"],"items":{"type":"string"}},"isMachineUser":{"type":["boolean","null"]},"phoneNumber":{"type":["string","null"]},"phoneNumberVerified":{"type":["boolean","null"]},"defaultOrganizationId":{"type":["string","null"]},"createdAt":{"type":"string"},"updatedAt":{"type":["string","null"]},"deletedAt":{"type":["string","null"]}},"required":["id","name","email","emailVerified","image","role","banned","banReason","banExpires","twoFactorEnabled","twoFactorMethods","isMachineUser","phoneNumber","phoneNumberVerified","defaultOrganizationId","createdAt","updatedAt","deletedAt"]},"segments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"customerId":{"type":"string"},"segmentId":{"type":"string"},"assignedAt":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":["string","null"]},"deletedAt":{"type":["string","null"]},"segment":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":["string","null"]}},"required":["id","name","description"]}},"required":["id","customerId","segmentId","assignedAt","createdAt","updatedAt","deletedAt"]},"default":[]}},"required":["id","name","email","avatarUrl","phoneNumber","groupId","type","status","externalId","externalSource","source","taxPin","withholdingTaxStatus","paymentTerms","salesPersonId","organizationId","emailVerified","image","banned","banReason","banExpires","isAnonymous","phoneNumberVerified","lastOrderDate","createdAt","updatedAt","deletedAt","contacts","statuses","addresses","documents","segments"]}},"required":["customer"]}}}}},"summary":"Get customer details","tags":["Customer-Profile"],"x-speakeasy-name-override":"getCustomer"},"patch":{"operationId":"updateCustomer","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"avatarUrl":{"type":["string","null"]},"taxPin":{"type":["string","null"]},"image":{"type":["string","null"]},"type":{"type":["string","null"],"enum":["individual","company",null]},"groupId":{"type":["string","null"]}}}}}},"responses":{"200":{"description":"Customer documents.","content":{"application/json":{"schema":{"type":"object","properties":{"customer":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":["string","null"]},"avatarUrl":{"type":["string","null"]},"phoneNumber":{"type":["string","null"]},"groupId":{"type":["string","null"]},"type":{"type":["string","null"],"enum":["individual","company",null]},"status":{"type":["string","null"],"enum":["active","inactive",null]},"externalId":{"type":["string","null"]},"externalSource":{"type":["string","null"]},"source":{"type":["string","null"]},"taxPin":{"type":["string","null"]},"withholdingTaxStatus":{"type":["string","null"],"enum":["pending","approved","rejected",null]},"creditLimit":{"type":["number","null"]},"creditMetadata":{"type":["object","null"],"additionalProperties":{}},"paymentTerms":{"type":["string","null"]},"accountBalance":{"type":["number","null"]},"openOrdersBalance":{"type":["number","null"]},"discountPercentage":{"type":["number","null"]},"salesPersonId":{"type":["string","null"]},"organizationId":{"type":"string"},"emailVerified":{"type":["boolean","null"]},"image":{"type":["string","null"]},"banned":{"type":["boolean","null"]},"banReason":{"type":["string","null"]},"banExpires":{"type":["string","null"]},"isAnonymous":{"type":["boolean","null"]},"phoneNumberVerified":{"type":["boolean","null"]},"numberOfOrders":{"type":["number","null"]},"totalSpent":{"type":["string","null"]},"averageOrderValue":{"type":["string","null"]},"lastOrderDate":{"type":["string","null"]},"createdAt":{"type":"string"},"updatedAt":{"type":["string","null"]},"deletedAt":{"type":["string","null"]},"notes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"content":{"type":"string"},"documentType":{"type":"string","enum":["customer","order","quotation"]},"documentId":{"type":"string"},"organizationId":{"type":"string"},"createdBy":{"type":"string"},"createdByType":{"type":"string","enum":["user","integration","customer"]},"createdAt":{"type":"string"},"updatedAt":{"type":["string","null"]},"deletedAt":{"type":["string","null"]},"author":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"image":{"type":["string","null"]},"email":{"type":"string"}},"required":["id","name","email"]}},"required":["id","content","documentType","documentId","organizationId","createdBy","createdByType","createdAt","updatedAt","deletedAt"]}},"contacts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"isPrimary":{"type":["boolean","null"]},"contactMethod":{"type":"string","enum":["whatsapp","email"]},"createdAt":{"type":"string"},"updatedAt":{"type":["string","null"]}},"required":["id","name","email","phone","isPrimary","contactMethod","createdAt","updatedAt"]},"default":[]},"statuses":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"},"customerId":{"type":"string"},"isActive":{"type":["boolean","null"]},"organizationId":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":["string","null"]},"deletedAt":{"type":["string","null"]}},"required":["id","status","customerId","isActive","organizationId","createdAt","updatedAt","deletedAt"]},"default":[]},"group":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"type":["string","null"]},"description":{"type":["string","null"]},"externalId":{"type":["string","null"]},"externalSource":{"type":["string","null"]},"organizationId":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":["string","null"]},"deletedAt":{"type":["string","null"]}},"required":["id","name","slug","description","externalId","externalSource","organizationId","createdAt","updatedAt","deletedAt"]},"addresses":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"addressType":{"type":"string"},"addressLine1":{"type":"string"},"addressLine2":{"type":["string","null"]},"state":{"type":["string","null"]},"postalCode":{"type":["string","null"]},"city":{"type":["string","null"]},"country":{"type":"string"},"latLng":{"type":["object","null"],"properties":{"lat":{"type":"number"},"lng":{"type":"number"}},"required":["lat","lng"]},"entityId":{"type":"string"},"entityType":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":["string","null"]}},"required":["id","addressType","addressLine1","addressLine2","state","postalCode","city","country","entityId","entityType","createdAt","updatedAt"]},"default":[]},"documents":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"customerId":{"type":"string"},"type":{"type":"string","enum":["tax_certificate","business_permit","id_card","withholding_tax_appointment_letter"]},"variant":{"type":["string","null"]},"status":{"type":"string","enum":["pending","verified","expired","rejected"]},"fileName":{"type":"string"},"fileSize":{"type":"integer","minimum":-2147483648,"maximum":2147483647},"mimeType":{"type":"string"},"verifiedAt":{"type":["string","null"]},"rejectedAt":{"type":["string","null"]},"rejectionReason":{"type":["string","null"]},"expiresAt":{"type":["string","null"]},"createdAt":{"type":"string"},"updatedAt":{"type":["string","null"]},"deletedAt":{"type":["string","null"]}},"required":["id","customerId","type","variant","status","fileName","fileSize","mimeType","verifiedAt","rejectedAt","rejectionReason","expiresAt","createdAt","updatedAt","deletedAt"]},"default":[]},"salesPerson":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":["string","null"]},"emailVerified":{"type":["boolean","null"]},"image":{"type":["string","null"]},"role":{"type":["string","null"]},"banned":{"type":["boolean","null"]},"banReason":{"type":["string","null"]},"banExpires":{"type":["string","null"]},"twoFactorEnabled":{"type":["boolean","null"]},"twoFactorMethods":{"type":["array","null"],"items":{"type":"string"}},"isMachineUser":{"type":["boolean","null"]},"phoneNumber":{"type":["string","null"]},"phoneNumberVerified":{"type":["boolean","null"]},"defaultOrganizationId":{"type":["string","null"]},"createdAt":{"type":"string"},"updatedAt":{"type":["string","null"]},"deletedAt":{"type":["string","null"]}},"required":["id","name","email","emailVerified","image","role","banned","banReason","banExpires","twoFactorEnabled","twoFactorMethods","isMachineUser","phoneNumber","phoneNumberVerified","defaultOrganizationId","createdAt","updatedAt","deletedAt"]},"segments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"customerId":{"type":"string"},"segmentId":{"type":"string"},"assignedAt":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":["string","null"]},"deletedAt":{"type":["string","null"]},"segment":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":["string","null"]}},"required":["id","name","description"]}},"required":["id","customerId","segmentId","assignedAt","createdAt","updatedAt","deletedAt"]},"default":[]}},"required":["id","name","email","avatarUrl","phoneNumber","groupId","type","status","externalId","externalSource","source","taxPin","withholdingTaxStatus","paymentTerms","salesPersonId","organizationId","emailVerified","image","banned","banReason","banExpires","isAnonymous","phoneNumberVerified","lastOrderDate","createdAt","updatedAt","deletedAt","contacts","statuses","addresses","documents","segments"]}},"required":["customer"]}}}}},"summary":"Update Customer details","tags":["Customer-Profile"],"x-speakeasy-name-override":"updateCustomer"}},"/v1/profile/documents":{"get":{"description":"List all documents uploaded for a specific customer by ID","operationId":"listCustomerDocuments","parameters":[],"responses":{"200":{"description":"Customer documents.","content":{"application/json":{"schema":{"type":"object","properties":{"documents":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"customerId":{"type":"string"},"type":{"type":"string","enum":["tax_certificate","business_permit","id_card","withholding_tax_appointment_letter"]},"variant":{"type":["string","null"]},"status":{"type":"string","enum":["pending","verified","expired","rejected"]},"fileName":{"type":"string"},"fileSize":{"type":"integer","minimum":-2147483648,"maximum":2147483647},"mimeType":{"type":"string"},"verifiedAt":{"type":["string","null"]},"rejectedAt":{"type":["string","null"]},"rejectionReason":{"type":["string","null"]},"expiresAt":{"type":["string","null"]},"createdAt":{"type":"string"},"updatedAt":{"type":["string","null"]},"deletedAt":{"type":["string","null"]}},"required":["id","customerId","type","variant","status","fileName","fileSize","mimeType","verifiedAt","rejectedAt","rejectionReason","expiresAt","createdAt","updatedAt","deletedAt"]}}},"required":["documents"]}}}}},"summary":"List customer documents","tags":["Customer-Profile"],"x-speakeasy-name-override":"listCustomerDocuments"},"post":{"operationId":"createCustomerDocuments","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["tax_certificate","business_permit","id_card","withholding_tax_appointment_letter"]},"variant":{"type":["string","null"]},"fileKey":{"type":"string"},"fileName":{"type":"string"},"fileSize":{"type":"integer","minimum":-2147483648,"maximum":2147483647},"mimeType":{"type":"string"},"expiresAt":{"type":["string","null"]}},"required":["type","fileKey","fileName","fileSize","mimeType"]}}}},"responses":{"201":{"description":"Customer document created successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"document":{"type":"object","properties":{"id":{"type":"string"},"customerId":{"type":"string"},"type":{"type":"string","enum":["tax_certificate","business_permit","id_card","withholding_tax_appointment_letter"]},"variant":{"type":["string","null"]},"status":{"type":"string","enum":["pending","verified","expired","rejected"]},"fileName":{"type":"string"},"fileSize":{"type":"integer","minimum":-2147483648,"maximum":2147483647},"mimeType":{"type":"string"},"verifiedAt":{"type":["string","null"]},"rejectedAt":{"type":["string","null"]},"rejectionReason":{"type":["string","null"]},"expiresAt":{"type":["string","null"]},"createdAt":{"type":"string"},"updatedAt":{"type":["string","null"]},"deletedAt":{"type":["string","null"]}},"required":["id","customerId","type","variant","status","fileName","fileSize","mimeType","verifiedAt","rejectedAt","rejectionReason","expiresAt","createdAt","updatedAt","deletedAt"]}},"required":["document"]}}}}},"summary":"Create customer documents","tags":["Customer-Profile"],"x-speakeasy-name-override":"createDocument"}},"/v1/profile/documents/{documentId}":{"put":{"description":"Replace a customer document","operationId":"replaceCustomerDocument","parameters":[{"name":"documentId","required":true,"in":"path","description":"Document ID","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["tax_certificate","business_permit","id_card","withholding_tax_appointment_letter"]},"variant":{"type":["string","null"]},"fileKey":{"type":"string"},"fileName":{"type":"string"},"fileSize":{"type":"integer","minimum":-2147483648,"maximum":2147483647},"mimeType":{"type":"string"},"expiresAt":{"type":["string","null"]}},"required":["type","fileKey","fileName","fileSize","mimeType"]}}}},"responses":{"200":{"description":"Customer document replaced successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"document":{"type":"object","properties":{"id":{"type":"string"},"customerId":{"type":"string"},"type":{"type":"string","enum":["tax_certificate","business_permit","id_card","withholding_tax_appointment_letter"]},"variant":{"type":["string","null"]},"status":{"type":"string","enum":["pending","verified","expired","rejected"]},"fileName":{"type":"string"},"fileSize":{"type":"integer","minimum":-2147483648,"maximum":2147483647},"mimeType":{"type":"string"},"verifiedAt":{"type":["string","null"]},"rejectedAt":{"type":["string","null"]},"rejectionReason":{"type":["string","null"]},"expiresAt":{"type":["string","null"]},"createdAt":{"type":"string"},"updatedAt":{"type":["string","null"]},"deletedAt":{"type":["string","null"]}},"required":["id","customerId","type","variant","status","fileName","fileSize","mimeType","verifiedAt","rejectedAt","rejectionReason","expiresAt","createdAt","updatedAt","deletedAt"]}},"required":["document"]}}}}},"summary":"Replace customer document","tags":["Customer-Profile"],"x-speakeasy-name-override":"replaceDocument"}},"/v1/profile/documents/presign-upload":{"post":{"description":"Generates a presigned URL for uploading a customer document with type-based storage paths","operationId":"presignCustomerDocumentUpload","parameters":[],"requestBody":{"required":true,"description":"Document upload details","content":{"application/json":{"schema":{"type":"object","properties":{"fileName":{"type":"string","minLength":1},"mimeType":{"type":"string","minLength":1},"documentType":{"type":"string","enum":["tax_certificate","business_permit","id_card","withholding_tax_appointment_letter"]},"variant":{"type":"string"}},"required":["fileName","mimeType","documentType"]}}}},"responses":{"201":{"description":"Success. Returns presigned URL and file ID","content":{"application/json":{"schema":{"type":"object","properties":{"fileKey":{"type":"string"},"url":{"type":"string"},"fileId":{"type":"string"}},"required":["fileKey","url","fileId"]}}}}},"summary":"Generate presigned URL for customer document upload","tags":["Customer-Profile"],"x-speakeasy-name-override":"customerDocPresignUpload"}},"/v1/profile/documents/{documentId}/download":{"get":{"description":"Generates a presigned URL for downloading/viewing a customer document","operationId":"getCustomerDocumentDownloadUrl","parameters":[{"name":"documentId","required":true,"in":"path","description":"The ID of the document","schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Returns presigned URL for downloading","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"expiresIn":{"type":"number"},"fileName":{"type":"string"}},"required":["url","expiresIn","fileName"]}}}}},"summary":"Get presigned URL for downloading customer document","tags":["Customer-Profile"],"x-speakeasy-name-override":"getCustomerDocumentDownloadUrl"}},"/v1/api-keys":{"post":{"description":"Create an api key","operationId":"createApiKey","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"isMachineUserOwned":{"type":"boolean","default":false},"permissions":{"type":"string"},"expiresIn":{"type":"integer","exclusiveMinimum":0},"machineUserId":{"type":"string"}},"required":["name","isMachineUserOwned"]}}}},"responses":{"201":{"description":""}},"summary":"Create api key","tags":["API Keys"],"x-speakeasy-name-override":"createApiKey"},"put":{"operationId":"bulkUpdateApiKeys","parameters":[{"name":"apiKeys","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"permissions":{"type":"string"}},"required":["id","permissions"]}}}],"responses":{"200":{"description":""}},"summary":"Update an api key","tags":["API Keys"],"x-speakeasy-name-override":"bulkUpdateAPiKeys"},"get":{"description":"List all api keys","operationId":"listApiKeys","parameters":[{"name":"name","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"type":"string","minLength":1,"maxLength":100}},{"name":"isMachineUserOwned","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"type":"boolean","default":false}},{"name":"permissions","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"type":"string"}},{"name":"expiresIn","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"type":"integer","minimum":0,"exclusiveMinimum":true}},{"name":"machineUserId","required":false,"in":"query","style":"deepObject","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"List api keys","tags":["API Keys"],"x-speakeasy-name-override":"listApiKeys"}},"/v1/api-keys/{id}":{"delete":{"description":"Deletes an api key by id","operationId":"deleteApiKey","parameters":[{"name":"id","required":true,"in":"path","description":"API Key ID","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"Delete an api key","tags":["API Keys"],"x-speakeasy-name-override":"deleteApiKey"}}},"info":{"title":"E-Commerce API","description":"E-Commerce API allows users to create an e-commerce experience for customers using resources from Bunni Admin App.","version":"1.0","contact":{}},"tags":[],"servers":[{"url":"https://commerce.staging.bunihq.com","description":"Staging"}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key generated from your organization dashboard"},"cookie":{"type":"apiKey","in":"cookie","name":"connect.sid"}},"schemas":{}},"security":[{"api_key":[]}]}