Trendsic Platform Service

<back to all web services

DispatchPickupBookRequest

The following routes are available for this service:
POST,OPTIONS/v1/dispatch/public/pickup/{SchedulerUrl}
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchPickupBookResponse:
    code: Optional[str] = None
    fare: Decimal = decimal.Decimal(0)
    zone: Optional[str] = None
    bags: int = 0
    pay_mode: Optional[str] = None
    pay_line: Optional[str] = None
    track_url: Optional[str] = None
    book_token: Optional[str] = None
    client_secret: Optional[str] = None
    publishable_key: Optional[str] = None
    delivery: Optional[str] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchPickupBookRequest:
    scheduler_url: Optional[str] = None
    address: Optional[str] = None
    unit: Optional[str] = None
    city: Optional[str] = None
    zip: Optional[str] = None
    zone: Optional[str] = None
    bags: int = 0
    needs: List[str] = field(default_factory=list)
    note: Optional[str] = None
    customer_name: Optional[str] = None
    customer_phone: Optional[str] = None
    pay_mode: Optional[str] = None
    account_code: Optional[str] = None
    turnstile_token: Optional[str] = None

Python DispatchPickupBookRequest DTOs

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

HTTP + OTHER

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

POST /v1/dispatch/public/pickup/{SchedulerUrl} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"SchedulerUrl":"String","Address":"String","Unit":"String","City":"String","Zip":"String","Zone":"String","Bags":0,"Needs":["String"],"Note":"String","CustomerName":"String","CustomerPhone":"String","PayMode":"String","AccountCode":"String","TurnstileToken":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Code":"String","Fare":0,"Zone":"String","Bags":0,"PayMode":"String","PayLine":"String","TrackUrl":"String","BookToken":"String","ClientSecret":"String","PublishableKey":"String","Delivery":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}