All pages
Powered by GitBook
1 of 1

Loading...

Business objects & API collections

This topic lists all business objects available in the SoftwareOne Marketplace REST API and the corresponding API collection endpoints used to access them.

Use this page as a centralized reference to identify the correct object types and endpoints when designing integrations or reviewing platform capabilities.

Object ID prefixes

Every object in the Marketplace Platform has a unique identifier with a prefix that indicates the object type. Use these prefixes to quickly identify what kind of object you are working with:

Accounts

Object Type
Prefix
Example
Object Type
Prefix
Example
Object Type
Prefix
Example
Object Type
Prefix
Example
Object Type
Prefix
Example
Object Type
Prefix
Example
Object Type
Prefix
Example
Object Type
Prefix
Example
Object Type
Prefix
Example
Object Type
Prefix
Example
Collection
Path
Collection
Path
Collection
Path
Collection
Path
Collection
Path
Collection
Path
Collection
Path
Collection
Path
Collection
Path

ACC-

ACC-1234-5678

BUY-

BUY-5171-6994

CLT-

CLT-1976-5289

ERP-

ERP-1456-2363-9856

LCE-

LCE-8499-1473-5603

MOD-

MOD-1234

SEL-

SEL-6685-4945

USR-

USR-3758-7092

UGR-

UGR-0601-5102

TKN-

TKN-9299-7556

AET-

AET-8784-9237

AUD-

JOA-

JOA-4710-3489

CHG-

PRD-

PRD-2689-4589

AGR-

AGR-5896-1479-0269

ORD-

CUR-

CUR-1234-4678

FXP-

EXT-

EXT-5984-1232

EXC-

WBH-

WBH-5987-1258

NTC-

PRG-

PRG-7432-9033

PPG-

SPO-

SPO-<5694>-<8956>-<1010>-<3975>-<2134>

SPQ-

/public/v1/accounts/accounts

/public/v1/accounts/buyers

/public/v1/audit/event-types

/public/v1/audit/records

/public/v1/billing/credit-memos

/public/v1/billing/custom-ledgers

/public/v1/catalog/products

/public/v1/catalog/products/{id}/items

/public/v1/commerce/agreements

/public/v1/commerce/orders

/public/v1/integration/extensions

/public/v1/integration/categories

/public/v1/notifications/webhooks

/public/v1/notifications/categories

/public/v1/program/programs

/public/v1/program/programs/{id}/parameter-groups

/v1/spotlight/objects

Audit

Billing

Catalog

Commerce

Currency

Extensions

Notifications

Program

Spotlight

SpotlightTopItem object does not have its own unique prefix. It uses the same ID prefix as the related object.

Collections

Accounts

Audit Trail

Billing

Catalog

Commerce

Extension

Notifications

Program

Spotlight

AUD-5681-1729-3068-0895

CHG-5841-6913-2879-2010-9301

CRD

CRD-8280-7533-0235-8348

CRL-

CRL-5974-2302-1490-9437

CLE-

CLE-5974-2384

INV-

INV-2078-0901-9457-5058

INL-

INL-4836-8218-0290-3679

BJO-

BJO-7823-5971

BLE-

BLE-5694-5681

BOV-

BOV-5895-8712

SOM-

SOM-6005-1054-1535-5364

ITM-

ITM-2598-1496-3258

IGR-

IGR-5895-5343-9056

PGR-

PGR-3452-0864-2005

PAR-

PAR-6064-5794-1256

MED-

MED-8053-5894-1289

DOC-

DOC-5841-7434-9044

TCS-

TCS-1795-2689-9856

TPL-

TPL-0215-9943-4590

PRC-

PRC-8485-1289-3478

PRI-

PRI-5804-4357-0742-1065

LST-

LST-9635-2894

AUT-

AUT-8914-4365

UNT-

UNT-5892

PRP-

PRP-5634-4806-1075

PPA-

PPA-6324-1708-0298-3578

ORD-5879-2698-3893

SUB-

SUB-1548-1246-0954

REQ-

REQ-7319-1974-9054

ALI-

ALI-6199-1408-4789-1964

AST-

AST-5971-3179-2597

FXP-1234-4678

FXR-

FXR-1234-4678-0000-0001

EXC-7310

EDM-

EDM-9741-3001-2984

EXM-

EXM-5674-1974-2684

ETC-

ETC-2697-1456-9745

ETV-

ETV-2358-0125-3789-1158

INS-

