Change Log

  • 19-Jun-2024 | v7.0.0 | All new article

Contributors:

Adam Wilson - Logo Pogo

Module Items API

Create, Retrieve, Update and Delete Module Items via the public API endpoint using "where" filtering as well as Retrieve and Update Module Item's SEO data.

GET Module Items List

Retrieves a list of Module Items as a JSON response based on your provided query parameters.

/api/v2/admin/module-items/{moduleId}/list

Data / Response:

{
    "Where" : {},
    "Order_By" : "Id",
    "Offset" : 0,
    "Limit" : 100,
}

{
  "Items": [
    {
      "Id": 0,
      "Url": "string",
      "ItemRating": 0,
      "UrlList": [
        "string"
      ],
      "LastUpdatedDate": "2024-05-22T16:11:07.052Z",
      "ItemCategoriesIdList": [
        0
      ],
      "SiteSearchKeywordsString": "string",
      "IsActiveDraft": true,
      "EventProperties": {
        "HideWhenFull": true,
        "AllowMultipleSubscriptionPerEmail": true,
        "Capacity": 0,
        "Allocation": 0,
        "EventDateStart": "2024-05-22T16:11:07.052Z",
        "EventDateEnd": "2024-05-22T16:11:07.052Z"
      },
      "ProductProperties": {
        "SmallImage": "string",
        "LargeImage": "string",
        "OnSale": true,
        "IsGiftVoucher": true,
        "ProductWeight": 0,
        "ProductWidth": 0,
        "ProductHeight": 0,
        "ProductDepth": 0,
        "EnableDropShipping": true,
        "UnitType": "string",
        "MinimumUnits": 0,
        "MaximumUnits": 0,
        "RecurringType": "None",
        "IsShippable": true,
        "IsDownloadable": true,
        "NumberOfPossibleDownloads": 0,
        "Supplier": 0,
        "IsHide": true,
        "InStock": 0,
        "IsDisable": true,
        "IsGroupedProduct": true,
        "DownloadableFileLink": "string"
      },
      "Name": "string",
      "UrlSlug": "string",
      "ParentId": 0,
      "Enabled": true,
      "ReleaseDate": "2024-05-22T16:11:07.052Z",
      "ExpiryDate": "2024-05-22T16:11:07.052Z",
      "Description": "string",
      "Weighting": 0,
      "DisableForSiteSearch": true,
      "SKUCode": "string",
      "CreatedByMemberId": 0,
      "Author": 0,
      "ModuleId": 0,
      "TemplateId": 0,
      "LayoutId": 0,
      "Parents": [
        0
      ],
      "ItemCategories": [
        "string"
      ],
      "ItemTags": [
        "string"
      ],
      "SiteSearchKeywords": [
        "string"
      ],
      "CustomProperties": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      }
    }
  ],
  "TotalItemsCount": 0
}

POST Module Item Create

Creates a new Module Item based on the provided data.

/api/v2/admin/module-items

Data / Response:

{
  "EventProperties": {
    "HideWhenFull": true,
    "AllowMultipleSubscriptionPerEmail": true,
    "Capacity": 0,
    "EventDateStart": "2024-05-22T16:10:05.639Z",
    "EventDateEnd": "2024-05-22T16:10:05.639Z"
  },
  "ProductProperties": {
    "SmallImage": "string",
    "LargeImage": "string",
    "OnSale": true,
    "IsGiftVoucher": true,
    "ProductWeight": 0,
    "ProductWidth": 0,
    "ProductHeight": 0,
    "ProductDepth": 0,
    "EnableDropShipping": true,
    "UnitType": "string",
    "MinimumUnits": 0,
    "MaximumUnits": 0,
    "RecurringType": "None",
    "IsShippable": true,
    "IsDownloadable": true,
    "NumberOfPossibleDownloads": 0,
    "Supplier": 0,
    "IsHide": true,
    "InStock": 0,
    "IsDisable": true,
    "IsGroupedProduct": true,
    "DownloadableFileLink": "string"
  },
  "Name": "string",
  "UrlSlug": "string",
  "ParentId": 0,
  "Enabled": true,
  "ReleaseDate": "2024-05-22T16:10:05.639Z",
  "ExpiryDate": "2024-05-22T16:10:05.639Z",
  "Description": "string",
  "Weighting": 0,
  "DisableForSiteSearch": true,
  "SKUCode": "string",
  "CreatedByMemberId": 0,
  "Author": 0,
  "ModuleId": 0,
  "TemplateId": 0,
  "LayoutId": 0,
  "Parents": [
    0
  ],
  "ItemCategories": [
    "string"
  ],
  "ItemTags": [
    "string"
  ],
  "SiteSearchKeywords": [
    "string"
  ],
  "CustomProperties": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  }
}

