POST api/v2/leaflets/geolocated/shopleaflets
Request Information
URI Parameters
None.
Body Parameters
ShopLeafletsRequestName | Description | Type | Additional information |
---|---|---|---|
LeafletShopSlug | string |
Required |
|
ApiKey | globally unique identifier |
Required |
|
ApplicationVersion | integer |
Required |
|
Udid | string |
Required |
|
UserID | globally unique identifier |
Required |
|
ZoneID | integer |
Required |
Request Formats
application/json, text/json
Sample:
{ "LeafletShopSlug": "sample string 1", "ApiKey": "cbd8e36a-5141-428a-b807-0a9a3ac5e32c", "ApplicationVersion": 3, "Udid": "sample string 4", "UserID": "e92f8165-04cc-4113-93f5-312d7f722354", "ZoneID": 6 }
application/xml, text/xml
Sample:
<ShopLeafletsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Requests"> <ApiKey xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models">cbd8e36a-5141-428a-b807-0a9a3ac5e32c</ApiKey> <ApplicationVersion xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models">3</ApplicationVersion> <Udid xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models">sample string 4</Udid> <UserID xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models">e92f8165-04cc-4113-93f5-312d7f722354</UserID> <ZoneID xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models">6</ZoneID> <LeafletShopSlug>sample string 1</LeafletShopSlug> </ShopLeafletsRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
ShopLeafletsResultV2Name | Description | Type | Additional information |
---|---|---|---|
Leaflets | Collection of LeafletV2 |
None. |
|
InteractiveLeaflets | Collection of InteractiveLeafletV2 |
None. |
|
LeafletsOrder | Collection of LeafletOrder |
None. |
Response Formats
application/json, text/json
Sample:
{ "Leaflets": [ { "AssetsPathUrl": "sample string 1", "LeafletID": "c287d468-3fd3-4dbf-a959-991914d9c45a", "LeafletSlug": "sample string 3", "LeafletRetailerID": "ca2dfd57-6243-4f02-a0d7-351e616bb3e2", "CoverPageNumber": 5, "EndDate": "2024-09-18T23:58:47.19+00:00", "ImageFileFormat": "sample string 7", "ImageRatio": 1.0, "PdfFileName": "sample string 8", "DisplayedStartDate": "2024-09-18T23:58:47.19+00:00", "StartDate": "2024-09-18T23:58:47.19+00:00", "Title": "sample string 11", "TotalPages": 12, "ZoneID": 13, "ExtenderFolderInfos": { "AdvertisingUrl": "sample string 1", "BannerSmartphoneLowResImageUrl": "sample string 2", "BannerSmartphoneImageUrl": "sample string 3", "WebsiteUrl": "sample string 4", "WebsiteUrlDescription": "sample string 5" }, "LeafletUrl": "sample string 14" }, { "AssetsPathUrl": "sample string 1", "LeafletID": "c287d468-3fd3-4dbf-a959-991914d9c45a", "LeafletSlug": "sample string 3", "LeafletRetailerID": "ca2dfd57-6243-4f02-a0d7-351e616bb3e2", "CoverPageNumber": 5, "EndDate": "2024-09-18T23:58:47.19+00:00", "ImageFileFormat": "sample string 7", "ImageRatio": 1.0, "PdfFileName": "sample string 8", "DisplayedStartDate": "2024-09-18T23:58:47.19+00:00", "StartDate": "2024-09-18T23:58:47.19+00:00", "Title": "sample string 11", "TotalPages": 12, "ZoneID": 13, "ExtenderFolderInfos": { "AdvertisingUrl": "sample string 1", "BannerSmartphoneLowResImageUrl": "sample string 2", "BannerSmartphoneImageUrl": "sample string 3", "WebsiteUrl": "sample string 4", "WebsiteUrlDescription": "sample string 5" }, "LeafletUrl": "sample string 14" } ], "InteractiveLeaflets": [ { "LeafletID": "006342c5-2b0e-4e7c-a344-5e6f471ffb91", "LeafletSlug": "sample string 2", "LeafletRetailerID": "e45e1a82-3d5b-4fa7-ba9e-f2a1caf495a7", "DisplayedStartDate": "2024-09-18T23:58:47.19+00:00", "StartDate": "2024-09-18T23:58:47.19+00:00", "EndDate": "2024-09-18T23:58:47.19+00:00", "Title": "sample string 7", "ZoneID": 8, "LeafletUrl": "sample string 9", "MyshopiLeafletUrl": "sample string 10", "CoverUrl": "sample string 11" }, { "LeafletID": "006342c5-2b0e-4e7c-a344-5e6f471ffb91", "LeafletSlug": "sample string 2", "LeafletRetailerID": "e45e1a82-3d5b-4fa7-ba9e-f2a1caf495a7", "DisplayedStartDate": "2024-09-18T23:58:47.19+00:00", "StartDate": "2024-09-18T23:58:47.19+00:00", "EndDate": "2024-09-18T23:58:47.19+00:00", "Title": "sample string 7", "ZoneID": 8, "LeafletUrl": "sample string 9", "MyshopiLeafletUrl": "sample string 10", "CoverUrl": "sample string 11" } ], "LeafletsOrder": [ { "LeafletID": "16cfb87e-253f-4b04-bcbc-d7d8320ed6ce", "Position": 2, "IsInteractiveLeaflet": true }, { "LeafletID": "16cfb87e-253f-4b04-bcbc-d7d8320ed6ce", "Position": 2, "IsInteractiveLeaflet": true } ] }
application/xml, text/xml
Sample:
<ShopLeafletsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses.v2"> <Leaflets> <Leaflet> <AreaPosition xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses">1</AreaPosition> <AssetsPathUrl xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses">sample string 1</AssetsPathUrl> <CoverPageNumber xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses">5</CoverPageNumber> <DisplayedStartDate xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses">2024-09-18T23:58:47.1909782+00:00</DisplayedStartDate> <EndDate xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses">2024-09-18T23:58:47.1909782+00:00</EndDate> <ExtenderFolderInfos xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses"> <AdvertisingUrl>sample string 1</AdvertisingUrl> <BannerSmartphoneImageUrl>sample string 3</BannerSmartphoneImageUrl> <BannerSmartphoneLowResImageUrl>sample string 2</BannerSmartphoneLowResImageUrl> <WebsiteUrl>sample string 4</WebsiteUrl> <WebsiteUrlDescription>sample string 5</WebsiteUrlDescription> </ExtenderFolderInfos> <ImageFileFormat xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses">sample string 7</ImageFileFormat> <ImageRatio xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses">1</ImageRatio> <LeafletGroupID xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses">f5420e77-daa6-4b36-9758-79a3f7239f17</LeafletGroupID> <LeafletID xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses">c287d468-3fd3-4dbf-a959-991914d9c45a</LeafletID> <LeafletRetailerID xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses">ca2dfd57-6243-4f02-a0d7-351e616bb3e2</LeafletRetailerID> <LeafletSlug xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses">sample string 3</LeafletSlug> <LeafletUrl xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses">sample string 14</LeafletUrl> <PdfFileName xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses">sample string 8</PdfFileName> <Position xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses">15</Position> <StartDate xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses">2024-09-18T23:58:47.1909782+00:00</StartDate> <Title xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses">sample string 11</Title> <TotalPages xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses">12</TotalPages> <ZoneID xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses">13</ZoneID> </Leaflet> <Leaflet> <AreaPosition xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses">1</AreaPosition> <AssetsPathUrl xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses">sample string 1</AssetsPathUrl> <CoverPageNumber xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses">5</CoverPageNumber> <DisplayedStartDate xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses">2024-09-18T23:58:47.1909782+00:00</DisplayedStartDate> <EndDate xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses">2024-09-18T23:58:47.1909782+00:00</EndDate> <ExtenderFolderInfos xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses"> <AdvertisingUrl>sample string 1</AdvertisingUrl> <BannerSmartphoneImageUrl>sample string 3</BannerSmartphoneImageUrl> <BannerSmartphoneLowResImageUrl>sample string 2</BannerSmartphoneLowResImageUrl> <WebsiteUrl>sample string 4</WebsiteUrl> <WebsiteUrlDescription>sample string 5</WebsiteUrlDescription> </ExtenderFolderInfos> <ImageFileFormat xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses">sample string 7</ImageFileFormat> <ImageRatio xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses">1</ImageRatio> <LeafletGroupID xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses">f5420e77-daa6-4b36-9758-79a3f7239f17</LeafletGroupID> <LeafletID xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses">c287d468-3fd3-4dbf-a959-991914d9c45a</LeafletID> <LeafletRetailerID xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses">ca2dfd57-6243-4f02-a0d7-351e616bb3e2</LeafletRetailerID> <LeafletSlug xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses">sample string 3</LeafletSlug> <LeafletUrl xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses">sample string 14</LeafletUrl> <PdfFileName xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses">sample string 8</PdfFileName> <Position xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses">15</Position> <StartDate xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses">2024-09-18T23:58:47.1909782+00:00</StartDate> <Title xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses">sample string 11</Title> <TotalPages xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses">12</TotalPages> <ZoneID xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses">13</ZoneID> </Leaflet> </Leaflets> <LeafletsOrder xmlns:d2p1="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses"> <d2p1:LeafletOrder> <d2p1:IsInteractiveLeaflet>true</d2p1:IsInteractiveLeaflet> <d2p1:LeafletID>16cfb87e-253f-4b04-bcbc-d7d8320ed6ce</d2p1:LeafletID> <d2p1:Position>2</d2p1:Position> </d2p1:LeafletOrder> <d2p1:LeafletOrder> <d2p1:IsInteractiveLeaflet>true</d2p1:IsInteractiveLeaflet> <d2p1:LeafletID>16cfb87e-253f-4b04-bcbc-d7d8320ed6ce</d2p1:LeafletID> <d2p1:Position>2</d2p1:Position> </d2p1:LeafletOrder> </LeafletsOrder> </ShopLeafletsResult>