Trendsic Platform Service

CustomerAppCardSetupRequest

The following routes are available for this service:
POST	/v1/c/app/cards/setup

**CustomerAppSessionRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Slug	form	string	No
Profile	form	string	No

**CustomerAppResponse** Parameters:
Name	Parameter	Data Type	Required
Boot	form	CustomerAppBoot	No
Customer	form	CustomerAppMe	No
Addresses	form	List<CustomerAppAddress>	No
Cards	form	List<CustomerAppCard>	No
Notif	form	CustomerAppNotif	No
Recurring	form	List<CustomerAppRecurrence>	No
Booked	form	CourierBookOrderResponse	No
Sent	form	bool	No
Token	form	string	No
NeedsName	form	bool	No
Name	form	string	No
Url	form	string	No
ClientSecret	form	string	No
PublishableKey	form	string	No
Message	form	string	No
ReopenStep	form	string	No
Customers	form	List<CourierCustomerRow>	No
Run	form	RunResult	No
ResponseStatus	form	ResponseStatus	No

**CustomerAppBoot** Parameters:
Name	Parameter	Data Type	Required
Profile	form	string	No
Available	form	bool	No
Reason	form	string	No
AuthMethod	form	string	No
Slug	form	string	No
Page	form	CourierBookPageView	No
ManifestUrl	form	string	No

**CourierBookPageView** Parameters:
Name	Parameter	Data Type	Required
Available	form	bool	No
BookingOn	form	bool	No
Business	form	CourierTrackBusiness	No
Profile	form	CourierBookProfile	No
Profiles	form	List<CourierBookProfileLink>	No
CardEnabled	form	bool	No
PublishableKey	form	string	No
AppUrl	form	string	No
Today	form	string	No
Weekday	form	int	No
NowMin	form	int	No

**CourierTrackBusiness** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No
Phone	form	string	No

**CourierBookProfile** Parameters:
Name	Parameter	Data Type	Required
Code	form	string	No
Name	form	string	No
Shape	form	string	No
Template	form	string	No
UnitOne	form	string	No
UnitMany	form	string	No
UnitOneEs	form	string	No
UnitManyEs	form	string	No
FacilityNoun	form	string	No
FacilityNounEs	form	string	No
FacilityName	form	string	No
Levels	form	List<CourierBookLevel>	No
Asap	form	bool	No
Recurring	form	bool	No
PayTiming	form	string	No
FinalAfterCount	form	bool	No
CancelFee	form	decimal	No
MissedFee	form	decimal	No
MissedWaitMin	form	int	No
ServiceArea	form	List<string>	No
Zips	form	List<string>	No
Handoffs	form	HandoffOptions	No

**CourierBookLevel** Parameters:
Name	Parameter	Data Type	Required
Code	form	string	No
Name	form	string	No
Ready	form	string	No
WithinMin	form	int	No
InBy	form	string	No
Surcharge	form	decimal	No
Days	form	List<int>	No
DeadlineMin	form	int?	No

**HandoffOptions** Parameters:
Name	Parameter	Data Type	Required
Hand	form	bool	No
Porch	form	bool	No
Desk	form	bool	No
SigRequired	form	bool	No
IdRequired	form	bool	No
CodeRequired	form	bool	No

**CourierBookProfileLink** Parameters:
Name	Parameter	Data Type	Required
Code	form	string	No
Name	form	string	No
Shape	form	string	No

**CustomerAppMe** Parameters:
Name	Parameter	Data Type	Required
ContactId	form	int	No
FirstName	form	string	No
LastName	form	string	No
Name	form	string	No
Phone	form	string	No
NeedsName	form	bool	No
BillingMode	form	string	No
AccountCode	form	string	No
Addresses	form	List<CustomerAppAddress>	No
Cards	form	List<CustomerAppCard>	No
Notif	form	CustomerAppNotif	No
Orders	form	List<CustomerAppOrder>	No
Recurring	form	List<CustomerAppRecurrence>	No
Invoices	form	List<CustomerAppInvoice>	No
Today	form	string	No
NowMin	form	int	No

**CustomerAppAddress** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Label	form	string	No
Street	form	string	No
Unit	form	string	No
City	form	string	No
Zip	form	string	No
Lat	form	decimal?	No
Lng	form	decimal?	No
InArea	form	bool	No

