Platform
    Atlassian Marketplace / Reference / Promotions REST API

    Promotions

    Postman Collection
    OpenAPI
    GET

    Get promotions paged

    Get a list of promotions for the specified partner in paginated way. This resource requires authentication.

    Request

    Path parameters

    partnerId

    integer

    Required

    Query parameters

    limit

    integer

    offset

    integer

    order-by

    any

    active-only

    boolean

    hosting-type

    any

    app-key

    string

    ascending

    boolean

    nextId

    string

    prevId

    string

    Responses

    application/json

    PromotionListPaginatedResponse
    GET/marketplace/catalog/partners/{partnerId}/promotions/paged
    1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/marketplace/catalog/partners/{partnerId}/promotions/paged' \ --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 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 { "_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>" } }, "id": "<string>", "name": "<string>", "eligibleApps": [ { "key": "<string>", "name": "<string>" } ], "startDate": "<string>", "expirationDate": "<string>", "endImmediatelyDate": "<string>", "creationDate": "<string>", "status": "ACTIVE", "promotionType": "SHARED_PROMOTION", "discountType": "FLAT_DISCOUNT", "discount": [ { "pricingItemId": "<string>", "discountAmount": 43 } ], "discountPercent": 71, "appliesToAllLicenseTypes": true, "maxUses": 78, "used": 44, "hostingType": "SERVER", "subscriptionType": "MONTHLY", "allowedBillingCycles": 80, "allowUnlimitedUses": true, "promotionCode": "<string>" } ], "offset": 42, "limit": 48, "totalItems": 46, "orderBy": "START_DATE", "nextId": "<string>", "prevId": "<string>" }
    GET

    Get promotions

    Get a list of promotions for the specified partner.

    This resource requires authentication.

    It is strongly recommended to use paginated API. Refer Get promotions paged

    Request

    Path parameters

    partnerId

    integer

    Required

    Responses

    application/json

    PromotionListResponse
    GET/marketplace/catalog/partners/{partnerId}/promotions
    1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/marketplace/catalog/partners/{partnerId}/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 52 53 54 55 56 57 58 59 60 { "_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>" } }, "id": "<string>", "name": "<string>", "eligibleApps": [ { "key": "<string>", "name": "<string>" } ], "startDate": "<string>", "expirationDate": "<string>", "endImmediatelyDate": "<string>", "creationDate": "<string>", "status": "ACTIVE", "promotionType": "SHARED_PROMOTION", "discountType": "FLAT_DISCOUNT", "discount": [ { "pricingItemId": "<string>", "discountAmount": 43 } ], "discountPercent": 71, "appliesToAllLicenseTypes": true, "maxUses": 78, "used": 44, "hostingType": "SERVER", "subscriptionType": "MONTHLY", "allowedBillingCycles": 80, "allowUnlimitedUses": true, "promotionCode": "<string>" } ] }
    POST

    Create promotion

    Create a new promotion for the specified partner. This resource requires authentication.

    Request

    Path parameters

    partnerId

    integer

    Required

    Request bodyapplication/json

    name

    string

    Required
    eligibleApps

    array<string>

    Required
    startDate

    string

    expirationDate

    string

    Required
    promotionType

    string

    Required
    discountType

    string

    Required
    discountPercent

    integer

    maxUses

    integer

    hostingType

    string

    Required
    subscriptionType

    string

    Responses

    Successfully created

    application/json

    CreatePromotionResponse
    POST/marketplace/catalog/partners/{partnerId}/promotions
    1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 curl --request POST \ --url 'https://api.atlassian.com/marketplace/catalog/partners/{partnerId}/promotions' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "name": "<string>", "eligibleApps": [ "<string>" ], "startDate": "<string>", "expirationDate": "<string>", "promotionType": "SHARED_PROMOTION", "discountType": "FLAT_DISCOUNT", "discountPercent": 71, "maxUses": 78, "hostingType": "SERVER", "subscriptionType": "MONTHLY", "allowedBillingCycles": 80, "allowUnlimitedUses": true, "customPromoCode": "<string>" }'
    200Response
    1 2 3 { "id": "<string>" }
    GET

    Get promotion

    Get a specific promotion for the specified partner. This resource requires authentication.

    Request

    Path parameters

    partnerId

    integer

    Required
    promotionId

    string

    Required

    Responses

    application/json

    PromotionResponse
    GET/marketplace/catalog/partners/{partnerId}/promotions/{promotionId}
    1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/marketplace/catalog/partners/{partnerId}/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 51 52 53 54 55 56 57 58 59 { "_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>" } }, "id": "<string>", "name": "<string>", "eligibleApps": [ { "key": "<string>", "name": "<string>" } ], "startDate": "<string>", "expirationDate": "<string>", "endImmediatelyDate": "<string>", "creationDate": "<string>", "status": "ACTIVE", "promotionType": "SHARED_PROMOTION", "discountType": "FLAT_DISCOUNT", "discount": [ { "pricingItemId": "<string>", "discountAmount": 43 } ], "discountPercent": 71, "appliesToAllLicenseTypes": true, "maxUses": 78, "used": 44, "hostingType": "SERVER", "subscriptionType": "MONTHLY", "allowedBillingCycles": 80, "allowUnlimitedUses": true, "promotionCode": "<string>" }
    PATCH

    Update promotion

    Update a specific promotion for the specified partner. This resource requires authentication.

    Request

    Path parameters

    partnerId

    integer

    Required
    promotionId

    string

    Required

    Request bodyapplication/json

    name

    string

    startDate

    string

    expirationDate

    string

    discountPercent

    integer

    maxUses

    integer

    allowedBillingCycles

    integer

    Responses

    Successfully modified

    PATCH/marketplace/catalog/partners/{partnerId}/promotions/{promotionId}
    1 2 3 4 5 6 7 8 9 10 11 12 curl --request PATCH \ --url 'https://api.atlassian.com/marketplace/catalog/partners/{partnerId}/promotions/{promotionId}' \ --user 'email@example.com:<api_token>' \ --header 'Content-Type: application/json' \ --data '{ "name": "<string>", "startDate": "<string>", "expirationDate": "<string>", "discountPercent": 71, "maxUses": 78, "allowedBillingCycles": 80 }'
    GET

    Get promotion codes

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

    This resource requires authentication.

    Request

    Path parameters

    partnerId

    integer

    Required
    promotionId

    string

    Required

    Responses

    application/json

    PromotionCodesResponse
    GET/marketplace/catalog/partners/{partnerId}/promotions/{promotionId}/codes
    1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/marketplace/catalog/partners/{partnerId}/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>", "orderId": 94, "name": "<string>", "email": "<string>", "apps": [ {} ], "siteUrl": "<string>", "appEntitlementId": "<string>", "appEntitlementNumber": "<string>" } } ] }
    POST

    Create promotion code

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

    This resource requires authentication.

    Request

    Path parameters

    partnerId

    integer

    Required
    promotionId

    string

    Required

    Responses

    Successfully created

    POST/marketplace/catalog/partners/{partnerId}/promotions/{promotionId}/codes
    1 2 3 curl --request POST \ --url 'https://api.atlassian.com/marketplace/catalog/partners/{partnerId}/promotions/{promotionId}/codes' \ --user 'email@example.com:<api_token>'
    GET

    Get promotion code

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

    This resource requires authentication.

    Request

    Path parameters

    partnerId

    integer

    Required
    promotionId

    string

    Required
    promotionCode

    integer

    Required

    Responses

    application/json

    PromotionCodeResponse
    GET/marketplace/catalog/partners/{partnerId}/promotions/{promotionId}/codes/{promotionCode}
    1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/marketplace/catalog/partners/{partnerId}/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 30 31 32 33 34 35 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "usage": { "href": "<string>", "type": "<string>", "title": "<string>" } }, "code": "<string>", "created": "<string>", "usage": { "date": "<string>", "orderId": 94, "name": "<string>", "email": "<string>", "apps": [ { "key": "<string>", "edition": "<string>", "sen": "<string>", "userTier": 76, "entitlementId": "<string>", "entitlementNumber": "<string>" } ], "siteUrl": "<string>", "appEntitlementId": "<string>", "appEntitlementNumber": "<string>" } }
    DEL

    Delete promotion code

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

    This resource requires authentication.

    Request

    Path parameters

    partnerId

    integer

    Required
    promotionId

    string

    Required
    promotionCode

    integer

    Required

    Responses

    Successfully deleted

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

    Get promotion status

    Get a specific promotion status for the specified partner. This resource requires authentication.

    Request

    Path parameters

    partnerId

    integer

    Required
    promotionId

    string

    Required

    Responses

    application/json

    string

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

    Rate this page: