GET
/
api
/
orders
/
{id}
curl --request GET \
  --url https://api-v2.vitau.mx/api/orders/{id}/ \
  --header 'X-API-KEY: <api-key>'
{
  "id": 123,
  "details": [
    {
      "id": 123,
      "product": {
        "id": 123,
        "current_supplier": {
          "id": 123,
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "name": "<string>"
        },
        "cost": "<string>",
        "presentation": "<string>",
        "supplier_products": [
          {
            "id": 123,
            "supplier": {
              "id": 123,
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z",
              "name": "<string>"
            },
            "cost": "<string>",
            "product": 123
          }
        ],
        "album": {
          "id": 123,
          "images": [
            {
              "id": 123,
              "album": 123,
              "image": "<string>",
              "is_default": true
            }
          ]
        },
        "product_variants": [
          {
            "id": 123,
            "variant": {
              "id": 123,
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z",
              "name": "<string>"
            },
            "value": "<string>"
          }
        ],
        "base": {
          "id": 123,
          "category": {
            "id": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "name": "<string>",
            "parent": 123
          },
          "pharmaceutical_company": {
            "id": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "name": "<string>"
          },
          "diseases": [
            {
              "id": 123,
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z",
              "name": "<string>"
            }
          ],
          "tags": [
            {
              "id": 123,
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z",
              "name": "<string>"
            }
          ],
          "medical_information": {
            "id": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "active_ingredient": "<string>",
            "is_generic": true,
            "group_number": 1073741823,
            "requires_prescription": true,
            "base_product": 123
          },
          "is_medicine": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "description": "<string>",
          "created_by": 123,
          "updated_by": 123
        },
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "price": "<string>",
        "has_iva": true,
        "public_price": "<string>",
        "average_cost": "<string>",
        "is_active": true,
        "sat_key": "<string>",
        "sat_unit": "<string>",
        "has_shortage": true,
        "ean_key": "<string>",
        "should_calculate_price": true,
        "enlace_vital_description": "<string>",
        "active_ingredient": "<string>",
        "description": "<string>",
        "group_number": 1073741823,
        "image": "<string>",
        "is_generic": true,
        "name": "<string>",
        "category": 123,
        "medical_information": 123,
        "pharmaceutical_company": 123,
        "variants": [
          123
        ],
        "diseases": [
          123
        ]
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "price": "<string>",
      "subtotal": "<string>",
      "total": "<string>",
      "discount": "<string>",
      "iva": "<string>",
      "quantity": 16383,
      "order": 123
    }
  ],
  "patient": {
    "id": 123,
    "user": {
      "id": 123,
      "patient": "<string>",
      "doctor": "<string>",
      "insurance_employee": "<string>",
      "country_code": "<string>",
      "national_number": "<string>",
      "date_joined": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z",
      "email": "jsmith@example.com",
      "phone": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "second_last_name": "<string>",
      "sex": "M",
      "birthdate": "2023-12-25",
      "medical_condition": "<string>",
      "created_by": 123,
      "groups": [
        123
      ]
    },
    "referred_by": 123,
    "default_shipping": 123,
    "default_invoicing": 123,
    "preferred_payment": 123,
    "insurance_carriers": [
      {
        "id": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "deleted_at": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "patients": [
          123
        ]
      }
    ]
  },
  "shipping": {
    "id": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "street": "<string>",
    "exterior_number": "<string>",
    "interior_number": "<string>",
    "neighborhood": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "<string>",
    "zipcode": "<string>",
    "phone": "<string>",
    "additional_info": "<string>",
    "latitude": "<string>",
    "longitude": "<string>",
    "updated_by": 123
  },
  "store": {
    "id": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "street": "<string>",
    "exterior_number": "<string>",
    "interior_number": "<string>",
    "neighborhood": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "<string>",
    "zipcode": "<string>",
    "phone": "<string>",
    "additional_info": "<string>",
    "latitude": "<string>",
    "longitude": "<string>",
    "company_name": "<string>",
    "business_hours": "<string>"
  },
  "payment": {
    "id": 123,
    "user": 123,
    "card_id": "<string>",
    "method": "<string>",
    "name": "<string>"
  },
  "paypal_agreement": {
    "id": 123,
    "email": "jsmith@example.com",
    "user": 123
  },
  "payment_references": [
    {
      "id": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "method": "<string>",
      "reference": "<string>",
      "institution": "<string>",
      "external_url": "<string>",
      "order": 123
    }
  ],
  "payment_method": {
    "id": 123,
    "fee": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "fixed_fee": "<string>"
  },
  "coupon": {
    "code": "<string>",
    "description": "<string>",
    "value": "<string>",
    "has_free_shipping": true
  },
  "generated_by": {
    "id": 123,
    "patient": "<string>",
    "doctor": "<string>",
    "insurance_employee": "<string>",
    "country_code": "<string>",
    "national_number": "<string>",
    "date_joined": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": "2023-11-07T05:31:56Z",
    "email": "jsmith@example.com",
    "phone": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "second_last_name": "<string>",
    "sex": "M",
    "birthdate": "2023-12-25",
    "medical_condition": "<string>",
    "created_by": 123,
    "groups": [
      123
    ]
  },
  "updated_by": {
    "id": 123,
    "patient": "<string>",
    "doctor": "<string>",
    "insurance_employee": "<string>",
    "country_code": "<string>",
    "national_number": "<string>",
    "date_joined": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": "2023-11-07T05:31:56Z",
    "email": "jsmith@example.com",
    "phone": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "second_last_name": "<string>",
    "sex": "M",
    "birthdate": "2023-12-25",
    "medical_condition": "<string>",
    "created_by": 123,
    "groups": [
      123
    ]
  },
  "invoicing": {
    "id": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "full_name": "<string>",
    "rfc": "<string>",
    "street": "<string>",
    "exterior_number": "<string>",
    "neighborhood": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "<string>",
    "zipcode": "<string>",
    "latitude": "<string>",
    "longitude": "<string>",
    "email": "jsmith@example.com",
    "cfdi_use": "<string>",
    "fiscal_regime": "<string>",
    "updated_by": 123
  },
  "payment_date": "2023-11-07T05:31:56Z",
  "shipping_date": "2023-11-07T05:31:56Z",
  "expected_delivery_date": "2023-11-07T05:31:56Z",
  "max_delivery_date": "2023-11-07T05:31:56Z",
  "receiving_date": "2023-11-07T05:31:56Z",
  "patient_order_status": "<string>",
  "prescriptions": [
    {
      "id": 123,
      "document_name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "issue_date": "2023-12-25",
      "expiring_date": "2023-12-25",
      "document": "<string>",
      "is_verified": true,
      "patient": 123,
      "order": 123,
      "updated_by": 123
    }
  ],
  "tags": "<string>",
  "shipping_method": {
    "id": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "company": "<string>",
    "method": "standard",
    "min_delivery_days": 16383,
    "max_delivery_days": 16383
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z",
  "insurance_refund_status": "not_started",
  "order_status": "quoted",
  "payment_status": "unpaid",
  "rejection_reason": "<string>",
  "origin": "<string>",
  "subtotal": "<string>",
  "iva": "<string>",
  "shipping_price": "<string>",
  "shipping_discount": "<string>",
  "shipping_cost": "<string>",
  "discount": "<string>",
  "total": "<string>",
  "folio": "<string>",
  "cfdi": "<string>",
  "external_payment_id": "<string>",
  "reminder": 123,
  "subscription": 123
}

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
id
string
required

Response

200 - application/json
​
details
object[]
required
​
patient
object
required
​
payment_references
object[]
required
​
payment_method
object
required
​
payment_date
string
required
​
shipping_date
string
required
​
expected_delivery_date
string
required
​
max_delivery_date
string
required
​
receiving_date
string
required
​
prescriptions
object[]
required
​
shipping_method
object
required
​
subtotal
string
required
​
shipping_price
string
required
​
discount
string
required
​
total
string
required
​
id
integer
​
shipping
object
​
store
object
​
payment
object
​
paypal_agreement
object
​
coupon
object
​
generated_by
object
​
updated_by
object
​
invoicing
object
​
patient_order_status
string
​
tags
string
​
created_at
string
​
updated_at
string
​
deleted_at
string | null
​
insurance_refund_status
enum<string>
Available options:
not_started,
missing_data,
sent_to_broker,
sent_to_insurer,
approved_by_insurer
​
order_status
enum<string>
Available options:
quoted,
pending_approval,
approved,
in_process,
ready,
shipped,
delivered,
cancelled,
delayed,
shortage
​
payment_status
enum<string>
Available options:
unpaid,
credit,
paid,
in_process,
processing,
rejected
​
rejection_reason
string
Maximum length: 50
​
origin
string
Maximum length: 20
​
iva
string
​
shipping_discount
string | null
​
shipping_cost
string | null
​
folio
string
Maximum length: 20
​
cfdi
string
Maximum length: 30
​
external_payment_id
string
Maximum length: 50
​
reminder
integer | null
​
subscription
integer | null

Was this page helpful?