POST api/Partner/VendConfig

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ID	integer	None.
UserID	string	None.
TaxID	string	None.
RegisterID	string	None.
ShopID	string	None.
PaymentTypeID	string	None.

Request Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "UserID": "sample string 2",
  "TaxID": "sample string 3",
  "RegisterID": "sample string 4",
  "ShopID": "sample string 5",
  "PaymentTypeID": "sample string 6"
}

application/xml, text/xml

Sample:

<VendConfig xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hub.Server.Business.Models">
  <ID>1</ID>
  <PaymentTypeID>sample string 6</PaymentTypeID>
  <RegisterID>sample string 4</RegisterID>
  <ShopID>sample string 5</ShopID>
  <TaxID>sample string 3</TaxID>
  <UserID>sample string 2</UserID>
</VendConfig>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PartnerModel

Name	Description	Type	Additional information
ID		integer	None.
Name	Trading name of cycle shop	string	None.
Description	Optional short description o fcycleshop, highlighting their core skills and services	string	None.
eMail		string	None.
WebAddress		string	None.
PhysicalAddress		string	None.
PhoneNumber1		string	None.
PhoneNumber2		string	None.
StatusID	Get a list from the Lookpup API, but possible values are: 1 - linked and active (Cycleshop uses HubTiger) 2 - Linked but inactive 3 - Not Linked (probably captured by cyclist as part of historic service records).	integer	None.
CurrencySymbol	Only used by Admin Web UI to setup the service checklist questions	string	None.
MinimumJobcardNo	Initiates the jobcardno for first jobcard: Minimum of 100	integer	None.
WorkflowTypeID		integer	None.
ImageURL	Field is populated by uploading an image for a partner/cycle shop. This image should be a logo, and is used when generating communication	string	None.
PartnerImage		string	None.
POSSystemID		integer	None.
OffersBookingService		boolean	None.
OffersPickUpservice		boolean	None.
Latitude		decimal number	None.
Longitude		decimal number	None.
DistanceFromSearchSource		decimal number	None.
PickupServiceRadiusLimit	Radius limit for pickup (in Km)	integer	None.
VATRate		decimal number	None.
VATInclusive		boolean	None.
DefaultUnitOfMeasure		integer	None.
Country		string	None.
EnableCustomerMessaging		boolean	None.
PaymentMethod		integer	None.
OffersCollections		boolean	None.
OffersDropOffs		boolean	None.
CollectionsDayBuffer		integer	None.
BikePerTimeSlot		integer	None.
AllowDiscount		boolean	None.
ReminderHoursBeforeService		integer	None.
SendNotificationOnBooking		boolean	None.
SlackNotificationChannel		string	None.
RequestOrder		boolean	None.
WaitingDelayHours		integer	None.
ServiceFollowUpReminderMonths		integer	None.
OtherServiceFollowUpReminderMonths		integer	None.
PostServiceFollowUpDays		integer	None.
Print_ShowLogo		boolean	None.
Print_ShowChecklist		boolean	None.
Print_ShowLineItemBarcode		boolean	None.
Print_ShowQuote		boolean	None.
Print_ShowOnlyPreServiceCheck		boolean	None.
ShowINeedHelp		boolean	None.
INeedHelpLabel		string	None.
INeedHelpColor		string	None.
OpenPrintOnNewJob		boolean	None.
POSCustomURL		string	None.
OffersFittingService		boolean	None.
ShowLabourGoals		boolean	None.
ShowLabourTotalsCalendar		boolean	None.
ShowWorkshopTotalsCalendar		boolean	None.
ShowTechnicianLegendCalendar		boolean	None.
ShowTour		boolean	None.
ManageStock		boolean	None.
AddStockBackAtSendToPOS		boolean	None.
EnableInventoryManagementCorrectService		boolean	None.
BikeIsHereDefault		boolean	None.
AllowExactMatchingOnQuote		boolean	None.
AllowQuoteToUpdateServiceTypes		boolean	None.
SendDailySummaryReport		boolean	None.
DailySummaryReportRecipients		string	None.
ShowBikeBays		boolean	None.
AllowMultipleQuoteOptions		boolean	None.
DisableAutoCollect		boolean	None.
ShowOriginalDateOnCalendar		boolean	None.
DefaultDayViewTimeInterval		string	None.
CreatedDate		date	None.
ParentID		integer	None.
PickupsColor		string	None.
BookedInColor		string	None.
WaitingForWorkColor		string	None.
WaitingForClientColor		string	None.
WaitingForPartsColor		string	None.
WarrantyColor		string	None.
WorkingOnColor		string	None.
BikeReadyColor		string	None.
CollectedColor		string	None.
DeliveryColor		string	None.
PickupLabel		string	None.
BookedInLabel		string	None.
FittingsBookedInLabel		string	None.
WaitingForWorkLabel		string	None.
WorkingOnLabel		string	None.
WarrantyLabel		string	None.
WaitingForPartsLabel		string	None.
WaitingForClientLabel		string	None.
FittingCompleteLabel		string	None.
CompletedLabel		string	None.
CollectedLabel		string	None.
DeliveryLabel		string	None.
CancelledLabel		string	None.
SendNotificationOnFittingBooking		boolean	None.
SendNotificationOnRental		boolean	None.
FittingNotificationsAddresses		string	None.
ServiceNotificationsAddresses		string	None.
RentalNotificationsAddresses		string	None.
CollectionServiceBufferDays		integer	None.
PrintOutQRImageURL		string	None.
PrintOutTerms		string	None.
PrintJobcardQRCode		boolean	None.
ShowJobCardBarcode		boolean	None.
ShowJobCardStatus		boolean	None.
ShowLineItemNotesOnJobcard		boolean	None.
ShowBikeTypeOnCalendar		boolean	None.
CreatedByOverrideOnBooking		boolean	None.
OpenTabOnScheduleAndOpen		string	None.
ExternalKey		string	None.
ShowComplaintFlag		boolean	None.
ComplaintSlackChannel		string	None.
MandatorySerialNumber		boolean	None.
UseLineItemNotesFromPOS		boolean	None.
PartnerType		integer	None.
BikeNotCollectedFollowUpDays		integer	None.
BikeNotCollectedFollowUpReminderDays		integer	None.
DeliveryNotBookedFollowUpDays		integer	None.
DeliveryNotBookedReminderFollowUpDays		integer	None.
FreeTextMergeTag		string	None.
ReviewGoogleUrl		string	None.
ReviewTrustPilotUrl		string	None.
Enable2FA		boolean	None.
ShowGDPRMarketingConsent		boolean	None.
ShowGDPRMarketingConsentCustomText		string	None.
Project529Enabled		boolean	None.
UseCustomerStorage		boolean	None.
UseProductStorage		boolean	None.
HasCouponsSetup		boolean	None.
EnableDailyShoprideSummary		boolean	None.
AllowRefunds		boolean	None.
DailyShoprideSummaryReminderTime		integer	None.
ExternalProductIntegrationsPartnerLinks		Collection of ExternalProductIntegrationsPartnerLinks	None.
SubscribedProducts		Collection of SubscribedProducts	None.

