GET Subscriber/{subscriberId}/Rules/Shopping

Gets global shopping rules for the acting user at the subscriber

Request Information

URI Parameters

Name	Description	Type	Additional information
subscriberId		string	None.

Body Parameters

None.

Response Information

Resource Description

SubscriberUserShoppingConfiguration

Name	Type	Additional information
CashDrawerRequiredForCheckout	boolean	None.
RunStoredCards	boolean	None.
ViewClientBillingInfo	boolean	None.
EditPriceAndCount	boolean	None.
CanSwitchLocationAtPos	boolean	None.
CompleteSalesTransactionAtPos	boolean	None.
CanEditSaleDiscount	boolean	None.
RequireSalesRepInPos	boolean	None.
SalesRepsEnabled	boolean	None.
ForceCommissionSelection	boolean	None.
CommissionsEnabled	boolean	None.
SplitCommissionsEnabled	boolean	None.
AutoselectCommissionRecipientEnabled	boolean	None.
Locations	Collection of SubscriberLocation	None.
LocationRestrictions	Collection of SubscriberLocation	None.
AllowReloadingOfGiftCards	boolean	None.
RequireConfirmationOfGiftCardExternalIds	boolean	None.
NotificationsConfiguration	ShoppingNotificationsConfiguration	None.
AutopayPaymentMethodTypes	Collection of string	None.
ProvideGiftCardIdGeneration	boolean	None.
RetailProductsEnabled	boolean	None.
UsePerStaffPricing	boolean	None.
CanApplyPaymentsToAppointments	boolean	None.
CanCheckoutAppointments	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "CashDrawerRequiredForCheckout": true,
  "RunStoredCards": true,
  "ViewClientBillingInfo": true,
  "EditPriceAndCount": true,
  "CanSwitchLocationAtPos": true,
  "CompleteSalesTransactionAtPos": true,
  "CanEditSaleDiscount": true,
  "RequireSalesRepInPos": true,
  "SalesRepsEnabled": true,
  "ForceCommissionSelection": true,
  "CommissionsEnabled": true,
  "SplitCommissionsEnabled": true,
  "AutoselectCommissionRecipientEnabled": true,
  "Locations": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Active": true,
      "City": "sample string 4",
      "StateOrProvinceCode": "sample string 5",
      "CountryCode": "sample string 6",
      "AddressLine1": "sample string 7",
      "AddressLine2": "sample string 8",
      "PostalCode": "sample string 9",
      "Latitude": 1.1,
      "Longitude": 1.1,
      "Phone": "sample string 10",
      "MasterLocationId": 1,
      "InventoryEnabled": true
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Active": true,
      "City": "sample string 4",
      "StateOrProvinceCode": "sample string 5",
      "CountryCode": "sample string 6",
      "AddressLine1": "sample string 7",
      "AddressLine2": "sample string 8",
      "PostalCode": "sample string 9",
      "Latitude": 1.1,
      "Longitude": 1.1,
      "Phone": "sample string 10",
      "MasterLocationId": 1,
      "InventoryEnabled": true
    }
  ],
  "LocationRestrictions": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Active": true,
      "City": "sample string 4",
      "StateOrProvinceCode": "sample string 5",
      "CountryCode": "sample string 6",
      "AddressLine1": "sample string 7",
      "AddressLine2": "sample string 8",
      "PostalCode": "sample string 9",
      "Latitude": 1.1,
      "Longitude": 1.1,
      "Phone": "sample string 10",
      "MasterLocationId": 1,
      "InventoryEnabled": true
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Active": true,
      "City": "sample string 4",
      "StateOrProvinceCode": "sample string 5",
      "CountryCode": "sample string 6",
      "AddressLine1": "sample string 7",
      "AddressLine2": "sample string 8",
      "PostalCode": "sample string 9",
      "Latitude": 1.1,
      "Longitude": 1.1,
      "Phone": "sample string 10",
      "MasterLocationId": 1,
      "InventoryEnabled": true
    }
  ],
  "AllowReloadingOfGiftCards": true,
  "RequireConfirmationOfGiftCardExternalIds": true,
  "NotificationsConfiguration": {
    "Enabled": true,
    "Notifications": [
      {
        "Type": "PurchaseReceipt",
        "DefaultToSend": true
      },
      {
        "Type": "PurchaseReceipt",
        "DefaultToSend": true
      }
    ]
  },
  "AutopayPaymentMethodTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "ProvideGiftCardIdGeneration": true,
  "RetailProductsEnabled": true,
  "UsePerStaffPricing": true,
  "CanApplyPaymentsToAppointments": true,
  "CanCheckoutAppointments": true
}

application/xml, text/xml

Sample:

<SubscriberUserShoppingConfiguration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mindbody.Contract.Marketplace.Models.Configuration">
  <AllowReloadingOfGiftCards>true</AllowReloadingOfGiftCards>
  <AutopayPaymentMethodTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </AutopayPaymentMethodTypes>
  <AutoselectCommissionRecipientEnabled>true</AutoselectCommissionRecipientEnabled>
  <CanApplyPaymentsToAppointments>true</CanApplyPaymentsToAppointments>
  <CanCheckoutAppointments>true</CanCheckoutAppointments>
  <CanEditSaleDiscount>true</CanEditSaleDiscount>
  <CanSwitchLocationAtPos>true</CanSwitchLocationAtPos>
  <CashDrawerRequiredForCheckout>true</CashDrawerRequiredForCheckout>
  <CommissionsEnabled>true</CommissionsEnabled>
  <CompleteSalesTransactionAtPos>true</CompleteSalesTransactionAtPos>
  <EditPriceAndCount>true</EditPriceAndCount>
  <ForceCommissionSelection>true</ForceCommissionSelection>
  <LocationRestrictions>
    <SubscriberLocation>
      <Active>true</Active>
      <AddressLine1>sample string 7</AddressLine1>
      <AddressLine2>sample string 8</AddressLine2>
      <City>sample string 4</City>
      <CountryCode>sample string 6</CountryCode>
      <Id>1</Id>
      <InventoryEnabled>true</InventoryEnabled>
      <Latitude>1.1</Latitude>
      <Longitude>1.1</Longitude>
      <MasterLocationId>1</MasterLocationId>
      <Name>sample string 2</Name>
      <Phone>sample string 10</Phone>
      <PostalCode>sample string 9</PostalCode>
      <StateOrProvinceCode>sample string 5</StateOrProvinceCode>
    </SubscriberLocation>
    <SubscriberLocation>
      <Active>true</Active>
      <AddressLine1>sample string 7</AddressLine1>
      <AddressLine2>sample string 8</AddressLine2>
      <City>sample string 4</City>
      <CountryCode>sample string 6</CountryCode>
      <Id>1</Id>
      <InventoryEnabled>true</InventoryEnabled>
      <Latitude>1.1</Latitude>
      <Longitude>1.1</Longitude>
      <MasterLocationId>1</MasterLocationId>
      <Name>sample string 2</Name>
      <Phone>sample string 10</Phone>
      <PostalCode>sample string 9</PostalCode>
      <StateOrProvinceCode>sample string 5</StateOrProvinceCode>
    </SubscriberLocation>
  </LocationRestrictions>
  <Locations>
    <SubscriberLocation>
      <Active>true</Active>
      <AddressLine1>sample string 7</AddressLine1>
      <AddressLine2>sample string 8</AddressLine2>
      <City>sample string 4</City>
      <CountryCode>sample string 6</CountryCode>
      <Id>1</Id>
      <InventoryEnabled>true</InventoryEnabled>
      <Latitude>1.1</Latitude>
      <Longitude>1.1</Longitude>
      <MasterLocationId>1</MasterLocationId>
      <Name>sample string 2</Name>
      <Phone>sample string 10</Phone>
      <PostalCode>sample string 9</PostalCode>
      <StateOrProvinceCode>sample string 5</StateOrProvinceCode>
    </SubscriberLocation>
    <SubscriberLocation>
      <Active>true</Active>
      <AddressLine1>sample string 7</AddressLine1>
      <AddressLine2>sample string 8</AddressLine2>
      <City>sample string 4</City>
      <CountryCode>sample string 6</CountryCode>
      <Id>1</Id>
      <InventoryEnabled>true</InventoryEnabled>
      <Latitude>1.1</Latitude>
      <Longitude>1.1</Longitude>
      <MasterLocationId>1</MasterLocationId>
      <Name>sample string 2</Name>
      <Phone>sample string 10</Phone>
      <PostalCode>sample string 9</PostalCode>
      <StateOrProvinceCode>sample string 5</StateOrProvinceCode>
    </SubscriberLocation>
  </Locations>
  <NotificationsConfiguration>
    <Enabled>true</Enabled>
    <Notifications>
      <ShoppingNotificationConfiguration>
        <DefaultToSend>true</DefaultToSend>
        <Type>PurchaseReceipt</Type>
      </ShoppingNotificationConfiguration>
      <ShoppingNotificationConfiguration>
        <DefaultToSend>true</DefaultToSend>
        <Type>PurchaseReceipt</Type>
      </ShoppingNotificationConfiguration>
    </Notifications>
  </NotificationsConfiguration>
  <ProvideGiftCardIdGeneration>true</ProvideGiftCardIdGeneration>
  <RequireConfirmationOfGiftCardExternalIds>true</RequireConfirmationOfGiftCardExternalIds>
  <RequireSalesRepInPos>true</RequireSalesRepInPos>
  <RetailProductsEnabled>true</RetailProductsEnabled>
  <RunStoredCards>true</RunStoredCards>
  <SalesRepsEnabled>true</SalesRepsEnabled>
  <SplitCommissionsEnabled>true</SplitCommissionsEnabled>
  <UsePerStaffPricing>true</UsePerStaffPricing>
  <ViewClientBillingInfo>true</ViewClientBillingInfo>
</SubscriberUserShoppingConfiguration>