Description générale de l'API FuturWeb

Tous les appels aux services FuturWeb sont formatés de la manière suivante : https://jws.futurlog.com/{Application}/{Action}/{MerchantCode}/{Login}/{Key}/{Parameter}

Composantes de l'URL

MerchantCode

MerchantCode est votre code marchand. Il est composé de 3 caractères alphanumériques et vous est fourni par FuturLog.

Login

Login détermine le compte avec lequel vous effectuerez les actions sur le Web Service. Le Login vous est fourni par FuturLog.

En environnement de test, ce Login doit être suivi de -test.

Key

Key est la clé permettant de vous identifier auprès de nos services. La clé vous est fournie par FuturLog.

Elle est différente en environnement de test et en environnement de production.

Elle est composée de 64 caractères [a-Z0-9].

Parameter

Parameter est un paramètre facultatif selon la méthode que vous souhaitez appeler. Il sera détaillé plus bas.

Méthodes

Déclarer une nouvelle commande

Requête

Url /Order/CreateNewOrder/{merchantCode}/{login}/{key}
Type POST
En-tête Accept "application/json"
Corps Order

Réponse

HTTP Status 200
Corps Boolean
Erreurs E_UNKNOWN_USER_OR_KEY = Utilisateur ou clé inconnus
E_UNKNOWN_MERCHANT = Code marchand inconnu
E_NO_ORDER = Pas de commande
E_NO_ORDER_LINE = Pas de ligne de commande
E_NO_ORDER_NUMBER = Pas de numéro de commande
E_ALREADY_EXISTING_ORDER = La commande existe déjà pour ce marchand
E_UNKNOWN_ERROR = Erreur inconnue
Voir « Error »

Obtenir ma liste de transporteurs

Requête

Url /Order/GetCarriers/{merchantCode}/{login}/{key}
Type GET
En-tête Accept "application/json"

Réponse

HTTP Status 200
Corps Liste de CarrierReturn
Erreurs E_UNKNOWN_USER_OR_KEY = Utilisateur ou clé inconnus
E_UNKNOWN_MERCHANT = Code marchand inconnu
E_UNKNOWN_ERROR = Erreur inconnue
Voir « Error »

Obtenir la liste des commandes en erreur

Requête

Url /Order/GetOrderErrors/{merchantCode}/{login}/{key}
Type GET
En-tête Accept "application/json"

Réponse

HTTP Status 200
Corps Liste de OrderErrorReturn
Erreurs E_UNKNOWN_USER_OR_KEY = Utilisateur ou clé inconnus
E_UNKNOWN_MERCHANT = Code marchand inconnu
E_UNKNOWN_ERROR = Erreur inconnue
Voir « Error »

Obtenir la liste des commandes retournées

Requête

Url /Order/GetReturns/{merchantCode}/{login}/{key}/{dateFromUtc}
Type GET
En-tête Accept "application/json"

Réponse

HTTP Status 200
Corps Liste de OrderReturn
Erreurs E_UNKNOWN_USER_OR_KEY = Utilisateur ou clé inconnus
E_UNKNOWN_MERCHANT = Code marchand inconnu
E_UNKNOWN_ERROR = Erreur inconnue
Voir « Error »

Obtenir l'état d'avancement d'une commande

Requête

Url /Order/GetShipments/{merchantCode}/{login}/{key}/{dateFromUtc}
Type GET
En-tête Accept "application/json"
Paramètres dateFromUtc = Toutes les commandes dont un changement d'état a eu lieu après cette date (décalage UTC/GMT +0)
Formats acceptés : "yyyy-MM-dd" ou "yyyy-MM-ddTHH:mm:ss"
Exemple : "2019-12-17" ou "2019-12-17T13:45:31"

Réponse

HTTP Status 200
Corps Liste de ShipmentReturn
Erreurs E_UNKNOWN_USER_OR_KEY = Utilisateur ou clé inconnus
E_UNKNOWN_MERCHANT = Code marchand inconnu
E_UNKNOWN_ERROR = Erreur inconnue
Voir « Error »

Obtenir la liste des états

Requête

Url /Order/GetStates/{merchantCode}/{login}/{key}
Type GET
En-tête Accept "application/json"

Réponse

HTTP Status 200
Corps Liste de StateReturn
Erreurs E_UNKNOWN_USER_OR_KEY = Utilisateur ou clé inconnus
E_UNKNOWN_MERCHANT = Code marchand inconnu
E_UNKNOWN_ERROR = Erreur inconnue
Voir « Error »

Créer un nouvel attendu de réception

Requête

Url /Product/CreateNewExpectedReceipt/{merchantCode}/{login}/{key}
Type POST
En-tête Accept "application/json"
Corps Receipt

Réponse

HTTP Status 200
Corps Boolean
Erreurs E_UNKNOWN_USER_OR_KEY = Utilisateur ou clé inconnus
E_UNKNOWN_MERCHANT = Code marchand inconnu
E_UNKNOWN_ERROR = Erreur inconnue
E_NO_RECEIPT = Pas d'attendu
E_ALREADY_EXISTING_RECEIPT = L'attendu existe déjà pour ce marchand
E_NO_RECEIPT_LINE = Pas de ligne d'attendu
E_NO_SCHEDULED_DATE = Date de réception prévue non renseignée
E_UNKNOWN_PRODUCT_CODE = Code produit inconnu pour ce marchand
E_NO_RECEIPT_LINE_QUANTITY = Quantité de ligne d'attendu à 0
E_NO_SUPPLIER_NAME = Nom du fournisseur non renseigné
Voir « Error »

