{ "opencollection": "1.0.0", "info": { "name": "Commerce Layer addresses events API", "version": "7.10.1" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "events", "type": "folder" }, "items": [ { "info": { "name": "Retrieve the events associated to the address", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/addresses/:addressId/events", "params": [ { "name": "addressId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the address" }, { "info": { "name": "Retrieve the events associated to the authorization", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/authorizations/:authorizationId/events", "params": [ { "name": "authorizationId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the authorization" }, { "info": { "name": "Retrieve the events associated to the avalara account", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/avalara_accounts/:avalaraAccountId/events", "params": [ { "name": "avalaraAccountId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the avalara account" }, { "info": { "name": "Retrieve the events associated to the bundle", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/bundles/:bundleId/events", "params": [ { "name": "bundleId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the bundle" }, { "info": { "name": "Retrieve the events associated to the buy x pay y promotion", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/buy_x_pay_y_promotions/:buyXPayYPromotionId/events", "params": [ { "name": "buyXPayYPromotionId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the buy x pay y promotion" }, { "info": { "name": "Retrieve the events associated to the capture", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/captures/:captureId/events", "params": [ { "name": "captureId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the capture" }, { "info": { "name": "Retrieve the events associated to the cleanup", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/cleanups/:cleanupId/events", "params": [ { "name": "cleanupId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the cleanup" }, { "info": { "name": "Retrieve the events associated to the coupon", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/coupons/:couponId/events", "params": [ { "name": "couponId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the coupon" }, { "info": { "name": "Retrieve the events associated to the customer address", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/customer_addresses/:customerAddressId/events", "params": [ { "name": "customerAddressId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the customer address" }, { "info": { "name": "Retrieve the events associated to the customer password reset", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/customer_password_resets/:customerPasswordResetId/events", "params": [ { "name": "customerPasswordResetId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the customer password reset" }, { "info": { "name": "Retrieve the events associated to the customer subscription", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/customer_subscriptions/:customerSubscriptionId/events", "params": [ { "name": "customerSubscriptionId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the customer subscription" }, { "info": { "name": "Retrieve the events associated to the customer", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/customers/:customerId/events", "params": [ { "name": "customerId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the customer" }, { "info": { "name": "Retrieve the events associated to the easypost pickup", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/easypost_pickups/:easypostPickupId/events", "params": [ { "name": "easypostPickupId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the easypost pickup" }, { "info": { "name": "List all events", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/events" }, "docs": "List all events" }, { "info": { "name": "Retrieve an event", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/events/:eventId", "params": [ { "name": "eventId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve an event" }, { "info": { "name": "Update an event", "type": "http" }, "http": { "method": "PATCH", "url": "https://{your_organization_slug}.commercelayer.io/api/events/:eventId", "params": [ { "name": "eventId", "value": "", "type": "path", "description": "The resource's id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an event" }, { "info": { "name": "Retrieve the events associated to the export", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/exports/:exportId/events", "params": [ { "name": "exportId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the export" }, { "info": { "name": "Retrieve the events associated to the external promotion", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/external_promotions/:externalPromotionId/events", "params": [ { "name": "externalPromotionId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the external promotion" }, { "info": { "name": "Retrieve the events associated to the external tax calculator", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/external_tax_calculators/:externalTaxCalculatorId/events", "params": [ { "name": "externalTaxCalculatorId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the external tax calculator" }, { "info": { "name": "Retrieve the events associated to the fixed amount promotion", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/fixed_amount_promotions/:fixedAmountPromotionId/events", "params": [ { "name": "fixedAmountPromotionId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the fixed amount promotion" }, { "info": { "name": "Retrieve the events associated to the fixed price promotion", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/fixed_price_promotions/:fixedPricePromotionId/events", "params": [ { "name": "fixedPricePromotionId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the fixed price promotion" }, { "info": { "name": "Retrieve the events associated to the flex promotion", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/flex_promotions/:flexPromotionId/events", "params": [ { "name": "flexPromotionId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the flex promotion" }, { "info": { "name": "Retrieve the events associated to the free gift promotion", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/free_gift_promotions/:freeGiftPromotionId/events", "params": [ { "name": "freeGiftPromotionId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the free gift promotion" }, { "info": { "name": "Retrieve the events associated to the free shipping promotion", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/free_shipping_promotions/:freeShippingPromotionId/events", "params": [ { "name": "freeShippingPromotionId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the free shipping promotion" }, { "info": { "name": "Retrieve the events associated to the gift card", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/gift_cards/:giftCardId/events", "params": [ { "name": "giftCardId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the gift card" }, { "info": { "name": "Retrieve the events associated to the import", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/imports/:importId/events", "params": [ { "name": "importId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the import" }, { "info": { "name": "Retrieve the events associated to the in stock subscription", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/in_stock_subscriptions/:inStockSubscriptionId/events", "params": [ { "name": "inStockSubscriptionId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the in stock subscription" }, { "info": { "name": "Retrieve the events associated to the line item option", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/line_item_options/:lineItemOptionId/events", "params": [ { "name": "lineItemOptionId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the line item option" }, { "info": { "name": "Retrieve the events associated to the line item", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/line_items/:lineItemId/events", "params": [ { "name": "lineItemId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the line item" }, { "info": { "name": "Retrieve the events associated to the link", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/links/:linkId/events", "params": [ { "name": "linkId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the link" }, { "info": { "name": "Retrieve the events associated to the manual tax calculator", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/manual_tax_calculators/:manualTaxCalculatorId/events", "params": [ { "name": "manualTaxCalculatorId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the manual tax calculator" }, { "info": { "name": "Retrieve the events associated to the order copy", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/order_copies/:orderCopyId/events", "params": [ { "name": "orderCopyId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the order copy" }, { "info": { "name": "Retrieve the events associated to the order factory", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/order_factories/:orderFactoryId/events", "params": [ { "name": "orderFactoryId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the order factory" }, { "info": { "name": "Retrieve the events associated to the order subscription", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/order_subscriptions/:orderSubscriptionId/events", "params": [ { "name": "orderSubscriptionId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the order subscription" }, { "info": { "name": "Retrieve the events associated to the order", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/orders/:orderId/events", "params": [ { "name": "orderId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the order" }, { "info": { "name": "Retrieve the events associated to the parcel", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/parcels/:parcelId/events", "params": [ { "name": "parcelId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the parcel" }, { "info": { "name": "Retrieve the events associated to the percentage discount promotion", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/percentage_discount_promotions/:percentageDiscountPromotionId/events", "params": [ { "name": "percentageDiscountPromotionId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the percentage discount promotion" }, { "info": { "name": "Retrieve the events associated to the pickup", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/pickups/:pickupId/events", "params": [ { "name": "pickupId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the pickup" }, { "info": { "name": "Retrieve the events associated to the price frequency tier", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/price_frequency_tiers/:priceFrequencyTierId/events", "params": [ { "name": "priceFrequencyTierId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the price frequency tier" }, { "info": { "name": "Retrieve the events associated to the price list scheduler", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/price_list_schedulers/:priceListSchedulerId/events", "params": [ { "name": "priceListSchedulerId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the price list scheduler" }, { "info": { "name": "Retrieve the events associated to the price volume tier", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/price_volume_tiers/:priceVolumeTierId/events", "params": [ { "name": "priceVolumeTierId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the price volume tier" }, { "info": { "name": "Retrieve the events associated to the promotion", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/promotions/:promotionId/events", "params": [ { "name": "promotionId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the promotion" }, { "info": { "name": "Retrieve the events associated to the recurring order copy", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/recurring_order_copies/:recurringOrderCopyId/events", "params": [ { "name": "recurringOrderCopyId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the recurring order copy" }, { "info": { "name": "Retrieve the events associated to the refund", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/refunds/:refundId/events", "params": [ { "name": "refundId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the refund" }, { "info": { "name": "Retrieve the events associated to the return", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/returns/:returnId/events", "params": [ { "name": "returnId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the return" }, { "info": { "name": "Retrieve the events associated to the shipment", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/shipments/:shipmentId/events", "params": [ { "name": "shipmentId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the shipment" }, { "info": { "name": "Retrieve the events associated to the shipping method", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/shipping_methods/:shippingMethodId/events", "params": [ { "name": "shippingMethodId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the shipping method" }, { "info": { "name": "Retrieve the events associated to the shipping weight tier", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/shipping_weight_tiers/:shippingWeightTierId/events", "params": [ { "name": "shippingWeightTierId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the shipping weight tier" }, { "info": { "name": "Retrieve the events associated to the SKU option", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/sku_options/:skuOptionId/events", "params": [ { "name": "skuOptionId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the SKU option" }, { "info": { "name": "Retrieve the events associated to the SKU", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/skus/:skuId/events", "params": [ { "name": "skuId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the SKU" }, { "info": { "name": "Retrieve the events associated to the stock transfer", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/stock_transfers/:stockTransferId/events", "params": [ { "name": "stockTransferId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the stock transfer" }, { "info": { "name": "Retrieve the events associated to the store", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/stores/:storeId/events", "params": [ { "name": "storeId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the store" }, { "info": { "name": "Retrieve the events associated to the stripe tax account", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/stripe_tax_accounts/:stripeTaxAccountId/events", "params": [ { "name": "stripeTaxAccountId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the stripe tax account" }, { "info": { "name": "Retrieve the events associated to the tax calculator", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/tax_calculators/:taxCalculatorId/events", "params": [ { "name": "taxCalculatorId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the tax calculator" }, { "info": { "name": "Retrieve the events associated to the taxjar account", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/taxjar_accounts/:taxjarAccountId/events", "params": [ { "name": "taxjarAccountId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the taxjar account" }, { "info": { "name": "Retrieve the events associated to the transaction", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/transactions/:transactionId/events", "params": [ { "name": "transactionId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the transaction" }, { "info": { "name": "Retrieve the events associated to the vertex account", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/vertex_accounts/:vertexAccountId/events", "params": [ { "name": "vertexAccountId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the vertex account" }, { "info": { "name": "Retrieve the events associated to the void", "type": "http" }, "http": { "method": "GET", "url": "https://{your_organization_slug}.commercelayer.io/api/voids/:voidId/events", "params": [ { "name": "voidId", "value": "", "type": "path", "description": "The resource's id" } ] }, "docs": "Retrieve the events associated to the void" } ] } ], "bundled": true }