API Sticker Mule

Démarrage rapide

1. Générer une clé API

Ouvrez les paramètres de votre compte et, dans les paramètres de Boutique, générez une clé API. Copiez-la immédiatement, elle n'est affichée qu'une seule fois.

2. Appeler l'API

Envoyez votre clé en tant que jeton Bearer. Cet exemple passe une commande pour un article enregistré :

curl -X POST https://www.stickermule.com/api/orders \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [{ "id": "456", "quantity": 50 }],
    "addressId": "22",
    "paymentId": "7"
  }'

Authentification

Chaque requête doit inclure votre clé API en tant que jeton Bearer dans l'en-tête "Authorization".

Authorization: Bearer YOUR_API_KEY

• L'API est disponible uniquement sur les comptes personnels, et non sur les comptes d'équipe.
• Chaque compte possède une clé. La génération d'une nouvelle clé remplace l'ancienne.
• Traitez la clé comme un mot de passe. Elle peut passer des commandes et lire vos données sauvegardées.

URL de base

Tous les endpoints sont relatifs à cette URL de base.

https://www.stickermule.com/api

Points de terminaison

GET /api/items - Éléments de la liste

Renvoie les articles que vous pouvez commander. L'identifiant de chaque article peut être utilisé sous la forme items[].id lors de la création d'une commande.

GET /api/items

Copier

curl "https://www.stickermule.com/api/items?limit=20" \
  -H "Authorization: Bearer YOUR_API_KEY"

Paramètres de requête

Paramètre	Type	Par défaut	Description
limit	number	20	Nombre d'articles à retourner, de 1 à 50.
offset	number	0	Nombre d'éléments à ignorer avant d'afficher les résultats.
currency	string	USD	Code de devise ISO 4217 utilisé pour les prix.
locale	string	en	Langue utilisée pour les noms et les prix des produits.

Réponse

Les résultats sont paginés avec une limite et un décalage, et l'option "canLoadMore" est activée lorsque davantage d'articles sont disponibles. La pagination étant basée sur le décalage, les pages peuvent se déplacer à mesure que de nouvelles commandes arrivent.

Champ	Type	Description
id	string	Identifiant de l'article. À utiliser sous la forme items[].id lors de la création d'une commande.
name	string | null	Nom personnalisé que vous avez donné à l'article, le cas échéant.
productId	number	Identifiant du produit Sticker Mule.
productName	string | null	Nom du produit, ou null si le produit n'est plus disponible.
quantity	number	Quantité de la commande initiale.
size	RegularItemDimensions | TShirtDimensions | HoodieDimensions	Taille de l'article. Pour les t-shirts et les t-shirts épais, un objet de taille de vêtement avec __typename TShirtDimensions et une taille. Pour les sweats à capuche, __typename HoodieDimensions et une taille. Pour tous les autres produits, les dimensions physiques en pouces avec __typename RegularItemDimensions ainsi que la largeur et la hauteur.
isSizeRequired	boolean	Vrai lorsque le produit nécessite une taille de vêtement pour être réapprovisionné (t-shirts, t-shirts épais et sweats à capuche). Faux dans le cas contraire.
buyingOptions	object | null	Quantités de réapprovisionnement autorisées : minimum, maximum et incrément. Valeur nulle si le produit est indisponible.
retailPrice	number | null	Prix correspondant à la quantité minimale, ou valeur nulle si le prix n'est pas disponible.
artworkUrls	string[]	URL des maquettes approuvées pour l'article.

Exemple de réponse

Copier

{
  "items": [
    {
      "id": "456",
      "name": "Logo stickers",
      "productId": 12,
      "productName": "Die cut stickers",
      "quantity": 50,
      "size": { "__typename": "RegularItemDimensions", "width": 3, "height": 3 },
      "isSizeRequired": false,
      "buyingOptions": {
        "quantity": { "min": 50, "max": 5000, "increment": 5 }
      },
      "retailPrice": 79,
      "artworkUrls": ["https://cdn.stickermule.com/artwork.png"]
    },
    {
      "id": "789",
      "name": "Team t-shirt",
      "productId": 34,
      "productName": "Custom t-shirts",
      "quantity": 25,
      "size": { "__typename": "TShirtDimensions", "size": "sizeL" },
      "isSizeRequired": true,
      "buyingOptions": {
        "quantity": { "min": 1, "max": 500, "increment": 1 }
      },
      "retailPrice": 18,
      "artworkUrls": ["https://cdn.stickermule.com/shirt.png"]
    },
    {
      "id": "812",
      "name": "Team hoodie",
      "productId": 56,
      "productName": "Custom hoodies",
      "quantity": 10,
      "size": { "__typename": "HoodieDimensions", "size": "sizeM" },
      "isSizeRequired": true,
      "buyingOptions": {
        "quantity": { "min": 1, "max": 500, "increment": 1 }
      },
      "retailPrice": 32,
      "artworkUrls": ["https://cdn.stickermule.com/hoodie.png"]
    }
  ],
  "canLoadMore": true
}

