Created
September 28, 2018 01:54
-
-
Save danganf/01398dfc5abf8f0cac929a8740df3060 to your computer and use it in GitHub Desktop.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| <?php | |
| /** | |
| * | |
| * @SWG\Swagger( | |
| * @SWG\Info( | |
| * title="APIs Magali-PDV", | |
| * version="Beta", | |
| * @SWG\Contact( | |
| * email="[email protected]" | |
| * ) | |
| * ) | |
| * ) | |
| * | |
| * @SWG\Get( | |
| * path="grand-chef/categories", | |
| * summary="Get categories avaible", | |
| * operationId="GF-categories-avaible", | |
| * tags={"Grand-Chef / PDV"}, | |
| * @SWG\Parameter(in="header",name="X-DreamFactory-API-Key",description="Authorization Proxy",type="string",required=true,default="2a1bf8a3e63fbb8d1f84e53fb159145e61a23edc13dcd977590fe57a681f12d1"), | |
| * @SWG\Parameter(in="header",name="x-pdv-token",description="PDV Session Token",type="string",required=true,default=""), | |
| * @SWG\Response(response=200, description="successful operation") | |
| * ) | |
| * | |
| * @SWG\Get( | |
| * path="grand-chef/products/{category_id}", | |
| * summary="Get products avaible", | |
| * operationId="GF-products-avaible", | |
| * tags={"Grand-Chef / PDV"}, | |
| * @SWG\Parameter(in="header",name="X-DreamFactory-API-Key",description="Authorization Proxy",type="string",required=true,default="2a1bf8a3e63fbb8d1f84e53fb159145e61a23edc13dcd977590fe57a681f12d1"), | |
| * @SWG\Parameter(in="header",name="x-pdv-token",description="PDV Session Token",type="string",required=true,default=""), | |
| * @SWG\Parameter(in="path", name="category_id", description="category id", type="integer", required=false, default=""), | |
| * @SWG\Response(response=200, description="successful operation") | |
| * ) | |
| * | |
| * @SWG\Get( | |
| * path="grand-chef/payment-methods", | |
| * summary="Get payment methods avaible", | |
| * operationId="GF-paymethod-avaible", | |
| * tags={"Grand-Chef / PDV"}, | |
| * @SWG\Parameter(in="header",name="X-DreamFactory-API-Key",description="Authorization Proxy",type="string",required=true,default="2a1bf8a3e63fbb8d1f84e53fb159145e61a23edc13dcd977590fe57a681f12d1"), | |
| * @SWG\Parameter(in="header",name="x-pdv-token",description="PDV Session Token",type="string",required=true,default=""), | |
| * @SWG\Response(response=200, description="successful operation") | |
| * ) | |
| * | |
| * @SWG\Get( | |
| * path="grand-chef/credit-cards", | |
| * summary="Get credit-cards avaible", | |
| * operationId="GF-creditcards-avaible", | |
| * tags={"Grand-Chef / PDV"}, | |
| * @SWG\Parameter(in="header",name="X-DreamFactory-API-Key",description="Authorization Proxy",type="string",required=true,default="2a1bf8a3e63fbb8d1f84e53fb159145e61a23edc13dcd977590fe57a681f12d1"), | |
| * @SWG\Parameter(in="header",name="x-pdv-token",description="PDV Session Token",type="string",required=true,default=""), | |
| * @SWG\Response(response=200, description="successful operation") | |
| * ) | |
| * | |
| * @SWG\Get( | |
| * path="order/flow/status/{sale_code}", | |
| * summary="Get list next status flow", | |
| * operationId="pdv-orderflow-status", | |
| * tags={"Order"}, | |
| * @SWG\Parameter(in="header",name="X-DreamFactory-API-Key",description="Authorization Proxy",type="string",required=true,default="2a1bf8a3e63fbb8d1f84e53fb159145e61a23edc13dcd977590fe57a681f12d1"), | |
| * @SWG\Parameter(in="header",name="x-pdv-token",description="PDV Session Token",type="string",required=true,default=""), | |
| * @SWG\Parameter(in="path", name="sale_code", description="sale code", type="string", required=true ), | |
| * @SWG\Response(response=200, description="successful operation") | |
| * ) | |
| * | |
| * @SWG\Put( | |
| * path="order/flow/approved/{sale_code}", | |
| * summary="Approved order - next status flow", | |
| * operationId="pdv-orderflow-apŕoved", | |
| * tags={"Order"}, | |
| * @SWG\Parameter(in="header",name="X-DreamFactory-API-Key",description="Authorization Proxy",type="string",required=true,default="2a1bf8a3e63fbb8d1f84e53fb159145e61a23edc13dcd977590fe57a681f12d1"), | |
| * @SWG\Parameter(in="header",name="x-pdv-token",description="PDV Session Token",type="string",required=true,default=""), | |
| * @SWG\Parameter(in="path", name="sale_code", description="sale code", type="string", required=true ), | |
| * @SWG\Response(response=200, description="successful operation") | |
| * ) | |
| * | |
| * @SWG\Put( | |
| * path="order/flow/status/{sale_code}/{state}/{status}", | |
| * summary="Update status order", | |
| * operationId="pdv-orderflow-udptstatus", | |
| * tags={"Order"}, | |
| * @SWG\Parameter(in="header",name="X-DreamFactory-API-Key",description="Authorization Proxy",type="string",required=true,default="2a1bf8a3e63fbb8d1f84e53fb159145e61a23edc13dcd977590fe57a681f12d1"), | |
| * @SWG\Parameter(in="header",name="x-pdv-token",description="PDV Session Token",type="string",required=true,default=""), | |
| * @SWG\Parameter(in="path", name="sale_code", description="sale code", type="string", required=true ), | |
| * @SWG\Parameter(in="path", name="state", description="new state", type="string", required=true ), | |
| * @SWG\Parameter(in="path", name="status", description="new status", type="string", required=true ), | |
| * @SWG\Response(response=200, description="successful operation") | |
| * ) | |
| * | |
| * @SWG\Post( | |
| * path="order", | |
| * summary="Created store order", | |
| * operationId="pdv-orderCreate", | |
| * tags={"Order"}, | |
| * @SWG\Parameter(in="header",name="X-DreamFactory-API-Key",description="Authorization Proxy",type="string",required=true,default="2a1bf8a3e63fbb8d1f84e53fb159145e61a23edc13dcd977590fe57a681f12d1"), | |
| * @SWG\Parameter(in="header",name="x-pdv-token",description="PDV Session Token",type="string",required=true,default=""), | |
| * @SWG\Parameter(in="body",name="body",description=" | |
| * Não envie a tag 'delivery_method' para pedido sem entrega | |
| * Não envie a tag 'client_id' para pedido sem delivery_method, | |
| * Não envie a tag 'travel', ou envie com valor FALSE, para pedido que não necessite embalagem de viagem, | |
| * Só envie a tag 'item[X].composition_remove' caso o pedido tenha itens de sua composição retirados, | |
| * Só envie a tag 'item[X].additional' caso o pedido itens adicional incluido", | |
| * required=true,default="", | |
| * @SWG\Schema(type="string", | |
| * @SWG\Property(property="client_id", type="integer", example=1), | |
| * @SWG\Property(property="total_purchase_value", type="float", example=65.6), | |
| * @SWG\Property(property="travel", type="boolean", example=false), | |
| * @SWG\Property(property="paymemt_method", type="array", | |
| * @SWG\Items(type="object", | |
| * @SWG\Property(property="code",type="string", example="db_mc_loja"), | |
| * @SWG\Property(property="value",type="float", example=65.6) | |
| * ) | |
| * ), | |
| * @SWG\Property(property="delivery_method", type="object", | |
| * @SWG\Property(property="code" ,type="string", example="local_barra_square"), | |
| * @SWG\Property(property="attributes", type="array", | |
| * @SWG\Items(type="object", | |
| * @SWG\Property(property="label" ,type="string", example="Bloco"), | |
| * @SWG\Property(property="value",type="string", example="3") | |
| * ) | |
| * ) | |
| * ), | |
| * @SWG\Property(property="items", type="array", | |
| * @SWG\Items(type="object", | |
| * @SWG\Property(property="id" ,type="integer", example=2), | |
| * @SWG\Property(property="qty",type="integer", example=1), | |
| * @SWG\Property(property="final_price",type="float", example=18.9), | |
| * @SWG\Property(property="note",type="string", example="null"), | |
| * @SWG\Property(property="composition_remove", type="array", | |
| * @SWG\Items(type="object", | |
| * @SWG\Property(property="id" ,type="integer", example=18), | |
| * ) | |
| * ), | |
| * @SWG\Property(property="additional", type="array", | |
| * @SWG\Items(type="object", | |
| * @SWG\Property(property="id" ,type="integer", example=32), | |
| * ) | |
| * ) | |
| * ) | |
| * ), | |
| * @SWG\Property(property="note", type="string", example="null") | |
| * )), | |
| * @SWG\Response(response=201, description="successful operation. User created and rescued"), | |
| * ) | |
| * | |
| * @SWG\Put( | |
| * path="order", | |
| * summary="Update store order - Para pedidos feito pelo APP", | |
| * operationId="pdv-orderUpdate", | |
| * tags={"Order"}, | |
| * @SWG\Parameter(in="header",name="X-DreamFactory-API-Key",description="Authorization Proxy",type="string",required=true,default="2a1bf8a3e63fbb8d1f84e53fb159145e61a23edc13dcd977590fe57a681f12d1"), | |
| * @SWG\Parameter(in="header",name="x-pdv-token",description="PDV Session Token",type="string",required=true,default=""), | |
| * @SWG\Parameter(in="body",name="body",description=" | |
| * Não envie a tag 'delivery_method' para pedido sem entrega | |
| * Não envie a tag 'paymemt_method' para peddido com entrega, | |
| * Não envie a tag 'travel', ou envie com valor FALSE, para pedido que não necessite embalagem de viagem, | |
| * Só envie a tag 'item[X].composition_remove' caso o pedido tenha itens de sua composição retirados, | |
| * Só envie a tag 'item[X].additional' caso o pedido itens adicional incluido", | |
| * required=true,default="", | |
| * @SWG\Schema(type="string", | |
| * @SWG\Property(property="user",title="UserSummary", | |
| * @SWG\Property(property="uid",type="string", example="75ea47ab-ace5-59da-b1a1-fdd21b2d66a0"), | |
| * @SWG\Property(property="name",type="string", example="null"), | |
| * @SWG\Property(property="mobile_number",type="string", example="21981692318") | |
| * ), | |
| * @SWG\Property(property="sale_code", type="string", example="18000225"), | |
| * @SWG\Property(property="total_purchase_value", type="float", example=65.6), | |
| * @SWG\Property(property="travel", type="boolean", example=false), | |
| * @SWG\Property(property="paymemt_method", type="array", | |
| * @SWG\Items(type="object", | |
| * @SWG\Property(property="code",type="string", example="db_mc_loja"), | |
| * @SWG\Property(property="value",type="float", example=65.6) | |
| * ) | |
| * ), | |
| * @SWG\Property(property="delivery_method", type="object", | |
| * @SWG\Property(property="code" ,type="string", example="local_barra_square"), | |
| * @SWG\Property(property="attributes", type="array", | |
| * @SWG\Items(type="object", | |
| * @SWG\Property(property="label" ,type="string", example="Bloco"), | |
| * @SWG\Property(property="value",type="string", example="3") | |
| * ) | |
| * ) | |
| * ), | |
| * @SWG\Property(property="items", type="array", | |
| * @SWG\Items(type="object", | |
| * @SWG\Property(property="id" ,type="integer", example=2), | |
| * @SWG\Property(property="qty",type="integer", example=1), | |
| * @SWG\Property(property="final_price",type="float", example=18.9), | |
| * @SWG\Property(property="note",type="string", example="null"), | |
| * @SWG\Property(property="composition_remove", type="array", | |
| * @SWG\Items(type="object", | |
| * @SWG\Property(property="id" ,type="integer", example=18), | |
| * ) | |
| * ), | |
| * @SWG\Property(property="additional", type="array", | |
| * @SWG\Items(type="object", | |
| * @SWG\Property(property="id" ,type="integer", example=32), | |
| * ) | |
| * ) | |
| * ) | |
| * ), | |
| * @SWG\Property(property="note", type="string", example="null") | |
| * )), | |
| * @SWG\Response(response=201, description="successful operation. User created and rescued"), | |
| * ) | |
| * | |
| * @SWG\Get( | |
| * path="order/qr-code/{qr_code}", | |
| * summary="Get order by string qr_code", | |
| * operationId="pdv-order-qrcode", | |
| * tags={"Order"}, | |
| * @SWG\Parameter(in="header",name="X-DreamFactory-API-Key",description="Authorization Proxy",type="string",required=true,default="2a1bf8a3e63fbb8d1f84e53fb159145e61a23edc13dcd977590fe57a681f12d1"), | |
| * @SWG\Parameter(in="header",name="x-pdv-token",description="PDV Session Token",type="string",required=true,default=""), | |
| * @SWG\Parameter(in="path", name="qr_code", description="qr code string", type="string", required=true ), | |
| * @SWG\Response(response=200, description="successful operation") | |
| * ) | |
| * | |
| * @SWG\Get( | |
| * path="order/in-delivery", | |
| * summary="Get order in delivery", | |
| * operationId="pdv-order-in-delivery", | |
| * tags={"Order"}, | |
| * @SWG\Parameter(in="header",name="X-DreamFactory-API-Key",description="Authorization Proxy",type="string",required=true,default="2a1bf8a3e63fbb8d1f84e53fb159145e61a23edc13dcd977590fe57a681f12d1"), | |
| * @SWG\Parameter(in="header",name="x-pdv-token",description="PDV Session Token",type="string",required=true,default=""), | |
| * @SWG\Response(response=200, description="successful operation") | |
| * ) | |
| * | |
| * @SWG\Get( | |
| * path="order/waiting-confirmation", | |
| * summary="Get order waiting confirmation", | |
| * operationId="pdv-order-waiting-confirmation", | |
| * tags={"Order"}, | |
| * @SWG\Parameter(in="header",name="X-DreamFactory-API-Key",description="Authorization Proxy",type="string",required=true,default="2a1bf8a3e63fbb8d1f84e53fb159145e61a23edc13dcd977590fe57a681f12d1"), | |
| * @SWG\Parameter(in="header",name="x-pdv-token",description="PDV Session Token",type="string",required=true,default=""), | |
| * @SWG\Response(response=200, description="successful operation") | |
| * ) | |
| * | |
| * @SWG\Put( | |
| * path="order/pay-done/{sale_code}", | |
| * summary="Register order payment", | |
| * operationId="pdv-order-paydone", | |
| * tags={"Order"}, | |
| * @SWG\Parameter(in="header",name="X-DreamFactory-API-Key",description="Authorization Proxy",type="string",required=true,default="2a1bf8a3e63fbb8d1f84e53fb159145e61a23edc13dcd977590fe57a681f12d1"), | |
| * @SWG\Parameter(in="header",name="X-Store-Uid",description="API-key Store",type="string",required=true,default="494bfc1a-2963-5d9b-bfe2-40a190eea020",default="494bfc1a-2963-5d9b-bfe2-40a190eea020"), | |
| * @SWG\Parameter(in="path", name="sale_code", description="sale code", type="string", required=true ), | |
| * @SWG\Response(response=200, description="successful operation") | |
| * ) | |
| * | |
| * @SWG\Get( | |
| * path="product/{category_id}/{search_filter}", | |
| * summary="Filter product by (code or name)", | |
| * operationId="Pdv-product-filter", | |
| * tags={"Product"}, | |
| * @SWG\Parameter(in="header",name="X-DreamFactory-API-Key",description="Authorization Proxy",type="string",required=true,default="2a1bf8a3e63fbb8d1f84e53fb159145e61a23edc13dcd977590fe57a681f12d1"), | |
| * @SWG\Parameter(in="header",name="x-pdv-token",description="PDV Session Token",type="string",required=true,default=""), | |
| * @SWG\Parameter(in="path", name="category_id", description="category id search", type="string", required=true ), | |
| * @SWG\Parameter(in="path", name="search_filter", description="filter search", type="string", required=false ), | |
| * @SWG\Response(response=200, description="successful operation") | |
| * ) | |
| * | |
| * @SWG\Get( | |
| * path="product/", | |
| * summary="List all product", | |
| * operationId="Pdv-product-filterDash", | |
| * tags={"Product"}, | |
| * @SWG\Parameter(in="header",name="X-DreamFactory-API-Key",description="Authorization Proxy",type="string",required=true,default="2a1bf8a3e63fbb8d1f84e53fb159145e61a23edc13dcd977590fe57a681f12d1"), | |
| * @SWG\Parameter(in="header",name="x-pdv-token",description="PDV Session Token",type="string",required=true,default=""), | |
| * @SWG\Parameter(in="query",name="code",description="Filter by Code",type="string",default=""), | |
| * @SWG\Parameter(in="query",name="type",description="Filter by Type",type="string",default=""), | |
| * @SWG\Parameter(in="query",name="name",description="Filter by Name",type="string",default=""), | |
| * @SWG\Parameter(in="query",name="limit",description="Limit pagination",required=true,type="integer",default="25"), | |
| * @SWG\Response(response=200, description="successful operation") | |
| * ) | |
| * | |
| * @SWG\Get( | |
| * path="category/avaible", | |
| * summary="get store category avaible", | |
| * operationId="Pdv-category-avaible", | |
| * tags={"Category"}, | |
| * @SWG\Parameter(in="header",name="X-DreamFactory-API-Key",description="Authorization Proxy",type="string",required=true,default="2a1bf8a3e63fbb8d1f84e53fb159145e61a23edc13dcd977590fe57a681f12d1"), | |
| * @SWG\Parameter(in="header",name="x-pdv-token",description="PDV Session Token",type="string",required=true,default=""), | |
| * @SWG\Response(response=200, description="successful operation.") | |
| * ) | |
| * | |
| * @SWG\Get( | |
| * path="category/{id}", | |
| * summary="List Category by filter", | |
| * operationId="Pdv-category-get", | |
| * tags={"Category"}, | |
| * @SWG\Parameter(in="header",name="X-DreamFactory-API-Key",description="Authorization Proxy",type="string",required=true,default="2a1bf8a3e63fbb8d1f84e53fb159145e61a23edc13dcd977590fe57a681f12d1"), | |
| * @SWG\Parameter(in="header",name="x-pdv-token",description="PDV Session Token",type="string",required=true,default=""), | |
| * @SWG\Parameter(in="path", name="id", description="category id", type="integer", required=false, default=""), | |
| * @SWG\Parameter(in="query",name="name",description="Filter by name",type="string",default=""), | |
| * @SWG\Parameter(in="query",name="limit",description="Limit pagination",required=true,type="integer",default="25"), | |
| * @SWG\Response(response=200, description="successful operation") | |
| * ) | |
| * | |
| * @SWG\Post( | |
| * path="category", | |
| * summary="Created category", | |
| * operationId="pdv-category-create", | |
| * tags={"Category"}, | |
| * @SWG\Parameter(in="header",name="X-DreamFactory-API-Key",description="Authorization Proxy",type="string",required=true,default="2a1bf8a3e63fbb8d1f84e53fb159145e61a23edc13dcd977590fe57a681f12d1"), | |
| * @SWG\Parameter(in="header",name="x-pdv-token",description="PDV Session Token",type="string",required=true,default=""), | |
| * @SWG\Parameter(in="body",name="body",description=" | |
| * 'description' opcional. Envio 'null' caso não exista a informação", | |
| * required=true,default="", | |
| * @SWG\Schema(type="string", | |
| * @SWG\Property(property="name", type="string", example="Salada"), | |
| * @SWG\Property(property="description", type="string", example="Sempre uma opção saudavel"), | |
| * @SWG\Property(property="ordain", type="integer", example=0), | |
| * @SWG\Property(property="status", type="boolean", example=true) | |
| * )), | |
| * @SWG\Response(response=201, description="successful operation. User created and rescued"), | |
| * ) | |
| * | |
| * @SWG\Put( | |
| * path="category/{id}", | |
| * summary="Edit category", | |
| * operationId="pdv-category-edit", | |
| * tags={"Category"}, | |
| * @SWG\Parameter(in="header",name="X-DreamFactory-API-Key",description="Authorization Proxy",type="string",required=true,default="2a1bf8a3e63fbb8d1f84e53fb159145e61a23edc13dcd977590fe57a681f12d1"), | |
| * @SWG\Parameter(in="header",name="x-pdv-token",description="PDV Session Token",type="string",required=true,default=""), | |
| * @SWG\Parameter(in="path", name="id", description="Category id", type="string", required=true ), | |
| * @SWG\Parameter(in="body",name="body",description=" | |
| * 'description' opcional. Envio 'null' caso não exista a informação", | |
| * required=true,default="", | |
| * @SWG\Schema(type="string", | |
| * @SWG\Property(property="name", type="string", example="Salada"), | |
| * @SWG\Property(property="description", type="string", example="Sempre uma opção saudavel"), | |
| * @SWG\Property(property="ordain", type="integer", example=0), | |
| * @SWG\Property(property="status", type="boolean", example=true) | |
| * )), | |
| * @SWG\Response(response=201, description="successful operation. User created and rescued"), | |
| * ) | |
| * | |
| * @SWG\Delete( | |
| * path="category/{id}", | |
| * summary="Delete Category", | |
| * operationId="Pdv-category-del", | |
| * tags={"Category"}, | |
| * @SWG\Parameter(in="header",name="X-DreamFactory-API-Key",description="Authorization Proxy",type="string",required=true,default="2a1bf8a3e63fbb8d1f84e53fb159145e61a23edc13dcd977590fe57a681f12d1"), | |
| * @SWG\Parameter(in="header",name="x-pdv-token",description="PDV Session Token",type="string",required=true,default=""), | |
| * @SWG\Parameter(in="path", name="id", description="Category id", type="string", required=true ), | |
| * @SWG\Response(response=200, description="successful operation") | |
| * ) | |
| * | |
| * | |
| */ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment