Skip to content

Get product by ID

Request

Security
api_key
Path
productIdstring, (uuid)required
curl -i -X GET \
  'https://apidocs.wetransact.io/_mock/openapi/api/v1.0/products/{productId}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

The requested product

Bodyapplication/json
ProductIdstring, (uuid)
Example:"c82329c5-5331-4580-96af-2d2cb6aebde9"
ProductNamestring
Example:"WeTransact"
Statusstring
Example:"Published"
Createdstring, (date-time)
Example:"2024-02-13T13:35:56Z"
ProductDescriptionstring
Example:"<p>Introducing WeTransact...</p>"
GettingStartedInstructionsstring
Example:"Getting Started Instructions"
SearchKeyword1string
Example:"Marketplace Publishing"
SearchKeyword2string
Example:"Integration"
SearchKeyword3string
Example:"Go-to-Market"
LogoUrlstring
Example:"https://xyz.blob.core.windows.net/productlogos/logo.png"
ScreenshotsArray of strings
Example:
[
  "https://xyz.blob.core.windows.net/files/screenshot.png"
]
SupportingFilesArray of objects
VideosArray of strings
Example:
[
  "https://www.youtube.com/watch?v=xyz"
]
TagLinestring
Example:"Publish and Sell on Azure Marketplace with ease!"
PrivacyPolicyUrlstring
Example:"https://www.wetransact.io/privacy"
SupportUrlstring
Example:"https://www.wetransact.io/support"
TermsAndConditionsAmendmentTextstring or null
Example:"Custom amendment text for this offer."
TermsAndConditionsTypestring
Example:"msftcontract"
PartnerCenterOfferIdstring
Example:"c82329c5-5331-4580-96af-2c2cb6aebab9"
HasUnpublishedDetailsboolean
Example:true
ProductTypestring
Example:"SaaS"
SelectedPublisherstring
Example:"EMEA"
PlansArray of objects(Plan)
SubscriptionIdsArray of strings
Example:
[
  "343ebc84-7a85-45fc-8fce-82ca0b358784"
]
IsFullyHostedInAzureboolean
Example:true
Response
{
  "ProductId": "c82329c5-5331-4580-96af-2d2cb6aebde9",
  "ProductName": "WeTransact",
  "Status": "Published",
  "Created": "2024-02-13T13:35:56Z",
  "ProductDescription": "<p>Introducing WeTransact...</p>",
  "GettingStartedInstructions": "Getting Started Instructions",
  "SearchKeyword1": "Marketplace Publishing",
  "SearchKeyword2": "Integration",
  "SearchKeyword3": "Go-to-Market",
  "LogoUrl": "https://xyz.blob.core.windows.net/productlogos/logo.png",
  "Screenshots": [
    "https://xyz.blob.core.windows.net/files/screenshot.png"
  ],
  "SupportingFiles": [
    { … }
  ],
  "Videos": [
    "https://www.youtube.com/watch?v=xyz"
  ],
  "TagLine": "Publish and Sell on Azure Marketplace with ease!",
  "PrivacyPolicyUrl": "https://www.wetransact.io/privacy",
  "SupportUrl": "https://www.wetransact.io/support",
  "TermsAndConditionsAmendmentText": "Custom amendment text for this offer.",
  "TermsAndConditionsType": "msftcontract",
  "TermsAndConditionsLink": "https://www.wetransact.io/terms",
  "PartnerCenterOfferId": "c82329c5-5331-4580-96af-2c2cb6aebab9",
  "HasUnpublishedDetails": true,
  "ProductType": "SaaS",
  "SelectedPublisher": "EMEA",
  "Plans": [
    { … }
  ],
  "SubscriptionIds": [
    "343ebc84-7a85-45fc-8fce-82ca0b358784"
  ],
  "IsFullyHostedInAzure": true,
  "Links": [
    { … }
  ]
}