Skip to main content
PATCH
/
api
/
orders
/
{id}
/
request-invoice
cURL
curl --request PATCH \
  --url https://api-v2.vitau.mx/api/orders/{id}/request-invoice/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "full_name": "<string>",
  "rfc": "<string>",
  "street": "<string>",
  "exterior_number": "<string>",
  "neighborhood": "<string>",
  "city": "<string>",
  "state": "<string>",
  "country": "<string>",
  "zipcode": "<string>",
  "cfdi_use": "<string>",
  "fiscal_regime": "<string>",
  "latitude": "<string>",
  "longitude": "<string>",
  "email": "[email protected]"
}
'
{
  "details": [
    {
      "product": 123,
      "quantity": 16383,
      "id": 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>",
      "order": 123
    }
  ],
  "patient": 123,
  "payment_method": 123,
  "id": 123,
  "shipping": 123,
  "store": 123,
  "payment": 123,
  "paypal_agreement": 123,
  "invoicing": 123,
  "coupon": "<string>",
  "shipping_method": 123,
  "prescriptions": [
    {
      "document": "<string>",
      "issue_date": "2023-12-25",
      "id": 123,
      "document_name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "expiring_date": "2023-12-25",
      "is_verified": true,
      "patient": 123,
      "order": 123,
      "updated_by": 123
    }
  ],
  "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>",
  "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",
  "folio": "<string>",
  "cfdi": "<string>",
  "external_payment_id": "<string>",
  "generated_by": 123,
  "updated_by": 123,
  "reminder": 123,
  "subscription": 123
}

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
id
integer
required

A unique integer value identifying this order.

Body

application/json
​
full_name
string
required
Required string length: 1 - 100
​
rfc
string
required
Required string length: 1 - 20
​
street
string
required
Maximum string length: 250
​
exterior_number
string
required
Maximum string length: 20
​
neighborhood
string
required
Maximum string length: 100
​
city
string
required
Maximum string length: 100
​
state
string
required
Maximum string length: 100
​
country
string
required
Maximum string length: 100
​
zipcode
string
required
Maximum string length: 20
​
cfdi_use
string
required
Maximum string length: 4
​
fiscal_regime
string
required
Maximum string length: 3
​
latitude
string<decimal> | null
​
longitude
string<decimal> | null
​
email
string<email>
Maximum string length: 254

Response

200 - application/json
​
details
object[]
required
​
patient
integer
required
​
payment_method
integer
required
​
id
integer
​
shipping
integer | null
​
store
integer | null
​
payment
integer | null
​
paypal_agreement
integer
​
invoicing
integer | null
​
coupon
string
Required string length: 1 - 16
​
shipping_method
integer
​
prescriptions
object[]
​
created_at
string<date-time>
​
updated_at
string<date-time>
​
deleted_at
string<date-time> | 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
Minimum string length: 1
​
origin
string
Maximum string length: 20
​
subtotal
string<decimal>
​
iva
string<decimal>
​
shipping_price
string<decimal>
​
shipping_discount
string<decimal> | null
​
shipping_cost
string<decimal>
​
discount
string<decimal>
​
total
string<decimal>
​
payment_date
string<date-time>
​
shipping_date
string<date-time>
​
expected_delivery_date
string<date-time>
​
max_delivery_date
string<date-time>
​
receiving_date
string<date-time>
​
folio
string
Maximum string length: 20
​
cfdi
string
Minimum string length: 1
​
external_payment_id
string
Minimum string length: 1
​
generated_by
integer | null
​
updated_by
integer | null
​
reminder
integer | null
​
subscription
integer