Getting started

The Commerce REST API lets you build apps and integrations that extend and enhance the Atlassian purchasing flow.

Authentication

All Commerce REST API queries require a valid access token.

Partners can generate tokens for their apps in the Partner portal.

Once you have an access token, include your token as an Authorization header, prefixed by Bearer, on all API queries. Requests are made via api.atlassian.com domain as shown below:

1
2
curl --request GET \
--url https://api.atlassian.com/commerce/api/v2/entitlements/{entitlementId}/details \
--header 'Authorization: Bearer ACCESS_TOKEN' \
--header 'Accept: application/json'

Endpoints and requests

REST API endpoints are organized by resource type. You’ll need to use different endpoints depending on your app’s requirements.

All REST API endpoints follow this pattern:

https://api.atlassian.com/commerce/api/{version}/{resource}

• The API is versioned per endpoint. New versions are announced in the changelog.
• All REST endpoints support cursor-based pagination.
• All requests produce HTTP response status codes.

Explore the APIs

Rate limits

The REST API supports different rate limits per endpoint. You can find the specific limits in the REST API documentation - they're highlighted in the description of each endpoint.

Status and error codes

All API queries return HTTP status codes that can tell you more about the response.

401 Unauthorized

The client doesn’t have correct authentication credentials.

403 Forbidden

The server is refusing to respond. This is typically caused by incorrect transaction account ID.

404 Not Found

The requested resource wasn't found.

422 Unprocessable Entity

The request body contains semantic errors.

429 Too Many Requests

The client has exceeded the rate limit.

5xx Errors

An internal error occurred in Commerce.