En bref. Utilisez le point de terminaison de création ou mise à jour des redirections de vitrine avec le site_id obligatoire du site cible et le chemin source dans from_path.
Définition : La création ou mise à jour (upsert) de redirections pour une vitrine BigCommerce s’effectue par une requête
PUTdont le corps JSON contient les enregistrements de redirection. Pour cibler un site vitrine (storefront) précis, chaque enregistrement fournit l’entier obligatoiresite_idde ce site ainsi que le chemin source obligatoire dansfrom_path.
Points clés
- BigCommerce documente le point de terminaison
PUT https://api.bigcommerce.com/stores/{store_hash}/v3/storefront/redirects; son corps est une liste d’objets301RedirectUpsert. La référence Upsert Redirects décrit cette requête. - Dans le schéma de la requête,
from_pathest une chaîne de caractères obligatoire etsite_idest un entier obligatoire. La même référence indique qu’un conflit sur cette paire remplace les données de la redirection par les nouvelles données. - BigCommerce définit un site comme un site web contrôlé par le marchand et rattaché à un seul canal. Sa présentation de Multi-Storefront indique que la première vitrine Stencil porte l’identifiant de site
1000et constitue le site par défaut. La présentation de Multi-Storefront explique ce modèle.
Comment la requête identifie-t-elle le site vitrine ?
Chaque objet de redirection doit contenir l’identifiant du site dans site_id. La référence Upsert Redirects de BigCommerce présente ce corps de requête minimal :
[
{
"from_path": "/old-url/",
"site_id": 1
}
]
Le corps prend la forme d’un tableau parce que le point de terminaison attend une liste : un seul appel peut donc contenir plusieurs enregistrements de redirection. from_path est le chemin source à enregistrer et site_id associe ce chemin au site vitrine sélectionné. La référence de l’API décrit l’opération comme une création ou mise à jour des données de redirection sur l’ensemble des vitrines, tandis que le champ de site obligatoire détermine le site auquel s’applique chaque enregistrement.
L’identifiant de site est distinct de l’identifiant de canal. La documentation Multi-Storefront de BigCommerce indique que chaque site est rattaché à un seul canal, tandis qu’un canal peut exister sans site. Un site possède également une url publique et le channel_id du canal associé.
Que se passe-t-il lorsque le même chemin est envoyé à nouveau ?
BigCommerce définit le conflit à partir de la combinaison de from_path et de site_id. Le schéma de création ou mise à jour des redirections indique que l’envoi de la même paire remplace les données de la redirection par les nouvelles données. L’identité complète décrite par ce schéma comprend donc le chemin et l’identifiant de site. Une valeur de chemin telle que /old-url/ doit ainsi figurer dans un enregistrement avec l’identifiant du site vitrine sur lequel cette redirection est gérée.
L’objet facultatif to décrit la destination. La référence énumère product, brand, category, page, post et url parmi les valeurs autorisées pour type, et documente également les champs facultatifs entity_id et url. La requête peut ainsi utiliser une entité BigCommerce ou une URL comme destination, tout en conservant from_path et site_id comme champs obligatoires du côté de la source.
Comment trouver l’identifiant de site à envoyer ?
La référence Sites de BigCommerce documente un point de terminaison pour la collection de sites :
GET https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/sites
X-Auth-Token: {{ACCESS_TOKEN}}
Accept: application/json
La même référence indique que les sites relient les vitrines découplées (headless) aux canaux de vente et présente une réponse de site contenant id, url et channel_id. L’id renvoyé sert de site_id dans la requête de redirection. Pour une vitrine Stencil par défaut, la présentation de Multi-Storefront donne 1000 comme identifiant de site et indique que ce site ne peut pas être supprimé.
Termes associés
- Comment une agence peut-elle vérifier si les paramètres SEO d’un canal BigCommerce héritent des valeurs globales ?
- Comment une vitrine découplée (headless) BigCommerce retrouve-t-elle une page à partir d’un chemin d’URL ?
- En quoi les cibles des redirections manuelles et dynamiques de BigCommerce diffèrent-elles ?
Questions fréquentes
site_id est-il facultatif lors de l’enregistrement d’une redirection ?
Non. Le schéma de création ou mise à jour de BigCommerce définit site_id comme un entier obligatoire, aux côtés de la chaîne de caractères obligatoire from_path. L’exemple de l’API inclut les deux champs dans l’objet de la requête.
La requête utilise-t-elle un identifiant de canal à la place d’un identifiant de site ?
L’objet de création ou mise à jour de redirection exige site_id. La documentation des sites de BigCommerce décrit channel_id comme une propriété du site, tandis que la requête de redirection utilise l’id du site dans site_id.
Une requête peut-elle contenir plusieurs redirections ?
Oui. Le point de terminaison attend une liste de 301RedirectUpsert et le corps de requête documenté est un tableau JSON contenant un objet de redirection.
Sources
- BigCommerce, « Upsert Redirects », sans date
- BigCommerce, « Introduction to Multi-Storefront », sans date
- BigCommerce, « Sites », sans date
Vérifiez comment une page se lit pour les moteurs de réponse. Ouvrir l’analyseur de score GEO