Contributors:
Module Item Draft API
Update and Delete Module Item Drafts via the public API endpoint including the publishing of drafts.
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
Data / Response:
{
"Id": 0,
"EventProperties": {
"HideWhenFull": true,
"AllowMultipleSubscriptionPerEmail": true,
"Capacity": 0,
"EventDateStart": "2024-05-22T15:48:57.672Z",
"EventDateEnd": "2024-05-22T15:48:57.672Z"
},
"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-22T15:48:57.672Z",
"ExpiryDate": "2024-05-22T15:48:57.672Z",
"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-22T15:49:45.895Z",
"ItemCategoriesIdList": [
0
],
"SiteSearchKeywordsString": "string",
"IsActiveDraft": true,
"EventProperties": {
"HideWhenFull": true,
"AllowMultipleSubscriptionPerEmail": true,
"Capacity": 0,
"Allocation": 0,
"EventDateStart": "2024-05-22T15:49:45.895Z",
"EventDateEnd": "2024-05-22T15:49:45.895Z"
},
"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-22T15:49:45.895Z",
"ExpiryDate": "2024-05-22T15:49:45.895Z",
"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 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
PUT Module Item Draft Publish
Publishes a single Module Item Draft based on the ID passed in the endpoint URL and data provided.
/api/v2/admin/module-items/publish-draft
Data / Response:
{
"Id": 0,
"EventProperties": {
"HideWhenFull": true,
"AllowMultipleSubscriptionPerEmail": true,
"Capacity": 0,
"EventDateStart": "2024-05-22T15:49:45.893Z",
"EventDateEnd": "2024-05-22T15:49:45.893Z"
},
"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-22T15:49:45.893Z",
"ExpiryDate": "2024-05-22T15:49:45.893Z",
"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-22T15:49:45.895Z",
"ItemCategoriesIdList": [
0
],
"SiteSearchKeywordsString": "string",
"IsActiveDraft": true,
"EventProperties": {
"HideWhenFull": true,
"AllowMultipleSubscriptionPerEmail": true,
"Capacity": 0,
"Allocation": 0,
"EventDateStart": "2024-05-22T15:49:45.895Z",
"EventDateEnd": "2024-05-22T15:49:45.895Z"
},
"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-22T15:49:45.895Z",
"ExpiryDate": "2024-05-22T15:49:45.895Z",
"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"
}
}