POST api/v2/leaflets/geolocated/shopleaflets

Request Information

URI Parameters

None.

Body Parameters

Name	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": "29dc88f1-0fb3-4ffc-a4b9-04ccc81e1008",
  "ApplicationVersion": 3,
  "Udid": "sample string 4",
  "UserID": "196824ad-643a-4692-ba7c-7977e62052be",
  "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">29dc88f1-0fb3-4ffc-a4b9-04ccc81e1008</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">196824ad-643a-4692-ba7c-7977e62052be</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:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ShopLeafletsRequest'.

Response Information

Resource Description

ShopLeafletsResultV2

Name	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": "b162ec4a-4cef-4ea6-80f5-778df6f4cd30",
      "LeafletSlug": "sample string 3",
      "LeafletRetailerID": "3e205abe-f580-498a-8964-0a8af9611260",
      "CoverPageNumber": 5,
      "EndDate": "2025-09-01T18:54:02.346+00:00",
      "ImageFileFormat": "sample string 7",
      "ImageRatio": 1.0,
      "PdfFileName": "sample string 8",
      "DisplayedStartDate": "2025-09-01T18:54:02.346+00:00",
      "StartDate": "2025-09-01T18:54:02.346+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": "b162ec4a-4cef-4ea6-80f5-778df6f4cd30",
      "LeafletSlug": "sample string 3",
      "LeafletRetailerID": "3e205abe-f580-498a-8964-0a8af9611260",
      "CoverPageNumber": 5,
      "EndDate": "2025-09-01T18:54:02.346+00:00",
      "ImageFileFormat": "sample string 7",
      "ImageRatio": 1.0,
      "PdfFileName": "sample string 8",
      "DisplayedStartDate": "2025-09-01T18:54:02.346+00:00",
      "StartDate": "2025-09-01T18:54:02.346+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": "083beb8e-3b69-4bcd-a348-74ec921c56d1",
      "LeafletSlug": "sample string 2",
      "LeafletRetailerID": "3d388618-bb99-4332-b264-95615240b15e",
      "DisplayedStartDate": "2025-09-01T18:54:02.346+00:00",
      "StartDate": "2025-09-01T18:54:02.346+00:00",
      "EndDate": "2025-09-01T18:54:02.346+00:00",
      "Title": "sample string 7",
      "ZoneID": 8,
      "LeafletUrl": "sample string 9",
      "MyshopiLeafletUrl": "sample string 10",
      "CoverUrl": "sample string 11"
    },
    {
      "LeafletID": "083beb8e-3b69-4bcd-a348-74ec921c56d1",
      "LeafletSlug": "sample string 2",
      "LeafletRetailerID": "3d388618-bb99-4332-b264-95615240b15e",
      "DisplayedStartDate": "2025-09-01T18:54:02.346+00:00",
      "StartDate": "2025-09-01T18:54:02.346+00:00",
      "EndDate": "2025-09-01T18:54:02.346+00:00",
      "Title": "sample string 7",
      "ZoneID": 8,
      "LeafletUrl": "sample string 9",
      "MyshopiLeafletUrl": "sample string 10",
      "CoverUrl": "sample string 11"
    }
  ],
  "LeafletsOrder": [
    {
      "LeafletID": "04828398-7829-4ad6-86f4-d0eec85ca601",
      "Position": 2,
      "IsInteractiveLeaflet": true
    },
    {
      "LeafletID": "04828398-7829-4ad6-86f4-d0eec85ca601",
      "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">2025-09-01T18:54:02.3464467+00:00</DisplayedStartDate>
      <EndDate xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses">2025-09-01T18:54:02.3464467+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">33f59318-3742-4107-9ce5-6f5639b621a3</LeafletGroupID>
      <LeafletID xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses">b162ec4a-4cef-4ea6-80f5-778df6f4cd30</LeafletID>
      <LeafletRetailerID xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses">3e205abe-f580-498a-8964-0a8af9611260</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">2025-09-01T18:54:02.3464467+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">2025-09-01T18:54:02.3464467+00:00</DisplayedStartDate>
      <EndDate xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses">2025-09-01T18:54:02.3464467+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">33f59318-3742-4107-9ce5-6f5639b621a3</LeafletGroupID>
      <LeafletID xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses">b162ec4a-4cef-4ea6-80f5-778df6f4cd30</LeafletID>
      <LeafletRetailerID xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses">3e205abe-f580-498a-8964-0a8af9611260</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">2025-09-01T18:54:02.3464467+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>04828398-7829-4ad6-86f4-d0eec85ca601</d2p1:LeafletID>
      <d2p1:Position>2</d2p1:Position>
    </d2p1:LeafletOrder>
    <d2p1:LeafletOrder>
      <d2p1:IsInteractiveLeaflet>true</d2p1:IsInteractiveLeaflet>
      <d2p1:LeafletID>04828398-7829-4ad6-86f4-d0eec85ca601</d2p1:LeafletID>
      <d2p1:Position>2</d2p1:Position>
    </d2p1:LeafletOrder>
  </LeafletsOrder>
</ShopLeafletsResult>