Redirect Detail

🔒

Requires read_shop_navigation access scope. More access scope

The Redirect Detail API allows users to get the details of the url.

Request Parameters

Public Request Parameters

📘

Public Request Parameters

Path Parameters

ParameterTypeDescriptionRequiredExample
idstringUnique identifier for the redirect.Yes4540188244553

Response Explanation

Public Response Parameters

📘

Public Response Parameters

Error Response

Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.

FieldTypeExampleDescription
errorsArray["bad request"]A list of errors encountered during the request processing.
FieldTypeExampleDescription
errorString "store is not active"Indicates an error encountered during the process

Error Detail

Status CodeMessagePossible ReasonExample Response
400Bad RequestInvalid input format or request structure (e.g., missing required fields or incorrect data types).Bad Request
UnauthorizedThe request is missing valid authentication credentials or the credentials provided are invalid.Unauthorized

API Structure Overview

Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!