A settable attribute of order type properties, externalShopperContext lets you specify if the properties and their values are sent as name/value pairs in the webhook request body. To add custom properties to an order type, issue a PUT request to the /ccadmin/v1/orderTypes/{id} endpoint on the administration server. (See Add custom properties to an order type for more information.)

The following example shows a sample request that adds the defaultPriceListGroup, defaultCatalog, defaultAdditionalPriceListGroups, responseCode, and message properties to the order type the widget Note that the externalShopperContext attribute is set to true for these properties.

{
   "properties":{
      "defaultPriceListGroup":{
         "dimension":true,
         "multiSelect":true,
         "textSearchable":false,
         "default":"",
         "internalOnly":false,
         "localizable":false,
         "label":"defaultPriceListGroup",
         "type":"shortText",
         "uiEditorType":"shortText",
         "required":false,
         "searchable":false,
         "audienceVisibility":false,
         "externalShopperContext":true
      },
      "defaultCatalog":{
         "dimension":true,
         "multiSelect":true,
         "textSearchable":false,
         "default":"",
         "internalOnly":false,
        "localizable":false,
         "label":"defaultCatalog",
         "type":"shortText",
         "uiEditorType":"shortText",
         "required":false,
         "searchable":false,
         "audienceVisibility":false,
         "externalShopperContext":true
      },
      "responseCode":{
         "dimension":true,
         "multiSelect":true,
         "textSearchable":false,
         "default":"",
         "internalOnly":false,
         "localizable":false,
         "label":"responseCode",
         "type":"shortText",
         "uiEditorType":"shortText",
         "required":false,
         "searchable":false,
         "audienceVisibility":false,
         "externalShopperContext":true
      },
      "message":{
         "dimension":true,
         "multiSelect":true,
         "textSearchable":false,
         "default":"",
         "internalOnly":false,
         "localizable":false,
         "label":"message",
         "type":"shortText",
         "uiEditorType":"shortText",
         "required":false,
         "searchable":false,
         "audienceVisibility":false,
         "externalShopperContext":true
      },
      "defaultAdditionalPriceListGroups":{
         "dimension":true,
         "multiSelect":true,
         "textSearchable":false,
         "default":"",
         "internalOnly":false,
         "localizable":false,
         "label":"defaultAdditionalPriceListGroups",
         "type":"shortText",
         "uiEditorType":"shortText",
         "required":false,
         "searchable":false,
         "audienceVisibility":false,
         "externalShopperContext":true
      }
   }
}