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 order API

Provides operations to handle orders for end-customers.## WebhooksWe will ping the URL provided whenever an order has changed its status to: `"created"`, `"completed"`, or `"canceled"`.**Payload**:- Available fields: - `id`: `string` - `assets`: `array` of `Asset` - `metadata`: `object` - `offer_id`: `string` - `seller_offer_reference`: `string` - `status`: `string enum` - `shipping_address`: `ShippingAddress` `ShippingAddress` contains this fields: - `name`: `string` - `line1`: `string` - `line2`: `string` - `postal_code`: `string` - `city`: `string` - `region`: `string` - `country_code`: `string`

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

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

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

7 operations 6 paths 23 schemas 3 GET1 PATCH3 POST

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 order 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 7

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

order 7

Provides operations to handle orders for end-customers. Webhooks We will ping the URL provided whenever an order has changed its status to: "created", "completed", or "canceled".…

GET
/v1/ordersdeprecated
List all orders (deprecated)
order#getBySeller 3 params → 200400401403
GET
/v1/orders/{id}
Retrieve an order
order#show 1 param → 200400401403404
PATCH
/v1/orders/{id}
Set metadata on an order
order#setMetadata 1 param body → 200400401403404
POST
/v1/orders/{id}/accept
Confirm an order
order#acceptOrder 1 param → 200400401403404422
POST
/v1/orders/{id}/acknowledge
Acknowledge an order
order#acknowledgeOrder 1 param → 200400401403404422
POST
/v1/orders/{id}/reject
Reject an order
order#rejectOrder 1 param → 200400401403404422
GET
/v1/orders/paginated
List all orders with pagination
order#getBySellerPaginated 15 params → 200400401403

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are SellerInfo (18 properties), FullOrderResult (16 properties), OrderLineItem (13 properties), BaseOrderLineItem (12 properties). Each schema is shown below with its type and property counts.

OrderSummary
object
Summary info about an order
8 properties 8 required
Asset
object
An item included in an order
7 properties 5 required
OrderLineItem
object
13 properties 8 required
OrdersSummary
object
1 property
ShippingInfo
object
Shipping information
3 properties 2 required
CustomerInfo
object
Customer information
5 properties
Address
object
6 properties 4 required
SalesAgent
object
Sales agent related to an offer
4 properties 3 required
PostalAddress
object
6 properties 4 required
OrderResult
object
Basic information about an order
6 properties 5 required
SellerInfo
object
18 properties 13 required
MoneyAmount
object
3 properties 3 required
PaginationMetadata
object
4 properties
FirstPartyService
object
Info for first party service
4 properties 3 required
FirstPartyServiceAdditionalValues
object
Additional values for specific first party types.
1 property
CompanyInfo
object
Information about the customer company
4 properties
OrdersSummaryPaginated
object
Orders list with pagination metadata
2 properties 2 required
SellerProductReference
object
2 properties 2 required
FullOrderResult
object
Full information about an order
16 properties 12 required
ShippingAddress
object
Shipping Address. If the saleschannel is ecommerce, this field will be required
7 properties 4 required
BaseOrderLineItem
object
12 properties 8 required
Error
object
6 properties 6 required
SetMetadataRequestBody
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

topi-order-api-openapi.yml Raw ↑

Other APIs Topi publishes across the network.

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

This is an independent, third-party profile of Topi order 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.