--- title: "GET /api/purchaseintents" method: GET path: "/api/purchaseintents" tags: ["api", "purchaseintents"] --- # GET /api/purchaseintents `GET /api/purchaseintents` Get all PurchaseIntents ## Query parameters - `customerId` string — The customer id to filter for - `status` string — The status to filter for - `approvalStatus` string — The approval status to filter for - `name` string — The name to filter for - `eventId` string — The event id to filter for - `shopId` string — The secret shop id to filter for - `createdAtStart` string — An ISO timestamp from which to filter for - `createdAtEnd` string — An ISO timestamp until which to filter for - `outcomeCheckoutId` string — The resulting checkout id. - `top` integer — A limit on the number of objects to be returned. Can range between 1 and 1000. - `skip` integer — The number of objects to skip for the requested result ## Response `200` OK - GETPurchaseintentsGetAllPurchaseIntents200Response - `rows` PurchaseIntentResource[] - `_id` string, required - `status` 'new' | 'complete' | 'canceled', required - `approvalStatus` 'awaiting' | 'approved' | 'rejected', required - `rejectionReason` string - `company` string - `firstname` string - `lastname` string - `name` string - `email` string, email - `customerId` string - `address` object - `fullAddress` string, nullable — Optional full address - `street` string, nullable — The street of the address. Street name including number. - `line2` string, nullable — The additional field of the address. - `postal` string, nullable — The postal code of the address. - `city` string, nullable — The city of the address. - `country` string, nullable — The country of the address. An ISO 3166 country code. - `state` string, nullable — The state of the address. If applicable - `deliveryAddress` object - `fullAddress` string, nullable — Optional full address - `street` string, nullable — The street of the address. Street name including number. - `line2` string, nullable — The additional field of the address. - `postal` string, nullable — The postal code of the address. - `city` string, nullable — The city of the address. - `country` string, nullable — The country of the address. An ISO 3166 country code. - `state` string, nullable — The state of the address. If applicable - `name` string — The name of the person receiving delivery. - `identification` LegalIdentificationDocumentResource[] — An array of identification items - union - object - `type` 'france_siren', required - `identifier` string, required - object - `type` 'spain_tax_id' | 'origin_country_id', required — The type of the identification document. - `sellerId` string, required - `eventId` string, required - `shopId` string - `strategyId` string - `vouchers` string[] - `appliedCoupons` union[] - union - boolean - number - object - string - `regularPrice` number, float, required - `realPrice` number, float, required - `currency` 'EUR' | 'USD' | 'GBP' | 'AUD' | 'CHF' | 'THB' | 'ILS' | 'COP' | 'MXN' | 'DKK' | 'NOK' | 'SEK' | 'QAR' | 'CAD' | 'ISK' | 'GTQ' | 'INR' | 'DOP' | 'SGD' | 'PLN' | 'SAR' | 'TTD' | 'ZAR' | 'KYD' | 'HKD' | 'CZK' | 'KRW' | 'JPY' | 'NZD' | 'AED' | 'MAD' | 'TWD' | 'BRL' | 'BWP' | 'NAD' | 'KES' | 'SCR' | 'TRY' | 'SZL' | 'LSL' | 'TZS' | 'UGX' | 'ZMW' | 'ZWG' | 'GHS' | 'NGN' | 'SLE' | 'LRD' | 'XOF' | 'XAF' | 'GEL' | 'IDR' | 'ARS' | 'CRC' | 'HUF' | 'EGP' | 'MYR' | 'VND' | 'PHP' | 'MWK', required - `innerFeeComponents` union - boolean - number - object - string - `innerCharge` number, float, required - `outerFeeComponents` union - boolean - number - object - string - `outerCharge` number, float, required - `tickets` object[], required - `type` 'ticket' — The type of the cart item. - `_id` string — Unique identifier for the cart item. If omitted, the system will automatically generate one. - `name` string, nullable — The name of the cart item. - `amount` integer, required — The amount of the cart item. - `netPrice` number, float — The single piece net price of the cart item. - `price` number, float, required — The single piece price of the cart item. - `taxRate` number, float, nullable — The tax rate to be applied to this cart item. If not present the tax rate of the transaction is taken. - `triggeredBy` union — An ID or an array of IDs of other cart items which triggered the buy action of the cart item. - string — An ID of another cart item which triggered the buy action of the cart item. - string[] — An array of IDs of other cart items which triggered the buy action of the cart item. - `bundleInfo` object, nullable - `bundleId` string - `componentId` string - `optionId` string - `ticketTypeId` string, required — The ID of the ticket type of the cart item. - `categoryRef` string — The category reference of the ticket type. - `seatingInfo` object, nullable — The associated seating object. - `_id` string — The ID of the seating object. - `_type` 6 | 7, float, required — Indicates the type of seating object. Seat = 6, General Admission = 7. - `categoryId` string — The ID of the category containing the seating object. - `statusId` string, required — The ID of a container holding information about the seating status of the seating object. - `name` string, nullable — If _type == 7. The name of the general admission. - `seatType` 'handicapped' | 'limitedView' | 'foldable', nullable — If _type == 6. The type of the seat. null = normal. - `sectionName` string, nullable — If _type == 6. The name of the section where the seat is located. - `groupName` string, nullable — If _type == 6. The name of the row group where the seat is located. - `rowName` string, nullable — If _type == 6. The name of the row where the seat is located. - `seatName` string, nullable — If _type == 6. The seat name. - `gate` string, nullable — The entry gate associated with the seating object. - `slotInfo` object, nullable — The associated time slot object. - `slotId` string, required — The ID of the time slot. - `slotStartTime` string, required — The start time of the time slot. - `asHardTicket` boolean, nullable — Whether this ticket is a hard ticket. - `listingId` string, nullable — Listing in secondary market. - `listingItemId` string, nullable — The ID of the listing item in the secondary market. - `triggeredAutomations` boolean, nullable — Whether the cart item triggered automations. - `meta` object, nullable — Meta data which is propagated to the ticket. - `addOns` object[] — A list of Add-Ons of the ticket. - `productId` string, required - `productVariantId` string, required - `name` string, required - `capabilities` union[], nullable — The capabilities of the ticket. - union - object - `type` 'self_service_return', required - `settings` object, required - … - object - `type` 'repersonalization', required - `settings` object, required - … - `taxInfo` object — The tax info details. - `serviceTypeId` string — The ID of the service type. - `exceptionId` string — The ID of the exception. - `proceedsAccountId` string — The ID of the proceeds account. - `proceedsAccountCode` string — The code of the proceeds account. - `taxItems` object[] — The array of tax items. - `name` string, nullable - `taxTypeId` string, nullable - `rate` number, float, required - `perUnit` number, float, required - `total` number, float, required - `netTotal` number, float, nullable - `netPerUnit` number, float, nullable - `taxPayableAccountId` string, nullable - `taxPayableAccountCode` string, nullable - `products` object[] - `type` 'product', required — The type of the cart item. - `_id` string — Unique identifier for the cart item. If omitted, the system will automatically generate one. - `name` string, nullable — The name of the cart item. - `amount` integer, required — The amount of the cart item. - `netPrice` number, float — The single piece net price of the cart item. - `price` number, float, required — The single piece price of the cart item. - `taxRate` number, float, nullable — The tax rate to be applied to this cart item. If not present the tax rate of the transaction is taken. - `triggeredBy` union — An ID or an array of IDs of other cart items which triggered the buy action of the cart item. - string — An ID of another cart item which triggered the buy action of the cart item. - string[] — An array of IDs of other cart items which triggered the buy action of the cart item. - `bundleInfo` object, nullable - `bundleId` string - `componentId` string - `optionId` string - `productVariantId` string, required — The ID of the product variant. - `isFulfillable` boolean — Whether the product can be delivered - `taxInfo` object — The tax info details. - `serviceTypeId` string — The ID of the service type. - `exceptionId` string — The ID of the exception. - `proceedsAccountId` string — The ID of the proceeds account. - `proceedsAccountCode` string — The code of the proceeds account. - `taxItems` object[] — The array of tax items. - `name` string, nullable - `taxTypeId` string, nullable - `rate` number, float, required - `perUnit` number, float, required - `total` number, float, required - `netTotal` number, float, nullable - `netPerUnit` number, float, nullable - `taxPayableAccountId` string, nullable - `taxPayableAccountCode` string, nullable - `additionalItems` union[] - union - object - `itemId` string, required — The ID of the item. - `type` 'bundle', required — The type of the additional item. - `netPrice` number, float, required — The single piece net price of the additional item. - `price` number, float, required — The single piece price of the additional item. - `taxRate` number, float, nullable, required — The tax rate to be applied to this additional item. - `taxInfo` object — The tax info details. - `serviceTypeId` string — The ID of the service type. - `exceptionId` string — The ID of the exception. - `proceedsAccountId` string — The ID of the proceeds account. - `proceedsAccountCode` string — The code of the proceeds account. - `taxItems` object[] — The array of tax items. - … - `data` object - `bundleId` string, required — The ID of the bundle. - object - `itemId` string, required — The ID of the item. - `type` 'fulfillmentType', required — The type of the additional item. - `netPrice` number, float, required — The single piece net price of the additional item. - `price` number, float, required — The single piece price of the additional item. - `taxRate` number, float, nullable, required — The tax rate to be applied to this additional item. - `taxInfo` object — The tax info details. - `serviceTypeId` string — The ID of the service type. - `exceptionId` string — The ID of the exception. - `proceedsAccountId` string — The ID of the proceeds account. - `proceedsAccountCode` string — The code of the proceeds account. - `taxItems` object[] — The array of tax items. - … - `data` object - `fulfillmentTypeId` string, required — The ID of the fulfillment type. - `cartItemIds` string[] — The array of the related cart items IDs. - `extraFields` object - `expiresAt` string, date-time - `secret` string, required - `transactionId` string - `outcome` object - `checkoutId` string - `restrictedCompletion` string[], nullable — Specifies how the customer can complete their purchase intent - `cancellationStrategy` 'notAllowed' | 'cancellationAllowed' - `seatingReservationToken` string - `salesChannelId` string - `meta` object — Custom key-value data. Metadata is useful for storing additional, structured information on an object. - `history` object[] — An array of history items indicating changes on the purchase intent - `type` 'purchaseIntent.created' | 'purchaseIntent.approved' | 'purchaseIntent.rejected' | 'purchaseIntent.updated' | 'purchaseIntent.expired' | 'purchaseIntent.completed' | 'purchaseIntent.canceled' | 'purchaseIntent.commented' | 'purchaseIntent.resent.mail' — The type of the history item. - `date` string, date-time — An ISO timestamp indicating the date of the history item. - `userId` string, nullable — The user ID of the history item. - `data` object — The data of the history item - `userId` string — The ID of the user who created the purchase intent. - `deposit` object — Information for the deposit paid, if there was any - `amount` number, float, required — The amount paid for the deposit - `paymentId` string, required — The id of the payment for the deposit - `balanceTransactionId` string, required — The id of the transaction for the deposit - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `__v` integer - `total` integer ## Other responses - `400` — Bad Request - `401` — Unauthorized --- [API](https://skmtc.net/vivenu/apis/vivenu-api.md) · [All operations](https://skmtc.net/vivenu/apis/vivenu-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vivenu/vivenu-api/revisions/36be0dca14e7/schema)