Operations 243
GET
/adyen_payments/{adyenPaymentId}/payment_gateway
Retrieve the payment gateway associated to the adyen payment
#
GET
/axerve_payments/{axervePaymentId}/payment_gateway
Retrieve the payment gateway associated to the axerve payment
#
GET
/braintree_payments/{braintreePaymentId}/order
Retrieve the order associated to the braintree payment
#
GET
/braintree_payments/{braintreePaymentId}/payment_gateway
Retrieve the payment gateway associated to the braintree payment
#
GET
/buy_x_pay_y_promotions/{buyXPayYPromotionId}/market
Retrieve the market associated to the buy x pay y promotion
#
GET
/buy_x_pay_y_promotions/{buyXPayYPromotionId}/order_amount_promotion_rule
Retrieve the order amount promotion rule associated to the buy x pay y promotion
#
GET
/buy_x_pay_y_promotions/{buyXPayYPromotionId}/sku_list_promotion_rule
Retrieve the sku list promotion rule associated to the buy x pay y promotion
#
GET
/buy_x_pay_y_promotions/{buyXPayYPromotionId}/coupon_codes_promotion_rule
Retrieve the coupon codes promotion rule associated to the buy x pay y promotion
#
GET
/buy_x_pay_y_promotions/{buyXPayYPromotionId}/custom_promotion_rule
Retrieve the custom promotion rule associated to the buy x pay y promotion
#
GET
/buy_x_pay_y_promotions/{buyXPayYPromotionId}/sku_list
Retrieve the sku list associated to the buy x pay y promotion
#
GET
/captures/{captureId}/reference_authorization
Retrieve the reference authorization associated to the capture
#
GET
/carrier_accounts/{carrierAccountId}/market
Retrieve the market associated to the carrier account
#
GET
/checkout_com_payments/{checkoutComPaymentId}/order
Retrieve the order associated to the checkout.com payment
#
GET
/checkout_com_payments/{checkoutComPaymentId}/payment_gateway
Retrieve the payment gateway associated to the checkout.com payment
#
GET
/coupon_recipients/{couponRecipientId}/customer
Retrieve the customer associated to the coupon recipient
#
GET
/customer_addresses/{customerAddressId}/customer
Retrieve the customer associated to the customer address
#
GET
/customer_addresses/{customerAddressId}/address
Retrieve the address associated to the customer address
#
GET
/customer_password_resets/{customerPasswordResetId}/customer
Retrieve the customer associated to the customer password reset
#
GET
/customer_payment_sources/{customerPaymentSourceId}/customer
Retrieve the customer associated to the customer payment source
#
GET
/customer_payment_sources/{customerPaymentSourceId}/payment_method
Retrieve the payment method associated to the customer payment source
#
GET
/customer_subscriptions/{customerSubscriptionId}/customer
Retrieve the customer associated to the customer subscription
#
GET
/delivery_lead_times/{deliveryLeadTimeId}/stock_location
Retrieve the stock location associated to the delivery lead time
#
GET
/delivery_lead_times/{deliveryLeadTimeId}/shipping_method
Retrieve the shipping method associated to the delivery lead time
#
GET
/discount_engine_items/{discountEngineItemId}/discount_engine
Retrieve the discount engine associated to the discount engine item
#
GET
/discount_engine_items/{discountEngineItemId}/order
Retrieve the order associated to the discount engine item
#
GET
/easypost_pickups/{easypostPickupId}/shipment
Retrieve the shipment associated to the easypost pickup
#
GET
/event_callbacks/{eventCallbackId}/webhook
Retrieve the webhook associated to the event callback
#
GET
/external_payments/{externalPaymentId}/order
Retrieve the order associated to the external payment
#
GET
/external_payments/{externalPaymentId}/payment_gateway
Retrieve the payment gateway associated to the external payment
#
GET
/external_payments/{externalPaymentId}/wallet
Retrieve the wallet associated to the external payment
#
GET
/external_promotions/{externalPromotionId}/market
Retrieve the market associated to the external promotion
#
GET
/external_promotions/{externalPromotionId}/order_amount_promotion_rule
Retrieve the order amount promotion rule associated to the external promotion
#
GET
/external_promotions/{externalPromotionId}/sku_list_promotion_rule
Retrieve the sku list promotion rule associated to the external promotion
#
GET
/external_promotions/{externalPromotionId}/coupon_codes_promotion_rule
Retrieve the coupon codes promotion rule associated to the external promotion
#
GET
/external_promotions/{externalPromotionId}/custom_promotion_rule
Retrieve the custom promotion rule associated to the external promotion
#
GET
/external_promotions/{externalPromotionId}/sku_list
Retrieve the sku list associated to the external promotion
#
GET
/fixed_amount_promotions/{fixedAmountPromotionId}/market
Retrieve the market associated to the fixed amount promotion
#
GET
/fixed_amount_promotions/{fixedAmountPromotionId}/order_amount_promotion_rule
Retrieve the order amount promotion rule associated to the fixed amount promotion
#
GET
/fixed_amount_promotions/{fixedAmountPromotionId}/sku_list_promotion_rule
Retrieve the sku list promotion rule associated to the fixed amount promotion
#
GET
/fixed_amount_promotions/{fixedAmountPromotionId}/coupon_codes_promotion_rule
Retrieve the coupon codes promotion rule associated to the fixed amount promotion
#
GET
/fixed_amount_promotions/{fixedAmountPromotionId}/custom_promotion_rule
Retrieve the custom promotion rule associated to the fixed amount promotion
#
GET
/fixed_amount_promotions/{fixedAmountPromotionId}/sku_list
Retrieve the sku list associated to the fixed amount promotion
#
GET
/fixed_price_promotions/{fixedPricePromotionId}/market
Retrieve the market associated to the fixed price promotion
#
GET
/fixed_price_promotions/{fixedPricePromotionId}/order_amount_promotion_rule
Retrieve the order amount promotion rule associated to the fixed price promotion
#
GET
/fixed_price_promotions/{fixedPricePromotionId}/sku_list_promotion_rule
Retrieve the sku list promotion rule associated to the fixed price promotion
#
GET
/fixed_price_promotions/{fixedPricePromotionId}/coupon_codes_promotion_rule
Retrieve the coupon codes promotion rule associated to the fixed price promotion
#
GET
/fixed_price_promotions/{fixedPricePromotionId}/custom_promotion_rule
Retrieve the custom promotion rule associated to the fixed price promotion
#
GET
/fixed_price_promotions/{fixedPricePromotionId}/sku_list
Retrieve the sku list associated to the fixed price promotion
#
GET
/flex_promotions/{flexPromotionId}/coupon_codes_promotion_rule
Retrieve the coupon codes promotion rule associated to the flex promotion
#
GET
/free_gift_promotions/{freeGiftPromotionId}/market
Retrieve the market associated to the free gift promotion
#
GET
/free_gift_promotions/{freeGiftPromotionId}/order_amount_promotion_rule
Retrieve the order amount promotion rule associated to the free gift promotion
#
GET
/free_gift_promotions/{freeGiftPromotionId}/sku_list_promotion_rule
Retrieve the sku list promotion rule associated to the free gift promotion
#
GET
/free_gift_promotions/{freeGiftPromotionId}/coupon_codes_promotion_rule
Retrieve the coupon codes promotion rule associated to the free gift promotion
#
GET
/free_gift_promotions/{freeGiftPromotionId}/custom_promotion_rule
Retrieve the custom promotion rule associated to the free gift promotion
#
GET
/free_gift_promotions/{freeGiftPromotionId}/sku_list
Retrieve the sku list associated to the free gift promotion
#
GET
/free_shipping_promotions/{freeShippingPromotionId}/market
Retrieve the market associated to the free shipping promotion
#
GET
/free_shipping_promotions/{freeShippingPromotionId}/order_amount_promotion_rule
Retrieve the order amount promotion rule associated to the free shipping promotion
#
GET
/free_shipping_promotions/{freeShippingPromotionId}/sku_list_promotion_rule
Retrieve the sku list promotion rule associated to the free shipping promotion
#
GET
/free_shipping_promotions/{freeShippingPromotionId}/coupon_codes_promotion_rule
Retrieve the coupon codes promotion rule associated to the free shipping promotion
#
GET
/free_shipping_promotions/{freeShippingPromotionId}/custom_promotion_rule
Retrieve the custom promotion rule associated to the free shipping promotion
#
GET
/free_shipping_promotions/{freeShippingPromotionId}/sku_list
Retrieve the sku list associated to the free shipping promotion
#
GET
/gift_card_recipients/{giftCardRecipientId}/customer
Retrieve the customer associated to the gift card recipient
#
GET
/gift_cards/{giftCardId}/gift_card_recipient
Retrieve the gift card recipient associated to the gift card
#
GET
/in_stock_subscriptions/{inStockSubscriptionId}/market
Retrieve the market associated to the in stock subscription
#
GET
/in_stock_subscriptions/{inStockSubscriptionId}/customer
Retrieve the customer associated to the in stock subscription
#
GET
/in_stock_subscriptions/{inStockSubscriptionId}/sku
Retrieve the sku associated to the in stock subscription
#
GET
/inventory_return_locations/{inventoryReturnLocationId}/stock_location
Retrieve the stock location associated to the inventory return location
#
GET
/inventory_return_locations/{inventoryReturnLocationId}/inventory_model
Retrieve the inventory model associated to the inventory return location
#
GET
/inventory_stock_locations/{inventoryStockLocationId}/stock_location
Retrieve the stock location associated to the inventory stock location
#
GET
/inventory_stock_locations/{inventoryStockLocationId}/inventory_model
Retrieve the inventory model associated to the inventory stock location
#
GET
/klarna_payments/{klarnaPaymentId}/payment_gateway
Retrieve the payment gateway associated to the klarna payment
#
GET
/line_item_options/{lineItemOptionId}/line_item
Retrieve the line item associated to the line item option
#
GET
/line_item_options/{lineItemOptionId}/sku_option
Retrieve the sku option associated to the line item option
#
GET
/markets/{marketId}/subscription_model
Retrieve the subscription model associated to the market
#
GET
/markets/{marketId}/default_shipping_method
Retrieve the default shipping method associated to the market
#
GET
/markets/{marketId}/default_payment_method
Retrieve the default payment method associated to the market
#
GET
/order_copies/{orderCopyId}/source_order
Retrieve the source order associated to the order copy
#
GET
/order_copies/{orderCopyId}/target_order
Retrieve the target order associated to the order copy
#
GET
/order_copies/{orderCopyId}/order_subscription
Retrieve the order subscription associated to the order copy
#
GET
/order_factories/{orderFactoryId}/source_order
Retrieve the source order associated to the order factory
#
GET
/order_factories/{orderFactoryId}/target_order
Retrieve the target order associated to the order factory
#
GET
/order_subscription_items/{orderSubscriptionItemId}/order_subscription
Retrieve the order subscription associated to the order subscription item
#
GET
/order_subscription_items/{orderSubscriptionItemId}/source_line_item
Retrieve the source line item associated to the order subscription item
#
GET
/order_subscriptions/{orderSubscriptionId}/market
Retrieve the market associated to the order subscription
#
GET
/order_subscriptions/{orderSubscriptionId}/subscription_model
Retrieve the subscription model associated to the order subscription
#
GET
/order_subscriptions/{orderSubscriptionId}/source_order
Retrieve the source order associated to the order subscription
#
GET
/order_subscriptions/{orderSubscriptionId}/customer
Retrieve the customer associated to the order subscription
#
GET
/order_subscriptions/{orderSubscriptionId}/customer_payment_source
Retrieve the customer payment source associated to the order subscription
#
GET
/orders/{orderId}/default_shipping_method
Retrieve the default shipping method associated to the order
#
GET
/orders/{orderId}/default_payment_method
Retrieve the default payment method associated to the order
#
GET
/orders/{orderId}/discount_engine_item
Retrieve the discount engine item associated to the order
#
GET
/parcel_line_items/{parcelLineItemId}/parcel
Retrieve the parcel associated to the parcel line item
#
GET
/parcel_line_items/{parcelLineItemId}/stock_line_item
Retrieve the stock line item associated to the parcel line item
#
GET
/payment_methods/{paymentMethodId}/market
Retrieve the market associated to the payment method
#
GET
/payment_methods/{paymentMethodId}/payment_gateway
Retrieve the payment gateway associated to the payment method
#
GET
/paypal_payments/{paypalPaymentId}/payment_gateway
Retrieve the payment gateway associated to the paypal payment
#
GET
/percentage_discount_promotions/{percentageDiscountPromotionId}/market
Retrieve the market associated to the percentage discount promotion
#
GET
/percentage_discount_promotions/{percentageDiscountPromotionId}/order_amount_promotion_rule
Retrieve the order amount promotion rule associated to the percentage discount promotion
#
GET
/percentage_discount_promotions/{percentageDiscountPromotionId}/sku_list_promotion_rule
Retrieve the sku list promotion rule associated to the percentage discount promotion
#
GET
/percentage_discount_promotions/{percentageDiscountPromotionId}/coupon_codes_promotion_rule
Retrieve the coupon codes promotion rule associated to the percentage discount promotion
#
GET
/percentage_discount_promotions/{percentageDiscountPromotionId}/custom_promotion_rule
Retrieve the custom promotion rule associated to the percentage discount promotion
#
GET
/percentage_discount_promotions/{percentageDiscountPromotionId}/sku_list
Retrieve the sku list associated to the percentage discount promotion
#
GET
/price_frequency_tiers/{priceFrequencyTierId}/price
Retrieve the price associated to the price frequency tier
#
GET
/price_list_schedulers/{priceListSchedulerId}/market
Retrieve the market associated to the price list scheduler
#
GET
/price_list_schedulers/{priceListSchedulerId}/price_list
Retrieve the price list associated to the price list scheduler
#
GET
/price_volume_tiers/{priceVolumeTierId}/price
Retrieve the price associated to the price volume tier
#
GET
/promotions/{promotionId}/order_amount_promotion_rule
Retrieve the order amount promotion rule associated to the promotion
#
GET
/promotions/{promotionId}/sku_list_promotion_rule
Retrieve the sku list promotion rule associated to the promotion
#
GET
/promotions/{promotionId}/coupon_codes_promotion_rule
Retrieve the coupon codes promotion rule associated to the promotion
#
GET
/promotions/{promotionId}/custom_promotion_rule
Retrieve the custom promotion rule associated to the promotion
#
GET
/recurring_order_copies/{recurringOrderCopyId}/source_order
Retrieve the source order associated to the recurring order copy
#
GET
/recurring_order_copies/{recurringOrderCopyId}/target_order
Retrieve the target order associated to the recurring order copy
#
GET
/recurring_order_copies/{recurringOrderCopyId}/order_subscription
Retrieve the order subscription associated to the recurring order copy
#
GET
/reserved_stocks/{reservedStockId}/stock_item
Retrieve the stock item associated to the reserved stock
#
GET
/return_line_items/{returnLineItemId}/return
Retrieve the return associated to the return line item
#
GET
/return_line_items/{returnLineItemId}/line_item
Retrieve the line item associated to the return line item
#
GET
/returns/{returnId}/destination_address
Retrieve the destination address associated to the return
#
GET
/satispay_payments/{satispayPaymentId}/order
Retrieve the order associated to the satispay payment
#
GET
/satispay_payments/{satispayPaymentId}/payment_gateway
Retrieve the payment gateway associated to the satispay payment
#
GET
/shipments/{shipmentId}/shipping_category
Retrieve the shipping category associated to the shipment
#
GET
/shipments/{shipmentId}/inventory_stock_location
Retrieve the inventory stock location associated to the shipment
#
GET
/shipments/{shipmentId}/shipping_address
Retrieve the shipping address associated to the shipment
#
GET
/shipments/{shipmentId}/shipping_method
Retrieve the shipping method associated to the shipment
#
GET
/shipments/{shipmentId}/delivery_lead_time
Retrieve the delivery lead time associated to the shipment
#
GET
/shipping_method_tiers/{shippingMethodTierId}/shipping_method
Retrieve the shipping method associated to the shipping method tier
#
GET
/shipping_methods/{shippingMethodId}/market
Retrieve the market associated to the shipping method
#
GET
/shipping_methods/{shippingMethodId}/shipping_zone
Retrieve the shipping zone associated to the shipping method
#
GET
/shipping_methods/{shippingMethodId}/shipping_category
Retrieve the shipping category associated to the shipping method
#
GET
/shipping_methods/{shippingMethodId}/stock_location
Retrieve the stock location associated to the shipping method
#
GET
/shipping_methods/{shippingMethodId}/delivery_lead_time_for_shipment
Retrieve the delivery lead time for shipment associated to the shipping method
#
GET
/shipping_weight_tiers/{shippingWeightTierId}/shipping_method
Retrieve the shipping method associated to the shipping weight tier
#
GET
/sku_list_items/{skuListItemId}/sku_list
Retrieve the sku list associated to the SKU list item
#
GET
/sku_list_promotion_rules/{skuListPromotionRuleId}/sku_list
Retrieve the sku list associated to the SKU list promotion rule
#
GET
/stock_items/{stockItemId}/stock_location
Retrieve the stock location associated to the stock item
#
GET
/stock_items/{stockItemId}/reserved_stock
Retrieve the reserved stock associated to the stock item
#
GET
/stock_line_items/{stockLineItemId}/shipment
Retrieve the shipment associated to the stock line item
#
GET
/stock_line_items/{stockLineItemId}/line_item
Retrieve the line item associated to the stock line item
#
GET
/stock_line_items/{stockLineItemId}/stock_item
Retrieve the stock item associated to the stock line item
#
GET
/stock_line_items/{stockLineItemId}/stock_reservation
Retrieve the stock reservation associated to the stock line item
#
GET
/stock_locations/{stockLocationId}/address
Retrieve the address associated to the stock location
#
GET
/stock_reservations/{stockReservationId}/line_item
Retrieve the line item associated to the stock reservation
#
GET
/stock_reservations/{stockReservationId}/order
Retrieve the order associated to the stock reservation
#
GET
/stock_reservations/{stockReservationId}/stock_line_item
Retrieve the stock line item associated to the stock reservation
#
GET
/stock_reservations/{stockReservationId}/stock_transfer
Retrieve the stock transfer associated to the stock reservation
#
GET
/stock_reservations/{stockReservationId}/stock_item
Retrieve the stock item associated to the stock reservation
#
GET
/stock_reservations/{stockReservationId}/reserved_stock
Retrieve the reserved stock associated to the stock reservation
#
GET
/stock_reservations/{stockReservationId}/sku
Retrieve the sku associated to the stock reservation
#
GET
/stock_transfers/{stockTransferId}/origin_stock_location
Retrieve the origin stock location associated to the stock transfer
#
GET
/stock_transfers/{stockTransferId}/destination_stock_location
Retrieve the destination stock location associated to the stock transfer
#
GET
/stock_transfers/{stockTransferId}/shipment
Retrieve the shipment associated to the stock transfer
#
GET
/stock_transfers/{stockTransferId}/line_item
Retrieve the line item associated to the stock transfer
#
GET
/stock_transfers/{stockTransferId}/stock_reservation
Retrieve the stock reservation associated to the stock transfer
#
GET
/stripe_payments/{stripePaymentId}/payment_gateway
Retrieve the payment gateway associated to the stripe payment
#
GET
/tax_rules/{taxRuleId}/manual_tax_calculator
Retrieve the manual tax calculator associated to the tax rule
#
GET
/voids/{voidId}/reference_authorization
Retrieve the reference authorization associated to the void
#
GET
/application_memberships/{applicationMembershipId}/api_credential
Related application membership
#
GET
/application_memberships/{applicationMembershipId}/membership_profile
Related application membership
#
GET
/application_memberships/{applicationMembershipId}/organization
Related application membership
#
Documentation
📖
Documentation
https://docs.commercelayer.io/core/
📖
Documentation
https://docs.commercelayer.io/core-api-reference/
📖
Documentation
https://docs.commercelayer.io/core/api-specification
📖
Authentication
https://docs.commercelayer.io/core/authentication
📖
RateLimits
https://docs.commercelayer.io/core/rate-limits
📖
Documentation
https://docs.commercelayer.io/core/event-stream-hub
📖
Documentation
https://docs.commercelayer.io/provisioning
📖
Documentation
https://docs.commercelayer.io/provisioning-api-reference/
📖
Documentation
https://docs.commercelayer.io/metrics/welcome
📖
Documentation
https://docs.commercelayer.io/metrics/getting-started/api-specification
Specifications
Schemas & Data
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/commerce-layer/refs/heads/main/json-schema/commerce-layer-order-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/commerce-layer/refs/heads/main/json-schema/commerce-layer-sku-schema.json
Other Resources
🔗
Webhooks
https://docs.commercelayer.io/core/real-time-webhooks
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/commerce-layer/refs/heads/main/json-ld/commerce-layer-context.jsonld
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/commerce-layer/refs/heads/main/graphql/commerce-layer-graphql.md