Bulk update subscription delivery method

Updates the delivery method configuration for subscription contracts in bulk.

Full behavior, validation rules, and side effects

Endpoint: PUT /api/external/v2/bulk-automations/delivery-method

Authentication:

• API Key (query parameter: api_key) Query Parameters:
• api_key (required) – Your API key
• deliveryMethodTitle (required) – Delivery method title
• deliveryMethodCode (required) – Delivery method code
• deliveryMethodPresentmentTitle (required) – Customer-facing delivery method title
• deliveryMethodId (required) – Shopify Delivery Method Definition GraphQL ID

Request Body:

{
  "subscriptionIds": "29879894300"
}

What This Endpoint Does:

• Updates the delivery method details for the provided subscription contracts
• Creates a bulk automation task
• Processes updates asynchronously in the background

How It Works:

1. Merchant provides delivery method details via query parameters
2. Subscription IDs are provided in request body
3. System validates shop ownership and active status
4. Bulk automation job is created
5. Delivery method is updated for each subscription

Important Notes:

• Only one bulk automation per shop can run at a time
• deliveryMethodId must be in Shopify GraphQL ID format (e.g. gid://shopify/DeliveryMethodDefinition/…)
• Processing is asynchronous
• Previous generated orders are not modified

PUT /api/external/v2/bulk-automations/delivery-method

Bulk update subscription delivery method

cURL

curl --request PUT \
  --url https://subscription-admin.appstle.com/api/external/v2/bulk-automations/delivery-method \
  --header 'Content-Type: application/json' \
  --data '
{
  "subscriptionIds": "<string>"
}
'

204

{}

Query Parameters

api_key · string · required

Your API Key

deliveryMethodTitle · string · required

deliveryMethodCode · string · required

deliveryMethodPresentmentTitle · string · required

deliveryMethodId · string · required

suppressEmailNotification · boolean

allSubscriptions · boolean

Body

application/json

subscriptionIds · string

Response

204

application/json

Bulk delivery method update successfully queued and initiated.