Déclarer un nouvel article

Requête

Url /Product/CreateNewProduct/{merchantCode}/{login}/{key}
Type POST
En-tête Accept "application/json"
Corps Product
Commentaire Si le produit existe déjà, il est mis à jour

Réponse

HTTP Status 200
Corps Boolean
Erreurs E_UNKNOWN_USER_OR_KEY = Utilisateur ou clé inconnus
E_UNKNOWN_MERCHANT = Code marchand inconnu
E_NO_PRODUCT_CODE = Pas de code produit
E_UNKNOWN_ERROR = Erreur inconnue
Voir « Error »

Déclarer des articles en masse

Requête

Url /Product/CreateNewProducts/{merchantCode}/{login}/{key}
Type POST
En-tête Accept "application/json"
Corps Liste de Product
Commentaire Si un produit existe déjà, il est mis à jour
Nb: En cas d'erreur sur un produit, aucun produit n'est enregistré

Réponse

HTTP Status 200
Corps Boolean
Erreurs E_UNKNOWN_USER_OR_KEY = Utilisateur ou clé inconnus
E_UNKNOWN_MERCHANT = Code marchand inconnu
E_NO_PRODUCT_CODE = Pas de code produit
E_UNKNOWN_ERROR = Erreur inconnue
Voir « Error »

Suppression d'un article

Requête

Url /Product/DeleteProduct/{merchantCode}/{login}/{key}/{productCode}
Type POST
En-tête Accept "application/json"
Paramètres productCode = Code du produit à supprimer

Réponse

HTTP Status 200
Corps Boolean
Erreurs E_UNKNOWN_USER_OR_KEY = Utilisateur ou clé inconnus
E_UNKNOWN_MERCHANT = Code marchand inconnu
E_NO_PRODUCT_CODE = Pas de code produit
E_UNKNOWN_PRODUCT_CODE = Code produit inconnu pour ce marchand
E_UNKNOWN_ERROR = Erreur inconnue
Voir « Error »

Obtenir la liste des produits en erreur

Requête

Url /Product/GetProductErrors/{merchantCode}/{login}/{key}
Type GET
En-tête Accept "application/json"

Réponse

HTTP Status 200
Corps Liste de ProductErrorReturn
Erreurs E_UNKNOWN_USER_OR_KEY = Utilisateur ou clé inconnus
E_UNKNOWN_MERCHANT = Code marchand inconnu
E_UNKNOWN_ERROR = Erreur inconnue
Voir « Error »

Obtenir la liste des réceptions

Requête

Url /Product/GetReceipts/{merchantCode}/{login}/{key}/{dateFromUtc}
Type GET
En-tête Accept "application/json"

Réponse

HTTP Status 200
Corps Liste de ReceiptReturn
Erreurs E_UNKNOWN_USER_OR_KEY = Utilisateur ou clé inconnus
E_UNKNOWN_MERCHANT = Code marchand inconnu
E_UNKNOWN_ERROR = Erreur inconnue
Voir « Error »

Obtenir l'état du stock

Requête

Url /Product/GetStocks/{merchantCode}/{login}/{key}/{productCode}
Type GET
En-tête Accept "application/json"
Paramètres productCode = Code du produit
Si non renseigné, retourne les états des stocks de tous les produits

Réponse

HTTP Status 200
Corps Liste de StockReturn
Erreurs E_UNKNOWN_USER_OR_KEY = Utilisateur ou clé inconnus
E_UNKNOWN_MERCHANT = Code marchand inconnu
E_UNKNOWN_ERROR = Erreur inconnue
Voir « Error »

Mettre à jour un article existant

Requête

Url /Product/UpdateProduct/{merchantCode}/{login}/{key}
Type POST
En-tête Accept "application/json"
Corps Product
Commentaire Si le produit n'existe pas, il est créé

Réponse

HTTP Status 200
Corps Boolean
Erreurs E_UNKNOWN_USER_OR_KEY = Utilisateur ou clé inconnus
E_UNKNOWN_MERCHANT = Code marchand inconnu
E_NO_PRODUCT_CODE = Pas de code produit
E_UNKNOWN_ERROR = Erreur inconnue
Voir « Error »

Mettre à jour des articles existants en masse

Requête

Url /Product/UpdateProducts/{merchantCode}/{login}/{key}
Type POST
En-tête Accept "application/json"
Corps Liste de Product
Commentaire Si un produit n'existe pas, il est créé
Nb: En cas d'erreur sur un produit, aucune modification de produit n'est enregistrée

Réponse

HTTP Status 200
Corps Boolean
Erreurs E_UNKNOWN_USER_OR_KEY = Utilisateur ou clé inconnus
E_UNKNOWN_MERCHANT = Code marchand inconnu
E_NO_PRODUCT_CODE = Pas de code produit
E_UNKNOWN_ERROR = Erreur inconnue
Voir « Error »

Entités

Order

