api
checkouts

Changed on

Get all checkouts

get/api/checkouts

Request

  • Base URL: https://vivenu.com
  • URL: https://vivenu.com/api/checkouts
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Query parameters

statusstring[]

Filter checkouts by checkout status

namestring

Filter checkouts by name

emailstring

The email of the checkout customer

typestring[]

Filter checkouts by checkout type

customerIdstring

The ID of the checkout customer

$gtstring date-time

value is greater than

$gtestring date-time

value is greater than or equal

$ltstring date-time

value is less than

$ltestring date-time

value is less than or equal

$eqstring date-time

value is equal

$nestring date-time

value is not equal

$gtstring date-time

value is greater than

$gtestring date-time

value is greater than or equal

$ltstring date-time

value is less than

$ltestring date-time

value is less than or equal

$eqstring date-time

value is equal

$nestring date-time

value is not equal

topinteger

A limit on the number of objects to be returned. Can range between 1 and 1000.

skipinteger

The number of objects to skip for the requested result

Response

OK

totalinteger

Changes

  • 4ef1e0466eb3Revision changes
    • breaking

      added subschema #1 subschema #2 to the /////// response property oneOf list for the response status

    • info

      removed subschema #1 subschema #2 from the /////// response property oneOf list for the response status

  • 09cf944e044aRevision changes
    • info

      added the optional property // to the response with the status