{"openapi":"3.0.0","info":{"title":"7Boss Common API","description":"7Boss Common API","version":"1.0.0"},"components":{},"servers":[{"url":"http://localhost/"},{"url":"https://localhost/"}],"paths":{"/api/v1/common/stores/{storesId}/psa":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"description":"Successful response","type":"object","properties":{"response":{"type":"object","properties":{"code":{"type":"integer"},"id":{"type":"string"},"timestamp":{"type":"string"},"function":{"type":"object","properties":{"method":{"type":"string"},"url":{"type":"string"},"ip":{"type":"string"},"apiVersion":{"type":"string"}}}}},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"psa":{"type":"string"}}}}}}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"description":"BAD REQUEST","type":"object","properties":{"response":{"type":"object","properties":{"code":{"type":"integer"},"id":{"type":"string"},"timestamp":{"type":"string"},"function":{"type":"object","properties":{"method":{"type":"string"},"url":{"type":"string"},"ip":{"type":"string"},"apiVersion":{"type":"string"}}},"messages":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}},"warnings":{"type":"array","items":{"type":"string"}},"info":{"type":"array","items":{"type":"string"}}}}}}}}}},"description":"BAD REQUEST"},"402":{"content":{"application/json":{"schema":{"description":"UNAUTHORIZED","type":"object","properties":{"response":{"type":"object","properties":{"code":{"type":"integer"},"id":{"type":"string"},"timestamp":{"type":"string"},"function":{"type":"object","properties":{"method":{"type":"string"},"url":{"type":"string"},"ip":{"type":"string"},"apiVersion":{"type":"string"}}},"messages":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}},"warnings":{"type":"array","items":{"type":"string"}},"info":{"type":"array","items":{"type":"string"}}}}}}}}}},"description":"UNAUTHORIZED"},"403":{"content":{"application/json":{"schema":{"description":"FORBIDDEN","type":"object","properties":{"response":{"type":"object","properties":{"code":{"type":"integer"},"id":{"type":"string"},"timestamp":{"type":"string"},"function":{"type":"object","properties":{"method":{"type":"string"},"url":{"type":"string"},"ip":{"type":"string"},"apiVersion":{"type":"string"}}},"messages":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}},"warnings":{"type":"array","items":{"type":"string"}},"info":{"type":"array","items":{"type":"string"}}}}}}}}}},"description":"FORBIDDEN"},"500":{"content":{"application/json":{"schema":{"description":"INTERNAL SERVER ERROR","type":"object","properties":{"response":{"type":"object","properties":{"code":{"type":"integer"},"id":{"type":"string"},"timestamp":{"type":"string"},"function":{"type":"object","properties":{"method":{"type":"string"},"url":{"type":"string"},"ip":{"type":"string"},"apiVersion":{"type":"string"}}},"messages":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}},"warnings":{"type":"array","items":{"type":"string"}},"info":{"type":"array","items":{"type":"string"}}}}}}}}}},"description":"INTERNAL SERVER ERROR"}},"summary":"PSA Lookup","description":"post some data","tags":["PSA"],"security":[{"customauthorizer":[]}],"requestBody":{"content":{"application/json":{"schema":{}}}},"parameters":[{"name":"storeId","in":"path","required":true,"description":"store id","schema":{"type":"string","description":"store id"}}]}},"/api/v1/common/psa":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"description":"Successful response","type":"object","properties":{"response":{"type":"object","properties":{"code":{"type":"integer"},"id":{"type":"string"},"timestamp":{"type":"string"},"function":{"type":"object","properties":{"method":{"type":"string"},"url":{"type":"string"},"ip":{"type":"string"},"apiVersion":{"type":"string"}}}}},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"psa":{"type":"string"}}}}}}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"description":"BAD REQUEST","type":"object","properties":{"response":{"type":"object","properties":{"code":{"type":"integer"},"id":{"type":"string"},"timestamp":{"type":"string"},"function":{"type":"object","properties":{"method":{"type":"string"},"url":{"type":"string"},"ip":{"type":"string"},"apiVersion":{"type":"string"}}},"messages":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}},"warnings":{"type":"array","items":{"type":"string"}},"info":{"type":"array","items":{"type":"string"}}}}}}}}}},"description":"BAD REQUEST"},"402":{"content":{"application/json":{"schema":{"description":"UNAUTHORIZED","type":"object","properties":{"response":{"type":"object","properties":{"code":{"type":"integer"},"id":{"type":"string"},"timestamp":{"type":"string"},"function":{"type":"object","properties":{"method":{"type":"string"},"url":{"type":"string"},"ip":{"type":"string"},"apiVersion":{"type":"string"}}},"messages":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}},"warnings":{"type":"array","items":{"type":"string"}},"info":{"type":"array","items":{"type":"string"}}}}}}}}}},"description":"UNAUTHORIZED"},"403":{"content":{"application/json":{"schema":{"description":"FORBIDDEN","type":"object","properties":{"response":{"type":"object","properties":{"code":{"type":"integer"},"id":{"type":"string"},"timestamp":{"type":"string"},"function":{"type":"object","properties":{"method":{"type":"string"},"url":{"type":"string"},"ip":{"type":"string"},"apiVersion":{"type":"string"}}},"messages":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}},"warnings":{"type":"array","items":{"type":"string"}},"info":{"type":"array","items":{"type":"string"}}}}}}}}}},"description":"FORBIDDEN"},"500":{"content":{"application/json":{"schema":{"description":"INTERNAL SERVER ERROR","type":"object","properties":{"response":{"type":"object","properties":{"code":{"type":"integer"},"id":{"type":"string"},"timestamp":{"type":"string"},"function":{"type":"object","properties":{"method":{"type":"string"},"url":{"type":"string"},"ip":{"type":"string"},"apiVersion":{"type":"string"}}},"messages":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}},"warnings":{"type":"array","items":{"type":"string"}},"info":{"type":"array","items":{"type":"string"}}}}}}}}}},"description":"INTERNAL SERVER ERROR"}},"summary":"PSA Lookup","description":"post some data","tags":["PSA"],"security":[{"customauthorizer":[]}],"requestBody":{"content":{"application/json":{"schema":{}}}},"parameters":[{"name":"storeId","in":"path","required":true,"description":"store id","schema":{"type":"string","description":"store id"}}]}},"/api/v1/common/stores/{storeId}/psa/{psa}/categories":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"description":"Successful response","type":"object","properties":{"response":{"type":"object","properties":{"code":{"type":"integer"},"id":{"type":"string"},"timestamp":{"type":"string"},"function":{"type":"object","properties":{"method":{"type":"string"},"url":{"type":"string"},"ip":{"type":"string"},"apiVersion":{"type":"string"}}}}},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"category":{"type":"string"}}}}}}}},"description":"Successful response"}},"summary":"PSA -> Categories","description":"post some data","tags":["PSA"],"security":[{"apiKey":[]}],"requestBody":{"content":{"application/json":{"schema":{}}}},"parameters":[{"name":"storeId","in":"path","required":true,"description":"store id","schema":{"type":"string","description":"store id"}},{"name":"psa","in":"path","required":true,"description":"psa code","schema":{"type":"number","description":"psa code"}}]}},"/api/v1/common/stores/{storeId}/psa/{psa}":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"description":"Successful response","type":"object","properties":{"response":{"type":"object","properties":{"code":{"type":"integer"},"id":{"type":"string"},"timestamp":{"type":"string"},"function":{"type":"object","properties":{"method":{"type":"string"},"url":{"type":"string"},"ip":{"type":"string"},"apiVersion":{"type":"string"}}}}},"data":{"type":"array","items":{"type":"object","properties":{"storeId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"accountingGroupId":{"type":"number"},"accountingGroupType":{"type":"string"},"voucherId":{"type":"string"},"ageRestriction":{"type":"string"},"highAmountLockout":{"type":"number"},"lowAmountLockout":{"type":"number"},"negativeSalesFlag":{"type":"string"},"discountAllowed":{"type":"string"},"foodStampAllowed":{"type":"string"},"manufacturerCouponAllowed":{"type":"string"},"storeCouponAllowed":{"type":"string"},"otherCouponAllowed":{"type":"string"},"taxId":{"type":"array","items":{"type":"number"}},"updatedTimeStamp":{"type":"string"},"updatedBy":{"type":"string"},"id":{"type":"number"},"manualIdEntryDisabled":{"type":"string"},"psaGroup":{"type":"object","properties":{"psaCode":{"type":"string"},"psaDescription":{"type":"string"},"catCode":{"type":"string"},"catDescription":{"type":"string"},"isDefaultWriteoffCat":{"type":"boolean"},"subcatCode":{"type":"string"},"subcatDescription":{"type":"string"},"orderGroupCode":{"type":"string"},"isActive":{"type":"boolean"},"isDefaultCycle":{"type":"string"},"isGuidedReplenishment":{"type":"boolean"},"isAvailableForGrill":{"type":"boolean"},"isShelfTagPrintAllowed":{"type":"boolean"}}}}}}}}}},"description":"Successful response"}},"summary":"PSA -> Items","description":"post some data","tags":["PSA"],"security":[{"apiKey":[]}],"requestBody":{"content":{"application/json":{"schema":{}}}},"parameters":[{"name":"storeId","in":"path","required":true,"description":"store id","schema":{"type":"string","description":"store id"}},{"name":"itemId","in":"path","required":true,"description":"item id","schema":{"type":"number","description":"item id"}}]}},"/api/v1/common/stores/{storeId}/item/{itemId}/psa":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"description":"Successful response","type":"object","properties":{"response":{"type":"object","properties":{"code":{"type":"integer"},"id":{"type":"string"},"timestamp":{"type":"string"},"function":{"type":"object","properties":{"method":{"type":"string"},"url":{"type":"string"},"ip":{"type":"string"},"apiVersion":{"type":"string"}}}}},"data":{"type":"array","items":{"type":"object","properties":{"storeId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"accountingGroupId":{"type":"number"},"accountingGroupType":{"type":"string"},"voucherId":{"type":"string"},"ageRestriction":{"type":"string"},"highAmountLockout":{"type":"number"},"lowAmountLockout":{"type":"number"},"negativeSalesFlag":{"type":"string"},"discountAllowed":{"type":"string"},"foodStampAllowed":{"type":"string"},"manufacturerCouponAllowed":{"type":"string"},"storeCouponAllowed":{"type":"string"},"otherCouponAllowed":{"type":"string"},"taxId":{"type":"array","items":{"type":"number"}},"updatedTimeStamp":{"type":"string"},"updatedBy":{"type":"string"},"id":{"type":"number"},"manualIdEntryDisabled":{"type":"string"},"psaGroup":{"type":"object","properties":{"psaCode":{"type":"string"},"psaDescription":{"type":"string"},"catCode":{"type":"string"},"catDescription":{"type":"string"},"isDefaultWriteoffCat":{"type":"boolean"},"subcatCode":{"type":"string"},"subcatDescription":{"type":"string"},"orderGroupCode":{"type":"string"},"isActive":{"type":"boolean"},"isDefaultCycle":{"type":"string"},"isGuidedReplenishment":{"type":"boolean"},"isAvailableForGrill":{"type":"boolean"},"isShelfTagPrintAllowed":{"type":"boolean"}}}}}}}}}},"description":"Successful response"}},"summary":"PSA -> Items","description":"post some data","tags":["PSA"],"security":[{"apiKey":[]}],"requestBody":{"content":{"application/json":{"schema":{}}}},"parameters":[{"name":"storeId","in":"path","required":true,"description":"store id","schema":{"type":"string","description":"store id"}},{"name":"itemId","in":"path","required":true,"description":"item id","schema":{"type":"number","description":"item id"}}]}},"/api/v1/common/stores/{storeId}/search/items":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"description":"Successful response","type":"object","properties":{"response":{"type":"object","properties":{"code":{"type":"integer"},"id":{"type":"string"},"timestamp":{"type":"string"},"function":{"type":"object","properties":{"method":{"type":"string"},"url":{"type":"string"},"ip":{"type":"string"},"apiVersion":{"type":"string"}}}}},"data":{"type":"array","items":{"type":"string"}}}}}},"description":"Successful response"}},"summary":"Search -> Items","description":"post some data","tags":["Items"],"security":[{"apiKey":[]}],"requestBody":{"content":{"application/json":{"schema":{}}}},"parameters":[{"name":"q","in":"query","required":true,"description":"query","schema":{"type":"string","description":"query"}},{"name":"storeId","in":"path","required":true,"description":"store id","schema":{"type":"string","description":"store id"}}]}},"/api/v1/common/stores/{storeId}/search/items/list":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"description":"Successful response","type":"object","properties":{"response":{"type":"object","properties":{"code":{"type":"integer"},"id":{"type":"string"},"timestamp":{"type":"string"},"function":{"type":"object","properties":{"method":{"type":"string"},"url":{"type":"string"},"ip":{"type":"string"},"apiVersion":{"type":"string"}}}}},"data":{"type":"array","items":{"type":"object","properties":{"itemId":{"type":"integer"},"itemName":{"type":"string"},"itemShirtName":{"type":"integer"},"itemUPC":{"type":"array","items":{"type":"object","properties":{"UPC":{"type":"integer"},"isDefaultUPC":{"type":"boolean"}}}},"class":{"type":"string"}}}}}}}},"description":"Successful response"}},"summary":"Search -> Items -> List","description":"post some data","tags":["Items"],"security":[{"apiKey":[]}],"requestBody":{"content":{"application/json":{"schema":{}}}},"parameters":[{"name":"q","in":"query","required":true,"description":"query","schema":{"type":"string","description":"query"}},{"name":"storeId","in":"path","required":true,"description":"store id","schema":{"type":"string","description":"store id"}}]}},"/api/v1/common/scheduler/items":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"description":"Successful response","type":"object","properties":{"response":{"type":"object","properties":{"code":{"type":"integer"},"id":{"type":"string"},"timestamp":{"type":"string"},"function":{"type":"object","properties":{"method":{"type":"string"},"url":{"type":"string"},"ip":{"type":"string"},"apiVersion":{"type":"string"}}}}},"data":{"type":"string"}}}}},"description":"Successful response"}},"summary":"Scheduler -> Items","description":"scheduler for items redis builder","tags":["Scheduler"],"security":[{"apiKey":[]}],"requestBody":{"content":{"application/json":{"schema":{}}}}}}}}