Passer au contenu principal
POST
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.

Corps

application/json

Une nouvelle famille de variantes : son code, le type d'articles que ses variantes représentent, ses champs communs et les options par lesquelles ses variantes diffèrent.

code
string
requis

Le code de la famille, jusqu'à 64 lettres, chiffres et . _ - /, commençant par une lettre ou un chiffre. Unique dans l'organisation, sans égard à la casse. Un modèle d'UGS l'écrit {family}.

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

Le genre d'article de chaque variante : stocked, non_stocked ou service.

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

Indique si chaque variante est fabriquée, achetée ou les deux : make, buy ou both.

Options disponibles:
make,
buy,
both
name
string
requis

Le nom de la famille, 255 caractères au plus.

Maximum string length: 255
options
object[]
requis

Les options qui distinguent les variantes, comme Taille et Couleur : d'une à trois, dans l'ordre. Chacune a un name d'au plus 50 lettres, chiffres et espaces, unique sans égard à la casse, et une liste de 1 à 50 values, chacune d'au plus 50 caractères et unique dans l'option, sans égard à la casse.

Required array length: 1 - 3 elements
description
string | null

Une description que toutes les variantes partagent à moins d'avoir la leur, d'au plus 5,000 caractères.

Maximum string length: 5000
custom_fields
object

Valeurs de champs personnalisés que les variantes de la famille partagent : 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.

Réponse

ItemFamilyPageResource

data
ItemFamilyPageResource · object
requis

Une famille et ses variantes, par UGS.