INS-5684-3645-8945-2156

EXI-

EXI-8945-2589-6485

NTC-2987-6471

CTT-

CTT-8925-0193

MST-

MST-5874-3684-5986

MSG-

MSG-2589-4597-5689-2689

NTS-

NTS-5987-0126-9125

PPG-6456-5841-9785

PPM-

PPM-2589-6489-2587

PMD-

PMD-2486-8946-2547

PDM-

PDM-2686-7895-2389

PTC-

PTC-1478-6974-2569

PTV-

PTV-2599-3474-2579-2395

PTM-

PTM-5977-5689-4785

CER-

CER-9845-5647-2387

ENR-

ENR-3795-5796-1254

ENA-

ENA-9025-3547-8914-2368

SPQ-2565-5895

Not applicable

Not applicable

/public/v1/accounts/cloud-tenants

/public/v1/accounts/erp-links

/public/v1/accounts/licensees

/public/v1/modules

/public/v1/accounts/sellers

/public/v1/accounts/tokens

/public/v1/accounts/users

/public/v1/billing/invoices

/public/v1/billing/journals

/public/v1/billing/ledgers

/public/v1/billing/overrides

/public/v1/billing/statements

/public/v1/catalog/products/{id}/item-groups

/public/v1/catalog/products/{id}/parameter-groups

/public/v1/catalog/products/{id}/parameters

/public/v1/catalog/products/{id}/media

/public/v1/catalog/products/{id}/documents

/public/v1/catalog/products/{id}/terms

/public/v1/catalog/products/{id}/templates

/public/v1/catalog/items

/public/v1/catalog/price-lists

/public/v1/catalog/price-lists/{id}/items

/public/v1/catalog/listings

/public/v1/catalog/authorizations

/public/v1/catalog/units-of-measure

/public/v1/catalog/pricing-policies

/public/v1/commerce/subscriptions

/public/v1/commerce/requests

/public/v1/commerce/assets

/public/v1/integration/extensions/{id}/documents

/public/v1/integration/extensions/{id}/media

/public/v1/integration/extensions/{id}/terms

Hosting

/public/v1/integration/hosting

/public/v1/integration/instances/{eid}

/public/v1/integration/installations

/public/v1/notifications/contacts

/public/v1/notifications/batches

/public/v1/notifications/messages

/public/v1/notifications/subscribers

/public/v1/program/programs/{id}/parameters

/public/v1/program/programs/{id}/media

/public/v1/program/programs/{id}/documents

/public/v1/program/programs/{id}/terms

/public/v1/program/programs/{id}/templates

/public/v1/program/certificates

/public/v1/program/enrollments

Account
Buyer
Cloud Tenant
ERP Link
Licensee
Module
Seller
User
Group
Token
Audit Event Type
Audit Record
Billing Attachment
Charge
Product
Item
Agreement
Order
Currency
Pair
Extension
Category
Webhook
Category
Program
Parameter Group
Spotlight
SpotlightQuery
Accounts
Buyers
Cloud Tenant
Audit Event Types
Audit Records
Credit Memo
Custom Ledgers
Invoices
Products
Items
Item Groups
Agreements
Orders
Subscriptions
Extension
Categories
Documents
Webhooks
Categories
Contacts
Programs
Parameter Groups
Parameters
Spotlight
Credit Memo
Credit Memo Line
Custom Ledger
Invoice
Invoice Line
Journal
Ledger
Override
Statement
Item Group
Parameter Group
Parameter
Media
Document
Terms and Conditions
Template
Price List
Price List Item
Listing
Authorization
Unit Of Measure
Pricing Policy
Pricing Policy Attachment
Subscription
Request
Line
Asset
Rate
Document
Media
Term
Term Variant
Instance
Installation
Contact
Batch
Message
Subscriber
Program Parameter
Program Media
Program Document
Program Terms
Program Terms Variant
Program Template
Certificate
Enrollment
Enrollment Attachment
SpotlightTopItem
ERP Links
Licensees
Modules
Sellers
Tokens
Users
Journals
Ledgers
Overrides
Statements
Parameter Groups
Parameters
Media
Documents
Terms and Conditions
Templates
Items
Price Lists
Price List Items
Listings
Authorizations
Units of Measure
Pricing Policies
Requests
Assets
Media
Terms
Instances
Installations
Batches
Messages
Subscribers
Media
Documents
Terms and Conditions
Templates
Certificates
Enrollments