Rate this page:
Information about vendors
Get a list of vendors matching the specified parameters.
boolean
boolean
string
integer
integer
1
2
3
curl --request GET \
--url 'https://marketplace.atlassian.com/rest/2/vendors' \
--header 'Accept: application/json'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>"
},
"query": {
"template": "<string>",
"type": "<string>",
"name": "<string>"
},
"next": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"prev": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"vendors": [
{
"href": "<string>",
"type": "<string>",
"title": "<string>"
}
]
},
"_embedded": {
"vendors": [
{
"_links": {
"self": {
"href": "<string>"
},
"alternate": {
"href": "<string>"
}
},
"_embedded": {},
"name": "<string>",
"verifiedStatus": "flagged",
"programs": {},
"isAtlassian": true
}
]
},
"count": 48
}Create a new vendor. This resource requires authentication.
VendorLinks
RequiredVendorEmbedded
string
Requiredstring
Address
string
Requiredstring
VendorExternalLinks
RequiredVendorSupportDetails
Requiredstring
Successfully created
string
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
}'Get a specific vendor.
integer
RequiredDetailed information about a vendor
1
2
3
curl --request GET \
--url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}' \
--header 'Accept: application/json'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
142
143
144
145
{
"_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>",
"id": 16,
"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>",
"verifiedStatus": "flagged",
"programs": {
"topVendor": {
"status": "approved"
}
},
"cloudSecurity": {
"approved": true,
"issueKey": "<string>",
"approvalDate": "<string>",
"expiryDate": "<string>"
},
"solutionPartner": {
"partnerLevel": "Gold"
},
"isAtlassian": true
}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.
integer
RequiredThe 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>
string
Requiredstring
Requiredobject
string
Successfully modified
string
1
2
3
curl --request PATCH \
--url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}' \
--user 'email@example.com:<api_token>'Get a list of contacts for the specified vendor.
integer
Required1
2
3
curl --request GET \
--url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/contacts' \
--header 'Accept: application/json'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
{
"_links": {
"self": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
}
},
"contacts": [
{
"_links": {
"self": {
"href": "<string>"
},
"alternate": {
"href": "<string>"
}
},
"username": "<string>",
"displayName": "<string>",
"email": "<string>",
"permissions": [
"administer-vendor"
],
"roles": [
"primary"
]
}
],
"count": 28
}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.
integer
RequiredVendorContactLinks
string
array<string>
array<string>
Successfully created
string
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
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"
],
"roles": [
"primary"
]
}'Get a specific contact for the specified vendor. This resource requires authentication.
integer
Requiredinteger
Required1
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'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
"_links": {
"self": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"alternate": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
}
},
"username": "<string>",
"displayName": "<string>",
"email": "<string>",
"permissions": [
"administer-vendor"
],
"roles": [
"primary"
]
}Removes the user from the vendor's list of contacts. This resource does not remove the user's Marketplace account.
This resource requires authentication.
integer
Requiredinteger
RequiredSuccess
1
2
3
curl --request DELETE \
--url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/contacts/{userId}' \
--user 'email@example.com:<api_token>'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.
integer
Requiredinteger
RequiredThe 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>
string
Requiredstring
Requiredobject
string
Successfully modified
string
1
2
3
curl --request PATCH \
--url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/contacts/{userId}' \
--user 'email@example.com:<api_token>'Get the payment details for the specified vendor. This resource requires authentication.
integer
Required1
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'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
{
"_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
}
}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.
integer
RequiredSelfLinkOnly
Address
RequiredVendorPaymentContact
RequiredVendorPaymentAccount
RequiredVendorTax
RequiredSuccessfully modified
string
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
}
}'