Platform
Atlassian Marketplace / Reference / Marketplace REST API (v2)

Promotions (Removed)

Postman Collection
OpenAPI

Information about vendor promotions

Operations
GET/vendors/{vendorId}/promotionsPOST/vendors/{vendorId}/promotionsGET/vendors/{vendorId}/promotions/{promotionId}PATCH/vendors/{vendorId}/promotions/{promotionId}GET/vendors/{vendorId}/promotions/{promotionId}/codesPOST/vendors/{vendorId}/promotions/{promotionId}/codesGET/vendors/{vendorId}/promotions/{promotionId}/codes/{promotionCode}DEL/vendors/{vendorId}/promotions/{promotionId}/codes/{promotionCode}GET/vendors/{vendorId}/promotions/{promotionId}/status
GET

Get promotionsDeprecated

Get a list of promotions for the specified vendor.

This resource requires authentication.

This is a deprecated API. Refer Get promotions for the new API details

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

vendorId

integer

Required

Responses

application/json

PromotionList
GET/vendors/{vendorId}/promotions
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/promotions' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" } }, "promotions": [ { "_links": { "self": { "href": "<string>" }, "edit": { "href": "<string>" }, "status": { "href": "<string>" }, "codes": { "href": "<string>" }, "usage": { "href": "<string>" } }, "name": "<string>", "products": [ "<string>" ], "startDate": "<string>", "expirationDate": "<string>", "endImmediatelyDate": "<string>", "status": "ACTIVE", "usageType": "MULTI", "discountType": "FLAT", "discount": [ { "pricingItemId": "<string>", "discountAmount": 43 } ], "discountPercent": 71, "appliesToAllLicenseTypes": true, "maxUses": 78, "used": 44, "hosting": "<string>" } ] }
POST

Create promotionDeprecated

Create a new promotion for the specified vendor.

This resource requires authentication.

This is a deprecated API. Refer Create promotion for the new API details

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

vendorId

integer

Required

Request bodyapplication/json

_links

PromotionLinks

name

string

Required
products

array<string>

Required
startDate

string

expirationDate

string

Required
status

string

usageType

string

Required
discountType

string

Required
discountPercent

integer

appliesToAllLicenseTypes

boolean

Responses

Successfully created

Headers

Location

string

POST/vendors/{vendorId}/promotions
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 curl --request POST \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/promotions' \ --user 'email@example.com:<api_token>' \ --header 'Content-Type: application/json' \ --data '{ "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "edit": { "href": "<string>", "type": "<string>", "title": "<string>" }, "status": { "href": "<string>", "type": "<string>", "title": "<string>" }, "codes": { "href": "<string>", "type": "<string>", "title": "<string>" }, "usage": { "href": "<string>", "type": "<string>", "title": "<string>" } }, "name": "<string>", "products": [ "<string>" ], "startDate": "<string>", "expirationDate": "<string>", "status": "ACTIVE", "usageType": "MULTI", "discountType": "FLAT", "discountPercent": 71, "appliesToAllLicenseTypes": true, "maxUses": 78, "hosting": "<string>" }'
GET

Get promotionDeprecated

Get a specific promotion for the specified vendor.

This resource requires authentication.

This is a deprecated API. Refer Get promotion for the new API details

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

vendorId

integer

Required
promotionId

string

Required

Responses

application/json

Promotion
GET/vendors/{vendorId}/promotions/{promotionId}
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/promotions/{promotionId}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "edit": { "href": "<string>", "type": "<string>", "title": "<string>" }, "status": { "href": "<string>", "type": "<string>", "title": "<string>" }, "codes": { "href": "<string>", "type": "<string>", "title": "<string>" }, "usage": { "href": "<string>", "type": "<string>", "title": "<string>" } }, "name": "<string>", "products": [ "<string>" ], "startDate": "<string>", "expirationDate": "<string>", "endImmediatelyDate": "<string>", "status": "ACTIVE", "usageType": "MULTI", "discountType": "FLAT", "discount": [ { "pricingItemId": "<string>", "discountAmount": 43 } ], "discountPercent": 71, "appliesToAllLicenseTypes": true, "maxUses": 78, "used": 44, "hosting": "<string>" }
PATCH

