Passer au contenu principal
PUT
cURL

Autorisations

Authorization
string
header
requis

Pour vos propres scripts et vos intégrations de serveur à serveur. Créez une clé dans l'application sous Paramètres > Accès > Clés d'API et copiez-la à ce moment-là, car elle n'est affichée qu'une fois. Envoyez-la sous la forme Authorization: Bearer <key>. La clé agit en tant que le membre qui l'a créée, dans l'organisation où elle a été créée. Un appel exige l'autorisation du membre et l'une des portées de la clé, comme inventory:read ou sales:write. Une clé avec * a toutes les portées.

Paramètres de chemin

item
string
requis

L'ID de l'article, un UUID.

Corps

application/json

Les champs d'un article, pour le créer ou le modifier. Une UGS est composée de lettres, de chiffres et de . _ - /, et commence par une lettre ou un chiffre. Le poids, les dimensions et le code douanier sont ce dont un transporteur a besoin pour expédier l'article.

sku
string
requis

L'UGS de l'article, jusqu'à 64 lettres, chiffres et . _ - /, commençant par une lettre ou un chiffre. Unique dans l'organisation, sans égard à la casse, donc ab-1 est refusé lorsque AB-1 existe.

Maximum string length: 64
Pattern: ^[A-Za-z0-9][A-Za-z0-9._\/-]*$
name
string
requis

Le nom de l'article tel qu'il apparaît sur les documents et les étiquettes, 255 caractères au plus.

Maximum string length: 255
type
enum<string>
requis

Le genre d'article : stocked est compté en stock, non_stocked est acheté ou utilisé sans être compté et service est du travail, comme des frais de réglage.

Options disponibles:
stocked,
non_stocked,
service
make_or_buy
enum<string>
requis

Indique si l'organisation fabrique l'article, l'achète ou fait les deux : make, buy ou both.

Options disponibles:
make,
buy,
both
description
string | null

Une description plus longue de l'article, d'au plus 5,000 caractères. Omettez-la ou envoyez null pour aucune.

Maximum string length: 5000
brand
string | null

La marque sous laquelle l'article est vendu, au plus 255 caractères.

Maximum string length: 255
custom_fields
object

Valeurs de champs personnalisés par clé de champ : texte, nombre (une chaîne décimale est exacte), date YYYY-MM-DD, booléen ou l'une des options d'un champ de sélection. Les champs omis sont effacés.

weight
string | null

Le poids d'une unité de base, sous forme de chaîne décimale supérieure à zéro avec jusqu'à huit chiffres et quatre décimales. Il sert à tarifer et à étiqueter les expéditions.

Pattern: ^\d{1,8}(\.\d{1,4})?$
weight_unit
enum<string> | null

L'unité dans laquelle weight est exprimé : g, kg, oz ou lb. Obligatoire avec un poids.

Options disponibles:
g,
kg,
oz,
lb
length
string | null

La longueur d'une unité de base, sous forme de chaîne décimale supérieure à zéro avec jusqu'à huit chiffres et quatre décimales. Envoyez length, width et height ensemble ou aucun des trois.

Pattern: ^\d{1,8}(\.\d{1,4})?$
width
string | null

La largeur d'une unité de base, au même format que length. Obligatoire avec length ou height.

Pattern: ^\d{1,8}(\.\d{1,4})?$
height
string | null

La hauteur d'une unité de base, dans le même format que length. Obligatoire avec length ou width.

Pattern: ^\d{1,8}(\.\d{1,4})?$
dimension_unit
enum<string> | null

L'unité dans laquelle length, width et height sont exprimés : mm, cm ou in. Obligatoire avec les dimensions.

Options disponibles:
mm,
cm,
in
hs_code
string | null

Le code du Système harmonisé selon lequel les douanes classent l'article, sur 6 à 10 chiffres sans points.

Pattern: ^\d{6,10}$

Réponse

ItemResource

data
ItemResource · object
requis

Un article que l'organisation fabrique, achète, stocke ou vend, avec les valeurs de ses champs personnalisés et ses détails d'expédition.