Aller au contenu principal

Produits

Remplacez votre jeton par l'espace réservé entre crochets dans la partie en-tête, et votre sous-domaine de localisation dans la partie URL comme indiqué ci-dessous.

Liste des produits​

Vous pouvez récupérer la liste des produits en utilisant l'appel API suivant :

curl -H "Authorization: Token [api_token]" https://[location_subdomain].datadocks.com/api/v1/products

Si votre jeton API est 12345 et que votre sous-domaine de localisation est toronto-acme, cela ressemblera à ceci :

curl -H "Authorization: Token 12345" https://toronto-acme.datadocks.com/api/v1/products

Vous pouvez passer les paramètres suivants pour filtrer la liste des produits retournés :

Filtrage​

name​

  • Type : Chaîne de caractères
  • Description : Le nom du produit pour filtrer. Ceci est une correspondance floue si fourni.
curl -H "Authorization: Token [api_token]" https://[location_subdomain].datadocks.com/api/v1/products?name=a

sku​

  • Type : Chaîne de caractères
  • Description : Le SKU du produit pour filtrer. Ceci est une correspondance exacte si fourni.
curl -H "Authorization: Token [api_token]" https://[location_subdomain].datadocks.com/api/v1/products?sku=1234

Exemple de charge utile​

[
  {
    "id": 1,
    "name": "Premier",
    "sku": "1A"
  },
  {
    "id": 2,
    "name": "Second",
    "sku": "2B"
  }
]

Champs​

id​

  • Type : Entier
  • Obligatoire : Oui
  • Description : Identifiant unique interne à DataDocks.
  • Valeurs possibles : Ne peut pas être défini en externe.

name​

  • Type : Chaîne de caractères
  • Obligatoire : Oui
  • Description : Le nom du produit.

sku​

  • Type : Chaîne de caractères
  • Obligatoire : Oui
  • Description : Le SKU du produit.

Création de produits​

Vous pouvez créer un produit en utilisant l'appel API suivant et en fournissant les données du produit au format JSON.

curl -v \
  -H "Accept: application/json" \
  -H "Content-type: application/json" \
  -H "Authorization: Token [api_token]" \
  -X POST \
  -d '{"product": {"name": "Troisième", "sku": "3C"}}' \
  https://[location_subdomain].datadocks.com/api/v1/products

Si votre jeton API est 12345 et que votre sous-domaine de localisation est toronto-acme, cela ressemblera à ceci :

curl -v \
  -H "Accept: application/json" \
  -H "Content-type: application/json" \
  -H "Authorization: Token 12345" \
  -X POST \
  -d '{"product": {"name": "Troisième", "sku": "3C"}}' \
  https://toronto-acme.datadocks.com/api/v1/products

Mise à jour des produits​

Vous pouvez mettre à jour un produit en utilisant l'appel API suivant et en fournissant les données du produit au format JSON. Notez que l'URL nécessite l'ID du produit à la fin (l'ID du produit DataDocks).

curl -v \
  -H "Accept: application/json" \
  -H "Content-type: application/json" \
  -H "Authorization: Token [api_token]" \
  -X PUT \
  -d '{"product": {"name": "Nom Modifié"}}' \
  https://[location_subdomain].datadocks.com/api/v1/products/[product_id]

Si votre jeton API est 12345, votre sous-domaine de localisation est toronto-acme et que l'ID du produit que vous souhaitez mettre à jour est 1, cela ressemblera à ceci :

curl -v \
  -H "Accept: application/json" \
  -H "Content-type: application/json" \
  -H "Authorization: Token 12345" \
  -X PUT \
  -d '{"product": {"name": "Nom Modifié"}}' \
  https://toronto-acme.datadocks.com/api/v1/products/1