How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Topi offer API

Provides operations to handle offers for end-customers.## Webhooks### OfferUpdatesWe will ping the URL provided whenever an offer has changed its status to: `"accepted"`, `"declined"`, `"voided"`, `"pending_review"` or `"expired"`.**Payload**:- same as [show offer](#tag/offer/operation/offer#show) - `id`: `string` - `created_at`: `string ` - `status`: `string enum: "accepted" | "declined" | "pending_review" | "voided" | "expired"` - `checkout_redirect_url`: `string `

Topi offer API is one of 5 APIs that Topi publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Offer. The published artifact set on APIs.io includes an OpenAPI specification.

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

Requests are made against 4 base URLs: https://seller-api-sandbox.topi-sandbox.eu, https://seller-api.topi.eu, https://seller-api.topi-staging.eu, https://seller-api-sandbox.topi-sandbox-staging.eu.

9 operations 7 paths 34 schemas 4 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://seller-api.topi.eu
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Topi offer API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2Seller_header_Authorization) using the clientCredentials flow, exposing 13 scopes.

  • OAuth2Seller_header_Authorization — Read our [Integration Guide](https://docs.topi.eu/docs/integration-guide/authentication) for detailed instructions on how to authenticate.

Paths & Operations 9

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

offer 9

Provides operations to handle offers for end-customers. Webhooks OfferUpdates We will ping the URL provided whenever an offer has changed its status to: "accepted", "declined", "v…

GET
/v1/offersdeprecated
List all offers (deprecated)
offer#listOffers 3 params → 200400401403404
POST
/v1/offers
Create an offer
offer#create body → 201400401403422503
GET
/v1/offers/{id}
Retrieve an offer
offer#show 1 param → 200400401403404
PUT
/v1/offers/{id}
Edit an offer
offer#edit 1 param body → 202400401403422503
POST
/v1/offers/{id}/void
Void an offer
offer#void 1 param body → 200400401403404422
GET
/v1/offers/paginated
List all offers with pagination
offer#listOffersPaginated 15 params → 200400401403404
POST
/v1/offers/partners
Create an offer for a partner
offer#createForPartner body → 201400401403422503
GET
/v1/offers/ref/{seller_offer_reference}
Retrieve an offer by seller reference
offer#showByReference 1 param → 200400401403404
POST
/v1/offers/validate
Validate an offer
offer#validate body → 200400401403422

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are OfferLineResult (16 properties), OfferWithReferenceResult (15 properties), OfferResult (15 properties), OfferLineResultBase (15 properties). Each schema is shown below with its type and property counts.

ValidateRequestBody
object
13 properties 4 required
Rent
object
2 properties 2 required
ItemSummary
object
7 properties 7 required
ContractTerms
object
2 properties
ShippingInfo
object
Shipping information
3 properties 2 required
CustomerInfo
object
Customer information
5 properties
PayNowContractTerm
object
2 properties 1 required
CreatePayload2
object
12 properties 4 required
OfferLinePayload
object
A product line within an offer
9 properties 4 required
MoneyAmountWithOptionalGross
object
3 properties 2 required
SalesAgent
object
Sales agent related to an offer
4 properties 3 required
OfferLineResult
object
16 properties 7 required
PostalAddress
object
6 properties 4 required
VoidRequestBody
object
1 property
UnprocessableOffer
object
UnprocessableOffer is the error returned when one or more product reference is unsupported.
3 properties 2 required
MoneyAmount
object
3 properties 3 required
OfferResult
object
Basic information about an offer
15 properties 11 required
PaginationMetadata
object
4 properties
CreatePayloadWithMandatorySalesAgent2
object
12 properties 5 required
BreakdownLine
object
Items that are important for the payment
3 properties 2 required
PayNow
object
1 property 1 required
ValidateResult
object
Purchase overview of the validated offer
1 property 1 required
OfferLineResultBase
object
A product line within an offer
15 properties 7 required
CompanyInfo
object
Information about the customer company
4 properties
RentContractTerm
object
3 properties 2 required
PricingOverview
object
An Overview of the total price to pay by the user using topi.
5 properties 3 required
SellerProductReference
object
2 properties 2 required
ShippingAddress
object
Shipping Address. If the saleschannel is ecommerce, this field will be required
7 properties 4 required
OfferWithReferenceResult
object
15 properties 11 required
MoneyAmountWithRequiredTax
object
4 properties 4 required
OfferListResult
object
List of offers with pagination metadata
2 properties 2 required
Error
object
6 properties 6 required
CreateOfferPayload
object
Payload to create an offer
12 properties 4 required
SubLinePayload
object
A service line that is attached to a hardware or accessory
8 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

topi-offer-api-openapi.yml Raw ↑

Other APIs Topi publishes across the network.

Topi catalog API
Topi order API
Topi shipment API
Topi shippingMethod API
Where this information came from

This is an independent, third-party profile of Topi offer API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.