Trendsic Platform Service

CourierCustomersRequest

The following routes are available for this service:
GET	/v1/dispatch/courier/customers

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class CourierCustomersRequest
{
    open var Q:String? = null
}

open class CustomerAppResponse
{
    open var Boot:CustomerAppBoot? = null
    open var Customer:CustomerAppMe? = null
    open var Addresses:ArrayList<CustomerAppAddress> = ArrayList<CustomerAppAddress>()
    open var Cards:ArrayList<CustomerAppCard> = ArrayList<CustomerAppCard>()
    open var Notif:CustomerAppNotif? = null
    open var Recurring:ArrayList<CustomerAppRecurrence> = ArrayList<CustomerAppRecurrence>()
    open var Booked:CourierBookOrderResponse? = null
    open var Sent:Boolean? = null
    open var Token:String? = null
    open var NeedsName:Boolean? = null
    open var Name:String? = null
    open var Url:String? = null
    open var ClientSecret:String? = null
    open var PublishableKey:String? = null
    open var Message:String? = null
    open var ReopenStep:String? = null
    open var Customers:ArrayList<CourierCustomerRow> = ArrayList<CourierCustomerRow>()
    open var Run:RunResult? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class CustomerAppBoot
{
    open var Profile:String? = null
    open var Available:Boolean? = null
    open var Reason:String? = null
    open var AuthMethod:String? = null
    open var Slug:String? = null
    open var Page:CourierBookPageView? = null
    open var ManifestUrl:String? = null
}

open class CourierBookPageView
{
    open var Available:Boolean? = null
    open var BookingOn:Boolean? = null
    open var Business:CourierTrackBusiness? = null
    open var Profile:CourierBookProfile? = null
    open var Profiles:ArrayList<CourierBookProfileLink> = ArrayList<CourierBookProfileLink>()
    open var CardEnabled:Boolean? = null
    open var PublishableKey:String? = null
    open var AppUrl:String? = null
    open var Today:String? = null
    open var Weekday:Int? = null
    open var NowMin:Int? = null
}

open class CourierTrackBusiness
{
    open var Name:String? = null
    open var Phone:String? = null
}

open class CourierBookProfile
{
    open var Code:String? = null
    open var Name:String? = null
    open var Shape:String? = null
    open var Template:String? = null
    open var UnitOne:String? = null
    open var UnitMany:String? = null
    open var UnitOneEs:String? = null
    open var UnitManyEs:String? = null
    open var FacilityNoun:String? = null
    open var FacilityNounEs:String? = null
    open var FacilityName:String? = null
    open var Levels:ArrayList<CourierBookLevel> = ArrayList<CourierBookLevel>()
    open var Asap:Boolean? = null
    open var Recurring:Boolean? = null
    open var PayTiming:String? = null
    open var FinalAfterCount:Boolean? = null
    open var CancelFee:BigDecimal? = null
    open var MissedFee:BigDecimal? = null
    open var MissedWaitMin:Int? = null
    open var ServiceArea:ArrayList<String> = ArrayList<String>()
    open var Zips:ArrayList<String> = ArrayList<String>()
    open var Handoffs:HandoffOptions? = null
}

open class CourierBookLevel
{
    open var Code:String? = null
    open var Name:String? = null
    open var Ready:String? = null
    open var WithinMin:Int? = null
    open var InBy:String? = null
    open var Surcharge:BigDecimal? = null
    open var Days:ArrayList<Int> = ArrayList<Int>()
    open var DeadlineMin:Int? = null
}

open class HandoffOptions
{
    open var Hand:Boolean? = null
    open var Porch:Boolean? = null
    open var Desk:Boolean? = null
    open var SigRequired:Boolean? = null
    open var IdRequired:Boolean? = null
    open var CodeRequired:Boolean? = null
}

open class CourierBookProfileLink
{
    open var Code:String? = null
    open var Name:String? = null
    open var Shape:String? = null
}

open class CustomerAppMe
{
    open var ContactId:Int? = null
    open var FirstName:String? = null
    open var LastName:String? = null
    open var Name:String? = null
    open var Phone:String? = null
    open var NeedsName:Boolean? = null
    open var BillingMode:String? = null
    open var AccountCode:String? = null
    open var Addresses:ArrayList<CustomerAppAddress> = ArrayList<CustomerAppAddress>()
    open var Cards:ArrayList<CustomerAppCard> = ArrayList<CustomerAppCard>()
    open var Notif:CustomerAppNotif? = null
    open var Orders:ArrayList<CustomerAppOrder> = ArrayList<CustomerAppOrder>()
    open var Recurring:ArrayList<CustomerAppRecurrence> = ArrayList<CustomerAppRecurrence>()
    open var Invoices:ArrayList<CustomerAppInvoice> = ArrayList<CustomerAppInvoice>()
    open var Today:String? = null
    open var NowMin:Int? = null
}

open class CustomerAppAddress
{
    open var Id:Int? = null
    open var Label:String? = null
    open var Street:String? = null
    open var Unit:String? = null
    open var City:String? = null
    open var Zip:String? = null
    open var Lat:BigDecimal? = null
    open var Lng:BigDecimal? = null
    open var InArea:Boolean? = null
}

open class CustomerAppCard
{
    open var Id:Int? = null
    open var Label:String? = null
    open var Brand:String? = null
    open var Last4:String? = null
    open var IsDefault:Boolean? = null
}

open class CustomerAppNotif
{
    open var Texts:Boolean? = null
    open var Push:Boolean? = null
    open var Promos:Boolean? = null
}

open class CustomerAppOrder
{
    open var Id:Int? = null
    open var Code:String? = null
    open var Status:String? = null
    open var State:String? = null
    open var Active:Boolean? = null
    open var LevelCode:String? = null
    open var LevelName:String? = null
    open var Units:Int? = null
    open var UnitsFound:Int? = null
    open var Address:String? = null
    open var Unit:String? = null
    open var Zip:String? = null
    open var DropAddress:String? = null
    open var RecipientName:String? = null
    open var Handoff:String? = null
    open var IsAsap:Boolean? = null
    open var DayIx:Int? = null
    open var DateText:String? = null
    open var StartMin:Int? = null
    open var EndMin:Int? = null
    open var DriverFirstName:String? = null
    open var EtaMin:Int? = null
    open var Promise:String? = null
    open var PayMode:String? = null
    open var Amount:BigDecimal? = null
    open var Charged:BigDecimal? = null
    open var Tip:BigDecimal? = null
    open var CardLast4:String? = null
    open var RecurrenceId:Int? = null
    open var Steps:ArrayList<CustomerAppStep> = ArrayList<CustomerAppStep>()
}

open class CustomerAppStep
{
    open var Key:String? = null
    open var Done:Boolean? = null
    open var Time:String? = null
}

open class CustomerAppRecurrence
{
    open var Id:Int? = null
    open var Weekday:Int? = null
    open var StartMin:Int? = null
    open var EndMin:Int? = null
    open var Cadence:String? = null
    open var LevelCode:String? = null
    open var Units:Int? = null
    open var Handoff:String? = null
    open var Address:String? = null
    open var Paused:Boolean? = null
    open var PayMode:String? = null
    open var CardLast4:String? = null
    open var NextDate:String? = null
    open var SkippedDate:String? = null
    open var AheadDays:Int? = null
}

open class CustomerAppInvoice
{
    open var Uid:UUID? = null
    open var Number:String? = null
    open var DateText:String? = null
    open var Total:BigDecimal? = null
    open var Balance:BigDecimal? = null
    open var Paid:Boolean? = null
}

open class CourierBookOrderResponse
{
    open var Done:Boolean? = null
    open var NeedsAction:Boolean? = null
    open var ClientSecret:String? = null
    open var SetupIntentId:String? = null
    open var Code:String? = null
    open var TrackUrl:String? = null
    open var IcsUrl:String? = null
    open var WindowText:String? = null
    open var Promise:String? = null
    open var Total:BigDecimal? = null
    open var PayTiming:String? = null
    open var CardLast4:String? = null
    open var Repeats:String? = null
    open var LinkSentBy:String? = null
    open var ReopenStep:String? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class CourierCustomerRow
{
    open var ContactId:Int? = null
    open var Name:String? = null
    open var Phone:String? = null
    open var BillingMode:String? = null
    open var AccountCode:String? = null
    open var Orders:Int? = null
    open var LastOrderAt:Date? = null
    open var Unbilled:Int? = null
    open var UnbilledAmount:BigDecimal? = null
    open var Cards:Int? = null
}

open class RunResult
{
    open var Invoices:Int? = null
    open var Orders:Int? = null
    open var Total:BigDecimal? = null
    open var Skipped:ArrayList<String> = ArrayList<String>()
}

Kotlin CourierCustomersRequest DTOs

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.

GET /v1/dispatch/courier/customers HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

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>