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 Private Offer Actions API

Private offer lifecycle actions such as archive, cancel, and sync.

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

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

This API exposes 4 operations across 4 paths, and defines 34 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.

4 operations 4 paths 34 schemas 4 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 Private Offer Actions 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 4

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

Private Offer Actions 4

Private offer lifecycle actions such as archive, cancel, and sync.

POST
/api/private-offers/{id}/archive
Archive an offer
archivePrivateOffer 2 params → 200400401403404500
POST
/api/private-offers/{id}/unarchive
Unarchive an offer
unarchivePrivateOffer 2 params → 200400401403404500
POST
/api/private-offers/{id}/cancel
Cancel an offer
cancelPrivateOffer 2 params → 200400401403404500
POST
/api/private-offers/{id}/sync
Sync an offer from Microsoft
syncPrivateOffer 3 params → 200400401403404500

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are PrivateOffer (63 properties), OfferPricing (10 properties), Dimension (5 properties), PrivateOfferState (5 properties). Each schema is shown below with its type and property counts.

MsftResponse
object
4 properties
PrivateOfferError
object
3 properties
Partner
object
2 properties
InitialCharge
object
2 properties
PrivateOfferState
object
5 properties
ProductType
string
PaymentInstallment
object
1 property
ContractDuration
object
2 properties
UserLimits
object
2 properties
PrivateOffer
object
Stored Tackle Microsoft private offer.
63 properties
StartOn
string
PrivateOfferActivityUser
object
4 properties
Buyer
object
3 properties
PaymentModel
string
ScheduleDetail
object
3 properties
PrivateOfferStateDetail
object
1 property
Dimension
object
5 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…
Source
string
PlanTemplate
object
2 properties
BuyerDetails
object
3 properties
OfferType
string
PrivateOfferActivity
object
5 properties
PricingType
string
ErrorResponse
object
1 property 1 required
EULA
object
4 properties
PaymentSchedule
object
2 properties
OfferPricing
object
10 properties
Clone
object
2 properties
UserToNotify
object
5 properties
OfferStateValue
string
PreRegistrationDetails
object
2 properties
PrivateOfferSalesforce
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tackle-private-offer-actions-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