{
  "Id": 0,
  "Url": "string",
  "ItemRating": 0,
  "UrlList": [
    "string"
  ],
  "LastUpdatedDate": "2024-05-22T16:10:05.641Z",
  "ItemCategoriesIdList": [
    0
  ],
  "SiteSearchKeywordsString": "string",
  "IsActiveDraft": true,
  "EventProperties": {
    "HideWhenFull": true,
    "AllowMultipleSubscriptionPerEmail": true,
    "Capacity": 0,
    "Allocation": 0,
    "EventDateStart": "2024-05-22T16:10:05.641Z",
    "EventDateEnd": "2024-05-22T16:10:05.641Z"
  },
  "ProductProperties": {
    "SmallImage": "string",
    "LargeImage": "string",
    "OnSale": true,
    "IsGiftVoucher": true,
    "ProductWeight": 0,
    "ProductWidth": 0,
    "ProductHeight": 0,
    "ProductDepth": 0,
    "EnableDropShipping": true,
    "UnitType": "string",
    "MinimumUnits": 0,
    "MaximumUnits": 0,
    "RecurringType": "None",
    "IsShippable": true,
    "IsDownloadable": true,
    "NumberOfPossibleDownloads": 0,
    "Supplier": 0,
    "IsHide": true,
    "InStock": 0,
    "IsDisable": true,
    "IsGroupedProduct": true,
    "DownloadableFileLink": "string"
  },
  "Name": "string",
  "UrlSlug": "string",
  "ParentId": 0,
  "Enabled": true,
  "ReleaseDate": "2024-05-22T16:10:05.641Z",
  "ExpiryDate": "2024-05-22T16:10:05.641Z",
  "Description": "string",
  "Weighting": 0,
  "DisableForSiteSearch": true,
  "SKUCode": "string",
  "CreatedByMemberId": 0,
  "Author": 0,
  "ModuleId": 0,
  "TemplateId": 0,
  "LayoutId": 0,
  "Parents": [
    0
  ],
  "ItemCategories": [
    "string"
  ],
  "ItemTags": [
    "string"
  ],
  "SiteSearchKeywords": [
    "string"
  ],
  "CustomProperties": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  }
}

GET Module Item Item

Retrieves a single Module Item based on the ID passed in the endpoint URL.

/api/v2/admin/module-items/{id}

Data / Response:

N/A

{
  "Id": 0,
  "Url": "string",
  "ItemRating": 0,
  "UrlList": [
    "string"
  ],
  "LastUpdatedDate": "2024-05-22T16:10:05.641Z",
  "ItemCategoriesIdList": [
    0
  ],
  "SiteSearchKeywordsString": "string",
  "IsActiveDraft": true,
  "EventProperties": {
    "HideWhenFull": true,
    "AllowMultipleSubscriptionPerEmail": true,
    "Capacity": 0,
    "Allocation": 0,
    "EventDateStart": "2024-05-22T16:10:05.641Z",
    "EventDateEnd": "2024-05-22T16:10:05.641Z"
  },
  "ProductProperties": {
    "SmallImage": "string",
    "LargeImage": "string",
    "OnSale": true,
    "IsGiftVoucher": true,
    "ProductWeight": 0,
    "ProductWidth": 0,
    "ProductHeight": 0,
    "ProductDepth": 0,
    "EnableDropShipping": true,
    "UnitType": "string",
    "MinimumUnits": 0,
    "MaximumUnits": 0,
    "RecurringType": "None",
    "IsShippable": true,
    "IsDownloadable": true,
    "NumberOfPossibleDownloads": 0,
    "Supplier": 0,
    "IsHide": true,
    "InStock": 0,
    "IsDisable": true,
    "IsGroupedProduct": true,
    "DownloadableFileLink": "string"
  },
  "Name": "string",
  "UrlSlug": "string",
  "ParentId": 0,
  "Enabled": true,
  "ReleaseDate": "2024-05-22T16:10:05.641Z",
  "ExpiryDate": "2024-05-22T16:10:05.641Z",
  "Description": "string",
  "Weighting": 0,
  "DisableForSiteSearch": true,
  "SKUCode": "string",
  "CreatedByMemberId": 0,
  "Author": 0,
  "ModuleId": 0,
  "TemplateId": 0,
  "LayoutId": 0,
  "Parents": [
    0
  ],
  "ItemCategories": [
    "string"
  ],
  "ItemTags": [
    "string"
  ],
  "SiteSearchKeywords": [
    "string"
  ],
  "CustomProperties": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  }
}

PUT Module Item Update

Updates a single Module Item based on the ID passed in the endpoint URL and data provided.

/api/v2/admin/module-items

Data / Response:

{
  "Id": 0,
  "EventProperties": {
    "HideWhenFull": true,
    "AllowMultipleSubscriptionPerEmail": true,
    "Capacity": 0,
    "EventDateStart": "2024-05-22T16:10:29.558Z",
    "EventDateEnd": "2024-05-22T16:10:29.558Z"
  },
  "ProductProperties": {
    "SmallImage": "string",
    "LargeImage": "string",
    "OnSale": true,
    "IsGiftVoucher": true,
    "ProductWeight": 0,
    "ProductWidth": 0,
    "ProductHeight": 0,
    "ProductDepth": 0,
    "EnableDropShipping": true,
    "UnitType": "string",
    "MinimumUnits": 0,
    "MaximumUnits": 0,
    "RecurringType": "None",
    "IsShippable": true,
    "IsDownloadable": true,
    "NumberOfPossibleDownloads": 0,
    "Supplier": 0,
    "IsHide": true,
    "InStock": 0,
    "IsDisable": true,
    "IsGroupedProduct": true,
    "DownloadableFileLink": "string"
  },
  "Name": "string",
  "UrlSlug": "string",
  "ParentId": 0,
  "Enabled": true,
  "ReleaseDate": "2024-05-22T16:10:29.558Z",
  "ExpiryDate": "2024-05-22T16:10:29.558Z",
  "Description": "string",
  "Weighting": 0,
  "DisableForSiteSearch": true,
  "SKUCode": "string",
  "CreatedByMemberId": 0,
  "Author": 0,
  "ModuleId": 0,
  "TemplateId": 0,
  "LayoutId": 0,
  "Parents": [
    0
  ],
  "ItemCategories": [
    "string"
  ],
  "ItemTags": [
    "string"
  ],
  "SiteSearchKeywords": [
    "string"
  ],
  "CustomProperties": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  }
}

{
  "Id": 0,
  "Url": "string",
  "ItemRating": 0,
  "UrlList": [
    "string"
  ],
  "LastUpdatedDate": "2024-05-22T16:10:05.641Z",
  "ItemCategoriesIdList": [
    0
  ],
  "SiteSearchKeywordsString": "string",
  "IsActiveDraft": true,
  "EventProperties": {
    "HideWhenFull": true,
    "AllowMultipleSubscriptionPerEmail": true,
    "Capacity": 0,
    "Allocation": 0,
    "EventDateStart": "2024-05-22T16:10:05.641Z",
    "EventDateEnd": "2024-05-22T16:10:05.641Z"
  },
  "ProductProperties": {
    "SmallImage": "string",
    "LargeImage": "string",
    "OnSale": true,
    "IsGiftVoucher": true,
    "ProductWeight": 0,
    "ProductWidth": 0,
    "ProductHeight": 0,
    "ProductDepth": 0,
    "EnableDropShipping": true,
    "UnitType": "string",
    "MinimumUnits": 0,
    "MaximumUnits": 0,
    "RecurringType": "None",
    "IsShippable": true,
    "IsDownloadable": true,
    "NumberOfPossibleDownloads": 0,
    "Supplier": 0,
    "IsHide": true,
    "InStock": 0,
    "IsDisable": true,
    "IsGroupedProduct": true,
    "DownloadableFileLink": "string"
  },
  "Name": "string",
  "UrlSlug": "string",
  "ParentId": 0,
  "Enabled": true,
  "ReleaseDate": "2024-05-22T16:10:05.641Z",
  "ExpiryDate": "2024-05-22T16:10:05.641Z",
  "Description": "string",
  "Weighting": 0,
  "DisableForSiteSearch": true,
  "SKUCode": "string",
  "CreatedByMemberId": 0,
  "Author": 0,
  "ModuleId": 0,
  "TemplateId": 0,
  "LayoutId": 0,
  "Parents": [
    0
  ],
  "ItemCategories": [
    "string"
  ],
  "ItemTags": [
    "string"
  ],
  "SiteSearchKeywords": [
    "string"
  ],
  "CustomProperties": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  }
}

DELETE Module Item Delete

Deletes a single Module Item based on the ID passed in the endpoint URL.

/api/v2/admin/module-items/{id}

Data / Response:

N/A

Status 204

GET Module Item's SEO Data

Retrieves a single Module Item's SEO Data based on the ID passed in the endpoint URL.

/api/v2/admin/module-items/{id}/seo

Data / Response:

N/A

{
  "Id": 0,
  "SEOTitle": "string",
  "MetaDescription": "string",
  "CanonicalLink": "string",
  "SocialMetaTags": "string",
  "SeoPriority": 1,
  "EnableAMP": true,
  "AMPContent": "string",
  "ShowPageForSearchEngine": true,
  "OpenGraphProperties": {
    "Image": "string",
    "Locale": "string",
    "Title": "string",
    "Type": "string",
    "Url": "string"
  }
}

PUT Module Item's SEO Data Update

Updates a single Module Item's SEO Data based on the data provided.

/api/v2/admin/module-items/seo

Data / Response:

{
  "Id": 0,
  "SEOTitle": "string",
  "MetaDescription": "string",
  "CanonicalLink": "string",
  "SocialMetaTags": "string",
  "SeoPriority": 1,
  "EnableAMP": true,
  "AMPContent": "string",
  "ShowPageForSearchEngine": true,
  "OpenGraphProperties": {
    "Image": "string",
    "Locale": "string",
    "Title": "string",
    "Type": "string",
    "Url": "string"
  }
}

{
  "Id": 0,
  "SEOTitle": "string",
  "MetaDescription": "string",
  "CanonicalLink": "string",
  "SocialMetaTags": "string",
  "SeoPriority": 1,
  "EnableAMP": true,
  "AMPContent": "string",
  "ShowPageForSearchEngine": true,
  "OpenGraphProperties": {
    "Image": "string",
    "Locale": "string",
    "Title": "string",
    "Type": "string",
    "Url": "string"
  }
}