Welcome to our beta documentation!
Vignette ID API Documentation
Partner API (v1.0)

Orders List Endpoints (1.0.0)

Endpoint:https://docs.vignette.id

Get Orders

GET
https://docs.vignette.id
/public/orders

Get Orders › query Parameters

  • statusstring
  • bug_reportboolean
    Default: false

Get Orders › Headers

  • Authorizationstring · required

Get Orders › Responses

  • idstring
  • emailstring
  • created_datenumber

Create order

POST
https://docs.vignette.id
/public/orders

Create order › Headers

  • Authorizationstring · required
  • Content-Typestring · enum · required
    Enum values:
    application/json

Create order › Request Body

  • terms_and_privacy_acceptedboolean · required
    Example: true
  • order_has_been_paidboolean · required
    Example: true
  • carsobject[] · required
  • productsobject[] · required
  • emailstring · email
  • userobject
  • interchange_feeobject

Create order › Responses

  • errornull
  • resultobject

Get Order

GET
https://docs.vignette.id
/public/orders/:id

Get Order › path Parameters

  • idstring · required

Get Order › query Parameters

  • bug_reportboolean
    Default: false

Get Order › Headers

  • Authorizationstring · required

Get Order › Responses

  • errornull
  • resultobject

Get Order Status

GET
https://docs.vignette.id
/public/orders/:id/status

Get Order Status › path Parameters

  • idstring · required

Get Order Status › query Parameters

  • bug_reportboolean
    Default: false

Get Order Status › Headers

  • Authorizationstring · required

Get Order Status › Responses

  • errornull
  • resultobject

Cancel Pending Order (will be deprecated)

POST
https://docs.vignette.id
/public/orders/:id/cancel

Cancel Pending Order (will be deprecated) › path Parameters

  • idstring · required

Cancel Pending Order (will be deprecated) › query Parameters

  • bug_reportboolean
    Default: false

Cancel Pending Order (will be deprecated) › Headers

  • Authorizationstring · required

Cancel Pending Order (will be deprecated) › Responses

  • errornull
  • resultobject

Cancel Pending Order

POST
https://docs.vignette.id
/public/orders/:id/cancel-pending

Cancel Pending Order › path Parameters

  • idstring · required

Cancel Pending Order › query Parameters

  • bug_reportboolean
    Default: false

Cancel Pending Order › Headers

  • Authorizationstring · required

Cancel Pending Order › Responses

  • errornull
  • resultobject

Cancel Deferred Order

POST
https://docs.vignette.id
/public/orders/:id/cancel-deferred

Cancel Deferred Order › path Parameters

  • idstring · required

Cancel Deferred Order › query Parameters

  • bug_reportboolean
    Default: false

Cancel Deferred Order › Headers

  • Authorizationstring · required

Cancel Deferred Order › Responses

  • errornull
  • resultobject
Users List EndpointsExtended List Endpoints