{
  BrandCode: "",
  CurrencyCode: "",
  CustomerNumber: "",
  DateUtc: "2019-12-31 23:59:59",
  Language: "",
  MerchantCarrierCode: "",
  MerchantCarrierLabel: "",
  OrderNumber: "",
  PickerComments: "",
  ScheduledTransmissionDate: "2019-12-31 23:59:59",
  ShippingServiceCode: ""
  Address: {
    Address1: "",
    Address2: "",
    Address3: "",
    City: "",
    Comments: "",
    CorporateName: "",
    CountryCode: "",
    Email: "",
    FirstName: "",
    LastName: "",
    MobilePhone: "",
    Phone: "",
    PickupPointNumber: "",
    ProvinceCode: "",
    ZipCode: ""
  },
  Billing: {
    Address1: "",
    Address2: "",
    Address3: "",
    BillNumber: "",
    City: "",
    CorporateName: "",
    CountryCode: "",
    Discount: 0.0,
    DiscountHT: 0.0,
    DiscountTTC: 0.0,
    FirstName: "",
    LastName: "",
    ProvinceCode: "",
    ShipmentPrice: 0.0,
    ShipmentVAT: 0.0,
    TotalAmount: 0.0,
    ZipCode: ""
  },
  Gift: {
    Message: "",
    PackageType: 0
  },
  OrderLines: [
    {
      ProductCode: "",
      ProductLabel: "",
      Quantity: 0,
      UnitPrice: 0.0,
      UnitPriceHT: 0.0,
      UnitPriceTTC: 0.0,
      VATRate: 0.0
    }
  ],
}
			

Propriété Obligatoire /
Facultatif
Type[Taille maximum] Description
BrandCode o/f string[3] Code de l'enseigne
CurrencyCode f string[3] Devise (EUR, USD, ...)
CustomerNumber f string[50] Numéro de commande client (B2B)
DateUtc f datetime<nullable> Date de la commande
Language f string[2] Langue de l'enseigne
MerchantCarrierCode f string[7] Code du transporteur du marchand
MerchantCarrierLabel f string[50] Nom du transporteur du marchand
OrderNumber o string[9] Numéro de la commande
PickerComments f string[500] Commentaire préparateur de commande
ScheduledTransmissionDate f datetime<nullable> Date de transmission au logisticien programmée
ShippingServiceCode f string[3] Code de service (A2P, CIT, BPR, CDI, ACP, DOM, RDV, MRL, DOS, CMT, BDP, ...).
Address   o Address Adresse
Address1 o string[35] Adresse de livraison : adresse
Address2 f string[35] Adresse de livraison : complément d'adresse
Address3 f string[35] Adresse de livraison : suite de complément d'adresse
City o string[50] Adresse de livraison : ville
Comments f string[500] Adresse de livraison : commentaires
CorporateName f string[100] Adresse de livraison : nom de la société
CountryCode o string[2] Adresse de livraison : code pays (Voir « Annexe-Countries »)
Email f string[100] Adresse de livraison : email
FirstName f string[50] Adresse de livraison : prénom du client
LastName f string[50] Adresse de livraison : nom du client
MobilePhone o string[30] Adresse de livraison : numéro de mobile
Phone f string[30] Adresse de livraison : numéro de téléphone
PickupPointNumber f string[10] Adresse de livraison : code de point-relais
ProvinceCode f string[2] Adresse de livraison : code province (US et Canada) (Voir « Annexe-Provinces »)
ZipCode o string[10] Adresse de livraison : code postal
Billing   f Billing Billing attributes
Address1 o string[35] Adresse de facturation : adresse
Address2 f string[35] Adresse de facturation : complément d'adresse
Address3 f string[35] Adresse de facturation : suite de complément d'adresse
BillNumber f string[50] Numéro de la facture
City o string[50] Adresse de facturation : ville
CorporateName f string[50] Adresse de facturation : nom de la société
CountryCode o string[2] Adresse de facturation : code pays (Voir « Annexe-Countries »)
Discount f decimal<nullable> Montant Remise (HT ou TTC spécifié dans vos paramètres FuturLog)
DiscountHT f decimal<nullable> Montant Remise HT
DiscountTTC f decimal<nullable> Montant Remise TTC
FirstName f string[50] Adresse de facturation : prénom du client
LastName f string[50] Adresse de facturation : nom du client
ProvinceCode f string[2] Adresse de facturation : code province (US et Canada) (Voir « Annexe-Provinces »)
ShipmentPrice f decimal<nullable> Frais de port TTC
ShipmentVAT o/f decimal<nullable> Taux de TVA des frais de port
TotalAmount o decimal<nullable> Montant total de la commande TTC
ZipCode o string[10] Adresse de facturation : code postal
Gift   f Gift Gift attributes
Message f string Message de la carte cadeau
PackageType f int<nullable> Type de papier cadeau
OrderLines   o list<OrderLine> Lignes de commande
ProductCode o string[30] Référence de produit
ProductLabel o string[120] Libellé produit
Quantity o int Quantité commandée
UnitPrice o/f decimal<nullable> Prix unitaire (HT ou TTC spécifié dans vos paramètres FuturLog)
UnitPriceHT o/f decimal<nullable> Prix unitaire HT
UnitPriceTTC o/f decimal<nullable> Prix unitaire TTC
VATRate o/f decimal<nullable> Taux de TVA

Product

