Skip to main content
Publish a product group from test to production environment. Uses UPSERT behavior — you can re-publish after making changes, unlike product publishing which only supports the first publish. 
POST /v1/actions/subscription-product-group/publish-group
Authentication: API Key
Do not include the X-Environment header for this endpoint. Publishing is always one-way from test to production.

​
Request Body

FieldTypeRequiredDescription
idstringYesGroup ID (UUID format, must be a test environment group)

​
Example Request

await client.subscriptionProductGroups.publish({
  id: "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f9a",
});
Unlike product publishing, group publishing supports repeated UPSERT operations. You can update a test group and re-publish it to production at any time. The production group will be created or updated to match the current test group.

​
Errors

Retry policy: Never retry 4xx — fix the request and resubmit. Retry 5xx with exponential backoff (start 5s, max 3 attempts).
Statuserrors[0].messageWhat it meansRecommended handling
400Missing required field: idRequest body did not include idAdd id, resubmit
400Can only publish test environment groupsThe supplied group is already in production (or otherwise not test)Only test-environment groups are publishable
400Cannot publish: product_ids is emptyThe group has no member productsAdd at least one product via update-group, resubmit
404Group not foundNo group exists for the supplied idVerify the id belongs to your store
500Internal server errorInternal error or transient downstream failureRetry with exponential backoff (start 5s, max 3 attempts)