Atlassian Marketplace Developer

Atlassian Marketplace Developer

Rate this page:

Vendors

Information about vendors

Get vendors

GET /rest/2/vendors

Get a list of vendors matching the specified parameters.

Request

Query parameters
excludeAtlassian

boolean

Exclude vendors associated with Atlassian

forThisUser

boolean

Only returns vendors associated with the current user

text

string

Only returns vendors with names that matches the search text

offset

integer

If specified, skips ahead by this number of items

Format: int32
limit

integer

If specified, limits the result set to this number of items

Format: int32

Example

1
2
3
curl --request GET \
  --url 'https://marketplace.atlassian.com/rest/2/vendors' \
  --header 'Accept: application/json'

Responses

Content typeValue
application/json

VendorCollection

Create vendor

POST /rest/2/vendors

Create a new vendor. This resource requires authentication.

Request

Body parameters

Detailed information about a vendor

_links Required

VendorLinks

_embedded

VendorEmbedded

name Required

string

Name of the vendor

description

string

Short introductory text that will appear on the vendor's Marketplace page

address

Address

email Required

string

The vendor's public contact email

phone

string

The vendor's public phone number

vendorLinks Required

VendorExternalLinks

supportDetails Required

VendorSupportDetails

otherContactDetails

string

Any other public contact information the vendor wishes to provide

programs

VendorPrograms

cloudSecurity

VendorCloudSecurity

solutionPartner

VendorSolutionPartner

isAtlassian

boolean

Whether this vendor is one of the Atlassian vendors

Example

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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
curl --request POST \
  --url 'https://marketplace.atlassian.com/rest/2/vendors' \
  --user 'email@example.com:<api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "_links": {
    "self": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    },
    "alternate": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    },
    "addons": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    },
    "archivedAddons": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    },
    "contacts": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    },
    "sales": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    },
    "salesReport": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    },
    "licenseReport": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    },
    "reporting": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    },
    "logo": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    },
    "edit": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    },
    "paymentInfo": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    },
    "promotions": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    }
  },
  "_embedded": {
    "logo": {
      "_links": {
        "self": {
          "href": "<string>"
        },
        "image": {
          "href": "<string>"
        },
        "unscaled": {
          "href": "<string>"
        }
      }
    }
  },
  "name": "<string>",
  "description": "<string>",
  "address": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postCode": "<string>",
    "country": "<string>"
  },
  "email": "<string>",
  "phone": "<string>",
  "vendorLinks": {
    "homePage": "<string>",
    "sla": "<string>"
  },
  "supportDetails": {
    "supportOrg": {
      "name": "<string>",
      "supportEmail": "<string>",
      "supportUrl": "<string>",
      "supportPhone": "<string>"
    },
    "targetResponseTime": 62,
    "supportHours": {
      "range": {
        "from": "<string>",
        "until": "<string>"
      },
      "timezone": "<string>",
      "days": [
        "friday"
      ],
      "holidays": [
        {
          "title": "<string>",
          "date": "<string>",
          "repeatAnnually": true
        }
      ]
    },
    "emergencyContact": "<string>"
  },
  "otherContactDetails": "<string>",
  "programs": {
    "topVendor": {}
  },
  "cloudSecurity": {
    "approved": true,
    "issueKey": "<string>"
  },
  "solutionPartner": {},
  "isAtlassian": true
}'

Responses

Successfully created

A schema has not been defined for this response code.

Header Parameters
Location

string

URI of the new resource

Get vendor

GET /rest/2/vendors/{vendorId}

Get a specific vendor.

Request

Path parameters
vendorId Required

integer

The unique identifier for this vendor

Format: int64

Example

1
2
3
curl --request GET \
  --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}' \
  --header 'Accept: application/json'

Responses

Content typeValue
application/json

Vendor

Update vendor

PATCH /rest/2/vendors/{vendorId}

Update a specific 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.

Request

Path parameters
vendorId Required

integer

The unique identifier for this vendor

Format: int64
Body parameters
Content typeValue
application/json-patch+json

Array<JsonPatchDocumentation>

Example

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

Responses

Successfully modified

Header Parameters
Location

string

URI of the resource

Get vendor contacts

GET /rest/2/vendors/{vendorId}/contacts

Get a list of contacts for the specified vendor.

Request

Path parameters
vendorId Required