**CustomerAppCard** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Label	form	string	No
Brand	form	string	No
Last4	form	string	No
IsDefault	form	bool	No

**CustomerAppNotif** Parameters:
Name	Parameter	Data Type	Required
Texts	form	bool	No
Push	form	bool	No
Promos	form	bool	No

**CustomerAppOrder** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Code	form	string	No
Status	form	string	No
State	form	string	No
Active	form	bool	No
LevelCode	form	string	No
LevelName	form	string	No
Units	form	int	No
UnitsFound	form	int?	No
Address	form	string	No
Unit	form	string	No
Zip	form	string	No
DropAddress	form	string	No
RecipientName	form	string	No
Handoff	form	string	No
IsAsap	form	bool	No
DayIx	form	int	No
DateText	form	string	No
StartMin	form	int?	No
EndMin	form	int?	No
DriverFirstName	form	string	No
EtaMin	form	int?	No
Promise	form	string	No
PayMode	form	string	No
Amount	form	decimal	No
Charged	form	decimal?	No
Tip	form	decimal?	No
CardLast4	form	string	No
RecurrenceId	form	int?	No
Steps	form	List<CustomerAppStep>	No

**CustomerAppStep** Parameters:
Name	Parameter	Data Type	Required
Key	form	string	No
Done	form	bool	No
Time	form	string	No

**CustomerAppRecurrence** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Weekday	form	int	No
StartMin	form	int	No
EndMin	form	int	No
Cadence	form	string	No
LevelCode	form	string	No
Units	form	int	No
Handoff	form	string	No
Address	form	string	No
Paused	form	bool	No
PayMode	form	string	No
CardLast4	form	string	No
NextDate	form	string	No
SkippedDate	form	string	No
AheadDays	form	int	No

**CustomerAppInvoice** Parameters:
Name	Parameter	Data Type	Required
Uid	form	Guid	No
Number	form	string	No
DateText	form	string	No
Total	form	decimal	No
Balance	form	decimal	No
Paid	form	bool	No

**CourierBookOrderResponse** Parameters:
Name	Parameter	Data Type	Required
Done	form	bool	No
NeedsAction	form	bool	No
ClientSecret	form	string	No
SetupIntentId	form	string	No
Code	form	string	No
TrackUrl	form	string	No
IcsUrl	form	string	No
WindowText	form	string	No
Promise	form	string	No
Total	form	decimal	No
PayTiming	form	string	No
CardLast4	form	string	No
Repeats	form	string	No
LinkSentBy	form	string	No
ReopenStep	form	string	No
ResponseStatus	form	ResponseStatus	No

**CourierCustomerRow** Parameters:
Name	Parameter	Data Type	Required
ContactId	form	int	No
Name	form	string	No
Phone	form	string	No
BillingMode	form	string	No
AccountCode	form	string	No
Orders	form	int	No
LastOrderAt	form	DateTime?	No
Unbilled	form	int	No
UnbilledAmount	form	decimal	No
Cards	form	int	No

**RunResult** Parameters:
Name	Parameter	Data Type	Required
Invoices	form	int	No
Orders	form	int	No
Total	form	decimal	No
Skipped	form	List<string>	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/c/app/cards/setup HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CustomerAppCardSetupRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Profile>String</Profile>
  <Slug>String</Slug>
</CustomerAppCardSetupRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CustomerAppResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Addresses>
    <CustomerAppAddress>
      <City>String</City>
      <Id>0</Id>
      <InArea>false</InArea>
      <Label>String</Label>
      <Lat>0</Lat>
      <Lng>0</Lng>
      <Street>String</Street>
      <Unit>String</Unit>
      <Zip>String</Zip>
    </CustomerAppAddress>
  </Addresses>
  <Booked>
    <CardLast4>String</CardLast4>
    <ClientSecret>String</ClientSecret>
    <Code>String</Code>
    <Done>false</Done>
    <IcsUrl>String</IcsUrl>
    <LinkSentBy>String</LinkSentBy>
    <NeedsAction>false</NeedsAction>
    <PayTiming>String</PayTiming>
    <Promise>String</Promise>
    <ReopenStep>String</ReopenStep>
    <Repeats>String</Repeats>
    <ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
      <d3p1:ErrorCode>String</d3p1:ErrorCode>
      <d3p1:Message>String</d3p1:Message>
      <d3p1:StackTrace>String</d3p1:StackTrace>
      <d3p1:Errors>
        <d3p1:ResponseError>
          <d3p1:ErrorCode>String</d3p1:ErrorCode>
          <d3p1:FieldName>String</d3p1:FieldName>
          <d3p1:Message>String</d3p1:Message>
          <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d3p1:Meta>
        </d3p1:ResponseError>
      </d3p1:Errors>
      <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d3p1:Meta>
    </ResponseStatus>
    <SetupIntentId>String</SetupIntentId>
    <Total>0</Total>
    <TrackUrl>String</TrackUrl>
    <WindowText>String</WindowText>
  </Booked>
  <Boot>
    <AuthMethod>String</AuthMethod>
    <Available>false</Available>
    <ManifestUrl>String</ManifestUrl>
    <Page>
      <AppUrl>String</AppUrl>
      <Available>false</Available>
      <BookingOn>false</BookingOn>
      <Business>
        <Name>String</Name>
        <Phone>String</Phone>
      </Business>
      <CardEnabled>false</CardEnabled>
      <NowMin>0</NowMin>
      <Profile>
        <Asap>false</Asap>
        <CancelFee>0</CancelFee>
        <Code>String</Code>
        <FacilityName>String</FacilityName>
        <FacilityNoun>String</FacilityNoun>
        <FacilityNounEs>String</FacilityNounEs>
        <FinalAfterCount>false</FinalAfterCount>
        <Handoffs>
          <CodeRequired>false</CodeRequired>
          <Desk>false</Desk>
          <Hand>false</Hand>
          <IdRequired>false</IdRequired>
          <Porch>false</Porch>
          <SigRequired>false</SigRequired>
        </Handoffs>
        <Levels>
          <CourierBookLevel>
            <Code>String</Code>
            <Days xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:int>0</d7p1:int>
            </Days>
            <DeadlineMin>0</DeadlineMin>
            <InBy>String</InBy>
            <Name>String</Name>
            <Ready>String</Ready>
            <Surcharge>0</Surcharge>
            <WithinMin>0</WithinMin>
          </CourierBookLevel>
        </Levels>
        <MissedFee>0</MissedFee>
        <MissedWaitMin>0</MissedWaitMin>
        <Name>String</Name>
        <PayTiming>String</PayTiming>
        <Recurring>false</Recurring>
        <ServiceArea xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </ServiceArea>
        <Shape>String</Shape>
        <Template>String</Template>
        <UnitMany>String</UnitMany>
        <UnitManyEs>String</UnitManyEs>
        <UnitOne>String</UnitOne>
        <UnitOneEs>String</UnitOneEs>
        <Zips xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </Zips>
      </Profile>
      <Profiles>
        <CourierBookProfileLink>
          <Code>String</Code>
          <Name>String</Name>
          <Shape>String</Shape>
        </CourierBookProfileLink>
      </Profiles>
      <PublishableKey>String</PublishableKey>
      <Today>String</Today>
      <Weekday>0</Weekday>
    </Page>
    <Profile>String</Profile>
    <Reason>String</Reason>
    <Slug>String</Slug>
  </Boot>
  <Cards>
    <CustomerAppCard>
      <Brand>String</Brand>
      <Id>0</Id>
      <IsDefault>false</IsDefault>
      <Label>String</Label>
      <Last4>String</Last4>
    </CustomerAppCard>
  </Cards>
  <ClientSecret>String</ClientSecret>
  <Customer>
    <AccountCode>String</AccountCode>
    <Addresses>
      <CustomerAppAddress>
        <City>String</City>
        <Id>0</Id>
        <InArea>false</InArea>
        <Label>String</Label>
        <Lat>0</Lat>
        <Lng>0</Lng>
        <Street>String</Street>
        <Unit>String</Unit>
        <Zip>String</Zip>
      </CustomerAppAddress>
    </Addresses>
    <BillingMode>String</BillingMode>
    <Cards>
      <CustomerAppCard>
        <Brand>String</Brand>
        <Id>0</Id>
        <IsDefault>false</IsDefault>
        <Label>String</Label>
        <Last4>String</Last4>
      </CustomerAppCard>
    </Cards>
    <ContactId>0</ContactId>
    <FirstName>String</FirstName>
    <Invoices>
      <CustomerAppInvoice>
        <Balance>0</Balance>
        <DateText>String</DateText>
        <Number>String</Number>
        <Paid>false</Paid>
        <Total>0</Total>
        <Uid>00000000-0000-0000-0000-000000000000</Uid>
      </CustomerAppInvoice>
    </Invoices>
    <LastName>String</LastName>
    <Name>String</Name>
    <NeedsName>false</NeedsName>
    <Notif>
      <Promos>false</Promos>
      <Push>false</Push>
      <Texts>false</Texts>
    </Notif>
    <NowMin>0</NowMin>
    <Orders>
      <CustomerAppOrder>
        <Active>false</Active>
        <Address>String</Address>
        <Amount>0</Amount>
        <CardLast4>String</CardLast4>
        <Charged>0</Charged>
        <Code>String</Code>
        <DateText>String</DateText>
        <DayIx>0</DayIx>
        <DriverFirstName>String</DriverFirstName>
        <DropAddress>String</DropAddress>
        <EndMin>0</EndMin>
        <EtaMin>0</EtaMin>
        <Handoff>String</Handoff>
        <Id>0</Id>
        <IsAsap>false</IsAsap>
        <LevelCode>String</LevelCode>
        <LevelName>String</LevelName>
        <PayMode>String</PayMode>
        <Promise>String</Promise>
        <RecipientName>String</RecipientName>
        <RecurrenceId>0</RecurrenceId>
        <StartMin>0</StartMin>
        <State>String</State>
        <Status>String</Status>
        <Steps>
          <CustomerAppStep>
            <Done>false</Done>
            <Key>String</Key>
            <Time>String</Time>
          </CustomerAppStep>
        </Steps>
        <Tip>0</Tip>
        <Unit>String</Unit>
        <Units>0</Units>
        <UnitsFound>0</UnitsFound>
        <Zip>String</Zip>
      </CustomerAppOrder>
    </Orders>
    <Phone>String</Phone>
    <Recurring>
      <CustomerAppRecurrence>
        <Address>String</Address>
        <AheadDays>0</AheadDays>
        <Cadence>String</Cadence>
        <CardLast4>String</CardLast4>
        <EndMin>0</EndMin>
        <Handoff>String</Handoff>
        <Id>0</Id>
        <LevelCode>String</LevelCode>
        <NextDate>String</NextDate>
        <Paused>false</Paused>
        <PayMode>String</PayMode>
        <SkippedDate>String</SkippedDate>
        <StartMin>0</StartMin>
        <Units>0</Units>
        <Weekday>0</Weekday>
      </CustomerAppRecurrence>
    </Recurring>
    <Today>String</Today>
  </Customer>
  <Customers>
    <CourierCustomerRow>
      <AccountCode>String</AccountCode>
      <BillingMode>String</BillingMode>
      <Cards>0</Cards>
      <ContactId>0</ContactId>
      <LastOrderAt>0001-01-01T00:00:00</LastOrderAt>
      <Name>String</Name>
      <Orders>0</Orders>
      <Phone>String</Phone>
      <Unbilled>0</Unbilled>
      <UnbilledAmount>0</UnbilledAmount>
    </CourierCustomerRow>
  </Customers>
  <Message>String</Message>
  <Name>String</Name>
  <NeedsName>false</NeedsName>
  <Notif>
    <Promos>false</Promos>
    <Push>false</Push>
    <Texts>false</Texts>
  </Notif>
  <PublishableKey>String</PublishableKey>
  <Recurring>
    <CustomerAppRecurrence>
      <Address>String</Address>
      <AheadDays>0</AheadDays>
      <Cadence>String</Cadence>
      <CardLast4>String</CardLast4>
      <EndMin>0</EndMin>
      <Handoff>String</Handoff>
      <Id>0</Id>
      <LevelCode>String</LevelCode>
      <NextDate>String</NextDate>
      <Paused>false</Paused>
      <PayMode>String</PayMode>
      <SkippedDate>String</SkippedDate>
      <StartMin>0</StartMin>
      <Units>0</Units>
      <Weekday>0</Weekday>
    </CustomerAppRecurrence>
  </Recurring>
  <ReopenStep>String</ReopenStep>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Run>
    <Invoices>0</Invoices>
    <Orders>0</Orders>
    <Skipped xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Skipped>
    <Total>0</Total>
  </Run>
  <Sent>false</Sent>
  <Token>String</Token>
  <Url>String</Url>
</CustomerAppResponse>