Redirects

Toolset redirects, 6 tools.

RecordsCopy Anchor Link

redirectCopy Anchor Link

A redirect from an old address of the storefront to a new one, with its status (301 or 302), whether it was made by hand or by an import, and how often it was hit.

• Permission: settings.read
• Tools: redirect_list, redirect_get

Filters on the list:

ActionsCopy Anchor Link

redirect_createCopy Anchor Link

Send visitors of an old address to a new one.

A redirect to another website sends shoppers off the store, so use one only when the merchant named that address. Loops, chains that are too long, the home page as the old address and a second redirect from the same address are refused.

• Action key: redirect.create
• Permission: settings.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.

Example input:

{
  "from": "/old-shoes",
  "to": "/products/shoes"
}

redirect_deleteCopy Anchor Link

Delete a redirect; its old address stops leading anywhere.

• Action key: redirect.delete
• Permission: settings.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:

{
  "redirect_id": "019bb648-e4eb-7d36-bb38-cf96bc5910d0"
}

redirect_importCopy Anchor Link

Create many redirects at once, for example after moving from another shop.

Up to 1000 rows per call. mode replace overwrites an existing redirect from the same address, keep_manual leaves redirects made by hand untouched. Rows that fail validation are listed in the answer and the rest are written.

• Action key: redirect.import
• 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.

Example input:

{
  "rows": [
    {
      "from": "/a",
      "to": "/b"
    },
    {
      "from": "/c",
      "to": "/d",
      "status": 302
    }
  ],
  "mode": "keep_manual"
}

redirect_updateCopy Anchor Link

Change where a redirect leads, its old address or its status.

The redirect is replaced, so pass from and to again even when only one changes.

• Action key: redirect.update
• 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.

Example input:

{
  "redirect_id": "019bb648-e4eb-7d36-bb38-cf96bc5910d0",
  "from": "/old-shoes",
  "to": "/products/trainers"
}