GET
/
api
/
orders
curl --request GET \
  --url https://api-v2.vitau.mx/api/orders/ \
  --header 'X-API-KEY: <api-key>'
{
  "id": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "order_status": "quoted",
  "patient_order_status": "<string>",
  "patient": "<string>",
  "payment_status": "unpaid",
  "products_count": "<string>",
  "details": "<string>",
  "shipping": "<string>",
  "payment_method": "<string>",
  "coupon": "<string>",
  "total": "<string>",
  "origin": "<string>",
  "tags": "<string>",
  "expected_delivery_date": "2023-11-07T05:31:56Z",
  "max_delivery_date": "2023-11-07T05:31:56Z",
  "subscription": 123
}

Authorizations

​
X-API-KEY
string
header
required

Query Parameters

​
search
string

A search term.

​
ordering
string

Which field to use when ordering the results.

​
patient
string
​
expected_delivery_date
string
​
max_delivery_date
string
​
invoicing_status
string
​
requires_prescription
string
​
payment_method
string
​
is_subscription
string
​
origin
string
​
subscription
string
​
has_enlace_vital
string
​
order_status__in
string

Múltiples valores separados por comas.

​
payment_status__in
string

Múltiples valores separados por comas.

​
page
integer

A page number within the paginated result set.

​
limit
integer

Number of results to return per page.

Response

200 - application/json
​
total
string
required
​
expected_delivery_date
string
required
​
max_delivery_date
string
required
​
id
integer
​
created_at
string
​
order_status
enum<string>
Available options:
quoted,
pending_approval,
approved,
in_process,
ready,
shipped,
delivered,
cancelled,
delayed,
shortage
​
patient_order_status
string
​
patient
string
​
payment_status
enum<string>
Available options:
unpaid,
credit,
paid,
in_process,
processing,
rejected
​
products_count
string
​
details
string
​
shipping
string
​
payment_method
string
​
coupon
string
​
origin
string
Maximum length: 20
​
tags
string
​
subscription
integer | null

Was this page helpful?