GET /api/addresses - Listez les adresses

Renvoie vos adresses de livraison enregistrées, par défaut en premier. Chaque identifiant est valide comme identifiant d'adresse lors de la création d'une commande.

GET /api/addresses

Copier

curl https://www.stickermule.com/api/addresses \
  -H "Authorization: Bearer YOUR_API_KEY"

Réponse

Champ	Type	Description
id	string	Identifiant d'adresse. À utiliser comme addressId lors de la création d'une commande.
name	string | null	Nom complet du destinataire.
firstName	string | null	Prénom du destinataire.
lastName	string | null	Nom de famille du destinataire.
companyName	string | null	Nom de l'entreprise, le cas échéant.
addressLine1	string	Adresse postale.
addressLine2	string | null	Ligne d'adresse supplémentaire, le cas échéant.
cityName	string	Ville.
stateName	string | null	Nom de l'État ou de la province, le cas échéant.
stateAbbreviation	string | null	Abréviation de l'État ou de la province, le cas échéant.
zipCode	string	Code Postal.
countryIso	string	Code pays ISO 3166, tel que "US".
countryName	string	Nom du pays.
phone	string | null	Numéro de téléphone, le cas échéant.
isDefault	boolean	Valable pour votre adresse de livraison par défaut.

Exemple de réponse

Copier

{
  "addresses": [
    {
      "id": "22",
      "name": "Jane Doe",
      "firstName": "Jane",
      "lastName": "Doe",
      "companyName": null,
      "addressLine1": "123 Main St",
      "addressLine2": null,
      "cityName": "Amsterdam",
      "stateName": null,
      "stateAbbreviation": null,
      "zipCode": "1000AA",
      "countryIso": "NL",
      "countryName": "Netherlands",
      "phone": "+31612345678",
      "isDefault": true
    }
  ]
}

GET /api/payments - Liste des modes de paiement

Renvoie vos moyens de paiement enregistrés, en commençant par celui défini par défaut. Chaque identifiant peut être utilisé comme paymentId lors de la création d'une commande.

GET /api/payments

Copier

curl https://www.stickermule.com/api/payments \
  -H "Authorization: Bearer YOUR_API_KEY"

Réponse

Champ	Type	Description
id	string	Identifiant du mode de paiement. Utilisez-le comme paymentId lors de la création d'une commande.
ccType	string	Marque de carte, telle que Visa ou Mastercard.
lastDigits	string	Les quatre derniers chiffres de la carte.
expiration	object	Date d'expiration de la carte (mois et année).
isDefault	boolean	C'est valable pour votre mode de paiement par défaut.

Exemple de réponse

Copier

{
  "payments": [
    {
      "id": "7",
      "ccType": "visa",
      "lastDigits": "1007",
      "expiration": { "month": 7, "year": 2028 },
      "isDefault": true
    }
  ]
}

GET /api/orders - Liste des commandes

Affiche la liste de vos commandes passées, de la plus récente à la plus ancienne. Le numéro de chaque commande correspond à celui renvoyé par la requête POST /api/orders.

GET /api/orders

Copier

curl "https://www.stickermule.com/api/orders?limit=10" \
  -H "Authorization: Bearer YOUR_API_KEY"

Paramètres de requête

Paramètre	Type	Par défaut	Description
limit	number	10	Nombre de commandes à retourner, de 1 à 50.
offset	number	0	Nombre de commandes à ignorer avant d'afficher les résultats.

Réponse

Les résultats sont paginés avec une limite et un décalage, et l'option "canLoadMore" est activée lorsque davantage de commandes sont disponibles. La pagination étant basée sur le décalage, les pages peuvent se déplacer à mesure que de nouvelles commandes sont placées.

