En bref. Le champ site_id cible un site et redirect_ids sélectionne les enregistrements de redirection dans une tâche d’export BigCommerce.

Définition : Oui. La tâche d’export de redirections de BigCommerce accepte un filtre facultatif site_id et une liste facultative redirect_ids. Une requête peut ainsi cibler un seul site, certaines règles de redirection, ou les deux.

Points clés

BigCommerce propose l’opération POST /v3/storefront/redirects/imex/export, qui crée une nouvelle tâche d’export de redirections 301, décrite dans la référence de création d’une tâche d’export de redirections.
site_id est un entier facultatif qui accepte la valeur null. En son absence, la requête exporte les redirections de tous les sites.
redirect_ids est une liste facultative d’entiers dont la valeur par défaut est []. En son absence, la requête exporte toutes les redirections du périmètre de sites sélectionné.
include_dynamic_target_urls est facultatif et vaut false par défaut. La valeur true ajoute une colonne d’URL de destination en lecture seule pour les redirections dynamiques.
Une réponse 409 signifie qu’aucune redirection ne répond aux critères de la requête. Une réponse 429 signifie qu’une tâche d’import ou d’export de redirections est déjà en cours.

Comment fonctionnent les filtres d’export ?

Le corps de la requête est un objet JSON. Le champ site_id définit le périmètre de sites et redirect_ids désigne les enregistrements de redirection à exporter dans ce périmètre. La documentation précise que la liste d’identifiants s’applique à la sélection de sites indiquée : une liste vide sélectionne donc toutes les redirections de ce périmètre.

POST https://api.bigcommerce.com/stores/{store_hash}/v3/storefront/redirects/imex/export
Accept: application/json
Content-Type: application/json
X-Auth-Token: <apiKey>

{
  "site_id": 1,
  "redirect_ids": [1, 2]
}

La requête exige aussi le paramètre de chemin store_hash, que BigCommerce définit comme l’identifiant permanent de la boutique. L’en-tête X-Auth-Token est obligatoire. La référence indique store_v2_content pour l’autorisation de modification du contenu et store_v2_content_read_only pour l’autorisation de lecture seule du contenu.

À quoi correspond un site dans cette API ?

La référence d’export définit site_id comme le site dont les redirections sont exportées. La référence distincte de création ou de mise à jour des redirections de BigCommerce présente le même champ dans l’objet de redirection et l’exige lors de la création ou de la mise à jour des données de redirection. Cette référence décrit le point de terminaison comme permettant d’écrire des données de redirection sur l’ensemble des vitrines (storefronts), chaque objet 301RedirectUpsert portant son propre site_id.

La requête de création ou de mise à jour comprend les champs obligatoires from_path et site_id, ainsi qu’un objet facultatif to. Sa réponse comprend les champs data et meta. La référence d’export ne précise pas comment est traité un identifiant qui appartient à un autre site que celui sélectionné.

Que renvoie la tâche d’export ?

En cas de succès, le point de terminaison renvoie 201 Created avec un champ facultatif id de type chaîne de caractères. Cet identifiant désigne la tâche d’export créée par la requête. Une réponse 409 est renvoyée lorsqu’aucune redirection ne répond aux critères, et une réponse 429 lorsque la boutique possède déjà une tâche d’import ou d’export de redirections en cours. L’option facultative include_dynamic_target_urls modifie les colonnes du CSV en ajoutant l’URL de destination complète dans un champ en lecture seule pour les redirections dynamiques.

Termes associés

Questions fréquentes

Puis-je exporter les redirections de tous les sites ?

Oui. Omettez site_id dans la requête. BigCommerce indique que cela exporte toutes les redirections de tous les sites.

Puis-je exporter uniquement les règles de redirection désignées ?

Oui. Fournissez leurs identifiants entiers dans redirect_ids. Si vous omettez ce champ, l’export comprend toutes les redirections du périmètre de sites sélectionné.

Que se passe-t-il lorsqu’aucune règle ne correspond ?

La référence d’export décrit une réponse 409 Conflict Error accompagnée du message « No Redirects in your store meet the criteria in your request. »

Sources

Vérifiez comment une page se lit pour les moteurs de réponse. Ouvrir l’analyseur de score GEO

Peut-on limiter un export de redirections BigCommerce à certaines règles ou à un seul site ?