Response Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "Name": "sample string 2",
  "Description": "sample string 3",
  "eMail": "sample string 4",
  "WebAddress": "sample string 5",
  "PhysicalAddress": "sample string 6",
  "PhoneNumber1": "sample string 7",
  "PhoneNumber2": "sample string 8",
  "StatusID": 9,
  "CurrencySymbol": "sample string 10",
  "MinimumJobcardNo": 11,
  "WorkflowTypeID": 12,
  "ImageURL": "sample string 13",
  "PartnerImage": "sample string 14",
  "POSSystemID": 15,
  "OffersBookingService": true,
  "OffersPickUpservice": true,
  "Latitude": 18.1,
  "Longitude": 19.1,
  "DistanceFromSearchSource": 20.1,
  "PickupServiceRadiusLimit": 21,
  "VATRate": 22.1,
  "VATInclusive": true,
  "DefaultUnitOfMeasure": 24,
  "Country": "sample string 25",
  "EnableCustomerMessaging": true,
  "PaymentMethod": 27,
  "OffersCollections": true,
  "OffersDropOffs": true,
  "CollectionsDayBuffer": 30,
  "BikePerTimeSlot": 31,
  "AllowDiscount": true,
  "ReminderHoursBeforeService": 33,
  "SendNotificationOnBooking": true,
  "SlackNotificationChannel": "sample string 35",
  "RequestOrder": true,
  "WaitingDelayHours": 37,
  "ServiceFollowUpReminderMonths": 38,
  "OtherServiceFollowUpReminderMonths": 39,
  "PostServiceFollowUpDays": 40,
  "Print_ShowLogo": true,
  "Print_ShowChecklist": true,
  "Print_ShowLineItemBarcode": true,
  "Print_ShowQuote": true,
  "Print_ShowOnlyPreServiceCheck": true,
  "ShowINeedHelp": true,
  "INeedHelpLabel": "sample string 47",
  "INeedHelpColor": "sample string 48",
  "OpenPrintOnNewJob": true,
  "POSCustomURL": "sample string 50",
  "OffersFittingService": true,
  "ShowLabourGoals": true,
  "ShowLabourTotalsCalendar": true,
  "ShowWorkshopTotalsCalendar": true,
  "ShowTechnicianLegendCalendar": true,
  "ShowTour": true,
  "ManageStock": true,
  "AddStockBackAtSendToPOS": true,
  "EnableInventoryManagementCorrectService": true,
  "BikeIsHereDefault": true,
  "AllowExactMatchingOnQuote": true,
  "AllowQuoteToUpdateServiceTypes": true,
  "SendDailySummaryReport": true,
  "DailySummaryReportRecipients": "sample string 64",
  "ShowBikeBays": true,
  "AllowMultipleQuoteOptions": true,
  "DisableAutoCollect": true,
  "ShowOriginalDateOnCalendar": true,
  "DefaultDayViewTimeInterval": "sample string 69",
  "CreatedDate": "2025-09-05T16:03:43.1580263+00:00",
  "ParentID": 1,
  "PickupsColor": "sample string 71",
  "BookedInColor": "sample string 72",
  "WaitingForWorkColor": "sample string 73",
  "WaitingForClientColor": "sample string 74",
  "WaitingForPartsColor": "sample string 75",
  "WarrantyColor": "sample string 76",
  "WorkingOnColor": "sample string 77",
  "BikeReadyColor": "sample string 78",
  "CollectedColor": "sample string 79",
  "DeliveryColor": "sample string 80",
  "PickupLabel": "sample string 81",
  "BookedInLabel": "sample string 82",
  "FittingsBookedInLabel": "sample string 83",
  "WaitingForWorkLabel": "sample string 84",
  "WorkingOnLabel": "sample string 85",
  "WarrantyLabel": "sample string 86",
  "WaitingForPartsLabel": "sample string 87",
  "WaitingForClientLabel": "sample string 88",
  "FittingCompleteLabel": "sample string 89",
  "CompletedLabel": "sample string 90",
  "CollectedLabel": "sample string 91",
  "DeliveryLabel": "sample string 92",
  "CancelledLabel": "sample string 93",
  "SendNotificationOnFittingBooking": true,
  "SendNotificationOnRental": true,
  "FittingNotificationsAddresses": "sample string 96",
  "ServiceNotificationsAddresses": "sample string 97",
  "RentalNotificationsAddresses": "sample string 98",
  "CollectionServiceBufferDays": 99,
  "PrintOutQRImageURL": "sample string 100",
  "PrintOutTerms": "sample string 101",
  "PrintJobcardQRCode": true,
  "ShowJobCardBarcode": true,
  "ShowJobCardStatus": true,
  "ShowLineItemNotesOnJobcard": true,
  "ShowBikeTypeOnCalendar": true,
  "CreatedByOverrideOnBooking": true,
  "OpenTabOnScheduleAndOpen": "sample string 108",
  "ExternalKey": "sample string 109",
  "ShowComplaintFlag": true,
  "ComplaintSlackChannel": "sample string 111",
  "MandatorySerialNumber": true,
  "UseLineItemNotesFromPOS": true,
  "PartnerType": 114,
  "BikeNotCollectedFollowUpDays": 115,
  "BikeNotCollectedFollowUpReminderDays": 116,
  "DeliveryNotBookedFollowUpDays": 117,
  "DeliveryNotBookedReminderFollowUpDays": 118,
  "FreeTextMergeTag": "sample string 119",
  "ReviewGoogleUrl": "sample string 120",
  "ReviewTrustPilotUrl": "sample string 121",
  "Enable2FA": true,
  "ShowGDPRMarketingConsent": true,
  "ShowGDPRMarketingConsentCustomText": "sample string 124",
  "Project529Enabled": true,
  "UseCustomerStorage": true,
  "UseProductStorage": true,
  "HasCouponsSetup": true,
  "EnableDailyShoprideSummary": true,
  "AllowRefunds": true,
  "DailyShoprideSummaryReminderTime": 131,
  "ExternalProductIntegrationsPartnerLinks": [
    {
      "ID": 1,
      "PartnerID": 2,
      "ExternalProductPartnerID": 3
    },
    {
      "ID": 1,
      "PartnerID": 2,
      "ExternalProductPartnerID": 3
    }
  ],
  "SubscribedProducts": [
    {
      "PartnerID": 1,
      "StripeProductID": "sample string 2",
      "StatusID": 3,
      "ProductType": "sample string 4",
      "NumberRentalProducts": 5
    },
    {
      "PartnerID": 1,
      "StripeProductID": "sample string 2",
      "StatusID": 3,
      "ProductType": "sample string 4",
      "NumberRentalProducts": 5
    }
  ]
}

