API : Add Return Label
Usage de la commande Add Return Label
La commande add_return_label
vous permet d'ajouter une étiquette retour à une commande et d'obtenir le lien vers l'étiquette.
La réponse contient les mêmes informations que la commande Order Query, elle inclut le détail de tous les colis, parmi lesquels se trouve l'étiquette retour créée.
Avant d'ajouter une étiquette retour, vous pouvez d'abord vérifier qu'il n'en existe pas déjà une avec la commande Order Query.
Exemple de requête
<add_return_label>
<AccountName>beautyshop</AccountName>
<order>
<OrderId>486454</OrderId>
<delivery_method_id>87</delivery_method_id>
<DeliveryEmail>jeandurand@domaine.com</DeliveryEmail>
<products>
<product>
<Sku>125452</Sku>
<Quantity>1</Quantity>
</product>
<product>
<Sku>9458454</Sku>
<Quantity>2</Quantity>
</product>
</products>
</order>
</add_return_label>
Champs de la requête
Ces champs ont pour seul but d'identifier la commande. Vous devez donc y reprendre strictement les mêmes valeurs que dans la requête de création de la commande.
Champ | Obligatoire | Description |
---|---|---|
AccountName | Oui | Votre identifiant de compte PMS |
Champs <order>
Champ | Obligatoire | Description |
---|---|---|
OrderId | Oui | Numéro de commande dans votre ERP |
delivery_method_id | Oui | Identifiant PMS du service de transport à utiliser pour le retour. Ce service doit préalablement être créé et configuré dans PMS. |
DeliveryEmail | Non | Adresse email transmise au transporteur |
Champs <order> <products> <product>
Champ | Obligatoire | Description |
---|---|---|
Sku | Oui | Identifiant unique pour chaque article |
Quantity | Oui | Quantité |
Exemple de réponse
<response>
<order>
<OrderId>486454</OrderId>
<CustomerOrderId></CustomerOrderId>
<CustomerId>64154</CustomerId>
<DeliveryNoteId></DeliveryNoteId>
<InvoiceId></InvoiceId>
<ShopId>1</ShopId>
<pms_order_id>784645489</pms_order_id>
<status>90</status>
<message><![CDATA[Attention : merci d'ajouter une carte cadeau]]></message>
<DeliveryMethodId>3</ DeliveryMethodId>
<end_packing_date>2017-09-05 15:10:07</status>
<shipping_date>2017-09-05 15:11:18</status>
<who_packing>14</who_packing>
<who_shipping>14</who_shipping>
<ship_weight>267</ship_weight>
<parcels>
<parcel>
<is_return>0</is_return>
<parcel_rank>1</parcel_rank>
<DeliveryMethodId>54</DeliveryMethodId>
<ship_number>9V154515540151</ship_number>
<ship_weight>267</ship_weight>
<label_url>http://www.transporteur.com/label_9V154515540151.pdf</label_url>
<customs_url>http://www.transporteur.com/cn23_9V154515540151.pdf</customs_url>
<tracking_url>http://www.transporteur.com/track?9V154515540151</tracking_url>
<cost>5.67</cost>
</parcel>
<parcel>
<is_return>1</is_return>
<DeliveryMethodId>87</DeliveryMethodId>
<ship_number>8R42821660094</ship_number>
<ship_weight>0</ship_weight>
<label_url>http://www.transporteur.com/label_8R42821660094.pdf</label_url>
<customs_url></customs_url>
<tracking_url>http://www.transporteur.com/track?8R42821660094</tracking_url>
<cost>5.67</cost>
</parcel>
</parcels>
</order>
</response>
Champs de la réponse
Les champs en majuscules/minuscules sont vos données. Nous ne les explicitons pas ci-dessous. Les champs en minuscules sont les données PMS :
Champ | Description |
---|---|
pms_order_id | Id PMS de l'instance de la commande. Attention cet id change à chaque fois que la commande est retransmise. |
OrderStatus | Deprecated. |
Message | Deprecated. |
status | Statut de la commande dans PMS (voir dictionnaire) |
message | Message interne (consigne aux équipes) |
DeliveryMethodId | Votre id de service de transport |
end_packing_date | |
shipping_date | |
who_packing | Id de l'employé ayant effectué le packing, sous réserve d'avoir renseigné les id employés dans les profils utilisateurs de PMS |
who_shipping | Id de l'employé ayant effectué le shipping, sous réserve d'avoir renseigné les id employés dans les profils utilisateurs de PMS |
ship_weight | Poids de la commande (somme des poids colis) en grammes |
Champs <parcel>
Champ | Description |
---|---|
is_return | 1 s'il s'agit d'un colis retour, 0 sinon |
parcel_rank | N° de séquence du colis (1 à N) |
DeliveryMethodId | Votre id de service de transport |
ship_number | Numéro de suivi du colis |
ship_weight | Poids en grammes |
label_url | URL de l'étiquette transporteur au format PDF |
customs_url | URL des documents de douane au format PDF |
tracking_url | |
cost | Coût du transport HT |