Skip to content

URL Rewrite Detail

Returns a single URL rewrite with its full field set — the data behind the admin Marketing → Search & SEO → URL Rewrites view screen.

TIP

New here? Read the URL Rewrites overview for what a URL rewrite does and how its fields behave.

Operation

OperationTypePurpose
adminMarketingUrlRewriteQueryFetch one URL rewrite by id

Details

  • Requires an admin Bearer token in the Authorization header.
  • Pass the rewrite's IRI (e.g. /api/admin/marketing/url-rewrites/118) as the id argument; _id in the response is the numeric id.

Fields

FieldTypeNotes
idIDThe rewrite's IRI
_idIntNumeric id
entityTypeStringproduct, category, or cms_page
requestPathStringSource path the shopper requests
targetPathStringDestination path the request redirects to
redirectTypeString301 permanent / 302 temporary
localeStringLocale code the rewrite applies to
createdAtStringCreation timestamp
updatedAtStringLast-update timestamp

Released under the MIT License.