AfterHours5

AIAgents9

Announcements2

ApplicationAccess1

Assets89

AssetTaskResponse5

AssetTypes25

Attachments31

BatchRfp1

Branding1

Categories6

CheckLists10

Classification2

Compliance5

Contracts5

put/contracts/retireRetire Provider Contract. When 'Trade' and 'StoreId' are not specified then provider is 'retired' from all subscriber's stores.
get/contractsReturns provider active contracts by providerId, locationId and trade
get/GetPrimaryRankedProviders/{subscriberId}Get Primary Ranked Providers of all primary ranked providers for all Trades for a given subscriber
get/GetPrimaryRankedProviderTrades/{subscriberId}/{providerId}Get trades for primary ranked provider
get/GetPrimaryRankedProviderLocations/{subscriberId}/{providerId}/{tradeId}Get locations for primary ranked provider

ContractServiceRates4

Ctools8

Currencies1

DashboardSettings10

EmailNotifications4

Eula2

Feedback7

GlCodes5

Invoices18

IssueList38

LocationNotes2

Locations38

LocationSupply4

MliConfiguration8

MobileTheme7

Notes8

NotificationSubscriptions11

NotificationWebHooks5

OutgoingXml30

Parts10

PlannedMaintenance2

PlatformIntelligence1

Priorities3

Proposals35

ProviderAssignment2

Providers13

PushNotifications4

RefrigerantTracking58

ResolutionCodes8

Rfps6

Roles1

ScConnector10

ServiceRequest10

SingleSignOn4

SiteAudit22

Subscribers10

SupplyClick1

SurveyQuestions5

TemplateFilesHistory1

Trades10

Tradesmen1

Training1

Trucks9

Users15

Weather2

WorkActivities6

WorkOrders65

WorkRequestNote4

WorkRequests14

Contracts

Retire Provider Contract. When 'Trade' and 'StoreId' are not specified then provider is 'retired' from all subscriber's stores.

Available only for Subscriber Super Admin user.

put/contracts/retire

Request

Base URL
https://sb2api.servicechannel.com/v3
Auth
OAuth 2
Authorization codehttps://sb2login.servicechannel.com/oauth/authorize
Token URLhttps://sb2login.servicechannel.com/oauth/token
TypeScript
https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/docs/contracts/retire/put.ts
A function with typed inputs. Its response is checked against the schema.

Request body

StoreIdstring

Optional, When 'Trade' and 'StoreId' are not specified then provider is 'retired' from all subscriber's stores.

Tradestring

Optional, When 'Trade' and 'StoreId' are not specified then provider is 'retired' from all subscriber's stores.

ProviderIdinteger required

Required Provider Id

Response

Indicates that the request succeeded. When 'Trade' and 'StoreId' are not specified then provider is 'retired' from all subscriber's stores.

SystemObject required

Changes

No recorded changes to this operation across all 1 revision of this API.

Retire Provider Contract. When 'Trade' and 'StoreId' are not specified then provider is 'retired' from all subscriber's stores.

Request

Request body

Response 200OK

Changes

Response