v1

latestSwagger 2.0BeezUP2026-07-13254876845.8 KB
Marketplaces - Channel catalogs - Settings

Get the marketplace properties for a channel catalog

get/v2/user/marketplaces/channelcatalogs/{channelCatalogId}/properties

Path parameters

channelCatalogIdstring guid required

Query parameters

redirectionPageUrlstring uri required

Headers

Accept-Languagestring[]

Indicates that the client accepts the following languages.

Response

Successfully fetched channel catalog properties

Example response

{
  "links": {
    "self": {
      "href": "/v2/user/marketplaces/channelcatatalogs/6a90fcfd-24c7-422e-a65f-aadb1725bbfe/properties"
    },
    "settings": {
      "href": "/v2/user/marketplaces/channelcatatalogs/6a90fcfd-24c7-422e-a65f-aadb1725bbfe/settings"
    },
    "externalConfigurationPage": {
      "label": "The translated label",
      "docUrl": "https://api-docs.beezup.com/#operation/EnableChannelCatalog",
      "description": "This is a description link",
      "href": "/v2/marketplaces/orders/{marketplaceTechnicalCode}/{accountId}/{beezUPOrderId}",
      "operationId": "GetOrder",
      "method": "GET"
    }
  },
  "propertyGroups": [
    {
      "name": "AccountInformations",
      "position": "1",
      "properties": [
        {
          "name": "EbayToken",
          "position": "1",
          "readOnly": "true",
          "values": [
            "AgAAAA**AQAAAA**aAAAAA**2VFhVg**nY+sHZ2PrBmdj6wVnY+sEZ2PrA2dj6AElISgCJaLpwWdj6x9nY+seQ**OEsBAA**AAMAAA**jzsVAMwj1dPBsyCEp0Fuj/toSBrfZF2JpKKDrrXIirMzgvgbsyxnA2h1wl7WjFD+TfdCmaBq3CAFLOog/433G5gsse1DLTT6uXFajdiHnPVfnL7QtKIpQEIwL8ZO5Tx1dGl0XQLsU7knPwbGHn5X6Z3JzXrCGvvpw2+MIzDNhasYlqPfOEr8Lct5dcsIIdhXl/qgrzALe5++v76/XjaXvP6eic3uCWBEXBiXC1uisjEtOqaNIPkFaiICBaXsQUzVZdM68bQatBg5bwf6hxvqOyNJRw4pttGStovcXXjL+aszw7ejbxLv1lJ6qeTMj5oRwTPl0AzBAejcY+DTBrLEmgdzrvWHLvMOa1ijGOGzVodBoDGimiqadCPQpAVZr0e7HvQIVbOlbmKpuCUFJ4RPCv0NxpkCm1/nxZWeS9H8gd/SfLf9Chgd115dcKzgxFBoSh7myJcw+MRM7szPQ2Pwv980dTRyHvbI8XR4OieYvXmU4H7Nl51N8B3qkjYFkdcp6J06eqs4dO68lDNdWZfXHkjwI3dY6umDUp4y82IdQl8IykPty3/DZfUAfqafgiAwMHZvXjewp5HhPjDi2zgf+5EcDlvf6rNMzjsghjdWUQi4WldDk+LXgkos6jswIQaNPdpW1D4KyPYWtGYknx0Xzzuc6WmBoVwGFalgMvCWWI9Gs2w6PG5GqB9zm1Fnr3svtPbNYPQ6q3VQpkKL2SWQXy383O1cp6ZMLI9GwZe0FnrqCxb/wc4XJUVw2RoR3qiX"
          ]
        },
        {
          "name": "PayPalEmailAddress",
          "position": "2",
          "required": true,
          "pattern": "(?:[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*|\"(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21\\x23-\\x5b\\x5d-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])*\")@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-z0-9-]*[a-z0-9]:(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21-\\x5a\\x53-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])+)\\])",
          "x-pattern": "(?:[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*|\"(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21\\x23-\\x5b\\x5d-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])*\")@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-z0-9-]*[a-z0-9]:(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21-\\x5a\\x53-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])+)\\])"
        }
      ]
    },
    {
      "displayGroupCode": "AnnounceTitle",
      "displayGroupPosition": "2",
      "properties": [
        {
          "name": "Postalcode",
          "required": true,
          "position": "1"
        },
        {
          "name": "Country",
          "position": "2",
          "required": true,
          "lovLink": {
            "href": "/v2/user/lov/Country_eBay"
          },
          "lovRequired": "true"
        },
        {
          "name": "ReturnsWithinOption",
          "position": "3",
          "required": true,
          "lovLink": {
            "href": "/v2/user/lov/ReturnsWithinDuration_eBay"
          },
          "lovRequired": "true"
        },
        {
          "name": "ShippingService",
          "position": "4",
          "required": true,
          "lovLink": {
            "href": "/v2/user/lov/FRA_ShippingService_eBay"
          },
          "lovRequired": "true"
        },
        {
          "name": "Currency",
          "position": "5",
          "required": true,
          "lovLink": {
            "href": "/v2/user/lov/Currency_eBay"
          },
          "lovRequired": "true"
        },
        {
          "name": "PaymentMethods",
          "position": "6",
          "required": true,
          "lovLink": {
            "href": "/v2/user/lov/PaymentMethods_eBay"
          },
          "lovRequired": "true",
          "minItems": 1,
          "maxItems": 2
        }
      ]
    },
    {
      "displayGroupCode": "SalesConditions",
      "displayGroupPosition": "3",
      "properties": [
        {
          "name": "ReturnsAcceptedOption",
          "position": "1",
          "required": true,
          "lovLink": {
            "href": "/v2/user/lov/ReturnsAcceptedOption_eBay"
          },
          "lovRequired": "true"
        },
        {
          "name": "ShippingCostPaidByOption",
          "position": "2",
          "required": true,
          "lovLink": {
            "href": "/v2/user/lov/ShippingCostPaidByOption_eBay"
          },
          "lovRequired": "true"
        },
        {
          "name": "RefundOption",
          "position": "3",
          "required": true,
          "lovLink": {
            "href": "/v2/user/lov/RefundOption_eBay"
          },
          "lovRequired": "true"
        },
        {
          "name": "ReturnsWithinOption",
          "position": "4",
          "required": true,
          "lovLink": {
            "href": "/v2/user/lov/ReturnsWithinDuration_eBay"
          },
          "lovRequired": "true"
        },
        {
          "name": "ReturnDescription",
          "position": "5",
          "required": false,
          "maxLength": 5000
        }
      ]
    },
    {
      "displayGroupCode": "HTML",
      "displayGroupPosition": "4",
      "properties": [
        {
          "name": "Template_HTML",
          "position": "1",
          "required": false,
          "maxLength": 50000
        }
      ]
    },
    {
      "displayGroupCode": "OrdersRetrievalOptions",
      "displayGroupPosition": "5",
      "properties": [
        {
          "name": "RetrieveOnlyOneCountry",
          "description": "If true allows to retireve one marketplace country only",
          "position": "1",
          "type": "boolean",
          "required": false
        }
      ]
    }
  ]
}