Changelog
Back to All
Added

Order placement API, plus userId on reschedule & cancel

about 22 hours ago by Daniel Druchleben

You can now place orders programmatically, and identify the acting user by userId on reschedule and cancel endpoints.

Place an order

A new guided purchase flow lets you create an order end to end:

  • POST /v1/sessions: open a purchase session for a workspace user and property.
  • GET /v1/sessions/{sessionId}/products: discover the products available in the session.
  • POST /v1/sessions/{sessionId}/instructions: fetch the billing, organization, and delivery instruction options for the products you selected.
  • POST /v1/orders: place the order using the session, products, and instructions.

See the new Order Sessions and updated Orders sections in the API Reference for request and response details.

userId on reschedule & cancel

The reschedule and cancel endpoints now accept userId as an alternative to userReferenceId. Supply either one to identify the user acting on the order:

  • PUT /v1/orders/{orderPublicId}/reschedule
  • PUT /v1/orders/{orderPublicId}/cancel