All Verbs | /service/ShareProductCatalogPages | ||
---|---|---|---|
All Verbs | /service/ShareProductCatalogPages/{ShareKind} | ||
All Verbs | /service/PrintProductCatalogPages | ||
All Verbs | /service/EmailProductCatalogPages |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ImageSize | query | string | No | |
PageIds | query | string[] | No | |
ProductIds | query | string[] | No | |
ShareKind | path | ShareKind | No | |
CartId | query | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
StubbornVendorId | form | string | No | |
SendTo | form | string | No | |
Subject | form | string | No | |
SubjectOverWrite | form | string | No | |
Message | form | string | No | |
ReplyTo | form | string | No | |
Bcc | form | string | No | |
Cc | form | string | No | |
Body | form | string | No | |
ToEmail | form | string | No | |
To | form | string | No | |
From | form | string | No | |
FromEmail | form | string | No | |
ReplyToList | form | IEnumerable<string> | No | |
Recipients | form | IEnumerable<string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Products | form | List<Product> | No | |
Pages | form | List<ProductCatalogPage> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
ProductLineId | form | string | No | |
ManufacturerNumber | form | string | No | |
ShortDescription | form | string | No | |
LongDescription | form | string | No | |
AltDescription | form | string | No | |
UpcCode | form | string | No | |
Status | form | string | No | |
Pricing | form | IDictionary<int, double> | No | |
ListPrice | form | decimal | No | |
WholesalePrice | form | decimal | No | |
RetailPrice | form | decimal? | No | |
RetailListPrice | form | decimal | No | |
UnitsInStock | form | int | No | |
UnitsAllocated | form | int | No | |
Price | form | decimal? | No | |
Unlisted | form | bool | No | |
CategoryId | form | string | No | |
Category | form | ProductCategory | No | |
MinimumOrderQty | form | double | No | |
AvailableQty | form | double | No | |
CaseQty | form | double | No | |
CasePrice | form | decimal | No | |
AvailableOn | form | DateTime? | No | |
IncomingQty | form | double | No | |
PurchaseIncrement | form | double | No | |
OptionGroup | form | string | No | |
OptionGroupList | form | string | No | |
VendorId | form | string | No | |
Vendor | form | Vendor | No | |
IsB2B | form | bool | No | |
IsB2C | form | bool | No | |
IsSellable | form | bool | No | |
IsNonDiscountable | form | bool | No | |
ItemType | form | string | No | |
ImageUrl | form | string | No | |
OnDemandProductEuid | form | string | No | |
Keywords | form | string | No | |
SuperCategory | form | string | No | |
Tags | form | Dictionary<string, HashSet<String>> | No | |
AsShownValues | form | FieldValue[] | No | |
GenericTags | form | List<Tag> | No | |
IsNew | form | bool | No | |
IsRestricted | form | bool | No | |
IsAsShown | form | bool | No | |
IsKit | form | bool | No | |
IsKitExplode | form | bool | No | |
IsKitEditable | form | bool | No | |
Meta | form | Dictionary<string, string> | No | |
IsOnDemand | form | bool | No | |
CreatedOn | form | DateTime | No | |
Weight | form | double | No | |
Height | form | decimal | No | |
Width | form | double | No | |
Length | form | decimal | No | |
CubicVolume | form | double | No | |
MaxNumLines | form | int | No | |
Cost | form | decimal | No | |
UOM | form | string | No | |
SubCategory | form | string | No | |
ShipOn | form | DateTime? | No | |
Featured | form | int | No | |
Likes | form | long | No | |
HasLiked | form | bool | No | |
EnforceMinimum | form | bool | No | |
Points | form | decimal | No | |
Custom9 | form | string | No | |
ProductImages | form | List<ProductImage> | No | |
IsDealerVisible | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | K | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Label | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Label | form | string | No | |
VendorName | form | string | No | |
Abbreviation | form | string | No | |
OrderMinimum | form | decimal | No | |
ReOrderMinimum | form | decimal | No | |
MinimumBalance | form | decimal | No | |
Active | form | bool | No | |
IsInvoiceOnly | form | bool | No | |
AllowPriceOverride | form | bool | No | |
DefaultShipDatePrevious | form | bool | No | |
EnforceMinimums | form | bool | No | |
EnforcePurchaseIncrement | form | bool | No | |
AllowDiscounts | form | bool | No | |
EmailOrders | form | bool | No | |
AllowBackorders | form | bool | No | |
UseVendorCustId | form | bool | No | |
UseVendorShipId | form | bool | No | |
UseVendorTerms | form | bool | No | |
ExportReviewOrders | form | bool | No | |
EmailUrlToExport | form | bool | No | |
IncludeInBatch | form | bool | No | |
DecryptCCOnExport | form | bool | No | |
CustomerNumber | form | string | No | |
ExportOrders | form | bool | No | |
SplitByProductLine | form | bool | No | |
IsShowroomVendor | form | bool | No | |
AllowManualItemEntry | form | bool | No | |
RequireCreditSheet | form | bool | No | |
Address | form | string | No | |
City | form | string | No | |
State | form | string | No | |
Zip | form | string | No | |
Phone | form | string | No | |
Fax | form | string | No | |
form | string | No | ||
Website | form | string | No | |
Note | form | string | No | |
CommissionPercent | form | decimal | No | |
OrderTagLine | form | string | No | |
ProductTags | form | List<VendorProductTag> | No | |
Settings | form | List<VendorSetting> | No | |
LastLoginAttempt | form | DateTime | No | |
LastOrderedOn | form | DateTime | No | |
Meta | form | Dictionary<string, string> | No | |
Tags | form | Dictionary<string, HashSet<String>> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Tag | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
VendorId | form | string | No | |
Key | form | string | No | |
Value | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
FieldId | form | string | No | |
ValueId | form | string | No | |
CustomText | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | double | No | |
Shard | form | string | No | |
PrincipalId | form | string | No | |
TagKind | form | string | No | |
TagLabel | form | string | No | |
ParentTagKind | form | string | No | |
ParentTagLabel | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CreatedBy | form | string | No | |
CreatedOn | form | DateTime | No | |
LastModifiedOn | form | DateTime | No | |
LastModifiedBy | form | string | No | |
Generated | form | bool | No | |
Exported | form | bool | No | |
Position | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ProductId | form | string | No | |
Position | form | int | No | |
CreatedOn | form | DateTime | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
CatalogId | form | string | No | |
SectionId | form | string | No | |
PageNum | form | int | No | |
Position | form | int | No | |
RepCustom | form | bool | No | |
MediaId | form | string | No | |
ModifiedOn | form | DateTime | No | |
LastModifiedOn | form | DateTime | No | |
Label | form | string | No | |
Attributes | form | ProductCatalogPageAttributes | No | |
Url | form | string | No | |
Overview | form | string | No | |
Description | form | string | No | |
Width | form | double? | No | |
Height | form | double? | No | |
Type | form | string | No | |
PageCount | form | int? | No | |
Layout | form | string | No | |
Hotspots | form | List<ProductCatalogHotspot> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
Euid | form | Guid? | No | |
Label | form | string | No | |
Description | form | string | No | |
Overview | form | string | No | |
Realm | form | string | No | |
Url | form | string | No | |
ContentType | form | string | No | |
Height | form | double? | No | |
Width | form | double? | No | |
RefId | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
PageId | form | string | No | |
Action | form | HotspotActions | No | |
ProductId | form | string | No | |
MediaId | form | string | No | |
YouTubeId | form | string | No | |
ExternalResource | form | string | No | |
LinkedSectionId | form | string | No | |
LinkedCatalogId | form | string | No | |
LinkedPageId | form | string | No | |
Meta | form | Dictionary<string, string> | No | |
ProductIds | form | IEnumerable<string> | No | |
OriginalWidth | form | int | No | |
OriginalHeight | form | int | No | |
Left | form | int | No | |
Top | form | int | No | |
Right | form | int | No | |
Bottom | form | int | No | |
Width | form | int | No | |
Height | form | int | No | |
Generated | form | bool | No | |
RepCustom | form | bool | No | |
Position | form | int | No | |
ModifiedOn | form | DateTime | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /service/ShareProductCatalogPages HTTP/1.1
Host: www.bernhardt.com
Accept: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Content-Length: length
{"imageSize":"String","pageIds":["String"],"productIds":["String"],"shareKind":"Print","cartId":"String","stubbornVendorId":"String","sendTo":"String","subject":"String","subjectOverWrite":"String","message":"String","replyTo":"String","bcc":"String","cc":"String","body":"String","toEmail":"String","to":"String","from":"String","fromEmail":"String","replyToList":[],"recipients":[]}
HTTP/1.1 200 OK Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet Content-Length: length {"products":[{"id":"String","productLineId":"String","manufacturerNumber":"String","shortDescription":"String","longDescription":"String","altDescription":"String","upcCode":"String","status":"String","listPrice":0,"wholesalePrice":0,"retailPrice":0,"retailListPrice":0,"unitsInStock":0,"unitsAllocated":0,"unlisted":false,"categoryId":"String","category":{"id":"String","label":"String"},"minimumOrderQty":0,"availableQty":0,"caseQty":0,"casePrice":0,"availableOn":"0001-01-01T00:00:00.0000000Z","incomingQty":0,"purchaseIncrement":0,"optionGroup":"String","optionGroupList":"String","vendorId":"String","vendor":{"id":"String","label":"String","vendorName":"String","abbreviation":"String","orderMinimum":0,"reOrderMinimum":0,"minimumBalance":0,"active":false,"isInvoiceOnly":false,"allowPriceOverride":false,"defaultShipDatePrevious":false,"enforceMinimums":false,"enforcePurchaseIncrement":false,"allowDiscounts":false,"emailOrders":false,"allowBackorders":false,"useVendorCustId":false,"useVendorShipId":false,"useVendorTerms":false,"exportReviewOrders":false,"emailUrlToExport":false,"includeInBatch":false,"decryptCCOnExport":false,"customerNumber":"String","exportOrders":false,"splitByProductLine":false,"isShowroomVendor":false,"allowManualItemEntry":false,"requireCreditSheet":false,"address":"String","city":"String","state":"String","zip":"String","phone":"String","fax":"String","email":"String","website":"String","note":"String","commissionPercent":0,"orderTagLine":"String","productTags":[{"id":"String","tag":"String"}],"settings":[{"vendorId":"String","key":"String","value":"String"}],"lastLoginAttempt":"0001-01-01T00:00:00.0000000Z","lastOrderedOn":"0001-01-01T00:00:00.0000000Z","meta":{"String":"String"},"tags":{"String":["String"]}},"isB2B":false,"isB2C":false,"isSellable":false,"isNonDiscountable":false,"itemType":"String","imageUrl":"String","onDemandProductEuid":"String","keywords":"String","superCategory":"String","tags":{"String":["String"]},"asShownValues":[{"fieldId":"String","valueId":"String","customText":"String"}],"genericTags":[{"id":-1982275678.19823,"shard":"String","principalId":"String","tagKind":"String","tagLabel":"String","parentTagKind":"String","parentTagLabel":"String","createdBy":"String","createdOn":"0001-01-01T00:00:00.0000000Z","lastModifiedOn":"0001-01-01T00:00:00.0000000Z","lastModifiedBy":"String","generated":false,"exported":false,"position":0}],"isNew":false,"isRestricted":false,"isAsShown":false,"isKit":false,"isKitExplode":false,"isKitEditable":false,"meta":{"String":"String"},"isOnDemand":false,"createdOn":"0001-01-01T00:00:00.0000000Z","weight":0,"height":0,"width":0,"length":0,"cubicVolume":0,"maxNumLines":0,"cost":0,"uom":"String","subCategory":"String","shipOn":"0001-01-01T00:00:00.0000000Z","featured":0,"likes":1,"hasLiked":false,"enforceMinimum":false,"points":0,"custom9":"String","productImages":[{"productId":"String","position":0,"createdOn":"0001-01-01T00:00:00.0000000Z"}],"isDealerVisible":false}],"pages":[{"id":"String","catalogId":"String","sectionId":"String","pageNum":0,"position":0,"repCustom":false,"mediaId":"String","modifiedOn":"0001-01-01T00:00:00.0000000Z","lastModifiedOn":"0001-01-01T00:00:00.0000000Z","label":"String","attributes":{"id":0,"euid":"00000000-0000-0000-0000-000000000000","label":"String","description":"String","overview":"String","realm":"String","url":"String","contentType":"String","height":0,"width":0,"refId":"String"},"url":"String","overview":"String","description":"String","width":0,"height":0,"type":"String","pageCount":0,"layout":"String","hotspots":[{"id":"String","pageId":"String","action":"None","productId":"String","meta":{"String":"String"},"originalWidth":0,"originalHeight":0,"left":0,"top":0,"right":0,"bottom":0,"width":0,"height":0,"generated":false,"repCustom":false,"position":0,"modifiedOn":"0001-01-01T00:00:00.0000000Z"}]}]}