Microsoft.Marketplace (stable:2020-12-01)

2025/09/26 • 10 new, 10 deleted methods

PrivateStore_QueryNotificationsState (new)
Description :  Get private store notifications state
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/queryNotificationsState
{}

⚐ Response (200)

{
stopSellNotifications:
{
Required: False ,
}
[
{
offerId:
{
Description: Gets offer id ,
Required: False ,
}
string ,
displayName:
{
Description: Gets offer display name ,
Required: False ,
}
string ,
isEntire:
{
Description: Gets a value indicating whether entire offer is in stop sell or only few of its plans ,
Required: False ,
}
boolean ,
messageCode:
{
Description: Gets or sets the notification message id ,
Format: int64 ,
Required: False ,
}
integer ,
icon:
{
Description: Gets or sets the icon url ,
Required: False ,
}
string ,
plans:
{
Description: Gets or sets removed plans notifications ,
Required: False ,
}
[
{
planId:
{
Description: Gets or sets the plan id ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Gets or sets the plan display name ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
newNotifications:
{
Required: False ,
}
[
{
offerId:
{
Description: Gets offer id ,
Required: False ,
}
string ,
displayName:
{
Description: Gets offer display name ,
Required: False ,
}
string ,
isFuturePlansEnabled:
{
Description: Gets a value indicating whether future plans is enabled. ,
Required: False ,
}
boolean ,
messageCode:
{
Description: Gets or sets the notification message id ,
Format: int64 ,
Required: False ,
}
integer ,
icon:
{
Description: Gets or sets the icon url ,
Required: False ,
}
string ,
plans:
{
Description: Gets or sets removed plans notifications ,
Required: False ,
}
[
{
planId:
{
Description: Gets or sets the plan id ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Gets or sets the plan display name ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
approvalRequests:
{
Required: False ,
}
[
{
offerId:
{
Description: Gets offer id ,
Required: False ,
}
string ,
displayName:
{
Description: Gets offer display name ,
Required: False ,
}
string ,
publisherId:
{
Description: Gets or sets publisher id ,
Required: False ,
}
string ,
messageCode:
{
Description: Gets or sets the notification message id ,
Format: int64 ,
Required: False ,
}
integer ,
icon:
{
Description: Gets or sets the icon url ,
Required: False ,
}
string ,
plans:
{
Description: Gets or sets removed plans notifications ,
Required: False ,
}
[
{
planId:
{
Description: Gets or sets the plan id ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Gets or sets the plan display name ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_AcknowledgeOfferNotification (new)
Description :  Acknowledge notification for offer
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/offers/{offerId}/acknowledgeNotification
{
payload:
{
Required: False ,
}
{
properties:
{
Description: Notification update request payload details ,
Required: False ,
}
{
acknowledge:
{
Description: Gets or sets a value indicating whether acknowledge action flag is enabled ,
Required: False ,
}
boolean ,
dismiss:
{
Description: Gets or sets a value indicating whether dismiss action flag is enabled ,
Required: False ,
}
boolean ,
removeOffer:
{
Description: Gets or sets a value indicating whether remove offer action flag is enabled ,
Required: False ,
}
boolean ,
addPlans:
{
Description: Gets or sets added plans ,
Required: False ,
}
[
string ,
]
,
removePlans:
{
Description: Gets or sets remove plans ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_GetApprovalRequestsList (new)
Description :  Get all open approval requests of current user
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/requestApprovals
{}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The privateStore approval request data structure. ,
Required: False ,
}
{
offerId:
{
Description: Gets or sets unique offer id. ,
Required: False ,
}
string ,
offerDisplayName:
{
Description: Gets offer display name ,
Required: False ,
}
string ,
publisherId:
{
Description: The offer's publisher id ,
Required: False ,
}
string ,
plansDetails:
{
Description: Gets or sets the plans details ,
Required: False ,
}
[
{
planId:
{
Description: Gets or sets Plan Id ,
Required: False ,
}
string ,
status:
{
Description: Gets the plan status ,
Enum:
{
Pending: No description available. ,
Rejected: No description available. ,
Approved: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
requestDate:
{
Description: Gets request date ,
Format: date-time ,
Required: False ,
}
string ,
justification:
{
Description: Gets or sets user's justification for the plan's request ,
Required: False ,
}
string ,
}
,
]
,
isClosed:
{
Description: Gets a value indicating whether the request is closed ,
Required: False ,
}
boolean ,
messageCode:
{
Description: Gets or sets the request approval message code ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of notifications list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_GetRequestApproval (new)
Description :  Get open request approval details
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/requestApprovals/{requestApprovalId}
{}

⚐ Response (200)

{
properties:
{
Description: The privateStore approval request data structure. ,
Required: False ,
}
{
offerId:
{
Description: Gets or sets unique offer id. ,
Required: False ,
}
string ,
offerDisplayName:
{
Description: Gets offer display name ,
Required: False ,
}
string ,
publisherId:
{
Description: The offer's publisher id ,
Required: False ,
}
string ,
plansDetails:
{
Description: Gets or sets the plans details ,
Required: False ,
}
[
{
planId:
{
Description: Gets or sets Plan Id ,
Required: False ,
}
string ,
status:
{
Description: Gets the plan status ,
Enum:
{
Pending: No description available. ,
Rejected: No description available. ,
Approved: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
requestDate:
{
Description: Gets request date ,
Format: date-time ,
Required: False ,
}
string ,
justification:
{
Description: Gets or sets user's justification for the plan's request ,
Required: False ,
}
string ,
}
,
]
,
isClosed:
{
Description: Gets a value indicating whether the request is closed ,
Required: False ,
}
boolean ,
messageCode:
{
Description: Gets or sets the request approval message code ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_CreateApprovalRequest (new)
Description :  Create approval request
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/requestApprovals/{requestApprovalId}
{
payload:
{
Required: False ,
}
{
properties:
{
Description: The privateStore approval request data structure. ,
Required: False ,
}
{
offerId:
{
Description: Gets or sets unique offer id. ,
Required: False ,
}
string ,
offerDisplayName:
{
Description: Gets offer display name ,
Required: False ,
}
string ,
publisherId:
{
Description: The offer's publisher id ,
Required: False ,
}
string ,
plansDetails:
{
Description: Gets or sets the plans details ,
Required: False ,
}
[
{
planId:
{
Description: Gets or sets Plan Id ,
Required: False ,
}
string ,
status:
{
Description: Gets the plan status ,
Enum:
{
Pending: No description available. ,
Rejected: No description available. ,
Approved: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
requestDate:
{
Description: Gets request date ,
Format: date-time ,
Required: False ,
}
string ,
justification:
{
Description: Gets or sets user's justification for the plan's request ,
Required: False ,
}
string ,
}
,
]
,
isClosed:
{
Description: Gets a value indicating whether the request is closed ,
Required: False ,
}
boolean ,
messageCode:
{
Description: Gets or sets the request approval message code ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The privateStore approval request data structure. ,
Required: False ,
}
{
offerId:
{
Description: Gets or sets unique offer id. ,
Required: False ,
}
string ,
offerDisplayName:
{
Description: Gets offer display name ,
Required: False ,
}
string ,
publisherId:
{
Description: The offer's publisher id ,
Required: False ,
}
string ,
plansDetails:
{
Description: Gets or sets the plans details ,
Required: False ,
}
[
{
planId:
{
Description: Gets or sets Plan Id ,
Required: False ,
}
string ,
status:
{
Description: Gets the plan status ,
Enum:
{
Pending: No description available. ,
Rejected: No description available. ,
Approved: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
requestDate:
{
Description: Gets request date ,
Format: date-time ,
Required: False ,
}
string ,
justification:
{
Description: Gets or sets user's justification for the plan's request ,
Required: False ,
}
string ,
}
,
]
,
isClosed:
{
Description: Gets a value indicating whether the request is closed ,
Required: False ,
}
boolean ,
messageCode:
{
Description: Gets or sets the request approval message code ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_QueryRequestApproval (new)
Description :  Get request statuses foreach plan, this api is used as a complex GET action.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/requestApprovals/{requestApprovalId}/query
{
payload:
{
Required: False ,
}
{
properties:
{
Description: The details to get the request plans statuses ,
Required: False ,
}
{
publisherId:
{
Description: The offer's publisher id ,
Required: False ,
}
string ,
planIds:
{
Description: Current plans list ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
uniqueOfferId:
{
Description: Gets or sets unique offer id. ,
Required: False ,
}
string ,
plansDetails:
{
Description: Gets or sets the plans details ,
Required: False ,
}
object ,
etag:
{
Description: Gets or sets e-tag field ,
Required: False ,
}
string ,
messageCode:
{
Description: Gets or sets the notification message id ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_WithdrawPlan (new)
Description :  Withdraw a user request approval on specific plan
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/requestApprovals/{requestApprovalId}/withdrawPlan
{
payload:
{
Required: False ,
}
{
properties:
{
Description: Withdraw properties details ,
Required: False ,
}
{
planId:
{
Description: Gets or sets Plan Id ,
Required: False ,
}
string ,
publisherId:
{
Description: The offer's publisher id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_AdminRequestApprovalsList (new)
Description :  Get list of admin request approvals
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/adminRequestApprovals
{}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The privateStore admin Approval request data structure. ,
Required: False ,
}
{
offerId:
{
Description: Gets or sets offer Id ,
Required: False ,
}
string ,
displayName:
{
Description: Gets display name ,
Required: False ,
}
string ,
publisherId:
{
Description: Gets or sets publisher Id ,
Required: False ,
}
string ,
adminAction:
{
Description: Gets or sets admin action ,
Enum:
{
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
approvedPlans:
{
Description: Gets or sets Approved plans ids, empty in case of rejected ,
Required: False ,
}
[
string ,
]
,
comment:
{
Description: Gets or sets admin comment ,
Required: False ,
}
string ,
administrator:
{
Description: Gets or sets admin details ,
Required: False ,
}
string ,
plans:
{
Description: Gets list of plans with requesters details ,
Required: False ,
}
[
{
planId:
{
Description: Gets the plan id ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Gets the plan display name ,
Required: False ,
}
string ,
requesters:
{
Description: Gets requesters details list ,
Required: False ,
}
[
{
user:
{
Description: Gets user id ,
Required: False ,
}
string ,
date:
{
Description: Gets request date ,
Required: False ,
}
string ,
justification:
{
Description: Gets justification ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of notifications list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_GetAdminRequestApproval (new)
Description :  Get open approval requests
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/adminRequestApprovals/{adminRequestApprovalId}
{
publisherId:
{
Description: The publisher id of this offer. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The privateStore admin Approval request data structure. ,
Required: False ,
}
{
offerId:
{
Description: Gets or sets offer Id ,
Required: False ,
}
string ,
displayName:
{
Description: Gets display name ,
Required: False ,
}
string ,
publisherId:
{
Description: Gets or sets publisher Id ,
Required: False ,
}
string ,
adminAction:
{
Description: Gets or sets admin action ,
Enum:
{
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
approvedPlans:
{
Description: Gets or sets Approved plans ids, empty in case of rejected ,
Required: False ,
}
[
string ,
]
,
comment:
{
Description: Gets or sets admin comment ,
Required: False ,
}
string ,
administrator:
{
Description: Gets or sets admin details ,
Required: False ,
}
string ,
plans:
{
Description: Gets list of plans with requesters details ,
Required: False ,
}
[
{
planId:
{
Description: Gets the plan id ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Gets the plan display name ,
Required: False ,
}
string ,
requesters:
{
Description: Gets requesters details list ,
Required: False ,
}
[
{
user:
{
Description: Gets user id ,
Required: False ,
}
string ,
date:
{
Description: Gets request date ,
Required: False ,
}
string ,
justification:
{
Description: Gets justification ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_UpdateAdminRequestApproval (new)
Description :  Update the admin action, weather the request is approved or rejected and the approved plans
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/adminRequestApprovals/{adminRequestApprovalId}
{
payload:
{
Required: False ,
}
{
properties:
{
Description: The privateStore admin Approval request data structure. ,
Required: False ,
}
{
offerId:
{
Description: Gets or sets offer Id ,
Required: False ,
}
string ,
displayName:
{
Description: Gets display name ,
Required: False ,
}
string ,
publisherId:
{
Description: Gets or sets publisher Id ,
Required: False ,
}
string ,
adminAction:
{
Description: Gets or sets admin action ,
Enum:
{
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
approvedPlans:
{
Description: Gets or sets Approved plans ids, empty in case of rejected ,
Required: False ,
}
[
string ,
]
,
comment:
{
Description: Gets or sets admin comment ,
Required: False ,
}
string ,
administrator:
{
Description: Gets or sets admin details ,
Required: False ,
}
string ,
plans:
{
Description: Gets list of plans with requesters details ,
Required: False ,
}
[
{
planId:
{
Description: Gets the plan id ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Gets the plan display name ,
Required: False ,
}
string ,
requesters:
{
Description: Gets requesters details list ,
Required: False ,
}
[
{
user:
{
Description: Gets user id ,
Required: False ,
}
string ,
date:
{
Description: Gets request date ,
Required: False ,
}
string ,
justification:
{
Description: Gets justification ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The privateStore admin Approval request data structure. ,
Required: False ,
}
{
offerId:
{
Description: Gets or sets offer Id ,
Required: False ,
}
string ,
displayName:
{
Description: Gets display name ,
Required: False ,
}
string ,
publisherId:
{
Description: Gets or sets publisher Id ,
Required: False ,
}
string ,
adminAction:
{
Description: Gets or sets admin action ,
Enum:
{
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
approvedPlans:
{
Description: Gets or sets Approved plans ids, empty in case of rejected ,
Required: False ,
}
[
string ,
]
,
comment:
{
Description: Gets or sets admin comment ,
Required: False ,
}
string ,
administrator:
{
Description: Gets or sets admin details ,
Required: False ,
}
string ,
plans:
{
Description: Gets list of plans with requesters details ,
Required: False ,
}
[
{
planId:
{
Description: Gets the plan id ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Gets the plan display name ,
Required: False ,
}
string ,
requesters:
{
Description: Gets requesters details list ,
Required: False ,
}
[
{
user:
{
Description: Gets user id ,
Required: False ,
}
string ,
date:
{
Description: Gets request date ,
Required: False ,
}
string ,
justification:
{
Description: Gets justification ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_QueryNotificationsState (removed)
Description :  Get private store notifications state
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/queryNotificationsState
{}

⚐ Response (200)

{
stopSellNotifications:
{
Required: False ,
}
[
{
offerId:
{
Description: Gets offer id ,
Required: False ,
}
string ,
displayName:
{
Description: Gets offer display name ,
Required: False ,
}
string ,
isEntire:
{
Description: Gets a value indicating whether entire offer is in stop sell or only few of its plans ,
Required: False ,
}
boolean ,
messageCode:
{
Description: Gets or sets the notification message id ,
Format: int64 ,
Required: False ,
}
integer ,
icon:
{
Description: Gets or sets the icon url ,
Required: False ,
}
string ,
plans:
{
Description: Gets or sets removed plans notifications ,
Required: False ,
}
[
{
planId:
{
Description: Gets or sets the plan id ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Gets or sets the plan display name ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
newNotifications:
{
Required: False ,
}
[
{
offerId:
{
Description: Gets offer id ,
Required: False ,
}
string ,
displayName:
{
Description: Gets offer display name ,
Required: False ,
}
string ,
isFuturePlansEnabled:
{
Description: Gets a value indicating whether future plans is enabled. ,
Required: False ,
}
boolean ,
messageCode:
{
Description: Gets or sets the notification message id ,
Format: int64 ,
Required: False ,
}
integer ,
icon:
{
Description: Gets or sets the icon url ,
Required: False ,
}
string ,
plans:
{
Description: Gets or sets removed plans notifications ,
Required: False ,
}
[
{
planId:
{
Description: Gets or sets the plan id ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Gets or sets the plan display name ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
approvalRequests:
{
Required: False ,
}
[
{
offerId:
{
Description: Gets offer id ,
Required: False ,
}
string ,
displayName:
{
Description: Gets offer display name ,
Required: False ,
}
string ,
publisherId:
{
Description: Gets or sets publisher id ,
Required: False ,
}
string ,
messageCode:
{
Description: Gets or sets the notification message id ,
Format: int64 ,
Required: False ,
}
integer ,
icon:
{
Description: Gets or sets the icon url ,
Required: False ,
}
string ,
plans:
{
Description: Gets or sets removed plans notifications ,
Required: False ,
}
[
{
planId:
{
Description: Gets or sets the plan id ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Gets or sets the plan display name ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_AcknowledgeOfferNotification (removed)
Description :  Acknowledge notification for offer
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/offers/{offerId}/acknowledgeNotification
{
payload:
{
Required: False ,
}
{
properties:
{
Description: Notification update request payload details ,
Required: False ,
}
{
acknowledge:
{
Description: Gets or sets a value indicating whether acknowledge action flag is enabled ,
Required: False ,
}
boolean ,
dismiss:
{
Description: Gets or sets a value indicating whether dismiss action flag is enabled ,
Required: False ,
}
boolean ,
removeOffer:
{
Description: Gets or sets a value indicating whether remove offer action flag is enabled ,
Required: False ,
}
boolean ,
addPlans:
{
Description: Gets or sets added plans ,
Required: False ,
}
[
string ,
]
,
removePlans:
{
Description: Gets or sets remove plans ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_GetApprovalRequestsList (removed)
Description :  Get all open approval requests of current user
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/requestApprovals
{}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The privateStore approval request data structure. ,
Required: False ,
}
{
offerId:
{
Description: Gets or sets unique offer id. ,
Required: False ,
}
string ,
offerDisplayName:
{
Description: Gets offer display name ,
Required: False ,
}
string ,
publisherId:
{
Description: The offer's publisher id ,
Required: False ,
}
string ,
plansDetails:
{
Description: Gets or sets the plans details ,
Required: False ,
}
[
{
planId:
{
Description: Gets or sets Plan Id ,
Required: False ,
}
string ,
status:
{
Description: Gets the plan status ,
Enum:
{
Pending: No description available. ,
Rejected: No description available. ,
Approved: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
requestDate:
{
Description: Gets request date ,
Format: date-time ,
Required: False ,
}
string ,
justification:
{
Description: Gets or sets user's justification for the plan's request ,
Required: False ,
}
string ,
}
,
]
,
isClosed:
{
Description: Gets a value indicating whether the request is closed ,
Required: False ,
}
boolean ,
messageCode:
{
Description: Gets or sets the request approval message code ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of notifications list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_GetRequestApproval (removed)
Description :  Get open request approval details
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/requestApprovals/{requestApprovalId}
{}

⚐ Response (200)

{
properties:
{
Description: The privateStore approval request data structure. ,
Required: False ,
}
{
offerId:
{
Description: Gets or sets unique offer id. ,
Required: False ,
}
string ,
offerDisplayName:
{
Description: Gets offer display name ,
Required: False ,
}
string ,
publisherId:
{
Description: The offer's publisher id ,
Required: False ,
}
string ,
plansDetails:
{
Description: Gets or sets the plans details ,
Required: False ,
}
[
{
planId:
{
Description: Gets or sets Plan Id ,
Required: False ,
}
string ,
status:
{
Description: Gets the plan status ,
Enum:
{
Pending: No description available. ,
Rejected: No description available. ,
Approved: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
requestDate:
{
Description: Gets request date ,
Format: date-time ,
Required: False ,
}
string ,
justification:
{
Description: Gets or sets user's justification for the plan's request ,
Required: False ,
}
string ,
}
,
]
,
isClosed:
{
Description: Gets a value indicating whether the request is closed ,
Required: False ,
}
boolean ,
messageCode:
{
Description: Gets or sets the request approval message code ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_CreateApprovalRequest (removed)
Description :  Create approval request
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/requestApprovals/{requestApprovalId}
{
payload:
{
Required: False ,
}
{
properties:
{
Description: The privateStore approval request data structure. ,
Required: False ,
}
{
offerId:
{
Description: Gets or sets unique offer id. ,
Required: False ,
}
string ,
offerDisplayName:
{
Description: Gets offer display name ,
Required: False ,
}
string ,
publisherId:
{
Description: The offer's publisher id ,
Required: False ,
}
string ,
plansDetails:
{
Description: Gets or sets the plans details ,
Required: False ,
}
[
{
planId:
{
Description: Gets or sets Plan Id ,
Required: False ,
}
string ,
status:
{
Description: Gets the plan status ,
Enum:
{
Pending: No description available. ,
Rejected: No description available. ,
Approved: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
requestDate:
{
Description: Gets request date ,
Format: date-time ,
Required: False ,
}
string ,
justification:
{
Description: Gets or sets user's justification for the plan's request ,
Required: False ,
}
string ,
}
,
]
,
isClosed:
{
Description: Gets a value indicating whether the request is closed ,
Required: False ,
}
boolean ,
messageCode:
{
Description: Gets or sets the request approval message code ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The privateStore approval request data structure. ,
Required: False ,
}
{
offerId:
{
Description: Gets or sets unique offer id. ,
Required: False ,
}
string ,
offerDisplayName:
{
Description: Gets offer display name ,
Required: False ,
}
string ,
publisherId:
{
Description: The offer's publisher id ,
Required: False ,
}
string ,
plansDetails:
{
Description: Gets or sets the plans details ,
Required: False ,
}
[
{
planId:
{
Description: Gets or sets Plan Id ,
Required: False ,
}
string ,
status:
{
Description: Gets the plan status ,
Enum:
{
Pending: No description available. ,
Rejected: No description available. ,
Approved: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
requestDate:
{
Description: Gets request date ,
Format: date-time ,
Required: False ,
}
string ,
justification:
{
Description: Gets or sets user's justification for the plan's request ,
Required: False ,
}
string ,
}
,
]
,
isClosed:
{
Description: Gets a value indicating whether the request is closed ,
Required: False ,
}
boolean ,
messageCode:
{
Description: Gets or sets the request approval message code ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_QueryRequestApproval (removed)
Description :  Get request statuses foreach plan, this api is used as a complex GET action.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/requestApprovals/{requestApprovalId}/query
{
payload:
{
Required: False ,
}
{
properties:
{
Description: The details to get the request plans statuses ,
Required: False ,
}
{
publisherId:
{
Description: The offer's publisher id ,
Required: False ,
}
string ,
planIds:
{
Description: Current plans list ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
uniqueOfferId:
{
Description: Gets or sets unique offer id. ,
Required: False ,
}
string ,
plansDetails:
{
Description: Gets or sets the plans details ,
Required: False ,
}
object ,
etag:
{
Description: Gets or sets e-tag field ,
Required: False ,
}
string ,
messageCode:
{
Description: Gets or sets the notification message id ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_WithdrawPlan (removed)
Description :  Withdraw a user request approval on specific plan
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/requestApprovals/{requestApprovalId}/withdrawPlan
{
payload:
{
Required: False ,
}
{
properties:
{
Description: Withdraw properties details ,
Required: False ,
}
{
planId:
{
Description: Gets or sets Plan Id ,
Required: False ,
}
string ,
publisherId:
{
Description: The offer's publisher id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_AdminRequestApprovalsList (removed)
Description :  Get list of admin request approvals
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/adminRequestApprovals
{}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The privateStore admin Approval request data structure. ,
Required: False ,
}
{
offerId:
{
Description: Gets or sets offer Id ,
Required: False ,
}
string ,
displayName:
{
Description: Gets display name ,
Required: False ,
}
string ,
publisherId:
{
Description: Gets or sets publisher Id ,
Required: False ,
}
string ,
adminAction:
{
Description: Gets or sets admin action ,
Enum:
{
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
approvedPlans:
{
Description: Gets or sets Approved plans ids, empty in case of rejected ,
Required: False ,
}
[
string ,
]
,
comment:
{
Description: Gets or sets admin comment ,
Required: False ,
}
string ,
administrator:
{
Description: Gets or sets admin details ,
Required: False ,
}
string ,
plans:
{
Description: Gets list of plans with requesters details ,
Required: False ,
}
[
{
planId:
{
Description: Gets the plan id ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Gets the plan display name ,
Required: False ,
}
string ,
requesters:
{
Description: Gets requesters details list ,
Required: False ,
}
[
{
user:
{
Description: Gets user id ,
Required: False ,
}
string ,
date:
{
Description: Gets request date ,
Required: False ,
}
string ,
justification:
{
Description: Gets justification ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of notifications list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_GetAdminRequestApproval (removed)
Description :  Get open approval requests
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/adminRequestApprovals/{adminRequestApprovalId}
{
publisherId:
{
Description: The publisher id of this offer. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The privateStore admin Approval request data structure. ,
Required: False ,
}
{
offerId:
{
Description: Gets or sets offer Id ,
Required: False ,
}
string ,
displayName:
{
Description: Gets display name ,
Required: False ,
}
string ,
publisherId:
{
Description: Gets or sets publisher Id ,
Required: False ,
}
string ,
adminAction:
{
Description: Gets or sets admin action ,
Enum:
{
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
approvedPlans:
{
Description: Gets or sets Approved plans ids, empty in case of rejected ,
Required: False ,
}
[
string ,
]
,
comment:
{
Description: Gets or sets admin comment ,
Required: False ,
}
string ,
administrator:
{
Description: Gets or sets admin details ,
Required: False ,
}
string ,
plans:
{
Description: Gets list of plans with requesters details ,
Required: False ,
}
[
{
planId:
{
Description: Gets the plan id ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Gets the plan display name ,
Required: False ,
}
string ,
requesters:
{
Description: Gets requesters details list ,
Required: False ,
}
[
{
user:
{
Description: Gets user id ,
Required: False ,
}
string ,
date:
{
Description: Gets request date ,
Required: False ,
}
string ,
justification:
{
Description: Gets justification ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_UpdateAdminRequestApproval (removed)
Description :  Update the admin action, weather the request is approved or rejected and the approved plans
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/adminRequestApprovals/{adminRequestApprovalId}
{
payload:
{
Required: False ,
}
{
properties:
{
Description: The privateStore admin Approval request data structure. ,
Required: False ,
}
{
offerId:
{
Description: Gets or sets offer Id ,
Required: False ,
}
string ,
displayName:
{
Description: Gets display name ,
Required: False ,
}
string ,
publisherId:
{
Description: Gets or sets publisher Id ,
Required: False ,
}
string ,
adminAction:
{
Description: Gets or sets admin action ,
Enum:
{
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
approvedPlans:
{
Description: Gets or sets Approved plans ids, empty in case of rejected ,
Required: False ,
}
[
string ,
]
,
comment:
{
Description: Gets or sets admin comment ,
Required: False ,
}
string ,
administrator:
{
Description: Gets or sets admin details ,
Required: False ,
}
string ,
plans:
{
Description: Gets list of plans with requesters details ,
Required: False ,
}
[
{
planId:
{
Description: Gets the plan id ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Gets the plan display name ,
Required: False ,
}
string ,
requesters:
{
Description: Gets requesters details list ,
Required: False ,
}
[
{
user:
{
Description: Gets user id ,
Required: False ,
}
string ,
date:
{
Description: Gets request date ,
Required: False ,
}
string ,
justification:
{
Description: Gets justification ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The privateStore admin Approval request data structure. ,
Required: False ,
}
{
offerId:
{
Description: Gets or sets offer Id ,
Required: False ,
}
string ,
displayName:
{
Description: Gets display name ,
Required: False ,
}
string ,
publisherId:
{
Description: Gets or sets publisher Id ,
Required: False ,
}
string ,
adminAction:
{
Description: Gets or sets admin action ,
Enum:
{
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
approvedPlans:
{
Description: Gets or sets Approved plans ids, empty in case of rejected ,
Required: False ,
}
[
string ,
]
,
comment:
{
Description: Gets or sets admin comment ,
Required: False ,
}
string ,
administrator:
{
Description: Gets or sets admin details ,
Required: False ,
}
string ,
plans:
{
Description: Gets list of plans with requesters details ,
Required: False ,
}
[
{
planId:
{
Description: Gets the plan id ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Gets the plan display name ,
Required: False ,
}
string ,
requesters:
{
Description: Gets requesters details list ,
Required: False ,
}
[
{
user:
{
Description: Gets user id ,
Required: False ,
}
string ,
date:
{
Description: Gets request date ,
Required: False ,
}
string ,
justification:
{
Description: Gets justification ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}