This is the reference for the Commerce Cloud Platform REST API. This API is the primary way to get and modify data in Commerce, whether you are developing an app or any other integration. Use it to interact with Commerce entities, like orders, quotes, offerings, and pricing plans.

The Commerce API requires a token for authentication. Make sure to include your generated access token as an authorization header in all requests.

1
2
curl --request GET \
--url "https://api.atlassian.com/commerce/api..." \
--header "Authorization: Bearer ACCESS_TOKEN"

The Commerce API uses cursor-based pagination to limit response size for resources that may return large numbers of results. HTTP clients may specify a smaller page size of N by adding the query parameter page-size=N. The supported query parameters for pagination are:

• start-id (optional) - Specifies the starting cursor to skip entries.
• page-size (optional) - Specifies the maximum page size, the default value can vary by resource.

The response for paginated endpoints will contain the following fragment:

1
2
{
  "values" :[
    // resource object
  ],
  "nextId": <String>
}

The nextId attribute in the response payload should be used as the start-id query parameter to load entries from the next page of results.

All dates returned by the API are Unix timestamps.

All currency values are accepted, and returned, in the lowest denominator. For example, for USD all values are returned in cents, for $1.00 the returned value is 100.

The following response status codes may be accompanied by an error representation.

Error responses will contain a JSON representation like in the example below:

1
2
{
  "title": "Invalid parameter: trial",
  "code": "parameter_invalid",
  "detail": "Invalid value :123123",
  "id": "uuid",
  "status": "400"
}