{"info":{"contact":{"email":"support@graphee.co","name":"Graphee support","url":"http://www.graphee.co"},"description":"We collect and digitalise to SKU level over 4000 PDFs of promotion leaflets every month. It means that you can have access to over half of millions promotion every month from the FMCG \u0026 Retail sector. \n\n This API provides easy access to all this information.","title":"Graphee Flyers API","version":"1.0.0"},"openapi":"3.0.2","paths":{"/oauth/token":{"post":{"description":"Returns the access token used to authenticate for further requests. Generate a token and store it until expiration. If you generate too many tokens per day your access will be removed.","requestBody":{"content":{"application/json":{"example":{"audience":"https://flyers-api.graphee.io","client_id":"wMyIlV3u6FccCfK9itk0CZwodB5dvFF5","client_secret":"OuOtSJyagw1TP6a0WZ8hqqlMRDbwiNxi2d25rAGSJ4ea3UnXWM_yPoCOQh1I09m2","grant_type":"client_credentials"},"schema":{"properties":{"audience":{"description":"The audience for this api is *https://flyers-api.graphee.io*","type":"string"},"client_id":{"description":"Your client ID","type":"string"},"client_secret":{"description":"Your client secret","type":"string"},"grant_type":{"description":"The grant type, generally *client_credentials*","type":"string"}},"required":["client_id","client_secret","audience","grant_type"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"access_token":{"description":"The access token","type":"string"},"expires_in":{"description":"Expiration date","type":"integer"},"scope":{"description":"The scope list","type":"string"},"token_type":{"description":"The token type, in general *Bearer*","type":"string"}}}}},"description":"The access token"}},"summary":"Fetch Access Token","tags":["Authentication"]}},"/v1/flyers":{"get":{"description":"Returns all **flyers** from the system that the user has access to. The limit per result is fixed to **20**.","parameters":[{"description":"Bearer access token e.g. *Authorization:Bearer xxxxxxxxxxx*","explode":true,"in":"header","name":"Authorization","required":true,"schema":{"type":"string"},"style":"form"},{"description":"The targeted **country** to fetch **flyers** from","explode":true,"in":"query","name":"country","required":false,"schema":{"type":"string"},"style":"form"},{"description":"The targeted **retailer** to fetch **flyers** from","explode":true,"in":"query","name":"retailer","required":false,"schema":{"type":"integer"},"style":"form"},{"description":"The targeted **number of page** for **flyers**","explode":true,"in":"query","name":"page-count","required":false,"schema":{"type":"integer"},"style":"form"},{"description":"(format: yyyy-mm-dd). Find flyers which are valid at the time of the asked date. Also supports parameter value: now , instead of formatted date, in that case it would transform into current date","explode":true,"in":"query","name":"is-valid-at","required":false,"schema":{"type":"string"},"style":"form"},{"description":"The targeted **start date validity period** for **flyers** (format: yyyy-mm-dd). Find flyers that have an exact validity period start at the asked date.","explode":true,"in":"query","name":"validity-period-start-is","required":false,"schema":{"type":"string"},"style":"form"},{"description":"The targeted **end date validity period** for **flyers** (format: yyyy-mm-dd). Find flyers that have an exact validity period end at the asked date.","explode":true,"in":"query","name":"validity-period-end-is","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Filter flyers by uuid","explode":true,"in":"query","name":"uuid","required":false,"schema":{"type":"string"},"style":"form"},{"description":"For pagination usage; **after** query returns every elements strictly after the specified ID in **after**.","explode":true,"in":"query","name":"after","required":false,"schema":{"type":"integer"},"style":"form"},{"description":"Filter flyers by promotion operation id","explode":true,"in":"query","name":"promotion-operation-id","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Filter flyers by main flyer id","explode":true,"in":"query","name":"main-flyer-id","required":false,"schema":{"type":"string"},"style":"form"},{"description":"(format: yyyy-MM-dd or yyyy-MM-ddTHH:mm:ssZ). Find flyers which are valid at the time of the asked date.","explode":true,"in":"query","name":"last-modification-after","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"properties":{"asset":{"properties":{"legacyUrl":{"type":"string"},"url":{"type":"string"}},"type":"object"},"country":{"properties":{"iso":{"type":"string"}},"type":"object"},"created":{"format":"date-time","type":"string"},"cuttingIsCompleted":{"type":"boolean"},"id":{"format":"int32","type":"integer"},"lastModified":{"format":"date-time","type":"string"},"legacyId":{"format":"int32","type":"integer"},"matchingIsCompleted":{"type":"boolean"},"metrics":{"properties":{"matchingCompletionRatio":{"format":"int32","type":"integer"},"numberOfPages":{"format":"int32","type":"integer"},"numberOfPictures":{"format":"int32","type":"integer"},"numberOfPromotions":{"format":"int32","type":"integer"}},"type":"object"},"paperFormat":{"properties":{"height":{"type":"integer"},"id":{"type":"integer"},"legacyId":{"type":"integer"},"name":{"type":"string"},"width":{"type":"integer"}},"type":"object"},"pdfLink":{"type":"string"},"promotionOperation":{"properties":{"id":{"type":"integer"},"mainFlyerId":{"type":"integer"}},"type":"object"},"retailer":{"properties":{"id":{"format":"int32","type":"integer"},"legacyId":{"format":"int32","type":"integer"},"name":{"type":"string"}},"type":"object"},"support":{"properties":{"code":{"type":"string"},"groupId":{"type":"integer"},"id":{"type":"integer"},"legacyId":{"type":"integer"},"name":{"type":"string"}},"type":"object"},"theme":{"properties":{"id":{"type":"integer"},"legacyId":{"type":"integer"},"name":{"type":"string"},"status":{"type":"string"}},"type":"object"},"title":{"type":"string"},"uuid":{"type":"string"},"validityPeriod":{"properties":{"durationInDays":{"format":"float64","type":"number"},"end":{"format":"date-time","type":"string"},"start":{"format":"date-time","type":"string"}},"type":"object"}}},"type":"array"},"pagination":{"properties":{"next":{"type":"integer"}},"type":"object"}}}}},"description":"Success"}},"summary":"List all flyers","tags":["Flyer"]}},"/v1/flyers/:id":{"get":{"description":"Returns a **flyer**.","parameters":[{"description":"Bearer access token e.g. *Authorization:Bearer xxxxxxxxxxx*","explode":true,"in":"header","name":"Authorization","required":true,"schema":{"type":"string"},"style":"form"},{"description":"ID of the targeted **flyer**","in":"path","name":"id","required":true,"schema":{"type":"integer"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"asset":{"properties":{"legacyUrl":{"type":"string"},"url":{"type":"string"}},"type":"object"},"country":{"properties":{"iso":{"type":"string"}},"type":"object"},"created":{"format":"date-time","type":"string"},"cuttingIsCompleted":{"type":"boolean"},"id":{"format":"int32","type":"integer"},"lastModified":{"format":"date-time","type":"string"},"legacyId":{"format":"int32","type":"integer"},"matchingIsCompleted":{"type":"boolean"},"metrics":{"properties":{"matchingCompletionRatio":{"format":"int32","type":"integer"},"numberOfPages":{"format":"int32","type":"integer"},"numberOfPictures":{"format":"int32","type":"integer"},"numberOfPromotions":{"format":"int32","type":"integer"}},"type":"object"},"paperFormat":{"properties":{"height":{"type":"integer"},"id":{"type":"integer"},"legacyId":{"type":"integer"},"name":{"type":"string"},"width":{"type":"integer"}},"type":"object"},"pdfLink":{"type":"string"},"promotionOperation":{"properties":{"id":{"type":"integer"},"mainFlyerId":{"type":"integer"}},"type":"object"},"retailer":{"properties":{"id":{"format":"int32","type":"integer"},"legacyId":{"format":"int32","type":"integer"},"name":{"type":"string"}},"type":"object"},"support":{"properties":{"code":{"type":"string"},"groupId":{"type":"integer"},"id":{"type":"integer"},"legacyId":{"type":"integer"},"name":{"type":"string"}},"type":"object"},"theme":{"properties":{"id":{"type":"integer"},"legacyId":{"type":"integer"},"name":{"type":"string"},"status":{"type":"string"}},"type":"object"},"title":{"type":"string"},"uuid":{"type":"string"},"validityPeriod":{"properties":{"durationInDays":{"format":"float64","type":"number"},"end":{"format":"date-time","type":"string"},"start":{"format":"date-time","type":"string"}},"type":"object"}},"type":"object"}}}}},"description":"Success"}},"summary":"Fetch one flyer","tags":["Flyer"]}},"/v1/flyers/:id/asset":{"get":{"description":"Returns the **asset** file of the flyer.","parameters":[{"description":"Bearer access token e.g. *Authorization:Bearer xxxxxxxxxxx*","explode":true,"in":"header","name":"Authorization","required":true,"schema":{"type":"string"},"style":"form"},{"description":"ID of the targeted **flyer**","in":"path","name":"id","required":true,"schema":{"type":"integer"},"style":"simple"}],"responses":{"200":{"content":{"application/pdf":{"schema":{"type":"file"}}},"description":"Success"}},"summary":"Fetch asset for a flyer","tags":["Flyer"]}},"/v1/flyers/:id/asset/pages/:pageNumber":{"get":{"description":"Returns one page of the flyer's.","parameters":[{"description":"Bearer access token e.g. *Authorization:Bearer xxxxxxxxxxx*","explode":true,"in":"header","name":"Authorization","required":true,"schema":{"type":"string"},"style":"form"},{"description":"ID of the targeted **flyer**","in":"path","name":"id","required":true,"schema":{"type":"integer"},"style":"simple"},{"description":"Page number of the **flyer**","in":"path","name":"pageNumber","required":true,"schema":{"type":"integer"},"style":"simple"}],"responses":{"200":{"content":{"image/jpg":{"schema":{"type":"file"}}},"description":"Success"}},"summary":"Fetch one page for a flyer","tags":["Flyer"]}},"/v1/flyers/:id/asset/pages/:pageNumber/pictures/:pictureNumber":{"get":{"description":"Returns one valid picture in a flyer's page.","parameters":[{"description":"Bearer access token e.g. *Authorization:Bearer xxxxxxxxxxx*","explode":true,"in":"header","name":"Authorization","required":true,"schema":{"type":"string"},"style":"form"},{"description":"ID of the targeted **flyer**","in":"path","name":"id","required":true,"schema":{"type":"integer"},"style":"simple"},{"description":"Page number of the **flyer**","in":"path","name":"pageNumber","required":true,"schema":{"type":"integer"},"style":"simple"},{"description":"The picture's number in the page","in":"path","name":"pictureNumber","required":true,"schema":{"type":"integer"},"style":"simple"}],"responses":{"200":{"content":{"image/jpg":{"schema":{"type":"file"}}},"description":"Success"}},"summary":"Fetch one valid picture in a flyer's page","tags":["Flyer"]}},"/v1/flyers/:id/pages":{"get":{"description":"Returns all **pages** belonging to a targeted **flyer**. There is no limit per result.","parameters":[{"description":"Bearer access token e.g. *Authorization:Bearer xxxxxxxxxxx*","explode":true,"in":"header","name":"Authorization","required":true,"schema":{"type":"string"},"style":"form"},{"description":"ID of the targeted **flyer**","in":"path","name":"id","required":true,"schema":{"type":"integer"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"properties":{"asset":{"properties":{"legacyUrl":{"type":"string"},"url":{"type":"string"}},"type":"object"},"country":{"properties":{"iso":{"type":"string"}},"type":"object"},"duplicatePageId":{"format":"int32","type":"integer"},"flyer":{"properties":{"duplicateId":{"format":"int32","type":"integer"},"id":{"format":"int32","type":"integer"},"legacyId":{"format":"int32","type":"integer"}},"type":"object"},"id":{"format":"int32","type":"integer"},"imageUrl":{"type":"string"},"metrics":{"properties":{"dpi":{"format":"int32","type":"integer"},"height":{"format":"int32","type":"integer"},"width":{"format":"int32","type":"integer"}},"type":"object"},"number":{"format":"int32","type":"integer"},"pageId":{"format":"int32","type":"integer"}}},"type":"array"}}}}},"description":"Success"}},"summary":"Fetch pages","tags":["Flyer"]}},"/v1/flyers/:id/pictures":{"get":{"description":"Returns all **pictures** belonging to a targeted **flyer**. There is no limit per result.","parameters":[{"description":"Bearer access token e.g. *Authorization:Bearer xxxxxxxxxxx*","explode":true,"in":"header","name":"Authorization","required":true,"schema":{"type":"string"},"style":"form"},{"description":"ID of the targeted **flyer**","in":"path","name":"id","required":true,"schema":{"type":"integer"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"properties":{"asset":{"properties":{"legacyUrl":{"type":"string"},"url":{"type":"string"}},"type":"object"},"coordinates":{"properties":{"x1":{"format":"int32","type":"integer"},"x2":{"format":"int32","type":"integer"},"y1":{"format":"int32","type":"integer"},"y2":{"format":"int32","type":"integer"}},"type":"object"},"country":{"properties":{"iso":{"type":"string"}},"type":"object"},"duplicatePictureId":{"format":"int32","type":"integer"},"flyer":{"properties":{"id":{"format":"int32","type":"integer"},"legacyId":{"format":"int32","type":"integer"}},"type":"object"},"id":{"format":"int32","type":"integer"},"imageUrl":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"number":{"format":"int32","type":"integer"},"otherCoordinates":{"items":{"properties":{"otherCoordinates":{"properties":{"x1":{"format":"int32","type":"integer"},"x2":{"format":"int32","type":"integer"},"y1":{"format":"int32","type":"integer"},"y2":{"format":"int32","type":"integer"}},"type":"object"}}},"type":"array"},"pageId":{"format":"int32","type":"integer"},"pictureId":{"format":"int32","type":"integer"}}},"type":"array"}}}}},"description":"Success"}},"summary":"Fetch pictures","tags":["Flyer"]}},"/v1/flyers/:id/promotions":{"get":{"description":"Returns all **promotions** belonging to a targeted **flyer**. The limit per result is fixed to **250**.","parameters":[{"description":"Bearer access token e.g. *Authorization:Bearer xxxxxxxxxxx*","explode":true,"in":"header","name":"Authorization","required":true,"schema":{"type":"string"},"style":"form"},{"description":"ID of the targeted **flyer**","in":"path","name":"id","required":true,"schema":{"type":"integer"},"style":"simple"},{"description":"For pagination usage; **after** query returns every elements strictly after the specified ID in **after**.","explode":true,"in":"query","name":"after","required":false,"schema":{"type":"integer"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"properties":{"article":{"properties":{"id":{"format":"int32","type":"integer"},"legacyId":{"format":"int32","type":"integer"}},"type":"object"},"created":{"format":"date-time","type":"string"},"discount":{"properties":{"absolute":{"properties":{"currency":{"type":"string"},"display":{"type":"string"},"value":{"type":"number"}},"type":"object"},"relative":{"properties":{"display":{"type":"string"},"value":{"format":"int32","type":"integer"}},"type":"object"}},"type":"object"},"id":{"format":"int32","type":"integer"},"lastModified":{"format":"date-time","type":"string"},"legacyId":{"format":"int32","type":"integer"},"picture":{"properties":{"id":{"format":"int32","type":"integer"},"number":{"format":"int32","type":"integer"}},"type":"object"},"prices":{"properties":{"crossedPrice":{"properties":{"currency":{"type":"string"},"display":{"type":"string"},"value":{"type":"number"}},"type":"object"},"displayPrice":{"properties":{"currency":{"type":"string"},"display":{"type":"string"},"value":{"type":"number"}},"type":"object"},"mapPrice":{"properties":{"currency":{"type":"string"},"display":{"type":"string"},"value":{"type":"number"}},"type":"object"},"perUnitEquivalentPrice":{"properties":{"unit":{"properties":{"id":{"format":"int32","type":"integer"},"legacy":{"properties":{"id":{"format":"int32","type":"integer"}},"type":"object"}},"type":"object"},"value":{"type":"number"}},"type":"object"}},"type":"object"},"pricesWithoutVAT":{"properties":{"crossedPrice":{"properties":{"currency":{"type":"string"},"display":{"type":"string"},"value":{"type":"number"}},"type":"object"},"displayPrice":{"properties":{"currency":{"type":"string"},"display":{"type":"string"},"value":{"type":"number"}},"type":"object"},"mapPrice":{"properties":{"currency":{"type":"string"},"display":{"type":"string"},"value":{"type":"number"}},"type":"object"},"perUnitEquivalentPrice":{"properties":{"unit":{"properties":{"id":{"format":"int32","type":"integer"},"legacy":{"properties":{"id":{"format":"int32","type":"integer"}},"type":"object"}},"type":"object"},"value":{"type":"number"}},"type":"object"}},"type":"object"},"themeId":{"format":"int32","type":"integer"},"validityPeriod":{"properties":{"durationInDays":{"format":"float64","type":"number"},"end":{"format":"date-time","type":"string"},"start":{"format":"date-time","type":"string"}},"type":"object"},"vatRate":{"format":"float64","type":"number"}}},"type":"array"},"pagination":{"properties":{"next":{"type":"integer"}},"type":"object"}}}}},"description":"Success"}},"summary":"Fetch promotions","tags":["Flyer"]}},"/v1/flyers/:id/stores":{"get":{"description":"Returns a collection of **store** for the selected flyer.","parameters":[{"description":"Bearer access token e.g. *Authorization:Bearer xxxxxxxxxxx*","explode":true,"in":"header","name":"Authorization","required":true,"schema":{"type":"string"},"style":"form"},{"description":"ID of the targeted **flyer**","in":"path","name":"id","required":true,"schema":{"type":"integer"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"address":{"properties":{"city":{"type":"string"},"coordinates":{"properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}},"type":"object"},"country":{"type":"string"},"department":{"type":"string"},"line1":{"type":"string"},"line2":{"type":"string"},"region":{"type":"string"},"zipCode":{"type":"string"}},"type":"object"},"id":{"format":"int32","type":"integer"},"name":{"type":"string"}},"type":"object"}}}}},"description":"Success"}},"summary":"Fetch stores for flyer","tags":["Store"]}},"/v1/flyers/:id/stores-full":{"get":{"description":"Returns a collection of **store-full** for the selected flyer.","parameters":[{"description":"Bearer access token e.g. *Authorization:Bearer xxxxxxxxxxx*","explode":true,"in":"header","name":"Authorization","required":true,"schema":{"type":"string"},"style":"form"},{"description":"ID of the targeted **flyer**","in":"path","name":"id","required":true,"schema":{"type":"integer"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"address":{"properties":{"city":{"properties":{"legacyId":{"type":"number"},"value":{"type":"string"}},"type":"object"},"coordinates":{"properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}},"type":"object"},"country":{"type":"string"},"department":{"properties":{"legacyId":{"type":"number"},"value":{"type":"string"}},"type":"object"},"line1":{"type":"string"},"line2":{"type":"string"},"region":{"properties":{"legacyId":{"type":"number"},"value":{"type":"string"}},"type":"object"},"zipCode":{"type":"string"}},"type":"object"},"closingDate":{"format":"date-time","type":"string"},"id":{"format":"int32","type":"integer"},"legacyId":{"format":"int32","type":"integer"},"name":{"type":"string"},"openingDate":{"format":"date-time","type":"string"}},"type":"object"}}}}},"description":"Success"}},"summary":"Fetch stores full data for flyer","tags":["StoreFull"]}},"/v1/promotions":{"get":{"description":"Returns all **promotions** from the system that the user has access to. The limit per result is fixed to 20.","parameters":[{"description":"Bearer access token e.g. *Authorization:Bearer xxxxxxxxxxx*","explode":true,"in":"header","name":"Authorization","required":true,"schema":{"type":"string"},"style":"form"},{"description":"ID of the targeted **promotion**","in":"path","name":"id","required":true,"schema":{"type":"integer"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"properties":{"article":{"properties":{"id":{"format":"int32","type":"integer"},"legacyId":{"format":"int32","type":"integer"}},"type":"object"},"created":{"format":"date-time","type":"string"},"discount":{"properties":{"absolute":{"properties":{"currency":{"type":"string"},"display":{"type":"string"},"value":{"type":"number"}},"type":"object"},"relative":{"properties":{"display":{"type":"string"},"value":{"format":"int32","type":"integer"}},"type":"object"}},"type":"object"},"id":{"format":"int32","type":"integer"},"lastModified":{"format":"date-time","type":"string"},"legacyId":{"format":"int32","type":"integer"},"picture":{"properties":{"id":{"format":"int32","type":"integer"},"number":{"format":"int32","type":"integer"}},"type":"object"},"prices":{"properties":{"crossedPrice":{"properties":{"currency":{"type":"string"},"display":{"type":"string"},"value":{"type":"number"}},"type":"object"},"displayPrice":{"properties":{"currency":{"type":"string"},"display":{"type":"string"},"value":{"type":"number"}},"type":"object"},"mapPrice":{"properties":{"currency":{"type":"string"},"display":{"type":"string"},"value":{"type":"number"}},"type":"object"},"perUnitEquivalentPrice":{"properties":{"unit":{"properties":{"id":{"format":"int32","type":"integer"},"legacy":{"properties":{"id":{"format":"int32","type":"integer"}},"type":"object"}},"type":"object"},"value":{"type":"number"}},"type":"object"}},"type":"object"},"pricesWithoutVAT":{"properties":{"crossedPrice":{"properties":{"currency":{"type":"string"},"display":{"type":"string"},"value":{"type":"number"}},"type":"object"},"displayPrice":{"properties":{"currency":{"type":"string"},"display":{"type":"string"},"value":{"type":"number"}},"type":"object"},"mapPrice":{"properties":{"currency":{"type":"string"},"display":{"type":"string"},"value":{"type":"number"}},"type":"object"},"perUnitEquivalentPrice":{"properties":{"unit":{"properties":{"id":{"format":"int32","type":"integer"},"legacy":{"properties":{"id":{"format":"int32","type":"integer"}},"type":"object"}},"type":"object"},"value":{"type":"number"}},"type":"object"}},"type":"object"},"promoMechanisms":{"items":{"properties":{"id":{"format":"int32","type":"integer"},"type":{"type":"string"},"value":{"properties":{"unit":{"type":"string"},"value":{"format":"int32","type":"integer"}},"type":"object"}},"type":"object"},"type":"array"},"themeId":{"format":"int32","type":"integer"},"validityPeriod":{"properties":{"durationInDays":{"format":"float64","type":"number"},"end":{"format":"date-time","type":"string"},"start":{"format":"date-time","type":"string"}},"type":"object"},"vatRate":{"format":"float64","type":"number"}}},"type":"array"}}}}},"description":"Success"}},"summary":"Fetch all promotions","tags":["Promotion"]}},"/v1/promotions/:id":{"get":{"description":"Returns a **promotion**.","parameters":[{"description":"Bearer access token e.g. *Authorization:Bearer xxxxxxxxxxx*","explode":true,"in":"header","name":"Authorization","required":true,"schema":{"type":"string"},"style":"form"},{"description":"ID of the targeted **promotion**","in":"path","name":"id","required":true,"schema":{"type":"integer"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"article":{"properties":{"id":{"format":"int32","type":"integer"},"legacyId":{"format":"int32","type":"integer"}},"type":"object"},"created":{"format":"date-time","type":"string"},"discount":{"properties":{"absolute":{"properties":{"currency":{"type":"string"},"display":{"type":"string"},"value":{"type":"number"}},"type":"object"},"relative":{"properties":{"display":{"type":"string"},"value":{"format":"int32","type":"integer"}},"type":"object"}},"type":"object"},"id":{"format":"int32","type":"integer"},"lastModified":{"format":"date-time","type":"string"},"legacyId":{"format":"int32","type":"integer"},"picture":{"properties":{"id":{"format":"int32","type":"integer"},"number":{"format":"int32","type":"integer"}},"type":"object"},"prices":{"properties":{"crossedPrice":{"properties":{"currency":{"type":"string"},"display":{"type":"string"},"value":{"type":"number"}},"type":"object"},"displayPrice":{"properties":{"currency":{"type":"string"},"display":{"type":"string"},"value":{"type":"number"}},"type":"object"},"mapPrice":{"properties":{"currency":{"type":"string"},"display":{"type":"string"},"value":{"type":"number"}},"type":"object"},"perUnitEquivalentPrice":{"properties":{"unit":{"properties":{"id":{"format":"int32","type":"integer"},"legacy":{"properties":{"id":{"format":"int32","type":"integer"}},"type":"object"}},"type":"object"},"value":{"type":"number"}},"type":"object"}},"type":"object"},"pricesWithoutVAT":{"properties":{"crossedPrice":{"properties":{"currency":{"type":"string"},"display":{"type":"string"},"value":{"type":"number"}},"type":"object"},"displayPrice":{"properties":{"currency":{"type":"string"},"display":{"type":"string"},"value":{"type":"number"}},"type":"object"},"mapPrice":{"properties":{"currency":{"type":"string"},"display":{"type":"string"},"value":{"type":"number"}},"type":"object"},"perUnitEquivalentPrice":{"properties":{"unit":{"properties":{"id":{"format":"int32","type":"integer"},"legacy":{"properties":{"id":{"format":"int32","type":"integer"}},"type":"object"}},"type":"object"},"value":{"type":"number"}},"type":"object"}},"type":"object"},"promoMechanisms":{"items":{"properties":{"id":{"format":"int32","type":"integer"},"type":{"type":"string"},"value":{"properties":{"unit":{"type":"string"},"value":{"format":"int32","type":"integer"}},"type":"object"}},"type":"object"},"type":"array"},"themeId":{"format":"int32","type":"integer"},"validityPeriod":{"properties":{"durationInDays":{"format":"float64","type":"number"},"end":{"format":"date-time","type":"string"},"start":{"format":"date-time","type":"string"}},"type":"object"},"vatRate":{"format":"float64","type":"number"}},"type":"object"}}}}},"description":"Success"}},"summary":"Fetch one promotion","tags":["Promotion"]}},"/v1/retailers":{"get":{"description":"Returns all **retailers** from the system that the user has access to. The limit per result is fixed to **20**.","parameters":[{"description":"Bearer access token e.g. *Authorization:Bearer xxxxxxxxxxx*","explode":true,"in":"header","name":"Authorization","required":true,"schema":{"type":"string"},"style":"form"},{"description":"For pagination usage; **after** query returns every elements strictly after the specified ID in **after**.","explode":true,"in":"query","name":"after","required":false,"schema":{"type":"integer"},"style":"form"},{"description":"The targeted **country** to fetch **retailers** from","explode":true,"in":"query","name":"country","required":false,"schema":{"type":"string"},"style":"form"},{"description":"The targeted **retailer** filter","explode":true,"in":"query","name":"retailer","required":false,"schema":{"type":"integer"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"properties":{"category":{"properties":{"id":{"format":"int32","type":"integer"},"name":{"type":"string"}},"type":"object"},"id":{"format":"int32","type":"integer"},"legacyId":{"format":"int32","type":"integer"},"name":{"type":"string"},"parent":{"properties":{"id":{"format":"int32","type":"integer"},"legacyId":{"format":"int32","type":"integer"}},"type":"object"},"storeCount":{"format":"int32","type":"integer"}}},"type":"array"},"pagination":{"properties":{"next":{"type":"integer"}},"type":"object"}}}}},"description":"Success"}},"summary":"List all retailers","tags":["Retailer"]}}},"servers":[{"description":"Production API","url":"https://flyers-api.graphee.io"}],"tags":[{"description":"**Authentication Server**: *https://auth-api.graphee.io*","name":"Authentication","x-displayName":"Authentication"},{"description":"A **flyer** represents a promotion leaflet from the FMCG \u0026 Retail sector. It contains multiple **pages**, **pictures** and **promotions**.","name":"Flyer","x-displayName":"Flyers"},{"description":"A **store** represents a store from the FMCG \u0026 Retail sector.","name":"Store","x-displayName":"Stores"},{"description":"A **store-full** represents a store from the FMCG \u0026 Retail sector.","name":"StoreFull","x-displayName":"StoresFull"},{"description":"A Promotion","name":"Promotion","x-displayName":"Promotions"},{"description":"A Retailer","name":"Retailer","x-displayName":"Retailers"}]}