ExternalOrderResult
idExternal order id in the Vignette ID system.
reference_idOrder id in the Partner system (sent on creation).
external_order_idPartner order id as stored on the Vignette ID side.
statusOrder status. One of CREATED, COMPLETED, FAILED, REFUNDED.
productdescriptionamountOrder amount in major units of currency.
currencyemailsubaccountpayment_providerProvider that processed the payment. null until the order is paid.
allowed_payment_providerscallback_urlsuccess_urlcancel_urlopen_order_details_by_defaultis_sandboxerror_messagecreated_atpaid_atcompleted_atpayment_linkURL to show to the customer to complete the payment.
Payment attempts recorded for this order.
ExternalOrdersListObject
errortotalTotal number of orders matching the filter.
limitget-product-schema
errorError can be null, a simple string code, or an object with details.
get-product-status-schema
errorError can be null, a simple string code, or an object with details.
get-user-orders-schema
idcustom_idproductuser_idpurchase_datestart_fromstart_dateend_dateperiodtypecountrystatusreceiptsubaccountResponseValidatePlateObject
Error can be null, a simple string code, or an object with details.
error-401-schema
typetitlestatusdetailinstancetransfer-order-body
target_emailEmail of an existing vignette.id user who will receive the order.
The account is not created automatically - validate the recipient first via GET /public/users/exists.
modify-order-body
New vehicle data for the order. Orders only ever have one vehicle, so there is no need to identify which one you are changing.
start_dateOptional. New start date of vignette in UNIX time in Europe/Berlin Timezone. Can't be in the past. Keeps the existing start date if omitted.