application/xml, text/xml

Sample:

<PartnerModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hub.Server.Models.DTO">
  <AddStockBackAtSendToPOS>true</AddStockBackAtSendToPOS>
  <AllowDiscount>true</AllowDiscount>
  <AllowExactMatchingOnQuote>true</AllowExactMatchingOnQuote>
  <AllowMultipleQuoteOptions>true</AllowMultipleQuoteOptions>
  <AllowQuoteToUpdateServiceTypes>true</AllowQuoteToUpdateServiceTypes>
  <AllowRefunds>true</AllowRefunds>
  <BikeIsHereDefault>true</BikeIsHereDefault>
  <BikeNotCollectedFollowUpDays>115</BikeNotCollectedFollowUpDays>
  <BikeNotCollectedFollowUpReminderDays>116</BikeNotCollectedFollowUpReminderDays>
  <BikePerTimeSlot>31</BikePerTimeSlot>
  <BikeReadyColor>sample string 78</BikeReadyColor>
  <BookedInColor>sample string 72</BookedInColor>
  <BookedInLabel>sample string 82</BookedInLabel>
  <CancelledLabel>sample string 93</CancelledLabel>
  <CollectedColor>sample string 79</CollectedColor>
  <CollectedLabel>sample string 91</CollectedLabel>
  <CollectionServiceBufferDays>99</CollectionServiceBufferDays>
  <CollectionsDayBuffer>30</CollectionsDayBuffer>
  <ComplaintSlackChannel>sample string 111</ComplaintSlackChannel>
  <CompletedLabel>sample string 90</CompletedLabel>
  <Country>sample string 25</Country>
  <CreatedByOverrideOnBooking>true</CreatedByOverrideOnBooking>
  <CreatedDate>2025-09-05T16:03:43.1580263+00:00</CreatedDate>
  <CurrencySymbol>sample string 10</CurrencySymbol>
  <DailyShoprideSummaryReminderTime>131</DailyShoprideSummaryReminderTime>
  <DailySummaryReportRecipients>sample string 64</DailySummaryReportRecipients>
  <DefaultDayViewTimeInterval>sample string 69</DefaultDayViewTimeInterval>
  <DefaultUnitOfMeasure>24</DefaultUnitOfMeasure>
  <DeliveryColor>sample string 80</DeliveryColor>
  <DeliveryLabel>sample string 92</DeliveryLabel>
  <DeliveryNotBookedFollowUpDays>117</DeliveryNotBookedFollowUpDays>
  <DeliveryNotBookedReminderFollowUpDays>118</DeliveryNotBookedReminderFollowUpDays>
  <Description>sample string 3</Description>
  <DisableAutoCollect>true</DisableAutoCollect>
  <DistanceFromSearchSource>20.1</DistanceFromSearchSource>
  <Enable2FA>true</Enable2FA>
  <EnableCustomerMessaging>true</EnableCustomerMessaging>
  <EnableDailyShoprideSummary>true</EnableDailyShoprideSummary>
  <EnableInventoryManagementCorrectService>true</EnableInventoryManagementCorrectService>
  <ExternalKey>sample string 109</ExternalKey>
  <ExternalProductIntegrationsPartnerLinks>
    <ExternalProductIntegrationsPartnerLinks>
      <ExternalProductPartnerID>3</ExternalProductPartnerID>
      <ID>1</ID>
      <PartnerID>2</PartnerID>
    </ExternalProductIntegrationsPartnerLinks>
    <ExternalProductIntegrationsPartnerLinks>
      <ExternalProductPartnerID>3</ExternalProductPartnerID>
      <ID>1</ID>
      <PartnerID>2</PartnerID>
    </ExternalProductIntegrationsPartnerLinks>
  </ExternalProductIntegrationsPartnerLinks>
  <FittingCompleteLabel>sample string 89</FittingCompleteLabel>
  <FittingNotificationsAddresses>sample string 96</FittingNotificationsAddresses>
  <FittingsBookedInLabel>sample string 83</FittingsBookedInLabel>
  <FreeTextMergeTag>sample string 119</FreeTextMergeTag>
  <HasCouponsSetup>true</HasCouponsSetup>
  <ID>1</ID>
  <INeedHelpColor>sample string 48</INeedHelpColor>
  <INeedHelpLabel>sample string 47</INeedHelpLabel>
  <ImageURL>sample string 13</ImageURL>
  <Latitude>18.1</Latitude>
  <Longitude>19.1</Longitude>
  <ManageStock>true</ManageStock>
  <MandatorySerialNumber>true</MandatorySerialNumber>
  <MinimumJobcardNo>11</MinimumJobcardNo>
  <Name>sample string 2</Name>
  <OffersBookingService>true</OffersBookingService>
  <OffersCollections>true</OffersCollections>
  <OffersDropOffs>true</OffersDropOffs>
  <OffersFittingService>true</OffersFittingService>
  <OffersPickUpservice>true</OffersPickUpservice>
  <OpenPrintOnNewJob>true</OpenPrintOnNewJob>
  <OpenTabOnScheduleAndOpen>sample string 108</OpenTabOnScheduleAndOpen>
  <OtherServiceFollowUpReminderMonths>39</OtherServiceFollowUpReminderMonths>
  <POSCustomURL>sample string 50</POSCustomURL>
  <POSSystemID>15</POSSystemID>
  <ParentID>1</ParentID>
  <PartnerImage>sample string 14</PartnerImage>
  <PartnerType>114</PartnerType>
  <PaymentMethod>27</PaymentMethod>
  <PhoneNumber1>sample string 7</PhoneNumber1>
  <PhoneNumber2>sample string 8</PhoneNumber2>
  <PhysicalAddress>sample string 6</PhysicalAddress>
  <PickupLabel>sample string 81</PickupLabel>
  <PickupServiceRadiusLimit>21</PickupServiceRadiusLimit>
  <PickupsColor>sample string 71</PickupsColor>
  <PostServiceFollowUpDays>40</PostServiceFollowUpDays>
  <PrintJobcardQRCode>true</PrintJobcardQRCode>
  <PrintOutQRImageURL>sample string 100</PrintOutQRImageURL>
  <PrintOutTerms>sample string 101</PrintOutTerms>
  <Print_ShowChecklist>true</Print_ShowChecklist>
  <Print_ShowLineItemBarcode>true</Print_ShowLineItemBarcode>
  <Print_ShowLogo>true</Print_ShowLogo>
  <Print_ShowOnlyPreServiceCheck>true</Print_ShowOnlyPreServiceCheck>
  <Print_ShowQuote>true</Print_ShowQuote>
  <Project529Enabled>true</Project529Enabled>
  <ReminderHoursBeforeService>33</ReminderHoursBeforeService>
  <RentalNotificationsAddresses>sample string 98</RentalNotificationsAddresses>
  <RequestOrder>true</RequestOrder>
  <ReviewGoogleUrl>sample string 120</ReviewGoogleUrl>
  <ReviewTrustPilotUrl>sample string 121</ReviewTrustPilotUrl>
  <SendDailySummaryReport>true</SendDailySummaryReport>
  <SendNotificationOnBooking>true</SendNotificationOnBooking>
  <SendNotificationOnFittingBooking>true</SendNotificationOnFittingBooking>
  <SendNotificationOnRental>true</SendNotificationOnRental>
  <ServiceFollowUpReminderMonths>38</ServiceFollowUpReminderMonths>
  <ServiceNotificationsAddresses>sample string 97</ServiceNotificationsAddresses>
  <ShowBikeBays>true</ShowBikeBays>
  <ShowBikeTypeOnCalendar>true</ShowBikeTypeOnCalendar>
  <ShowComplaintFlag>true</ShowComplaintFlag>
  <ShowGDPRMarketingConsent>true</ShowGDPRMarketingConsent>
  <ShowGDPRMarketingConsentCustomText>sample string 124</ShowGDPRMarketingConsentCustomText>
  <ShowINeedHelp>true</ShowINeedHelp>
  <ShowJobCardBarcode>true</ShowJobCardBarcode>
  <ShowJobCardStatus>true</ShowJobCardStatus>
  <ShowLabourGoals>true</ShowLabourGoals>
  <ShowLabourTotalsCalendar>true</ShowLabourTotalsCalendar>
  <ShowLineItemNotesOnJobcard>true</ShowLineItemNotesOnJobcard>
  <ShowOriginalDateOnCalendar>true</ShowOriginalDateOnCalendar>
  <ShowTechnicianLegendCalendar>true</ShowTechnicianLegendCalendar>
  <ShowTour>true</ShowTour>
  <ShowWorkshopTotalsCalendar>true</ShowWorkshopTotalsCalendar>
  <SlackNotificationChannel>sample string 35</SlackNotificationChannel>
  <StatusID>9</StatusID>
  <SubscribedProducts>
    <SubscribedProducts>
      <NumberRentalProducts>5</NumberRentalProducts>
      <PartnerID>1</PartnerID>
      <ProductType>sample string 4</ProductType>
      <StatusID>3</StatusID>
      <StripeProductID>sample string 2</StripeProductID>
    </SubscribedProducts>
    <SubscribedProducts>
      <NumberRentalProducts>5</NumberRentalProducts>
      <PartnerID>1</PartnerID>
      <ProductType>sample string 4</ProductType>
      <StatusID>3</StatusID>
      <StripeProductID>sample string 2</StripeProductID>
    </SubscribedProducts>
  </SubscribedProducts>
  <UseCustomerStorage>true</UseCustomerStorage>
  <UseLineItemNotesFromPOS>true</UseLineItemNotesFromPOS>
  <UseProductStorage>true</UseProductStorage>
  <VATInclusive>true</VATInclusive>
  <VATRate>22.1</VATRate>
  <WaitingDelayHours>37</WaitingDelayHours>
  <WaitingForClientColor>sample string 74</WaitingForClientColor>
  <WaitingForClientLabel>sample string 88</WaitingForClientLabel>
  <WaitingForPartsColor>sample string 75</WaitingForPartsColor>
  <WaitingForPartsLabel>sample string 87</WaitingForPartsLabel>
  <WaitingForWorkColor>sample string 73</WaitingForWorkColor>
  <WaitingForWorkLabel>sample string 84</WaitingForWorkLabel>
  <WarrantyColor>sample string 76</WarrantyColor>
  <WarrantyLabel>sample string 86</WarrantyLabel>
  <WebAddress>sample string 5</WebAddress>
  <WorkflowTypeID>12</WorkflowTypeID>
  <WorkingOnColor>sample string 77</WorkingOnColor>
  <WorkingOnLabel>sample string 85</WorkingOnLabel>
  <eMail>sample string 4</eMail>
</PartnerModel>