Znode

GET portals/{portalId}

Gets a portal.

Request Information

» Parameters

Name Description Additional information
portalId The ID of the portal.

Define this parameter in the request URI.

» Expands

Name Description Usage
catalogs This will retrieve the related catalogs. GET portals/{portalId}?expand=catalogs
portalCountries This will retrieve the related list of portal countries. GET portals/{portalId}?expand=portalcountries

Response Information

» Response Body Formats

If this endpoint supports expands, they will be included in the sample response body below. However, please note that expands are NOT included in the response body by default. Expands are only included in the response body if they came through as part of the request.

Sample:
	{
  "Portal": {
    "AdminEmail": "admin@test.com",
    "CompanyName": "MaxWell's",
    "Catalogs": [],
    "CurrencyTypeId": 107,
    "CustomerServiceEmail": "customerservice@test.com",
    "CustomerServicePhoneNumber": "555-111-2222",
    "DefaultAnonymousProfileId": 1,
    "DefaultOrderStateId": 50,
    "DefaultProductReviewStateId": 10,
    "DefaultRegisteredProfileId": 2,
    "DefaultReviewStatus": "N",
    "DimensionUnit": "IN",
    "EmailListDefaultList": null,
    "EmailListPassword": null,
    "EmailListUsername": null,
    "EnableAddressValidation": true,
    "EnableCustomerPricing": false,
    "EnablePims": false,
    "ExternalId": null,
    "FedExAccountNumber": "icZ1z0zfF54=",
    "FedExAddInsurance": true,
    "FedExClientProductId": "KHHG",
    "FedExClientProductVersion": "3203",
    "FedExCspKey": "vuB2Ui3CCpHkCs53",
    "FedExCspPassword": "TAt234utxOFiJuJM2Yw0oL7sD",
    "FedExDropoffType": "REGULAR_PICKUP",
    "FedExMeterNumber": "icZ1z0zfF54=",
    "FedExPackagingType": "YOUR_PACKAGING",
    "FedExProductionKey": "icZ1z0zfF54=",
    "FedExSecurityCode": "icZ1z0zfF54=",
    "FedExUseDiscountRate": false,
    "GoogleAnalyticsCode": null,
    "ImageNotAvailablePath": "~/data/default/images/noimage.gif",
    "InclusiveTax": true,
    "IsActive": true,
    "IsShippingTaxable": false,
    "LocaleId": 43,
    "LogoPath": "~/data/default/content/maxwell.gif",
    "MasterPage": null,
    "MaxCatalogCategoryDisplayThumbnails": 5,
    "MaxCatalogDisplayColumns": 4,
    "MaxCatalogDisplayItems": 12,
    "MaxCatalogItemCrossSellWidth": 97,
    "MaxCatalogItemLargeWidth": 450,
    "MaxCatalogItemMediumWidth": 250,
    "MaxCatalogItemSmallThumbnailWidth": 37,
    "MaxCatalogItemSmallWidth": 100,
    "MaxCatalogItemThumbnailWidth": 50,
    "MobileTheme": "B2B",
    "OrderReceiptAffiliateJavascript": null,
    "PersistentCartEnabled": true,
    "PortalCatalogs": [],
    "PortalCountries": [
      {
        "Country": null,
        "CountryCode": "US",
        "IsBillingActive": true,
        "IsShippingActive": true,
        "PortalCountryId": 1,
        "PortalId": 1,
        "CountryName": "United States"
      }
    ],
    "PortalId": 1,
    "RequireValidatedAddress": true,
    "SalesEmail": "sales@test.com",
    "SalesPhoneNumber": "555-111-2222",
    "SeoDefaultCategoryDescription": null,
    "SeoDefaultCategoryKeyword": null,
    "SeoDefaultCategoryTitle": null,
    "SeoDefaultContentDescription": null,
    "SeoDefaultContentKeyword": null,
    "SeoDefaultContentTitle": null,
    "SeoDefaultProductDescription": null,
    "SeoDefaultProductKeyword": null,
    "SeoDefaultProductTitle": null,
    "ShippingOriginAddress1": "123 Anywhere Street",
    "ShippingOriginAddress2": "",
    "ShippingOriginCity": "Columbus",
    "ShippingOriginCountryCode": "US",
    "ShippingOriginPhone": "555-111-2222",
    "ShippingOriginStateCode": "OH",
    "ShippingOriginZipCode": "43210",
    "ShopByPriceIncrement": 20,
    "ShopByPriceMax": 100,
    "ShopByPriceMin": 0,
    "ShowAlternateImageInCategory": false,
    "ShowSwatchInCategory": false,
    "SiteWideAnalyticsJavascript": null,
    "SiteWideBottomJavascript": null,
    "SiteWideTopJavascript": null,
    "SmtpPassword": "icZ1z0zfF54=",
    "SmtpPort": 25,
    "SmtpServer": "",
    "SmtpUsername": "icZ1z0zfF54=",
    "SplashCategoryId": 81,
    "SplashImageFile": "images_231110124101_061210031622.gif",
    "StoreName": "Fine Foods",
    "TimeZoneOffset": null,
    "UpsKey": "icZ1z0zfF54=",
    "UpsPassword": "icZ1z0zfF54=",
    "UpsUsername": "icZ1z0zfF54=",
    "UseDynamicDisplayOrder": false,
    "UseSsl": true,
    "WeightUnit": "LBS",
    "OrderStatus": null,
    "DefaultProductReviewStateName": null,
    "CurrencySuffix": null,
    "CurrencyName": null,
    "CatalogName": null,
    "CssName": null,
    "ThemeName": null,
    "LocaleDescription": null,
    "IsEnableCompare": false,
    "CompareType": null,
    "TabMode": null,
    "IsMultipleCouponAllowed": false,
    "IsEnableSinglePageCheckout": false,
    "MobileLogoPath": "images_231110124101_061210031622.gif",
    "CurrencyTypeModel": {
      "CurrencyTypeID": 0,
      "Name": null,
      "Description": null,
      "CurrencySuffix": null,
      "Symbol": null
    },
    "EnableSslForSmtp": false,
    "QuickOrderSort": null
  },
  "IsMessagesCreated": false,
  "IsStoreCopied": false,
  "ErrorCode": null,
  "ErrorMessage": null,
  "HasError": false
}