{
  AlertThreshold: 0,
  BarCode: "",
  Code: "",
  Color: "",
  ExternalCode: "",
  Family: "",
  Height: 0.0,
  HsCode: "",
  IsActive: false,
  IsLotManaged: false,
  Label: "",
  Length: 0.0,
  Model: "",
  OriginCountryCode: "",
  Parameter1: "",
  Parameter2: "",
  PictureUrl: "",
  Size: "",
  TvaRate: 0.0,
  Type: "",
  UnitPriceHT: 0.0,
  WeePrice: 0.0,
  Weight: 0.0,
  Width: 0.0
  ProductsInBundle: [
    {
      Code: "",
      Quantity: 0
    }
  ],
}
			

Propriété Obligatoire /
Facultatif
Type[Taille maximum] Description
AlertThreshold f int<nullable> Plafond d'alerte (quantité restante en stock)
BarCode f string[60] Code barre
Code o string[30] Code Produit
Color f string[50] Couleur
ExternalCode f string[60] Code Fournisseur
Family f string[100] Catégorie de produit
Height f decimal<nullable> Hauteur en cm
HsCode f string[10] Nomenclature douanière
IsActive f bool Actif
IsLotManaged f bool Gestion des lots
Label o string[120] Libellé produit
Length f decimal<nullable> Longueur en cm
Model f string[100] Modèle du produit
OriginCountryCode f string[2] Code pays d'origine (Voir « Annexe-Countries »)
Parameter1 f string Paramètre custom 1
Parameter2 f string Paramètre custom 2
PictureUrl f string[300] URL de l'image
Size f string[100] Taille
TvaRate f decimal<nullable>
Type f string[100] Type du produit
UnitPriceHT f decimal<nullable> Dernier prix HT
WeePrice f decimal<nullable> Eco participation
Weight f decimal<nullable> Poids en kg
Width f decimal<nullable> Largeur en cm
ProductsInBundle   f list<ProductBundle> Produits contenus dans ce composé (si ce produit est un composé)
Code o string[30] Code produit contenu dans ce composé
Quantity o int Quantité de ce composant

Receipt

{
  CarrierName: "",
  DeliveryComments: "",
  ReceiptNumber: "",
  ScheduledDate: "2019-12-31 23:59:59",
  SupplierName: ""
  ReceiptLines: [
    {
      ProductCode: "",
      Quantity: 0
    }
  ],
}
			

Propriété Obligatoire /
Facultatif
Type[Taille maximum] Description
CarrierName f string[100] Nom du transporteur
DeliveryComments f string[500] Commentaire livraison
ReceiptNumber f string[12] Numéro de la commande
ScheduledDate o datetime Date de réception prévue
SupplierName o string[100] Nom du fournisseur
ReceiptLines   o list<ReceiptLine> Lignes de réception
ProductCode o string[30] Référence de produit
Quantity o int Quantité annoncée

CarrierReturn

{
  Data: [
    {
      Code: "",
      Label: ""
    }
  ]
}
			

Propriété Type[Taille maximum] Description
Code string[7] Code transporteur
Label string[50] Nom du transporteur

OrderErrorReturn

{
  Data: [
    {
      Brand: "",
      ErrorCode: "",
      ErrorLabel: "",
      OrderNumber: ""
    }
  ]
}
			

Propriété Type[Taille maximum] Description
Brand string[3] Code de l'enseigne
ErrorCode string[50] Code de l'erreur (Voir « Annexe-Codes d'erreur des commandes »)
ErrorLabel string[200] Libellé de l'erreur
OrderNumber string[9] Numéro de la commande

OrderReturn

{
  Data: [
    {
      Brand: "",
      CustomerNumber: "",
      Language: "",
      MerchantCarrierCode: "",
      MerchantCarrierLabel: "",
      OrderNumber: "",
      ShippingServiceCode: ""
      Address: {
        Address1: "",
        Address2: "",
        Address3: "",
        City: "",
        Comments: "",
        CorporateName: "",
        CountryCode: "",
        Email: "",
        FirstName: "",
        LastName: "",
        MobilePhone: "",
        Phone: "",
        PickupPointNumber: "",
        ProvinceCode: "",
        ZipCode: ""
      },
      Billing: {
        Address1: "",
        Address2: "",
        Address3: "",
        BillNumber: "",
        City: "",
        CorporateName: "",
        CountryCode: "",
        Discount: 0.0,
        DiscountHT: 0.0,
        DiscountTTC: 0.0,
        FirstName: "",
        LastName: "",
        ProvinceCode: "",
        ShipmentPrice: 0.0,
        ShipmentVAT: 0.0,
        TotalAmount: 0.0,
        ZipCode: ""
      },
      Gift: {
        Message: "",
        PackageType: 0
      },
      OrderLines: [
        {
          InitialQuantity: 0,
          ProductCode: "",
          ShippedBatchesReturn: [
            {
              Number: "",
              Quantity: 0
            }
          ]
        }
      ],
      ReturnLines: [
        {
          DateUtc: "2019-12-31 23:59:59",
          ProductCode: "",
          QuantityReturned: 0,
          QuantityReturnedDamaged: 0,
          ReturnReasonCode: 0,
          ReturnReasonLabel: ""
        }
      ],
    }
  ]
}
			

