Create Order

post

https://api.planomatic.com/api/v3/orders/create

Body Params

api_key

string

required

Defaults to y0Ur-AP1-k3y

Integration api token. Learn more >

external_property_id

string

required

Defaults to {property_id}

Client identification key of property.

billing_entity_slug

string

required

Defaults to investment_entity_1

Unique identifier of the billing entity that the order will be placed under. [Learn more >] (/reference/billing-entities)

metadata

object

Data stored and returned back in API responses, webhook payloads, and invoices. Limited to 4 keys and values with a max length of 255 character. Learn more >

services

array of objects

required

Array of service objects. Our services >

services*

property_access

object

required

Details required to access your property. Learn more >

property

object

required

Property information for the order.

external_order_id

string

Defaults to {external_order_id}

Optional identifier for the order.

order_notes

string

Defaults to Some special instructions.

Optional notes seen by the assigned PlanOtech while on-site during the appointment. 1,000 character limit.

Responses

Language

Response

Choose an example:

application/json

200200

400400