API Reference

Swap line

put
https://api.loopsubscriptions.com/storefront/2023-10/subscription//line//swap

This endpoint allows you to replace an existing product in the subscription with a new product.

Body parameters explained

  • variantShopifyId - Shopify id of the variant with which the existing line is being swapped.
  • quantity - Quantity of the new variant which is being swapped with the existing lineItem.
  • sellingPlanGroupId - The sellingPlanGroupId refers to the selling plan group ID associated with the variant that will be swapped.
    • If the sellingPlanGroupId is not provided, the system will assign the plan based on the priority of the available selling plan groups.
    • If the provided sellingPlanGroupId is invalid or does not exist, an error will be thrown.
Path Params
int64
required

The unique identifier for a subscription in Loop.

int32
required

Loop ID of the line to swap

Body Params
int64
required

The unique identifier of the variant in Shopify

int32
required

The quantity of variant to be swapped

int32

The sellingPlanGroupId which has to be applied on the line

int32

This parameter is used to log the cancellation reason performance

Responses

Updated 2 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago

Did this page help you?