REST API Reference (V2)
Master Data
Catalogs
List vendor categoriesgetList vendor sub-categoriesgetList vendorsgetGet vendorgetCreate vendorpostUpdate vendorpatchDelete vendordeleteList itemsgetGet itemgetCreate itempostUpdate itempatchDelete itemdeleteCreate vendor categorypostCreate vendor sub-categorypost
B2B Platform
Marketplace
List catalogsgetList productsgetGet productgetCreate productpostUpdate productpatchDelete productdeleteCreate catalogpost
B2B E-store
List storesgetGet storegetCreate storepostUpdate storepatchDelete storedeleteList storefront productsgetGet cartgetCreate cartpostAdd cart linepostUpdate cart linepatchDelete cart linedeleteList store ordersgetGet store ordergetCreate store orderpostUpdate store orderpatch
Source to Pay
List RFXsgetGet RFXgetCreate RFXpostUpdate RFXpatchDelete RFXdeleteList purchase ordersgetGet purchase ordergetCreate purchase orderpostUpdate purchase orderpatch
Sales
List opportunitiesgetList quotesgetGet quotegetCreate opportunitypostUpdate opportunitypatchCreate quotepostUpdate quotepatch
Network
List partnersgetGet partnergetCreate partnerpostUpdate partnerpatch
Finance
Payments
List paymentsgetGet paymentgetCreate paymentpostUpdate paymentpatch
Wallets
List walletsgetList wallet transactionsgetCreate walletpost
Invoices
List invoicesgetGet invoicegetCreate invoicepostUpdate invoicepatch
Webhooks
Subscriptions
List subscriptionsgetCreate subscriptionpostGet subscriptiongetUpdate subscriptionpatchDelete subscriptiondeleteList deliveriesget
Account
Workspace
Get current workspacegetUpdate workspacepatch
Users
List usersgetInvite userpostGet usergetUpdate userpatchRemove userdelete
API keys
List API keysgetCreate API keypostRevoke API keydelete
Subscription
Get subscriptionget
Apps & Plugins
Developer apps
List developer appsgetCreate developer apppostGet developer appgetUpdate developer apppatch
Listings
List listingsgetCreate listingpostUpdate listingpatch
Installations
List installationsgetCreate installationpostDelete installationdelete
Plans
List plansgetCreate planpost
AI Builder jobs
Create AI Builder jobpostGet AI Builder jobget
AI
Helpers
Summarize RFXpostClassify catalog linepost

REST API Reference (V2)

Updated on July 14, 2026

The Tradeics REST API V2 is the current HTTPS surface for ERP, OMS, CRM, and middleware integrations.

Base URL: https://api.tradeics.example/v2/

Auth header

Authorization: Bearer <your_api_key>
Content-Type: application/json
Accept: application/json

Scroll any endpoint below to load HTTP request and response examples in the right panel. Multi-language clients live in First request.

Try it with your API client

Postman Insomnia Bruno Hoppscotch OpenAPI HTTPie

Download the ⬇️ Postman collection or OpenAPI 3.1 and import into Postman, Insomnia, Bruno, Hoppscotch, or HTTPie. See API clients.

