Tackle Private Offers API

AWS private-offer lifecycle (create, read, update, cancel, push to marketplace).

Documentation Provider Profile APIs.io OpenAPI GitHub

Tackle Private Offers 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 Offers. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 11 operations across 6 paths, and defines 66 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.

11 operations 6 paths 66 schemas 1 DELETE4 GET5 POST1 PUT

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

Contact

Tackle Support

Resource Areas

Authentication & Security 4

Tackle Private Offers 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 11

Across 6 paths, the API surfaces 11 operations — 1 DELETE, 4 GET, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Private Offers 11

AWS private-offer lifecycle (create, read, update, cancel, push to marketplace).

GET

/private-offers

List Private Offers

listPrivateOffers 11 params → 200400401403500

POST

/private-offers

Create Private Offer

createPrivateOffer body → 200201400401403500

GET

/private-offers/{id}

Get Private Offer

getPrivateOffer 1 param → 200401403404

PUT

/private-offers/{id}

Update Private Offer

updatePrivateOffer 1 param body → 200400401403404

DELETE

/private-offers/{id}

Delete Private Offer

deletePrivateOffer 1 param → 204401403404

POST

/private-offers/{id}/cancel

Cancel Private Offer

cancelPrivateOffer 1 param → 200400401403404409

POST

/private-offers/{id}/marketplace-create

Push Private Offer to AWS Marketplace

marketplaceCreatePrivateOffer 1 param body → 200201400401403404409

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

Schemas 66

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

ExtraData

object

1 property

UpdateOffer

object

Partial request body for updating a Microsoft SaaS private offer.

24 properties

PrivateOfferError

object

3 properties

ProductType

string

PositiveTargeting

object

Positive targeting constraints (currently country allow-lists).

1 property

StartOn

string

PrivateOfferList

object

Paginated list of private offers.

4 properties 4 required

CreatePrivateOfferRequest

object

Request body for creating or updating a private offer. The wrapper controls how the request is processed; the privateoffer field carries the offer payload. For…

5 properties 4 required

PrivateOffer_2

object

Stored Tackle Microsoft private offer.

63 properties

ErrorResponse

object

1 property 1 required

ExtraDataUser

object

1 property 1 required

MarketplaceCreatePrivateOfferRequest

object

Request body for promoting an existing Tackle draft offer into AWS Marketplace. Only the wrapper options are accepted; the offer payload is taken from the exis…

2 properties 2 required

UpdateDimension

object

5 properties

CreateOffer

object

Request body for creating a Microsoft SaaS private offer.

29 properties

Clone

object

2 properties

PrivateOfferSalesforce

object

3 properties

EULA_2

object

4 properties

UpdateOfferPricing

object

9 properties

Activity

object

5 properties

Partner

object

2 properties

ContractDuration

object

2 properties

UpdateUserToNotify

object

3 properties

CreatePrivateOfferResponse

object

2 properties 2 required

CreateUserToNotify

object

3 properties

Error

object

Error response. Endpoints in the Private Offers and Marketplace tags return the error in a message field. The Partners endpoint returns the error in an error f…

2 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…

ResellerAgreement

object

3 properties 1 required

Salesforce

object

3 properties

PreRegistrationDetails

object

2 properties

MsftResponse

object

4 properties

UserLimits

object

2 properties

PrivateOffer

object

Represents a private offer for any cloud marketplace and product type. Field shapes are backward-compatible with the privateoffermetadata object documented in…

40 properties 7 required

UsageDimension

object

4 properties

ScheduleDetail

object

3 properties

PrivateOfferStateDetail

object

1 property

BuyerDetails

object

3 properties

PricingType

string

UpdateSalesforce

object

2 properties

EULA

object

EULA configuration for the offer.

3 properties

PaymentSchedule

object

2 properties

OfferStateValue

string

Pricing

object

Pricing configuration for an offer. Used for all cloud marketplaces, offer types, and product types. Many fields are conditional on paymentmodel and billingter…

19 properties

UpdateContractDuration

object

2 properties

ScheduledPayment

object

2 properties

InitialCharge

object

2 properties

PrivateOfferState

object

5 properties

PricingDimension

object

6 properties

PaymentInstallment

object

1 property

PrivateOfferActivityUser

object

4 properties

PricingUnit

object

AMI-only pricing unit.

3 properties

Buyer_2

object

3 properties

Buyer

object

3 properties 1 required

PaymentModel

string

Dimension

object

5 properties

ImportMicrosoftOfferRequest

object

3 properties 2 required

PartnerOffer

object

Details about a partner (resale) offer. Only set when offertype is partnerresale.

7 properties

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

Other APIs Tackle publishes across the network.

Tackle Authentication API

AE Profile APIs.io

Tackle Contracts API

AE Profile APIs.io

Tackle Currencies API

AE Profile APIs.io

Tackle Disbursements API

AE Profile APIs.io

Tackle Entitlements API

AE Profile APIs.io

Tackle Groups API

AE Profile APIs.io

Tackle Invitations API

AE Profile APIs.io

Tackle Invoices API

AE Profile APIs.io

Tackle Marketplace API

AE Profile APIs.io

Tackle Metering API

AE Profile APIs.io

Tackle Notifications API

AE Profile APIs.io

Tackle Opportunities API

AE Profile APIs.io

#Private Offers

← Back to T APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Tackle Private Offers API

Metadata

Authentication & Security 4

Paths & Operations 11

Schemas 66

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Tackle Private Offers API

Metadata

Authentication & Security 4

Paths & Operations 11

Schemas 66

Specification

Source

More from Tackle 12

API Details

Provider

Explore more