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

Cart

{
    "id": 0,
    "token": "string",
    "items": [
        {
            "questions": {
                "property1": {
                    "id": 0
                },
                "property2": {
                    "id": 0
                }
            },
            "skuId": 0,
            "remote": true,
            "remoteOnly": true,
            "heroImageUrl": "http://example.com",
            "physicalProduct": true,
            "deviceName": "string",
            "brandName": "string",
            "skuCategoryName": "string",
            "priceType": "string",
            "hasUnansweredQuestions": true,
            "autoAdded": true,
            "quantity": 0
        }
    ],
    "status": "string",
    "statusId": 0,
    "workflow": "string",
    "coupon": "string",
    "followUp": "string",
    "availability": [
        {
            "value": "2019-08-24T14:15:22.123Z",
            "display": "string"
        }
    ],
    "consolidatedAvailability": {
        "property1": [
            "string"
        ],
        "property2": [
            "string"
        ]
    },
    "address": {
        "fullAddress": "string",
        "address1": "string",
        "address2": "string",
        "city": "string",
        "state": "string",
        "zip": "string",
        "details": "string"
    },
    "plan": "string",
    "lat": 0,
    "lng": 0,
    "phone": "string",
    "phoneType": "string",
    "remotePossible": true,
    "remote": true,
    "order": "string",
    "timezone": "string",
    "unorderable": "string",
    "card": {
        "id": 0,
        "lastDigits": 0,
        "brand": "string",
        "expMonth": "string",
        "expYear": "string"
    },
    "partnerName": "string",
    "hasProduct": true,
    "clientName": "string",
    "hasPins": true,
    "hasProducts": true,
    "hasOnlyProducts": true,
    "affirmEligible": true,
    "paymentType": "string",
    "clientId": 0,
    "clientEmail": "string",
    "bookedByChat": true,
    "bookedById": 0,
    "adminId": 0,
    "partner": "string",
    "fieldSaleAgent": "string",
    "skusIncludedInUpsellPlan": true,
    "discounts": [
        "string"
    ],
    "answeredQuestions": true,
    "treatments": {
        "timeWindow": "string"
    },
    "breakdown": {
        "items": [
            {
                "skuId": 0,
                "name": "string",
                "category": "string",
                "skuSeoName": "string",
                "skuBaseAmount": 0,
                "skuAmount": 0,
                "skuAmountFormatted": "string",
                "adjustments": [
                    {
                        "name": "string",
                        "amount": 0,
                        "type": "string",
                        "amountFormatted": "string"
                    }
                ],
                "amount": 0,
                "quantity": 0,
                "prepaid": "string",
                "amountFormatted": "string",
                "image": "http://example.com",
                "isProduct": true,
                "variantsIds": [
                    0
                ],
                "requiresInstallation": true,
                "followUp": "string",
                "priceType": "string",
                "subsidyAmount": 0,
                "amountWithoutSubsidy": 0,
                "amountWithoutSubsidyFormatted": "string"
            }
        ],
        "adjustments": [
            {
                "name": "string",
                "explanation": "string",
                "feeId": 0,
                "version": 0,
                "amount": 0,
                "amountFormatted": "string",
                "originalAmount": 0,
                "originalAmountFormatted": "string",
                "type": "string",
                "description": "string",
                "skuId": 0
            }
        ],
        "subscriptionAdjustments": [
            "string"
        ],
        "total": 0,
        "tax": 0,
        "serviceTax": 0,
        "subscriptionTax": 0,
        "totalSavings": 0,
        "serviceTotal": 0,
        "subscriptionTotal": 0,
        "credits": 0,
        "serviceTaxFormatted": "string",
        "totalFormatted": "string",
        "taxFormatted": "string",
        "totalSavingsFormatted": "string",
        "serviceTotalFormatted": "string",
        "subscriptionTotalFormatted": "string",
        "itemsTotal": 0,
        "itemsTotalFormatted": "string",
        "totalAmountWithoutSubsidy": 0,
        "totalAmountWithoutSubsidyFormatted": "string",
        "totalTechPayout": 0,
        "totalTechPayoutFormatted": "string"
    }
}
Built with