Format JSON

Format des données

Les données sont à présenter dans un format JSON qui se présente comme démontré dans la colonne de droite.

Vous trouverez également une liste complète des champs obligatoires et facultatifs ci-dessous.

Le client

Tous les détails concernant le client sont préfixés par 'Customer'.

CustomerFirstName string requis Prénom du client
CustomerLastName string requis Nom du client
CustomerEmail string requis Email du client
CustomerPhone string facultatif Téléphone du client au format français ou internationnal
CustomerAddressLine1 string requis Adresse de facturation du client
CustomerAddressLine2 string facultatif Complément d'adresse de facturation du client
CustomerPostalCode string requis Code postal de facturation du client
CustomerCity string requis Ville de facturation du client
CustomerRegion string facultatif Région de facturation du client
CustomerCountry string requis Pays de facturation du client sur 2 caractères majuscules, en norme ISO

 

La commande

Tous les détails concernant la commande sont préfixés par 'Order'.

OrderId integer requis Identifiant de la commande
OrderInvoiceNumber string facultatif Numéro de facture de la commande
OrderPrice integer requis Le montant TTC de la commande en centimes
OrderTaxPrice integer requis Le montant des taxes en centimes
OrderCurrency string requis Devise de la commande. A l'heure actuelle, seul 'EUR' est accepté

 

Le colis

Tous les détails concernant le colis sont préfixés par 'Parcel'.

ParcelWeight integer facultatif Poids du colis en grammes
ParcelWidth integer facultatif Largeur du colis en cm
ParcelHeight integer facultatif Hauteur du colis en cm
ParcelLength string facultatif Profondeur du colis en cm
ParcelStorage string facultatif Conditionnement des produits envoyés. Doit être de la liste : [carton, plastic, other]
ParcelDescription string facultatif Texte court décrivant au mieux le contenu de la commande (Ex: Vêtements, pièces détachées automobile, ...)

 

Les frais de port jusqu'aux entrepôts Neadly

Tous les détails concernant les frais de port sont préfixés par 'Shipping'.

L'indication des frais de port n'est pas obligatoire mais si un des champs est renseigné, tous les autres sont obligatoires.

ShippingReference string requis Référence du produit de livraison
ShippingName string requis Nom du transporteur
ShippingPrice integer requis Le montant TTC des frais de port en centimes
ShippingTaxPrice integer requis Le montant de la taxe sur les frais de port en centimes
ShippingTax float requis Le taux de taxe appliqué aux frais de port, en fraction. Pour une taxe à 20%, indiquer 0.2
ShippingTaxCode string requis Code de TVA suivant la liste fournie ici : liste des codes de TVAs

 

Les remises

Tous les détails concernant les remises sont préfixés par 'Discount'.

L'indication d'une remise n'est pas obligatoire mais si un des champs est renseigné, tous les autres sont obligatoires.

DiscountReference string requis Référence du code promo, de la réduction, ...
DiscountName string requis Nom à afficher sur la ligne de la réduction
DiscountPrice integer requis Le montant TTC de la réduction en centimes
DiscountTaxPrice integer requis Le montant de la taxe sur la remise
DiscountTax float requis Le taux de taxe appliqué aux frais de port, en fraction. Pour une taxe à 20%, indiquer 0.2
DiscountTaxCode string requis Code de TVA suivant la liste fournie ici : liste des codes de TVAs

 

Les produits

Les produits sont à présenter dans un tableau de produits. Chaque objet Produit du tableau doit être constitué ainsi :

Reference string requis Référence du produit
Name string requis Nom du produit
Price integer requis Le montant TTC unitaire du produit
TaxPrice integer requis Le montant de la taxe unitaire sur le produit
Tax float requis Le taux de taxe appliqué sur le produit, en fraction. Pour une taxe à 20%, indiquer 0.2
TaxCode string requis Code de TVA suivant la liste fournie ici : liste des codes de TVAs
Quantity integer facultatif Nombre de produits au panier
Weight float facultatif Poids en Kg
Width integer facultatif Largeur en cm
Height integer facultatif Hauteur en cm
Length integer facultatif Profondeur en cm

 

Gestion des URLs

Il est possible de spécifier les URLs de navigation lors de l'appel à l'API. Si ces URLs sont spécifiées, elles seront utilisées en lieu et place de celles précisées par défaut dans votre tableau de bord.

ReturnURL string facultatif URL vers laquelle l'internaute sera redirigé s'il décide de quitter le processus de paiement
SuccesURL string facultatif URL vers laquelle l'internaute sera redirigé sur le site marchand après un succès de paiement
FailureURL string facultatif URL vers laquelle l'internaute sera redirigé sur le site marchand en cas d'échec de paiement
{
	"CustomerFirstName":		"Nom",
	"CustomerLastName":		"Prénom",
	"CustomerEmail":			"nomprenom@fournisseur.ext",
	"CustomerPhone":			"061234567",
	"CustomerAddressLine1":	"51 Grande Rue",
	"CustomerAddressLine2":	"2ème étage",
	"CustomerCity":				"Paris",
	"CustomerRegion":			"",
	"CustomerPostalCode":		"75000",
	"CustomerCountry":			"FR",

	"OrderId": 					20160106000489,
	"OrderInvoiceNumber": 		"2016-FAC-000489",
	"OrderPrice": 				8249,
	"OrderTaxPrice": 			858,
	"OrderCurrency": 			"EUR",

	"ParcelWeight":				 2,
	"ParcelWidth": 				100,
	"ParcelHeight": 				100,
	"ParcelLength": 				200,
	"ParcelStorage": 				"carton",
	"ParcelDescription": 			"HighTech",

	"ShippingReference":		"Laposte",
	"ShippingName": 			"Laposte",
	"ShippingPrice": 				3000,
	"ShippingTaxPrice": 			600,
	"ShippingTax": 				0.2,
	"ShippingTaxCode": 			"normal",

	"DiscountReference": 		"remise",
	"DiscountName": 			"Remise 10",
	"DiscountPrice": 			1000,
	"DiscountTaxPrice": 			0,
	"DiscountTax": 				0,
	"DiscountTaxCode": 			"normal",

	"Products": [
		{
			"Reference": 		"produit_1",
			"Name": 			"Produit 1",
			"Price": 				10000,
			"TaxPrice": 			2000,
			"Tax": 				0.2,
			"TaxCode": 			"normal",
			"Quantity": 			1,
			"Weight": 			1,
			"Width": 			22,
			"Height": 			33,
			"Length": 			15
		},
		{
			"Reference": 		"produit_2",
			"Name": 			"Produit 2",
			"Price": 				20000,
			"TaxPrice": 			2000,
			"Tax": 				0.1,
			"TaxCode": 			"normal",
			"Quantity": 			2,
			"Weight": 			2,
			"Width": 			10,
			"Height": 			10,
			"Length": 			20
		}
	],
	"ReturnURL":				"https://domaine_marchand.com",
	"SuccesURL":				"https://domaine_marchand.com/success",
	"FailureURL": 				"https://domaine_marchand.com/echec"
}