Readiness and delivery profiles

Toolset readiness, 13 tools.

RecordsCopy Anchor Link

delivery_profilesCopy Anchor Link

The delivery promise profiles of the store: each with its name, the products it applies to and the delivery components it is built from, and which one is the default. There is one record; pass any id, e.g. "current".

• Permission: products.read
• Tools: delivery_profiles_get

product_deliveryCopy Anchor Link

Which delivery profile a product and each of its variants use, whether chosen on the product or inherited, and how it resolves. Pass the product id.

• Permission: products.read
• Tools: product_delivery_get

product_readinessCopy Anchor Link

Whether one product is ready to sell and to publish: the findings of the readiness checks and what blocks publishing. Pass the product id. include full runs the slower checks too.

• Permission: products.read
• Tools: product_readiness_get
• Includes: full

readiness_checkCopy Anchor Link

A check the readiness engine runs on the store, a product or a variant: what it asserts, how severe it can be, whether it blocks publishing, and whether it is active or disabled.

• Permission: products.read
• Tools: readiness_check_list

store_readinessCopy Anchor Link

Whether the store is ready to sell: the findings of the store-level readiness checks with their fixes. include full runs the slower checks too. There is one record; pass any id, e.g. "current".

• Permission: products.read
• Tools: store_readiness_get
• Includes: full

variant_readinessCopy Anchor Link

Whether one variant is ready to sell: the findings of the variant readiness checks. Pass <product id>/<variant id>.

• Permission: products.read
• Tools: variant_readiness_get
• Includes: full

ActionsCopy Anchor Link

delivery_profile_deleteCopy Anchor Link

Delete a delivery profile; products that used it fall back to the default.

• Action key: delivery_profile.delete
• Permission: products.write
• Approval: Always waits for a person to approve it.
• Effect: Changes the live store.
• Destructive: in compact mode it runs with run_destructive_action.
• Retries: safe to repeat with the same input.

Example input:

{
  "profile_id": "019bb276-bd8c-7a66-9c86-722d45f4e493"
}

delivery_profile_saveCopy Anchor Link

Create a delivery profile, or change one by passing its id.

components are the delivery steps in the shape delivery_profiles_get answers (at most 8); read the document first and copy the shape. applicability.mode any|all decides whether a product needs one or all of the listed categories, collections or tags.

• Action key: delivery_profile.save
• Permission: products.write
• Approval: Waits for approval when the store requires it for this action.
• Effect: Changes the live store.
• Retries: safe to repeat with the same input.

Example input:

{
  "name": "Ships in 2 days",
  "components": []
}

delivery_profile_set_defaultCopy Anchor Link

Choose the delivery profile products without their own use. null clears it.

• Action key: delivery_profile.set_default
• Permission: products.write
• Approval: Waits for approval when the store requires it for this action.
• Effect: Changes the live store.
• Retries: safe to repeat with the same input.

Example input:

{
  "profile_id": "019bb276-bd8c-7a66-9c86-722d45f4e493"
}

product_delivery_setCopy Anchor Link

Choose the delivery profile of a product and of its variants.

mode inherit follows the level above, none shows no delivery promise, profile uses profile_id. Variants not listed keep their choice.

• Action key: product_delivery.set
• Permission: products.write
• Approval: Waits for approval when the store requires it for this action.
• Effect: Changes the live store.
• Retries: safe to repeat with the same input.

Example input:

{
  "product_id": "019bb58e-0ec1-79c1-9f40-d39d8d07674b",
  "product": {
    "mode": "profile",
    "profile_id": "019bb276-bd8c-7a66-9c86-722d45f4e493"
  }
}

product_publishCopy Anchor Link

Publish a product through the readiness gate.

Runs the readiness checks first: when something blocks publishing the product stays a draft and the blockers come back (the answer is still a success). force publishes anyway, so use it only when the merchant says so.

• Action key: product.publish
• Permission: products.write
• Approval: Waits for approval when the store requires it for this action.
• Effect: Changes the live store.
• Retries: safe to repeat with the same input.

Example input:

{
  "product_id": "019bb58e-0ec1-79c1-9f40-d39d8d07674b"
}

readiness_run_actionCopy Anchor Link

Run one of the one-click fixes the readiness findings offer.

action_id comes from the fixes the readiness findings offer; only actions of kind apply can run. target_id is the product, variant or record it fixes. A dry run says what it would change.

• Action key: readiness.run_action
• Permission: products.write
• Approval: Always waits for a person to approve it.
• Effect: Changes the live store.
• Retries: runs at most once; a repeat with the same idempotency key returns the first result.
• Dry run: supported, with dry_run set to true.

Example input:

{
  "action_id": "core.link_default_sales_channel",
  "target_id": "019bb58e-0ec1-79c1-9f40-d39d8d07674b"
}

store_baseline_applyCopy Anchor Link

Set up what the store needs to sell in a market: countries, currency, tax rates and a shipping option.

A dry run reports what would be created without changing anything. countries are two-letter codes, primary_country one of them. selling and shipping choose the kinds of products sold and how they ship.

• Action key: store_baseline.apply
• Permission: settings.write
• Approval: Always waits for a person to approve it.
• Effect: Changes the live store.
• Retries: safe to repeat with the same input.
• Dry run: supported, with dry_run set to true.

Example input:

{
  "countries": [
    "hu"
  ],
  "primary_country": "hu",
  "currency_code": "huf"
}