Sign in
latestOpenAPI 3.0.02026-08-10134271194.2 KB

da24e062ff11

Purchase State

Get Events by Shopify Subscription ID. Returns up to 250 most recent events

get/vendor/purchase-state/{shopifySubscriptionId}/events

Path parameters

shopifySubscriptionIdstring required

Response

Successful response

idstring required
createdBy'CUSTOMER' | 'AGENT' | 'SCRIPT' | 'SEQUENTIAL' | 'SMARTRR' | 'API' required
eventDatestring required

A string in ISO format (ISO 8601 Extended Format): YYYY-MM-DDTHH:mm:ss.sssZ

eventType'CHANGE_ORDER_DATE' | 'CHANGE_SELLING_PLAN' | 'PAUSE' | 'CANCEL_PREPAID' | 'CANCEL' | 'EXPIRED' | 'ACTIVATE' | 'FAILED_DISCOUNT' | 'SUCCESSFUL_DISCOUNT' | 'SUCCESSFUL_BILLING_ATTEMPT' | 'FAILED_BILLING_ATTEMPT' | 'CREATE_BILL' | 'SKIP' | 'UNSKIP' | 'GIFT' | 'UNDO_GIFT' | 'ADD_ADDRESS' | 'CHANGE_ADDRESS' | 'UPDATE_ADDRESS' | 'DELETE_ADDRESS' | 'REMOVE_DISCOUNT' | 'REMOVE_LINE_ITEM' | 'UPDATE_LINE_ITEM' | 'ADD_LINE_ITEM' | 'CHANGE_SHIPPING_PRICE' | 'SWAP_LINE_ITEM' | 'FAILED_CHANGE_ORDER_DATE' | 'FAILED_CHANGE_SELLING_PLAN' | 'FAILED_PAUSE' | 'FAILED_CANCEL' | 'FAILED_ACTIVATE' | 'FAILED_SKIP' | 'FAILED_UNSKIP' | 'FAILED_GIFT' | 'FAILED_UNDO_GIFT' | 'FAILED_ADD_ADDRESS' | 'FAILED_UPDATE_ADDRESS' | 'FAILED_CHANGE_ADDRESS' | 'FAILED_DELETE_ADDRESS' | 'FAILED_REMOVE_DISCOUNT' | 'FAILED_REMOVE_LINE_ITEM' | 'FAILED_UPDATE_LINE_ITEM' | 'FAILED_ADD_LINE_ITEM' | 'FAILED_CHANGE_SHIPPING_PRICE' | 'FAILED_SWAP_LINE_ITEM' | 'OOS_AUTOMATIC_PAUSE' | 'UNAVAILABLE_AUTOMATIC_PAUSE' | 'OOS_LINE_ITEM_REMOVED' | 'OOS_LINE_ITEM_REINSERTED' | 'OOS_AUTOMATIC_SKIP' | 'REWARDS_REDEEMED_PRODUCT' | 'REWARDS_REDEEMED_INCENTIVE' | 'REWARDS_POINTS_EARNED' | 'REWARDS_POINTS_CORRECTION' | 'UPDATE_EXTERNAL_SUBSCRIPTION_DATES' | 'FAILED_UPDATE_EXTERNAL_SUBSCRIPTION_DATES' | 'NOTIFICATION_SUBS_CREATED_NEW' | 'NOTIFICATION_SUBS_CREATED_EXISTING' | 'NOTIFICATION_PAYMENT_FAILED' | 'NOTIFICATION_SUBSCRIPTION_CANCELED' | 'NOTIFICATION_SUBSCRIPTION_PAUSED' | 'NOTIFICATION_SUBSCRIPTION_ACTIVATED' | 'NOTIFICATION_UPCOMING_ORDER' | 'NOTIFICATION_PAYMENT_EXPIRATION' | 'NOTIFICATION_ITEM_OUT_OF_STOCK' | 'NOTIFICATION_GIFT_CREATED' | 'NOTIFICATION_GIFT_SHIPPING' | 'BILL_CREATION_FAILED' | 'AUTO_RESUMED' | 'ADMIN_LOGGEDIN_AS_CUSTOMER' | 'SUPER_USER_LOGGEDIN_AS_CUSTOMER' | 'ADMIN_ADDED_COMMENT' | 'SUCCESSFUL_REFERRAL' | 'CHANGE_EMAIL' | 'SEQUENTIAL_SWAP' | 'SEQUENTIAL_REMOVE_PRODUCT' | 'SEQUENTIAL_TERMINATE_CONTRACT' | 'SEQUENTIAL_RESTART_SEQUENCE' | 'AUTO_CANCELED' | 'PAYMENT_METHOD_UPDATED' | 'ADD_ON_INSTANT_DIGITAL_ORDER' required