Bons de livraison

Obtenir une liste de bons de livraison

GET /packinglists/packinglists[/status/#{status}][/start_date/#{start_date}][/end_date/#{end_date}][/clients/#{clients}][/tags/#{tags}][/number/#{number}][/user/#{user_id}]

Arguments de l'URI

Argument	Type	Requis	Valeur/Description
status	string		Un ou des statuts à filtrer. Vous pouvez passer plusieurs statuts en même temps en les séparant par ":". Par exemple : /status/draft:sent Voir les valeurs possibles de status.
start_date	date		Si l'argument n'est pas renseigné, la valeur par défaut est le premier jour du mois courant.
end_date	date		Si l'argument n'est pas renseigné, la valeur par défaut est le dernier jour du mois courant.
clients	string		Un ou des clients à filtrer. Vous pouvez passer plusieurs clients en même temps en les séparant par ":". Par exemple : /clients/Client%20Name:Another%20Client%20Name
tags	string		Un ou des tags à filtrer. Vous pouvez passer plusieurs tags en même temps en les séparant par ":". Par exemple : /tags/Tag%201:Tag%202
number	string		Tout ou partie d'un numéro de bon de livraison à filtrer (équivalent à la fonction MySQL "LIKE '#{number}%'".
user	integer		Le #{user_id} de l'utilisateur pour lequel filtrer les résultats.

Exemple de requête avec cURL

	
curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-X GET https://#{subdomain}.iscriba.com/api/packinglists/packinglists/start_date/2010-11-01
	

Exemple de réponse XML

HTTP Status: 200 OK

<?xml version="1.0" encoding="utf-8"?>
<xml>
	<packinglists>
		<packinglist>
			<packinglist_id>5</packinglist_id>
			<company_name>Company Name</company_name>
			<client_id>15</client_id>
			<packinglist_number>BL10110001</packinglist_number>
			<invoice_number></invoice_number>
			<related_invoice_id>0</related_invoice_id>
			<purchaseorder_number></purchaseorder_number>
			<related_purchaseorder_id>0</related_purchaseorder_id>
			<date_packinglist>2010-11-26</date_packinglist>
			<status>draft</status>
			<shipped_total>6</shipped_total>
		</packinglist>
		<packinglist>
		...
		</packinglist>
	</packinglists>
</xml>
	

Haut

---

Obtenir un bon de livraison

GET /packinglists/packinglist/id/#{packinglist_id}

Arguments de l'URI

Argument	Type	Requis	Valeur
id	integer	oui	Le #{packinglist_id} du bon de livraison que vous souhaitez obtenir.

Exemple de requête avec cURL

	
curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-X GET https://#{subdomain}.iscriba.com/api/packinglists/packinglist/id/6
	

Exemple de réponse XML

HTTP Status: 200 OK

<xml>
	<packinglist>
		<packinglist_id>6</packinglist_id>
		<user_id>1</user_id>
		<company_id>1</company_id>
		<company_name>Company Name</company_name>
		<summary></summary>
		<client_id>2</client_id>
		<client_name>Client Name</client_name>
		<client_language>french</client_language>
		<packinglist_number>BL10120001</packinglist_number>
		<related_invoice_id>0</related_invoice_id>
		<related_purchaseorder_id>4</related_purchaseorder_id>
		<invoice_number></invoice_number>
		<purchaseorder_number>BC10090004</purchaseorder_number>
		<date_creation>2010-12-01 16:54:29</date_creation>
		<date_packinglist>2010-12-01</date_packinglist>
		<shipped_total>3</shipped_total>
		<ordered_total>3</ordered_total>
		<weight_total>0</weight_total>
		<packages>0</packages>
		<massunit>kg</massunit>
		<carrier></carrier>
		<carrier_specified></carrier_specified>
		<tracking_url></tracking_url>
		<tracking_number></tracking_number>
		<delivery_address>
			<name>Client Name</name>
			<address1></address1>
			<address2></address2>
			<address3></address3>
			<address4></address4>
			<city></city>
			<state></state>
			<postalcode></postalcode>
			<country>FR</country>
		</delivery_address>
		<notes></notes>
		<status>draft</status>
		<to_be_delivered_total>0</to_be_delivered_total>
		<lines>
			<line>
				<line_id>8</line_id>
				<line_number>1</line_number>
				<item_id>3</item_id>
				<kind>1</kind>
				<description>Lorem ispum dolor sit amet.</description>
				<weight>0</weight>
				<qty_shipped>3</qty_shipped>
				<qty_ordered>3</qty_ordered>
				<qty_unshipped>0</qty_unshipped>
			</line>
		</lines>
	</packinglist>
</xml>
	

Haut

---

Obtenir un bon de livraison au format PDF

GET /packinglists/packinglist/id/#{packinglist_id}/format/pdf

Arguments de l'URI

Argument	Type	Requis	Valeur
id	integer	oui	Le #{packinglist_id} du bon de livraison que vous souhaitez obtenir.

Exemple de requête avec cURL

	
curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-X GET https://#{subdomain}.iscriba.com/api/packinglists/packinglist/id/6/format/pdf
	

Exemple de réponse XML

HTTP Status: 200 OK
Content-Type: application/pdf

%PDF-1.4

...

%%EOF
	

Haut

---

Créer un bon de livraison

POST /packinglists/packinglist

Champs de la requête

Champ	Type	Requis	Description
date	date	oui	Date du bon de livraison. Ne peut pas être antérieur à la date du dernier bon de livraison créé.
client_id	integer	oui	Le #{client_id} de la société pour laquelle vous créez le bon de livraison.
summary	string		Un résumé du bon de livraison (pour usage interne).
invoice_number	string		Un numéro de facture associé à ce bon de livraison.
purchaseorder_number	string		Un numéro de bon de commande associé à ce bon de livraison.
address	array		Ce champ sert à personnaliser l'adresse de livraison. Si vous ne le transmettez pas, l'adresse par défaut du client est utilisée.
address[address1]	string		Ligne d'adresse 1.
address[address2]	string		Ligne d'adresse 2.
address[address3]	string		Ligne d'adresse 3.
address[address4]	string		Ligne d'adresse 4.
address[city]	string		Ville.
address[state]	string		Région/Etat.
address[postalcode]	string		Code postal.
lines	array	oui (au moins une ligne)	Les lignes du bon de livraison.
lines[#{key}][item_id]	integer		Le #{item_id} de l'article de l'inventaire associé à la ligne. S'il est renseigné, le champ description n'est plus requis.
lines[#{key}][kind]	integer		Type de la ligne. La valeur par défaut est "1" pour "Service". Voir les valeurs possibles de kind.
lines[#{key}][description]	string	oui	Description de l'article.
lines[#{key}][weight]	double		Poids de l'article. Vaut 0 par défaut.
lines[#{key}][qty_shipped]	double		Quantité d'articles livrés. Vaut 1 par défaut.
lines[#{key}][qty_ordered]	double		Quantité d'articles commandés. Vaut 1 par défaut.
carrier	string		Transporteur utilisé pour la livraison. Voir les valeurs possibles de carrier.
tracking_url	string		L'adresse URL pour le suivi de la livraison. Ajouter le symbole @ à l'endroit de l'URL où doit se situer le numéro de suivi. Par exemple : "http://www.chronopost.fr/WEB_SHIPPING/inputLTNumbersNoJahia.do?listeNumeros=@". Pour les transporteurs prédéfinis (voir carrier), iScriba remplit ce champ automatiquement.
tracking_number	string		Le numéro de suivi de la livraison.
packages	integer		Le nombre de colis constituant la livraison.
mass_unit	string		L'unité de mesure de poids. Voir les valeurs possibles de mass_unit.
notes	string		Les notes que vous souhaitez ajouter au bon de livraison. Ce champ n'apparait pas sur le document si vous le laissez vide.

Exemple de requête avec cURL

curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-d "date=2010-12-01&client_id=16&lines[0][item_id]=3&lines[0][qty_shipped]=2&lines[0][qty_ordered]=2&lines[1][description]=Lorem ipsum dolor sit amet&lines[1][qty_shipped]=1&lines[1][qty_ordered]=1"\
https://#{subdomain}.iscriba.com/api/packinglists/packinglist
	

Exemple de réponse XML

HTTP Status: 201 Created

<?xml version="1.0" encoding="utf-8"?>
<xml>
	<packinglist_id>1</packinglist_id>
</xml>	
	

Haut

---

Modifier un bon de livraison

PUT /packinglists/packinglist/id/#{packinglist_id}

Arguments de l'URI

Argument	Type	Requis	Valeur
id	integer	oui	Le #{packinglist_id} du bon de livraison que vous souhaitez modifier.

Champs de la requête

Identiques à créer un bon de livraison excepté qu'aucun champ n'est requis. Tous les champs non intégrés à la requête resteront inchangés. Les champs date et client_id ne sont pas pris en compte.

Attention : pour les champs de type array, vous devez transmettre le tableau complet si vous souhaitez ajouter, modifier ou supprimer un élément du tableau.

Exemple de requête avec cURL

curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-X PUT\
-d "lines[0][item_id]=3&lines[0][description]=Lorem ipsum dolor sit amet&lines[0][qty_shipped]=2&lines[0][qty_ordered]=2&lines[1][description]=Lorem ipsum dolor sit amet&lines[1][qty_shipped]=1&lines[1][qty_ordered]=1"\
https://#{subdomain}.iscriba.com/api/packinglists/packinglist/id/1
	

Exemple de réponse XML

HTTP Response: 200 OK

<?xml version="1.0" encoding="utf-8"?>
<xml>
	<packinglist_id>1</packinglist_id>
</xml>	
	

Haut

---

Mettre à jour le statut d'un bon de livraison

PUT /packinglists/packinglist_status/id/#{packinglist_id}

Arguments de l'URI

Argument	Type	Requis	Valeur
id	integer	oui	Le #{packinglist_id} du bon de livraison dont vous souhaitez modifier le statut.

Champs de la requête

Champ	Type	Requis	Description
status	string	oui	Voir les valeurs possibles de status.

Exemple de requête avec cURL

curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-X PUT\
-d "status=sent" https://#{subdomain}.iscriba.com/api/packinglists/packinglist_status/id/1
	

Exemple de réponse XML

HTTP Response: 200 OK

<?xml version="1.0" encoding="utf-8"?>
<xml>
	<packinglist>
		<status>sent</status>
	</packinglist>
</xml>	
	

Haut

---

Supprimer un bon de livraison

DELETE /packinglists/packinglist/id/#{packinglist_id}

Arguments de l'URI

Argument	Type	Requis	Valeur
id	integer	oui	Le #{packinglist_id} du bon de livraison que vous souhaitez supprimer.

Exemple de requête avec cURL

curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-X DELETE https://#{subdomain}.iscriba.com/api/packinglists/packinglist/id/1
	

Exemple de réponse XML

HTTP Response: 200 OK

<?xml version="1.0" encoding="utf-8"?>
<xml>
	<packinglist_id>1</packinglist_id>
</xml>	
	

Haut

---

Obtenir les commentaires liés à un bon de livraison

GET /packinglists/packinglist_related_comments/id/#{packinglist_id}

Arguments de l'URI

Argument	Type	Requis	Valeur
id	integer	oui	Le #{packinglist_id} du bon de livraison dont vous souhaitez obtenir les commentaires liés.

Exemple de requête avec cURL

	
curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-X GET https://#{subdomain}.iscriba.com/api/packinglists/packinglist_related_comments/id/19
	

Exemple de réponse XML

HTTP Status: 200 OK

<?xml version="1.0" encoding="utf-8"?>
<xml>
	<packinglist_related_comments>
		<packinglist_related_comment>
			<comment_id>14</comment_id>
			<packinglist_id>19</packinglist_id>
			<user_id>1</user_id>
			<firstname>John</firstname>
			<lastname>Doe</lastname>
			<title></title>
			<subtitle></subtitle>
			<content>Lorem ipsum dolor sit amet.</content>
			<date>2010-12-23</date>
			<type>post</type>
			<is_public>0</is_public>
		</packinglist_related_comment>
		<packinglist_related_comment>
		...
		</packinglist_related_comment>
	</packinglist_related_comments>
</xml>
	

Haut

---

Créer un commentaire lié à un bon de livraison

POST /packinglists/packinglist_related_comment

Champs de la requête

Champ	Type	Requis	Description
packinglist_id	integer	oui	Le #{packinglist_id} du bon de livraison auquel sera lié le commentaire.
content	string	oui	Le contenu du commentaire (seul le texte brut est autorisé).
is_public	boolean		Défini si le commentaire est visible par le client. La valeur par défaut est TRUE (le commentaire est public).

Exemple de requête avec cURL

curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-d "packinglist_id=10&content=Lorem ipsum dolor sit amet.&is_public=0"\
https://#{subdomain}.iscriba.com/api/packinglists/packinglist_related_comment
	

Exemple de réponse XML

HTTP Status: 201 Created

<?xml version="1.0" encoding="utf-8"?>
<xml>
	<comment_id>1</comment_id>
</xml>	
	

Haut

---

Supprimer un commentaire lié à un bon de livraison

DELETE /packinglists/packinglist_related_comment/id/#{comment_id}

Arguments de l'URI

Argument	Type	Requis	Valeur
id	integer	oui	Le #{comment_id} du commentaire que vous souhaitez supprimer.

Exemple de requête avec cURL

curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-X DELETE https://#{subdomain}.iscriba.com/api/packinglists/packinglist_related_comment/id/1
	

Exemple de réponse XML

HTTP Response: 200 OK

<?xml version="1.0" encoding="utf-8"?>
<xml>
	<comment_id>1</comment_id>
</xml>	
	

Haut

---

Obtenir les documents liés à un bon de livraison

GET /packinglists/packinglist_related_documents/id/#{packinglist_id}

Arguments de l'URI

Argument	Type	Requis	Valeur
id	integer	oui	Le #{packinglist_id} du bon de livraison dont vous souhaitez obtenir les documents liés.

Exemple de requête avec cURL

	
curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-X GET https://#{subdomain}.iscriba.com/api/packinglists/packinglist_related_documents/id/19
	

Exemple de réponse XML

HTTP Status: 200 OK

<?xml version="1.0" encoding="utf-8"?>
<xml>
	<related_documents>
		<related_document>
			<id>5</id>
			<number>D10090005</number>
			<date_creation>2010-09-29 15:03:17</date_creation>
			<date>2010-09-29</date>
			<total>717.6</total><!-- Total TTC -->
			<currency>EUR</currency>
			<type></type>
			<kind>estimate</kind>
			<status>invoiced</status>
		</related_document>
		<related_document>
			...
		</related_document>
	</related_documents>
</xml>
	

Haut

---

Obtenir les tags liés à un bon de livraison

GET /packinglists/packinglist_related_tags/id/#{packinglist_id}

Arguments de l'URI

Argument	Type	Requis	Valeur
id	integer	oui	Le #{packinglist_id} du bon de livraison dont vous souhaitez obtenir les tags liés.

Exemple de requête avec cURL

	
curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-X GET https://#{subdomain}.iscriba.com/api/packinglists/packinglist_related_tags/id/19
	

Exemple de réponse XML

HTTP Status: 200 OK

<?xml version="1.0" encoding="utf-8"?>
<xml>
	<packinglist_related_tags>
		<packinglist_related_tag>
			<tag_id>5</tag_id>
			<tag_name>lorem</tag_name>
		</packinglist_related_tag>
		<packinglist_related_tag>
		...
		</packinglist_related_tag>
	</packinglist_related_tags>
</xml>
	

Haut

---

Créer un tag lié à un bon de livraison

POST /packinglists/packinglist_related_tag

Champs de la requête

Champ	Type	Requis	Description
packinglist_id	integer	oui	Le #{packinglist_id} du bon de livraison auquel sera lié le tag.
tag	string	oui	Le nom du tag.

Exemple de requête avec cURL

curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-d "packinglist_id=10&tag=Votre-tag"\
https://#{subdomain}.iscriba.com/api/packinglists/packinglist_related_tag
	

Exemple de réponse XML

HTTP Status: 201 Created

<?xml version="1.0" encoding="utf-8"?>
<xml>
	<tag_id>1</tag_id>
</xml>	
	

Haut

---

Supprimer un tag lié à un bon de livraison

DELETE /packinglists/packinglist_related_tag/packinglist_id/#{packinglist_id}/tag_id/#{tag_id}

Arguments de l'URI

Argument	Type	Requis	Valeur
packinglist_id	integer	oui	Le #{packinglist_id} du bon de livraison auquel est associé le tag.
tag_id	integer	oui	Le #{tag_id} du tag lié au bon de livraison.

Exemple de requête avec cURL

curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-X DELETE https://#{subdomain}.iscriba.com/api/packinglists/packinglist_related_tag/packinglist_id/1/tag_id/1
	

Exemple de réponse XML

HTTP Response: 200 OK

<?xml version="1.0" encoding="utf-8"?>
<xml>
	<tag_id>1</tag_id>
</xml>	
	

Haut

---