Propriété Type[Taille maximum] Description
Brand string[3] Code de l'enseigne
CustomerNumber string[50] Numéro de commande client (B2B)
Language string[2] Langue de l'enseigne
MerchantCarrierCode string[7] Code de service transporteur du marchand
MerchantCarrierLabel string[50] Nom du transporteur du marchand
OrderNumber string[9] Numéro de la commande
ShippingServiceCode string[3] Code de service (A2P, CIT, BPR, CDI, ACP, DOM, RDV, MRL, DOS, CMT, BDP, ...).
Address   Address Adresse
Address1 string[35] Adresse de livraison : adresse
Address2 string[35] Adresse de livraison : complément d'adresse
Address3 string[35] Adresse de livraison : suite de complément d'adresse
City string[50] Adresse de livraison : ville
Comments string[500] Adresse de livraison : commentaires
CorporateName string[100] Adresse de livraison : nom de la société
CountryCode string[2] Adresse de livraison : code pays (Voir « Annexe-Countries »)
Email string[100] Adresse de livraison : email
FirstName string[50] Adresse de livraison : prénom du client
LastName string[50] Adresse de livraison : nom du client
MobilePhone string[30] Adresse de livraison : numéro de mobile
Phone string[30] Adresse de livraison : numéro de téléphone
PickupPointNumber string[10] Adresse de livraison : code de point-relais
ProvinceCode string[2] Adresse de livraison : code province (US et Canada) (Voir « Annexe-Provinces »)
ZipCode string[10] Adresse de livraison : code postal
Billing   Billing Billing attributes
Address1 string[35] Adresse de facturation : adresse
Address2 string[35] Adresse de facturation : complément d'adresse
Address3 string[35] Adresse de facturation : suite de complément d'adresse
BillNumber string[50] Numéro de la facture
City string[50] Adresse de facturation : ville
CorporateName string[50] Adresse de facturation : nom de la société
CountryCode string[2] Adresse de facturation : code pays (Voir « Annexe-Countries »)
Discount decimal<nullable> Montant Remise (HT ou TTC spécifié dans vos paramètres FuturLog)
DiscountHT decimal<nullable> Montant Remise HT
DiscountTTC decimal<nullable> Montant Remise TTC
FirstName string[50] Adresse de facturation : prénom du client
LastName string[50] Adresse de facturation : nom du client
ProvinceCode string[2] Adresse de facturation : code province (US et Canada) (Voir « Annexe-Provinces »)
ShipmentPrice decimal<nullable> Frais de port TTC
ShipmentVAT decimal<nullable> Taux de TVA des frais de port
TotalAmount decimal<nullable> Montant total de la commande TTC
ZipCode string[10] Adresse de facturation : code postal
Gift   Gift Gift attributes
Message string Message de la carte cadeau
PackageType int<nullable> Type de papier cadeau
OrderLines   list<OrderLineReturn> Lignes de commande
InitialQuantity int Quantité commandée initiale
ProductCode string[30] Référence de produit
ShippedBatchesReturn   list<ShippedBatchReturn> Liste des lots
Number string[50] Numéro de lot
Quantity int Quantité expédiée
ReturnLines   list<ReturnLineReturn> Lignes de retour
DateUtc datetime Date du retour
ProductCode string[30] Référence de produit
QuantityReturned int Quantité retournée
QuantityReturnedDamaged int Quantité retournée endommagée
ReturnReasonCode int<nullable> Code de la cause du retour
ReturnReasonLabel string[50] Libellé de la cause du retour

ProductErrorReturn

{
  Data: [
    {
      Code: "",
      ErrorCode: "",
      ErrorLabel: ""
    }
  ]
}
			

Propriété Type[Taille maximum] Description
Code string[30] Code Produit
ErrorCode string[50] Code de l'erreur (Voir « Annexe-Codes d'erreur des produits »)
ErrorLabel string[200] Libellé de l'erreur

ReceiptReturn

{
  Data: [
    {
      EntryDateUtc: "2019-12-31 23:59:59",
      ReceiptDate: "2019-12-31 23:59:59",
      ReceiptNumber: "",
      State: "",
      StateCode: 0
      ReceiptLines: [
        {
          ProductCode: "",
          Quantity: 0,
          ReceivedQuantity: 0,
          ReceivedQuantityDamaged: 0
          ReceiptLinePartialReceptions: [
            {
              Date: "2019-12-31 23:59:59",
              ProductBatchNumber: "",
              ReceivedQuantity: 0,
              ReceivedQuantityDamaged: 0
            }
          ],
        }
      ],
    }
  ]
}
			

Propriété Type[Taille maximum] Description
EntryDateUtc datetime Date de la saisie
ReceiptDate datetime<nullable> Date de réception effective
ReceiptNumber string[30] Numéro de la commande
State string[50] Etat de la réception (Voir « Annexe-States »)
StateCode int Code état de la réception (Voir « Annexe-States »)
ReceiptLines   list<ReceiptLineReturn> Lignes de réception
ProductCode string[30] Référence de produit
Quantity int Quantité annoncée
ReceivedQuantity int<nullable> Quantité réceptionnée
ReceivedQuantityDamaged int<nullable> Quantité réceptionnée endommagée
ReceiptLinePartialReceptions   list<ReceiptLinePartialReceptionReturn> Lignes de réception partielles
Date datetime Date
ProductBatchNumber string[50] Numéro de lot
ReceivedQuantity int<nullable> Quantité réceptionnée
ReceivedQuantityDamaged int<nullable> Quantité réceptionnée endommagée

