openapi: 3.1.0 info: title: Commerce Layer addresses event_stores API version: 7.10.1 contact: name: API Support url: https://commercelayer.io email: support@commercelayer.io description: Headless Commerce for Global Brands. servers: - url: https://{your_organization_slug}.commercelayer.io/api description: API - url: https://core.commercelayer.io/users/sign_in description: Sign in - url: https://docs.commercelayer.io/api description: API reference security: - bearerAuth: [] tags: - name: event_stores description: resource type paths: /addresses/{addressId}/event_stores: get: operationId: GET/addressId/event_stores summary: Retrieve the event stores associated to the address description: Retrieve the event stores associated to the address tags: - event_stores parameters: - name: addressId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the address /adjustments/{adjustmentId}/event_stores: get: operationId: GET/adjustmentId/event_stores summary: Retrieve the event stores associated to the adjustment description: Retrieve the event stores associated to the adjustment tags: - event_stores parameters: - name: adjustmentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the adjustment /adyen_gateways/{adyenGatewayId}/event_stores: get: operationId: GET/adyenGatewayId/event_stores summary: Retrieve the event stores associated to the adyen gateway description: Retrieve the event stores associated to the adyen gateway tags: - event_stores parameters: - name: adyenGatewayId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the adyen gateway /adyen_payments/{adyenPaymentId}/event_stores: get: operationId: GET/adyenPaymentId/event_stores summary: Retrieve the event stores associated to the adyen payment description: Retrieve the event stores associated to the adyen payment tags: - event_stores parameters: - name: adyenPaymentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the adyen payment /attachments/{attachmentId}/event_stores: get: operationId: GET/attachmentId/event_stores summary: Retrieve the event stores associated to the attachment description: Retrieve the event stores associated to the attachment tags: - event_stores parameters: - name: attachmentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the attachment /authorizations/{authorizationId}/event_stores: get: operationId: GET/authorizationId/event_stores summary: Retrieve the event stores associated to the authorization description: Retrieve the event stores associated to the authorization tags: - event_stores parameters: - name: authorizationId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the authorization /avalara_accounts/{avalaraAccountId}/event_stores: get: operationId: GET/avalaraAccountId/event_stores summary: Retrieve the event stores associated to the avalara account description: Retrieve the event stores associated to the avalara account tags: - event_stores parameters: - name: avalaraAccountId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the avalara account /axerve_gateways/{axerveGatewayId}/event_stores: get: operationId: GET/axerveGatewayId/event_stores summary: Retrieve the event stores associated to the axerve gateway description: Retrieve the event stores associated to the axerve gateway tags: - event_stores parameters: - name: axerveGatewayId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the axerve gateway /axerve_payments/{axervePaymentId}/event_stores: get: operationId: GET/axervePaymentId/event_stores summary: Retrieve the event stores associated to the axerve payment description: Retrieve the event stores associated to the axerve payment tags: - event_stores parameters: - name: axervePaymentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the axerve payment /bing_geocoders/{bingGeocoderId}/event_stores: get: operationId: GET/bingGeocoderId/event_stores summary: Retrieve the event stores associated to the bing geocoder description: Retrieve the event stores associated to the bing geocoder tags: - event_stores parameters: - name: bingGeocoderId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the bing geocoder /braintree_gateways/{braintreeGatewayId}/event_stores: get: operationId: GET/braintreeGatewayId/event_stores summary: Retrieve the event stores associated to the braintree gateway description: Retrieve the event stores associated to the braintree gateway tags: - event_stores parameters: - name: braintreeGatewayId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the braintree gateway /braintree_payments/{braintreePaymentId}/event_stores: get: operationId: GET/braintreePaymentId/event_stores summary: Retrieve the event stores associated to the braintree payment description: Retrieve the event stores associated to the braintree payment tags: - event_stores parameters: - name: braintreePaymentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the braintree payment /bundles/{bundleId}/event_stores: get: operationId: GET/bundleId/event_stores summary: Retrieve the event stores associated to the bundle description: Retrieve the event stores associated to the bundle tags: - event_stores parameters: - name: bundleId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the bundle /buy_x_pay_y_promotions/{buyXPayYPromotionId}/event_stores: get: operationId: GET/buyXPayYPromotionId/event_stores summary: Retrieve the event stores associated to the buy x pay y promotion description: Retrieve the event stores associated to the buy x pay y promotion tags: - event_stores parameters: - name: buyXPayYPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the buy x pay y promotion /captures/{captureId}/event_stores: get: operationId: GET/captureId/event_stores summary: Retrieve the event stores associated to the capture description: Retrieve the event stores associated to the capture tags: - event_stores parameters: - name: captureId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the capture /carrier_accounts/{carrierAccountId}/event_stores: get: operationId: GET/carrierAccountId/event_stores summary: Retrieve the event stores associated to the carrier account description: Retrieve the event stores associated to the carrier account tags: - event_stores parameters: - name: carrierAccountId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the carrier account /checkout_com_gateways/{checkoutComGatewayId}/event_stores: get: operationId: GET/checkoutComGatewayId/event_stores summary: Retrieve the event stores associated to the checkout.com gateway description: Retrieve the event stores associated to the checkout.com gateway tags: - event_stores parameters: - name: checkoutComGatewayId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the checkout.com gateway /checkout_com_payments/{checkoutComPaymentId}/event_stores: get: operationId: GET/checkoutComPaymentId/event_stores summary: Retrieve the event stores associated to the checkout.com payment description: Retrieve the event stores associated to the checkout.com payment tags: - event_stores parameters: - name: checkoutComPaymentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the checkout.com payment /cleanups/{cleanupId}/event_stores: get: operationId: GET/cleanupId/event_stores summary: Retrieve the event stores associated to the cleanup description: Retrieve the event stores associated to the cleanup tags: - event_stores parameters: - name: cleanupId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the cleanup /coupon_codes_promotion_rules/{couponCodesPromotionRuleId}/event_stores: get: operationId: GET/couponCodesPromotionRuleId/event_stores summary: Retrieve the event stores associated to the coupon codes promotion rule description: Retrieve the event stores associated to the coupon codes promotion rule tags: - event_stores parameters: - name: couponCodesPromotionRuleId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the coupon codes promotion rule /coupon_recipients/{couponRecipientId}/event_stores: get: operationId: GET/couponRecipientId/event_stores summary: Retrieve the event stores associated to the coupon recipient description: Retrieve the event stores associated to the coupon recipient tags: - event_stores parameters: - name: couponRecipientId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the coupon recipient /coupons/{couponId}/event_stores: get: operationId: GET/couponId/event_stores summary: Retrieve the event stores associated to the coupon description: Retrieve the event stores associated to the coupon tags: - event_stores parameters: - name: couponId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the coupon /custom_promotion_rules/{customPromotionRuleId}/event_stores: get: operationId: GET/customPromotionRuleId/event_stores summary: Retrieve the event stores associated to the custom promotion rule description: Retrieve the event stores associated to the custom promotion rule tags: - event_stores parameters: - name: customPromotionRuleId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the custom promotion rule /customer_addresses/{customerAddressId}/event_stores: get: operationId: GET/customerAddressId/event_stores summary: Retrieve the event stores associated to the customer address description: Retrieve the event stores associated to the customer address tags: - event_stores parameters: - name: customerAddressId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the customer address /customer_groups/{customerGroupId}/event_stores: get: operationId: GET/customerGroupId/event_stores summary: Retrieve the event stores associated to the customer group description: Retrieve the event stores associated to the customer group tags: - event_stores parameters: - name: customerGroupId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the customer group /customer_password_resets/{customerPasswordResetId}/event_stores: get: operationId: GET/customerPasswordResetId/event_stores summary: Retrieve the event stores associated to the customer password reset description: Retrieve the event stores associated to the customer password reset tags: - event_stores parameters: - name: customerPasswordResetId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the customer password reset /customer_payment_sources/{customerPaymentSourceId}/event_stores: get: operationId: GET/customerPaymentSourceId/event_stores summary: Retrieve the event stores associated to the customer payment source description: Retrieve the event stores associated to the customer payment source tags: - event_stores parameters: - name: customerPaymentSourceId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the customer payment source /customer_subscriptions/{customerSubscriptionId}/event_stores: get: operationId: GET/customerSubscriptionId/event_stores summary: Retrieve the event stores associated to the customer subscription description: Retrieve the event stores associated to the customer subscription tags: - event_stores parameters: - name: customerSubscriptionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the customer subscription /customers/{customerId}/event_stores: get: operationId: GET/customerId/event_stores summary: Retrieve the event stores associated to the customer description: Retrieve the event stores associated to the customer tags: - event_stores parameters: - name: customerId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the customer /delivery_lead_times/{deliveryLeadTimeId}/event_stores: get: operationId: GET/deliveryLeadTimeId/event_stores summary: Retrieve the event stores associated to the delivery lead time description: Retrieve the event stores associated to the delivery lead time tags: - event_stores parameters: - name: deliveryLeadTimeId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the delivery lead time /discount_engine_items/{discountEngineItemId}/event_stores: get: operationId: GET/discountEngineItemId/event_stores summary: Retrieve the event stores associated to the discount engine item description: Retrieve the event stores associated to the discount engine item tags: - event_stores parameters: - name: discountEngineItemId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the discount engine item /discount_engines/{discountEngineId}/event_stores: get: operationId: GET/discountEngineId/event_stores summary: Retrieve the event stores associated to the discount engine description: Retrieve the event stores associated to the discount engine tags: - event_stores parameters: - name: discountEngineId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the discount engine /easypost_pickups/{easypostPickupId}/event_stores: get: operationId: GET/easypostPickupId/event_stores summary: Retrieve the event stores associated to the easypost pickup description: Retrieve the event stores associated to the easypost pickup tags: - event_stores parameters: - name: easypostPickupId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the easypost pickup /event_callbacks/{eventCallbackId}/event_stores: get: operationId: GET/eventCallbackId/event_stores summary: Retrieve the event stores associated to the event callback description: Retrieve the event stores associated to the event callback tags: - event_stores parameters: - name: eventCallbackId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the event callback /event_stores/{eventStoreId}: get: operationId: GET/event_stores/eventStoreId summary: Retrieve an event store description: Retrieve an event store tags: - event_stores parameters: - name: eventStoreId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event store object content: application/vnd.api+json: schema: $ref: '#/components/schemas/eventStoreResponse' /events/{eventId}/event_stores: get: operationId: GET/eventId/event_stores summary: Retrieve the event stores associated to the event description: Retrieve the event stores associated to the event tags: - event_stores parameters: - name: eventId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the event /exports/{exportId}/event_stores: get: operationId: GET/exportId/event_stores summary: Retrieve the event stores associated to the export description: Retrieve the event stores associated to the export tags: - event_stores parameters: - name: exportId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the export /external_gateways/{externalGatewayId}/event_stores: get: operationId: GET/externalGatewayId/event_stores summary: Retrieve the event stores associated to the external gateway description: Retrieve the event stores associated to the external gateway tags: - event_stores parameters: - name: externalGatewayId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the external gateway /external_payments/{externalPaymentId}/event_stores: get: operationId: GET/externalPaymentId/event_stores summary: Retrieve the event stores associated to the external payment description: Retrieve the event stores associated to the external payment tags: - event_stores parameters: - name: externalPaymentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the external payment /external_promotions/{externalPromotionId}/event_stores: get: operationId: GET/externalPromotionId/event_stores summary: Retrieve the event stores associated to the external promotion description: Retrieve the event stores associated to the external promotion tags: - event_stores parameters: - name: externalPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the external promotion /external_tax_calculators/{externalTaxCalculatorId}/event_stores: get: operationId: GET/externalTaxCalculatorId/event_stores summary: Retrieve the event stores associated to the external tax calculator description: Retrieve the event stores associated to the external tax calculator tags: - event_stores parameters: - name: externalTaxCalculatorId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the external tax calculator /fixed_amount_promotions/{fixedAmountPromotionId}/event_stores: get: operationId: GET/fixedAmountPromotionId/event_stores summary: Retrieve the event stores associated to the fixed amount promotion description: Retrieve the event stores associated to the fixed amount promotion tags: - event_stores parameters: - name: fixedAmountPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the fixed amount promotion /fixed_price_promotions/{fixedPricePromotionId}/event_stores: get: operationId: GET/fixedPricePromotionId/event_stores summary: Retrieve the event stores associated to the fixed price promotion description: Retrieve the event stores associated to the fixed price promotion tags: - event_stores parameters: - name: fixedPricePromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the fixed price promotion /flex_promotions/{flexPromotionId}/event_stores: get: operationId: GET/flexPromotionId/event_stores summary: Retrieve the event stores associated to the flex promotion description: Retrieve the event stores associated to the flex promotion tags: - event_stores parameters: - name: flexPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the flex promotion /free_gift_promotions/{freeGiftPromotionId}/event_stores: get: operationId: GET/freeGiftPromotionId/event_stores summary: Retrieve the event stores associated to the free gift promotion description: Retrieve the event stores associated to the free gift promotion tags: - event_stores parameters: - name: freeGiftPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the free gift promotion /free_shipping_promotions/{freeShippingPromotionId}/event_stores: get: operationId: GET/freeShippingPromotionId/event_stores summary: Retrieve the event stores associated to the free shipping promotion description: Retrieve the event stores associated to the free shipping promotion tags: - event_stores parameters: - name: freeShippingPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the free shipping promotion /geocoders/{geocoderId}/event_stores: get: operationId: GET/geocoderId/event_stores summary: Retrieve the event stores associated to the geocoder description: Retrieve the event stores associated to the geocoder tags: - event_stores parameters: - name: geocoderId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the geocoder /gift_card_recipients/{giftCardRecipientId}/event_stores: get: operationId: GET/giftCardRecipientId/event_stores summary: Retrieve the event stores associated to the gift card recipient description: Retrieve the event stores associated to the gift card recipient tags: - event_stores parameters: - name: giftCardRecipientId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the gift card recipient /gift_cards/{giftCardId}/event_stores: get: operationId: GET/giftCardId/event_stores summary: Retrieve the event stores associated to the gift card description: Retrieve the event stores associated to the gift card tags: - event_stores parameters: - name: giftCardId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the gift card /google_geocoders/{googleGeocoderId}/event_stores: get: operationId: GET/googleGeocoderId/event_stores summary: Retrieve the event stores associated to the google geocoder description: Retrieve the event stores associated to the google geocoder tags: - event_stores parameters: - name: googleGeocoderId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the google geocoder /imports/{importId}/event_stores: get: operationId: GET/importId/event_stores summary: Retrieve the event stores associated to the import description: Retrieve the event stores associated to the import tags: - event_stores parameters: - name: importId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the import /in_stock_subscriptions/{inStockSubscriptionId}/event_stores: get: operationId: GET/inStockSubscriptionId/event_stores summary: Retrieve the event stores associated to the in stock subscription description: Retrieve the event stores associated to the in stock subscription tags: - event_stores parameters: - name: inStockSubscriptionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the in stock subscription /inventory_models/{inventoryModelId}/event_stores: get: operationId: GET/inventoryModelId/event_stores summary: Retrieve the event stores associated to the inventory model description: Retrieve the event stores associated to the inventory model tags: - event_stores parameters: - name: inventoryModelId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the inventory model /inventory_return_locations/{inventoryReturnLocationId}/event_stores: get: operationId: GET/inventoryReturnLocationId/event_stores summary: Retrieve the event stores associated to the inventory return location description: Retrieve the event stores associated to the inventory return location tags: - event_stores parameters: - name: inventoryReturnLocationId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the inventory return location /inventory_stock_locations/{inventoryStockLocationId}/event_stores: get: operationId: GET/inventoryStockLocationId/event_stores summary: Retrieve the event stores associated to the inventory stock location description: Retrieve the event stores associated to the inventory stock location tags: - event_stores parameters: - name: inventoryStockLocationId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the inventory stock location /klarna_gateways/{klarnaGatewayId}/event_stores: get: operationId: GET/klarnaGatewayId/event_stores summary: Retrieve the event stores associated to the klarna gateway description: Retrieve the event stores associated to the klarna gateway tags: - event_stores parameters: - name: klarnaGatewayId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the klarna gateway /klarna_payments/{klarnaPaymentId}/event_stores: get: operationId: GET/klarnaPaymentId/event_stores summary: Retrieve the event stores associated to the klarna payment description: Retrieve the event stores associated to the klarna payment tags: - event_stores parameters: - name: klarnaPaymentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the klarna payment /line_item_options/{lineItemOptionId}/event_stores: get: operationId: GET/lineItemOptionId/event_stores summary: Retrieve the event stores associated to the line item option description: Retrieve the event stores associated to the line item option tags: - event_stores parameters: - name: lineItemOptionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the line item option /line_items/{lineItemId}/event_stores: get: operationId: GET/lineItemId/event_stores summary: Retrieve the event stores associated to the line item description: Retrieve the event stores associated to the line item tags: - event_stores parameters: - name: lineItemId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the line item /links/{linkId}/event_stores: get: operationId: GET/linkId/event_stores summary: Retrieve the event stores associated to the link description: Retrieve the event stores associated to the link tags: - event_stores parameters: - name: linkId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the link /manual_gateways/{manualGatewayId}/event_stores: get: operationId: GET/manualGatewayId/event_stores summary: Retrieve the event stores associated to the manual gateway description: Retrieve the event stores associated to the manual gateway tags: - event_stores parameters: - name: manualGatewayId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the manual gateway /manual_tax_calculators/{manualTaxCalculatorId}/event_stores: get: operationId: GET/manualTaxCalculatorId/event_stores summary: Retrieve the event stores associated to the manual tax calculator description: Retrieve the event stores associated to the manual tax calculator tags: - event_stores parameters: - name: manualTaxCalculatorId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the manual tax calculator /markets/{marketId}/event_stores: get: operationId: GET/marketId/event_stores summary: Retrieve the event stores associated to the market description: Retrieve the event stores associated to the market tags: - event_stores parameters: - name: marketId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the market /merchants/{merchantId}/event_stores: get: operationId: GET/merchantId/event_stores summary: Retrieve the event stores associated to the merchant description: Retrieve the event stores associated to the merchant tags: - event_stores parameters: - name: merchantId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the merchant /notifications/{notificationId}/event_stores: get: operationId: GET/notificationId/event_stores summary: Retrieve the event stores associated to the notification description: Retrieve the event stores associated to the notification tags: - event_stores parameters: - name: notificationId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the notification /order_amount_promotion_rules/{orderAmountPromotionRuleId}/event_stores: get: operationId: GET/orderAmountPromotionRuleId/event_stores summary: Retrieve the event stores associated to the order amount promotion rule description: Retrieve the event stores associated to the order amount promotion rule tags: - event_stores parameters: - name: orderAmountPromotionRuleId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the order amount promotion rule /order_copies/{orderCopyId}/event_stores: get: operationId: GET/orderCopyId/event_stores summary: Retrieve the event stores associated to the order copy description: Retrieve the event stores associated to the order copy tags: - event_stores parameters: - name: orderCopyId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the order copy /order_factories/{orderFactoryId}/event_stores: get: operationId: GET/orderFactoryId/event_stores summary: Retrieve the event stores associated to the order factory description: Retrieve the event stores associated to the order factory tags: - event_stores parameters: - name: orderFactoryId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the order factory /order_subscription_items/{orderSubscriptionItemId}/event_stores: get: operationId: GET/orderSubscriptionItemId/event_stores summary: Retrieve the event stores associated to the order subscription item description: Retrieve the event stores associated to the order subscription item tags: - event_stores parameters: - name: orderSubscriptionItemId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the order subscription item /order_subscriptions/{orderSubscriptionId}/event_stores: get: operationId: GET/orderSubscriptionId/event_stores summary: Retrieve the event stores associated to the order subscription description: Retrieve the event stores associated to the order subscription tags: - event_stores parameters: - name: orderSubscriptionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the order subscription /orders/{orderId}/event_stores: get: operationId: GET/orderId/event_stores summary: Retrieve the event stores associated to the order description: Retrieve the event stores associated to the order tags: - event_stores parameters: - name: orderId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the order /organization/{organizationId}/event_stores: get: operationId: GET/organizationId/event_stores summary: Retrieve the event stores associated to the organization description: Retrieve the event stores associated to the organization tags: - event_stores parameters: - name: organizationId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the organization /packages/{packageId}/event_stores: get: operationId: GET/packageId/event_stores summary: Retrieve the event stores associated to the package description: Retrieve the event stores associated to the package tags: - event_stores parameters: - name: packageId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the package /parcel_line_items/{parcelLineItemId}/event_stores: get: operationId: GET/parcelLineItemId/event_stores summary: Retrieve the event stores associated to the parcel line item description: Retrieve the event stores associated to the parcel line item tags: - event_stores parameters: - name: parcelLineItemId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the parcel line item /parcels/{parcelId}/event_stores: get: operationId: GET/parcelId/event_stores summary: Retrieve the event stores associated to the parcel description: Retrieve the event stores associated to the parcel tags: - event_stores parameters: - name: parcelId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the parcel /payment_gateways/{paymentGatewayId}/event_stores: get: operationId: GET/paymentGatewayId/event_stores summary: Retrieve the event stores associated to the payment gateway description: Retrieve the event stores associated to the payment gateway tags: - event_stores parameters: - name: paymentGatewayId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the payment gateway /payment_methods/{paymentMethodId}/event_stores: get: operationId: GET/paymentMethodId/event_stores summary: Retrieve the event stores associated to the payment method description: Retrieve the event stores associated to the payment method tags: - event_stores parameters: - name: paymentMethodId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the payment method /payment_options/{paymentOptionId}/event_stores: get: operationId: GET/paymentOptionId/event_stores summary: Retrieve the event stores associated to the payment option description: Retrieve the event stores associated to the payment option tags: - event_stores parameters: - name: paymentOptionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the payment option /paypal_gateways/{paypalGatewayId}/event_stores: get: operationId: GET/paypalGatewayId/event_stores summary: Retrieve the event stores associated to the paypal gateway description: Retrieve the event stores associated to the paypal gateway tags: - event_stores parameters: - name: paypalGatewayId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the paypal gateway /paypal_payments/{paypalPaymentId}/event_stores: get: operationId: GET/paypalPaymentId/event_stores summary: Retrieve the event stores associated to the paypal payment description: Retrieve the event stores associated to the paypal payment tags: - event_stores parameters: - name: paypalPaymentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the paypal payment /percentage_discount_promotions/{percentageDiscountPromotionId}/event_stores: get: operationId: GET/percentageDiscountPromotionId/event_stores summary: Retrieve the event stores associated to the percentage discount promotion description: Retrieve the event stores associated to the percentage discount promotion tags: - event_stores parameters: - name: percentageDiscountPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the percentage discount promotion /pickups/{pickupId}/event_stores: get: operationId: GET/pickupId/event_stores summary: Retrieve the event stores associated to the pickup description: Retrieve the event stores associated to the pickup tags: - event_stores parameters: - name: pickupId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the pickup /price_frequency_tiers/{priceFrequencyTierId}/event_stores: get: operationId: GET/priceFrequencyTierId/event_stores summary: Retrieve the event stores associated to the price frequency tier description: Retrieve the event stores associated to the price frequency tier tags: - event_stores parameters: - name: priceFrequencyTierId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the price frequency tier /price_list_schedulers/{priceListSchedulerId}/event_stores: get: operationId: GET/priceListSchedulerId/event_stores summary: Retrieve the event stores associated to the price list scheduler description: Retrieve the event stores associated to the price list scheduler tags: - event_stores parameters: - name: priceListSchedulerId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the price list scheduler /price_lists/{priceListId}/event_stores: get: operationId: GET/priceListId/event_stores summary: Retrieve the event stores associated to the price list description: Retrieve the event stores associated to the price list tags: - event_stores parameters: - name: priceListId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the price list /price_tiers/{priceTierId}/event_stores: get: operationId: GET/priceTierId/event_stores summary: Retrieve the event stores associated to the price tier description: Retrieve the event stores associated to the price tier tags: - event_stores parameters: - name: priceTierId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the price tier /price_volume_tiers/{priceVolumeTierId}/event_stores: get: operationId: GET/priceVolumeTierId/event_stores summary: Retrieve the event stores associated to the price volume tier description: Retrieve the event stores associated to the price volume tier tags: - event_stores parameters: - name: priceVolumeTierId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the price volume tier /prices/{priceId}/event_stores: get: operationId: GET/priceId/event_stores summary: Retrieve the event stores associated to the price description: Retrieve the event stores associated to the price tags: - event_stores parameters: - name: priceId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the price /promotion_rules/{promotionRuleId}/event_stores: get: operationId: GET/promotionRuleId/event_stores summary: Retrieve the event stores associated to the promotion rule description: Retrieve the event stores associated to the promotion rule tags: - event_stores parameters: - name: promotionRuleId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the promotion rule /promotions/{promotionId}/event_stores: get: operationId: GET/promotionId/event_stores summary: Retrieve the event stores associated to the promotion description: Retrieve the event stores associated to the promotion tags: - event_stores parameters: - name: promotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the promotion /recurring_order_copies/{recurringOrderCopyId}/event_stores: get: operationId: GET/recurringOrderCopyId/event_stores summary: Retrieve the event stores associated to the recurring order copy description: Retrieve the event stores associated to the recurring order copy tags: - event_stores parameters: - name: recurringOrderCopyId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the recurring order copy /refunds/{refundId}/event_stores: get: operationId: GET/refundId/event_stores summary: Retrieve the event stores associated to the refund description: Retrieve the event stores associated to the refund tags: - event_stores parameters: - name: refundId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the refund /reserved_stocks/{reservedStockId}/event_stores: get: operationId: GET/reservedStockId/event_stores summary: Retrieve the event stores associated to the reserved stock description: Retrieve the event stores associated to the reserved stock tags: - event_stores parameters: - name: reservedStockId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the reserved stock /resource_errors/{resourceErrorId}/event_stores: get: operationId: GET/resourceErrorId/event_stores summary: Retrieve the event stores associated to the resource error description: Retrieve the event stores associated to the resource error tags: - event_stores parameters: - name: resourceErrorId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the resource error /return_line_items/{returnLineItemId}/event_stores: get: operationId: GET/returnLineItemId/event_stores summary: Retrieve the event stores associated to the return line item description: Retrieve the event stores associated to the return line item tags: - event_stores parameters: - name: returnLineItemId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the return line item /returns/{returnId}/event_stores: get: operationId: GET/returnId/event_stores summary: Retrieve the event stores associated to the return description: Retrieve the event stores associated to the return tags: - event_stores parameters: - name: returnId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the return /satispay_gateways/{satispayGatewayId}/event_stores: get: operationId: GET/satispayGatewayId/event_stores summary: Retrieve the event stores associated to the satispay gateway description: Retrieve the event stores associated to the satispay gateway tags: - event_stores parameters: - name: satispayGatewayId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the satispay gateway /satispay_payments/{satispayPaymentId}/event_stores: get: operationId: GET/satispayPaymentId/event_stores summary: Retrieve the event stores associated to the satispay payment description: Retrieve the event stores associated to the satispay payment tags: - event_stores parameters: - name: satispayPaymentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the satispay payment /shipments/{shipmentId}/event_stores: get: operationId: GET/shipmentId/event_stores summary: Retrieve the event stores associated to the shipment description: Retrieve the event stores associated to the shipment tags: - event_stores parameters: - name: shipmentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the shipment /shipping_categories/{shippingCategoryId}/event_stores: get: operationId: GET/shippingCategoryId/event_stores summary: Retrieve the event stores associated to the shipping category description: Retrieve the event stores associated to the shipping category tags: - event_stores parameters: - name: shippingCategoryId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the shipping category /shipping_method_tiers/{shippingMethodTierId}/event_stores: get: operationId: GET/shippingMethodTierId/event_stores summary: Retrieve the event stores associated to the shipping method tier description: Retrieve the event stores associated to the shipping method tier tags: - event_stores parameters: - name: shippingMethodTierId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the shipping method tier /shipping_methods/{shippingMethodId}/event_stores: get: operationId: GET/shippingMethodId/event_stores summary: Retrieve the event stores associated to the shipping method description: Retrieve the event stores associated to the shipping method tags: - event_stores parameters: - name: shippingMethodId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the shipping method /shipping_weight_tiers/{shippingWeightTierId}/event_stores: get: operationId: GET/shippingWeightTierId/event_stores summary: Retrieve the event stores associated to the shipping weight tier description: Retrieve the event stores associated to the shipping weight tier tags: - event_stores parameters: - name: shippingWeightTierId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the shipping weight tier /shipping_zones/{shippingZoneId}/event_stores: get: operationId: GET/shippingZoneId/event_stores summary: Retrieve the event stores associated to the shipping zone description: Retrieve the event stores associated to the shipping zone tags: - event_stores parameters: - name: shippingZoneId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the shipping zone /sku_list_items/{skuListItemId}/event_stores: get: operationId: GET/skuListItemId/event_stores summary: Retrieve the event stores associated to the SKU list item description: Retrieve the event stores associated to the SKU list item tags: - event_stores parameters: - name: skuListItemId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the SKU list item /sku_list_promotion_rules/{skuListPromotionRuleId}/event_stores: get: operationId: GET/skuListPromotionRuleId/event_stores summary: Retrieve the event stores associated to the SKU list promotion rule description: Retrieve the event stores associated to the SKU list promotion rule tags: - event_stores parameters: - name: skuListPromotionRuleId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the SKU list promotion rule /sku_lists/{skuListId}/event_stores: get: operationId: GET/skuListId/event_stores summary: Retrieve the event stores associated to the SKU list description: Retrieve the event stores associated to the SKU list tags: - event_stores parameters: - name: skuListId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the SKU list /sku_options/{skuOptionId}/event_stores: get: operationId: GET/skuOptionId/event_stores summary: Retrieve the event stores associated to the SKU option description: Retrieve the event stores associated to the SKU option tags: - event_stores parameters: - name: skuOptionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the SKU option /skus/{skuId}/event_stores: get: operationId: GET/skuId/event_stores summary: Retrieve the event stores associated to the SKU description: Retrieve the event stores associated to the SKU tags: - event_stores parameters: - name: skuId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the SKU /stock_items/{stockItemId}/event_stores: get: operationId: GET/stockItemId/event_stores summary: Retrieve the event stores associated to the stock item description: Retrieve the event stores associated to the stock item tags: - event_stores parameters: - name: stockItemId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the stock item /stock_line_items/{stockLineItemId}/event_stores: get: operationId: GET/stockLineItemId/event_stores summary: Retrieve the event stores associated to the stock line item description: Retrieve the event stores associated to the stock line item tags: - event_stores parameters: - name: stockLineItemId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the stock line item /stock_locations/{stockLocationId}/event_stores: get: operationId: GET/stockLocationId/event_stores summary: Retrieve the event stores associated to the stock location description: Retrieve the event stores associated to the stock location tags: - event_stores parameters: - name: stockLocationId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the stock location /stock_reservations/{stockReservationId}/event_stores: get: operationId: GET/stockReservationId/event_stores summary: Retrieve the event stores associated to the stock reservation description: Retrieve the event stores associated to the stock reservation tags: - event_stores parameters: - name: stockReservationId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the stock reservation /stock_transfers/{stockTransferId}/event_stores: get: operationId: GET/stockTransferId/event_stores summary: Retrieve the event stores associated to the stock transfer description: Retrieve the event stores associated to the stock transfer tags: - event_stores parameters: - name: stockTransferId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the stock transfer /stores/{storeId}/event_stores: get: operationId: GET/storeId/event_stores summary: Retrieve the event stores associated to the store description: Retrieve the event stores associated to the store tags: - event_stores parameters: - name: storeId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the store /stripe_gateways/{stripeGatewayId}/event_stores: get: operationId: GET/stripeGatewayId/event_stores summary: Retrieve the event stores associated to the stripe gateway description: Retrieve the event stores associated to the stripe gateway tags: - event_stores parameters: - name: stripeGatewayId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the stripe gateway /stripe_payments/{stripePaymentId}/event_stores: get: operationId: GET/stripePaymentId/event_stores summary: Retrieve the event stores associated to the stripe payment description: Retrieve the event stores associated to the stripe payment tags: - event_stores parameters: - name: stripePaymentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the stripe payment /stripe_tax_accounts/{stripeTaxAccountId}/event_stores: get: operationId: GET/stripeTaxAccountId/event_stores summary: Retrieve the event stores associated to the stripe tax account description: Retrieve the event stores associated to the stripe tax account tags: - event_stores parameters: - name: stripeTaxAccountId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the stripe tax account /subscription_models/{subscriptionModelId}/event_stores: get: operationId: GET/subscriptionModelId/event_stores summary: Retrieve the event stores associated to the subscription model description: Retrieve the event stores associated to the subscription model tags: - event_stores parameters: - name: subscriptionModelId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the subscription model /tags/{tagId}/event_stores: get: operationId: GET/tagId/event_stores summary: Retrieve the event stores associated to the tag description: Retrieve the event stores associated to the tag tags: - event_stores parameters: - name: tagId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the tag /talon_one_accounts/{talonOneAccountId}/event_stores: get: operationId: GET/talonOneAccountId/event_stores summary: Retrieve the event stores associated to the talon one account description: Retrieve the event stores associated to the talon one account tags: - event_stores parameters: - name: talonOneAccountId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the talon one account /tax_calculators/{taxCalculatorId}/event_stores: get: operationId: GET/taxCalculatorId/event_stores summary: Retrieve the event stores associated to the tax calculator description: Retrieve the event stores associated to the tax calculator tags: - event_stores parameters: - name: taxCalculatorId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the tax calculator /tax_categories/{taxCategoryId}/event_stores: get: operationId: GET/taxCategoryId/event_stores summary: Retrieve the event stores associated to the tax category description: Retrieve the event stores associated to the tax category tags: - event_stores parameters: - name: taxCategoryId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the tax category /tax_rules/{taxRuleId}/event_stores: get: operationId: GET/taxRuleId/event_stores summary: Retrieve the event stores associated to the tax rule description: Retrieve the event stores associated to the tax rule tags: - event_stores parameters: - name: taxRuleId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the tax rule /taxjar_accounts/{taxjarAccountId}/event_stores: get: operationId: GET/taxjarAccountId/event_stores summary: Retrieve the event stores associated to the taxjar account description: Retrieve the event stores associated to the taxjar account tags: - event_stores parameters: - name: taxjarAccountId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the taxjar account /transactions/{transactionId}/event_stores: get: operationId: GET/transactionId/event_stores summary: Retrieve the event stores associated to the transaction description: Retrieve the event stores associated to the transaction tags: - event_stores parameters: - name: transactionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the transaction /vertex_accounts/{vertexAccountId}/event_stores: get: operationId: GET/vertexAccountId/event_stores summary: Retrieve the event stores associated to the vertex account description: Retrieve the event stores associated to the vertex account tags: - event_stores parameters: - name: vertexAccountId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the vertex account /voids/{voidId}/event_stores: get: operationId: GET/voidId/event_stores summary: Retrieve the event stores associated to the void description: Retrieve the event stores associated to the void tags: - event_stores parameters: - name: voidId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the void /webhooks/{webhookId}/event_stores: get: operationId: GET/webhookId/event_stores summary: Retrieve the event stores associated to the webhook description: Retrieve the event stores associated to the webhook tags: - event_stores parameters: - name: webhookId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the webhook /wire_transfers/{wireTransferId}/event_stores: get: operationId: GET/wireTransferId/event_stores summary: Retrieve the event stores associated to the wire transfer description: Retrieve the event stores associated to the wire transfer tags: - event_stores parameters: - name: wireTransferId in: path schema: type: string required: true description: The resource's id responses: '200': description: The event_stores associated to the wire transfer components: schemas: eventStoreResponse: type: object properties: data: type: object properties: id: type: string description: The event identifier. example: 1755185525941-0 type: type: string description: The resource's type enum: - event_stores links: type: object properties: self: type: string description: URL attributes: $ref: '#/components/schemas/eventStore/properties/data/properties/attributes' relationships: type: object properties: {} eventStore: properties: data: properties: attributes: type: object properties: resource_type: type: string description: The type of the affected resource. example: orders nullable: true resource_id: type: string description: The ID of the affected resource. example: PzdJhdLdYV nullable: true event: type: string description: The type of change (one of create or update). example: update nullable: true payload: type: object description: The object changes payload. example: status: - draft - placed nullable: true who: type: object description: Information about who triggered the change. example: application: id: DNOPYiZYpn kind: sales_channel public: true owner: id: yQQrBhLBmQ type: Customer nullable: true created_at: type: string description: Time at which the resource was created. example: '2018-01-01T12:00:00.000Z' nullable: false updated_at: type: string description: Time at which the resource was last updated. example: '2018-01-01T12:00:00.000Z' nullable: false reference: type: string description: A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. example: ANY-EXTERNAL-REFEFERNCE nullable: true reference_origin: type: string description: Any identifier of the third party system that defines the reference code. example: ANY-EXTERNAL-REFEFERNCE-ORIGIN nullable: true metadata: type: object description: Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. example: foo: bar nullable: true securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT