Create Order

POST/api/v1/orders/create/externalAccessExpress

Creates an order along with all the necessary related entities. Use this endpoint after receiving a quote to place an order for services.

Auth Scope

urn:grt:accessexpress

Content-Type

application/json

Rate Limit

60 req/min

Headers

Header	Value
`Authorization`	`Bearer access-token`

Field	Type	Required	Description
`quote_request_id`	UUID	Yes	Unique identifier of the associated quote request
`order_name`	string	Yes	A user-defined name for the order, used for easy identification
`requester`	string	Yes	Name of the person requesting the order
`customer_name`	string	Yes	Name of the customer on whose behalf the order is placed
`order_items`	array of order_items	Yes	List of items to be included in the order, each containing product and location-specific information
`granted_tenant_macnum`	string	No	The company macnum on whose behalf the action is performed

Each item in the order_items list should contain:

Field	Type	Required	Description
`location_id`	UUID	Yes	Unique identifier of the physical location for the product/service delivery
`formal_product_id`	UUID	Yes	Unique identifier of the formal product being ordered
`local_contact_name`	string	Yes	Name of the local contact at the delivery location
`location_contact_email`	string	Yes	Email address of the location's point of contact
`local_contact_phone`	string	Yes	Phone number of the location's point of contact
`business_name`	string	Yes	Name of the business operating at the location
`network_monitoring_package`	string	No	Name of the requested network monitoring package. Acceptable values are `"essentials"` or `"enhanced"` for Broadband, `"enhanced"` for DIA, or `"none"` if no package is desired. By default, products include recommended packages
`account_macnum`	string	No	Account macnum provided with corresponding address
`account_to_create`	account	No	New account details to be created

Exactly one of account_macnum or account_to_create must be provided.
The values for quote_request_id, location_id, account_macnum, and formal_product_id should be retrieved from the quote endpoints.

When creating a new account, the account_to_create object should contain:

Field	Type	Required	Description
`parent_macnum`	string	Yes	Number of the parent account under which the new account will be created
`parent_name`	string	Yes	Name of the parent account
`billing_type`	string	Yes	Code representing the type of billing. Valid values: `"4"` (Bill to Parent Account), `"5"` (Bill to This Account)
`invoice_delivery_method`	string	Yes	Method used to deliver invoices. Valid values: `"1"` (Paper only), `"2"` (Paper & email), `"3"` (Email only)
`invoice_style`	string	Yes	Style or format of the invoice to be used. For billing_type "4": `"Summary Bill"`, `"Network integration only"`, `"No site invoice"`. For billing_type "5": `"Summary Bill"`, `"Network integration only"`
`address_line_1`	string	Yes	Primary street address
`city`	string	Yes	City where the business is located
`state`	string	Yes	State or province of the business
`zip`	string	Yes	Postal code of the business location
`billing_address_line_1`	string	Yes	Primary billing address
`billing_city`	string	Yes	City of the billing address
`billing_state`	string	Yes	State of the billing address
`billing_zip_code`	string	Yes	Postal code of the billing address

Field	Type	Description
`opportunity_id`	string	Unique identifier for the created opportunity
`order_status`	string	Current status of the order. Typically `"submitted"` upon successful creation
`quote_id`	string	Identifier linking the order to the original quote

HTTP Status	Error Description	Resolution
`400`	Bad Request	Review the error response body for specific validation errors. Common issues: missing required fields, invalid account_macnum or quote_request_id, or both account_macnum and account_to_create provided (exactly one must be provided).
`401`	Authentication Failed	Verify your access token is valid and included in the Authorization header with the "Bearer " prefix.
`403`	Permission Denied	You do not have permissions to create orders for the specified accounts. Check your API scope (`urn:grt:accessexpress`).
`404`	Not Found	The provided quote_request_id, location_id, or account_macnum was not found. Verify these values were retrieved from the quote endpoints.