Create a New Order

post

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

Create a new order, typically for manual order entry by staff.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Create a new order, typically for manual order entry by staff.

Body Params

A schema representing a patient's order, including all relevant details such as pricing, products, status, and shipping information.

organization

string

The unique identifier of the organization associated with the order.

_id

string

The unique database identifier for the order record.

number

A human-readable unique identifier for the order.

createdAt

date-time

The timestamp when the order was created.

updatedAt

date-time

The timestamp when the order was last updated.

shippedAt

date-time

The timestamp when the order was shipped.

customer

object

A subset of the patient's information linked to this order.

status

object

The current status of the order.

statusHistory

array of objects

A chronological record of all status changes for the order.

statusHistory

extras

object

Additional non-standard data related to the order.

meta

object

Metadata about the order (e.g., cart ID, payment status).

source

object

The source of the order.

lineItems

array of objects

An array of product items included in the order.

lineItems

invoices

array of objects

An array of invoice records associated with the order.

invoices

shippingAddress

object

The address to which the order will be shipped.

coupon

string

The coupon code applied to the order.

totalAmount

number

The final total amount paid for the order.

discountAmount

number

The total amount of discounts applied.

baseAmount

number

The total amount of the order before any discounts.

note

string

Any notes or special instructions for the order.

assignedTo

object

The provider or staff member assigned to this order.

assignedToGroup

string

The group that the order was assigned to.

trackingCode

string

The tracking number for the order shipment.

trackingLink

string

The URL to the shipment's tracking page.

version

number

The version of the order schema.

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

201Order created successfully.