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.

Endpoint

EndpointMethod
/api/admin/marketing/url-rewrites/{id}GET

Details

  • Requires an admin Bearer token in the Authorization header.
  • An unknown id returns a 404.

Response fields

FieldTypeNotes
idintNumeric id
entityTypestringproduct, category, or cms_page
requestPathstringSource path the shopper requests
targetPathstringPath the shopper is redirected to
redirectTypestring301 permanent / 302 temporary
localestringLocale code the rewrite applies to
createdAtstringCreation timestamp
updatedAtstringLast-update timestamp

Released under the MIT License.