Change Log

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

Contributors:

{
  "id": 2418,
  "name": "Adam Wilson",
  "url": "/adam-wilson"
}
Adam Wilson - Logo Pogo

Module Item Draft API

Retrieve, Update and Delete Module Item Drafts via the public API endpoint, including publishing a draft to make it live. A Module Item's SEO Draft can also be retrieved, updated, deleted and published through this API.

GET Module Item Draft Item

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

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

Data / Response:

N/A

{
  "Id": 0,
  "Url": "string",
  "ItemRating": 0,
  "UrlList": [
    "string"
  ],
  "LastUpdatedDate": "2024-01-01T00:00:00.000Z",
  "ItemCategoriesIdList": [
    0
  ],
  "SiteSearchKeywordsString": "string",
  "IsActiveDraft": true,
  "EventProperties": {
    "HideWhenFull": true,
    "AllowMultipleSubscriptionPerEmail": true,
    "Capacity": 0,
    "Allocation": 0,
    "EventDateStart": "2024-01-01T00:00:00.000Z",
    "EventDateEnd": "2024-01-01T00:00:00.000Z"
  },
  "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"
  },
  "ParentName": "string",
  "ParentUrl": "string",
  "Name": "string",
  "UrlSlug": "string",
  "ParentId": 0,
  "Enabled": true,
  "ReleaseDate": "2024-01-01T00:00:00.000Z",
  "ExpiryDate": "2024-01-01T00:00:00.000Z",
  "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": {
    "<PropertyAlias1>": "<value>",
    "<PropertyAlias2>": "<value>"
  }
}

PUT Module Item Draft Update

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

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

Data / Response:

{
  "EventProperties": {
    "HideWhenFull": true,
    "AllowMultipleSubscriptionPerEmail": true,
    "Capacity": 0,
    "EventDateStart": "2024-01-01T00:00:00.000Z",
    "EventDateEnd": "2024-01-01T00:00:00.000Z"
  },
  "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-01-01T00:00:00.000Z",
  "ExpiryDate": "2024-01-01T00:00:00.000Z",
  "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": {
    "<PropertyAlias1>": "<value>",
    "<PropertyAlias2>": "<value>"
  }
}

{
  "Id": 0,
  "Url": "string",
  "ItemRating": 0,
  "UrlList": [
    "string"
  ],
  "LastUpdatedDate": "2024-01-01T00:00:00.000Z",
  "ItemCategoriesIdList": [
    0
  ],
  "SiteSearchKeywordsString": "string",
  "IsActiveDraft": true,
  "EventProperties": {
    "HideWhenFull": true,
    "AllowMultipleSubscriptionPerEmail": true,
    "Capacity": 0,
    "Allocation": 0,
    "EventDateStart": "2024-01-01T00:00:00.000Z",
    "EventDateEnd": "2024-01-01T00:00:00.000Z"
  },
  "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"
  },
  "ParentName": "string",
  "ParentUrl": "string",
  "Name": "string",
  "UrlSlug": "string",
  "ParentId": 0,
  "Enabled": true,
  "ReleaseDate": "2024-01-01T00:00:00.000Z",
  "ExpiryDate": "2024-01-01T00:00:00.000Z",
  "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": {
    "<PropertyAlias1>": "<value>",
    "<PropertyAlias2>": "<value>"
  }
}

DELETE Module Item Draft Delete

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

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

Data / Response:

N/A

Status 204

GET Module Item SEO Draft Item

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

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

Data / Response:

N/A

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

PUT Module Item SEO Draft Update

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

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

Data / Response:

{
  "SEOTitle": "string",
  "MetaDescription": "string",
  "CanonicalLink": "string",
  "SocialMetaTags": "string",
  "SeoPriority": 0,
  "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": 0,
  "EnableAMP": true,
  "AMPContent": "string",
  "ShowPageForSearchEngine": true,
  "OpenGraphProperties": {
    "Image": "string",
    "Locale": "string",
    "Title": "string",
    "Type": "string",
    "Url": "string"
  }
}

DELETE Module Item SEO Draft Delete

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

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

Data / Response:

N/A

Status 204

PUT Module Item Draft Publish

Publishes a single Module Item Draft based on the ID passed in the endpoint URL and data provided, making the draft content the live version of the Module Item.

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

Data / Response:

{
  "EventProperties": {
    "HideWhenFull": true,
    "AllowMultipleSubscriptionPerEmail": true,
    "Capacity": 0,
    "EventDateStart": "2024-01-01T00:00:00.000Z",
    "EventDateEnd": "2024-01-01T00:00:00.000Z"
  },
  "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-01-01T00:00:00.000Z",
  "ExpiryDate": "2024-01-01T00:00:00.000Z",
  "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": {
    "<PropertyAlias1>": "<value>",
    "<PropertyAlias2>": "<value>"
  }
}

{
  "Id": 0,
  "Url": "string",
  "ItemRating": 0,
  "UrlList": [
    "string"
  ],
  "LastUpdatedDate": "2024-01-01T00:00:00.000Z",
  "ItemCategoriesIdList": [
    0
  ],
  "SiteSearchKeywordsString": "string",
  "IsActiveDraft": true,
  "EventProperties": {
    "HideWhenFull": true,
    "AllowMultipleSubscriptionPerEmail": true,
    "Capacity": 0,
    "Allocation": 0,
    "EventDateStart": "2024-01-01T00:00:00.000Z",
    "EventDateEnd": "2024-01-01T00:00:00.000Z"
  },
  "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"
  },
  "ParentName": "string",
  "ParentUrl": "string",
  "Name": "string",
  "UrlSlug": "string",
  "ParentId": 0,
  "Enabled": true,
  "ReleaseDate": "2024-01-01T00:00:00.000Z",
  "ExpiryDate": "2024-01-01T00:00:00.000Z",
  "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": {
    "<PropertyAlias1>": "<value>",
    "<PropertyAlias2>": "<value>"
  }
}

PUT Module Item SEO Draft Publish

Publishes a single Module Item's SEO Draft based on the ID passed in the endpoint URL and data provided, making the SEO draft the live SEO data for the Module Item.

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

Data / Response:

{
  "SEOTitle": "string",
  "MetaDescription": "string",
  "CanonicalLink": "string",
  "SocialMetaTags": "string",
  "SeoPriority": 0,
  "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": 0,
  "EnableAMP": true,
  "AMPContent": "string",
  "ShowPageForSearchEngine": true,
  "OpenGraphProperties": {
    "Image": "string",
    "Locale": "string",
    "Title": "string",
    "Type": "string",
    "Url": "string"
  }
}