{"openapi":"3.1.0","info":{"title":"Resonance Demand Storefront REST API","summary":"Resonance Demand Storefront API Routes that fall outside of GraphQL","version":"1.0.0"},"servers":[{"url":"https://storefrontapi.buildresonance.com","description":"Resonance Demand Production Admin API"}],"paths":{"/demand-hqs/{demandHqId}/storefronts/{storefrontId}/collection-auto-completes":{"get":{"summary":"List CollectionAutoCompletes","description":"List suggested searches based on a prefix for Collection search","tags":["CollectionAutoComplete"],"parameters":[{"in":"path","name":"demandHqId","summary":"The demandHqId to search Collections for","schema":{"type":"string"},"required":true},{"in":"path","name":"storefrontId","summary":"The storefrontId to search Collections for","schema":{"type":"string"},"required":true},{"in":"query","name":"query","summary":"The prefix to search for","schema":{"type":"string"},"required":true},{"in":"query","name":"first","summary":"first does not actually indicate number of results, but rather how many results the search DB will return, that will then get permutation treatment. Actual result amount will be random.","schema":{"type":"number","default":10},"required":false}],"responses":{"200":{"description":"Collection Auto-Completes","content":{"application/json":{"schema":{"type":"object","properties":{"collectionAutoCompletes":{"type":"array","items":{"type":"string","description":"Collection Auto-Completes. For a result of \"Old House on the Prairie\", it would return: \"Old\", \"Old House\", \"Old House on\", \"Old House on the\", \"Old House on the Prairie\" + \"House\", \"House on\", \"House on the\", \"House on the Prairie\" + \"on\", \"on the\", \"on the Prairie\" + \"the\", \"the Prairie\" + \"Prairie\""}}},"required":["collectionAutoCompletes"]},"example":{"collectionAutoCompletes":["test","test this","test this route"]}}}},"400":{"description":"Bad Request (Invalid Query Parameters)","content":{"text/plain":{"schema":{"type":"string"}}}}}}},"/demand-hqs/{demandHqId}/storefronts/{storefrontId}/collection-or-product-auto-completes":{"get":{"summary":"List Collection or Product AutoCompletes","description":"List suggested searches based on a prefix for Collection and Product search simultaneously","tags":["CollectionOrProductAutoComplete"],"parameters":[{"in":"path","name":"demandHqId","summary":"The demandHqId to search Collections for","schema":{"type":"string"},"required":true},{"in":"path","name":"storefrontId","summary":"The storefrontId to search Collections for","schema":{"type":"string"},"required":true},{"in":"query","name":"query","summary":"The prefix to search for","schema":{"type":"string"},"required":true},{"in":"query","name":"first","summary":"first does not actually indicate number of results, but rather how many results the search DB will return, that will then get permutation treatment. Actual result amount will be random.","schema":{"type":"number","default":10},"required":false}],"responses":{"200":{"description":"Collection or Product Auto-Completes","content":{"application/json":{"schema":{"type":"object","properties":{"collectionAutoCompletes":{"type":"array","items":{"type":"string","description":"Collection Auto-Completes. For a result of \"Old House on the Prairie\", it would return: \"Old\", \"Old House\", \"Old House on\", \"Old House on the\", \"Old House on the Prairie\" + \"House\", \"House on\", \"House on the\", \"House on the Prairie\" + \"on\", \"on the\", \"on the Prairie\" + \"the\", \"the Prairie\" + \"Prairie\""}},"productAutoCompletes":{"type":"array","items":{"type":"string","description":"Product Auto-Completes. For a result of \"Old House on the Prairie\", it would return: \"Old\", \"Old House\", \"Old House on\", \"Old House on the\", \"Old House on the Prairie\" + \"House\", \"House on\", \"House on the\", \"House on the Prairie\" + \"on\", \"on the\", \"on the Prairie\" + \"the\", \"the Prairie\" + \"Prairie\""}}},"required":["collectionAutoCompletes","productAutoCompletes"]},"example":{"collectionAutoCompletes":["test","test this","test this route"],"productAutoCompletes":["test","test this","test this product"]}}}},"400":{"description":"Bad Request (Invalid Query Parameters)","content":{"text/plain":{"schema":{"type":"string"}}}}}}},"/demand-hqs/{demandHqId}/storefronts/{storefrontId}/page-auto-completes":{"get":{"summary":"List PageAutoCompletes","description":"List suggested searches based on a prefix for Page search","tags":["PageAutoComplete"],"parameters":[{"in":"path","name":"demandHqId","summary":"The demandHqId to search Pages for","schema":{"type":"string"},"required":true},{"in":"path","name":"storefrontId","summary":"The storefrontId to search Collections for","schema":{"type":"string"},"required":true},{"in":"query","name":"query","summary":"The prefix to search for","schema":{"type":"string"},"required":true},{"in":"query","name":"first","summary":"first does not actually indicate number of results, but rather how many results the search DB will return, that will then get permutation treatment. Actual result amount will be random.","schema":{"type":"number","default":10},"required":false}],"responses":{"200":{"description":"Page Auto-Completes","content":{"application/json":{"schema":{"type":"object","properties":{"pageAutoCompletes":{"type":"array","items":{"type":"string","description":"Page Auto-Completes. For a result of \"Old House on the Prairie\", it would return: \"Old\", \"Old House\", \"Old House on\", \"Old House on the\", \"Old House on the Prairie\" + \"House\", \"House on\", \"House on the\", \"House on the Prairie\" + \"on\", \"on the\", \"on the Prairie\" + \"the\", \"the Prairie\" + \"Prairie\""}}},"required":["pageAutoCompletes"]},"example":{"pageAutoCompletes":["test","test this","test this route"]}}}},"400":{"description":"Bad Request (Invalid Query Parameters)","content":{"text/plain":{"schema":{"type":"string"}}}}}}},"/demand-hqs/{demandHqId}/storefronts/{storefrontId}/product-auto-completes":{"get":{"summary":"List ProductAutoCompletes","description":"List suggested searches based on a prefix for Product search","tags":["ProductAutoComplete"],"parameters":[{"in":"path","name":"demandHqId","summary":"The demandHqId to search Products for","schema":{"type":"string"},"required":true},{"in":"path","name":"storefrontId","summary":"The storefrontId to search Collections for","schema":{"type":"string"},"required":true},{"in":"query","name":"query","summary":"The prefix to search for","schema":{"type":"string"},"required":true},{"in":"query","name":"first","summary":"first does not actually indicate number of results, but rather how many results the search DB will return, that will then get permutation treatment. Actual result amount will be random.","schema":{"type":"number","default":10},"required":false}],"responses":{"200":{"description":"Product Auto-Completes","content":{"application/json":{"schema":{"type":"object","properties":{"productAutoCompletes":{"type":"array","items":{"type":"string","description":"Product Auto-Completes. For a result of \"Old House on the Prairie\", it would return: \"Old\", \"Old House\", \"Old House on\", \"Old House on the\", \"Old House on the Prairie\" + \"House\", \"House on\", \"House on the\", \"House on the Prairie\" + \"on\", \"on the\", \"on the Prairie\" + \"the\", \"the Prairie\" + \"Prairie\""}}},"required":["productAutoCompletes"]},"example":{"productAutoCompletes":["test","test this","test this route"]}}}},"400":{"description":"Bad Request (Invalid Query Parameters)","content":{"text/plain":{"schema":{"type":"string"}}}}}}}}}