Commerce Layer events API

openapi: 3.1.0
info:
  title: Commerce Layer addresses events 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: events
  description: resource type
paths:
  /addresses/{addressId}/events:
    get:
      operationId: GET/addressId/events
      summary: Retrieve the events associated to the address
      description: Retrieve the events associated to the address
      tags:
      - events
      parameters:
      - name: addressId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the address
  /authorizations/{authorizationId}/events:
    get:
      operationId: GET/authorizationId/events
      summary: Retrieve the events associated to the authorization
      description: Retrieve the events associated to the authorization
      tags:
      - events
      parameters:
      - name: authorizationId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the authorization
  /avalara_accounts/{avalaraAccountId}/events:
    get:
      operationId: GET/avalaraAccountId/events
      summary: Retrieve the events associated to the avalara account
      description: Retrieve the events associated to the avalara account
      tags:
      - events
      parameters:
      - name: avalaraAccountId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the avalara account
  /bundles/{bundleId}/events:
    get:
      operationId: GET/bundleId/events
      summary: Retrieve the events associated to the bundle
      description: Retrieve the events associated to the bundle
      tags:
      - events
      parameters:
      - name: bundleId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the bundle
  /buy_x_pay_y_promotions/{buyXPayYPromotionId}/events:
    get:
      operationId: GET/buyXPayYPromotionId/events
      summary: Retrieve the events associated to the buy x pay y promotion
      description: Retrieve the events associated to the buy x pay y promotion
      tags:
      - events
      parameters:
      - name: buyXPayYPromotionId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the buy x pay y promotion
  /captures/{captureId}/events:
    get:
      operationId: GET/captureId/events
      summary: Retrieve the events associated to the capture
      description: Retrieve the events associated to the capture
      tags:
      - events
      parameters:
      - name: captureId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the capture
  /cleanups/{cleanupId}/events:
    get:
      operationId: GET/cleanupId/events
      summary: Retrieve the events associated to the cleanup
      description: Retrieve the events associated to the cleanup
      tags:
      - events
      parameters:
      - name: cleanupId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the cleanup
  /coupons/{couponId}/events:
    get:
      operationId: GET/couponId/events
      summary: Retrieve the events associated to the coupon
      description: Retrieve the events associated to the coupon
      tags:
      - events
      parameters:
      - name: couponId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the coupon
  /customer_addresses/{customerAddressId}/events:
    get:
      operationId: GET/customerAddressId/events
      summary: Retrieve the events associated to the customer address
      description: Retrieve the events associated to the customer address
      tags:
      - events
      parameters:
      - name: customerAddressId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the customer address
  /customer_password_resets/{customerPasswordResetId}/events:
    get:
      operationId: GET/customerPasswordResetId/events
      summary: Retrieve the events associated to the customer password reset
      description: Retrieve the events associated to the customer password reset
      tags:
      - events
      parameters:
      - name: customerPasswordResetId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the customer password reset
  /customer_subscriptions/{customerSubscriptionId}/events:
    get:
      operationId: GET/customerSubscriptionId/events
      summary: Retrieve the events associated to the customer subscription
      description: Retrieve the events associated to the customer subscription
      tags:
      - events
      parameters:
      - name: customerSubscriptionId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the customer subscription
  /customers/{customerId}/events:
    get:
      operationId: GET/customerId/events
      summary: Retrieve the events associated to the customer
      description: Retrieve the events associated to the customer
      tags:
      - events
      parameters:
      - name: customerId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the customer
  /easypost_pickups/{easypostPickupId}/events:
    get:
      operationId: GET/easypostPickupId/events
      summary: Retrieve the events associated to the easypost pickup
      description: Retrieve the events associated to the easypost pickup
      tags:
      - events
      parameters:
      - name: easypostPickupId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the easypost pickup
  /events:
    get:
      operationId: GET/events
      summary: List all events
      description: List all events
      tags:
      - events
      responses:
        '200':
          description: A list of event objects
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/eventResponseList'
  /events/{eventId}:
    get:
      operationId: GET/events/eventId
      summary: Retrieve an event
      description: Retrieve an event
      tags:
      - events
      parameters:
      - name: eventId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The event object
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/eventResponse'
    patch:
      operationId: PATCH/events/eventId
      summary: Update an event
      description: Update an event
      tags:
      - events
      parameters:
      - name: eventId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/eventUpdate'
      responses:
        '200':
          description: The updated event object
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/eventResponse'
  /exports/{exportId}/events:
    get:
      operationId: GET/exportId/events
      summary: Retrieve the events associated to the export
      description: Retrieve the events associated to the export
      tags:
      - events
      parameters:
      - name: exportId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the export
  /external_promotions/{externalPromotionId}/events:
    get:
      operationId: GET/externalPromotionId/events
      summary: Retrieve the events associated to the external promotion
      description: Retrieve the events associated to the external promotion
      tags:
      - events
      parameters:
      - name: externalPromotionId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the external promotion
  /external_tax_calculators/{externalTaxCalculatorId}/events:
    get:
      operationId: GET/externalTaxCalculatorId/events
      summary: Retrieve the events associated to the external tax calculator
      description: Retrieve the events associated to the external tax calculator
      tags:
      - events
      parameters:
      - name: externalTaxCalculatorId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the external tax calculator
  /fixed_amount_promotions/{fixedAmountPromotionId}/events:
    get:
      operationId: GET/fixedAmountPromotionId/events
      summary: Retrieve the events associated to the fixed amount promotion
      description: Retrieve the events associated to the fixed amount promotion
      tags:
      - events
      parameters:
      - name: fixedAmountPromotionId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the fixed amount promotion
  /fixed_price_promotions/{fixedPricePromotionId}/events:
    get:
      operationId: GET/fixedPricePromotionId/events
      summary: Retrieve the events associated to the fixed price promotion
      description: Retrieve the events associated to the fixed price promotion
      tags:
      - events
      parameters:
      - name: fixedPricePromotionId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the fixed price promotion
  /flex_promotions/{flexPromotionId}/events:
    get:
      operationId: GET/flexPromotionId/events
      summary: Retrieve the events associated to the flex promotion
      description: Retrieve the events associated to the flex promotion
      tags:
      - events
      parameters:
      - name: flexPromotionId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the flex promotion
  /free_gift_promotions/{freeGiftPromotionId}/events:
    get:
      operationId: GET/freeGiftPromotionId/events
      summary: Retrieve the events associated to the free gift promotion
      description: Retrieve the events associated to the free gift promotion
      tags:
      - events
      parameters:
      - name: freeGiftPromotionId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the free gift promotion
  /free_shipping_promotions/{freeShippingPromotionId}/events:
    get:
      operationId: GET/freeShippingPromotionId/events
      summary: Retrieve the events associated to the free shipping promotion
      description: Retrieve the events associated to the free shipping promotion
      tags:
      - events
      parameters:
      - name: freeShippingPromotionId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the free shipping promotion
  /gift_cards/{giftCardId}/events:
    get:
      operationId: GET/giftCardId/events
      summary: Retrieve the events associated to the gift card
      description: Retrieve the events associated to the gift card
      tags:
      - events
      parameters:
      - name: giftCardId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the gift card
  /imports/{importId}/events:
    get:
      operationId: GET/importId/events
      summary: Retrieve the events associated to the import
      description: Retrieve the events associated to the import
      tags:
      - events
      parameters:
      - name: importId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the import
  /in_stock_subscriptions/{inStockSubscriptionId}/events:
    get:
      operationId: GET/inStockSubscriptionId/events
      summary: Retrieve the events associated to the in stock subscription
      description: Retrieve the events associated to the in stock subscription
      tags:
      - events
      parameters:
      - name: inStockSubscriptionId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the in stock subscription
  /line_item_options/{lineItemOptionId}/events:
    get:
      operationId: GET/lineItemOptionId/events
      summary: Retrieve the events associated to the line item option
      description: Retrieve the events associated to the line item option
      tags:
      - events
      parameters:
      - name: lineItemOptionId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the line item option
  /line_items/{lineItemId}/events:
    get:
      operationId: GET/lineItemId/events
      summary: Retrieve the events associated to the line item
      description: Retrieve the events associated to the line item
      tags:
      - events
      parameters:
      - name: lineItemId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the line item
  /links/{linkId}/events:
    get:
      operationId: GET/linkId/events
      summary: Retrieve the events associated to the link
      description: Retrieve the events associated to the link
      tags:
      - events
      parameters:
      - name: linkId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the link
  /manual_tax_calculators/{manualTaxCalculatorId}/events:
    get:
      operationId: GET/manualTaxCalculatorId/events
      summary: Retrieve the events associated to the manual tax calculator
      description: Retrieve the events associated to the manual tax calculator
      tags:
      - events
      parameters:
      - name: manualTaxCalculatorId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the manual tax calculator
  /order_copies/{orderCopyId}/events:
    get:
      operationId: GET/orderCopyId/events
      summary: Retrieve the events associated to the order copy
      description: Retrieve the events associated to the order copy
      tags:
      - events
      parameters:
      - name: orderCopyId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the order copy
  /order_factories/{orderFactoryId}/events:
    get:
      operationId: GET/orderFactoryId/events
      summary: Retrieve the events associated to the order factory
      description: Retrieve the events associated to the order factory
      tags:
      - events
      parameters:
      - name: orderFactoryId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the order factory
  /order_subscriptions/{orderSubscriptionId}/events:
    get:
      operationId: GET/orderSubscriptionId/events
      summary: Retrieve the events associated to the order subscription
      description: Retrieve the events associated to the order subscription
      tags:
      - events
      parameters:
      - name: orderSubscriptionId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the order subscription
  /orders/{orderId}/events:
    get:
      operationId: GET/orderId/events
      summary: Retrieve the events associated to the order
      description: Retrieve the events associated to the order
      tags:
      - events
      parameters:
      - name: orderId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the order
  /parcels/{parcelId}/events:
    get:
      operationId: GET/parcelId/events
      summary: Retrieve the events associated to the parcel
      description: Retrieve the events associated to the parcel
      tags:
      - events
      parameters:
      - name: parcelId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the parcel
  /percentage_discount_promotions/{percentageDiscountPromotionId}/events:
    get:
      operationId: GET/percentageDiscountPromotionId/events
      summary: Retrieve the events associated to the percentage discount promotion
      description: Retrieve the events associated to the percentage discount promotion
      tags:
      - events
      parameters:
      - name: percentageDiscountPromotionId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the percentage discount promotion
  /pickups/{pickupId}/events:
    get:
      operationId: GET/pickupId/events
      summary: Retrieve the events associated to the pickup
      description: Retrieve the events associated to the pickup
      tags:
      - events
      parameters:
      - name: pickupId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the pickup
  /price_frequency_tiers/{priceFrequencyTierId}/events:
    get:
      operationId: GET/priceFrequencyTierId/events
      summary: Retrieve the events associated to the price frequency tier
      description: Retrieve the events associated to the price frequency tier
      tags:
      - events
      parameters:
      - name: priceFrequencyTierId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the price frequency tier
  /price_list_schedulers/{priceListSchedulerId}/events:
    get:
      operationId: GET/priceListSchedulerId/events
      summary: Retrieve the events associated to the price list scheduler
      description: Retrieve the events associated to the price list scheduler
      tags:
      - events
      parameters:
      - name: priceListSchedulerId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the price list scheduler
  /price_volume_tiers/{priceVolumeTierId}/events:
    get:
      operationId: GET/priceVolumeTierId/events
      summary: Retrieve the events associated to the price volume tier
      description: Retrieve the events associated to the price volume tier
      tags:
      - events
      parameters:
      - name: priceVolumeTierId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the price volume tier
  /promotions/{promotionId}/events:
    get:
      operationId: GET/promotionId/events
      summary: Retrieve the events associated to the promotion
      description: Retrieve the events associated to the promotion
      tags:
      - events
      parameters:
      - name: promotionId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the promotion
  /recurring_order_copies/{recurringOrderCopyId}/events:
    get:
      operationId: GET/recurringOrderCopyId/events
      summary: Retrieve the events associated to the recurring order copy
      description: Retrieve the events associated to the recurring order copy
      tags:
      - events
      parameters:
      - name: recurringOrderCopyId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the recurring order copy
  /refunds/{refundId}/events:
    get:
      operationId: GET/refundId/events
      summary: Retrieve the events associated to the refund
      description: Retrieve the events associated to the refund
      tags:
      - events
      parameters:
      - name: refundId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the refund
  /returns/{returnId}/events:
    get:
      operationId: GET/returnId/events
      summary: Retrieve the events associated to the return
      description: Retrieve the events associated to the return
      tags:
      - events
      parameters:
      - name: returnId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the return
  /shipments/{shipmentId}/events:
    get:
      operationId: GET/shipmentId/events
      summary: Retrieve the events associated to the shipment
      description: Retrieve the events associated to the shipment
      tags:
      - events
      parameters:
      - name: shipmentId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the shipment
  /shipping_methods/{shippingMethodId}/events:
    get:
      operationId: GET/shippingMethodId/events
      summary: Retrieve the events associated to the shipping method
      description: Retrieve the events associated to the shipping method
      tags:
      - events
      parameters:
      - name: shippingMethodId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the shipping method
  /shipping_weight_tiers/{shippingWeightTierId}/events:
    get:
      operationId: GET/shippingWeightTierId/events
      summary: Retrieve the events associated to the shipping weight tier
      description: Retrieve the events associated to the shipping weight tier
      tags:
      - events
      parameters:
      - name: shippingWeightTierId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the shipping weight tier
  /sku_options/{skuOptionId}/events:
    get:
      operationId: GET/skuOptionId/events
      summary: Retrieve the events associated to the SKU option
      description: Retrieve the events associated to the SKU option
      tags:
      - events
      parameters:
      - name: skuOptionId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the SKU option
  /skus/{skuId}/events:
    get:
      operationId: GET/skuId/events
      summary: Retrieve the events associated to the SKU
      description: Retrieve the events associated to the SKU
      tags:
      - events
      parameters:
      - name: skuId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the SKU
  /stock_transfers/{stockTransferId}/events:
    get:
      operationId: GET/stockTransferId/events
      summary: Retrieve the events associated to the stock transfer
      description: Retrieve the events associated to the stock transfer
      tags:
      - events
      parameters:
      - name: stockTransferId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the stock transfer
  /stores/{storeId}/events:
    get:
      operationId: GET/storeId/events
      summary: Retrieve the events associated to the store
      description: Retrieve the events associated to the store
      tags:
      - events
      parameters:
      - name: storeId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the store
  /stripe_tax_accounts/{stripeTaxAccountId}/events:
    get:
      operationId: GET/stripeTaxAccountId/events
      summary: Retrieve the events associated to the stripe tax account
      description: Retrieve the events associated to the stripe tax account
      tags:
      - events
      parameters:
      - name: stripeTaxAccountId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the stripe tax account
  /tax_calculators/{taxCalculatorId}/events:
    get:
      operationId: GET/taxCalculatorId/events
      summary: Retrieve the events associated to the tax calculator
      description: Retrieve the events associated to the tax calculator
      tags:
      - events
      parameters:
      - name: taxCalculatorId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the tax calculator
  /taxjar_accounts/{taxjarAccountId}/events:
    get:
      operationId: GET/taxjarAccountId/events
      summary: Retrieve the events associated to the taxjar account
      description: Retrieve the events associated to the taxjar account
      tags:
      - events
      parameters:
      - name: taxjarAccountId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the taxjar account
  /transactions/{transactionId}/events:
    get:
      operationId: GET/transactionId/events
      summary: Retrieve the events associated to the transaction
      description: Retrieve the events associated to the transaction
      tags:
      - events
      parameters:
      - name: transactionId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the transaction
  /vertex_accounts/{vertexAccountId}/events:
    get:
      operationId: GET/vertexAccountId/events
      summary: Retrieve the events associated to the vertex account
      description: Retrieve the events associated to the vertex account
      tags:
      - events
      parameters:
      - name: vertexAccountId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the vertex account
  /voids/{voidId}/events:
    get:
      operationId: GET/voidId/events
      summary: Retrieve the events associated to the void
      description: Retrieve the events associated to the void
      tags:
      - events
      parameters:
      - name: voidId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The events associated to the void
components:
  schemas:
    eventResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            id:
              type: string
              description: Unique identifier for the resource (hash).
              example: XAyRWNUzyN
            type:
              type: string
              description: The resource's type
              enum:
              - events
            links:
              type: object
              properties:
                self:
                  type: string
                  description: URL
            attributes:
              $ref: '#/components/schemas/event/properties/data/properties/attributes'
            relationships:
              type: object
              properties:
                webhooks:
                  type: object
                  properties:
                    links:
                      type: object
                      properties:
                        self:
                          type: string
                          description: URL
                        related:
                          type: string
                          description: URL
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - webhooks
                        id:
                          type: string
                          description: The resource ID
                last_even

# --- truncated at 32 KB (37 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/commerce-layer/refs/heads/main/openapi/commerce-layer-events-api-openapi.yml