/
CO
commercelayer
Search skmtc
⌘K
Docs
Sign in
Docs
History
Schema
Generate
Filter operations
addresses
5
adjustments
5
adyen_gateways
5
adyen_payments
5
application
1
attachments
5
authorizations
3
avalara_accounts
5
axerve_gateways
5
axerve_payments
5
billing_info_validation_rules
5
bing_geocoders
5
braintree_gateways
5
braintree_payments
5
bundles
5
buy_x_pay_y_promotions
5
captures
3
carrier_accounts
5
checkout_com_gateways
5
checkout_com_payments
5
cleanups
5
coupon_codes_promotion_rules
5
coupon_recipients
5
coupons
5
custom_promotion_rules
5
customer_addresses
5
customer_groups
5
customer_password_resets
5
customer_payment_sources
5
customer_subscriptions
5
customers
5
delivery_lead_times
5
discount_engine_items
2
discount_engines
2
easypost_pickups
5
event_callbacks
2
event_stores
1
events
3
exports
5
external_gateways
5
external_payments
5
external_promotions
5
external_tax_calculators
5
fixed_amount_promotions
5
fixed_price_promotions
5
flex_promotions
5
free_gift_promotions
5
free_shipping_promotions
5
geocoders
2
gift_card_recipients
5
gift_cards
5
google_geocoders
5
has_many
440
get
/addresses/{addressId}/events
Retrieve the events associated to the address
get
/addresses/{addressId}/tags
Retrieve the tags associated to the address
get
/addresses/{addressId}/event_stores
Retrieve the event stores associated to the address
get
/adjustments/{adjustmentId}/event_stores
Retrieve the event stores associated to the adjustment
get
/adyen_gateways/{adyenGatewayId}/payment_methods
Retrieve the payment methods associated to the adyen gateway
get
/adyen_gateways/{adyenGatewayId}/event_stores
Retrieve the event stores associated to the adyen gateway
get
/adyen_gateways/{adyenGatewayId}/adyen_payments
Retrieve the adyen payments associated to the adyen gateway
get
/adyen_payments/{adyenPaymentId}/event_stores
Retrieve the event stores associated to the adyen payment
get
/attachments/{attachmentId}/event_stores
Retrieve the event stores associated to the attachment
get
/authorizations/{authorizationId}/attachments
Retrieve the attachments associated to the authorization
get
/authorizations/{authorizationId}/events
Retrieve the events associated to the authorization
get
/authorizations/{authorizationId}/event_stores
Retrieve the event stores associated to the authorization
get
/authorizations/{authorizationId}/captures
Retrieve the captures associated to the authorization
get
/authorizations/{authorizationId}/voids
Retrieve the voids associated to the authorization
get
/avalara_accounts/{avalaraAccountId}/markets
Retrieve the markets associated to the avalara account
get
/avalara_accounts/{avalaraAccountId}/attachments
Retrieve the attachments associated to the avalara account
get
/avalara_accounts/{avalaraAccountId}/events
Retrieve the events associated to the avalara account
get
/avalara_accounts/{avalaraAccountId}/event_stores
Retrieve the event stores associated to the avalara account
get
/avalara_accounts/{avalaraAccountId}/tax_categories
Retrieve the tax categories associated to the avalara account
get
/axerve_gateways/{axerveGatewayId}/payment_methods
Retrieve the payment methods associated to the axerve gateway
get
/axerve_gateways/{axerveGatewayId}/event_stores
Retrieve the event stores associated to the axerve gateway
get
/axerve_gateways/{axerveGatewayId}/axerve_payments
Retrieve the axerve payments associated to the axerve gateway
get
/axerve_payments/{axervePaymentId}/event_stores
Retrieve the event stores associated to the axerve payment
get
/billing_info_validation_rules/{billingInfoValidationRuleId}/attachments
Retrieve the attachments associated to the billing info validation rule
get
/billing_info_validation_rules/{billingInfoValidationRuleId}/event_stores
Retrieve the event stores associated to the billing info validation rule
get
/bing_geocoders/{bingGeocoderId}/markets
Retrieve the markets associated to the bing geocoder
get
/bing_geocoders/{bingGeocoderId}/addresses
Retrieve the addresses associated to the bing geocoder
get
/bing_geocoders/{bingGeocoderId}/attachments
Retrieve the attachments associated to the bing geocoder
get
/bing_geocoders/{bingGeocoderId}/event_stores
Retrieve the event stores associated to the bing geocoder
get
/braintree_gateways/{braintreeGatewayId}/payment_methods
Retrieve the payment methods associated to the braintree gateway
get
/braintree_gateways/{braintreeGatewayId}/event_stores
Retrieve the event stores associated to the braintree gateway
get
/braintree_gateways/{braintreeGatewayId}/braintree_payments
Retrieve the braintree payments associated to the braintree gateway
get
/braintree_payments/{braintreePaymentId}/event_stores
Retrieve the event stores associated to the braintree payment
get
/bundles/{bundleId}/skus
Retrieve the skus associated to the bundle
get
/bundles/{bundleId}/attachments
Retrieve the attachments associated to the bundle
get
/bundles/{bundleId}/events
Retrieve the events associated to the bundle
get
/bundles/{bundleId}/tags
Retrieve the tags associated to the bundle
get
/bundles/{bundleId}/event_stores
Retrieve the event stores associated to the bundle
get
/buy_x_pay_y_promotions/{buyXPayYPromotionId}/coupons
Retrieve the coupons associated to the buy x pay y promotion
get
/buy_x_pay_y_promotions/{buyXPayYPromotionId}/attachments
Retrieve the attachments associated to the buy x pay y promotion
get
/buy_x_pay_y_promotions/{buyXPayYPromotionId}/events
Retrieve the events associated to the buy x pay y promotion
get
/buy_x_pay_y_promotions/{buyXPayYPromotionId}/tags
Retrieve the tags associated to the buy x pay y promotion
get
/buy_x_pay_y_promotions/{buyXPayYPromotionId}/event_stores
Retrieve the event stores associated to the buy x pay y promotion
get
/buy_x_pay_y_promotions/{buyXPayYPromotionId}/skus
Retrieve the skus associated to the buy x pay y promotion
get
/captures/{captureId}/attachments
Retrieve the attachments associated to the capture
get
/captures/{captureId}/events
Retrieve the events associated to the capture
get
/captures/{captureId}/event_stores
Retrieve the event stores associated to the capture
get
/captures/{captureId}/refunds
Retrieve the refunds associated to the capture
get
/carrier_accounts/{carrierAccountId}/attachments
Retrieve the attachments associated to the carrier account
get
/carrier_accounts/{carrierAccountId}/event_stores
Retrieve the event stores associated to the carrier account
get
/checkout_com_gateways/{checkoutComGatewayId}/payment_methods
Retrieve the payment methods associated to the checkout.com gateway
get
/checkout_com_gateways/{checkoutComGatewayId}/event_stores
Retrieve the event stores associated to the checkout.com gateway
get
/checkout_com_gateways/{checkoutComGatewayId}/checkout_com_payments
Retrieve the checkout com payments associated to the checkout.com gateway
get
/checkout_com_payments/{checkoutComPaymentId}/event_stores
Retrieve the event stores associated to the checkout.com payment
get
/cleanups/{cleanupId}/events
Retrieve the events associated to the cleanup
get
/cleanups/{cleanupId}/event_stores
Retrieve the event stores associated to the cleanup
get
/coupon_codes_promotion_rules/{couponCodesPromotionRuleId}/event_stores
Retrieve the event stores associated to the coupon codes promotion rule
get
/coupon_codes_promotion_rules/{couponCodesPromotionRuleId}/coupons
Retrieve the coupons associated to the coupon codes promotion rule
get
/coupon_recipients/{couponRecipientId}/event_stores
Retrieve the event stores associated to the coupon recipient
get
/coupon_recipients/{couponRecipientId}/attachments
Retrieve the attachments associated to the coupon recipient
get
/coupons/{couponId}/events
Retrieve the events associated to the coupon
get
/coupons/{couponId}/tags
Retrieve the tags associated to the coupon
get
/coupons/{couponId}/event_stores
Retrieve the event stores associated to the coupon
get
/custom_promotion_rules/{customPromotionRuleId}/event_stores
Retrieve the event stores associated to the custom promotion rule
get
/customer_addresses/{customerAddressId}/events
Retrieve the events associated to the customer address
get
/customer_addresses/{customerAddressId}/event_stores
Retrieve the event stores associated to the customer address
get
/customer_groups/{customerGroupId}/customers
Retrieve the customers associated to the customer group
get
/customer_groups/{customerGroupId}/markets
Retrieve the markets associated to the customer group
get
/customer_groups/{customerGroupId}/attachments
Retrieve the attachments associated to the customer group
get
/customer_groups/{customerGroupId}/event_stores
Retrieve the event stores associated to the customer group
get
/customer_password_resets/{customerPasswordResetId}/events
Retrieve the events associated to the customer password reset
get
/customer_password_resets/{customerPasswordResetId}/event_stores
Retrieve the event stores associated to the customer password reset
get
/customer_payment_sources/{customerPaymentSourceId}/event_stores
Retrieve the event stores associated to the customer payment source
get
/customer_subscriptions/{customerSubscriptionId}/events
Retrieve the events associated to the customer subscription
get
/customer_subscriptions/{customerSubscriptionId}/event_stores
Retrieve the event stores associated to the customer subscription
get
/customers/{customerId}/customer_addresses
Retrieve the customer addresses associated to the customer
get
/customers/{customerId}/customer_payment_sources
Retrieve the customer payment sources associated to the customer
get
/customers/{customerId}/customer_subscriptions
Retrieve the customer subscriptions associated to the customer
get
/customers/{customerId}/orders
Retrieve the orders associated to the customer
get
/customers/{customerId}/order_subscriptions
Retrieve the order subscriptions associated to the customer
get
/customers/{customerId}/returns
Retrieve the returns associated to the customer
get
/customers/{customerId}/sku_lists
Retrieve the sku lists associated to the customer
get
/customers/{customerId}/attachments
Retrieve the attachments associated to the customer
get
/customers/{customerId}/events
Retrieve the events associated to the customer
get
/customers/{customerId}/tags
Retrieve the tags associated to the customer
get
/customers/{customerId}/jwt_markets
Retrieve the jwt markets associated to the customer
get
/customers/{customerId}/jwt_stock_locations
Retrieve the jwt stock locations associated to the customer
get
/customers/{customerId}/event_stores
Retrieve the event stores associated to the customer
get
/delivery_lead_times/{deliveryLeadTimeId}/attachments
Retrieve the attachments associated to the delivery lead time
get
/delivery_lead_times/{deliveryLeadTimeId}/event_stores
Retrieve the event stores associated to the delivery lead time
get
/discount_engine_items/{discountEngineItemId}/event_stores
Retrieve the event stores associated to the discount engine item
get
/discount_engines/{discountEngineId}/markets
Retrieve the markets associated to the discount engine
get
/discount_engines/{discountEngineId}/discount_engine_items
Retrieve the discount engine items associated to the discount engine
get
/discount_engines/{discountEngineId}/attachments
Retrieve the attachments associated to the discount engine
get
/discount_engines/{discountEngineId}/event_stores
Retrieve the event stores associated to the discount engine
get
/easypost_pickups/{easypostPickupId}/parcels
Retrieve the parcels associated to the easypost pickup
get
/easypost_pickups/{easypostPickupId}/events
Retrieve the events associated to the easypost pickup
get
/easypost_pickups/{easypostPickupId}/event_stores
Retrieve the event stores associated to the easypost pickup
get
/event_callbacks/{eventCallbackId}/event_stores
Retrieve the event stores associated to the event callback
get
/events/{eventId}/webhooks
Retrieve the webhooks associated to the event
get
/events/{eventId}/last_event_callbacks
Retrieve the last event callbacks associated to the event
get
/events/{eventId}/event_stores
Retrieve the event stores associated to the event
get
/exports/{exportId}/events
Retrieve the events associated to the export
get
/exports/{exportId}/event_stores
Retrieve the event stores associated to the export
get
/external_gateways/{externalGatewayId}/payment_methods
Retrieve the payment methods associated to the external gateway
get
/external_gateways/{externalGatewayId}/event_stores
Retrieve the event stores associated to the external gateway
get
/external_gateways/{externalGatewayId}/external_payments
Retrieve the external payments associated to the external gateway
get
/external_payments/{externalPaymentId}/event_stores
Retrieve the event stores associated to the external payment
get
/external_promotions/{externalPromotionId}/coupons
Retrieve the coupons associated to the external promotion
get
/external_promotions/{externalPromotionId}/attachments
Retrieve the attachments associated to the external promotion
get
/external_promotions/{externalPromotionId}/events
Retrieve the events associated to the external promotion
get
/external_promotions/{externalPromotionId}/tags
Retrieve the tags associated to the external promotion
get
/external_promotions/{externalPromotionId}/event_stores
Retrieve the event stores associated to the external promotion
get
/external_promotions/{externalPromotionId}/skus
Retrieve the skus associated to the external promotion
get
/external_tax_calculators/{externalTaxCalculatorId}/markets
Retrieve the markets associated to the external tax calculator
get
/external_tax_calculators/{externalTaxCalculatorId}/attachments
Retrieve the attachments associated to the external tax calculator
get
/external_tax_calculators/{externalTaxCalculatorId}/events
Retrieve the events associated to the external tax calculator
get
/external_tax_calculators/{externalTaxCalculatorId}/event_stores
Retrieve the event stores associated to the external tax calculator
get
/fixed_amount_promotions/{fixedAmountPromotionId}/coupons
Retrieve the coupons associated to the fixed amount promotion
get
/fixed_amount_promotions/{fixedAmountPromotionId}/attachments
Retrieve the attachments associated to the fixed amount promotion
get
/fixed_amount_promotions/{fixedAmountPromotionId}/events
Retrieve the events associated to the fixed amount promotion
get
/fixed_amount_promotions/{fixedAmountPromotionId}/tags
Retrieve the tags associated to the fixed amount promotion
get
/fixed_amount_promotions/{fixedAmountPromotionId}/event_stores
Retrieve the event stores associated to the fixed amount promotion
get
/fixed_amount_promotions/{fixedAmountPromotionId}/skus
Retrieve the skus associated to the fixed amount promotion
get
/fixed_price_promotions/{fixedPricePromotionId}/coupons
Retrieve the coupons associated to the fixed price promotion
get
/fixed_price_promotions/{fixedPricePromotionId}/attachments
Retrieve the attachments associated to the fixed price promotion
get
/fixed_price_promotions/{fixedPricePromotionId}/events
Retrieve the events associated to the fixed price promotion
get
/fixed_price_promotions/{fixedPricePromotionId}/tags
Retrieve the tags associated to the fixed price promotion
get
/fixed_price_promotions/{fixedPricePromotionId}/event_stores
Retrieve the event stores associated to the fixed price promotion
get
/fixed_price_promotions/{fixedPricePromotionId}/skus
Retrieve the skus associated to the fixed price promotion
get
/flex_promotions/{flexPromotionId}/coupons
Retrieve the coupons associated to the flex promotion
get
/flex_promotions/{flexPromotionId}/attachments
Retrieve the attachments associated to the flex promotion
get
/flex_promotions/{flexPromotionId}/events
Retrieve the events associated to the flex promotion
get
/flex_promotions/{flexPromotionId}/tags
Retrieve the tags associated to the flex promotion
get
/flex_promotions/{flexPromotionId}/event_stores
Retrieve the event stores associated to the flex promotion
get
/free_gift_promotions/{freeGiftPromotionId}/coupons
Retrieve the coupons associated to the free gift promotion
get
/free_gift_promotions/{freeGiftPromotionId}/attachments
Retrieve the attachments associated to the free gift promotion
get
/free_gift_promotions/{freeGiftPromotionId}/events
Retrieve the events associated to the free gift promotion
get
/free_gift_promotions/{freeGiftPromotionId}/tags
Retrieve the tags associated to the free gift promotion
get
/free_gift_promotions/{freeGiftPromotionId}/event_stores
Retrieve the event stores associated to the free gift promotion
get
/free_gift_promotions/{freeGiftPromotionId}/skus
Retrieve the skus associated to the free gift promotion
get
/free_shipping_promotions/{freeShippingPromotionId}/coupons
Retrieve the coupons associated to the free shipping promotion
get
/free_shipping_promotions/{freeShippingPromotionId}/attachments
Retrieve the attachments associated to the free shipping promotion
get
/free_shipping_promotions/{freeShippingPromotionId}/events
Retrieve the events associated to the free shipping promotion
get
/free_shipping_promotions/{freeShippingPromotionId}/tags
Retrieve the tags associated to the free shipping promotion
get
/free_shipping_promotions/{freeShippingPromotionId}/event_stores
Retrieve the event stores associated to the free shipping promotion
get
/geocoders/{geocoderId}/markets
Retrieve the markets associated to the geocoder
get
/geocoders/{geocoderId}/addresses
Retrieve the addresses associated to the geocoder
get
/geocoders/{geocoderId}/attachments
Retrieve the attachments associated to the geocoder
get
/geocoders/{geocoderId}/event_stores
Retrieve the event stores associated to the geocoder
get
/gift_card_recipients/{giftCardRecipientId}/event_stores
Retrieve the event stores associated to the gift card recipient
get
/gift_card_recipients/{giftCardRecipientId}/attachments
Retrieve the attachments associated to the gift card recipient
get
/gift_cards/{giftCardId}/attachments
Retrieve the attachments associated to the gift card
get
/gift_cards/{giftCardId}/events
Retrieve the events associated to the gift card
get
/gift_cards/{giftCardId}/tags
Retrieve the tags associated to the gift card
get
/gift_cards/{giftCardId}/event_stores
Retrieve the event stores associated to the gift card
get
/google_geocoders/{googleGeocoderId}/markets
Retrieve the markets associated to the google geocoder
get
/google_geocoders/{googleGeocoderId}/addresses
Retrieve the addresses associated to the google geocoder
get
/google_geocoders/{googleGeocoderId}/attachments
Retrieve the attachments associated to the google geocoder
get
/google_geocoders/{googleGeocoderId}/event_stores
Retrieve the event stores associated to the google geocoder
get
/imports/{importId}/events
Retrieve the events associated to the import
get
/imports/{importId}/event_stores
Retrieve the event stores associated to the import
get
/in_stock_subscriptions/{inStockSubscriptionId}/events
Retrieve the events associated to the in stock subscription
get
/in_stock_subscriptions/{inStockSubscriptionId}/event_stores
Retrieve the event stores associated to the in stock subscription
get
/inventory_models/{inventoryModelId}/inventory_stock_locations
Retrieve the inventory stock locations associated to the inventory model
get
/inventory_models/{inventoryModelId}/inventory_return_locations
Retrieve the inventory return locations associated to the inventory model
get
/inventory_models/{inventoryModelId}/attachments
Retrieve the attachments associated to the inventory model
get
/inventory_models/{inventoryModelId}/event_stores
Retrieve the event stores associated to the inventory model
get
/inventory_return_locations/{inventoryReturnLocationId}/event_stores
Retrieve the event stores associated to the inventory return location
get
/inventory_stock_locations/{inventoryStockLocationId}/event_stores
Retrieve the event stores associated to the inventory stock location
get
/klarna_gateways/{klarnaGatewayId}/payment_methods
Retrieve the payment methods associated to the klarna gateway
get
/klarna_gateways/{klarnaGatewayId}/event_stores
Retrieve the event stores associated to the klarna gateway
get
/klarna_gateways/{klarnaGatewayId}/klarna_payments
Retrieve the klarna payments associated to the klarna gateway
get
/klarna_payments/{klarnaPaymentId}/event_stores
Retrieve the event stores associated to the klarna payment
get
/line_item_options/{lineItemOptionId}/events
Retrieve the events associated to the line item option
get
/line_item_options/{lineItemOptionId}/tags
Retrieve the tags associated to the line item option
get
/line_item_options/{lineItemOptionId}/event_stores
Retrieve the event stores associated to the line item option
get
/line_items/{lineItemId}/line_item_options
Retrieve the line item options associated to the line item
get
/line_items/{lineItemId}/return_line_items
Retrieve the return line items associated to the line item
get
/line_items/{lineItemId}/shipment_line_items
Retrieve the shipment line items associated to the line item
get
/line_items/{lineItemId}/stock_reservations
Retrieve the stock reservations associated to the line item
get
/line_items/{lineItemId}/stock_line_items
Retrieve the stock line items associated to the line item
get
/line_items/{lineItemId}/stock_transfers
Retrieve the stock transfers associated to the line item
get
/line_items/{lineItemId}/attachments
Retrieve the attachments associated to the line item
get
/line_items/{lineItemId}/notifications
Retrieve the notifications associated to the line item
get
/line_items/{lineItemId}/events
Retrieve the events associated to the line item
get
/line_items/{lineItemId}/tags
Retrieve the tags associated to the line item
get
/line_items/{lineItemId}/event_stores
Retrieve the event stores associated to the line item
get
/links/{linkId}/events
Retrieve the events associated to the link
get
/links/{linkId}/event_stores
Retrieve the event stores associated to the link
get
/manual_gateways/{manualGatewayId}/payment_methods
Retrieve the payment methods associated to the manual gateway
get
/manual_gateways/{manualGatewayId}/event_stores
Retrieve the event stores associated to the manual gateway
get
/manual_tax_calculators/{manualTaxCalculatorId}/markets
Retrieve the markets associated to the manual tax calculator
get
/manual_tax_calculators/{manualTaxCalculatorId}/attachments
Retrieve the attachments associated to the manual tax calculator
get
/manual_tax_calculators/{manualTaxCalculatorId}/events
Retrieve the events associated to the manual tax calculator
get
/manual_tax_calculators/{manualTaxCalculatorId}/event_stores
Retrieve the event stores associated to the manual tax calculator
get
/manual_tax_calculators/{manualTaxCalculatorId}/tax_rules
Retrieve the tax rules associated to the manual tax calculator
get
/markets/{marketId}/stores
Retrieve the stores associated to the market
get
/markets/{marketId}/price_list_schedulers
Retrieve the price list schedulers associated to the market
get
/markets/{marketId}/attachments
Retrieve the attachments associated to the market
get
/markets/{marketId}/event_stores
Retrieve the event stores associated to the market
get
/merchants/{merchantId}/attachments
Retrieve the attachments associated to the merchant
get
/merchants/{merchantId}/event_stores
Retrieve the event stores associated to the merchant
get
/notifications/{notificationId}/event_stores
Retrieve the event stores associated to the notification
get
/order_amount_promotion_rules/{orderAmountPromotionRuleId}/event_stores
Retrieve the event stores associated to the order amount promotion rule
get
/order_copies/{orderCopyId}/events
Retrieve the events associated to the order copy
get
/order_copies/{orderCopyId}/event_stores
Retrieve the event stores associated to the order copy
get
/order_factories/{orderFactoryId}/events
Retrieve the events associated to the order factory
get
/order_factories/{orderFactoryId}/event_stores
Retrieve the event stores associated to the order factory
get
/order_subscription_items/{orderSubscriptionItemId}/event_stores
Retrieve the event stores associated to the order subscription item
get
/order_subscriptions/{orderSubscriptionId}/order_subscription_items
Retrieve the order subscription items associated to the order subscription
get
/order_subscriptions/{orderSubscriptionId}/order_factories
Retrieve the order factories associated to the order subscription
get
/order_subscriptions/{orderSubscriptionId}/order_copies
Retrieve the order copies associated to the order subscription
get
/order_subscriptions/{orderSubscriptionId}/recurring_order_copies
Retrieve the recurring order copies associated to the order subscription
get
/order_subscriptions/{orderSubscriptionId}/orders
Retrieve the orders associated to the order subscription
get
/order_subscriptions/{orderSubscriptionId}/resource_errors
Retrieve the resource errors associated to the order subscription
get
/order_subscriptions/{orderSubscriptionId}/events
Retrieve the events associated to the order subscription
get
/order_subscriptions/{orderSubscriptionId}/tags
Retrieve the tags associated to the order subscription
get
/order_subscriptions/{orderSubscriptionId}/event_stores
Retrieve the event stores associated to the order subscription
get
/order_validation_rules/{orderValidationRuleId}/attachments
Retrieve the attachments associated to the order validation rule
get
/order_validation_rules/{orderValidationRuleId}/event_stores
Retrieve the event stores associated to the order validation rule
get
/orders/{orderId}/available_payment_methods
Retrieve the available payment methods associated to the order
get
/orders/{orderId}/available_customer_payment_sources
Retrieve the available customer payment sources associated to the order
get
/orders/{orderId}/available_free_skus
Retrieve the available free skus associated to the order
get
/orders/{orderId}/available_free_bundles
Retrieve the available free bundles associated to the order
get
/orders/{orderId}/line_items
Retrieve the line items associated to the order
get
/orders/{orderId}/line_item_options
Retrieve the line item options associated to the order
get
/orders/{orderId}/stock_reservations
Retrieve the stock reservations associated to the order
get
/orders/{orderId}/stock_line_items
Retrieve the stock line items associated to the order
get
/orders/{orderId}/stock_transfers
Retrieve the stock transfers associated to the order
get
/orders/{orderId}/shipments
Retrieve the shipments associated to the order
get
/orders/{orderId}/payment_options
Retrieve the payment options associated to the order
get
/orders/{orderId}/authorizations
Retrieve the authorizations associated to the order
get
/orders/{orderId}/captures
Retrieve the captures associated to the order
get
/orders/{orderId}/voids
Retrieve the voids associated to the order
get
/orders/{orderId}/refunds
Retrieve the refunds associated to the order
get
/orders/{orderId}/returns
Retrieve the returns associated to the order
get
/orders/{orderId}/order_subscriptions
Retrieve the order subscriptions associated to the order
get
/orders/{orderId}/order_factories
Retrieve the order factories associated to the order
get
/orders/{orderId}/order_copies
Retrieve the order copies associated to the order
get
/orders/{orderId}/recurring_order_copies
Retrieve the recurring order copies associated to the order
get
/orders/{orderId}/attachments
Retrieve the attachments associated to the order
get
/orders/{orderId}/notifications
Retrieve the notifications associated to the order
get
/orders/{orderId}/links
Retrieve the links associated to the order
get
/orders/{orderId}/resource_errors
Retrieve the resource errors associated to the order
get
/orders/{orderId}/events
Retrieve the events associated to the order
get
/orders/{orderId}/tags
Retrieve the tags associated to the order
get
/orders/{orderId}/event_stores
Retrieve the event stores associated to the order
get
/organization/{organizationId}/event_stores
Retrieve the event stores associated to the organization
get
/packages/{packageId}/parcels
Retrieve the parcels associated to the package
get
/packages/{packageId}/attachments
Retrieve the attachments associated to the package
get
/packages/{packageId}/event_stores
Retrieve the event stores associated to the package
get
/parcel_line_items/{parcelLineItemId}/event_stores
Retrieve the event stores associated to the parcel line item
get
/parcels/{parcelId}/parcel_line_items
Retrieve the parcel line items associated to the parcel
get
/parcels/{parcelId}/attachments
Retrieve the attachments associated to the parcel
get
/parcels/{parcelId}/events
Retrieve the events associated to the parcel
get
/parcels/{parcelId}/event_stores
Retrieve the event stores associated to the parcel
get
/payment_gateways/{paymentGatewayId}/payment_methods
Retrieve the payment methods associated to the payment gateway
get
/payment_gateways/{paymentGatewayId}/event_stores
Retrieve the event stores associated to the payment gateway
get
/payment_methods/{paymentMethodId}/attachments
Retrieve the attachments associated to the payment method
get
/payment_methods/{paymentMethodId}/event_stores
Retrieve the event stores associated to the payment method
get
/payment_options/{paymentOptionId}/attachments
Retrieve the attachments associated to the payment option
get
/payment_options/{paymentOptionId}/event_stores
Retrieve the event stores associated to the payment option
get
/paypal_gateways/{paypalGatewayId}/payment_methods
Retrieve the payment methods associated to the paypal gateway
get
/paypal_gateways/{paypalGatewayId}/event_stores
Retrieve the event stores associated to the paypal gateway
get
/paypal_gateways/{paypalGatewayId}/paypal_payments
Retrieve the paypal payments associated to the paypal gateway
get
/paypal_payments/{paypalPaymentId}/event_stores
Retrieve the event stores associated to the paypal payment
get
/percentage_discount_promotions/{percentageDiscountPromotionId}/coupons
Retrieve the coupons associated to the percentage discount promotion
get
/percentage_discount_promotions/{percentageDiscountPromotionId}/attachments
Retrieve the attachments associated to the percentage discount promotion
get
/percentage_discount_promotions/{percentageDiscountPromotionId}/events
Retrieve the events associated to the percentage discount promotion
get
/percentage_discount_promotions/{percentageDiscountPromotionId}/tags
Retrieve the tags associated to the percentage discount promotion
get
/percentage_discount_promotions/{percentageDiscountPromotionId}/event_stores
Retrieve the event stores associated to the percentage discount promotion
get
/percentage_discount_promotions/{percentageDiscountPromotionId}/skus
Retrieve the skus associated to the percentage discount promotion
get
/pickups/{pickupId}/parcels
Retrieve the parcels associated to the pickup
get
/pickups/{pickupId}/events
Retrieve the events associated to the pickup
get
/pickups/{pickupId}/event_stores
Retrieve the event stores associated to the pickup
get
/price_frequency_tiers/{priceFrequencyTierId}/attachments
Retrieve the attachments associated to the price frequency tier
get
/price_frequency_tiers/{priceFrequencyTierId}/event_stores
Retrieve the event stores associated to the price frequency tier
get
/price_frequency_tiers/{priceFrequencyTierId}/events
Retrieve the events associated to the price frequency tier
get
/price_list_schedulers/{priceListSchedulerId}/events
Retrieve the events associated to the price list scheduler
get
/price_list_schedulers/{priceListSchedulerId}/event_stores
Retrieve the event stores associated to the price list scheduler
get
/price_lists/{priceListId}/prices
Retrieve the prices associated to the price list
get
/price_lists/{priceListId}/price_list_schedulers
Retrieve the price list schedulers associated to the price list
get
/price_lists/{priceListId}/attachments
Retrieve the attachments associated to the price list
get
/price_lists/{priceListId}/event_stores
Retrieve the event stores associated to the price list
get
/price_tiers/{priceTierId}/attachments
Retrieve the attachments associated to the price tier
get
/price_tiers/{priceTierId}/event_stores
Retrieve the event stores associated to the price tier
get
/price_volume_tiers/{priceVolumeTierId}/attachments
Retrieve the attachments associated to the price volume tier
get
/price_volume_tiers/{priceVolumeTierId}/event_stores
Retrieve the event stores associated to the price volume tier
get
/price_volume_tiers/{priceVolumeTierId}/events
Retrieve the events associated to the price volume tier
get
/prices/{priceId}/price_tiers
Retrieve the price tiers associated to the price
get
/prices/{priceId}/price_volume_tiers
Retrieve the price volume tiers associated to the price
get
/prices/{priceId}/price_frequency_tiers
Retrieve the price frequency tiers associated to the price
get
/prices/{priceId}/attachments
Retrieve the attachments associated to the price
get
/prices/{priceId}/jwt_markets
Retrieve the jwt markets associated to the price
get
/prices/{priceId}/jwt_stock_locations
Retrieve the jwt stock locations associated to the price
get
/prices/{priceId}/event_stores
Retrieve the event stores associated to the price
get
/promotion_rules/{promotionRuleId}/event_stores
Retrieve the event stores associated to the promotion rule
get
/promotions/{promotionId}/coupons
Retrieve the coupons associated to the promotion
get
/promotions/{promotionId}/attachments
Retrieve the attachments associated to the promotion
get
/promotions/{promotionId}/events
Retrieve the events associated to the promotion
get
/promotions/{promotionId}/tags
Retrieve the tags associated to the promotion
get
/promotions/{promotionId}/event_stores
Retrieve the event stores associated to the promotion
get
/recurring_order_copies/{recurringOrderCopyId}/events
Retrieve the events associated to the recurring order copy
get
/recurring_order_copies/{recurringOrderCopyId}/event_stores
Retrieve the event stores associated to the recurring order copy
get
/refunds/{refundId}/attachments
Retrieve the attachments associated to the refund
get
/refunds/{refundId}/events
Retrieve the events associated to the refund
get
/refunds/{refundId}/event_stores
Retrieve the event stores associated to the refund
get
/reserved_stocks/{reservedStockId}/stock_reservations
Retrieve the stock reservations associated to the reserved stock
get
/reserved_stocks/{reservedStockId}/event_stores
Retrieve the event stores associated to the reserved stock
get
/resource_errors/{resourceErrorId}/event_stores
Retrieve the event stores associated to the resource error
get
/return_line_items/{returnLineItemId}/event_stores
Retrieve the event stores associated to the return line item
get
/returns/{returnId}/return_line_items
Retrieve the return line items associated to the return
get
/returns/{returnId}/attachments
Retrieve the attachments associated to the return
get
/returns/{returnId}/resource_errors
Retrieve the resource errors associated to the return
get
/returns/{returnId}/events
Retrieve the events associated to the return
get
/returns/{returnId}/tags
Retrieve the tags associated to the return
get
/returns/{returnId}/event_stores
Retrieve the event stores associated to the return
get
/satispay_gateways/{satispayGatewayId}/payment_methods
Retrieve the payment methods associated to the satispay gateway
get
/satispay_gateways/{satispayGatewayId}/event_stores
Retrieve the event stores associated to the satispay gateway
get
/satispay_gateways/{satispayGatewayId}/satispay_payments
Retrieve the satispay payments associated to the satispay gateway
get
/satispay_payments/{satispayPaymentId}/event_stores
Retrieve the event stores associated to the satispay payment
get
/shipment_line_items/{shipmentLineItemId}/event_stores
Retrieve the event stores associated to the shipment line item
get
/shipments/{shipmentId}/shipment_line_items
Retrieve the shipment line items associated to the shipment
get
/shipments/{shipmentId}/stock_line_items
Retrieve the stock line items associated to the shipment
get
/shipments/{shipmentId}/stock_transfers
Retrieve the stock transfers associated to the shipment
get
/shipments/{shipmentId}/line_items
Retrieve the line items associated to the shipment
get
/shipments/{shipmentId}/available_shipping_methods
Retrieve the available shipping methods associated to the shipment
get
/shipments/{shipmentId}/carrier_accounts
Retrieve the carrier accounts associated to the shipment
get
/shipments/{shipmentId}/parcels
Retrieve the parcels associated to the shipment
get
/shipments/{shipmentId}/attachments
Retrieve the attachments associated to the shipment
get
/shipments/{shipmentId}/events
Retrieve the events associated to the shipment
get
/shipments/{shipmentId}/tags
Retrieve the tags associated to the shipment
get
/shipments/{shipmentId}/event_stores
Retrieve the event stores associated to the shipment
get
/shipping_categories/{shippingCategoryId}/skus
Retrieve the skus associated to the shipping category
get
/shipping_categories/{shippingCategoryId}/attachments
Retrieve the attachments associated to the shipping category
get
/shipping_categories/{shippingCategoryId}/event_stores
Retrieve the event stores associated to the shipping category
get
/shipping_method_tiers/{shippingMethodTierId}/attachments
Retrieve the attachments associated to the shipping method tier
get
/shipping_method_tiers/{shippingMethodTierId}/event_stores
Retrieve the event stores associated to the shipping method tier
get
/shipping_methods/{shippingMethodId}/shipping_method_tiers
Retrieve the shipping method tiers associated to the shipping method
get
/shipping_methods/{shippingMethodId}/shipping_weight_tiers
Retrieve the shipping weight tiers associated to the shipping method
get
/shipping_methods/{shippingMethodId}/attachments
Retrieve the attachments associated to the shipping method
get
/shipping_methods/{shippingMethodId}/notifications
Retrieve the notifications associated to the shipping method
get
/shipping_methods/{shippingMethodId}/events
Retrieve the events associated to the shipping method
get
/shipping_methods/{shippingMethodId}/tags
Retrieve the tags associated to the shipping method
get
/shipping_methods/{shippingMethodId}/event_stores
Retrieve the event stores associated to the shipping method
get
/shipping_weight_tiers/{shippingWeightTierId}/attachments
Retrieve the attachments associated to the shipping weight tier
get
/shipping_weight_tiers/{shippingWeightTierId}/event_stores
Retrieve the event stores associated to the shipping weight tier
get
/shipping_weight_tiers/{shippingWeightTierId}/events
Retrieve the events associated to the shipping weight tier
get
/shipping_zones/{shippingZoneId}/attachments
Retrieve the attachments associated to the shipping zone
get
/shipping_zones/{shippingZoneId}/event_stores
Retrieve the event stores associated to the shipping zone
get
/sku_list_items/{skuListItemId}/event_stores
Retrieve the event stores associated to the SKU list item
get
/sku_list_promotion_rules/{skuListPromotionRuleId}/event_stores
Retrieve the event stores associated to the SKU list promotion rule
get
/sku_list_promotion_rules/{skuListPromotionRuleId}/skus
Retrieve the skus associated to the SKU list promotion rule
get
/sku_lists/{skuListId}/skus
Retrieve the skus associated to the SKU list
get
/sku_lists/{skuListId}/sku_list_items
Retrieve the sku list items associated to the SKU list
get
/sku_lists/{skuListId}/bundles
Retrieve the bundles associated to the SKU list
get
/sku_lists/{skuListId}/attachments
Retrieve the attachments associated to the SKU list
get
/sku_lists/{skuListId}/links
Retrieve the links associated to the SKU list
get
/sku_lists/{skuListId}/event_stores
Retrieve the event stores associated to the SKU list
get
/sku_options/{skuOptionId}/attachments
Retrieve the attachments associated to the SKU option
get
/sku_options/{skuOptionId}/events
Retrieve the events associated to the SKU option
get
/sku_options/{skuOptionId}/tags
Retrieve the tags associated to the SKU option
get
/sku_options/{skuOptionId}/event_stores
Retrieve the event stores associated to the SKU option
get
/skus/{skuId}/prices
Retrieve the prices associated to the SKU
get
/skus/{skuId}/stock_items
Retrieve the stock items associated to the SKU
get
/skus/{skuId}/stock_reservations
Retrieve the stock reservations associated to the SKU
get
/skus/{skuId}/delivery_lead_times
Retrieve the delivery lead times associated to the SKU
get
/skus/{skuId}/sku_options
Retrieve the sku options associated to the SKU
get
/skus/{skuId}/sku_list_items
Retrieve the sku list items associated to the SKU
get
/skus/{skuId}/sku_lists
Retrieve the sku lists associated to the SKU
get
/skus/{skuId}/attachments
Retrieve the attachments associated to the SKU
get
/skus/{skuId}/links
Retrieve the links associated to the SKU
get
/skus/{skuId}/events
Retrieve the events associated to the SKU
get
/skus/{skuId}/tags
Retrieve the tags associated to the SKU
get
/skus/{skuId}/jwt_markets
Retrieve the jwt markets associated to the SKU
get
/skus/{skuId}/jwt_stock_locations
Retrieve the jwt stock locations associated to the SKU
get
/skus/{skuId}/event_stores
Retrieve the event stores associated to the SKU
get
/stock_items/{stockItemId}/stock_reservations
Retrieve the stock reservations associated to the stock item
get
/stock_items/{stockItemId}/attachments
Retrieve the attachments associated to the stock item
get
/stock_items/{stockItemId}/event_stores
Retrieve the event stores associated to the stock item
get
/stock_line_items/{stockLineItemId}/event_stores
Retrieve the event stores associated to the stock line item
get
/stock_locations/{stockLocationId}/inventory_stock_locations
Retrieve the inventory stock locations associated to the stock location
get
/stock_locations/{stockLocationId}/inventory_return_locations
Retrieve the inventory return locations associated to the stock location
get
/stock_locations/{stockLocationId}/stock_items
Retrieve the stock items associated to the stock location
get
/stock_locations/{stockLocationId}/stock_transfers
Retrieve the stock transfers associated to the stock location
get
/stock_locations/{stockLocationId}/stores
Retrieve the stores associated to the stock location
get
/stock_locations/{stockLocationId}/attachments
Retrieve the attachments associated to the stock location
get
/stock_locations/{stockLocationId}/event_stores
Retrieve the event stores associated to the stock location
get
/stock_reservations/{stockReservationId}/event_stores
Retrieve the event stores associated to the stock reservation
get
/stock_transfers/{stockTransferId}/attachments
Retrieve the attachments associated to the stock transfer
get
/stock_transfers/{stockTransferId}/events
Retrieve the events associated to the stock transfer
get
/stock_transfers/{stockTransferId}/event_stores
Retrieve the event stores associated to the stock transfer
get
/stores/{storeId}/orders
Retrieve the orders associated to the store
get
/stores/{storeId}/payment_methods
Retrieve the payment methods associated to the store
get
/stores/{storeId}/events
Retrieve the events associated to the store
get
/stores/{storeId}/event_stores
Retrieve the event stores associated to the store
get
/stripe_gateways/{stripeGatewayId}/payment_methods
Retrieve the payment methods associated to the stripe gateway
get
/stripe_gateways/{stripeGatewayId}/event_stores
Retrieve the event stores associated to the stripe gateway
get
/stripe_gateways/{stripeGatewayId}/stripe_payments
Retrieve the stripe payments associated to the stripe gateway
get
/stripe_payments/{stripePaymentId}/event_stores
Retrieve the event stores associated to the stripe payment
get
/stripe_tax_accounts/{stripeTaxAccountId}/markets
Retrieve the markets associated to the stripe tax account
get
/stripe_tax_accounts/{stripeTaxAccountId}/attachments
Retrieve the attachments associated to the stripe tax account
get
/stripe_tax_accounts/{stripeTaxAccountId}/events
Retrieve the events associated to the stripe tax account
get
/stripe_tax_accounts/{stripeTaxAccountId}/event_stores
Retrieve the event stores associated to the stripe tax account
get
/stripe_tax_accounts/{stripeTaxAccountId}/tax_categories
Retrieve the tax categories associated to the stripe tax account
get
/subscription_models/{subscriptionModelId}/markets
Retrieve the markets associated to the subscription model
get
/subscription_models/{subscriptionModelId}/order_subscriptions
Retrieve the order subscriptions associated to the subscription model
get
/subscription_models/{subscriptionModelId}/attachments
Retrieve the attachments associated to the subscription model
get
/subscription_models/{subscriptionModelId}/event_stores
Retrieve the event stores associated to the subscription model
get
/tags/{tagId}/event_stores
Retrieve the event stores associated to the tag
get
/talon_one_accounts/{talonOneAccountId}/markets
Retrieve the markets associated to the talon one account
get
/talon_one_accounts/{talonOneAccountId}/discount_engine_items
Retrieve the discount engine items associated to the talon one account
get
/talon_one_accounts/{talonOneAccountId}/attachments
Retrieve the attachments associated to the talon one account
get
/talon_one_accounts/{talonOneAccountId}/event_stores
Retrieve the event stores associated to the talon one account
get
/tax_calculators/{taxCalculatorId}/markets
Retrieve the markets associated to the tax calculator
get
/tax_calculators/{taxCalculatorId}/attachments
Retrieve the attachments associated to the tax calculator
get
/tax_calculators/{taxCalculatorId}/events
Retrieve the events associated to the tax calculator
get
/tax_calculators/{taxCalculatorId}/event_stores
Retrieve the event stores associated to the tax calculator
get
/tax_categories/{taxCategoryId}/attachments
Retrieve the attachments associated to the tax category
get
/tax_categories/{taxCategoryId}/event_stores
Retrieve the event stores associated to the tax category
get
/tax_rules/{taxRuleId}/event_stores
Retrieve the event stores associated to the tax rule
get
/taxjar_accounts/{taxjarAccountId}/markets
Retrieve the markets associated to the taxjar account
get
/taxjar_accounts/{taxjarAccountId}/attachments
Retrieve the attachments associated to the taxjar account
get
/taxjar_accounts/{taxjarAccountId}/events
Retrieve the events associated to the taxjar account
get
/taxjar_accounts/{taxjarAccountId}/event_stores
Retrieve the event stores associated to the taxjar account
get
/taxjar_accounts/{taxjarAccountId}/tax_categories
Retrieve the tax categories associated to the taxjar account
get
/transactions/{transactionId}/attachments
Retrieve the attachments associated to the transaction
get
/transactions/{transactionId}/events
Retrieve the events associated to the transaction
get
/transactions/{transactionId}/event_stores
Retrieve the event stores associated to the transaction
get
/vertex_accounts/{vertexAccountId}/markets
Retrieve the markets associated to the vertex account
get
/vertex_accounts/{vertexAccountId}/attachments
Retrieve the attachments associated to the vertex account
get
/vertex_accounts/{vertexAccountId}/events
Retrieve the events associated to the vertex account
get
/vertex_accounts/{vertexAccountId}/event_stores
Retrieve the event stores associated to the vertex account
get
/voids/{voidId}/attachments
Retrieve the attachments associated to the void
get
/voids/{voidId}/events
Retrieve the events associated to the void
get
/voids/{voidId}/event_stores
Retrieve the event stores associated to the void
get
/webhooks/{webhookId}/last_event_callbacks
Retrieve the last event callbacks associated to the webhook
get
/webhooks/{webhookId}/event_stores
Retrieve the event stores associated to the webhook
get
/wire_transfers/{wireTransferId}/event_stores
Retrieve the event stores associated to the wire transfer
has_one
236
imports
5
in_stock_subscriptions
5
inventory_models
5
inventory_return_locations
5
inventory_stock_locations
5
klarna_gateways
5
klarna_payments
5
line_item_options
5
line_items
5
links
5
manual_gateways
5
manual_tax_calculators
5
markets
5
merchants
5
notifications
5
order_amount_promotion_rules
5
order_copies
5
order_factories
2
order_subscription_items
5
order_subscriptions
5
order_validation_rules
2
orders
5
organization
1
packages
5
parcel_line_items
5
parcels
5
payment_gateways
2
payment_methods
5
payment_options
5
paypal_gateways
5
paypal_payments
5
percentage_discount_promotions
5
pickups
2
price_frequency_tiers
5
price_list_schedulers
5
price_lists
5
price_tiers
2
price_volume_tiers
5
prices
5
promotion_rules
2
promotions
2
recurring_order_copies
5
refunds
3
reserved_stocks
2
resource_errors
2
return_line_items
5
returns
5
satispay_gateways
5
satispay_payments
5
shipment_line_items
2
shipments
5
shipping_categories
5
shipping_method_tiers
2
shipping_methods
5
shipping_weight_tiers
5
shipping_zones
5
sku_list_items
5
sku_list_promotion_rules
5
sku_lists
5
sku_options
5
skus
5
stock_items
5
stock_line_items
5
stock_locations
5
stock_reservations
5
stock_transfers
5
stores
5
stripe_gateways
5
stripe_payments
5
stripe_tax_accounts
5
subscription_models
5
tags
5
talon_one_accounts
5
tax_calculators
2
tax_categories
5
tax_rules
5
taxjar_accounts
5
transactions
2
vertex_accounts
5
voids
3
webhooks
5
wire_transfers
5
has_many
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Changes to Retrieve the coupons associated to the flex promotion
get
/flex_promotions/{flexPromotionId}/coupons
Jul 13, 2026
859097ed3fe6
Revision changes
info
endpoint added