Skip to main content
PUT

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

storeId
string
required

Store ID

Example:

"64e5a8a1af49a89df37e4ee7"

Body

application/json
Required array length: 1 - 100 elements
parent_sku
string
required

SKU of the product shoppers buy. Identifies the bundle. Case-sensitive.

Example:

"BUNDLE-STARTER-KIT"

children_skus
Children SKUs · object[]
required

The products contained in the bundle.

Minimum array length: 1
parent_variant_id
string

The parent variant. Send it if parent_sku may be on more than one variant in your catalog.

Example:

"55518673568035"

return_types
enum<string>[]

Return types this bundle applies to. Omit to apply to all.

Available options:
claim,
return,
warranty,
recycle,
withdrawal

Response

Request processed. Check results to see which bundles were stored.

Outcome of a bundle upsert, reported for each bundle in the request.

total_count
integer
required

Number of bundles processed, after merging entries that share a parent_sku.

applied_count
integer
required

Number of bundles now stored as requested.

failed_count
integer
required

Number of bundles skipped because a SKU was not found.

ambiguous_count
integer
required

Number of bundles skipped because a SKU is on more than one variant and no variant was given.

results
Results · object[]
required

One entry per bundle, in the order they were submitted.