API Reference

Create Order

post
https://api.planomatic.com/api/v3/orders/create
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

The Create Order API is the fastest way to get marketing materials for your properties. Your order starts the scheduling process the minute it's sent, ensuring you get your assets as quickly as possible. Our services >

How to Test

Email [email protected] for access to our QA environment, then send your requests to the QA host with your QA API key. Test environment >

POST https://api.planomatic.com/api/v3/orders/create      # Production
POST https://api.qa.planomatic.com/api/v3/orders/create   # QA
Body Params
string
required
Defaults to y0Ur-AP1-k3y

Integration api token. Learn more >

string
required
Defaults to {property_id}

Client identification key of property.

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 up to 4 entries with keys up to 60 characters and values up to 255 characters. Keys use the charset [a-zA-Z0-9_]. These limits are per-integration configurable defaults. 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.

string
Defaults to {external_order_id}

Optional identifier for the order.

string
Defaults to Some special instructions.

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

Responses

Updated 14 days ago

Did this page help you?
Language
LoadingLoading…
Response
Choose an example:
application/json

Updated 14 days ago

Did this page help you?