Ordering Details

Here are key guidelines for creating companies and placing orders via the Pax8 API.

Creating an Active Company

Before creating an order for a Company, the Company must be in an Active status.

Upon initial creation, a Company is placed into an Inactive status. To activate the Company, you must add one or more contacts that fulfill all primary contact constraints. A Company is required to have a primary Contact for each Contact Type ("Admin", "Billing", "Technical").

One contact designated as primary for all three types is sufficient to meet this requirement.

Placing Orders

Future-Dated Scheduled Orders

Currently, the Pax8 API does not support future-dated scheduled orders (e.g., placing an order today that activates in 10 days). While this ability is supported via the Pax8 platform interface, API users must use a workaround.

Workaround:
To handle this in your system, you can:

• Place the order immediately when you receive it.
• Alternatively, build logic into your system to trigger the order once the desired date/time has passed. This may involve running a cron job or background service to check and place the order at the specified time.

Endpoint: Create Order

Placing Test Orders

To test your ordering integration without creating billable data, you can use the isMock query parameter. The create order endpoint takes an optional ?isMock=true parameter.

When used, the API will validate your entire order payload.

• If the order is invalid, the API will return an error.
• If the order is valid, the API will return a success response, but the order will not be placed and no data will be created in the Pax8 system.