• Products
  • Offerings
  • PricingPlans
  • Invoices
  • InvoiceGroups
  • Orders
  • Quotes
  • Entitlements
Platform
Commerce / Reference / REST API

Products

Postman Collection
OpenAPI

A product is a container for all catalog definitions of a product that Atlassian is making available to the market.

GET

List products

List all products

Rate limit: 600 requests per minute.

Request

Query parameters

status

string

page-size

integer

start-id

string

Responses

OK

application/json

PaginatedResponsePublicProductResponse
GET/v2/products
1 2 3 curl --request GET \ --url 'https://api.atlassian.com/commerce/api/v2/products' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 { "values": [ { "id": "<string>", "name": "<string>", "ari": "<string>", "updatedAt": 2154, "supportedBillingSystems": [ "HAMS" ], "version": 2154, "status": "DRAFT" } ], "nextId": "<string>" }
GET

Get product by ID

Rate limit: 900 requests per minute.

Request

Path parameters

id

string

Required

Responses

OK

application/json

PublicProductResponse
GET/v2/products/{id}
1 2 3 curl --request GET \ --url 'https://api.atlassian.com/commerce/api/v2/products/{id}' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 { "id": "<string>", "name": "<string>", "ari": "<string>", "updatedAt": 2154, "supportedBillingSystems": [ "HAMS" ], "version": 2154, "status": "DRAFT" }
GET

Get opt-out by product

Rate limit: 600 requests per minute.

Request

Path parameters

productId

string

Required

Responses

OK

application/json

PublicProductIgnoreRuleResponse
GET/v1/product-ignore-rule/{productId}/promotion-type/partner
1 2 3 curl --request GET \ --url 'https://api.atlassian.com/commerce/api/v1/product-ignore-rule/{productId}/promotion-type/partner' \ --header 'Accept: application/json'
200Response
1 2 3 { "ignored": true }
GET

Get products that opted out

Rate limit: 600 requests per minute.

Request

This request has no parameters.

Responses

OK

application/json

GetPublicPromotionTypeIgnoreRuleResponse
GET/v1/product-ignore-rule/promotion-type/partner
1 2 3 curl --request GET \ --url 'https://api.atlassian.com/commerce/api/v1/product-ignore-rule/promotion-type/partner' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 { "productIds": [ "<string>" ] }