Aller au contenu principal

Bons de commande

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​

Vous pouvez récupérer la liste des bons de commande à l'aide de l'appel API suivant :

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

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

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

Exemple de chargement​

[
  {
    "id": 1,
    "po_number": "A-1000",
    "name": "A-1000-FastCo-Cereal",
    "carrier_name": "FastCo",
    "location_name": "Toronto",
    "outbound": false,
    "expected_starts_at": "2020-10-09T13:35:00-04:00",
    "expected_ends_at": "2020-10-15T13:35:00-04:00",
    "custom_values": {
      "expected_at": "2020-10-09",
      "travel_type": "Avion",
      "forklift_operator": "Joe "
    },
    "purchase_order_items": [
      {
        "id": 2,
        "customer_name": "FishCo",
        "product_name": "Trout",
        "unit_name": "Skid",
        "quantity": 16,
        "weight": 102,
        "custom_values": {}
      },
      {
        "id": 1,
        "customer_name": "FishCo",
        "product_name": "Céréales",
        "unit_name": "Skid",
        "quantity": 33,
        "weight": 581,
        "custom_values": {}
      }
    ]
  },
  {
    "id": 2,
    "po_number": "A-2000",
    "name": "A-2000-FastCo-Laptops",
    "carrier_name": "FastCo",
    "location_name": "Vancouver",
    "outbound": false,
    "expected_starts_at": "2020-09-30T13:35:00-04:00",
    "expected_ends_at": "2020-10-14T13:35:00-04:00",
    "custom_values": {
      "travel_type": "Vélo",
      "forklift_operator": "Frank"
    },
    "purchase_order_items": [
      {
        "id": 3,
        "customer_name": "FishCo",
        "product_name": "Ordinateurs portables",
        "unit_name": "Boîte",
        "quantity": 40,
        "weight": 795,
        "custom_values": {
          "travel_type": "Camion",
          "forklift_operator": "Sam"
        }
      },
      {
        "id": 4,
        "customer_name": "FishCo",
        "product_name": "Trout",
        "unit_name": "Skid",
        "quantity": 10,
        "weight": 152,
        "custom_values": {
          "travel_type": "Vélo",
          "forklift_operator": "Jenny"
        }
      }
    ]
  }
]

Champs​

id​

  • Type : Entier
  • Requis : Vrai
  • Description : Identifiant unique interne DataDocks.
  • Valeurs possibles : Ne peut pas être défini extérieurement.

po_number​

  • Type : Chaîne
  • Requis : Vrai
  • Description : Numéro de bon de commande.

name​

  • Type : Chaîne
  • Requis : Vrai
  • Description : Nom composé par DataDocks en interne basé sur les valeurs dans les champs et les articles du bon de commande.
  • Valeurs possibles : Ne peut pas être défini extérieurement.

carrier_name​

  • Type : Chaîne
  • Requis : Faux
  • Description : Le nom du transporteur auquel le bon de commande est attribué.

location_name​

  • Type : Chaîne
  • Requis : Faux
  • Description : Nom de l'emplacement associé au bon de commande.
  • Valeurs possibles : Optionnel. Les bons de commande ne doivent pas nécessairement être propres à un emplacement.

outbound​

  • Type : Booléen
  • Requis : Vrai
  • Description : Vrai s'il s'agit d'un bon de commande sortant, Faux s'il s'agit d'un bon de commande entrant. Défaut à Faux.

expected_starts_at​

  • Type : DateTime
  • Requis : Faux
  • Description : Quand le bon de commande est censé commencer.

expected_ends_at​

  • Type : DateTime
  • Requis : Faux
  • Description : Quand le bon de commande est censé se terminer.

closed​

  • Type : Booléen
  • Requis : Faux
  • Description : Marquez le booléen comme vrai pour fermer le bon de commande et empêcher les réservations futures. Ce champ est uniquement visible dans l'interface lorsque le paramètre "PO Valide" est activé.

custom_values​

  • Type : Hash
  • Requis : Faux
  • Description : Un hash (objet) de paires clé / valeur des champs personnalisés qui ont été complétés pour le bon de commande.

purchase_order_items​

  • Type : Tableau
  • Requis : Faux
  • Description : Les articles (listes d'emballage) appartenant au bon de commande.

purchase_order_items > id​

  • Type : Entier
  • Requis : Vrai
  • Description : Identifiant unique interne DataDocks.
  • Valeurs possibles : Ne peut pas être défini extérieurement.

purchase_order_items > customer_name​

  • Type : Chaîne
  • Requis : Faux
  • Description : Le nom du client auquel l'article est associé.

purchase_order_items > product_name​

  • Type : Chaîne
  • Requis : Vrai
  • Description : Nom du produit auquel l'article est associé.

purchase_order_items > unit_name​

  • Type : Chaîne
  • Requis : Faux
  • Description : Nom de l'unité à laquelle l'article est associé.

purchase_order_items > quantity​

  • Type : Décimal
  • Requis : Faux
  • Description : La quantité.

purchase_order_items > weight​

  • Type : Décimal
  • Requis : Faux
  • Description : Le poids.

purchase_order_items > custom_values​

  • Type : Hash
  • Requis : Faux
  • Description : Un hash (objet) de paires clé / valeur des champs personnalisés qui ont été complétés pour l'article.

Création de bons de commande​

Vous pouvez créer un bon de commande à l'aide de l'appel API suivant et en fournissant les données du bon de commande au format JSON.

curl -v \
  -H "Accept: application/json" \
  -H "Content-type: application/json" \
  -H "Authorization: Token [api_token]" \
  -X POST \
  -d '{"purchase_order": {"po_number": "A12345"}}' \
  https://[location_subdomain].datadocks.com/api/v1/purchase_orders

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

curl -v \
  -H "Accept: application/json" \
  -H "Content-type: application/json" \
  -H "Authorization: Token 12345" \
  -X POST \
  -d '{"purchase_order": {"po_number": "A12345"}}' \
  https://toronto-acme.datadocks.com/api/v1/purchase_orders

Mise à jour des bons de commande​

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

curl -v \
  -H "Accept: application/json" \
  -H "Content-type: application/json" \
  -H "Authorization: Token [api_token]" \
  -X PUT \
  -d '{"purchase_order": {"po_number": "A123456"}}' \
  https://[location_subdomain].datadocks.com/api/v1/purchase_orders/[purchase_order_id]

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

curl -v \
  -H "Accept: application/json" \
  -H "Content-type: application/json" \
  -H "Authorization: Token 12345" \
  -X PUT \
  -d '{"purchase_order": {"po_number": "A123456"}}' \
  https://toronto-acme.datadocks.com/api/v1/purchase_orders/1

Suppression des bons de commande​

Vous pouvez supprimer un bon de commande à l'aide de l'appel API suivant. Notez que l'URL nécessite l'ID du bon de commande à la fin (l'ID du bon de commande DataDocks).

curl -v \
  -H "Accept: application/json" \
  -H "Content-type: application/json" \
  -H "Authorization: Token [api_token]" \
  -X DELETE \
  https://[location_subdomain].datadocks.com/api/v1/purchase_orders/[purchase_order_id]

Si votre jeton API est 12345, votre sous-domaine de localisation est toronto-acme, et l'ID du bon de commande que vous souhaitez supprimer est 1 cela ressemblerait à :

curl -v \
  -H "Accept: application/json" \
  -H "Content-type: application/json" \
  -H "Authorization: Token 12345" \
  -X DELETE \
  https://toronto-acme.datadocks.com/api/v1/purchase_orders/1