integer

The unique identifier for this vendor

Format: int64

Example

1
2
3
curl --request GET \
  --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/contacts' \
  --header 'Accept: application/json'

Responses

Content typeValue
application/json

VendorContactList

Add vendor contact

POST /rest/2/vendors/{vendorId}/contacts

Adds a user as a contact associated with a specific vendor. The username property in the request body must match a user who already has an account on Marketplace.

This resource requires authentication.

Request

Path parameters
vendorId Required

integer

The unique identifier for this vendor

Format: int64
Body parameters
_links

VendorContactLinks

username

string

The user's Atlassian account username. The username is only visible to the vendor and administrators

permissions

Array<string>

The user's permissions. The permissions are only visible to the vendor administrators

Valid values: administer-vendor, manage-addon-details, manage-payment, manage-pricing, manage-promotions, manage-vendor-details, view-sales-reports, view-usage-reports

Example

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://marketplace.atlassian.com/rest/2/vendors/{vendorId}/contacts' \
  --user 'email@example.com:<api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "_links": {
    "self": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    },
    "alternate": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    }
  },
  "username": "<string>",
  "permissions": [
    "administer-vendor"
  ]
}'

Responses

Successfully created

A schema has not been defined for this response code.

Header Parameters
Location

string

URI of the new resource

Get vendor contact

GET /rest/2/vendors/{vendorId}/contacts/{userId}

Get a specific contact for the specified vendor. This resource requires authentication.

Request

Path parameters
vendorId Required

integer

The unique identifier for this vendor

Format: int64
userId Required

integer

Format: int64

Example

1
2
3
4
curl --request GET \
  --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/contacts/{userId}' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

Responses

Content typeValue
application/json

VendorContact

Delete vendor contact

DELETE /rest/2/vendors/{vendorId}/contacts/{userId}

Removes the user from the vendor's list of contacts. This resource does not remove the user's Marketplace account.

This resource requires authentication.

Request

Path parameters
vendorId Required

integer

The unique identifier for this vendor

Format: int64
userId Required

integer

Format: int64

Example

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

Responses

Success

Update vendor contact

PATCH /rest/2/vendors/{vendorId}/contacts/{userId}

Updates the permissions a particular user has in association with a particular 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.

Request

Path parameters
vendorId Required

integer

The unique identifier for this vendor

Format: int64
userId Required

integer

Format: int64
Body parameters
Content typeValue
application/json-patch+json

Array<JsonPatchDocumentation>

Example

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

Responses

Successfully modified

Header Parameters
Location

string

URI of the resource

Get payment details

GET /rest/2/vendors/{vendorId}/paymentInfo

Get the payment details for the specified vendor. This resource requires authentication.

Request

Path parameters
vendorId Required

integer

The unique identifier for this vendor

Format: int64

Example

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

Responses

Content typeValue
application/json

VendorPaymentInfo

Create / update payment details

PUT /rest/2/vendors/{vendorId}/paymentInfo

Create or update the payment details for a specific vendor.

Atlassian uses this information to send electronic payments for paid-via-Atlassian app sales. It is only required for vendors who are using the Atlassian payment and licensing system.

This resource requires authentication.

Request

Path parameters
vendorId Required

integer

The unique identifier for this vendor

Format: int64
Body parameters
_links

SelfLinkOnly

address Required

Address

contact Required

VendorPaymentContact

bankProperties Required

VendorPaymentAccount

tax Required

VendorTax

Example

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
curl --request PUT \
  --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/paymentInfo' \
  --user 'email@example.com:<api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "_links": {
    "self": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    }
  },
  "address": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postCode": "<string>",
    "country": "<string>"
  },
  "contact": {
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "phoneNumber": "<string>"
  },
  "bankProperties": {
    "accountName": "<string>",
    "accountNumberOrIban": "<string>",
    "bankName": "<string>",
    "bankCity": "<string>",
    "bankIsoCountryCode": "<string>",
    "routingNumber": "<string>",
    "bankAddress": "<string>",
    "bankState": "<string>",
    "bankPincode": "<string>",
    "swiftCode": "<string>"
  },
  "tax": {
    "abnOrTaxId": "<string>",
    "isGSTRegistered": true
  }
}'

Responses

Successfully modified

Header Parameters
Location

string

URI of the resource

Rate this page: