HT Partner API
  1. Common
HT Partner API
  • Orders
    • Retrieve all orders
      GET
    • Order count by tag
      GET
    • Create order
      POST
  • Clients
    • Create client
      POST
    • Retrieve client
      GET
    • Update client
      PUT
    • Create setup intent
      POST
    • Create ephemeral key
      POST
  • Schemas
    • Schemas
    • Response
      • ErrorResponse
    • Common
      • Client
      • SetupIntent
      • Error
      • SkuQuestion
      • Sku
      • Cart
      • Order
    • Params
      • ClientParams
    • Params
      • CartItem
  1. Common

Order

{
    "id": 0,
    "token": "string",
    "clientId": 0,
    "clientName": "string",
    "statusId": 0,
    "progressStatusId": 0,
    "createdAt": "2019-08-24T14:15:22.123Z",
    "remote": true,
    "workflow": "string",
    "hasPartner": true,
    "partner": "string",
    "clientZip": "string",
    "appointmentStart": "string",
    "appointmentStartDateTime": "string",
    "startedAt": "string",
    "completedAt": "string",
    "standByTimes": [
        {}
    ],
    "atRisk": true,
    "hasAuthError": true,
    "hasSetPassword": true,
    "breakdown": {
        "services": [
            {
                "id": 0,
                "skuId": 0,
                "name": "string",
                "amount": "string",
                "price": "string",
                "originalAmount": "string",
                "prepaid": "string",
                "totalAmount": "string",
                "originalTotalAmount": "string",
                "adjustments": [
                    {
                        "name": "string",
                        "details": "string",
                        "amount": "string",
                        "originalAmount": "string"
                    }
                ],
                "physicalProduct": true,
                "image": "http://example.com",
                "quantity": 0,
                "priceType": "string",
                "estimatedDuration": "string",
                "duration": "string"
            }
        ],
        "adjustments": [
            {
                "name": "string",
                "amount": "string",
                "originalAmount": "string",
                "type": "string",
                "explanation": "string",
                "feeId": 0,
                "version": 0,
                "originalAmountFormatted": "string"
            }
        ],
        "coupon": "string",
        "totalAmount": "string"
    },
    "childFollowUp": "string",
    "parentFollowUp": "string",
    "hasProducts": true,
    "hasOnlyProducts": true,
    "paymentSource": "string",
    "timezone": "string",
    "agent": "string",
    "treatments": {},
    "orderSummaryUrl": "string"
}
Built with