ShipmentReturn

{
  Data: [
    {
      BrandCode: "",
      OrderNumber: "",
      State: "",
      StateCode: 0
      OrderLines: [
        {
          InitialQuantity: 0,
          ProductCode: "",
          ShippedBatchesReturn: [
            {
              Number: "",
              Quantity: 0
            }
          ]
        }
      ],
      Parcels: [
        {
          CarrierCode: "",
          PackNumber: "",
          ShippingDate: "2019-12-31 23:59:59",
          State: "",
          StateCode: 0,
          TrackingNumber: "",
          TrackingUrl: "",
          Weight: 0.0
          ParcelLines: [
            {
              ProductCode: "",
              Quantity: 0
            }
          ],
        }
      ],
    }
  ]
}
			

Propriété Type[Taille maximum] Description
BrandCode string[3] Code enseigne
OrderNumber string[30] Numéro de la commande
State string[50] Etat de la commande (Voir « Annexe-States »)
StateCode int Code état de la commande (Voir « Annexe-States »)
OrderLines   list<OrderLineReturn> Liste des lignes de commande
InitialQuantity int Quantité commandée initiale
ProductCode string[30] Référence de produit
ShippedBatchesReturn   list<ShippedBatchReturn> Liste des lots
Number string[50] Numéro de lot
Quantity int Quantité expédiée
Parcels   list<ParcelReturn> Liste des colis
CarrierCode string[7] Code du transporteur
PackNumber string[50] Numéro de colis interne
ShippingDate datetime<nullable> Date d'expedition
State string[50] Etat du colis (Voir « Annexe-States »)
StateCode int Code état du colis (Voir « Annexe-States »)
TrackingNumber string[50] Numéro de tracking
TrackingUrl string[200] URL de tracking
Weight decimal Poids du colis en Kg
ParcelLines   list<ParcelLineReturn> Liste des produits du colis
ProductCode string[30] Code Produit
Quantity int Quantité produit

StateReturn

{
  Data: [
    {
      Code: 0,
      Label: "",
      SortOrder: 0
    }
  ]
}
			

Propriété Type[Taille maximum] Description
Code int Code état de la commande
Label string[50] Etat de la commande
SortOrder int<nullable> Ordre théorique d'apparition de l'état

StockReturn

{
  Data: [
    {
      AvailableQuantity: 0,
      Code: "",
      ReservedQuantity: 0
      BatchesStock: [
        {
          Number: "",
          OnHandQuantity: 0
        }
      ],
    }
  ]
}
			

Propriété Type[Taille maximum] Description
AvailableQuantity int Quantité disponible
Code string[30] Code Produit
ReservedQuantity int Quantité réservée
BatchesStock   list<BatchStockReturn> Stock des lots
Number string[50] Numéro de lot
OnHandQuantity int Quantité disponible

Error

{
  Error: {
    Message: "",
    Code: "",
    Data: [
      {
        Key: "",
        Value: ""
      }
    ]
  }
}
	

Propriété Type Description
Message string Message d'erreur
Code string Code d'erreur (E_...)
Data   list Informations
Key string Clé
Value string Valeur

Annexes

States

Liste des états des commandes (en grisé les états non implémentés) :

Code Etat
1 Reçue informatiquement
2 Rejetée
3 Incomplète
4 Complète
5 Bloquée
6 Annulée
7 Transmise logistique
8 En modification
9 Scindée
24 En préparation partielle
25 En préparation
29 Préparée partiellement
30 Préparée
39 Expédiée partiellement
40 Expédiée
49 Prise en charge par le transporteur - Partiel
50 Prise en charge par le transporteur
54 En acheminement partiel
55 En acheminement
59 En cours de livraison - Partiel
60 En cours de livraison
69 Disponible au point de retrait - Partiel
70 Disponible au point de retrait
74 Problème de livraison - Partiel
75 Problème de livraison
79 En dédouanement - Partiel
80 En dédouanement
89 Livrée - Partiel
90 Livrée
101 Non livrée - Absent
102 Non livrée - Pb adresse
103 Non livrée - Refus client
104 Non livrée - Pb accès
105 Colis détérioré
106 Colis perdu
107 Livraison contestée
109 En retour - Partiel
110 En retour
299 Retournée partiellement
300 Retournée au stock
400 Ouverture Enquête
410 Enquête en cours
420 Relance Enquête
430 Prise En Charge Acceptée
440 Prise En Charge Refusée
490 Dossier litige clos

Liste des états des réceptions :

Code Etat
1 Reçu informatiquement
2 Annoncé logistique
3 En réception
4 Terminé
5 Soldé
6 En annulation
7 Annulé

Countries

Liste des pays (ISO-2) :

