Dictionnaire de données de migration des boutiques
Le dictionnaire de données de migration des boutiques inclut des informations sur l’API de l’interface administrateur REST Customer
, Order
et les ressourcesProduct
. Le dictionnaire de données est une référence supplémentaire pour les Partenaires expérimentés qui migrent leurs boutiques vers Shopify.
Customer
propriétés des ressources
Le tableau suivant donne quelques informations utiles sur les propriétés de la ressource Customer
de l’API de l’interface administrateur REST.
Propriété | Valeurs | Description | Type de données | Longueur du champ | Accès au champ | Champ obligatoire critique |
---|---|---|---|---|---|---|
accepts_marketing | Par défaut : 0 | Si le client a accepté de recevoir des communications marketing. | Booléen | tinyint(1) | Y | |
accepts_marketing_ updated_at |
La date et l’heure au format ISO 8601 auxquelles le client a accepté ou a refusé de recevoir des communications marketing par e-mail. | DateTime | adresses | Une liste d’adresses associées au client. | [{ Adresse }] | |
devise | Le code à trois lettres au format ISO 4217 pour la devise utilisée par le client lors du paiement de sa dernière commande. | Chaîne | Devise de la boutique | lecture seule | ||
creation_le | Par défaut : NULL | La date et l’heure au format ISO 8601 auxquelles le client a été ajouté à la boutique. | DateTime | datetime | lecture seule | |
default_address | L’adresse par défaut du client. | { Address } | ||||
Par défaut : NULL | L’adresse e-mail unique du client. | Chaîne | varchar(255) | |||
first_name (prénom) | Par défaut : NULL | Le prénom du client. | Chaîne | varchar(255) | ||
identifiant | Par défaut : NULL | Un identifiant unique à l’échelle mondiale. (Cette valeur s’auto-incrémente.) | Entier | bigint(20) | Y | |
last_name (nom) | Par défaut : NULL | Le nom du client. | Chaîne | varchar(255) | ||
last_order_id | Par défaut : NULL | L’ID de la dernière commande du client. | Entier | bigint(20) | lecture seule | |
last_order_name | Par défaut : NULL | Le nom de la dernière commande du client. | Chaîne | lecture seule | ||
champ méta | Par défaut : NULL | Renvoie un champ méta par espace de nom et clé qui appartient à la ressource. | { Metafield } | |||
marketing_opt_ in_level |
|
Le niveau d’adhésion à l’abonnement marketing (comme décrit par la directive des bonnes pratiques M3AAWG) que le client a choisi lorsqu’il a consenti à recevoir des communications marketing par e-mail. | String, enum | |||
multipass_identifier | Par défaut : NULL | Un identifiant unique pour le client qui est utilisé avec la connexion Multipass. | Chaîne | varchar(255) | ||
note | Par défaut : NULL | Un commentaire au sujet d’un client. | Chaîne | mediumtext | ||
.orders_count | Par défaut : 0 | Le nombre de commandes que le client a passées dans la boutique depuis la création de son compte. | Entier | int(11) | lecture seule | |
Téléphone | Par défaut : NULL | Le numéro de téléphone (au format E.164) unique (à l’échelle de la boutique) de ce client. | Chaîne | varchar(255) | ||
sms_marketing_ consent |
Par défaut : NULL | L’état actuel du marketing par SMS pour le numéro de téléphone du client. | Chaîne | |||
state |
|
L’état du compte du client par rapport à la boutique. | String, enum | varchar(255) | lecture seule | |
balises | Par défaut : NULL | Une liste séparée par des virgules de jusqu’à 250 balises qui ont été ajoutées au client. | Chaîne | 255 caractères par balise | ||
tax_exempt | Par défaut : 0 | Si le client est exempt de taxes sur ses commandes. | Booléen | tinyint(1) | Y | |
tax_exemptions | Consultez la ressource Customer pour obtenir une liste complète des valeurs. | La liste des exonérations fiscales appliquées au client. | Chaîne | |||
.total_spent | Par défaut : 0 | Le montant total dépensé par le client en commandes depuis la création de son compte. Indiqué dans la devise de la boutique. Si vous utilisez plusieurs devises, le montant est indiqué dans la devise par défaut, sans taux de change. | Numériques | decimal(21,3) | lecture seule | |
updated_at | La date et l’heure auxquelles le client a été mis à jour pour la dernière fois. En fonction du fuseau horaire de la boutique. | DateTime | datetime | lecture seule | ||
verified_email | Par défaut : 1 | Si le client a vérifié son adresse e-mail. La valeur par défaut est « true » si le client est créé via l’interface administrateur Shopify ou l’API Shopify. | Booléen | tinyint(1) | lecture seule |
CustomerAddress
propriétés des ressources
Le tableau suivant donne quelques informations utiles sur les propriétés de la ressource CustomerAddress
de l’API de l’interface administrateur REST. Il n’y a pas de champs en lecture seule ou de champs critiques obligatoires pour cette ressource.
Propriété | Valeurs | Description | Type de données | Longueur du champ | Accès au champ |
---|---|---|---|---|---|
address1 | Par défaut : NULL | L’adresse postale du client. 100 par compte client. | Chaîne | varchar(255) | |
address2 | Par défaut : NULL | Un champ supplémentaire pour l’adresse postale du client. | Chaîne | varchar(255) | |
city | Par défaut : NULL | La ville ou le village du client. | Chaîne | varchar(255) | |
company | Par défaut : NULL | L’entreprise du client. | Chaîne | varchar(255) | |
Pays | Par défaut : NULL | Pays du client. | Chaîne | varchar(255) | |
first_name (prénom) | Par défaut : NULL | Le prénom du client. | Chaîne | varchar(255) | |
country_code | Le code de pays à deux lettres correspondant au pays du client. | Chaîne | lecture seule | ||
country_name | Le nom normalisé du pays du client. | Chaîne | |||
last_name (nom) | Par défaut : NULL | Le nom du client. | Chaîne | varchar(255) | |
nom | Le prénom et le nom du client. | Chaîne | |||
Téléphone | Par défaut : NULL | Le numéro de téléphone du client à cette adresse. | Chaîne | varchar(255) | |
province | Par défaut : NULL | Le nom de la région du client. Il s’agit généralement d’une province, un État ou une préfecture. | Chaîne | varchar(255) | |
province_code | Le code à deux lettres pour la région du client. | Chaîne | lecture seule | ||
code postal | Par défaut : NULL | Le code postal du client. | Chaîne | varchar(255) |
Order
propriétés des ressources
Le tableau suivant donne quelques informations utiles sur les propriétés de la ressource Order
de l’API de l’interface administrateur REST.
Propriété | Valeurs | Description | Type de données | Longueur du champ | Accès au champ | Champ obligatoire critique |
---|---|---|---|---|---|---|
app_id | Par défaut : NULL | L’ID de l’application qui a créé la commande. | entier | bigint(20) | lecture seule | |
billing_address | Par défaut : NULL | L’adresse postale associée au moyen de paiement. Ce champ d’adresse est facultatif et ne sera pas disponible pour les commandes qui ne nécessitent pas de moyen de paiement. | entier | bigint(20) | ||
browser_ip | L’adresse IP du navigateur utilisé par le client au moment où il a passé la commande. IPv4 et IPv6 sont tous deux pris en charge. | chaîne | varchar(255) | lecture seule | ||
buyer_accepts_marketing | Par défaut : 0 | Si le client a accepté de recevoir des mises à jour par e-mail de la part de la boutique. | booléen | tinyint(1) | ||
cancel_reason |
|
La raison de l’annulation de la commande. | chaîne | varchar(255) | ||
cancelled_at | Par défaut : NULL | La date et l’heure auxquelles la commande a été annulée. Renvoie « null » si la commande n’est pas annulée. | date | datetime | lecture seule | |
cart_token | Par défaut : NULL | Une valeur unique en référence au panier qui est associé à la commande. | chaîne | varchar(255) | lecture seule | |
checkout_token | Par défaut : NULL | Une valeur unique en référence au paiement associé à la commande. | chaîne | varchar(64) | lecture seule | |
client_details |
|
Informations sur le navigateur que le client a utilisé au moment où il a passé sa commande : accept_language : les langues et les paramètres régionaux que le navigateur comprend. browser_height : la hauteur de l’écran du navigateur en pixels, si disponible. browser_ip : l’adresse IP du navigateur. browser_width : la largeur de l’écran du navigateur en pixels, si disponible. session_hash : un hachage de la session. user_agent : détails du client de navigation, y compris les versions du logiciel et du système d’exploitation. |
object | lecture seule | ||
closed_at | Par défaut : NULL | La date et l’heure (format ISO 8601) auxquelles la commande a été fermée. Renvoie « null » si la commande n’est pas fermée. | date | datetime | lecture seule | |
creation_le | Par défaut : NULL | La date et l’heure générées automatiquement (format ISO 8601) auxquelles la commande a été créée dans Shopify. La valeur de cette propriété ne peut pas être modifiée. | date | datetime(6) | lecture seule | |
devise | Par défaut : NULL | Le code à trois lettres (format ISO 4217) de la devise de la boutique. | chaîne | char(3) | ||
current_subtotal_price | Le sous–total actuel de la commande dans la devise de la boutique. La valeur de ce champ reflète les modifications, les retours et les remboursements des commandes. | chaîne | varchar(255) | lecture seule | ||
current_subtotal_price_set | Le sous–total actuel de la commande dans la devise de la boutique et la devise de présentation. Les valeurs des montants associés à ce champ reflètent les modifications, les retours et les remboursements des commandes. | object | lecture seule | |||
current_total_discounts | Le total actuel des réductions sur la commande dans la devise de la boutique. La valeur de ce champ reflète les modifications, les retours et les remboursements des commandes. | chaîne | varchar(255) | lecture seule | ||
current_total_discounts_set | Le total actuel des réductions sur la commande dans la devise de la boutique et la devise de présentation. Les valeurs des montants associés à ce champ reflètent les modifications, les retours et les remboursements des commandes. | object | lecture seule | |||
current_total_duties_set | Le total actuel des frais de douane facturés sur la commande dans la devise de la boutique et la devise de présentation. Les valeurs des montants associés à ce champ reflètent les modifications, les retours et les remboursements des commandes. | object | lecture seule | |||
current_total_price | Le prix total actuel de la commande dans la devise de la boutique. La valeur de ce champ reflète les modifications, les retours et les remboursements des commandes. | chaîne | varchar(255) | lecture seule | ||
current_total_price_set | Le prix total actuel de la commande dans la devise de la boutique et la devise de présentation. Les valeurs des montants associés à ce champ reflètent les modifications, les retours et les remboursements des commandes. | object | lecture seule | |||
current_total_tax | Le total actuel des taxes facturées sur la commande dans la devise de la boutique. La valeur de ce champ reflète les modifications, les retours et les remboursements des commandes. | chaîne | varchar(255) | lecture seule | ||
current_total_tax_set | Le total actuel des taxes facturées sur la commande dans la devise de la boutique et la devise de présentation. Les valeurs des montants associés à ce champ reflètent les modifications, les retours et les remboursements des commandes. | object | lecture seule | |||
client | Par défaut : NULL | Informations sur le client. La commande peut ne pas avoir de client et les applications ne doivent pas dépendre de l’existence d’un objet client. Cette valeur peut être « null » si la commande a été créée via Shopify PDV | entier | bigint(20) | ||
customer_locale | Par défaut : NULL | Le code de langue à deux ou trois lettres, éventuellement suivi d’un modificateur de région. | chaîne | varchar(255) | lecture seule | |
discount_applications | Une liste classée d’applications de réductions empilées. La propriété discount_applications inclut 3 types : discount_code, manual et script. Les 3 types partagent une structure commune et ont des attributs spécifiques à chaque type. |
array | lecture seule | |||
discount_codes | Une liste de réductions appliquées à la commande. | array | ||||
L'adresse e-mail du client. | varchar(255) | |||||
estimated_taxes | Si des taxes sont estimées sur la commande. De nombreux facteurs peuvent changer entre le moment où un client passe une commande et celui où la commande est expédiée, ce qui peut influer sur le calcul des taxes. Cette propriété renvoie « false » lorsque les taxes sur la commande sont finalisées et ne sont soumises à aucun changement. | booléen | tinyint(1) | |||
financial_status |
|
Le statut des paiements associés à la commande. Ne peut être défini que lorsque la commande est créée. | chaîne | varchar(255) | lecture seule | |
fulfillment_status |
|
Le statut de la commande en termes de rubriques traitées. | chaîne | varchar(255) | ||
traitements | Un tableau de traitements associés à la commande | array | ||||
identifiant | Par défaut : NULL | L’ID de la commande, utilisé pour l’API. Ceci est différent de la propriété order_number, qui est l’ID utilisé par le propriétaire de la boutique et le client. | entier | bigint(20) | lecture seule | |
landing_site | Par défaut : NULL | L’URL de la page où l’acheteur est arrivé lorsqu’il est entré dans la boutique. | chaîne | varchar(4096) | lecture seule | |
line_items | Une liste d’objets de rubrique, contenant chacun des informations sur un article de la commande | array | Y | |||
location_id | Par défaut : NULL | L’ID de l’emplacement physique où la commande a été traitée. Si vous devez faire référence à un emplacement par rapport à une commande, utilisez la ressource FulfillmentOrder. | entier | bigint(20) | ||
nom | Par défaut : NULL | Le nom de la commande, généré en combinant la propriété order_number avec le préfixe et le suffixe de la commande, qui sont définis dans les paramètres généraux du marchand. Ceci est différent de la propriété id, qui est l’ID de la commande utilisé par l’API. Ce champ peut également être défini par l’API comme n’importe quelle valeur de chaîne. | chaîne | varchar(255) | ||
note | Par défaut : NULL | Une remarque facultative que le propriétaire d’une boutique peut joindre à la commande. | chaîne | |||
note_attributes | Par défaut : NULL | Des informations supplémentaires ajoutées à la commande. Apparaît dans la section Détails supplémentaires de la page de détails d’une commande. Chaque entrée de tableau doit contenir un hachage avec clés de nom et de valeur. | chaîne | |||
nombre | Par défaut : NULL | La position de la commande dans le compte de commandes de la boutique. Les numéros sont séquentiels et commencent à 1. | entier | int(11) | lecture seule | |
numero_commande | La position de la commande dans le compte de commandes de la boutique à partir de 1001. Les numéros de commande sont séquentiels. | entier | bigint(20) | lecture seule | ||
order_status_url | L’URL qui pointe vers la page web du statut de la commande, le cas échéant. | chaîne | varchar(255) | lecture seule | ||
original_total_duties_set | Le total d’origine des frais de douane facturés pour la commande dans la devise de la boutique et la devise de présentation. | object | lecture seule | |||
payment_gateway_names | Par défaut : NULL | La liste des passerelles de paiement utilisées pour la commande. |
varchar(255) | lecture seule | ||
payment_terms | Par défaut : NULL | Les conditions générales d’utilisation en vertu desquelles un paiement doit être traité. | object | bigint(20) | lecture seule | |
Téléphone | Par défaut : NULL | Le numéro de téléphone du client pour recevoir des notifications par SMS. | chaîne | varchar(255) | ||
presentment_currency | Par défaut : NULL | La devise de présentation qui a été utilisée pour afficher les prix au client. | chaîne | char(3) | ||
processed_at | Par défaut : NULL | La date et l’heure (format ISO 8601) auxquelles une commande a été traitée. Cette valeur est la date qui apparaît sur vos commandes et qui est utilisée dans les rapports d’analyse. Si vous importez des commandes à partir d’une application ou d’une autre plateforme, vous pouvez définir processed_at à une date et une heure dans le passé pour que celles–ci correspondent à la date de création de la commande d’origine. | date | datetime(6) | ||
processing_method |
|
Mode de traitement du paiement | chaîne | varchar(255) | lecture seule | |
referring_site | Par défaut : NULL | Le site web où le client a cliqué sur un lien vers la boutique. | chaîne | varchar(4096) | ||
remboursements | Une liste des remboursements appliqués à la commande | array | lecture seule | |||
shipping_address | Par défaut : NULL | L’adresse postale à laquelle la commande sera expédiée. Cette adresse est facultative et ne sera pas disponible pour les commandes qui ne nécessitent pas d’expédition | entier | bigint(20) | ||
shipping_lines | Un tableau d’objets, chacun indiquant un mode d’expédition utilisé. | array | ||||
source_name | Par défaut : NULL | D’où provient la commande. Ne peut être défini que lors de la création d’une commande et ne peut pas être modifié par la suite. Les valeurs des canaux Shopify sont protégées et ne peuvent pas être attribuées par d’autres clients API : web, pos, shopify_draft_order, iphone, et android. N’importe quelle autre chaîne de votre choix peut être attribuée aux commandes créées via l’API. Si celle–ci n’est pas spécifiée, la valeur de l’ID de votre application est attribuée aux nouvelles commandes. | chaîne | varchar(255) | ||
subtotal_price | Le prix de la commande dans la devise de la boutique après réductions, mais avant l’expédition, les frais de douane, les taxes et les pourboires. | entier | bigint(20) | |||
subtotal_price_set | Le sous–total de la commande dans la devise de la boutique et la devise de présentation, après réductions, mais avant l’expédition, les frais de douane, les taxes et les pourboires. | object | ||||
balises | Balises jointes à la commande, formatées comme une chaîne de valeurs séparées par des virgules. Les balises sont des descripteurs courts supplémentaires, couramment utilisés pour le filtrage et la recherche. La longueur de chaque balise individuelle est limitée à 40 caractères. | chaîne | varchar(4096) | |||
tax_lines | Un tableau d’objets de ligne de taxe, dont chacun indique une taxe applicable à la commande. Chaque objet possède les propriétés suivantes : Lors de la création d’une commande via l’API, des lignes de taxes peuvent être spécifiées sur la commande ou sur les rubriques, mais pas sur les deux. Les lignes de taxes indiquées sur la commande sont réparties sur les rubriques taxables de la commande créée. |
array | ||||
taxes_included |
|
Si les taxes sont incluses dans le sous–total de la commande. | booléen | tinyint(1) | ||
test |
|
S’il s’agit d’une commande de test. | booléen | tinyint(1) | lecture seule | |
token | Par défaut : NULL | Une valeur unique en référence à la commande. | chaîne | varchar(32) | lecture seule | |
total_discounts | Par défaut : 0 | Le total des réductions appliquées au prix de la commande dans la devise de la boutique. | chaîne | decimal(21,3) | ||
total_discounts_set | Le total des réductions appliquées au prix de la commande dans la devise de la boutique et la devise de présentation. | object | ||||
total_line_items_price | Par défaut : 0 | La somme de tous les prix des rubriques dans la devise de la boutique. | chaîne | decimal(21,3) | ||
total_line_items_price_set | Le total de tous les prix des rubriques dans la devise de la boutique et la devise de présentation. | object | ||||
total_outstanding | Par défaut : 0 | Le montant total impayé de la commande dans la devise de la boutique. | chaîne | decimal(21,3) | ||
total_price | Par défaut : 0 | La somme de tous les prix de rubriques, réductions, frais d’expédition, taxes et pourboires dans la devise de la boutique. Doit être positif. | chaîne | decimal(21,3) | ||
total_price_set | Le prix total de la commande dans la devise de la boutique et la devise de présentation. | object | ||||
total_shipping_price_set | Le prix d’expédition total de la commande, à l’exception des réductions et des retours, dans la devise de la boutique et la devise de présentation. Si taxes_included est défini sur « true », les taxes sont incluses dans total_shipping_price_set. | object | ||||
total_tax | Par défaut : 0 | La somme de toutes les taxes appliquées à la commande dans la devise de la boutique. Doit être positif. | chaîne | decimal(21,3) | ||
total_tax_set | Le total des taxes appliquées à la commande dans la devise de la boutique et la devise de présentation. | object | ||||
total_tip_received | La somme de tous les pourboires de la commande dans la devise de la boutique. | entier | bigint(20) | lecture seule | ||
total_weight | Par défaut : 0 | La somme des poids de toutes les rubriques en grammes. La somme n’est pas ajustée lorsque des articles sont retirés de la commande. | entier | bigint(20) unsigned | ||
updated_at | La date et l’heure (format ISO 8601) de la dernière modification de la commande. | date | datetime(6) | lecture seule | ||
user_id | Par défaut : NULL | L’ID de l’utilisateur connecté à Shopify PDV qui a traité la commande, le cas échéant. | entier | bigint(20) |
Product
propriétés des ressources
Le tableau suivant donne quelques informations utiles sur les propriétés de la ressource Product
de l’API de l’interface administrateur REST.
Propriété | Valeurs | Description | Type de données | Longueur du champ | Accès au champ | Champ obligatoire critique |
---|---|---|---|---|---|---|
body_html | Par défaut : NULL | Une description du produit. Prend en charge le formatage HTML. | chaîne | mediumtext | ||
creation_le | Par défaut : NULL | La date et l’heure (format ISO 8601) auxquelles le produit a été créé. | date | datetime | lecture seule | |
handle | Par défaut : NULL | chaîne | varchar(255) | |||
identifiant | Par défaut : NULL | Un nombre entier de 64 bits non signé, qui est utilisé comme identifiant unique du produit. Chaque ID est unique dans le système de Shopify. Deux produits n’auront jamais le même ID, même s’ils viennent de boutiques différentes. | entier | bigint(20) | lecture seule | Y |
images | Une liste d’objets d’image de produit, chacun représentant une image associée au produit. | [{ product_image }] | ||||
options | Les propriétés personnalisées du produit. Par exemple Taille, Couleur et Matériau. Chaque produit peut avoir jusqu’à 3 options et la longueur maximale de chaque valeur d’option est de 255 caractères. Les variantes de produits sont faites de combinaisons de valeurs d’option. Les options ne peuvent pas être créées sans valeurs. Pour créer de nouvelles options, une variante avec une valeur d’option associée doit également être créée. | array | ||||
product_type | Par défaut : NULL | Une catégorisation du produit utilisée pour le filtrage et la recherche de produits. | chaîne | varchar(255) | ||
published_at | Par défaut : NULL | La date et l’heure (format ISO 8601) auxquelles le produit a été publié. Peut être défini sur « null » pour annuler la publication du produit depuis le canal Boutique en ligne. | date | datetime | ||
published_scope |
|
Si le produit est publié sur le canal Point de vente. | chaîne | |||
statut |
|
Le statut du produit. | chaîne | varchar(32) | ||
balises | Une chaîne de balises séparées par des virgules, qui sont utilisées pour le filtrage et la recherche. Un produit peut avoir jusqu’à 250 balises. La longueur maximale de chaque balise est de 255 caractères. | chaîne | ||||
template_suffix | Par défaut : NULL | Le suffixe du modèle Liquid utilisé pour la page de produit. Si cette propriété est spécifiée, la page de produit utilise un modèle appelé « product.suffix.liquid », où « suffix » est la valeur de cette propriété. Si cette propriété est vide ou « null », la page du produit utilise le modèle par défaut « product.liquid ». | chaîne | varchar(255) | ||
title | Par défaut : NULL | Le nom du produit. | chaîne | varchar(255) | ||
updated_at | Par défaut : NULL | La date et l’heure (format ISO 8601) auxquelles le produit a été modifié pour la dernière fois. La valeur updated_at d’un produit peut changer pour différentes raisons. Par exemple, si une commande est passée pour un produit utilisant le suivi des stocks, l’ajustement du stock est compté comme une mise à jour. | date | datetime | lecture seule | |
variantes | Un tableau de variantes de produit, chacune représentant une version différente du produit. La propriété de position est en lecture seule. La position des variantes est indiquée par l’ordre dans lequel elles sont répertoriées. | array | ||||
fournisseur | Par défaut : NULL | Le nom du fournisseur du produit. | chaîne | varchar(255) |
ProductImage
propriétés des ressources
Le tableau suivant donne quelques informations utiles sur les propriétés de la ressource ProductImage
de l’API de l’interface administrateur REST. Il n’y a pas de champs en lecture seule ou de champs critiques obligatoires pour cette ressource.
Propriété | Valeurs | Description | Type de données | Longueur du champ |
---|---|---|---|---|
creation_le | Par défaut : NULL | La date et l’heure de création de l’image du produit. L’API renvoie cette valeur au format ISO 8601. | date | datetime |
height | Par défaut : NULL | Dimension en hauteur de l’image, qui est déterminée lors de l’importation. | smallint(4) unsigned | |
identifiant | Par défaut : NULL | Un identifiant numérique unique pour l’image du produit. (auto_increment) | entier | bigint(20) |
position | Par défaut : 0 | L’ordre de l’image de produit dans la liste. La première image du produit est à la position 1 et est l’image « principale » du produit. | smallint(5) unsigned | |
product_id | Par défaut : NULL | L’ID du produit associé à l’image. | bigint(20) | |
src | Indique l’emplacement de l’image du produit. Ce paramètre prend en charge les filtres URL que vous pouvez utiliser pour récupérer les copies modifiées de l’image. Par exemple, ajoutez _small au nom du fichier pour récupérer une copie à l’échelle de l’image à 100 x 100 px (par exemple, ipod-nano_small.png), ou ajoutez _2048x2048 pour récupérer une copie de l’image à une résolution de 2048 x 2048 px (par exemple, ipod-nano_2048x2048.png). | |||
updated_at | Par défaut : NULL | La date et l’heure auxquelles l’image du produit a été modifiée pour la dernière fois. L’API renvoie cette valeur au format ISO 8601. | date | datetime |
variant_ids | Un tableau d’ID de variantes associés à l’image. | |||
width | Par défaut : NULL | Dimension en largeur de l’image, qui est déterminée lors de l’importation. | smallint(4) unsigned |
ProductVariant
propriétés des ressources
Le tableau suivant donne quelques informations utiles sur les propriétés de la ressource ProductVariant
de l’API de l’interface administrateur REST. Il n’y a pas de champs en lecture seule ou de champs critiques obligatoires pour cette ressource.
Propriété | Valeurs | Description | Type de données | Longueur du champ | Accès au champ |
---|---|---|---|---|---|
code-barres | Par défaut : NULL | Le code-barres, le code UPC ou le numéro ISBN du produit. | varchar(255) | ||
compare_at_price | Par défaut : NULL | Le prix d’origine de l’article avant un ajustement ou une promotion. | decimal(20,2) | ||
creation_le | Par défaut : NULL | La date et l’heure (format ISO 8601) auxquelles la variante de produit a été créée. | date | datetime | |
fulfillment_service |
|
Le service de traitement des commandes associé à la variante du produit. | varchar(255) | ||
grams | Le poids de la variante du produit en grammes. | ||||
identifiant | Par défaut : NULL | L’identifiant numérique unique de la variante du produit. Cette valeur s’auto-incrémente. | bigint(20) | ||
image_id | Par défaut : NULL | L’identifiant numérique unique pour l’image d’un produit. L’image doit être associée au même produit que la variante. | bigint(20) | ||
inventory_item_id | L’identifiant unique de l’article en stock, qui est utilisé dans l’API Stock pour rechercher des informations sur le stock. | ||||
inventory_management |
|
Le service de traitement des commandes qui suit le nombre d’articles en stock pour la variante du produit. | varchar(255) | ||
inventory_policy |
|
Si les client(e)s peuvent passer commande pour la variante de produit en rupture de stock. | varchar(40) | ||
inventory_quantity | Par défaut : 1 | La somme des stocks pour tous les emplacements. Pour ajuster le stock à un emplacement spécifique, utilisez la ressource InventoryLevel. | int(11) | lecture seule | |
option | Les propriétés personnalisées que le propriétaire d’une boutique utilise pour définir les variantes de produit. Vous pouvez définir trois options pour une variante de produit : option1, option2, option3. Valeur par défaut : Default Title. Le champ de titre est une concaténation des champs option1, option2 et option3. Lorsque les champs d’option sont mis à jour, le champ de titre est également mis à jour. | ||||
position | Par défaut : 0 | L’ordre de la variante du produit dans la liste des variantes de produit. La première position de la liste est 1. La position des variantes est indiquée par l’ordre dans lequel elles sont répertoriées. | smallint(5) unsigned | lecture seule | |
presentment_prices | Une liste des prix de présentation et des prix avant réduction de la variante dans chacune des devises de présentation activées de la boutique. Chaque objet de prix possède les propriétés suivantes : -currency_code : le code à trois lettres (format ISO 4217) pour l’une des devises de présentation activées de la boutique. -amount : le prix ou le prix avant réduction de la variante dans la devise de présentation. Nécessite l’en–tête ’X-Shopify-Api-Features’: ’include-presentment-prices’. |
lecture seule | |||
prix | Par défaut : 0 | Le prix de la variante du produit. | decimal(20,2) | ||
product_id | Par défaut : NULL | L'identifiant numérique unique du produit. | bigint(20) | ||
requires_shipping | Par défaut : 1 | Cette propriété est obsolète. Utilisez plutôt la propriété « requires_shipping » sur la ressource InventoryItem. | booléen | tinyint(1) | |
sku | Un identifiant unique pour la variante de produit dans la boutique. Requis pour pouvoir se connecter à un FulfillmentService (service de traitement des commandes). | varchar(255) | |||
tax_code | Ce paramètre s’applique uniquement aux boutiques qui ont installé l’application Avalara AvaTax. Indique le code des impôts Avalara pour la variante du produit. | ||||
taxable | Par défaut : 1 | Si une taxe est facturée lors de la vente de la variante de produit. | booléen | tinyint(1) | |
title | Le titre de la variante du produit. Le champ de titre est une concaténation des champs option1, option2 et option3. Le titre ne peut être mis à jour que de manière indirecte, en utilisant les champs d’option. | varchar(255) | lecture seule | ||
updated_at | Par défaut : NULL | La date et l’heure auxquelles la variante du produit a été modifiée pour la dernière fois. Est renvoyé au format ISO 8601. | date | datetime | |
poids | Le poids de la variante du produit dans le système d’unités spécifié avec weight_unit. | ||||
weight_unit |
|
L’unité de mesure qui s’applique au poids de la variante du produit. Si vous ne précisez pas de valeur pour weight_unit, l’unité de mesure par défaut de la boutique est appliquée. | varchar(2) |