HT Partner API

Create order

POST/api/partners/orders

Creates an order.

Request

Header Params

string

optional

Example:

application/json

client_id

integer

optional

Client ID should be created by partner (if absent, the following fields are required and will create a new client)

first_name

string

optional

The first name of the customer (optional if client_id is passed)

last_name

string

optional

The last name of the customer (optional if client_id is passed)

string

optional

The email address of the customer (optional if client_id is passed)

address

string

required

The full address of the customer

address_details

string

optional

The apartment number or any additional information about the address

phone

string

required

The phone number for the customer

business_name

string

optional

The business name for the order, if applicable

sku_id

array[integer]

required

The SKUs that the customer has purchased

devices

array[string]

optional

The devices that a customer has (if more than 1, it will increase order price and tech payout)

notes

string

optional

Any additional notes that will be helpful regarding the customers service

time_windows

array [object {2}]

optional

An array of time windows with 1 hour blocks that we can go on site for the customer's service

start_time

string

optional

end_time

string

optional

purchase_order_id

string

optional

External ID reference (partner ID)

{
  "client_id": null,
  "first_name": "John",
  "last_name": "Doe",
  "email": "johndoe1@hellotech.com",
  "address": "719 Flower St, Los Angeles, CA 90017",
  "address_details": "Yellow house",
  "phone": "8888888888",
  "business_name": "John Doe S/A",
  "sku_id": [
    10639
  ],
  "devices": [
    "iPhone 13"
  ],
  "notes": "This is everything",
  "time_windows": [
    {
      "start_time": "2024-11-03T16:00:00.000Z",
      "end_time": "2024-11-03T17:00:00.000Z"
    },
    {
      "start_time": "2024-11-03T17:00:00.000Z",
      "end_time": "2024-11-03T18:00:00.000Z"
    }
  ],
  "purchase_order_id": "PO-1234"
}

Request samples

Responses

Success(200)

HTTP Code: 200

Content Type : JSONapplication/json

status

string

required

order

object

required

integer

required

status

string

required

client_id

integer

required

client_name

string

required

string

required

phone

object

required

address

string

required

service_description

string

required

events

array[string]

required

created_at

object

required

updated_at

object

required

tags

array[string]

required

token

string

required

status_label

string

required

client_city

string

required

client_state

string

required

client_street

string

required

client_zip

string

required

client_availability_ranges

array [object {4}]

required

skus

array [object {5}]

required

finish_order_url

string

required

order_summary_url

string

required

shipping_type

null

required

availability

array [object {2}]

required

consolidated_availability

object

required

appointment_start

null

required

appointment_start_date_time

null

required

{
  "order": {
    "id": 432873,
    "status": "Pending",
    "clientName": "Client Name",
    "clientCity": "Indianapolis",
    "clientState": "IN",
    "createdAt": {
      "integer": 1728427930,
      "iso": "2024-10-08T22:52:10Z",
      "isoShort": "2024-10-08T22:52:10"
    }
  }
}

Last modified: 2 months ago