Create an Order

post

https://patient-api.portals.care/orders

Create a new order for the authenticated patient.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Create a new order for the authenticated patient.

Body Params

A Data Transfer Object (DTO) for creating a new patient order. This schema is used when a patient finalizes their checkout, providing cart, payment, and shipping details.

cartId

string

The unique identifier of the cart from which the order is being created.

paymentMethodId

string

The unique identifier of the payment method to be charged for the order.

shippingAddress

object

The full shipping address for the order. This can be a new address or a saved one from the patient's profile.

isNewShippingAddress

boolean

A boolean flag indicating whether the provided shippingAddress is a new address being saved for the patient.

couponCode

string

The coupon code to be applied to the order, if any.

pauseCollection

boolean

A boolean flag that, when true, indicates that payment should not be charged immediately. This is often used for orders that require provider review before payment is processed.

assignedToGroup

string

The unique identifier of the group that the order should be assigned to for processing.

Headers

authorization

string

required

A Valid JWT Authentication token.

organization

string

Your unique Organization ID. This header is only required when using a custom portal domain, otherwise it is optional.

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201