Nom Code
Afghanistan AF
Afrique du Sud ZA
Åland, Îles AX
Albanie AL
Algérie DZ
Allemagne DE
Andorre AD
Angola AO
Anguilla AI
Antarctique AQ
Antigua et Barbuda AG
Antilles néerlandaises AN
Arabie Saoudite SA
Argentine AR
Arménie AM
Aruba AW
Australie AU
Autriche AT
Azerbaïdjan AZ
Bahamas BS
Bahrein BH
Bangladesh BD
Barbade BB
Bélarus BY
Belgique BE
Bélize BZ
Bénin BJ
Bermudes BM
Bhoutan BT
Bolivie (État plurinational de) BO
Bonaire, Saint-Eustache et Saba BQ
Bosnie-Herzégovine BA
Botswana BW
Bouvet, Ile BV
Brésil BR
Brunéi Darussalam BN
Bulgarie BG
Burkina Faso BF
Burundi BI
Cabo Verde CV
Caïmans, Iles KY
Cambodge KH
Cameroun CM
Canada CA
Chili CL
Chine CN
Christmas, île CX
Chypre CY
Cocos/Keeling (Îles) CC
Colombie CO
Comores KM
Congo CG
Congo, République démocratique du CD
Cook, Iles CK
Corée, République de KR
Corée, République populaire démocratique de KP
Costa Rica CR
Côte d'Ivoire CI
Croatie HR
Cuba CU
Curaçao CW
Danemark DK
Djibouti DJ
Dominicaine, République DO
Dominique DM
Egypte EG
El Salvador SV
Emirats arabes unis AE
Equateur EC
Erythrée ER
Espagne ES
Estonie EE
Etats-Unis d'Amérique US
Ethiopie ET
Falkland/Malouines (Îles) FK
Féroé, îles FO
Fidji FJ
Finlande FI
France FR
Gabon GA
Gambie GM
Géorgie GE
Géorgie du sud et les îles Sandwich du sud GS
Ghana GH
Gibraltar GI
Grèce GR
Grenade GD
Groenland GL
Guadeloupe GP
Guam GU
Guatemala GT
Guernesey GG
Guinée GN
Guinée équatoriale GQ
Guinée-Bissau GW
Guyana GY
Guyane française GF
Haïti HT
Heard, Ile et MacDonald, îles HM
Honduras HN
Hong Kong HK
Hongrie HU
Île de Man IM
Îles mineures éloignées des Etats-Unis UM
Îles vierges britanniques VG
Îles vierges des Etats-Unis VI
Inde IN
Indien (Territoire britannique de l'océan) IO
Indonésie ID
Iran, République islamique d' IR
Iraq IQ
Irlande IE
Islande IS
Israël IL
Italie IT
Jamaïque JM
Japon JP
Jersey JE
Jordanie JO
Kazakhstan KZ
Kenya KE
Kirghizistan KG
Kiribati KI
Kosovo XK
Koweït KW
Lao, République démocratique populaire LA
Lesotho LS
Lettonie LV
Liban LB
Libéria LR
Libye LY
Liechtenstein LI
Lituanie LT
Luxembourg LU
Macao MO
Macédoine, l'ex-République yougoslave de MK
Madagascar MG
Malaisie MY
Malawi MW
Maldives MV
Mali ML
Malte MT
Mariannes du nord, Iles MP
Maroc MA
Marshall, Iles MH
Martinique MQ
Maurice MU
Mauritanie MR
Mayotte YT
Mexique MX
Micronésie, Etats Fédérés de FM
Moldova, République de MD
Monaco MC
Mongolie MN
Monténégro ME
Montserrat MS
Mozambique MZ
Myanmar MM
Namibie NA
Nauru NR
Népal NP
Nicaragua NI
Niger NE
Nigéria NG
Niue NU
Norfolk, Ile NF
Norvège NO
Nouvelle-Calédonie NC
Nouvelle-Zélande NZ
Oman OM
Ouganda UG
Ouzbékistan UZ
Pakistan PK
Palaos PW
Palestine, Etat de PS
Panama PA
Papouasie-Nouvelle-Guinée PG
Paraguay PY
Pays-Bas NL
Pérou PE
Philippines PH
Pitcairn PN
Pologne PL
Polynésie française PF
Porto Rico PR
Portugal PT
Qatar QA
République arabe syrienne SY
République centrafricaine CF
Réunion RE
Roumanie RO
Royaume-Uni de Grande-Bretagne et d'Irlande du Nord GB
Russie, Fédération de RU
Rwanda RW
Sahara occidental EH
Saint-Barthélemy BL
Sainte-Hélène, Ascension et Tristan da Cunha SH
Sainte-Lucie LC
Saint-Kitts-et-Nevis KN
Saint-Marin SM
Saint-Martin (partie française) MF
Saint-Martin (partie néerlandaise) SX
Saint-Pierre-et-Miquelon PM
Saint-Vincent-et-les-Grenadines VC
Salomon, Iles SB
Samoa WS
Samoa américaines AS
Sao Tomé-et-Principe ST
Sénégal SN
Serbie RS
Seychelles SC
Sierra Leone SL
Singapour SG
Slovaquie SK
Slovénie SI
Somalie SO
Soudan SD
Soudan du Sud SS
Sri Lanka LK
Suède SE
Suisse CH
Suriname SR
Svalbard et île Jan Mayen SJ
Swaziland SZ
Tadjikistan TJ
Taïwan, Province de Chine TW
Tanzanie, République unie de TZ
Tchad TD
Tchèque, République CZ
Terres australes françaises TF
Thaïlande TH
Timor-Leste TL
Togo TG
Tokelau TK
Tonga TO
Trinité-et-Tobago TT
Tunisie TN
Turkménistan TM
Turks-et-Caïcos (Îles) TC
Turquie TR
Tuvalu TV
Ukraine UA
Uruguay UY
Vanuatu VU
Vatican (Saint-Siège) VA
Venezuela (République bolivarienne du) VE
Viet Nam VN
Wallis et Futuna WF
Yémen YE
Zambie ZM
Zimbabwe ZW

Provinces

Liste des états USA et Canada seulement (ISO-2) :

Nom Code Pays
Alberta AB CA
British Columbia BC CA
Manitoba MB CA
New Brunswick NB CA
Newfoundland NF CA
Northwest Territory NT CA
Nova Scotia NS CA
Ontario ON CA
Prince Edward Island PI CA
Quebec QC CA
Saskatchewan SK CA
Yukon Territory YK CA
Alabama AL US
Alaska AK US
Arizona AZ US
Arkansas AR US
California CA US
Colorado CO US
Connecticut CT US
Delaware DE US
District of Columbia DC US
Florida FL US
Georgia GA US
Hawaii HI US
Idaho ID US
Illinois IL US
Indiana IN US
Iowa IA US
Kansas KS US
Kentucky KY US
Louisiana LA US
Maine ME US
Maryland MD US
Massachusetts MA US
Michigan MI US
Minnesota MN US
Mississippi MS US
Missouri MO US
Montana MT US
Nebraska NE US
Nevada NV US
New Hampshire NH US
New Jersey NJ US
New Mexico NM US
New York NY US
North Carolina NC US
North Dakota ND US
Ohio OH US
Oklahoma OK US
Oregon OR US
Pennsylvania PA US
Rhode Island RI US
South Carolina SC US
South Dakota SD US
Tennessee TN US
Texas TX US
Utah UT US
Vermont VT US
Virginia VA US
Washington WA US
West Virginia WV US
Wisconsin WI US
Wyoming WY US

Codes d'erreur des commandes

Liste des codes d'erreurs possibles pour les commandes :

Code Raison
E_ORDER_NUMBER_TOO_LONG Le numéro de commande doit être inférieur ou égal à 9 caractères
E_ORDER_NUMBER_PROHIBITED_CHARACTERS Un numéro de commande ne doit pas contenir les caractères suivants : \ / : * ? " < > |
E_NO_COUNTRY_CODE Le code pays n'est pas renseigné
E_UNKNOWN_COUNTRY_CODE Le code pays est inconnu
E_INCOHERENT_CARRIER Les informations de transport sont incohérentes avec les données de la commandes
E_UNKNOWN_CARRIER Impossible de déterminer le transporteur
E_UNKNOWN_BRAND Code enseigne inconnu
E_BRAND_MISSING Code enseigne non spécifié
E_NO_PICKUP_POINT_NUMBER Le numéro de point relais n'est pas renseigné
E_UNKNOWN_BILLING_COUNTRY_CODE Le code pays de facturation est inconnu
E_UNKNOWN_PRODUCT_CODE Un ou plusieurs codes produits sont inconnus
E_NO_HS_CODE_OR_ORIGIN_COUNTRY Le code douanier ou le pays d'origine d'un ou plusieurs des produits de la commande n'est pas renseigné (dans le cas ou une commande a une destination hors UE)
E_INVALID_VAT Taux de TVA incorrect
E_NO_LASTNAME_OR_COMPANY Le nom du destinataire ou l'entreprise n'est pas spécifié
E_NO_ADDRESS L'adresse n'est renseignée
E_NO_ZIPCODE Le code postal n'est pas renseigné
E_UNKNOWN_ZIPCODE Le code postal est incorrect
E_NO_CITY La ville n'est pas renseignée
E_NO_PHONE Le numéro de téléphone n'est pas renseigné
E_NO_EMAIL L'e-mail n'est pas renseigné
E_INVALID_EMAIL Le format de l'e-mail est incorrect
E_INVALID_DISCOUNT La remise est incorrecte
E_INVALID_SHIPMENT_PRICE Le montant du transport est incorrect
E_INVALID_SHIPMENT_VAT Le taux de TVA du transport est incorrect
E_INVALID_TOTAL_AMOUNT Le montant total de la commande est incorrect (doit être supérieur à 0 si hors UE)
E_ONLY_VIRTUAL_PRODUCTS La commande est composée seulement de produits virtuels

Codes d'erreur des produits

Liste des codes d'erreurs possibles pour les produits :

Code Raison
E_PRODUCT_CODE_TOO_LONG Le code produit doit être inférieur ou égal à 14 ou 27 caractères selon l'entrepôt
E_UNKNOWN_HS_CODE Le code douanier est incorrect
E_UNKNOWN_COUNTRY_CODE Le pays d'origine est incorrect
E_ALREADY_EXISTING_BAR_CODE Le code à barres est déjà existant
E_ALREADY_EXISTING_BAR_CODE_2 Le 2e code barres est déjà existant
E_ALREADY_EXISTING_BAR_CODE_3 Le 3e code barres est déjà existant
E_ALREADY_EXISTING_BAR_CODE_4 Le 4e code barres est déjà existant
E_ALREADY_EXISTING_BAR_CODE_5 Le 5e code barres est déjà existant
E_NO_PRODUCT_LABEL Le libellé n'est pas renseigné
E_CIRCULAR_SUBSTITUTION Substitution circulaire (ex : A remplacé par B , B remplacé par A)