Champ	Type	Description
number	string	Numéro de commande. La même valeur que celle renvoyée par la requête POST /api/orders.
state	"complete" | "canceled" | "gift_unclaimed" | "ready_for_production" | "in_production" | "ready_to_proof" | "awaiting_scheduled_date"	Statut de la commande.
paymentState	"paid" | "credit_owed" | "balance_due" | "failed" | "checkout" | "completed" | "pending" | "processing" | "void" | null	Le statut de paiement de la commande, ou la valeur "null".
shipmentState	"backorder" | "canceled" | "partial" | "pending" | "ready" | "shipped" | "returned_for_reship" | "reship" | "delivered"	Statut d'expédition de la commande. Par défaut : en attente.
placedAt	string	Lorsque la commande a été passée, sous la forme d'un horodatage conforme à la norme ISO 8601.
currency	string	Devise ISO 4217 dans laquelle la commande a été facturée.
itemTotal	number	Sous-total des articles, avant frais de port, taxes et réductions.
total	number	Montant total facturé, frais de port et taxes inclus, moins les remises.
expectedDeliveryDate	string | null	Date de livraison estimée sous forme d'horodatage ISO 8601, ou nulle.
deliveredAt	string | null	Lorsque la commande a été livrée, sous forme d'horodatage ISO 8601 ou de valeur nulle.

Exemple de réponse

Copier

{
  "orders": [
    {
      "number": "R286234605",
      "state": "complete",
      "paymentState": "paid",
      "shipmentState": "shipped",
      "placedAt": "2026-07-20T14:03:00.000Z",
      "currency": "USD",
      "itemTotal": 79,
      "total": 88.5,
      "expectedDeliveryDate": "2026-07-27T00:00:00.000Z",
      "deliveredAt": null
    }
  ],
  "canLoadMore": true
}

POST /api/orders - Créer une commande

Passe une commande pour un ou plusieurs articles enregistrés, expédiée à une adresse enregistrée et facturée selon un mode de paiement enregistré.

POST /api/orders

Copier

curl -X POST https://www.stickermule.com/api/orders \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [{ "id": "456", "quantity": 50 }],
    "addressId": "22",
    "paymentId": "7"
  }'

Corps de la requête

Champ	Type	Obligatoire	Description
items	array	Oui	Articles à commander. Doit contenir au moins un article.
items[].id	string	Oui	Un identifiant d'article provenant de la requête GET /api/items.
items[].quantity	number	Oui	Quantité à commander pour cet article.
items[].size	TShirtSize | HoodieSize | null	Non	Taille du vêtement, à indiquer lors de la commande de vêtements (t-shirts, t-shirts épais et sweats à capuche). Utilisez les valeurs ci-dessous correspondant au produit. Ne rien indiquer pour les autres produits.
addressId	string	Oui	Un identifiant d'adresse provenant de GET /api/addresses.
paymentId	string	Oui	Un identifiant de mode de paiement issu de l'API GET /api/payments.

Une commande peut contenir jusqu'à 50 articles. La quantité de chaque article doit respecter les valeurs minimales, maximales et d'incrément du produit, telles que définies dans l'API GET /api/items.

Tailles de vêtements

Les tailles disponibles dépendent de la coupe du produit :

• T-shirts et t-shirts épais (TShirtSize) : "sizeYS" | "sizeYM" | "sizeYL" | "sizeS" | "sizeM" | "sizeL" | "sizeXL" | "size2XL" | "size3XL" | "size4XL" | "size5XL" | "size6XL" | "size7XL"
• Sweats à capuche (HoodieSize) : "sizeS" | "sizeM" | "sizeL" | "sizeXL" | "size2XL"

Réponse

Exemple de réponse

Copier

{
  "order": { "number": "R286234605" }
}

Erreurs

Les erreurs renvoient le code d'état HTTP correspondant ainsi qu'un corps JSON contenant un type et un message.

{
  "type": "UserInputError",
  "message": "items is required and must be a non-empty array"
}

Comment tout cela s'articule-t-il ?

• Vous ne pouvez commander que des articles que vous avez déjà commandés. Les articles personnalisés, le ruban adhésif d'emballage et les lettrages en vinyle ne sont pas disponibles via l'API.
• Veuillez d'abord lire vos articles, adresses et modes de paiement, puis transmettre leurs identifiants à la requête POST /api/orders.
• La requête GET /api/orders affiche la liste de vos commandes passées, classées par ordre chronologique décroissant. Le numéro de chaque commande correspond à celui renvoyé par la requête POST /api/orders.
• La plupart des produits sont commandés à nouveau dans leurs dimensions d'origine (largeur et hauteur en pouces). Les vêtements (t-shirts, t-shirts épais et sweats à capuche) sont quant à eux proposés selon un système de tailles : l'appel GET /api/items renvoie cette information sous la clé size lorsque isSizeRequired est défini sur true, et vous devez transmettre items[].size pour les commander. Les tailles valides dépendent du produit, et vous pouvez modifier la taille lors d'une nouvelle commande, par exemple, commander un t-shirt de taille M en taille L.
• Les requêtes GET /api/items et GET /api/orders sont paginées à l'aide des paramètres "limit" et "offset". Ce n'est pas le cas des points de terminaison relatifs aux adresses et aux paiements.