API Reference

Sandbox Environment [Coming 2025]

Test applications and APIs in a production-like environment without consequences.

🚧

Sandbox Under Construction

For testing PlanOmatic's APIs currently, please reach out to [email protected] for information on using our staging server.

Overview

The PlanOmatic sandbox environment (referred to as staging) is a helpful tool to test API usage in a production-like environment. Additional there is some basic webhook testing that can be done using staging environment.

How Can I Test Webhooks on Staging?

Currently, you cannot progress an API order to order.delivered on the staging, but there are a few ways to test the production readiness of your API integration.

Triggering order.canceled webhook via API.

By using the PlanOmatic V3 Cancel API, you can cancel a staging order which will trigger

  • Email [email protected] about getting access to your staging integration.
  • Create a staging webhook for the order.canceled event.
  • Create a staging order via the V3 Order API.
  • Cancel the staging order via the V3 Order Cancel API.
  • Observe order.canceled (You verify webhook was sent via the PlanOintegrate webhook logs)

Listening to production webhooks

Additionally, you can also setup a production webhook to point to DEV and QA environment. This is a great way to get used to consuming production like data.

Production and Staging URL Examples

# Order API
https://api.planomatic.com/api/v3/orders/create # Production
https://api-staging.planomatic.com/api/v3/orders/create # Sandbox

# PlanOintegrate
https://integrate.planomatic.com # Production
https://integrate-staging.planomatic.com # Sandbox