Conventions

  • Prefer V2 for all new work (https://api.tradeics.example/v2/).

  • Service modules may include a submodule version (example: master-management/v2.0).

  • All production traffic uses HTTPS.

  • Typical envelope: { "error": false, "reason": "listed", "data": {} }.

  • Common statuses: 200/201 OK, 400 bad request, 401 unauthorized, 403 forbidden, 404 not found, 422 validation, 429 rate limit, 5xx retry.

Catalogsin Master Data

List vendor categories

GET
/v2/vendor-category{?page}{&page_size}

Returns top-level vendor categories for ERP / PIM taxonomy alignment.

URI Parameters
page
stringRequired

Page index starting at 1

page_size
stringOptional

Items per page when supported by your key

  • GEThttps://api.tradeics.example/v2/vendor-category
  • Tiersuserapp
  • Scopesmaster:read
HTTP
Request
(loading)
Response
(loading)

List vendor sub-categories

GET
/v2/vendor-sub-category{?page}{&page_size}

Returns vendor sub-categories for ERP / PIM taxonomy alignment. Ideal first call after authentication.

URI Parameters
page
stringRequired

Page index starting at 1

page_size
stringOptional

Items per page when supported by your key

  • GEThttps://api.tradeics.example/v2/vendor-sub-category
  • Tiersuserapp
  • Scopesmaster:read
HTTP
Request
(loading)
Response
(loading)

List vendors

GET
/v2/vendors{?page}{&page_size}{&q}

Lists suppliers visible to your key.

URI Parameters
page
stringRequired

Page index starting at 1

page_size
stringOptional

Items per page

q
stringOptional

Free-text name or code filter

  • GEThttps://api.tradeics.example/v2/vendors
  • Tiersuserapp
  • Scopesmaster:read
HTTP
Request
(loading)
Response
(loading)

Get vendor

GET
/v2/vendors/{id}

Returns one supplier by Tradeics id.

URI Parameters
id
stringRequired

Vendor id

  • GEThttps://api.tradeics.example/v2/vendors/id
  • Tiersuserapp
  • Scopesmaster:read
HTTP
Request
(loading)
Response
(loading)

Create vendor

POST
/v2/vendors

Creates a supplier in master data.

Request Body
name
stringRequired

Legal or trading name

code
stringRequired

Stable supplier code

country
stringRequired

ISO 3166-1 alpha-2

erp_id
stringOptional

External ERP vendor id

  • POSThttps://api.tradeics.example/v2/vendors
  • Tiersuserapp
  • Scopesmaster:write
HTTP
Request
(loading)
Response
(loading)

Update vendor

PATCH
/v2/vendors/{id}

Updates mutable supplier fields. Omit unchanged keys.

URI Parameters
id
stringRequired

Vendor id

Request Body
name
stringOptional

Legal or trading name

country
stringOptional

ISO 3166-1 alpha-2

status
stringOptional

active, inactive

erp_id
stringOptional

External ERP vendor id

  • PATCHhttps://api.tradeics.example/v2/vendors/id
  • Tiersuserapp
  • Scopesmaster:write
HTTP
Request
(loading)
Response
(loading)

Delete vendor

DELETE
/v2/vendors/{id}

Soft-deletes or archives a supplier when policy allows. Prefer PATCH status=inactive when reversible.

URI Parameters
id
stringRequired

Vendor id

  • DELETEhttps://api.tradeics.example/v2/vendors/id
  • Tiersuserapp
  • Scopesmaster:write
HTTP
Request
(loading)
Response
(loading)

List items

GET
/v2/items{?page}{&page_size}{&q}

Lists catalog items for PIM / ERP sync.

URI Parameters
page
stringRequired

Page index starting at 1

page_size
stringOptional

Items per page

q
stringOptional

SKU or name filter

  • GEThttps://api.tradeics.example/v2/items
  • Tiersuserapp
  • Scopesmaster:read
HTTP
Request
(loading)
Response
(loading)

Get item

GET
/v2/items/{id}

Returns one catalog item by Tradeics id.

URI Parameters
id
stringRequired

Item id

  • GEThttps://api.tradeics.example/v2/items/id
  • Tiersuserapp
  • Scopesmaster:read
HTTP
Request
(loading)
Response
(loading)

Create item

POST
/v2/items

Creates a catalog item for PIM / ERP sync.

Request Body
sku
stringRequired

Stock keeping unit

name
stringRequired

Display name

uom
stringRequired

Unit of measure

category_id
stringOptional

Vendor category id

status
stringOptional

active, inactive (default active)

  • POSThttps://api.tradeics.example/v2/items
  • Tiersuserapp
  • Scopesmaster:write
HTTP
Request
(loading)
Response
(loading)

Update item

PATCH
/v2/items/{id}

Updates mutable catalog item fields.

URI Parameters
id
stringRequired

Item id

Request Body
name
stringOptional

Display name

uom
stringOptional

Unit of measure

category_id
stringOptional

Vendor category id

status
stringOptional

active, inactive

  • PATCHhttps://api.tradeics.example/v2/items/id
  • Tiersuserapp
  • Scopesmaster:write
HTTP
Request
(loading)
Response
(loading)

Delete item

DELETE
/v2/items/{id}

Archives a catalog item when policy allows.

URI Parameters
id
stringRequired

Item id

  • DELETEhttps://api.tradeics.example/v2/items/id
  • Tiersuserapp
  • Scopesmaster:write
HTTP
Request
(loading)
Response
(loading)

Create vendor category

POST
/v2/vendor-category

Creates a top-level vendor category.

Request Body
name
stringRequired

Category name

code
stringRequired

Stable category code

  • POSThttps://api.tradeics.example/v2/vendor-category
  • Tiersuserapp
  • Scopesmaster:write
HTTP
Request
(loading)
Response
(loading)

Create vendor sub-category

POST
/v2/vendor-sub-category

Creates a vendor sub-category under a parent category.

Request Body
name
stringRequired

Sub-category name

code
stringRequired

Stable code

parent_category_id
stringRequired

Parent category id

  • POSThttps://api.tradeics.example/v2/vendor-sub-category
  • Tiersuserapp
  • Scopesmaster:write
HTTP
Request
(loading)
Response
(loading)

Marketplacein B2B Platform

List catalogs

GET
/v2/catalogs{?page}{&page_size}

Lists catalogs available to your workspace.

URI Parameters
page
stringRequired

Page index starting at 1

page_size
stringOptional

Items per page

  • GEThttps://api.tradeics.example/v2/catalogs
  • Tiersuserapp
  • Scopesmarketplace:read
HTTP
Request
(loading)
Response
(loading)

List products

GET
/v2/products{?page}{&page_size}{&catalog_id}

Lists sellable products in one or more catalogs.

URI Parameters
page
stringRequired

Page index starting at 1

page_size
stringOptional

Items per page

catalog_id
stringOptional

Restrict to a catalog

  • GEThttps://api.tradeics.example/v2/products
  • Tiersuserapp
  • Scopesmarketplace:read
HTTP
Request
(loading)
Response
(loading)

Get product

GET
/v2/products/{id}

Returns one marketplace product.

URI Parameters
id
stringRequired

Product id

  • GEThttps://api.tradeics.example/v2/products/id
  • Tiersuserapp
  • Scopesmarketplace:read
HTTP
Request
(loading)
Response
(loading)

Create product

POST
/v2/products

Publishes a sellable product into a marketplace catalog.

Request Body
catalog_id
stringRequired

Target catalog

sku
stringRequired

Product SKU

name
stringRequired

Display name

unit_price
numberRequired

Major-unit price

currency
stringRequired

ISO currency code

moq
numberOptional

Minimum order quantity

  • POSThttps://api.tradeics.example/v2/products
  • Tiersuserapp
  • Scopesmarketplace:write
HTTP
Request
(loading)
Response
(loading)

Update product

PATCH
/v2/products/{id}

Updates price, MOQ, or status on a marketplace product.

URI Parameters
id
stringRequired

Product id

Request Body
unit_price
numberOptional

Major-unit price

moq
numberOptional

Minimum order quantity

status
stringOptional

active, inactive

  • PATCHhttps://api.tradeics.example/v2/products/id
  • Tiersuserapp
  • Scopesmarketplace:write
HTTP
Request
(loading)
Response
(loading)

Delete product

DELETE
/v2/products/{id}

Removes a product from the sellable catalog surface.

URI Parameters
id
stringRequired

Product id

  • DELETEhttps://api.tradeics.example/v2/products/id
  • Tiersuserapp
  • Scopesmarketplace:write
HTTP
Request
(loading)
Response
(loading)

Create catalog

POST
/v2/catalogs

Creates a marketplace catalog for your workspace.

Request Body
name
stringRequired

Catalog name

currency
stringRequired

Default ISO currency

  • POSThttps://api.tradeics.example/v2/catalogs
  • Tiersuserapp
  • Scopesmarketplace:write
HTTP
Request
(loading)
Response
(loading)

B2B E-storein B2B Platform

List stores

GET
/v2/stores{?page}{&page_size}{&status}

Lists B2B e-stores visible to your workspace.

URI Parameters
page
stringRequired

Page index starting at 1

page_size
stringOptional

Items per page

status
stringOptional

Filter: draft, live, paused

  • GEThttps://api.tradeics.example/v2/stores
  • Tiersuserapp
  • Scopesestore:read
HTTP
Request
(loading)
Response
(loading)

Get store

GET
/v2/stores/{id}

Returns one e-store configuration.

URI Parameters
id
stringRequired

Store id

  • GEThttps://api.tradeics.example/v2/stores/id
  • Tiersuserapp
  • Scopesestore:read
HTTP
Request
(loading)
Response
(loading)

Create store

POST
/v2/stores

Creates a B2B e-store (storefront) for your workspace.

Request Body
name
stringRequired

Store display name

slug
stringRequired

URL slug

currency
stringRequired

Default ISO currency

default_catalog_id
stringOptional

Linked marketplace or private catalog

  • POSThttps://api.tradeics.example/v2/stores
  • Tiersuserapp
  • Scopesestore:write
HTTP
Request
(loading)
Response
(loading)

Update store

PATCH
/v2/stores/{id}

Updates store branding, catalog link, or publish status.

URI Parameters
id
stringRequired

Store id

Request Body
name
stringOptional

Store display name

status
stringOptional

draft, live, paused

default_catalog_id
stringOptional

Linked catalog

currency
stringOptional

Default ISO currency

  • PATCHhttps://api.tradeics.example/v2/stores/id
  • Tiersuserapp
  • Scopesestore:write
HTTP
Request
(loading)
Response
(loading)

Delete store

DELETE
/v2/stores/{id}

Archives a draft or paused store. Live stores with open carts return 409.

URI Parameters
id
stringRequired

Store id

  • DELETEhttps://api.tradeics.example/v2/stores/id
  • Tiersuserapp
  • Scopesestore:write
HTTP
Request
(loading)
Response
(loading)

List storefront products

GET
/v2/stores/{id}/products{?page}{&page_size}{&q}

Lists products visible on a live e-store storefront (resolved from the linked catalog).

URI Parameters
id
stringRequired

Store id

page
stringRequired

Page index starting at 1

page_size
stringOptional

Items per page

q
stringOptional

SKU or name filter

  • GEThttps://api.tradeics.example/v2/stores/id/products
  • Tiersuserapp
  • Scopesestore:read
HTTP
Request
(loading)
Response
(loading)

Get cart

GET
/v2/carts/{id}

Returns a cart for a buyer session or ERP-backed checkout.

URI Parameters
id
stringRequired

Cart id

  • GEThttps://api.tradeics.example/v2/carts/id
  • Tiersuserapp
  • Scopesestore:read
HTTP
Request
(loading)
Response
(loading)

Create cart

POST
/v2/carts

Opens a cart on an e-store for a buyer or partner.

Request Body
store_id
stringRequired

Target e-store

partner_id
stringOptional

Buying partner

currency
stringOptional

Override store currency when allowed

  • POSThttps://api.tradeics.example/v2/carts
  • Tiersuserapp
  • Scopesestore:write
HTTP
Request
(loading)
Response
(loading)

Add cart line

POST
/v2/carts/{id}/lines

Adds a storefront product line to an open cart.

URI Parameters
id
stringRequired

Cart id

Request Body
sku
stringRequired

Storefront SKU

quantity
numberRequired

Units to add (must meet MOQ)

unit_price
numberOptional

Override when negotiated pricing applies

  • POSThttps://api.tradeics.example/v2/carts/id/lines
  • Tiersuserapp
  • Scopesestore:write
HTTP
Request
(loading)
Response
(loading)

Update cart line

PATCH
/v2/carts/{id}/lines/{line_id}

Updates quantity on an existing cart line.

URI Parameters
id
stringRequired

Cart id

line_id
stringRequired

Cart line id

Request Body
quantity
numberRequired

New quantity

  • PATCHhttps://api.tradeics.example/v2/carts/id/lines/line_id
  • Tiersuserapp
  • Scopesestore:write
HTTP
Request
(loading)
Response
(loading)

Delete cart line

DELETE
/v2/carts/{id}/lines/{line_id}

Removes a line from an open cart.

URI Parameters
id
stringRequired

Cart id

line_id
stringRequired

Cart line id

  • DELETEhttps://api.tradeics.example/v2/carts/id/lines/line_id
  • Tiersuserapp
  • Scopesestore:write
HTTP
Request
(loading)
Response
(loading)

List store orders

GET
/v2/orders{?page}{&page_size}{&store_id}{&status}

Lists e-store checkout orders for ERP / OMS sync.

URI Parameters
page
stringRequired

Page index starting at 1

page_size
stringOptional

Items per page

store_id
stringOptional

Restrict to one store

status
stringOptional

Filter: pending, confirmed, fulfilled, cancelled

  • GEThttps://api.tradeics.example/v2/orders
  • Tiersuserapp
  • Scopesestore:read
HTTP
Request
(loading)
Response
(loading)

Get store order

GET
/v2/orders/{id}

Returns one e-store order header and line summary.

URI Parameters
id
stringRequired

Store order id

  • GEThttps://api.tradeics.example/v2/orders/id
  • Tiersuserapp
  • Scopesestore:read
HTTP
Request
(loading)
Response
(loading)

Create store order

POST
/v2/orders

Checks out an open cart into a store order (direct-buy).

Request Body
cart_id
stringRequired

Open cart to checkout

reference
stringOptional

Buyer PO / external reference

ship_to
stringOptional

Shipping address id or inline label

  • POSThttps://api.tradeics.example/v2/orders
  • Tiersuserapp
  • Scopesestore:write
HTTP
Request
(loading)
Response
(loading)

Update store order

PATCH
/v2/orders/{id}

Updates store order status for fulfillment sync (pending → confirmed → fulfilled / cancelled).

URI Parameters
id
stringRequired

Store order id

Request Body
status
stringOptional

pending, confirmed, fulfilled, cancelled

reference
stringOptional

Buyer PO / external reference

  • PATCHhttps://api.tradeics.example/v2/orders/id
  • Tiersuserapp
  • Scopesestore:write
HTTP
Request
(loading)
Response
(loading)

Source to Payin B2B Platform

List RFXs

GET
/v2/rfx{?page}{&page_size}{&status}

Lists RFQs / RFPs visible to your key.

URI Parameters
page
stringRequired

Page index starting at 1

page_size
stringOptional

Items per page

status
stringOptional

Filter: draft, open, awarded, closed

  • GEThttps://api.tradeics.example/v2/rfx
  • Tiersuserapp
  • Scopess2p:read
HTTP
Request
(loading)
Response
(loading)

Get RFX

GET
/v2/rfx/{id}

Returns one RFX with header fields.

URI Parameters
id
stringRequired

RFX id

  • GEThttps://api.tradeics.example/v2/rfx/id
  • Tiersuserapp
  • Scopess2p:read
HTTP
Request
(loading)
Response
(loading)

Create RFX

POST
/v2/rfx

Creates an RFX draft. Line details may follow on subsequent update calls.

Request Body
title
stringRequired

RFX title

currency
stringRequired

ISO currency code

closes_at
stringOptional

RFC 3339 close time

  • POSThttps://api.tradeics.example/v2/rfx
  • Tiersuserapp
  • Scopess2p:write
HTTP
Request
(loading)
Response
(loading)

Update RFX

PATCH
/v2/rfx/{id}

Updates an RFX draft or open header fields. Award workflows stay separate.

URI Parameters
id
stringRequired

RFX id

Request Body
title
stringOptional

RFX title

status
stringOptional

draft, open, closed

closes_at
stringOptional

RFC 3339 close time

  • PATCHhttps://api.tradeics.example/v2/rfx/id
  • Tiersuserapp
  • Scopess2p:write
HTTP
Request
(loading)
Response
(loading)

Delete RFX

DELETE
/v2/rfx/{id}

Deletes a draft RFX. Open or awarded RFXs return 409 — close them instead.

URI Parameters
id
stringRequired

RFX id

  • DELETEhttps://api.tradeics.example/v2/rfx/id
  • Tiersuserapp
  • Scopess2p:write
HTTP
Request
(loading)
Response
(loading)

List purchase orders

GET
/v2/purchase-orders{?page}{&page_size}{&status}

Lists purchase orders for ERP / OMS sync.

URI Parameters
page
stringRequired

Page index starting at 1

page_size
stringOptional

Items per page

status
stringOptional

Filter: draft, issued, received, closed

  • GEThttps://api.tradeics.example/v2/purchase-orders
  • Tiersuserapp
  • Scopess2p:read
HTTP
Request
(loading)
Response
(loading)

Get purchase order

GET
/v2/purchase-orders/{id}

Returns one purchase order header.

URI Parameters
id
stringRequired

Purchase order id

  • GEThttps://api.tradeics.example/v2/purchase-orders/id
  • Tiersuserapp
  • Scopess2p:read
HTTP
Request
(loading)
Response
(loading)

Create purchase order

POST
/v2/purchase-orders

Creates a purchase order draft from an awarded RFX or free-form header.

Request Body
vendor_id
stringRequired

Supplier id

currency
stringRequired

ISO currency code

rfx_id
stringOptional

Source RFX

reference
stringOptional

Buyer PO number

  • POSThttps://api.tradeics.example/v2/purchase-orders
  • Tiersuserapp
  • Scopess2p:write
HTTP
Request
(loading)
Response
(loading)

Update purchase order

PATCH
/v2/purchase-orders/{id}

Updates PO status or header fields (draft → issued).

URI Parameters
id
stringRequired

Purchase order id

Request Body
status
stringOptional

draft, issued, received, closed

reference
stringOptional

Buyer PO number

  • PATCHhttps://api.tradeics.example/v2/purchase-orders/id
  • Tiersuserapp
  • Scopess2p:write
HTTP
Request
(loading)
Response
(loading)

Salesin B2B Platform

List opportunities

GET
/v2/opportunities{?page}{&page_size}{&status}

Lists sales opportunities in the buyers network.

URI Parameters
page
stringRequired

Page index starting at 1

page_size
stringOptional

Items per page

status
stringOptional

Filter: open, won, lost

  • GEThttps://api.tradeics.example/v2/opportunities
  • Tiersuserapp
  • Scopessales:read
HTTP
Request
(loading)
Response
(loading)

List quotes

GET
/v2/quotes{?page}{&page_size}{&opportunity_id}

Lists seller quotes, optionally scoped to an opportunity.

URI Parameters
page
stringRequired

Page index starting at 1

page_size
stringOptional

Items per page

opportunity_id
stringOptional

Restrict to an opportunity

  • GEThttps://api.tradeics.example/v2/quotes
  • Tiersuserapp
  • Scopessales:read
HTTP
Request
(loading)
Response
(loading)

Get quote

GET
/v2/quotes/{id}

Returns one seller quote.

URI Parameters
id
stringRequired

Quote id

  • GEThttps://api.tradeics.example/v2/quotes/id
  • Tiersuserapp
  • Scopessales:read
HTTP
Request
(loading)
Response
(loading)

Create opportunity

POST
/v2/opportunities

Creates a sales opportunity in the buyers network.

Request Body
title
stringRequired

Opportunity title

currency
stringRequired

ISO currency code

partner_id
stringOptional

Counterparty partner

  • POSThttps://api.tradeics.example/v2/opportunities
  • Tiersuserapp
  • Scopessales:write
HTTP
Request
(loading)
Response
(loading)

Update opportunity

PATCH
/v2/opportunities/{id}

Updates opportunity status (open, won, lost) or title.

URI Parameters
id
stringRequired

Opportunity id

Request Body
title
stringOptional

Opportunity title

status
stringOptional

open, won, lost

  • PATCHhttps://api.tradeics.example/v2/opportunities/id
  • Tiersuserapp
  • Scopessales:write
HTTP
Request
(loading)
Response
(loading)

Create quote

POST
/v2/quotes

Creates a seller quote for an opportunity.

Request Body
opportunity_id
stringRequired

Parent opportunity

amount
numberRequired

Quote total in major units

currency
stringRequired

ISO currency code

valid_until
stringOptional

RFC 3339 expiry

  • POSThttps://api.tradeics.example/v2/quotes
  • Tiersuserapp
  • Scopessales:write
HTTP
Request
(loading)
Response
(loading)

Update quote

PATCH
/v2/quotes/{id}

Updates quote amount or status (draft, sent, accepted, rejected).

URI Parameters
id
stringRequired

Quote id

Request Body
amount
numberOptional

Quote total

status
stringOptional

draft, sent, accepted, rejected

  • PATCHhttps://api.tradeics.example/v2/quotes/id
  • Tiersuserapp
  • Scopessales:write
HTTP
Request
(loading)
Response
(loading)

Networkin B2B Platform

List partners

GET
/v2/b2b-platform/v2.0/network/partners{?page}{&page_size}{&q}

Lists network partners visible to your workspace.

URI Parameters
page
stringRequired

Page index starting at 1

page_size
stringOptional

Items per page

q
stringOptional

Name filter

  • GEThttps://api.tradeics.example/v2/b2b-platform/v2.0/network/partners
  • Tiersuserapp
  • Scopesnetwork:read
HTTP
Request
(loading)
Response
(loading)

Get partner

GET
/v2/b2b-platform/v2.0/network/partners/{id}

Returns one network partner.

URI Parameters
id
stringRequired

Partner id

  • GEThttps://api.tradeics.example/v2/b2b-platform/v2.0/network/partners/id
  • Tiersuserapp
  • Scopesnetwork:read
HTTP
Request
(loading)
Response
(loading)

Create partner

POST
/v2/b2b-platform/v2.0/network/partners

Invites or registers a network partner for your workspace.

Request Body
name
stringRequired

Partner company name

role
stringRequired

buyer, supplier, both

country
stringOptional

ISO 3166-1 alpha-2

  • POSThttps://api.tradeics.example/v2/b2b-platform/v2.0/network/partners
  • Tiersuserapp
  • Scopesnetwork:write
HTTP
Request
(loading)
Response
(loading)

Update partner

PATCH
/v2/b2b-platform/v2.0/network/partners/{id}

Updates partner role or status.

URI Parameters
id
stringRequired

Partner id

Request Body
role
stringOptional

buyer, supplier, both

status
stringOptional

pending, active, suspended

  • PATCHhttps://api.tradeics.example/v2/b2b-platform/v2.0/network/partners/id
  • Tiersuserapp
  • Scopesnetwork:write
HTTP
Request
(loading)
Response
(loading)

Paymentsin Finance

List payments

GET
/v2/finance/v2.0/payments{?page}{&page_size}{&status}

Lists payments visible to your workspace.

URI Parameters
page
stringRequired

Page index starting at 1

page_size
stringOptional

Items per page

status
stringOptional

Filter: pending, captured, failed, refunded

  • GEThttps://api.tradeics.example/v2/finance/v2.0/payments
  • Tiersuserapp
  • Scopesfinance:read
HTTP
Request
(loading)
Response
(loading)

Get payment

GET
/v2/finance/v2.0/payments/{id}

Returns one payment by id.

URI Parameters
id
stringRequired

Payment id

  • GEThttps://api.tradeics.example/v2/finance/v2.0/payments/id
  • Tiersuserapp
  • Scopesfinance:read
HTTP
Request
(loading)
Response
(loading)

Create payment

POST
/v2/finance/v2.0/payments

Creates a payment intent against an invoice or PO anchor.

Request Body
amount
numberRequired

Major-unit amount

currency
stringRequired

ISO currency code

po_id
stringOptional

Related purchase order

invoice_id
stringOptional

Related invoice

  • POSThttps://api.tradeics.example/v2/finance/v2.0/payments
  • Tiersuserapp
  • Scopesfinance:write
HTTP
Request
(loading)
Response
(loading)

Update payment

PATCH
/v2/finance/v2.0/payments/{id}

Updates payment status (for example void a pending intent when policy allows).

URI Parameters
id
stringRequired

Payment id

Request Body
status
stringOptional

pending, captured, failed, refunded, void

  • PATCHhttps://api.tradeics.example/v2/finance/v2.0/payments/id
  • Tiersuserapp
  • Scopesfinance:write
HTTP
Request
(loading)
Response
(loading)

Walletsin Finance

List wallets

GET
/v2/finance/v2.0/wallets{?page}{&page_size}

Lists wallets for your workspace.

URI Parameters
page
stringRequired

Page index starting at 1

page_size
stringOptional

Items per page

  • GEThttps://api.tradeics.example/v2/finance/v2.0/wallets
  • Tiersuserapp
  • Scopesfinance:read
HTTP
Request
(loading)
Response
(loading)

List wallet transactions

GET
/v2/finance/v2.0/wallets/{id}/transactions{?page}{&page_size}

Lists ledger movements for one wallet.

URI Parameters
id
stringRequired

Wallet id

page
stringRequired

Page index starting at 1

page_size
stringOptional

Items per page

  • GEThttps://api.tradeics.example/v2/finance/v2.0/wallets/id/transactions
  • Tiersuserapp
  • Scopesfinance:read
HTTP
Request
(loading)
Response
(loading)

Create wallet

POST
/v2/finance/v2.0/wallets

Creates a wallet for your workspace in a given currency.

Request Body
currency
stringRequired

ISO currency code

label
stringOptional

Display label

  • POSThttps://api.tradeics.example/v2/finance/v2.0/wallets
  • Tiersuserapp
  • Scopesfinance:write
HTTP
Request
(loading)
Response
(loading)

Invoicesin Finance

List invoices

GET
/v2/finance/v2.0/invoices{?page}{&page_size}{&status}

Lists invoices for your workspace.

URI Parameters
page
stringRequired

Page index starting at 1

page_size
stringOptional

Items per page

status
stringOptional

Filter: draft, open, paid, void

  • GEThttps://api.tradeics.example/v2/finance/v2.0/invoices
  • Tiersuserapp
  • Scopesfinance:read
HTTP
Request
(loading)
Response
(loading)

Get invoice

GET
/v2/finance/v2.0/invoices/{id}

Returns one invoice.

URI Parameters
id
stringRequired

Invoice id

  • GEThttps://api.tradeics.example/v2/finance/v2.0/invoices/id
  • Tiersuserapp
  • Scopesfinance:read
HTTP
Request
(loading)
Response
(loading)

Create invoice

POST
/v2/finance/v2.0/invoices

Creates an invoice draft for a partner or PO anchor.

Request Body
partner_id
stringRequired

Bill-to partner

currency
stringRequired

ISO currency code

amount
numberRequired

Total in major units

purchase_order_id
stringOptional

Related PO

  • POSThttps://api.tradeics.example/v2/finance/v2.0/invoices
  • Tiersuserapp
  • Scopesfinance:write
HTTP
Request
(loading)
Response
(loading)

Update invoice

PATCH
/v2/finance/v2.0/invoices/{id}

Updates invoice status (draft → open → paid / void).

URI Parameters
id
stringRequired

Invoice id

Request Body
status
stringOptional

draft, open, paid, void

amount
numberOptional

Total in major units

  • PATCHhttps://api.tradeics.example/v2/finance/v2.0/invoices/id
  • Tiersuserapp
  • Scopesfinance:write
HTTP
Request
(loading)
Response
(loading)

Subscriptionsin Webhooks

List subscriptions

GET
/v2/webhooks/v2.0/subscriptions{?page}{&page_size}

Lists webhook subscriptions for your key.

URI Parameters
page
stringRequired

Page index starting at 1

page_size
stringOptional

Items per page

  • GEThttps://api.tradeics.example/v2/webhooks/v2.0/subscriptions
  • Tiersuserapp
  • Scopeswebhooks:read
HTTP
Request
(loading)
Response
(loading)

Create subscription

POST
/v2/webhooks/v2.0/subscriptions

Registers a webhook endpoint.

Request Body
url
stringRequired

HTTPS delivery URL

events
arrayRequired

Event names to subscribe to

secret
stringOptional

HMAC signing secret

  • POSThttps://api.tradeics.example/v2/webhooks/v2.0/subscriptions
  • Tiersuserapp
  • Scopeswebhooks:write
HTTP
Request
(loading)
Response
(loading)

Get subscription

GET
/v2/webhooks/v2.0/subscriptions/{id}

Returns one webhook subscription.

URI Parameters
id
stringRequired

Subscription id

  • GEThttps://api.tradeics.example/v2/account/v2.0/subscription
  • Tiersuserapp
  • Scopesaccount:read
HTTP
Request
(loading)
Response
(loading)

Update subscription

PATCH
/v2/webhooks/v2.0/subscriptions/{id}

Updates delivery URL, events, or status.

URI Parameters
id
stringRequired

Subscription id

Request Body
url
stringOptional

HTTPS delivery URL

events
arrayOptional

Event names

status
stringOptional

active, paused

  • PATCHhttps://api.tradeics.example/v2/webhooks/v2.0/subscriptions/id
  • Tiersuserapp
  • Scopeswebhooks:write
HTTP
Request
(loading)
Response
(loading)

Delete subscription

DELETE
/v2/webhooks/v2.0/subscriptions/{id}

Removes a webhook subscription.

URI Parameters
id
stringRequired

Subscription id

  • DELETEhttps://api.tradeics.example/v2/webhooks/v2.0/subscriptions/id
  • Tiersuserapp
  • Scopeswebhooks:write
HTTP
Request
(loading)
Response
(loading)

List deliveries

GET
/v2/webhooks/v2.0/subscriptions/{id}/deliveries{?page}{&page_size}

Lists recent delivery attempts for one subscription.

URI Parameters
id
stringRequired

Subscription id

page
stringRequired

Page index starting at 1

page_size
stringOptional

Items per page

  • GEThttps://api.tradeics.example/v2/webhooks/v2.0/subscriptions/id/deliveries
  • Tiersuserapp
  • Scopeswebhooks:read
HTTP
Request
(loading)
Response
(loading)

Workspacein Account

Get current workspace

GET
/v2/account/v2.0/workspace

Returns the workspace tied to your credential, including subdomain URL and subscription summary.

  • GEThttps://api.tradeics.example/v2/account/v2.0/workspace
  • Tiersuserapp
  • Scopesaccount:read
HTTP
Request
(loading)
Response
(loading)

Update workspace

PATCH
/v2/account/v2.0/workspace

Updates workspace profile fields visible to integrators. Slug changes (and subdomain URLs) are restricted — contact support when renaming a live workspace.

Request Body
name
stringOptional

Display name

timezone
stringOptional

IANA timezone

  • PATCHhttps://api.tradeics.example/v2/account/v2.0/workspace
  • Tiersuserapp
  • Scopesaccount:write
HTTP
Request
(loading)
Response
(loading)

Usersin Account

List users

GET
/v2/account/v2.0/users{?page}{&page_size}{&status}

Lists users in the current workspace.

URI Parameters
page
stringRequired

Page index starting at 1

page_size
stringOptional

Items per page

status
stringOptional

Filter: active invited disabled

  • GEThttps://api.tradeics.example/v2/account/v2.0/users
  • Tiersuserapp
  • Scopesaccount:read
HTTP
Request
(loading)
Response
(loading)

Invite user

POST
/v2/account/v2.0/users

Invites a user into the current workspace (creates membership; user may already exist on other workspaces).

Request Body
email
stringRequired

Invite email

role
stringRequired

Workspace role: owner admin member billing developer

name
stringOptional

Display name hint

  • POSThttps://api.tradeics.example/v2/account/v2.0/users
  • Tiersuserapp
  • Scopesaccount:write
HTTP
Request
(loading)
Response
(loading)

Get user

GET
/v2/account/v2.0/users/{id}

Returns a workspace membership for one user.

URI Parameters
id
stringRequired

User id in this workspace

  • GEThttps://api.tradeics.example/v2/account/v2.0/users/id
  • Tiersuserapp
  • Scopesaccount:read
HTTP
Request
(loading)
Response
(loading)

Update user

PATCH
/v2/account/v2.0/users/{id}

Updates a member's role or status in the current workspace (does not remove them from other workspaces).

URI Parameters
id
stringRequired

User id

Request Body
role
stringOptional

Workspace role

status
stringOptional

active disabled

  • PATCHhttps://api.tradeics.example/v2/account/v2.0/users/id
  • Tiersuserapp
  • Scopesaccount:write
HTTP
Request
(loading)
Response
(loading)

Remove user

DELETE
/v2/account/v2.0/users/{id}

Removes the user from the current workspace only. Their Tradeics user account and other workspace memberships remain.

URI Parameters
id
stringRequired

User id

  • DELETEhttps://api.tradeics.example/v2/account/v2.0/users/id
  • Tiersuserapp
  • Scopesaccount:write
HTTP
Request
(loading)
Response
(loading)

API keysin Account

List API keys

GET
/v2/account/v2.0/api-keys{?page}{&page_size}

Lists API keys for your workspace.

URI Parameters
page
stringRequired

Page index starting at 1

page_size
stringOptional

Items per page

  • GEThttps://api.tradeics.example/v2/account/v2.0/api-keys
  • Tiersuserapp
  • Scopesaccount:read
HTTP
Request
(loading)
Response
(loading)

Create API key

POST
/v2/account/v2.0/api-keys

Creates a workspace API key. The secret is returned once in the create response.

Request Body
name
stringRequired

Label for operators

scopes
arrayRequired

Scope strings

  • POSThttps://api.tradeics.example/v2/account/v2.0/api-keys
  • Tiersuserapp
  • Scopesaccount:write
HTTP
Request
(loading)
Response
(loading)

Revoke API key

DELETE
/v2/account/v2.0/api-keys/{id}

Revokes a workspace API key immediately.

URI Parameters
id
stringRequired

API key id

  • DELETEhttps://api.tradeics.example/v2/account/v2.0/api-keys/id
  • Tiersuserapp
  • Scopesaccount:write
HTTP
Request
(loading)
Response
(loading)

Subscriptionin Account

Get subscription

GET
/v2/account/v2.0/subscription

Returns the workspace subscription (plan, status, seats when applicable).

  • GEThttps://api.tradeics.example/v2/account/v2.0/subscription
  • Tiersuserapp
  • Scopesaccount:read
HTTP
Request
(loading)
Response
(loading)

Developer appsin Apps & Plugins

List developer apps

GET
/v2/apps/v2.0/developer-apps{?page}{&page_size}

Lists apps owned by your publisher workspace.

URI Parameters
page
stringRequired

Page index starting at 1

page_size
stringOptional

Items per page

  • GEThttps://api.tradeics.example/v2/apps/v2.0/developer-apps
  • Tiersapp
  • Scopesapps:read
HTTP
Request
(loading)
Response
(loading)

Create developer app

POST
/v2/apps/v2.0/developer-apps

Creates a developer app shell (manifest uploaded separately).

Request Body
name
stringRequired

Display name

slug
stringRequired

Unique slug

visibility_default
stringOptional

private, public, unlisted

  • POSThttps://api.tradeics.example/v2/apps/v2.0/developer-apps
  • Tiersapp
  • Scopesapps:write
HTTP
Request
(loading)
Response
(loading)

Get developer app

GET
/v2/apps/v2.0/developer-apps/{id}

Returns one developer app.

URI Parameters
id
stringRequired

App id

  • GEThttps://api.tradeics.example/v2/apps/v2.0/developer-apps/id
  • Tiersapp
  • Scopesapps:read
HTTP
Request
(loading)
Response
(loading)

Update developer app

PATCH
/v2/apps/v2.0/developer-apps/{id}

Updates app metadata (not the signed manifest — use version upload).

URI Parameters
id
stringRequired

App id

Request Body
name
stringOptional

Display name

status
stringOptional

draft, active, archived

  • PATCHhttps://api.tradeics.example/v2/apps/v2.0/developer-apps/id
  • Tiersapp
  • Scopesapps:write
HTTP
Request
(loading)
Response
(loading)

Listingsin Apps & Plugins

List listings

GET
/v2/apps/v2.0/listings{?page}{&page_size}{&visibility}

Lists listings for the publisher (or public catalog with catalog scopes).

URI Parameters
page
stringRequired

Page index starting at 1

page_size
stringOptional

Items per page

visibility
stringOptional

public, private, unlisted

  • GEThttps://api.tradeics.example/v2/apps/v2.0/listings
  • Tiersapp
  • Scopesapps:read
HTTP
Request
(loading)
Response
(loading)

Create listing

POST
/v2/apps/v2.0/listings

Creates a Store listing bound to an app.

Request Body
app_id
stringRequired

Developer app id

visibility
stringRequired

public, private, unlisted

pricing
stringRequired

free, one_time, subscription, metered

summary
stringRequired

Short Store blurb

  • POSThttps://api.tradeics.example/v2/apps/v2.0/listings
  • Tiersapp
  • Scopesapps:write
HTTP
Request
(loading)
Response
(loading)

Update listing

PATCH
/v2/apps/v2.0/listings/{id}

Updates listing visibility, pricing model, or copy.

URI Parameters
id
stringRequired

Listing id

Request Body
visibility
stringOptional

public, private, unlisted

pricing
stringOptional

free, one_time, subscription, metered

summary
stringOptional

Short Store blurb

status
stringOptional

draft, in_review, published, rejected

  • PATCHhttps://api.tradeics.example/v2/apps/v2.0/listings/id
  • Tiersapp
  • Scopesapps:write
HTTP
Request
(loading)
Response
(loading)

Installationsin Apps & Plugins

List installations

GET
/v2/apps/v2.0/installations{?page}{&page_size}{&app_id}

Lists installations visible to your key (org admin or publisher).

URI Parameters
page
stringRequired

Page index starting at 1

page_size
stringOptional

Items per page

app_id
stringOptional

Filter by developer app

  • GEThttps://api.tradeics.example/v2/apps/v2.0/installations
  • Tiersuserapp
  • Scopesapps:read
HTTP
Request
(loading)
Response
(loading)

Create installation

POST
/v2/apps/v2.0/installations

Installs an app into a workspace (consent recorded server-side).

Request Body
app_id
stringRequired

App to install

workspace_id
stringRequired

Target workspace

plan_id
stringOptional

Paid plan when required

  • POSThttps://api.tradeics.example/v2/apps/v2.0/installations
  • Tiersuserapp
  • Scopesapps:write
HTTP
Request
(loading)
Response
(loading)

Delete installation

DELETE
/v2/apps/v2.0/installations/{id}

Uninstalls an app and revokes its install token.

URI Parameters
id
stringRequired

Installation id

  • DELETEhttps://api.tradeics.example/v2/apps/v2.0/installations/id
  • Tiersuserapp
  • Scopesapps:write
HTTP
Request
(loading)
Response
(loading)

Plansin Apps & Plugins

List plans

GET
/v2/apps/v2.0/plans{?listing_id}{&page}{&page_size}

Lists plans for a listing.

URI Parameters
listing_id
stringOptional

Restrict to one listing

page
stringRequired

Page index starting at 1

page_size
stringOptional

Items per page

  • GEThttps://api.tradeics.example/v2/apps/v2.0/plans
  • Tiersapp
  • Scopesapps:read
HTTP
Request
(loading)
Response
(loading)

Create plan

POST
/v2/apps/v2.0/plans

Creates a monetization plan for a listing.

Request Body
listing_id
stringRequired

Parent listing

type
stringRequired

free, one_time, subscription, metered

price
numberRequired

Major-unit price (0 for free)

currency
stringRequired

ISO currency

interval
stringOptional

month, year when subscription

  • POSThttps://api.tradeics.example/v2/apps/v2.0/plans
  • Tiersapp
  • Scopesapps:write
HTTP
Request
(loading)
Response
(loading)

AI Builder jobsin Apps & Plugins

Create AI Builder job

POST
/v2/apps/v2.0/ai-builder/jobs

Creates a draft app scaffold from a natural-language brief.

Request Body
brief
stringRequired

What the app should do

visibility
stringOptional

Suggested private / public

pricing
stringOptional

Suggested pricing model

  • POSThttps://api.tradeics.example/v2/apps/v2.0/ai-builder/jobs
  • Tiersapp
  • Scopesapps:write
HTTP
Request
(loading)
Response
(loading)

Get AI Builder job

GET
/v2/apps/v2.0/ai-builder/jobs/{id}

Returns scaffold job status and resulting draft app id when complete.

URI Parameters
id
stringRequired

Job id

  • GEThttps://api.tradeics.example/v2/apps/v2.0/ai-builder/jobs/id
  • Tiersapp
  • Scopesapps:read
HTTP
Request
(loading)
Response
(loading)

Helpersin AI

Summarize RFX

POST
/v2/summarize-rfx

Returns a short summary of an RFX for buyers or sellers. Assistive only — do not auto-award from the result.

Request Body
rfx_id
stringRequired

RFX id to summarize

locale
stringOptional

BCP 47 locale, default en

  • POSThttps://api.tradeics.example/v2/summarize-rfx
  • Tiersuserapp
  • Scopesai:write
HTTP
Request
(loading)
Response
(loading)

Classify catalog line

POST
/v2/classify-item

Suggests a category / sub-category for a free-text catalog line.

Request Body
text
stringRequired

Item title or description

locale
stringOptional

BCP 47 locale, default en

  • POSThttps://api.tradeics.example/v2/classify-item
  • Tiersuserapp
  • Scopesai:write
HTTP
Request
(loading)
Response
(loading)