Update promotionDeprecated

Update a specific promotion for the specified vendor.

The request body must be a valid JSON Patch document. The properties which can be referenced in the PATCH are the same ones returned by a GET on this URI.

This resource requires authentication.

This is a deprecated API. Refer Update promotion for the new API details

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

vendorId

integer

Required
promotionId

string

Required

Request bodyapplication/json-patch+json

The request body must be a valid JSON Patch document. The properties which can be referenced in the PATCH are the same ones returned by a GET on this URI.

array<JsonPatchDocumentation>

op

string

Required
path

string

Required
value

object

from

string

Responses

Successfully modified

Headers

Location

string

PATCH/vendors/{vendorId}/promotions/{promotionId}
1 2 3 curl --request PATCH \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/promotions/{promotionId}' \ --user 'email@example.com:<api_token>'
GET

Get promotion codesDeprecated

Get a list of single-use codes for the specified promotion.

This resource requires authentication.

This is a deprecated API. Refer Get promotion codes for the new API details

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

vendorId

integer

Required
promotionId

string

Required

Responses

application/json

PromotionCodeList
GET/vendors/{vendorId}/promotions/{promotionId}/codes
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/promotions/{promotionId}/codes' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" } }, "codes": [ { "_links": { "self": { "href": "<string>" }, "usage": { "href": "<string>" } }, "code": "<string>", "created": "<string>", "usage": { "date": "<string>", "order": 60, "name": "<string>", "email": "<string>", "products": [ { "key": "<string>", "edition": "<string>" } ] } } ] }
POST

Create promotion codeDeprecated

Create a new single-use code for the specified promotion.

This resource requires authentication.

This is a deprecated API. Refer Create promotion code for the new API details

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

vendorId

integer

Required
promotionId

string

Required

Responses

application/json

PromotionCode
POST/vendors/{vendorId}/promotions/{promotionId}/codes
1 2 3 4 curl --request POST \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/promotions/{promotionId}/codes' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "usage": { "href": "<string>", "type": "<string>", "title": "<string>" } }, "code": "<string>", "created": "<string>", "usage": { "date": "<string>", "order": 60, "name": "<string>", "email": "<string>", "products": [ { "key": "<string>", "edition": "<string>", "sen": "<string>" } ] } }
GET

Get promotion codeDeprecated

Get a specific single-use code for the specified promotion.

This resource requires authentication.

This is a deprecated API. Refer Get promotion code for the new API details

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

vendorId

integer

Required
promotionId

string

Required
promotionCode

string

Required

Responses

application/json

PromotionCode
GET/vendors/{vendorId}/promotions/{promotionId}/codes/{promotionCode}
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/promotions/{promotionId}/codes/{promotionCode}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "usage": { "href": "<string>", "type": "<string>", "title": "<string>" } }, "code": "<string>", "created": "<string>", "usage": { "date": "<string>", "order": 60, "name": "<string>", "email": "<string>", "products": [ { "key": "<string>", "edition": "<string>", "sen": "<string>" } ] } }
DEL

Delete promotion codeDeprecated

Delete a specific single-use code for a specific promotion associated with a specific vendor.

Promotion codes can only be deleted prior to their use.

This resource requires authentication.

This is a deprecated API. Refer Delete promotion code for the new API details

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

vendorId

integer

Required
promotionId

string

Required
promotionCode

string

Required

Responses

Successfully deleted

DEL/vendors/{vendorId}/promotions/{promotionId}/codes/{promotionCode}
1 2 3 curl --request DELETE \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/promotions/{promotionId}/codes/{promotionCode}' \ --user 'email@example.com:<api_token>'
GET

Get promotion statusDeprecated

Get a specific promotion status for the specified vendor.

This resource requires authentication.

This is a deprecated API. Refer Get promotion status for the new API details

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

vendorId

integer

Required
promotionId

string

Required

Responses

application/json

string

GET/vendors/{vendorId}/promotions/{promotionId}/status
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/promotions/{promotionId}/status' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 "ACTIVE"

Rate this page: