Trendsic Platform Service

<back to all web services

CustomerAppAuthCodeRequest

The following routes are available for this service:
POST/v1/c/{Slug}/auth/code
CustomerAppAuthCodeRequest Parameters:
NameParameterData TypeRequiredDescription
SlugpathstringNo
ProfilebodystringNo
PhonebodystringNo
CustomerAppResponse Parameters:
NameParameterData TypeRequiredDescription
BootformCustomerAppBootNo
CustomerformCustomerAppMeNo
AddressesformList<CustomerAppAddress>No
CardsformList<CustomerAppCard>No
NotifformCustomerAppNotifNo
RecurringformList<CustomerAppRecurrence>No
BookedformCourierBookOrderResponseNo
SentformboolNo
TokenformstringNo
NeedsNameformboolNo
NameformstringNo
UrlformstringNo
ClientSecretformstringNo
PublishableKeyformstringNo
MessageformstringNo
ReopenStepformstringNo
CustomersformList<CourierCustomerRow>No
RunformRunResultNo
ResponseStatusformResponseStatusNo
CustomerAppBoot Parameters:
NameParameterData TypeRequiredDescription
ProfileformstringNo
AvailableformboolNo
ReasonformstringNo
AuthMethodformstringNo
SlugformstringNo
PageformCourierBookPageViewNo
ManifestUrlformstringNo
CourierBookPageView Parameters:
NameParameterData TypeRequiredDescription
AvailableformboolNo
BookingOnformboolNo
BusinessformCourierTrackBusinessNo
ProfileformCourierBookProfileNo
ProfilesformList<CourierBookProfileLink>No
CardEnabledformboolNo
PublishableKeyformstringNo
AppUrlformstringNo
TodayformstringNo
WeekdayformintNo
NowMinformintNo
CourierTrackBusiness Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
PhoneformstringNo
CourierBookProfile Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
NameformstringNo
ShapeformstringNo
TemplateformstringNo
UnitOneformstringNo
UnitManyformstringNo
UnitOneEsformstringNo
UnitManyEsformstringNo
FacilityNounformstringNo
FacilityNounEsformstringNo
FacilityNameformstringNo
LevelsformList<CourierBookLevel>No
AsapformboolNo
RecurringformboolNo
PayTimingformstringNo
FinalAfterCountformboolNo
CancelFeeformdecimalNo
MissedFeeformdecimalNo
MissedWaitMinformintNo
ServiceAreaformList<string>No
ZipsformList<string>No
HandoffsformHandoffOptionsNo
CourierBookLevel Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
NameformstringNo
ReadyformstringNo
WithinMinformintNo
InByformstringNo
SurchargeformdecimalNo
DaysformList<int>No
DeadlineMinformint?No
HandoffOptions Parameters:
NameParameterData TypeRequiredDescription
HandformboolNo
PorchformboolNo
DeskformboolNo
SigRequiredformboolNo
IdRequiredformboolNo
CodeRequiredformboolNo
CourierBookProfileLink Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
NameformstringNo
ShapeformstringNo
CustomerAppMe Parameters:
NameParameterData TypeRequiredDescription
ContactIdformintNo
FirstNameformstringNo
LastNameformstringNo
NameformstringNo
PhoneformstringNo
NeedsNameformboolNo
BillingModeformstringNo
AccountCodeformstringNo
AddressesformList<CustomerAppAddress>No
CardsformList<CustomerAppCard>No
NotifformCustomerAppNotifNo
OrdersformList<CustomerAppOrder>No
RecurringformList<CustomerAppRecurrence>No
InvoicesformList<CustomerAppInvoice>No
TodayformstringNo
NowMinformintNo
CustomerAppAddress Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
LabelformstringNo
StreetformstringNo
UnitformstringNo
CityformstringNo
ZipformstringNo
Latformdecimal?No
Lngformdecimal?No
InAreaformboolNo
CustomerAppCard Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
LabelformstringNo
BrandformstringNo
Last4formstringNo
IsDefaultformboolNo
CustomerAppNotif Parameters:
NameParameterData TypeRequiredDescription
TextsformboolNo
PushformboolNo
PromosformboolNo
CustomerAppOrder Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CodeformstringNo
StatusformstringNo
StateformstringNo
ActiveformboolNo
LevelCodeformstringNo
LevelNameformstringNo
UnitsformintNo
UnitsFoundformint?No
AddressformstringNo
UnitformstringNo
ZipformstringNo
DropAddressformstringNo
RecipientNameformstringNo
HandoffformstringNo
IsAsapformboolNo
DayIxformintNo
DateTextformstringNo
StartMinformint?No
EndMinformint?No
DriverFirstNameformstringNo
EtaMinformint?No
PromiseformstringNo
PayModeformstringNo
AmountformdecimalNo
Chargedformdecimal?No
Tipformdecimal?No
CardLast4formstringNo
RecurrenceIdformint?No
StepsformList<CustomerAppStep>No
CustomerAppStep Parameters:
NameParameterData TypeRequiredDescription
KeyformstringNo
DoneformboolNo
TimeformstringNo
CustomerAppRecurrence Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
WeekdayformintNo
StartMinformintNo
EndMinformintNo
CadenceformstringNo
LevelCodeformstringNo
UnitsformintNo
HandoffformstringNo
AddressformstringNo
PausedformboolNo
PayModeformstringNo
CardLast4formstringNo
NextDateformstringNo
SkippedDateformstringNo
AheadDaysformintNo
CustomerAppInvoice Parameters:
NameParameterData TypeRequiredDescription
UidformGuidNo
NumberformstringNo
DateTextformstringNo
TotalformdecimalNo
BalanceformdecimalNo
PaidformboolNo
CourierBookOrderResponse Parameters:
NameParameterData TypeRequiredDescription
DoneformboolNo
NeedsActionformboolNo
ClientSecretformstringNo
SetupIntentIdformstringNo
CodeformstringNo
TrackUrlformstringNo
IcsUrlformstringNo
WindowTextformstringNo
PromiseformstringNo
TotalformdecimalNo
PayTimingformstringNo
CardLast4formstringNo
RepeatsformstringNo
LinkSentByformstringNo
ReopenStepformstringNo
ResponseStatusformResponseStatusNo
CourierCustomerRow Parameters:
NameParameterData TypeRequiredDescription
ContactIdformintNo
NameformstringNo
PhoneformstringNo
BillingModeformstringNo
AccountCodeformstringNo
OrdersformintNo
LastOrderAtformDateTime?No
UnbilledformintNo
UnbilledAmountformdecimalNo
CardsformintNo
RunResult Parameters:
NameParameterData TypeRequiredDescription
InvoicesformintNo
OrdersformintNo
TotalformdecimalNo
SkippedformList<string>No

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /v1/c/{Slug}/auth/code HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Slug":"String","Profile":"String","Phone":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Boot":{"Profile":"String","Available":false,"Reason":"String","AuthMethod":"String","Slug":"String","Page":{"Available":false,"BookingOn":false,"Business":{"Name":"String","Phone":"String"},"Profile":{"Code":"String","Name":"String","Shape":"String","Template":"String","UnitOne":"String","UnitMany":"String","UnitOneEs":"String","UnitManyEs":"String","FacilityNoun":"String","FacilityNounEs":"String","FacilityName":"String","Levels":[{"Code":"String","Name":"String","Ready":"String","WithinMin":0,"InBy":"String","Surcharge":0,"Days":[0],"DeadlineMin":0}],"Asap":false,"Recurring":false,"PayTiming":"String","FinalAfterCount":false,"CancelFee":0,"MissedFee":0,"MissedWaitMin":0,"ServiceArea":["String"],"Zips":["String"],"Handoffs":{"Hand":false,"Porch":false,"Desk":false,"SigRequired":false,"IdRequired":false,"CodeRequired":false}},"Profiles":[{"Code":"String","Name":"String","Shape":"String"}],"CardEnabled":false,"PublishableKey":"String","AppUrl":"String","Today":"String","Weekday":0,"NowMin":0},"ManifestUrl":"String"},"Customer":{"ContactId":0,"FirstName":"String","LastName":"String","Name":"String","Phone":"String","NeedsName":false,"BillingMode":"String","AccountCode":"String","Addresses":[{"Id":0,"Label":"String","Street":"String","Unit":"String","City":"String","Zip":"String","Lat":0,"Lng":0,"InArea":false}],"Cards":[{"Id":0,"Label":"String","Brand":"String","Last4":"String","IsDefault":false}],"Notif":{"Texts":false,"Push":false,"Promos":false},"Orders":[{"Id":0,"Code":"String","Status":"String","State":"String","Active":false,"LevelCode":"String","LevelName":"String","Units":0,"UnitsFound":0,"Address":"String","Unit":"String","Zip":"String","DropAddress":"String","RecipientName":"String","Handoff":"String","IsAsap":false,"DayIx":0,"DateText":"String","StartMin":0,"EndMin":0,"DriverFirstName":"String","EtaMin":0,"Promise":"String","PayMode":"String","Amount":0,"Charged":0,"Tip":0,"CardLast4":"String","RecurrenceId":0,"Steps":[{"Key":"String","Done":false,"Time":"String"}]}],"Recurring":[{"Id":0,"Weekday":0,"StartMin":0,"EndMin":0,"Cadence":"String","LevelCode":"String","Units":0,"Handoff":"String","Address":"String","Paused":false,"PayMode":"String","CardLast4":"String","NextDate":"String","SkippedDate":"String","AheadDays":0}],"Invoices":[{"Uid":"00000000000000000000000000000000","Number":"String","DateText":"String","Total":0,"Balance":0,"Paid":false}],"Today":"String","NowMin":0},"Addresses":[{"Id":0,"Label":"String","Street":"String","Unit":"String","City":"String","Zip":"String","Lat":0,"Lng":0,"InArea":false}],"Cards":[{"Id":0,"Label":"String","Brand":"String","Last4":"String","IsDefault":false}],"Notif":{"Texts":false,"Push":false,"Promos":false},"Recurring":[{"Id":0,"Weekday":0,"StartMin":0,"EndMin":0,"Cadence":"String","LevelCode":"String","Units":0,"Handoff":"String","Address":"String","Paused":false,"PayMode":"String","CardLast4":"String","NextDate":"String","SkippedDate":"String","AheadDays":0}],"Booked":{"Done":false,"NeedsAction":false,"ClientSecret":"String","SetupIntentId":"String","Code":"String","TrackUrl":"String","IcsUrl":"String","WindowText":"String","Promise":"String","Total":0,"PayTiming":"String","CardLast4":"String","Repeats":"String","LinkSentBy":"String","ReopenStep":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}},"Sent":false,"Token":"String","NeedsName":false,"Name":"String","Url":"String","ClientSecret":"String","PublishableKey":"String","Message":"String","ReopenStep":"String","Customers":[{"ContactId":0,"Name":"String","Phone":"String","BillingMode":"String","AccountCode":"String","Orders":0,"LastOrderAt":"0001-01-01T00:00:00.0000000","Unbilled":0,"UnbilledAmount":0,"Cards":0}],"Run":{"Invoices":0,"Orders":0,"Total":0,"Skipped":["String"]},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}