Create Api V1 Order | Installer.com Docs

Authorization

Bearer

AuthorizationBearer <token>

Installer.com auth token

In: header

Request Body

application/json

Create order payload

TypeScript Definitions

Use the request body type in TypeScript.

name?|

Lengthlength <= 150

description?||

metadata?|

actorAssignments?array<>

workflowId?|

partnershipId?|

workflowCustomId?|

idempotencyKey?|

A unique optional identifier for the order. If the same idempotency key is used for multiple requests, the order will be created only once. Any string up to 150 characters is allowed. If not provided check for existing order with the same idempotency key will not be performed. Ideally use a UUID.

Length1 <= length <= 150

files?array<>|

orderTagIds?array<>|

customFields?array<>|

offer?|

isTest?|

Marks the order as a test order, e.g. created to try out a workflow template.

email*string

Formatemail

phoneNumber*string

contactPersonName*string

Length1 <= length <= 150

customerLegalId?|

Length1 <= length <= 50

externalId?|

The caller's own reference for this order in an external system (e.g. an accounting project reference). Free-form, up to 100 characters.

Lengthlength <= 100

property?||

address*string

Lengthlength <= 250

city*string

Lengthlength <= 150

postalCode*string

Lengthlength <= 50

state?|

Lengthlength <= 16

countryCode*string

Length2 <= length <= 2

latitude?|

longitude?|

Response Body

`application/json`

curl -X POST "https://api.installer.com/api/v1/order" \  -H "Content-Type: application/json" \  -d '{    "email": "[email protected]",    "phoneNumber": "string",    "contactPersonName": "string",    "address": "string",    "city": "string",    "postalCode": "string",    "countryCode": "st"  }'

{
  "value": "a860a344-d7b2-406e-828e-8d442f23f344",
  "displayId": "string",
  "clientUrl": "http://example.com"
}

{
  "code": "string",
  "message": "string",
  "orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5",
  "displayId": "string"
}

Authorization

Request Body

Response Body

201application/json

409application/json

`application/json`

`application/json`