Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Tackle public API

The public API from Tackle — 7 operation(s) for public.

Tackle public API is one of 25 APIs that Tackle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include public. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 9 operations across 7 paths, and defines 67 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, https://api.tackle.io.

9 operations 7 paths 67 schemas 5 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.tackle.io
Authentication
HTTP Bearer, HTTP Basic, API Key, OAuth 2.0
Resource Areas
1

Authentication & Security 4

Tackle public API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). It accepts HTTP basic authentication (BasicAuthCallback). An API key is passed in the header as subscription-key (HeaderApiKeyAuthCallback). It supports OAuth 2.0 (Oauth2AuthCallback) using the clientCredentials flow.

  • BearerAuth — The Tackle API requires a JWT for authentication. You can get this by [getting your API credentials](https://developers.tackle.io/docs/how-to-get-an-m2m-client…
  • BasicAuthCallback — Use basic for [basic HTTP authentication](https://en.wikipedia.org/wiki/Basicaccessauthentication); this is only used for callbacks
  • HeaderApiKeyAuthCallback — Use headerapikey to specify a custom HTTP request header for authentication. Requests from Tackle will use the specified HTTP header for outbound requests to y…
  • Oauth2AuthCallback — This auth-type is for oauth2 client credentials flow. We will use the clientid and clientsecret to call the tokenurl to get an access token; this is only used…

Paths & Operations 9

Across 7 paths, the API surfaces 9 operations — 5 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

public 9
POST
/api/private-offers/{id}
Update a Microsoft offer
updatePrivateOffer 2 params body → 200400401403404500
GET
/api/private-offers/{id}
Get an offer
getPrivateOffer 2 params → 200401403404500
POST
/api/private-offers
Create or import a Microsoft offer
createPrivateOffer 1 param body → 200400401403500
GET
/api/private-offers
List offers
listPrivateOffers 3 params → 200401403500
GET
/api/products
List Microsoft products
listProducts 1 param → 200401403500
GET
/api/products/{id}
Get Microsoft product details
getProductDetails 2 params → 200401403404500
POST
/api/private-offers/{id}/notifications
Create an offer notification
createPrivateOfferNotification 2 params body → 204400401403404500
GET
/api/currencies
Get Microsoft market currencies
getMarketCurrencies 1 param → 200401403500
POST
/api/currencies/convert
Convert currencies
convertCurrencies 1 param body → 200400401403500

Schemas 67

The contract defines 67 schemas that model the data the API accepts and returns. The most detailed are PrivateOffer (63 properties), CreateOffer (29 properties), UpdateOffer (24 properties), Product (11 properties). Each schema is shown below with its type and property counts.

UpdateOffer
object
Partial request body for updating a Microsoft SaaS private offer.
24 properties
MarketCurrency
object
6 properties
PrivateOfferError
object
3 properties
RecurrentPrice
object
4 properties
ProductType
string
StartOn
string
PlanPricing
object
2 properties
ErrorResponse
object
1 property 1 required
UpdateDimension
object
5 properties
CreateOffer
object
Request body for creating a Microsoft SaaS private offer.
29 properties
PriceDetail
object
3 properties
Clone
object
2 properties
PrivateOfferSalesforce
object
3 properties
UpdateOfferPricing
object
9 properties
PlanUserLimits
object
2 properties
Partner
object
2 properties
CurrencyConversionPayload
object
4 properties 4 required
ContractDuration
object
2 properties
UpdateUserToNotify
object
3 properties
CreateUserToNotify
object
3 properties
DimensionQuantity
object
3 properties
OfferStatus
string
Controls the offer workflow. Use draftstatus to save the offer in Tackle only. Use submittocloud to validate the offer and prepare it for Microsoft marketplace…
CurrencyConversionResult
object
9 properties
PreRegistrationDetails
object
2 properties
TermValue
object
2 properties
Meter
object
2 properties
CurrencyConversionRequest
object
2 properties 1 required
ProductDetailsResponse
object
4 properties
MsftResponse
object
4 properties
UserLimits
object
2 properties
PrivateOffer
object
Stored Tackle Microsoft private offer.
63 properties
ScheduleDetail
object
3 properties
PrivateOfferStateDetail
object
1 property
BuyerDetails
object
3 properties
PlanPrice
object
4 properties
CurrencyConversionResponse
object
2 properties
PricingType
string
UpdateSalesforce
object
2 properties
EULA
object
4 properties
PaymentSchedule
object
2 properties
PlanResponse
object
9 properties
MarketCurrenciesResponse
object
2 properties
CreateOfferNotificationRequest
object
Request body for creating an offer notification. Only buyer instruction emails are currently supported.
2 properties 2 required
OfferStateValue
string
CurrencyConversionError
object
2 properties
IncludedQuantity
object
3 properties
UpdateContractDuration
object
2 properties
CustomMeters
object
2 properties
InitialCharge
object
2 properties
PrivateOfferState
object
5 properties
PaymentInstallment
object
1 property
PrivateOfferActivityUser
object
4 properties
Buyer
object
3 properties
PaymentModel
string
CurrencyOption
object
2 properties
Product
object
A Microsoft Marketplace product owned by the calling seller. The fields below are the most commonly consumed; additional listing-type-specific fields may also…
11 properties 5 required
Dimension
object
5 properties
ImportMicrosoftOfferRequest
object
3 properties 2 required
Source
string
PlanTemplate
object
2 properties
OfferType
string
PrivateOfferActivity
object
5 properties
UpdateBuyerDetails
object
3 properties
OfferPricing
object
10 properties
CreateSalesforce
object
2 properties
UserToNotify
object
5 properties
UpdatePaymentInstallment
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tackle-public-api-openapi.yml Raw ↑

Other APIs Tackle publishes across the network.

Tackle Authentication API
Tackle Contracts API
Tackle Currencies API
Tackle Disbursements API
Tackle Entitlements API
Tackle Groups API
Tackle Invitations API
Tackle Invoices API
Tackle Marketplace API
Tackle Metering API
Tackle Notifications API
Tackle Opportunities API