Docs
Content API
Redirects

Redirects

Get All Redirects

GET /redirects
⚠️
This endpoint is deprecated.

Request

Returns a list all Redirect URLs.

Warning

Deprecated

  • This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future version.
  • To get redirect URLs, use Redirects V3ʼs Get redirects endpoint.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required

    The MIME type of the response body.

  • page in query - integer

    Filter param.

  • limit in query - integer

    Filter param.

example

Response

Body

array | application/json
  • id
    integer

    Numeric ID of the redirect.

    Example: 1

  • path
    string
    required

    The path from which to redirect.

    Example: /smith-journal-13/

  • forward
    object
    required

  • url
    string
    read-only

    URL of the redirect. READ-ONLY.

    Example: http://store-store_hash.mybigcommerce.com/towels/bath-towels/hand-towels/

example

Create a Redirect

POST /redirects

Request

Creates a Redirect URL.

Required Fields

  • path
  • forward

Read Only

  • url

Warning

Deprecated

  • This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future version.
  • To upsert new redirect data, use Redirects V3ʼs Upsert redirects endpoint.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • Content-Type in header with default of application/json - string
    required

    The MIME type of the request body.

Body

object | application/json
  • id
    integer

    Numeric ID of the redirect.

    Example: 1

  • path
    string
    required

    The path from which to redirect.

    Example: /smith-journal-13/

  • forward
    object
    required

  • url
    string
    read-only

    URL of the redirect. READ-ONLY.

    Example: http://store-store_hash.mybigcommerce.com/towels/bath-towels/hand-towels/

example

Response

Body

object | application/json
  • id
    integer

    Numeric ID of the redirect.

    Example: 1

  • path
    string
    required

    The path from which to redirect.

    Example: /smith-journal-13/

  • forward
    object
    required

  • url
    string
    read-only

    URL of the redirect. READ-ONLY.

    Example: http://store-store_hash.mybigcommerce.com/towels/bath-towels/hand-towels/

example

Delete All Redirects

DELETE /redirects
⚠️
This endpoint is deprecated.

Request

By default, it deletes all Redirect URLs in a store.

Warning

Deprecated

  • This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future version.
  • To delete redirect URLs, use Redirects V3ʼs Delete redirects endpoint.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required

    The MIME type of the response body.

example

Response

Get a Redirect

GET /redirects/{id}
⚠️
This endpoint is deprecated.

Request

Returns a single Redirect URL.

Warning

Deprecated

  • This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future version.
  • To get a redirect URL, use Redirects V3ʼs Get redirects endpoint.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required

    The MIME type of the response body.

  • id in path - integer
    required

    ID of the redirect URL.

example

Response

Body

object | application/json
  • id
    integer

    Numeric ID of the redirect.

    Example: 1

  • path
    string
    required

    The path from which to redirect.

    Example: /smith-journal-13/

  • forward
    object
    required

  • url
    string
    read-only

    URL of the redirect. READ-ONLY.

    Example: http://store-store_hash.mybigcommerce.com/towels/bath-towels/hand-towels/

example

Update a Redirect

PUT /redirects/{id}

Request

Updates a Redirect URL.

Required Fields

  • path
  • forward

Read Only Fields

  • url

Warning

Deprecated

  • This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future version.
  • To update redirect data, use Redirects V3ʼs Upsert redirects endpoint.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • id in path - integer
    required

    ID of the redirect URL.

  • Content-Type in header with default of application/json - string
    required

    The MIME type of the request body.

Body

object | application/json
  • id
    integer

    Numeric ID of the redirect.

    Example: 1

  • path
    string
    required

    The path from which to redirect.

    Example: /smith-journal-13/

  • forward
    object
    required

  • url
    string
    read-only

    URL of the redirect. READ-ONLY.

    Example: http://store-store_hash.mybigcommerce.com/towels/bath-towels/hand-towels/

example

Response

Body

object | application/json
  • id
    integer

    Numeric ID of the redirect.

    Example: 1

  • path
    string
    required

    The path from which to redirect.

    Example: /smith-journal-13/

  • forward
    object
    required

  • url
    string
    read-only

    URL of the redirect. READ-ONLY.

    Example: http://store-store_hash.mybigcommerce.com/towels/bath-towels/hand-towels/

example

Delete a Redirect

DELETE /redirects/{id}

Request

Deletes a Redirect URL.

Warning

Deprecated

  • This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future version.
  • To delete a redirect URL, use Redirects V3ʼs Delete redirects endpoint.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required

    The MIME type of the response body.

  • id in path - integer
    required

    ID of the redirect URL.

example

Response

Get a Count of Redirects

GET /redirects/count
⚠️
This endpoint is deprecated.

Request

Gets a count of Redirect URLs in a store.

Warning

Deprecated

  • This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future version.
  • To get a count of redirects, use the meta object data returned with the Redirects V3ʼs Get redirects endpoint.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required

    The MIME type of the response body.

example

Response

Body

object | application/json
  • count
    number

    Example: 27

example

Did you find what you were looking for?