GET webproductid/{webproductId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
webproductId

string

Required

Body Parameters

None.

Response Information

Resource Description

WebProduct
NameDescriptionTypeAdditional information
CartRoute

string

None.

CheckoutRoute

string

None.

StoreFrontRoute

string

None.

WebFormRoute

string

None.

AdminOnly

boolean

None.

BlockCodeIdentity

string

None.

Id

string

None.

ContactId

string

None.

ContactFullName

string

None.

BlockCodes

Collection of string

None.

Blocked

boolean

None.

SoldOut

boolean

None.

AllowAutoPay

boolean

None.

DisplayName

string

None.

DisplayOrder

decimal number

None.

Description

string

None.

LongDescription

string

None.

eCommCartRoute

string

None.

eCommCheckoutRoute

string

None.

eCommProductId

string

None.

AllowExternalEcommmerce

boolean

None.

DonationFrequency

string

None.

ImageUrl

string

None.

Price

decimal number

None.

InstallmentPlanId

globally unique identifier

None.

HasInstallmentPlan

boolean

None.

InstallmentPrice

decimal number

None.

IsRestricted

boolean

None.

AlreadyRegistered

boolean

None.

RegistrationTypeId

string

None.

Selected

boolean

None.

HasQuestions

boolean

None.

IsProduct

boolean

None.

IsSession

boolean

None.

IsEvent

boolean

None.

IsDonation

boolean

None.

EventId

globally unique identifier

None.

ProgramId

globally unique identifier

None.

ProductId

globally unique identifier

None.

RegistrationOption

integer

None.

IsProgram

boolean

None.

IsAccountProgram

boolean

None.

HasUpsellProducts

boolean

None.

HasOptionalAdditionalBenefits

boolean

None.

SendToSimple

boolean

None.

ShowQuantity

boolean

None.

GuestDisplayQuantity

integer

None.

JavaScript

string

None.

HeaderHTML

string

None.

FooterHTML

string

None.

PricingErrorMessage

string

None.

QuantityLabel

string

None.

Quantity

integer

None.

UpsellCategoryId

globally unique identifier

None.

NextWebProductId

globally unique identifier

None.

NextWebProductRoute

string

None.

DetailRoute

string

None.

NextCategoryId

globally unique identifier

None.

NextWebForm

string

None.

EventBeginDate

date

None.

Attendees

Collection of Attendee

None.

Guests

Collection of Guest

None.

WebProductQuestions

Collection of WebProductQuestion

None.

SessionWebProducts

Collection of WebProduct

None.

SessionGroups

Collection of SessionGroup

None.

EventPricings

Collection of EventPricing

None.

OptionalAdditionalBenefitGroups

Collection of AdditioinalBenefitGroup

None.

UpsellProducts

Collection of WebProduct

None.

Session

Session

None.

Event

Event

None.

ChargeTaxes

boolean

None.

HasBulkOption

boolean

None.

ChargeShipping

boolean

None.

AccountingCompanyId

string

None.

SelectedMealOption

string

None.

AddNewContactForm

string

None.

SelectedRegistrationType

string

None.

HasMealOptions

boolean

None.

MealOptions

Collection of MealOption

None.

IsAccountAdmin

boolean

None.

HasPreReqs

boolean

None.

AccountMembershipShoppingCartItemInCart

boolean

None.

DisableAddToCart

boolean

None.

IsEventAtCapacity

boolean

None.

IsSessionAtCapacity

boolean

None.

AdminAccounts

Collection of Option

None.

RegisterOthersAccounts

Collection of RegisterOthersAccount

None.

PrerequisiteResponse

PrerequisiteResponse

None.

MinDonationAmount

decimal number

None.

DefaultDonationAmounts

Collection of decimal number

None.

DefaultDonationFrequencies

Collection of OptionSetValue

None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.