openapi: 3.1.0 info: title: Commerce Layer addresses has_one API version: 7.10.1 contact: name: API Support url: https://commercelayer.io email: support@commercelayer.io description: Headless Commerce for Global Brands. servers: - url: https://{your_organization_slug}.commercelayer.io/api description: API - url: https://core.commercelayer.io/users/sign_in description: Sign in - url: https://docs.commercelayer.io/api description: API reference security: - bearerAuth: [] tags: - name: has_one description: relationship kind paths: /addresses/{addressId}/geocoder: get: operationId: GET/addressId/geocoder summary: Retrieve the geocoder associated to the address description: Retrieve the geocoder associated to the address tags: - has_one parameters: - name: addressId in: path schema: type: string required: true description: The resource's id responses: '200': description: The geocoder associated to the address /adyen_payments/{adyenPaymentId}/order: get: operationId: GET/adyenPaymentId/order summary: Retrieve the order associated to the adyen payment description: Retrieve the order associated to the adyen payment tags: - has_one parameters: - name: adyenPaymentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order associated to the adyen payment /adyen_payments/{adyenPaymentId}/payment_gateway: get: operationId: GET/adyenPaymentId/payment_gateway summary: Retrieve the payment gateway associated to the adyen payment description: Retrieve the payment gateway associated to the adyen payment tags: - has_one parameters: - name: adyenPaymentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The payment_gateway associated to the adyen payment /authorizations/{authorizationId}/order: get: operationId: GET/authorizationId/order summary: Retrieve the order associated to the authorization description: Retrieve the order associated to the authorization tags: - has_one parameters: - name: authorizationId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order associated to the authorization /axerve_payments/{axervePaymentId}/order: get: operationId: GET/axervePaymentId/order summary: Retrieve the order associated to the axerve payment description: Retrieve the order associated to the axerve payment tags: - has_one parameters: - name: axervePaymentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order associated to the axerve payment /axerve_payments/{axervePaymentId}/payment_gateway: get: operationId: GET/axervePaymentId/payment_gateway summary: Retrieve the payment gateway associated to the axerve payment description: Retrieve the payment gateway associated to the axerve payment tags: - has_one parameters: - name: axervePaymentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The payment_gateway associated to the axerve payment /braintree_payments/{braintreePaymentId}/order: get: operationId: GET/braintreePaymentId/order summary: Retrieve the order associated to the braintree payment description: Retrieve the order associated to the braintree payment tags: - has_one parameters: - name: braintreePaymentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order associated to the braintree payment /braintree_payments/{braintreePaymentId}/payment_gateway: get: operationId: GET/braintreePaymentId/payment_gateway summary: Retrieve the payment gateway associated to the braintree payment description: Retrieve the payment gateway associated to the braintree payment tags: - has_one parameters: - name: braintreePaymentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The payment_gateway associated to the braintree payment /bundles/{bundleId}/market: get: operationId: GET/bundleId/market summary: Retrieve the market associated to the bundle description: Retrieve the market associated to the bundle tags: - has_one parameters: - name: bundleId in: path schema: type: string required: true description: The resource's id responses: '200': description: The market associated to the bundle /bundles/{bundleId}/sku_list: get: operationId: GET/bundleId/sku_list summary: Retrieve the sku list associated to the bundle description: Retrieve the sku list associated to the bundle tags: - has_one parameters: - name: bundleId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku_list associated to the bundle /buy_x_pay_y_promotions/{buyXPayYPromotionId}/market: get: operationId: GET/buyXPayYPromotionId/market summary: Retrieve the market associated to the buy x pay y promotion description: Retrieve the market associated to the buy x pay y promotion tags: - has_one parameters: - name: buyXPayYPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The market associated to the buy x pay y promotion /buy_x_pay_y_promotions/{buyXPayYPromotionId}/order_amount_promotion_rule: get: operationId: GET/buyXPayYPromotionId/order_amount_promotion_rule summary: Retrieve the order amount promotion rule associated to the buy x pay y promotion description: Retrieve the order amount promotion rule associated to the buy x pay y promotion tags: - has_one parameters: - name: buyXPayYPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order_amount_promotion_rule associated to the buy x pay y promotion /buy_x_pay_y_promotions/{buyXPayYPromotionId}/sku_list_promotion_rule: get: operationId: GET/buyXPayYPromotionId/sku_list_promotion_rule summary: Retrieve the sku list promotion rule associated to the buy x pay y promotion description: Retrieve the sku list promotion rule associated to the buy x pay y promotion tags: - has_one parameters: - name: buyXPayYPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku_list_promotion_rule associated to the buy x pay y promotion /buy_x_pay_y_promotions/{buyXPayYPromotionId}/coupon_codes_promotion_rule: get: operationId: GET/buyXPayYPromotionId/coupon_codes_promotion_rule summary: Retrieve the coupon codes promotion rule associated to the buy x pay y promotion description: Retrieve the coupon codes promotion rule associated to the buy x pay y promotion tags: - has_one parameters: - name: buyXPayYPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The coupon_codes_promotion_rule associated to the buy x pay y promotion /buy_x_pay_y_promotions/{buyXPayYPromotionId}/custom_promotion_rule: get: operationId: GET/buyXPayYPromotionId/custom_promotion_rule summary: Retrieve the custom promotion rule associated to the buy x pay y promotion description: Retrieve the custom promotion rule associated to the buy x pay y promotion tags: - has_one parameters: - name: buyXPayYPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The custom_promotion_rule associated to the buy x pay y promotion /buy_x_pay_y_promotions/{buyXPayYPromotionId}/sku_list: get: operationId: GET/buyXPayYPromotionId/sku_list summary: Retrieve the sku list associated to the buy x pay y promotion description: Retrieve the sku list associated to the buy x pay y promotion tags: - has_one parameters: - name: buyXPayYPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku_list associated to the buy x pay y promotion /captures/{captureId}/order: get: operationId: GET/captureId/order summary: Retrieve the order associated to the capture description: Retrieve the order associated to the capture tags: - has_one parameters: - name: captureId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order associated to the capture /captures/{captureId}/reference_authorization: get: operationId: GET/captureId/reference_authorization summary: Retrieve the reference authorization associated to the capture description: Retrieve the reference authorization associated to the capture tags: - has_one parameters: - name: captureId in: path schema: type: string required: true description: The resource's id responses: '200': description: The reference_authorization associated to the capture /captures/{captureId}/return: get: operationId: GET/captureId/return summary: Retrieve the return associated to the capture description: Retrieve the return associated to the capture tags: - has_one parameters: - name: captureId in: path schema: type: string required: true description: The resource's id responses: '200': description: The return associated to the capture /carrier_accounts/{carrierAccountId}/market: get: operationId: GET/carrierAccountId/market summary: Retrieve the market associated to the carrier account description: Retrieve the market associated to the carrier account tags: - has_one parameters: - name: carrierAccountId in: path schema: type: string required: true description: The resource's id responses: '200': description: The market associated to the carrier account /checkout_com_payments/{checkoutComPaymentId}/order: get: operationId: GET/checkoutComPaymentId/order summary: Retrieve the order associated to the checkout.com payment description: Retrieve the order associated to the checkout.com payment tags: - has_one parameters: - name: checkoutComPaymentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order associated to the checkout.com payment /checkout_com_payments/{checkoutComPaymentId}/payment_gateway: get: operationId: GET/checkoutComPaymentId/payment_gateway summary: Retrieve the payment gateway associated to the checkout.com payment description: Retrieve the payment gateway associated to the checkout.com payment tags: - has_one parameters: - name: checkoutComPaymentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The payment_gateway associated to the checkout.com payment /coupon_recipients/{couponRecipientId}/customer: get: operationId: GET/couponRecipientId/customer summary: Retrieve the customer associated to the coupon recipient description: Retrieve the customer associated to the coupon recipient tags: - has_one parameters: - name: couponRecipientId in: path schema: type: string required: true description: The resource's id responses: '200': description: The customer associated to the coupon recipient /coupons/{couponId}/promotion_rule: get: operationId: GET/couponId/promotion_rule summary: Retrieve the promotion rule associated to the coupon description: Retrieve the promotion rule associated to the coupon tags: - has_one parameters: - name: couponId in: path schema: type: string required: true description: The resource's id responses: '200': description: The promotion_rule associated to the coupon /coupons/{couponId}/coupon_recipient: get: operationId: GET/couponId/coupon_recipient summary: Retrieve the coupon recipient associated to the coupon description: Retrieve the coupon recipient associated to the coupon tags: - has_one parameters: - name: couponId in: path schema: type: string required: true description: The resource's id responses: '200': description: The coupon_recipient associated to the coupon /customer_addresses/{customerAddressId}/customer: get: operationId: GET/customerAddressId/customer summary: Retrieve the customer associated to the customer address description: Retrieve the customer associated to the customer address tags: - has_one parameters: - name: customerAddressId in: path schema: type: string required: true description: The resource's id responses: '200': description: The customer associated to the customer address /customer_addresses/{customerAddressId}/address: get: operationId: GET/customerAddressId/address summary: Retrieve the address associated to the customer address description: Retrieve the address associated to the customer address tags: - has_one parameters: - name: customerAddressId in: path schema: type: string required: true description: The resource's id responses: '200': description: The address associated to the customer address /customer_password_resets/{customerPasswordResetId}/customer: get: operationId: GET/customerPasswordResetId/customer summary: Retrieve the customer associated to the customer password reset description: Retrieve the customer associated to the customer password reset tags: - has_one parameters: - name: customerPasswordResetId in: path schema: type: string required: true description: The resource's id responses: '200': description: The customer associated to the customer password reset /customer_payment_sources/{customerPaymentSourceId}/customer: get: operationId: GET/customerPaymentSourceId/customer summary: Retrieve the customer associated to the customer payment source description: Retrieve the customer associated to the customer payment source tags: - has_one parameters: - name: customerPaymentSourceId in: path schema: type: string required: true description: The resource's id responses: '200': description: The customer associated to the customer payment source /customer_payment_sources/{customerPaymentSourceId}/payment_method: get: operationId: GET/customerPaymentSourceId/payment_method summary: Retrieve the payment method associated to the customer payment source description: Retrieve the payment method associated to the customer payment source tags: - has_one parameters: - name: customerPaymentSourceId in: path schema: type: string required: true description: The resource's id responses: '200': description: The payment_method associated to the customer payment source /customer_subscriptions/{customerSubscriptionId}/customer: get: operationId: GET/customerSubscriptionId/customer summary: Retrieve the customer associated to the customer subscription description: Retrieve the customer associated to the customer subscription tags: - has_one parameters: - name: customerSubscriptionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The customer associated to the customer subscription /customers/{customerId}/customer_group: get: operationId: GET/customerId/customer_group summary: Retrieve the customer group associated to the customer description: Retrieve the customer group associated to the customer tags: - has_one parameters: - name: customerId in: path schema: type: string required: true description: The resource's id responses: '200': description: The customer_group associated to the customer /customers/{customerId}/jwt_customer: get: operationId: GET/customerId/jwt_customer summary: Retrieve the jwt customer associated to the customer description: Retrieve the jwt customer associated to the customer tags: - has_one parameters: - name: customerId in: path schema: type: string required: true description: The resource's id responses: '200': description: The jwt_customer associated to the customer /delivery_lead_times/{deliveryLeadTimeId}/stock_location: get: operationId: GET/deliveryLeadTimeId/stock_location summary: Retrieve the stock location associated to the delivery lead time description: Retrieve the stock location associated to the delivery lead time tags: - has_one parameters: - name: deliveryLeadTimeId in: path schema: type: string required: true description: The resource's id responses: '200': description: The stock_location associated to the delivery lead time /delivery_lead_times/{deliveryLeadTimeId}/shipping_method: get: operationId: GET/deliveryLeadTimeId/shipping_method summary: Retrieve the shipping method associated to the delivery lead time description: Retrieve the shipping method associated to the delivery lead time tags: - has_one parameters: - name: deliveryLeadTimeId in: path schema: type: string required: true description: The resource's id responses: '200': description: The shipping_method associated to the delivery lead time /discount_engine_items/{discountEngineItemId}/discount_engine: get: operationId: GET/discountEngineItemId/discount_engine summary: Retrieve the discount engine associated to the discount engine item description: Retrieve the discount engine associated to the discount engine item tags: - has_one parameters: - name: discountEngineItemId in: path schema: type: string required: true description: The resource's id responses: '200': description: The discount_engine associated to the discount engine item /discount_engine_items/{discountEngineItemId}/order: get: operationId: GET/discountEngineItemId/order summary: Retrieve the order associated to the discount engine item description: Retrieve the order associated to the discount engine item tags: - has_one parameters: - name: discountEngineItemId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order associated to the discount engine item /easypost_pickups/{easypostPickupId}/shipment: get: operationId: GET/easypostPickupId/shipment summary: Retrieve the shipment associated to the easypost pickup description: Retrieve the shipment associated to the easypost pickup tags: - has_one parameters: - name: easypostPickupId in: path schema: type: string required: true description: The resource's id responses: '200': description: The shipment associated to the easypost pickup /event_callbacks/{eventCallbackId}/webhook: get: operationId: GET/eventCallbackId/webhook summary: Retrieve the webhook associated to the event callback description: Retrieve the webhook associated to the event callback tags: - has_one parameters: - name: eventCallbackId in: path schema: type: string required: true description: The resource's id responses: '200': description: The webhook associated to the event callback /external_payments/{externalPaymentId}/order: get: operationId: GET/externalPaymentId/order summary: Retrieve the order associated to the external payment description: Retrieve the order associated to the external payment tags: - has_one parameters: - name: externalPaymentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order associated to the external payment /external_payments/{externalPaymentId}/payment_gateway: get: operationId: GET/externalPaymentId/payment_gateway summary: Retrieve the payment gateway associated to the external payment description: Retrieve the payment gateway associated to the external payment tags: - has_one parameters: - name: externalPaymentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The payment_gateway associated to the external payment /external_payments/{externalPaymentId}/wallet: get: operationId: GET/externalPaymentId/wallet summary: Retrieve the wallet associated to the external payment description: Retrieve the wallet associated to the external payment tags: - has_one parameters: - name: externalPaymentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The wallet associated to the external payment /external_promotions/{externalPromotionId}/market: get: operationId: GET/externalPromotionId/market summary: Retrieve the market associated to the external promotion description: Retrieve the market associated to the external promotion tags: - has_one parameters: - name: externalPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The market associated to the external promotion /external_promotions/{externalPromotionId}/order_amount_promotion_rule: get: operationId: GET/externalPromotionId/order_amount_promotion_rule summary: Retrieve the order amount promotion rule associated to the external promotion description: Retrieve the order amount promotion rule associated to the external promotion tags: - has_one parameters: - name: externalPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order_amount_promotion_rule associated to the external promotion /external_promotions/{externalPromotionId}/sku_list_promotion_rule: get: operationId: GET/externalPromotionId/sku_list_promotion_rule summary: Retrieve the sku list promotion rule associated to the external promotion description: Retrieve the sku list promotion rule associated to the external promotion tags: - has_one parameters: - name: externalPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku_list_promotion_rule associated to the external promotion /external_promotions/{externalPromotionId}/coupon_codes_promotion_rule: get: operationId: GET/externalPromotionId/coupon_codes_promotion_rule summary: Retrieve the coupon codes promotion rule associated to the external promotion description: Retrieve the coupon codes promotion rule associated to the external promotion tags: - has_one parameters: - name: externalPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The coupon_codes_promotion_rule associated to the external promotion /external_promotions/{externalPromotionId}/custom_promotion_rule: get: operationId: GET/externalPromotionId/custom_promotion_rule summary: Retrieve the custom promotion rule associated to the external promotion description: Retrieve the custom promotion rule associated to the external promotion tags: - has_one parameters: - name: externalPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The custom_promotion_rule associated to the external promotion /external_promotions/{externalPromotionId}/sku_list: get: operationId: GET/externalPromotionId/sku_list summary: Retrieve the sku list associated to the external promotion description: Retrieve the sku list associated to the external promotion tags: - has_one parameters: - name: externalPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku_list associated to the external promotion /fixed_amount_promotions/{fixedAmountPromotionId}/market: get: operationId: GET/fixedAmountPromotionId/market summary: Retrieve the market associated to the fixed amount promotion description: Retrieve the market associated to the fixed amount promotion tags: - has_one parameters: - name: fixedAmountPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The market associated to the fixed amount promotion /fixed_amount_promotions/{fixedAmountPromotionId}/order_amount_promotion_rule: get: operationId: GET/fixedAmountPromotionId/order_amount_promotion_rule summary: Retrieve the order amount promotion rule associated to the fixed amount promotion description: Retrieve the order amount promotion rule associated to the fixed amount promotion tags: - has_one parameters: - name: fixedAmountPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order_amount_promotion_rule associated to the fixed amount promotion /fixed_amount_promotions/{fixedAmountPromotionId}/sku_list_promotion_rule: get: operationId: GET/fixedAmountPromotionId/sku_list_promotion_rule summary: Retrieve the sku list promotion rule associated to the fixed amount promotion description: Retrieve the sku list promotion rule associated to the fixed amount promotion tags: - has_one parameters: - name: fixedAmountPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku_list_promotion_rule associated to the fixed amount promotion /fixed_amount_promotions/{fixedAmountPromotionId}/coupon_codes_promotion_rule: get: operationId: GET/fixedAmountPromotionId/coupon_codes_promotion_rule summary: Retrieve the coupon codes promotion rule associated to the fixed amount promotion description: Retrieve the coupon codes promotion rule associated to the fixed amount promotion tags: - has_one parameters: - name: fixedAmountPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The coupon_codes_promotion_rule associated to the fixed amount promotion /fixed_amount_promotions/{fixedAmountPromotionId}/custom_promotion_rule: get: operationId: GET/fixedAmountPromotionId/custom_promotion_rule summary: Retrieve the custom promotion rule associated to the fixed amount promotion description: Retrieve the custom promotion rule associated to the fixed amount promotion tags: - has_one parameters: - name: fixedAmountPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The custom_promotion_rule associated to the fixed amount promotion /fixed_amount_promotions/{fixedAmountPromotionId}/sku_list: get: operationId: GET/fixedAmountPromotionId/sku_list summary: Retrieve the sku list associated to the fixed amount promotion description: Retrieve the sku list associated to the fixed amount promotion tags: - has_one parameters: - name: fixedAmountPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku_list associated to the fixed amount promotion /fixed_price_promotions/{fixedPricePromotionId}/market: get: operationId: GET/fixedPricePromotionId/market summary: Retrieve the market associated to the fixed price promotion description: Retrieve the market associated to the fixed price promotion tags: - has_one parameters: - name: fixedPricePromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The market associated to the fixed price promotion /fixed_price_promotions/{fixedPricePromotionId}/order_amount_promotion_rule: get: operationId: GET/fixedPricePromotionId/order_amount_promotion_rule summary: Retrieve the order amount promotion rule associated to the fixed price promotion description: Retrieve the order amount promotion rule associated to the fixed price promotion tags: - has_one parameters: - name: fixedPricePromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order_amount_promotion_rule associated to the fixed price promotion /fixed_price_promotions/{fixedPricePromotionId}/sku_list_promotion_rule: get: operationId: GET/fixedPricePromotionId/sku_list_promotion_rule summary: Retrieve the sku list promotion rule associated to the fixed price promotion description: Retrieve the sku list promotion rule associated to the fixed price promotion tags: - has_one parameters: - name: fixedPricePromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku_list_promotion_rule associated to the fixed price promotion /fixed_price_promotions/{fixedPricePromotionId}/coupon_codes_promotion_rule: get: operationId: GET/fixedPricePromotionId/coupon_codes_promotion_rule summary: Retrieve the coupon codes promotion rule associated to the fixed price promotion description: Retrieve the coupon codes promotion rule associated to the fixed price promotion tags: - has_one parameters: - name: fixedPricePromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The coupon_codes_promotion_rule associated to the fixed price promotion /fixed_price_promotions/{fixedPricePromotionId}/custom_promotion_rule: get: operationId: GET/fixedPricePromotionId/custom_promotion_rule summary: Retrieve the custom promotion rule associated to the fixed price promotion description: Retrieve the custom promotion rule associated to the fixed price promotion tags: - has_one parameters: - name: fixedPricePromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The custom_promotion_rule associated to the fixed price promotion /fixed_price_promotions/{fixedPricePromotionId}/sku_list: get: operationId: GET/fixedPricePromotionId/sku_list summary: Retrieve the sku list associated to the fixed price promotion description: Retrieve the sku list associated to the fixed price promotion tags: - has_one parameters: - name: fixedPricePromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku_list associated to the fixed price promotion /flex_promotions/{flexPromotionId}/coupon_codes_promotion_rule: get: operationId: GET/flexPromotionId/coupon_codes_promotion_rule summary: Retrieve the coupon codes promotion rule associated to the flex promotion description: Retrieve the coupon codes promotion rule associated to the flex promotion tags: - has_one parameters: - name: flexPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The coupon_codes_promotion_rule associated to the flex promotion /free_gift_promotions/{freeGiftPromotionId}/market: get: operationId: GET/freeGiftPromotionId/market summary: Retrieve the market associated to the free gift promotion description: Retrieve the market associated to the free gift promotion tags: - has_one parameters: - name: freeGiftPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The market associated to the free gift promotion /free_gift_promotions/{freeGiftPromotionId}/order_amount_promotion_rule: get: operationId: GET/freeGiftPromotionId/order_amount_promotion_rule summary: Retrieve the order amount promotion rule associated to the free gift promotion description: Retrieve the order amount promotion rule associated to the free gift promotion tags: - has_one parameters: - name: freeGiftPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order_amount_promotion_rule associated to the free gift promotion /free_gift_promotions/{freeGiftPromotionId}/sku_list_promotion_rule: get: operationId: GET/freeGiftPromotionId/sku_list_promotion_rule summary: Retrieve the sku list promotion rule associated to the free gift promotion description: Retrieve the sku list promotion rule associated to the free gift promotion tags: - has_one parameters: - name: freeGiftPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku_list_promotion_rule associated to the free gift promotion /free_gift_promotions/{freeGiftPromotionId}/coupon_codes_promotion_rule: get: operationId: GET/freeGiftPromotionId/coupon_codes_promotion_rule summary: Retrieve the coupon codes promotion rule associated to the free gift promotion description: Retrieve the coupon codes promotion rule associated to the free gift promotion tags: - has_one parameters: - name: freeGiftPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The coupon_codes_promotion_rule associated to the free gift promotion /free_gift_promotions/{freeGiftPromotionId}/custom_promotion_rule: get: operationId: GET/freeGiftPromotionId/custom_promotion_rule summary: Retrieve the custom promotion rule associated to the free gift promotion description: Retrieve the custom promotion rule associated to the free gift promotion tags: - has_one parameters: - name: freeGiftPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The custom_promotion_rule associated to the free gift promotion /free_gift_promotions/{freeGiftPromotionId}/sku_list: get: operationId: GET/freeGiftPromotionId/sku_list summary: Retrieve the sku list associated to the free gift promotion description: Retrieve the sku list associated to the free gift promotion tags: - has_one parameters: - name: freeGiftPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku_list associated to the free gift promotion /free_shipping_promotions/{freeShippingPromotionId}/market: get: operationId: GET/freeShippingPromotionId/market summary: Retrieve the market associated to the free shipping promotion description: Retrieve the market associated to the free shipping promotion tags: - has_one parameters: - name: freeShippingPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The market associated to the free shipping promotion /free_shipping_promotions/{freeShippingPromotionId}/order_amount_promotion_rule: get: operationId: GET/freeShippingPromotionId/order_amount_promotion_rule summary: Retrieve the order amount promotion rule associated to the free shipping promotion description: Retrieve the order amount promotion rule associated to the free shipping promotion tags: - has_one parameters: - name: freeShippingPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order_amount_promotion_rule associated to the free shipping promotion /free_shipping_promotions/{freeShippingPromotionId}/sku_list_promotion_rule: get: operationId: GET/freeShippingPromotionId/sku_list_promotion_rule summary: Retrieve the sku list promotion rule associated to the free shipping promotion description: Retrieve the sku list promotion rule associated to the free shipping promotion tags: - has_one parameters: - name: freeShippingPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku_list_promotion_rule associated to the free shipping promotion /free_shipping_promotions/{freeShippingPromotionId}/coupon_codes_promotion_rule: get: operationId: GET/freeShippingPromotionId/coupon_codes_promotion_rule summary: Retrieve the coupon codes promotion rule associated to the free shipping promotion description: Retrieve the coupon codes promotion rule associated to the free shipping promotion tags: - has_one parameters: - name: freeShippingPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The coupon_codes_promotion_rule associated to the free shipping promotion /free_shipping_promotions/{freeShippingPromotionId}/custom_promotion_rule: get: operationId: GET/freeShippingPromotionId/custom_promotion_rule summary: Retrieve the custom promotion rule associated to the free shipping promotion description: Retrieve the custom promotion rule associated to the free shipping promotion tags: - has_one parameters: - name: freeShippingPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The custom_promotion_rule associated to the free shipping promotion /free_shipping_promotions/{freeShippingPromotionId}/sku_list: get: operationId: GET/freeShippingPromotionId/sku_list summary: Retrieve the sku list associated to the free shipping promotion description: Retrieve the sku list associated to the free shipping promotion tags: - has_one parameters: - name: freeShippingPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku_list associated to the free shipping promotion /gift_card_recipients/{giftCardRecipientId}/customer: get: operationId: GET/giftCardRecipientId/customer summary: Retrieve the customer associated to the gift card recipient description: Retrieve the customer associated to the gift card recipient tags: - has_one parameters: - name: giftCardRecipientId in: path schema: type: string required: true description: The resource's id responses: '200': description: The customer associated to the gift card recipient /gift_cards/{giftCardId}/market: get: operationId: GET/giftCardId/market summary: Retrieve the market associated to the gift card description: Retrieve the market associated to the gift card tags: - has_one parameters: - name: giftCardId in: path schema: type: string required: true description: The resource's id responses: '200': description: The market associated to the gift card /gift_cards/{giftCardId}/gift_card_recipient: get: operationId: GET/giftCardId/gift_card_recipient summary: Retrieve the gift card recipient associated to the gift card description: Retrieve the gift card recipient associated to the gift card tags: - has_one parameters: - name: giftCardId in: path schema: type: string required: true description: The resource's id responses: '200': description: The gift_card_recipient associated to the gift card /in_stock_subscriptions/{inStockSubscriptionId}/market: get: operationId: GET/inStockSubscriptionId/market summary: Retrieve the market associated to the in stock subscription description: Retrieve the market associated to the in stock subscription tags: - has_one parameters: - name: inStockSubscriptionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The market associated to the in stock subscription /in_stock_subscriptions/{inStockSubscriptionId}/customer: get: operationId: GET/inStockSubscriptionId/customer summary: Retrieve the customer associated to the in stock subscription description: Retrieve the customer associated to the in stock subscription tags: - has_one parameters: - name: inStockSubscriptionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The customer associated to the in stock subscription /in_stock_subscriptions/{inStockSubscriptionId}/sku: get: operationId: GET/inStockSubscriptionId/sku summary: Retrieve the sku associated to the in stock subscription description: Retrieve the sku associated to the in stock subscription tags: - has_one parameters: - name: inStockSubscriptionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku associated to the in stock subscription /inventory_return_locations/{inventoryReturnLocationId}/stock_location: get: operationId: GET/inventoryReturnLocationId/stock_location summary: Retrieve the stock location associated to the inventory return location description: Retrieve the stock location associated to the inventory return location tags: - has_one parameters: - name: inventoryReturnLocationId in: path schema: type: string required: true description: The resource's id responses: '200': description: The stock_location associated to the inventory return location /inventory_return_locations/{inventoryReturnLocationId}/inventory_model: get: operationId: GET/inventoryReturnLocationId/inventory_model summary: Retrieve the inventory model associated to the inventory return location description: Retrieve the inventory model associated to the inventory return location tags: - has_one parameters: - name: inventoryReturnLocationId in: path schema: type: string required: true description: The resource's id responses: '200': description: The inventory_model associated to the inventory return location /inventory_stock_locations/{inventoryStockLocationId}/stock_location: get: operationId: GET/inventoryStockLocationId/stock_location summary: Retrieve the stock location associated to the inventory stock location description: Retrieve the stock location associated to the inventory stock location tags: - has_one parameters: - name: inventoryStockLocationId in: path schema: type: string required: true description: The resource's id responses: '200': description: The stock_location associated to the inventory stock location /inventory_stock_locations/{inventoryStockLocationId}/inventory_model: get: operationId: GET/inventoryStockLocationId/inventory_model summary: Retrieve the inventory model associated to the inventory stock location description: Retrieve the inventory model associated to the inventory stock location tags: - has_one parameters: - name: inventoryStockLocationId in: path schema: type: string required: true description: The resource's id responses: '200': description: The inventory_model associated to the inventory stock location /klarna_payments/{klarnaPaymentId}/order: get: operationId: GET/klarnaPaymentId/order summary: Retrieve the order associated to the klarna payment description: Retrieve the order associated to the klarna payment tags: - has_one parameters: - name: klarnaPaymentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order associated to the klarna payment /klarna_payments/{klarnaPaymentId}/payment_gateway: get: operationId: GET/klarnaPaymentId/payment_gateway summary: Retrieve the payment gateway associated to the klarna payment description: Retrieve the payment gateway associated to the klarna payment tags: - has_one parameters: - name: klarnaPaymentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The payment_gateway associated to the klarna payment /line_item_options/{lineItemOptionId}/line_item: get: operationId: GET/lineItemOptionId/line_item summary: Retrieve the line item associated to the line item option description: Retrieve the line item associated to the line item option tags: - has_one parameters: - name: lineItemOptionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The line_item associated to the line item option /line_item_options/{lineItemOptionId}/sku_option: get: operationId: GET/lineItemOptionId/sku_option summary: Retrieve the sku option associated to the line item option description: Retrieve the sku option associated to the line item option tags: - has_one parameters: - name: lineItemOptionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku_option associated to the line item option /line_items/{lineItemId}/order: get: operationId: GET/lineItemId/order summary: Retrieve the order associated to the line item description: Retrieve the order associated to the line item tags: - has_one parameters: - name: lineItemId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order associated to the line item /markets/{marketId}/merchant: get: operationId: GET/marketId/merchant summary: Retrieve the merchant associated to the market description: Retrieve the merchant associated to the market tags: - has_one parameters: - name: marketId in: path schema: type: string required: true description: The resource's id responses: '200': description: The merchant associated to the market /markets/{marketId}/price_list: get: operationId: GET/marketId/price_list summary: Retrieve the price list associated to the market description: Retrieve the price list associated to the market tags: - has_one parameters: - name: marketId in: path schema: type: string required: true description: The resource's id responses: '200': description: The price_list associated to the market /markets/{marketId}/base_price_list: get: operationId: GET/marketId/base_price_list summary: Retrieve the base price list associated to the market description: Retrieve the base price list associated to the market tags: - has_one parameters: - name: marketId in: path schema: type: string required: true description: The resource's id responses: '200': description: The base_price_list associated to the market /markets/{marketId}/inventory_model: get: operationId: GET/marketId/inventory_model summary: Retrieve the inventory model associated to the market description: Retrieve the inventory model associated to the market tags: - has_one parameters: - name: marketId in: path schema: type: string required: true description: The resource's id responses: '200': description: The inventory_model associated to the market /markets/{marketId}/subscription_model: get: operationId: GET/marketId/subscription_model summary: Retrieve the subscription model associated to the market description: Retrieve the subscription model associated to the market tags: - has_one parameters: - name: marketId in: path schema: type: string required: true description: The resource's id responses: '200': description: The subscription_model associated to the market /markets/{marketId}/discount_engine: get: operationId: GET/marketId/discount_engine summary: Retrieve the discount engine associated to the market description: Retrieve the discount engine associated to the market tags: - has_one parameters: - name: marketId in: path schema: type: string required: true description: The resource's id responses: '200': description: The discount_engine associated to the market /markets/{marketId}/customer_group: get: operationId: GET/marketId/customer_group summary: Retrieve the customer group associated to the market description: Retrieve the customer group associated to the market tags: - has_one parameters: - name: marketId in: path schema: type: string required: true description: The resource's id responses: '200': description: The customer_group associated to the market /markets/{marketId}/geocoder: get: operationId: GET/marketId/geocoder summary: Retrieve the geocoder associated to the market description: Retrieve the geocoder associated to the market tags: - has_one parameters: - name: marketId in: path schema: type: string required: true description: The resource's id responses: '200': description: The geocoder associated to the market /markets/{marketId}/default_shipping_method: get: operationId: GET/marketId/default_shipping_method summary: Retrieve the default shipping method associated to the market description: Retrieve the default shipping method associated to the market tags: - has_one parameters: - name: marketId in: path schema: type: string required: true description: The resource's id responses: '200': description: The default_shipping_method associated to the market /markets/{marketId}/default_payment_method: get: operationId: GET/marketId/default_payment_method summary: Retrieve the default payment method associated to the market description: Retrieve the default payment method associated to the market tags: - has_one parameters: - name: marketId in: path schema: type: string required: true description: The resource's id responses: '200': description: The default_payment_method associated to the market /merchants/{merchantId}/address: get: operationId: GET/merchantId/address summary: Retrieve the address associated to the merchant description: Retrieve the address associated to the merchant tags: - has_one parameters: - name: merchantId in: path schema: type: string required: true description: The resource's id responses: '200': description: The address associated to the merchant /order_copies/{orderCopyId}/source_order: get: operationId: GET/orderCopyId/source_order summary: Retrieve the source order associated to the order copy description: Retrieve the source order associated to the order copy tags: - has_one parameters: - name: orderCopyId in: path schema: type: string required: true description: The resource's id responses: '200': description: The source_order associated to the order copy /order_copies/{orderCopyId}/target_order: get: operationId: GET/orderCopyId/target_order summary: Retrieve the target order associated to the order copy description: Retrieve the target order associated to the order copy tags: - has_one parameters: - name: orderCopyId in: path schema: type: string required: true description: The resource's id responses: '200': description: The target_order associated to the order copy /order_copies/{orderCopyId}/order_subscription: get: operationId: GET/orderCopyId/order_subscription summary: Retrieve the order subscription associated to the order copy description: Retrieve the order subscription associated to the order copy tags: - has_one parameters: - name: orderCopyId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order_subscription associated to the order copy /order_factories/{orderFactoryId}/source_order: get: operationId: GET/orderFactoryId/source_order summary: Retrieve the source order associated to the order factory description: Retrieve the source order associated to the order factory tags: - has_one parameters: - name: orderFactoryId in: path schema: type: string required: true description: The resource's id responses: '200': description: The source_order associated to the order factory /order_factories/{orderFactoryId}/target_order: get: operationId: GET/orderFactoryId/target_order summary: Retrieve the target order associated to the order factory description: Retrieve the target order associated to the order factory tags: - has_one parameters: - name: orderFactoryId in: path schema: type: string required: true description: The resource's id responses: '200': description: The target_order associated to the order factory /order_subscription_items/{orderSubscriptionItemId}/order_subscription: get: operationId: GET/orderSubscriptionItemId/order_subscription summary: Retrieve the order subscription associated to the order subscription item description: Retrieve the order subscription associated to the order subscription item tags: - has_one parameters: - name: orderSubscriptionItemId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order_subscription associated to the order subscription item /order_subscription_items/{orderSubscriptionItemId}/source_line_item: get: operationId: GET/orderSubscriptionItemId/source_line_item summary: Retrieve the source line item associated to the order subscription item description: Retrieve the source line item associated to the order subscription item tags: - has_one parameters: - name: orderSubscriptionItemId in: path schema: type: string required: true description: The resource's id responses: '200': description: The source_line_item associated to the order subscription item /order_subscriptions/{orderSubscriptionId}/market: get: operationId: GET/orderSubscriptionId/market summary: Retrieve the market associated to the order subscription description: Retrieve the market associated to the order subscription tags: - has_one parameters: - name: orderSubscriptionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The market associated to the order subscription /order_subscriptions/{orderSubscriptionId}/subscription_model: get: operationId: GET/orderSubscriptionId/subscription_model summary: Retrieve the subscription model associated to the order subscription description: Retrieve the subscription model associated to the order subscription tags: - has_one parameters: - name: orderSubscriptionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The subscription_model associated to the order subscription /order_subscriptions/{orderSubscriptionId}/source_order: get: operationId: GET/orderSubscriptionId/source_order summary: Retrieve the source order associated to the order subscription description: Retrieve the source order associated to the order subscription tags: - has_one parameters: - name: orderSubscriptionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The source_order associated to the order subscription /order_subscriptions/{orderSubscriptionId}/customer: get: operationId: GET/orderSubscriptionId/customer summary: Retrieve the customer associated to the order subscription description: Retrieve the customer associated to the order subscription tags: - has_one parameters: - name: orderSubscriptionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The customer associated to the order subscription /order_subscriptions/{orderSubscriptionId}/customer_payment_source: get: operationId: GET/orderSubscriptionId/customer_payment_source summary: Retrieve the customer payment source associated to the order subscription description: Retrieve the customer payment source associated to the order subscription tags: - has_one parameters: - name: orderSubscriptionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The customer_payment_source associated to the order subscription /orders/{orderId}/market: get: operationId: GET/orderId/market summary: Retrieve the market associated to the order description: Retrieve the market associated to the order tags: - has_one parameters: - name: orderId in: path schema: type: string required: true description: The resource's id responses: '200': description: The market associated to the order /orders/{orderId}/customer: get: operationId: GET/orderId/customer summary: Retrieve the customer associated to the order description: Retrieve the customer associated to the order tags: - has_one parameters: - name: orderId in: path schema: type: string required: true description: The resource's id responses: '200': description: The customer associated to the order /orders/{orderId}/shipping_address: get: operationId: GET/orderId/shipping_address summary: Retrieve the shipping address associated to the order description: Retrieve the shipping address associated to the order tags: - has_one parameters: - name: orderId in: path schema: type: string required: true description: The resource's id responses: '200': description: The shipping_address associated to the order /orders/{orderId}/billing_address: get: operationId: GET/orderId/billing_address summary: Retrieve the billing address associated to the order description: Retrieve the billing address associated to the order tags: - has_one parameters: - name: orderId in: path schema: type: string required: true description: The resource's id responses: '200': description: The billing_address associated to the order /orders/{orderId}/store: get: operationId: GET/orderId/store summary: Retrieve the store associated to the order description: Retrieve the store associated to the order tags: - has_one parameters: - name: orderId in: path schema: type: string required: true description: The resource's id responses: '200': description: The store associated to the order /orders/{orderId}/default_shipping_method: get: operationId: GET/orderId/default_shipping_method summary: Retrieve the default shipping method associated to the order description: Retrieve the default shipping method associated to the order tags: - has_one parameters: - name: orderId in: path schema: type: string required: true description: The resource's id responses: '200': description: The default_shipping_method associated to the order /orders/{orderId}/default_payment_method: get: operationId: GET/orderId/default_payment_method summary: Retrieve the default payment method associated to the order description: Retrieve the default payment method associated to the order tags: - has_one parameters: - name: orderId in: path schema: type: string required: true description: The resource's id responses: '200': description: The default_payment_method associated to the order /orders/{orderId}/payment_method: get: operationId: GET/orderId/payment_method summary: Retrieve the payment method associated to the order description: Retrieve the payment method associated to the order tags: - has_one parameters: - name: orderId in: path schema: type: string required: true description: The resource's id responses: '200': description: The payment_method associated to the order /orders/{orderId}/discount_engine_item: get: operationId: GET/orderId/discount_engine_item summary: Retrieve the discount engine item associated to the order description: Retrieve the discount engine item associated to the order tags: - has_one parameters: - name: orderId in: path schema: type: string required: true description: The resource's id responses: '200': description: The discount_engine_item associated to the order /orders/{orderId}/order_subscription: get: operationId: GET/orderId/order_subscription summary: Retrieve the order subscription associated to the order description: Retrieve the order subscription associated to the order tags: - has_one parameters: - name: orderId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order_subscription associated to the order /packages/{packageId}/stock_location: get: operationId: GET/packageId/stock_location summary: Retrieve the stock location associated to the package description: Retrieve the stock location associated to the package tags: - has_one parameters: - name: packageId in: path schema: type: string required: true description: The resource's id responses: '200': description: The stock_location associated to the package /parcel_line_items/{parcelLineItemId}/parcel: get: operationId: GET/parcelLineItemId/parcel summary: Retrieve the parcel associated to the parcel line item description: Retrieve the parcel associated to the parcel line item tags: - has_one parameters: - name: parcelLineItemId in: path schema: type: string required: true description: The resource's id responses: '200': description: The parcel associated to the parcel line item /parcel_line_items/{parcelLineItemId}/stock_line_item: get: operationId: GET/parcelLineItemId/stock_line_item summary: Retrieve the stock line item associated to the parcel line item description: Retrieve the stock line item associated to the parcel line item tags: - has_one parameters: - name: parcelLineItemId in: path schema: type: string required: true description: The resource's id responses: '200': description: The stock_line_item associated to the parcel line item /parcels/{parcelId}/shipment: get: operationId: GET/parcelId/shipment summary: Retrieve the shipment associated to the parcel description: Retrieve the shipment associated to the parcel tags: - has_one parameters: - name: parcelId in: path schema: type: string required: true description: The resource's id responses: '200': description: The shipment associated to the parcel /parcels/{parcelId}/package: get: operationId: GET/parcelId/package summary: Retrieve the package associated to the parcel description: Retrieve the package associated to the parcel tags: - has_one parameters: - name: parcelId in: path schema: type: string required: true description: The resource's id responses: '200': description: The package associated to the parcel /payment_methods/{paymentMethodId}/market: get: operationId: GET/paymentMethodId/market summary: Retrieve the market associated to the payment method description: Retrieve the market associated to the payment method tags: - has_one parameters: - name: paymentMethodId in: path schema: type: string required: true description: The resource's id responses: '200': description: The market associated to the payment method /payment_methods/{paymentMethodId}/payment_gateway: get: operationId: GET/paymentMethodId/payment_gateway summary: Retrieve the payment gateway associated to the payment method description: Retrieve the payment gateway associated to the payment method tags: - has_one parameters: - name: paymentMethodId in: path schema: type: string required: true description: The resource's id responses: '200': description: The payment_gateway associated to the payment method /payment_methods/{paymentMethodId}/store: get: operationId: GET/paymentMethodId/store summary: Retrieve the store associated to the payment method description: Retrieve the store associated to the payment method tags: - has_one parameters: - name: paymentMethodId in: path schema: type: string required: true description: The resource's id responses: '200': description: The store associated to the payment method /payment_options/{paymentOptionId}/order: get: operationId: GET/paymentOptionId/order summary: Retrieve the order associated to the payment option description: Retrieve the order associated to the payment option tags: - has_one parameters: - name: paymentOptionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order associated to the payment option /paypal_payments/{paypalPaymentId}/order: get: operationId: GET/paypalPaymentId/order summary: Retrieve the order associated to the paypal payment description: Retrieve the order associated to the paypal payment tags: - has_one parameters: - name: paypalPaymentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order associated to the paypal payment /paypal_payments/{paypalPaymentId}/payment_gateway: get: operationId: GET/paypalPaymentId/payment_gateway summary: Retrieve the payment gateway associated to the paypal payment description: Retrieve the payment gateway associated to the paypal payment tags: - has_one parameters: - name: paypalPaymentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The payment_gateway associated to the paypal payment /percentage_discount_promotions/{percentageDiscountPromotionId}/market: get: operationId: GET/percentageDiscountPromotionId/market summary: Retrieve the market associated to the percentage discount promotion description: Retrieve the market associated to the percentage discount promotion tags: - has_one parameters: - name: percentageDiscountPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The market associated to the percentage discount promotion /percentage_discount_promotions/{percentageDiscountPromotionId}/order_amount_promotion_rule: get: operationId: GET/percentageDiscountPromotionId/order_amount_promotion_rule summary: Retrieve the order amount promotion rule associated to the percentage discount promotion description: Retrieve the order amount promotion rule associated to the percentage discount promotion tags: - has_one parameters: - name: percentageDiscountPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order_amount_promotion_rule associated to the percentage discount promotion /percentage_discount_promotions/{percentageDiscountPromotionId}/sku_list_promotion_rule: get: operationId: GET/percentageDiscountPromotionId/sku_list_promotion_rule summary: Retrieve the sku list promotion rule associated to the percentage discount promotion description: Retrieve the sku list promotion rule associated to the percentage discount promotion tags: - has_one parameters: - name: percentageDiscountPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku_list_promotion_rule associated to the percentage discount promotion /percentage_discount_promotions/{percentageDiscountPromotionId}/coupon_codes_promotion_rule: get: operationId: GET/percentageDiscountPromotionId/coupon_codes_promotion_rule summary: Retrieve the coupon codes promotion rule associated to the percentage discount promotion description: Retrieve the coupon codes promotion rule associated to the percentage discount promotion tags: - has_one parameters: - name: percentageDiscountPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The coupon_codes_promotion_rule associated to the percentage discount promotion /percentage_discount_promotions/{percentageDiscountPromotionId}/custom_promotion_rule: get: operationId: GET/percentageDiscountPromotionId/custom_promotion_rule summary: Retrieve the custom promotion rule associated to the percentage discount promotion description: Retrieve the custom promotion rule associated to the percentage discount promotion tags: - has_one parameters: - name: percentageDiscountPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The custom_promotion_rule associated to the percentage discount promotion /percentage_discount_promotions/{percentageDiscountPromotionId}/sku_list: get: operationId: GET/percentageDiscountPromotionId/sku_list summary: Retrieve the sku list associated to the percentage discount promotion description: Retrieve the sku list associated to the percentage discount promotion tags: - has_one parameters: - name: percentageDiscountPromotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku_list associated to the percentage discount promotion /pickups/{pickupId}/shipment: get: operationId: GET/pickupId/shipment summary: Retrieve the shipment associated to the pickup description: Retrieve the shipment associated to the pickup tags: - has_one parameters: - name: pickupId in: path schema: type: string required: true description: The resource's id responses: '200': description: The shipment associated to the pickup /price_frequency_tiers/{priceFrequencyTierId}/price: get: operationId: GET/priceFrequencyTierId/price summary: Retrieve the price associated to the price frequency tier description: Retrieve the price associated to the price frequency tier tags: - has_one parameters: - name: priceFrequencyTierId in: path schema: type: string required: true description: The resource's id responses: '200': description: The price associated to the price frequency tier /price_list_schedulers/{priceListSchedulerId}/market: get: operationId: GET/priceListSchedulerId/market summary: Retrieve the market associated to the price list scheduler description: Retrieve the market associated to the price list scheduler tags: - has_one parameters: - name: priceListSchedulerId in: path schema: type: string required: true description: The resource's id responses: '200': description: The market associated to the price list scheduler /price_list_schedulers/{priceListSchedulerId}/price_list: get: operationId: GET/priceListSchedulerId/price_list summary: Retrieve the price list associated to the price list scheduler description: Retrieve the price list associated to the price list scheduler tags: - has_one parameters: - name: priceListSchedulerId in: path schema: type: string required: true description: The resource's id responses: '200': description: The price_list associated to the price list scheduler /price_tiers/{priceTierId}/price: get: operationId: GET/priceTierId/price summary: Retrieve the price associated to the price tier description: Retrieve the price associated to the price tier tags: - has_one parameters: - name: priceTierId in: path schema: type: string required: true description: The resource's id responses: '200': description: The price associated to the price tier /price_volume_tiers/{priceVolumeTierId}/price: get: operationId: GET/priceVolumeTierId/price summary: Retrieve the price associated to the price volume tier description: Retrieve the price associated to the price volume tier tags: - has_one parameters: - name: priceVolumeTierId in: path schema: type: string required: true description: The resource's id responses: '200': description: The price associated to the price volume tier /prices/{priceId}/price_list: get: operationId: GET/priceId/price_list summary: Retrieve the price list associated to the price description: Retrieve the price list associated to the price tags: - has_one parameters: - name: priceId in: path schema: type: string required: true description: The resource's id responses: '200': description: The price_list associated to the price /prices/{priceId}/sku: get: operationId: GET/priceId/sku summary: Retrieve the sku associated to the price description: Retrieve the sku associated to the price tags: - has_one parameters: - name: priceId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku associated to the price /prices/{priceId}/jwt_customer: get: operationId: GET/priceId/jwt_customer summary: Retrieve the jwt customer associated to the price description: Retrieve the jwt customer associated to the price tags: - has_one parameters: - name: priceId in: path schema: type: string required: true description: The resource's id responses: '200': description: The jwt_customer associated to the price /promotions/{promotionId}/market: get: operationId: GET/promotionId/market summary: Retrieve the market associated to the promotion description: Retrieve the market associated to the promotion tags: - has_one parameters: - name: promotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The market associated to the promotion /promotions/{promotionId}/order_amount_promotion_rule: get: operationId: GET/promotionId/order_amount_promotion_rule summary: Retrieve the order amount promotion rule associated to the promotion description: Retrieve the order amount promotion rule associated to the promotion tags: - has_one parameters: - name: promotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order_amount_promotion_rule associated to the promotion /promotions/{promotionId}/sku_list_promotion_rule: get: operationId: GET/promotionId/sku_list_promotion_rule summary: Retrieve the sku list promotion rule associated to the promotion description: Retrieve the sku list promotion rule associated to the promotion tags: - has_one parameters: - name: promotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku_list_promotion_rule associated to the promotion /promotions/{promotionId}/coupon_codes_promotion_rule: get: operationId: GET/promotionId/coupon_codes_promotion_rule summary: Retrieve the coupon codes promotion rule associated to the promotion description: Retrieve the coupon codes promotion rule associated to the promotion tags: - has_one parameters: - name: promotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The coupon_codes_promotion_rule associated to the promotion /promotions/{promotionId}/custom_promotion_rule: get: operationId: GET/promotionId/custom_promotion_rule summary: Retrieve the custom promotion rule associated to the promotion description: Retrieve the custom promotion rule associated to the promotion tags: - has_one parameters: - name: promotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The custom_promotion_rule associated to the promotion /promotions/{promotionId}/sku_list: get: operationId: GET/promotionId/sku_list summary: Retrieve the sku list associated to the promotion description: Retrieve the sku list associated to the promotion tags: - has_one parameters: - name: promotionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku_list associated to the promotion /recurring_order_copies/{recurringOrderCopyId}/source_order: get: operationId: GET/recurringOrderCopyId/source_order summary: Retrieve the source order associated to the recurring order copy description: Retrieve the source order associated to the recurring order copy tags: - has_one parameters: - name: recurringOrderCopyId in: path schema: type: string required: true description: The resource's id responses: '200': description: The source_order associated to the recurring order copy /recurring_order_copies/{recurringOrderCopyId}/target_order: get: operationId: GET/recurringOrderCopyId/target_order summary: Retrieve the target order associated to the recurring order copy description: Retrieve the target order associated to the recurring order copy tags: - has_one parameters: - name: recurringOrderCopyId in: path schema: type: string required: true description: The resource's id responses: '200': description: The target_order associated to the recurring order copy /recurring_order_copies/{recurringOrderCopyId}/order_subscription: get: operationId: GET/recurringOrderCopyId/order_subscription summary: Retrieve the order subscription associated to the recurring order copy description: Retrieve the order subscription associated to the recurring order copy tags: - has_one parameters: - name: recurringOrderCopyId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order_subscription associated to the recurring order copy /refunds/{refundId}/order: get: operationId: GET/refundId/order summary: Retrieve the order associated to the refund description: Retrieve the order associated to the refund tags: - has_one parameters: - name: refundId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order associated to the refund /refunds/{refundId}/reference_capture: get: operationId: GET/refundId/reference_capture summary: Retrieve the reference capture associated to the refund description: Retrieve the reference capture associated to the refund tags: - has_one parameters: - name: refundId in: path schema: type: string required: true description: The resource's id responses: '200': description: The reference_capture associated to the refund /refunds/{refundId}/return: get: operationId: GET/refundId/return summary: Retrieve the return associated to the refund description: Retrieve the return associated to the refund tags: - has_one parameters: - name: refundId in: path schema: type: string required: true description: The resource's id responses: '200': description: The return associated to the refund /reserved_stocks/{reservedStockId}/stock_item: get: operationId: GET/reservedStockId/stock_item summary: Retrieve the stock item associated to the reserved stock description: Retrieve the stock item associated to the reserved stock tags: - has_one parameters: - name: reservedStockId in: path schema: type: string required: true description: The resource's id responses: '200': description: The stock_item associated to the reserved stock /reserved_stocks/{reservedStockId}/sku: get: operationId: GET/reservedStockId/sku summary: Retrieve the sku associated to the reserved stock description: Retrieve the sku associated to the reserved stock tags: - has_one parameters: - name: reservedStockId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku associated to the reserved stock /return_line_items/{returnLineItemId}/return: get: operationId: GET/returnLineItemId/return summary: Retrieve the return associated to the return line item description: Retrieve the return associated to the return line item tags: - has_one parameters: - name: returnLineItemId in: path schema: type: string required: true description: The resource's id responses: '200': description: The return associated to the return line item /return_line_items/{returnLineItemId}/line_item: get: operationId: GET/returnLineItemId/line_item summary: Retrieve the line item associated to the return line item description: Retrieve the line item associated to the return line item tags: - has_one parameters: - name: returnLineItemId in: path schema: type: string required: true description: The resource's id responses: '200': description: The line_item associated to the return line item /returns/{returnId}/order: get: operationId: GET/returnId/order summary: Retrieve the order associated to the return description: Retrieve the order associated to the return tags: - has_one parameters: - name: returnId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order associated to the return /returns/{returnId}/customer: get: operationId: GET/returnId/customer summary: Retrieve the customer associated to the return description: Retrieve the customer associated to the return tags: - has_one parameters: - name: returnId in: path schema: type: string required: true description: The resource's id responses: '200': description: The customer associated to the return /returns/{returnId}/stock_location: get: operationId: GET/returnId/stock_location summary: Retrieve the stock location associated to the return description: Retrieve the stock location associated to the return tags: - has_one parameters: - name: returnId in: path schema: type: string required: true description: The resource's id responses: '200': description: The stock_location associated to the return /returns/{returnId}/origin_address: get: operationId: GET/returnId/origin_address summary: Retrieve the origin address associated to the return description: Retrieve the origin address associated to the return tags: - has_one parameters: - name: returnId in: path schema: type: string required: true description: The resource's id responses: '200': description: The origin_address associated to the return /returns/{returnId}/destination_address: get: operationId: GET/returnId/destination_address summary: Retrieve the destination address associated to the return description: Retrieve the destination address associated to the return tags: - has_one parameters: - name: returnId in: path schema: type: string required: true description: The resource's id responses: '200': description: The destination_address associated to the return /returns/{returnId}/reference_capture: get: operationId: GET/returnId/reference_capture summary: Retrieve the reference capture associated to the return description: Retrieve the reference capture associated to the return tags: - has_one parameters: - name: returnId in: path schema: type: string required: true description: The resource's id responses: '200': description: The reference_capture associated to the return /returns/{returnId}/reference_refund: get: operationId: GET/returnId/reference_refund summary: Retrieve the reference refund associated to the return description: Retrieve the reference refund associated to the return tags: - has_one parameters: - name: returnId in: path schema: type: string required: true description: The resource's id responses: '200': description: The reference_refund associated to the return /satispay_payments/{satispayPaymentId}/order: get: operationId: GET/satispayPaymentId/order summary: Retrieve the order associated to the satispay payment description: Retrieve the order associated to the satispay payment tags: - has_one parameters: - name: satispayPaymentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order associated to the satispay payment /satispay_payments/{satispayPaymentId}/payment_gateway: get: operationId: GET/satispayPaymentId/payment_gateway summary: Retrieve the payment gateway associated to the satispay payment description: Retrieve the payment gateway associated to the satispay payment tags: - has_one parameters: - name: satispayPaymentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The payment_gateway associated to the satispay payment /shipments/{shipmentId}/order: get: operationId: GET/shipmentId/order summary: Retrieve the order associated to the shipment description: Retrieve the order associated to the shipment tags: - has_one parameters: - name: shipmentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order associated to the shipment /shipments/{shipmentId}/shipping_category: get: operationId: GET/shipmentId/shipping_category summary: Retrieve the shipping category associated to the shipment description: Retrieve the shipping category associated to the shipment tags: - has_one parameters: - name: shipmentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The shipping_category associated to the shipment /shipments/{shipmentId}/inventory_stock_location: get: operationId: GET/shipmentId/inventory_stock_location summary: Retrieve the inventory stock location associated to the shipment description: Retrieve the inventory stock location associated to the shipment tags: - has_one parameters: - name: shipmentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The inventory_stock_location associated to the shipment /shipments/{shipmentId}/stock_location: get: operationId: GET/shipmentId/stock_location summary: Retrieve the stock location associated to the shipment description: Retrieve the stock location associated to the shipment tags: - has_one parameters: - name: shipmentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The stock_location associated to the shipment /shipments/{shipmentId}/origin_address: get: operationId: GET/shipmentId/origin_address summary: Retrieve the origin address associated to the shipment description: Retrieve the origin address associated to the shipment tags: - has_one parameters: - name: shipmentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The origin_address associated to the shipment /shipments/{shipmentId}/shipping_address: get: operationId: GET/shipmentId/shipping_address summary: Retrieve the shipping address associated to the shipment description: Retrieve the shipping address associated to the shipment tags: - has_one parameters: - name: shipmentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The shipping_address associated to the shipment /shipments/{shipmentId}/shipping_method: get: operationId: GET/shipmentId/shipping_method summary: Retrieve the shipping method associated to the shipment description: Retrieve the shipping method associated to the shipment tags: - has_one parameters: - name: shipmentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The shipping_method associated to the shipment /shipments/{shipmentId}/delivery_lead_time: get: operationId: GET/shipmentId/delivery_lead_time summary: Retrieve the delivery lead time associated to the shipment description: Retrieve the delivery lead time associated to the shipment tags: - has_one parameters: - name: shipmentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The delivery_lead_time associated to the shipment /shipments/{shipmentId}/pickup: get: operationId: GET/shipmentId/pickup summary: Retrieve the pickup associated to the shipment description: Retrieve the pickup associated to the shipment tags: - has_one parameters: - name: shipmentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The pickup associated to the shipment /shipping_method_tiers/{shippingMethodTierId}/shipping_method: get: operationId: GET/shippingMethodTierId/shipping_method summary: Retrieve the shipping method associated to the shipping method tier description: Retrieve the shipping method associated to the shipping method tier tags: - has_one parameters: - name: shippingMethodTierId in: path schema: type: string required: true description: The resource's id responses: '200': description: The shipping_method associated to the shipping method tier /shipping_methods/{shippingMethodId}/market: get: operationId: GET/shippingMethodId/market summary: Retrieve the market associated to the shipping method description: Retrieve the market associated to the shipping method tags: - has_one parameters: - name: shippingMethodId in: path schema: type: string required: true description: The resource's id responses: '200': description: The market associated to the shipping method /shipping_methods/{shippingMethodId}/shipping_zone: get: operationId: GET/shippingMethodId/shipping_zone summary: Retrieve the shipping zone associated to the shipping method description: Retrieve the shipping zone associated to the shipping method tags: - has_one parameters: - name: shippingMethodId in: path schema: type: string required: true description: The resource's id responses: '200': description: The shipping_zone associated to the shipping method /shipping_methods/{shippingMethodId}/shipping_category: get: operationId: GET/shippingMethodId/shipping_category summary: Retrieve the shipping category associated to the shipping method description: Retrieve the shipping category associated to the shipping method tags: - has_one parameters: - name: shippingMethodId in: path schema: type: string required: true description: The resource's id responses: '200': description: The shipping_category associated to the shipping method /shipping_methods/{shippingMethodId}/stock_location: get: operationId: GET/shippingMethodId/stock_location summary: Retrieve the stock location associated to the shipping method description: Retrieve the stock location associated to the shipping method tags: - has_one parameters: - name: shippingMethodId in: path schema: type: string required: true description: The resource's id responses: '200': description: The stock_location associated to the shipping method /shipping_methods/{shippingMethodId}/delivery_lead_time_for_shipment: get: operationId: GET/shippingMethodId/delivery_lead_time_for_shipment summary: Retrieve the delivery lead time for shipment associated to the shipping method description: Retrieve the delivery lead time for shipment associated to the shipping method tags: - has_one parameters: - name: shippingMethodId in: path schema: type: string required: true description: The resource's id responses: '200': description: The delivery_lead_time_for_shipment associated to the shipping method /shipping_weight_tiers/{shippingWeightTierId}/shipping_method: get: operationId: GET/shippingWeightTierId/shipping_method summary: Retrieve the shipping method associated to the shipping weight tier description: Retrieve the shipping method associated to the shipping weight tier tags: - has_one parameters: - name: shippingWeightTierId in: path schema: type: string required: true description: The resource's id responses: '200': description: The shipping_method associated to the shipping weight tier /sku_list_items/{skuListItemId}/sku_list: get: operationId: GET/skuListItemId/sku_list summary: Retrieve the sku list associated to the SKU list item description: Retrieve the sku list associated to the SKU list item tags: - has_one parameters: - name: skuListItemId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku_list associated to the SKU list item /sku_list_items/{skuListItemId}/sku: get: operationId: GET/skuListItemId/sku summary: Retrieve the sku associated to the SKU list item description: Retrieve the sku associated to the SKU list item tags: - has_one parameters: - name: skuListItemId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku associated to the SKU list item /sku_list_promotion_rules/{skuListPromotionRuleId}/sku_list: get: operationId: GET/skuListPromotionRuleId/sku_list summary: Retrieve the sku list associated to the SKU list promotion rule description: Retrieve the sku list associated to the SKU list promotion rule tags: - has_one parameters: - name: skuListPromotionRuleId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku_list associated to the SKU list promotion rule /sku_lists/{skuListId}/customer: get: operationId: GET/skuListId/customer summary: Retrieve the customer associated to the SKU list description: Retrieve the customer associated to the SKU list tags: - has_one parameters: - name: skuListId in: path schema: type: string required: true description: The resource's id responses: '200': description: The customer associated to the SKU list /sku_options/{skuOptionId}/market: get: operationId: GET/skuOptionId/market summary: Retrieve the market associated to the SKU option description: Retrieve the market associated to the SKU option tags: - has_one parameters: - name: skuOptionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The market associated to the SKU option /skus/{skuId}/shipping_category: get: operationId: GET/skuId/shipping_category summary: Retrieve the shipping category associated to the SKU description: Retrieve the shipping category associated to the SKU tags: - has_one parameters: - name: skuId in: path schema: type: string required: true description: The resource's id responses: '200': description: The shipping_category associated to the SKU /skus/{skuId}/jwt_customer: get: operationId: GET/skuId/jwt_customer summary: Retrieve the jwt customer associated to the SKU description: Retrieve the jwt customer associated to the SKU tags: - has_one parameters: - name: skuId in: path schema: type: string required: true description: The resource's id responses: '200': description: The jwt_customer associated to the SKU /stock_items/{stockItemId}/stock_location: get: operationId: GET/stockItemId/stock_location summary: Retrieve the stock location associated to the stock item description: Retrieve the stock location associated to the stock item tags: - has_one parameters: - name: stockItemId in: path schema: type: string required: true description: The resource's id responses: '200': description: The stock_location associated to the stock item /stock_items/{stockItemId}/sku: get: operationId: GET/stockItemId/sku summary: Retrieve the sku associated to the stock item description: Retrieve the sku associated to the stock item tags: - has_one parameters: - name: stockItemId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku associated to the stock item /stock_items/{stockItemId}/reserved_stock: get: operationId: GET/stockItemId/reserved_stock summary: Retrieve the reserved stock associated to the stock item description: Retrieve the reserved stock associated to the stock item tags: - has_one parameters: - name: stockItemId in: path schema: type: string required: true description: The resource's id responses: '200': description: The reserved_stock associated to the stock item /stock_line_items/{stockLineItemId}/shipment: get: operationId: GET/stockLineItemId/shipment summary: Retrieve the shipment associated to the stock line item description: Retrieve the shipment associated to the stock line item tags: - has_one parameters: - name: stockLineItemId in: path schema: type: string required: true description: The resource's id responses: '200': description: The shipment associated to the stock line item /stock_line_items/{stockLineItemId}/line_item: get: operationId: GET/stockLineItemId/line_item summary: Retrieve the line item associated to the stock line item description: Retrieve the line item associated to the stock line item tags: - has_one parameters: - name: stockLineItemId in: path schema: type: string required: true description: The resource's id responses: '200': description: The line_item associated to the stock line item /stock_line_items/{stockLineItemId}/stock_item: get: operationId: GET/stockLineItemId/stock_item summary: Retrieve the stock item associated to the stock line item description: Retrieve the stock item associated to the stock line item tags: - has_one parameters: - name: stockLineItemId in: path schema: type: string required: true description: The resource's id responses: '200': description: The stock_item associated to the stock line item /stock_line_items/{stockLineItemId}/sku: get: operationId: GET/stockLineItemId/sku summary: Retrieve the sku associated to the stock line item description: Retrieve the sku associated to the stock line item tags: - has_one parameters: - name: stockLineItemId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku associated to the stock line item /stock_line_items/{stockLineItemId}/stock_reservation: get: operationId: GET/stockLineItemId/stock_reservation summary: Retrieve the stock reservation associated to the stock line item description: Retrieve the stock reservation associated to the stock line item tags: - has_one parameters: - name: stockLineItemId in: path schema: type: string required: true description: The resource's id responses: '200': description: The stock_reservation associated to the stock line item /stock_locations/{stockLocationId}/address: get: operationId: GET/stockLocationId/address summary: Retrieve the address associated to the stock location description: Retrieve the address associated to the stock location tags: - has_one parameters: - name: stockLocationId in: path schema: type: string required: true description: The resource's id responses: '200': description: The address associated to the stock location /stock_reservations/{stockReservationId}/line_item: get: operationId: GET/stockReservationId/line_item summary: Retrieve the line item associated to the stock reservation description: Retrieve the line item associated to the stock reservation tags: - has_one parameters: - name: stockReservationId in: path schema: type: string required: true description: The resource's id responses: '200': description: The line_item associated to the stock reservation /stock_reservations/{stockReservationId}/order: get: operationId: GET/stockReservationId/order summary: Retrieve the order associated to the stock reservation description: Retrieve the order associated to the stock reservation tags: - has_one parameters: - name: stockReservationId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order associated to the stock reservation /stock_reservations/{stockReservationId}/stock_line_item: get: operationId: GET/stockReservationId/stock_line_item summary: Retrieve the stock line item associated to the stock reservation description: Retrieve the stock line item associated to the stock reservation tags: - has_one parameters: - name: stockReservationId in: path schema: type: string required: true description: The resource's id responses: '200': description: The stock_line_item associated to the stock reservation /stock_reservations/{stockReservationId}/stock_transfer: get: operationId: GET/stockReservationId/stock_transfer summary: Retrieve the stock transfer associated to the stock reservation description: Retrieve the stock transfer associated to the stock reservation tags: - has_one parameters: - name: stockReservationId in: path schema: type: string required: true description: The resource's id responses: '200': description: The stock_transfer associated to the stock reservation /stock_reservations/{stockReservationId}/stock_item: get: operationId: GET/stockReservationId/stock_item summary: Retrieve the stock item associated to the stock reservation description: Retrieve the stock item associated to the stock reservation tags: - has_one parameters: - name: stockReservationId in: path schema: type: string required: true description: The resource's id responses: '200': description: The stock_item associated to the stock reservation /stock_reservations/{stockReservationId}/reserved_stock: get: operationId: GET/stockReservationId/reserved_stock summary: Retrieve the reserved stock associated to the stock reservation description: Retrieve the reserved stock associated to the stock reservation tags: - has_one parameters: - name: stockReservationId in: path schema: type: string required: true description: The resource's id responses: '200': description: The reserved_stock associated to the stock reservation /stock_reservations/{stockReservationId}/sku: get: operationId: GET/stockReservationId/sku summary: Retrieve the sku associated to the stock reservation description: Retrieve the sku associated to the stock reservation tags: - has_one parameters: - name: stockReservationId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku associated to the stock reservation /stock_transfers/{stockTransferId}/sku: get: operationId: GET/stockTransferId/sku summary: Retrieve the sku associated to the stock transfer description: Retrieve the sku associated to the stock transfer tags: - has_one parameters: - name: stockTransferId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku associated to the stock transfer /stock_transfers/{stockTransferId}/origin_stock_location: get: operationId: GET/stockTransferId/origin_stock_location summary: Retrieve the origin stock location associated to the stock transfer description: Retrieve the origin stock location associated to the stock transfer tags: - has_one parameters: - name: stockTransferId in: path schema: type: string required: true description: The resource's id responses: '200': description: The origin_stock_location associated to the stock transfer /stock_transfers/{stockTransferId}/destination_stock_location: get: operationId: GET/stockTransferId/destination_stock_location summary: Retrieve the destination stock location associated to the stock transfer description: Retrieve the destination stock location associated to the stock transfer tags: - has_one parameters: - name: stockTransferId in: path schema: type: string required: true description: The resource's id responses: '200': description: The destination_stock_location associated to the stock transfer /stock_transfers/{stockTransferId}/shipment: get: operationId: GET/stockTransferId/shipment summary: Retrieve the shipment associated to the stock transfer description: Retrieve the shipment associated to the stock transfer tags: - has_one parameters: - name: stockTransferId in: path schema: type: string required: true description: The resource's id responses: '200': description: The shipment associated to the stock transfer /stock_transfers/{stockTransferId}/line_item: get: operationId: GET/stockTransferId/line_item summary: Retrieve the line item associated to the stock transfer description: Retrieve the line item associated to the stock transfer tags: - has_one parameters: - name: stockTransferId in: path schema: type: string required: true description: The resource's id responses: '200': description: The line_item associated to the stock transfer /stock_transfers/{stockTransferId}/stock_reservation: get: operationId: GET/stockTransferId/stock_reservation summary: Retrieve the stock reservation associated to the stock transfer description: Retrieve the stock reservation associated to the stock transfer tags: - has_one parameters: - name: stockTransferId in: path schema: type: string required: true description: The resource's id responses: '200': description: The stock_reservation associated to the stock transfer /stores/{storeId}/market: get: operationId: GET/storeId/market summary: Retrieve the market associated to the store description: Retrieve the market associated to the store tags: - has_one parameters: - name: storeId in: path schema: type: string required: true description: The resource's id responses: '200': description: The market associated to the store /stores/{storeId}/merchant: get: operationId: GET/storeId/merchant summary: Retrieve the merchant associated to the store description: Retrieve the merchant associated to the store tags: - has_one parameters: - name: storeId in: path schema: type: string required: true description: The resource's id responses: '200': description: The merchant associated to the store /stores/{storeId}/stock_location: get: operationId: GET/storeId/stock_location summary: Retrieve the stock location associated to the store description: Retrieve the stock location associated to the store tags: - has_one parameters: - name: storeId in: path schema: type: string required: true description: The resource's id responses: '200': description: The stock_location associated to the store /stripe_payments/{stripePaymentId}/order: get: operationId: GET/stripePaymentId/order summary: Retrieve the order associated to the stripe payment description: Retrieve the order associated to the stripe payment tags: - has_one parameters: - name: stripePaymentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order associated to the stripe payment /stripe_payments/{stripePaymentId}/payment_gateway: get: operationId: GET/stripePaymentId/payment_gateway summary: Retrieve the payment gateway associated to the stripe payment description: Retrieve the payment gateway associated to the stripe payment tags: - has_one parameters: - name: stripePaymentId in: path schema: type: string required: true description: The resource's id responses: '200': description: The payment_gateway associated to the stripe payment /tax_categories/{taxCategoryId}/sku: get: operationId: GET/taxCategoryId/sku summary: Retrieve the sku associated to the tax category description: Retrieve the sku associated to the tax category tags: - has_one parameters: - name: taxCategoryId in: path schema: type: string required: true description: The resource's id responses: '200': description: The sku associated to the tax category /tax_rules/{taxRuleId}/manual_tax_calculator: get: operationId: GET/taxRuleId/manual_tax_calculator summary: Retrieve the manual tax calculator associated to the tax rule description: Retrieve the manual tax calculator associated to the tax rule tags: - has_one parameters: - name: taxRuleId in: path schema: type: string required: true description: The resource's id responses: '200': description: The manual_tax_calculator associated to the tax rule /transactions/{transactionId}/order: get: operationId: GET/transactionId/order summary: Retrieve the order associated to the transaction description: Retrieve the order associated to the transaction tags: - has_one parameters: - name: transactionId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order associated to the transaction /voids/{voidId}/order: get: operationId: GET/voidId/order summary: Retrieve the order associated to the void description: Retrieve the order associated to the void tags: - has_one parameters: - name: voidId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order associated to the void /voids/{voidId}/reference_authorization: get: operationId: GET/voidId/reference_authorization summary: Retrieve the reference authorization associated to the void description: Retrieve the reference authorization associated to the void tags: - has_one parameters: - name: voidId in: path schema: type: string required: true description: The resource's id responses: '200': description: The reference_authorization associated to the void /wire_transfers/{wireTransferId}/order: get: operationId: GET/wireTransferId/order summary: Retrieve the order associated to the wire transfer description: Retrieve the order associated to the wire transfer tags: - has_one parameters: - name: wireTransferId in: path schema: type: string required: true description: The resource's id responses: '200': description: The order associated to the wire transfer /api_credentials/{apiCredentialId}/organization: get: operationId: GET/apiCredentialId/organization summary: Related API credential description: Related API credential tags: - has_one parameters: - name: apiCredentialId in: path schema: type: string required: true description: The ID of the resource. responses: '200': description: The organization associated to the API credential /api_credentials/{apiCredentialId}/role: get: operationId: GET/apiCredentialId/role summary: Related API credential description: Related API credential tags: - has_one parameters: - name: apiCredentialId in: path schema: type: string required: true description: The ID of the resource. responses: '200': description: The role associated to the API credential /application_memberships/{applicationMembershipId}/api_credential: get: operationId: GET/applicationMembershipId/api_credential summary: Related application membership description: Related application membership tags: - has_one parameters: - name: applicationMembershipId in: path schema: type: string required: true description: The ID of the resource. responses: '200': description: The api_credential associated to the application membership /application_memberships/{applicationMembershipId}/membership: get: operationId: GET/applicationMembershipId/membership summary: Related application membership description: Related application membership tags: - has_one parameters: - name: applicationMembershipId in: path schema: type: string required: true description: The ID of the resource. responses: '200': description: The membership associated to the application membership /application_memberships/{applicationMembershipId}/membership_profile: get: operationId: GET/applicationMembershipId/membership_profile summary: Related application membership description: Related application membership tags: - has_one parameters: - name: applicationMembershipId in: path schema: type: string required: true description: The ID of the resource. responses: '200': description: The membership_profile associated to the application membership /application_memberships/{applicationMembershipId}/organization: get: operationId: GET/applicationMembershipId/organization summary: Related application membership description: Related application membership tags: - has_one parameters: - name: applicationMembershipId in: path schema: type: string required: true description: The ID of the resource. responses: '200': description: The organization associated to the application membership /application_memberships/{applicationMembershipId}/role: get: operationId: GET/applicationMembershipId/role summary: Related application membership description: Related application membership tags: - has_one parameters: - name: applicationMembershipId in: path schema: type: string required: true description: The ID of the resource. responses: '200': description: The role associated to the application membership /identity_providers/{identityProviderId}/user: get: operationId: GET/identityProviderId/user summary: Related identity provider description: Related identity provider tags: - has_one parameters: - name: identityProviderId in: path schema: type: string required: true description: The ID of the resource. responses: '200': description: The user associated to the identity provider /memberships/{membershipId}/organization: get: operationId: GET/membershipId/organization summary: Related membership description: Related membership tags: - has_one parameters: - name: membershipId in: path schema: type: string required: true description: The ID of the resource. responses: '200': description: The organization associated to the membership /memberships/{membershipId}/role: get: operationId: GET/membershipId/role summary: Related membership description: Related membership tags: - has_one parameters: - name: membershipId in: path schema: type: string required: true description: The ID of the resource. responses: '200': description: The role associated to the membership /memberships/{membershipId}/membership_profile: get: operationId: GET/membershipId/membership_profile summary: Related membership description: Related membership tags: - has_one parameters: - name: membershipId in: path schema: type: string required: true description: The ID of the resource. responses: '200': description: The membership_profile associated to the membership /membership_profiles/{membershipProfileId}/organization: get: operationId: GET/membershipProfileId/organization summary: Related membership profile description: Related membership profile tags: - has_one parameters: - name: membershipProfileId in: path schema: type: string required: true description: The ID of the resource. responses: '200': description: The organization associated to the membership profile /permissions/{permissionId}/organization: get: operationId: GET/permissionId/organization summary: Related permission description: Related permission tags: - has_one parameters: - name: permissionId in: path schema: type: string required: true description: The ID of the resource. responses: '200': description: The organization associated to the permission /permissions/{permissionId}/role: get: operationId: GET/permissionId/role summary: Related permission description: Related permission tags: - has_one parameters: - name: permissionId in: path schema: type: string required: true description: The ID of the resource. responses: '200': description: The role associated to the permission /roles/{roleId}/organization: get: operationId: GET/roleId/organization summary: Related role description: Related role tags: - has_one parameters: - name: roleId in: path schema: type: string required: true description: The ID of the resource. responses: '200': description: The organization associated to the role components: securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT