Documentation for POST api/AutoShip/CreateUpdateOnlinePaymentInfo

POST api/AutoShip/CreateUpdateOnlinePaymentInfo

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
SubjectID	integer	None.
SubjectTypeID	integer	None.
Amount	decimal number	None.
LocaleID	integer	None.
CurrencyType	CurrencyTypeViewModel	None.
ShippingAddress	AddressViewModelAddress	None.
BillingAddress	AddressViewModelAddress	None.
CCAccountID	integer	None.
PaymentTypeID	integer	None.
OnlinePaymentInfoID	integer	None.
DateNextRun	date	None.
PeriodTypeID	integer	None.
ShipMethodID	integer	None.
PeriodDay	integer	None.
Items	Collection of AutoShipScheduleItemViewModel	None.
RepID	integer	None.
CustomerID	integer	None.

Request Formats

application/xml, text/xml

Sample:

<AutoShipProfileViewModel>
  <SubjectID>1</SubjectID>
  <SubjectTypeID>2</SubjectTypeID>
  <Amount>3</Amount>
  <LocaleID>4</LocaleID>
  <CurrencyType>
    <ID>1</ID>
    <Description>sample string 2</Description>
    <Abbreviation>sample string 3</Abbreviation>
    <CurrencySymbol>sample string 4</CurrencySymbol>
    <DecimalPlacesUsed>5</DecimalPlacesUsed>
    <IsVAT>True</IsVAT>
    <DisplayLocale>sample string 7</DisplayLocale>
  </CurrencyType>
  <ShippingAddress>
    <ID>1</ID>
    <Description>sample string 2</Description>
    <Street1>sample string 3</Street1>
    <Street2>sample string 4</Street2>
    <City>sample string 5</City>
    <Company>sample string 6</Company>
    <State>sample string 7</State>
    <PostalCode>sample string 8</PostalCode>
    <County>sample string 9</County>
    <Country>sample string 10</Country>
    <Phone>sample string 11</Phone>
    <Email>sample string 12</Email>
    <FirstName>sample string 13</FirstName>
    <LastName>sample string 14</LastName>
    <SpecialInstructions>sample string 15</SpecialInstructions>
    <SuggestedAddress>True</SuggestedAddress>
    <IsHiddenOnCart>True</IsHiddenOnCart>
    <IsOverrideAddress>True</IsOverrideAddress>
    <IsDefaultProfile>64</IsDefaultProfile>
  </ShippingAddress>
  <BillingAddress>
    <ID>1</ID>
    <Description>sample string 2</Description>
    <Street1>sample string 3</Street1>
    <Street2>sample string 4</Street2>
    <City>sample string 5</City>
    <Company>sample string 6</Company>
    <State>sample string 7</State>
    <PostalCode>sample string 8</PostalCode>
    <County>sample string 9</County>
    <Country>sample string 10</Country>
    <Phone>sample string 11</Phone>
    <Email>sample string 12</Email>
    <FirstName>sample string 13</FirstName>
    <LastName>sample string 14</LastName>
    <SpecialInstructions>sample string 15</SpecialInstructions>
    <SuggestedAddress>True</SuggestedAddress>
    <IsHiddenOnCart>True</IsHiddenOnCart>
    <IsOverrideAddress>True</IsOverrideAddress>
    <IsDefaultProfile>64</IsDefaultProfile>
  </BillingAddress>
  <CCAccountID>5</CCAccountID>
  <PaymentTypeID>6</PaymentTypeID>
  <OnlinePaymentInfoID>7</OnlinePaymentInfoID>
  <DateNextRun>11/03/2025 07:20:20</DateNextRun>
  <PeriodTypeID>1</PeriodTypeID>
  <ShipMethodID>1</ShipMethodID>
  <PeriodDay>1</PeriodDay>
  <Items>
    <AutoShipScheduleItemViewModel>
      <ProductID>sample string 1</ProductID>
      <Quantity>1</Quantity>
    </AutoShipScheduleItemViewModel>
    <AutoShipScheduleItemViewModel>
      <ProductID>sample string 1</ProductID>
      <Quantity>1</Quantity>
    </AutoShipScheduleItemViewModel>
  </Items>
  <RepID>1</RepID>
  <CustomerID>1</CustomerID>
</AutoShipProfileViewModel>

application/json, text/json

Sample:

{
  "SubjectID": 1,
  "SubjectTypeID": 2,
  "Amount": 3.0,
  "LocaleID": 4,
  "CurrencyType": {
    "ID": 1,
    "Description": "sample string 2",
    "Abbreviation": "sample string 3",
    "CurrencySymbol": "sample string 4",
    "DecimalPlacesUsed": 5,
    "IsVAT": true,
    "DisplayLocale": "sample string 7"
  },
  "ShippingAddress": {
    "ID": 1,
    "Description": "sample string 2",
    "Street1": "sample string 3",
    "Street2": "sample string 4",
    "City": "sample string 5",
    "Company": "sample string 6",
    "State": "sample string 7",
    "PostalCode": "sample string 8",
    "County": "sample string 9",
    "Country": "sample string 10",
    "Phone": "sample string 11",
    "Email": "sample string 12",
    "FirstName": "sample string 13",
    "LastName": "sample string 14",
    "SpecialInstructions": "sample string 15",
    "SuggestedAddress": true,
    "IsHiddenOnCart": true,
    "IsOverrideAddress": true,
    "IsDefaultProfile": 64
  },
  "BillingAddress": {
    "ID": 1,
    "Description": "sample string 2",
    "Street1": "sample string 3",
    "Street2": "sample string 4",
    "City": "sample string 5",
    "Company": "sample string 6",
    "State": "sample string 7",
    "PostalCode": "sample string 8",
    "County": "sample string 9",
    "Country": "sample string 10",
    "Phone": "sample string 11",
    "Email": "sample string 12",
    "FirstName": "sample string 13",
    "LastName": "sample string 14",
    "SpecialInstructions": "sample string 15",
    "SuggestedAddress": true,
    "IsHiddenOnCart": true,
    "IsOverrideAddress": true,
    "IsDefaultProfile": 64
  },
  "CCAccountID": 5,
  "PaymentTypeID": 6,
  "OnlinePaymentInfoID": 7,
  "DateNextRun": "2025-11-03T07:20:20.545432-05:00",
  "PeriodTypeID": 1,
  "ShipMethodID": 1,
  "PeriodDay": 1,
  "Items": [
    {
      "ProductID": "sample string 1",
      "Quantity": 1
    },
    {
      "ProductID": "sample string 1",
      "Quantity": 1
    }
  ],
  "RepID": 1,
  "CustomerID": 1
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'FormUrlEncodedFormatter' to write type 'AutoShipProfileViewModel'.

Response Information

Resource Description

IOperationResult

Name	Type	Additional information
IsSuccessful	boolean	None.
ValidationErrors	Dictionary of string [key] and string [value]	None.
Value	Object	None.

Response Formats

application/xml, text/xml

Sample:

<OperationResult>
  <IsSuccessful>False</IsSuccessful>
  <ValidationErrors />
  <Value />
</OperationResult>

application/json, text/json

Sample:

{
  "IsSuccessful": false,
  "ValidationErrors": {}
}