Partager via

Easyship (Éditeur indépendant) (préversion)

Easyship fournit un service puissant pour vous d’ajouter des options d’expédition mondiale sans soucis à votre site web et de bout en bout de la fonctionnalité d’expédition à votre entrepôt, ERP ou plateforme.

Ce connecteur est disponible dans les produits et régions suivants :

Service classe Régions
Copilot Studio Premium Toutes les régions Power Automate , à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Applications logiques Norme Toutes les régions Logic Apps , à l’exception des suivantes :
     - Régions Azure Government
     - Régions Azure Chine
     - Us Department of Defense (DoD)
Power Apps Premium Toutes les régions Power Apps , à l’exception des suivantes :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Power Automate Premium Toutes les régions Power Automate , à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Contact
Nom Troy Taylor
URL https://www.hitachisolutions.com
Messagerie électronique ttaylor@hitachisolutions.com
Métadonnées du connecteur
Éditeur Troy Taylor
Site internet https://www.easyship.com/
Politique de confidentialité https://www.easyship.com/legal/privacy
Catégories Gestion de l’entreprise ; Commerce

Création d’une connexion

Le connecteur prend en charge les types d’authentification suivants :
Par défaut Paramètres de création de connexion. Toutes les régions Impossible à partager

Faire défaut

Applicable : Toutes les régions

Paramètres de création de connexion.

Ce n’est pas une connexion partageable. Si l’application Power est partagée avec un autre utilisateur, un autre utilisateur sera invité à créer explicitement une nouvelle connexion.

Nom Type Descriptif Obligatoire
Jeton d’accès à l’API (au format : BEARer APIAccessToken) securestring Jeton d’accès à l’API (au format : BEARer APIAccessToken) pour cette API Vrai

Limitations

Nom Appels Période de renouvellement
Appels d’API par connexion 100 60 secondes

Actions

Acheter une étiquette d’expédition (V1)

Achetez et récupérez des informations sur une étiquette d’expédition.
Créer une expédition

Crée et récupère les informations relatives à une expédition.
Demander un enlèvement (V1)

Lorsqu’un enlèvement est créé, une demande de collecte est effectuée directement vers le courrier, qui renvoie un numéro de référence. Le numéro de référence peut être utilisé lors du contact avec le service client du courrier. Un emplacement de prise en charge doit être choisi ; Les emplacements de prise en charge à venir peuvent être trouvés à l’aide de l’action « Obtenir les emplacements de prise disponibles ».
Mettre à jour l’état de l’entrepôt

Mettez à jour l’état de l’entrepôt d’une expédition. Disponible uniquement pour les expéditions remplies à l’un des entrepôts intégrés Easyship.
Mettre à jour une expédition

Mettez à jour les détails d’une expédition.
Obtenir des points de contrôle

Récupère les détails des points de contrôle d’expédition.
Obtenir la catégories de l’élément

Récupère une liste de catégories d’expéditions et de la slug pour utiliser la catégorie.
Obtenir les emplacements de prise en charge disponibles (V1)

Les emplacements de prise en charge disponibles seront calculés pour un courrier spécifique, dans l’heure locale et pour les 7 prochains jours. Un enlèvement peut ensuite être demandé à l’aide de l’action « Demande d’enlèvement ».
Obtenir les tarifs et les taxes

Récupérez une liste de devis d’expédition pour une expédition potentielle.
Obtenir l’état du suivi

Récupère l’état de suivi d’une expédition.
Obtenir une expédition

Obtenez les détails d’une expédition.
Répertorier toutes les expéditions

Récupère une liste de toutes les expéditions.
Répertorier toutes les zones

Récupère une liste de toutes les boîtes de messagerie disponibles.
Supprimer une expédition (V1)

Supprimez et recevez la confirmation d’une suppression d’expédition.

Acheter une étiquette d’expédition (V1)

ID d’opération :
BuyAShipmentLabel

Achetez et récupérez des informations sur une étiquette d’expédition.

Paramètres

Nom Clé Obligatoire Type Description
ID d’expédition easyship
 easyship_shipment_id string

Identificateur unique de l’expédition Easyship.
ID de courrier
 courier_id string

Identificateur unique de courrier.

Retours

Nom Chemin d’accès Type Description
Message
 message string

Message.
Errors
 errors array of

Erreurs.
Coût total
 total_cost integer

Coût total.
Solde disponible
 available_balance integer

Solde disponible.
Étiquettes
 labels array of object
ID d’expédition easyship
 labels.easyship_shipment_id string

Identificateur unique de l’expédition Easyship.
État de l’étiquette
 labels.label_state string

État de l’étiquette.
URL d’étiquette
 labels.label_url string

Adresse URL de l’étiquette.
Statut
 labels.status string

État.
Numéro de suivi
 labels.tracking_number string

Numéro de suivi.
URL de la page de suivi
 labels.tracking_page_url string

Adresse URL de la page de suivi.

Créer une expédition

ID d’opération :
CreateAShipment

Crée et récupère les informations relatives à une expédition.

Paramètres

Nom Clé Obligatoire Type Description
Adresse
 line_1 string

Adresse.
Ligne d’adresse 2
 line_2 string

Ligne d’adresse 2.
État
 state string

État.
Ville
 city string

Ville.
Code postal
 postal_code string

Code postal.
Code pays
 country_alpha2 string

Code du pays.
Nom du contact
 contact_name string

Nom du contact.
Nom de l’entreprise
 company_name string

Nom de la société.
Numéro de téléphone du contact
 contact_phone string

Numéro de téléphone du contact.
E-mail de contact
 contact_email string

Adresse e-mail du contact.
Adresse
 line_1 string

Adresse.
Ligne d’adresse 2
 line_2 string

Ligne d’adresse 2.
État
 state string

État.
Ville
 city string

Ville.
Code postal
 postal_code string

Code postal.
Code pays
 country_alpha2 string

Code du pays.
Nom du contact
 contact_name string

Nom du contact.
Nom de l’entreprise
 company_name string

Nom de la société.
Numéro de téléphone du contact
 contact_phone string

Numéro de téléphone du contact.
E-mail de contact
 contact_email string

Adresse e-mail du contact.
Adresse
 line_1 string

Adresse.
Ligne d’adresse 2
 line_2 string

Ligne d’adresse 2.
État
 state string

État.
Ville
 city string

Ville.
Code postal
 postal_code string

Code postal.
Code pays
 country_alpha2 string

Code du pays.
Nom du contact
 contact_name string

Nom du contact.
Nom de l’entreprise
 company_name string

Nom de la société.
Numéro de téléphone du contact
 contact_phone string

Numéro de téléphone du contact.
E-mail de contact
 contact_email string

Adresse e-mail du contact.
Adresse
 line_1 string

Adresse.
Ligne d’adresse 2
 line_2 string

Ligne d’adresse 2.
État
 state string

État.
Ville
 city string

Ville.
Code postal
 postal_code string

Code postal.
Code pays
 country_alpha2 string

Code du pays.
Nom du contact
 contact_name string

Nom du contact.
Nom de l’entreprise
 company_name string

Nom de la société.
Numéro de téléphone du contact
 contact_phone string

Numéro de téléphone du contact.
E-mail de contact
 contact_email string

Adresse e-mail du contact.
Définir comme résidentiel
 set_as_residential boolean

Si elle est définie comme résidentielle.
ID fiscal du destinataire
 consignee_tax_id string

Identificateur fiscal du destinataire.
Informations de référence sur l’EEI
 eei_reference string

Référence EEI.
Incoterms
 incoterms string

Les incoterms.
Est assuré
 is_insured boolean

S’il est assuré.
Montant assuré
 insured_amount integer

Montant assuré.
Devise assurée
 insured_currency string

Devise assurée.
Nom de la plateforme
 platform_name string

Nom de la plateforme.
Numéro d’ordre de plateforme
 platform_order_number string

Numéro de commande de la plateforme.
Liste des étiquettes de commande
 order_tag_list array of string

Liste des étiquettes de commande.
Notes du vendeur
 seller_notes string

Notes du vendeur.
Notes de l’acheteur
 buyer_notes string

Note de l’acheteur.
ID de courrier sélectionné
 selected_courier_id string

Identificateur de courrier sélectionné.
Autoriser la secours de Courrier
 allow_courier_fallback boolean

S’il faut autoriser la secours de courrier.
Appliquer des règles d’expédition
 apply_shipping_rules boolean

Indique si les règles d’expédition ont été appliquées.
Weight
 weight string

Le poids.
Taille
 dimensions string

Dimensions.
Format
 format string

Format.
Étiquette
 label string

Étiquette.
Facture commerciale
 commercial_invoice string

Facture commerciale.
Bon de livraison
 packing_slip string

Le glissement d’emballage.
Acheter une étiquette
 buy_label boolean

Indique si l’étiquette est achetée.
Acheter une étiquette synchrone
 buy_label_synchronous boolean

Indique si l’étiquette est achetée de façon synchrone.
Poids réel total
 total_actual_weight float

Poids réel total.
Slug
 slug string
Length
 length integer

Longueur.
Largeur
 width integer

Largeur.
Hauteur
 height integer

Hauteur.
Descriptif
 description string

Description.
Catégorie
 category string

Catégorie.
Référence (SKU)
 sku string

Référence SKU.
Quantité
 quantity integer

Quantité.
Length
 length string

Longueur.
Largeur
 width string

Largeur.
Hauteur
 height string

Hauteur.
Poids réel
 actual_weight integer

Poids réel.
Devise déclarée
 declared_currency string

Devise déclarée.
Valeur douanière déclarée
 declared_customs_value integer

Valeur douanière déclarée.

Retours

Nom Chemin d’accès Type Description
Statut
 status string

État.
Errors
 errors array of

Erreurs.
ID d’expédition easyship
 shipment.easyship_shipment_id string

Identificateur d’expédition Easyship.
Créé à
 shipment.created_at string

Créé à.
Mise à jour à
 shipment.updated_at string

Lorsqu’il est mis à jour à l’adresse.
Étiquette payée à
 shipment.label_paid_at string

Étiquette payée.
Étiquette générée à
 shipment.label_generated_at string

Étiquette générée à.
Ordre créé à l’adresse
 shipment.order_created_at string

Ordre créé à l’adresse.
Adresse
 shipment.origin_address.line_1 string

Adresse.
Ligne d’adresse 2
 shipment.origin_address.line_2 string

Ligne d’adresse 2.
État
 shipment.origin_address.state string

État.
Ville
 shipment.origin_address.city string

Ville.
Code postal
 shipment.origin_address.postal_code string

Code postal.
Code pays
 shipment.origin_address.country_alpha2 string

Code du pays.
Nom du contact
 shipment.origin_address.contact_name string

Nom du contact.
Nom de l’entreprise
 shipment.origin_address.company_name string

Nom de la société.
Numéro de téléphone du contact
 shipment.origin_address.contact_phone string

Numéro de téléphone du contact.
E-mail de contact
 shipment.origin_address.contact_email string

Adresse e-mail du contact.
Adresse
 shipment.sender_address.line_1 string

Adresse.
Ligne d’adresse 2
 shipment.sender_address.line_2 string

Ligne d’adresse 2.
État
 shipment.sender_address.state string

État.
Ville
 shipment.sender_address.city string

Ville.
Code postal
 shipment.sender_address.postal_code string

Code postal.
Code pays
 shipment.sender_address.country_alpha2 string

Code du pays.
Nom du contact
 shipment.sender_address.contact_name string

Nom du contact.
Nom de l’entreprise
 shipment.sender_address.company_name string

Nom de la société.
Numéro de téléphone du contact
 shipment.sender_address.contact_phone string

Numéro de téléphone du contact.
E-mail de contact
 shipment.sender_address.contact_email string

Adresse e-mail du contact.
Adresse
 shipment.return_address.line_1 string

Adresse.
Ligne d’adresse 2
 shipment.return_address.line_2 string

Ligne d’adresse 2.
État
 shipment.return_address.state string

État.
Ville
 shipment.return_address.city string

Ville.
Code postal
 shipment.return_address.postal_code string

Code postal.
Code pays
 shipment.return_address.country_alpha2 string

Code du pays.
Nom du contact
 shipment.return_address.contact_name string

Nom du contact.
Nom de l’entreprise
 shipment.return_address.company_name string

Nom de la société.
Numéro de téléphone du contact
 shipment.return_address.contact_phone string

Numéro de téléphone du contact.
E-mail de contact
 shipment.return_address.contact_email string

Adresse e-mail du contact.
Adresse
 shipment.destination_address.line_1 string

Adresse.
Ligne d’adresse 2
 shipment.destination_address.line_2 string

Ligne d’adresse 2.
État
 shipment.destination_address.state string

État.
Ville
 shipment.destination_address.city string

Ville.
Code postal
 shipment.destination_address.postal_code string

Code postal.
Code pays
 shipment.destination_address.country_alpha2 string

Code du pays.
Nom du contact
 shipment.destination_address.contact_name string

Nom du contact.
Nom de l’entreprise
 shipment.destination_address.company_name string

Nom de la société.
Numéro de téléphone du contact
 shipment.destination_address.contact_phone string

Numéro de téléphone du contact.
E-mail de contact
 shipment.destination_address.contact_email string

Adresse e-mail du contact.
Nom de la plateforme
 shipment.order_data.platform_name string

Nom de la plateforme.
Numéro d’ordre de plateforme
 shipment.order_data.platform_order_number string

Numéro de commande de la plateforme.
Liste des étiquettes de commande
 shipment.order_data.order_tag_list array of string

Liste des étiquettes de commande.
Notes du vendeur
 shipment.order_data.seller_notes string

Notes du vendeur.
Notes de l’acheteur
 shipment.order_data.buyer_notes string

Note de l’acheteur.
Définir comme résidentiel
 shipment.set_as_residential boolean

Si elle est définie comme résidentielle.
ID fiscal du destinataire
 shipment.consignee_tax_id string

Identificateur fiscal du destinataire.
Informations de référence sur l’EEI
 shipment.eei_reference string

Référence EEI.
Incoterms
 shipment.incoterms string

Les incoterms.
Est assuré
 shipment.insurance.is_insured boolean

S’il est assuré.
Montant assuré
 shipment.insurance.insured_amount integer

Montant assuré.
Devise assurée
 shipment.insurance.insured_currency string

Devise assurée.
Nombre de colis
 shipment.parcels_count integer

Le nombre de parcelles.
Colis
 shipment.parcels array of object
Poids réel total
 shipment.parcels.total_actual_weight float

Poids réel total.
Valeur douanière totale
 shipment.parcels.total_customs_value float

Valeur douanière totale.
Poids total dimensionnel
 shipment.parcels.total_dimensional_weight float

Poids total de la dimension.
Poids volume total
 shipment.parcels.total_volumetric_weight float

Poids volumétrique total.
ID
 shipment.parcels.box.id string

Identificateur unique .
Slug
 shipment.parcels.box.slug string

La.
Length
 shipment.parcels.box.length integer

Longueur.
Largeur
 shipment.parcels.box.width integer

Largeur.
Hauteur
 shipment.parcels.box.height integer

Hauteur.
items
 shipment.parcels.items array of object
Descriptif
 shipment.parcels.items.description string

Description.
Catégorie
 shipment.parcels.items.category string

Catégorie.
Référence (SKU)
 shipment.parcels.items.sku string

Référence SKU.
Quantité
 shipment.parcels.items.quantity integer

Quantité.
Poids réel
 shipment.parcels.items.actual_weight integer

Poids réel.
Poids dimensionnel
 shipment.parcels.items.dimensional_weight integer

Poids dimensionnel.
Poids volumétrique
 shipment.parcels.items.volumetric_weight integer

Poids volumétrique.
Devise d’origine
 shipment.parcels.items.origin_currency string

Devise d’origine.
Valeur douanière d’origine
 shipment.parcels.items.origin_customs_value integer

Valeur douanière d’origine.
Devise déclarée
 shipment.parcels.items.declared_currency string

Devise déclarée.
Valeur douanière déclarée
 shipment.parcels.items.declared_customs_value integer

Valeur douanière déclarée.
Length
 shipment.parcels.items.dimensions.length integer

Longueur.
Largeur
 shipment.parcels.items.dimensions.width integer

Largeur.
Hauteur
 shipment.parcels.items.dimensions.height integer

Hauteur.
Valeur douanière totale
 shipment.total_customs_value float

Valeur douanière totale.
Poids réel total
 shipment.total_actual_weight float

Poids réel total.
Poids total dimensionnel
 shipment.total_dimensional_weight float

Poids total de la dimension.
Poids volume total
 shipment.total_volumetric_weight float

Poids volumétrique total.
État de l’expédition
 shipment.shipment_state string

État de l’expédition.
État de l’enlèvement
 shipment.pickup_state string

État de l’enlèvement.
État de remise
 shipment.delivery_state string

État de remise.
État de l’étiquette
 shipment.label_state string

État de l’étiquette.
État de l’entrepôt
 shipment.warehouse_state string

État de l’entrepôt.
Suivis
 shipment.trackings array of object
Numéro de suivi
 shipment.trackings.tracking_number string

Numéro de suivi.
Numéro de suivi local
 shipment.trackings.local_tracking_number string

Numéro de suivi local.
Autre numéro de suivi
 shipment.trackings.alternate_tracking_number string

Numéro de suivi de remplacement.
Numéro de la jambe
 shipment.trackings.leg_number integer

Numéro de jambe.
Handler
 shipment.trackings.handler string

Gestionnaire.
État de suivi
 shipment.trackings.tracking_state string

État de suivi.
URL de la page de suivi
 shipment.tracking_page_url string

URL de la page de suivi.
Documents d’expédition
 shipment.shipping_documents array of object
Catégorie
 shipment.shipping_documents.category string

Catégorie.
Obligatoire
 shipment.shipping_documents.required boolean

Indique si nécessaire.
Taille de page
 shipment.shipping_documents.page_size string

Taille de la page.
Format
 shipment.shipping_documents.format string

Format.
Chaînes encodées en base64
 shipment.shipping_documents.base64_encoded_strings array of string

Chaînes encodées en Base64.
URL
 shipment.shipping_documents.url string

Adresse URL.
Monnaie
 shipment.currency string

La devise.
ID
 shipment.selected_courier.id string

Identificateur unique.
Tarifs
 shipment.rates array of object
ID de courrier
 shipment.rates.courier_id string

Identificateur de courrier.
Nom du courrier
 shipment.rates.courier_name string

Nom du courrier.
Durée de livraison minimale
 shipment.rates.min_delivery_time integer

Délai de livraison minimal.
Durée de livraison maximale
 shipment.rates.max_delivery_time integer

Délai de livraison maximal.
Classement de valeur pour l’argent
 shipment.rates.value_for_money_rank integer

Valeur du classement de l’argent.
Classement de l’heure de remise
 shipment.rates.delivery_time_rank integer

Classement du délai de livraison.
Frais d’expédition
 shipment.rates.shipment_charge float

Frais d’expédition.
Surcharge de carburant
 shipment.rates.fuel_surcharge float

Le supplément de carburant.
Surcharge de zone distante
 shipment.rates.remote_area_surcharge integer

Surcharge de la zone distante.
Surcharge surdimensionnée
 shipment.rates.oversized_surcharge integer

Surcharge surdimensionnée.
Surcharge supplémentaire sur les services
 shipment.rates.additional_services_surcharge integer

Frais supplémentaires sur les services.
Frais complets résidentiels
 shipment.rates.residential_full_fee integer

Les frais d’habitation complets.
Frais d’escompte résidentiels
 shipment.rates.residential_discounted_fee integer

Les frais d’habitation réduits.
Total des frais d’expédition
 shipment.rates.shipment_charge_total float

Total des frais d’expédition.
Frais de gestion des entrepôts
 shipment.rates.warehouse_handling_fee integer

Frais de gestion de l’entrepôt.
Frais d’assurance
 shipment.rates.insurance_fee integer

Les frais d’assurance.
Taxe de vente
 shipment.rates.sales_tax integer

Taxe de vente.
Taxe de vente provinciale
 shipment.rates.provincial_sales_tax integer

Taxe de vente provinciale.
Frais de gestion DDP
 shipment.rates.ddp_handling_fee integer

Frais de traitement du DDP.
Frais fiscaux d’importation
 shipment.rates.import_tax_charge integer

Modification de la taxe d’importation.
Frais d’importation
 shipment.rates.import_duty_charge integer

Frais d’importation.
Total Des frais
 shipment.rates.total_charge float

Frais totaux.
Est au-dessus du seuil
 shipment.rates.is_above_threshold boolean

Indique s’il est au-dessus du seuil.
Incoterms
 shipment.rates.incoterms string

Les incoterms.
Taxe d’importation estimée
 shipment.rates.estimated_import_tax integer

Taxe d’importation estimée.
Estimation des droits d’importation
 shipment.rates.estimated_import_duty integer

Droits d’importation estimés.
Options de remise disponibles
 shipment.rates.available_handover_options string

Options de remise disponibles.
Évaluation du suivi
 shipment.rates.tracking_rating integer

Évaluation du suivi.
Easyship Rating
 shipment.rates.easyship_rating integer

La cote Easyship.
Remarques de courrier
 shipment.rates.courier_remarks string

Le courrier remarque.
Destinataire du paiement
 shipment.rates.payment_recipient string

Destinataire du paiement.
Code
 shipment.rates.discount.code string

Code.
Montant
 shipment.rates.discount.amount integer

Montant.
Expire à
 shipment.rates.discount.expires_at string

Expire à.
Pourcentage
 shipment.rates.discount.percentage string

Pourcentage.
Incoterms effectifs
 shipment.rates.effective_incoterms string

L’incoterms efficace.

Demander un enlèvement (V1)

ID d’opération :
RequestAPickup

Lorsqu’un enlèvement est créé, une demande de collecte est effectuée directement vers le courrier, qui renvoie un numéro de référence. Le numéro de référence peut être utilisé lors du contact avec le service client du courrier. Un emplacement de prise en charge doit être choisi ; Les emplacements de prise en charge à venir peuvent être trouvés à l’aide de l’action « Obtenir les emplacements de prise disponibles ».

Paramètres

Nom Clé Obligatoire Type Description
ID de courrier
 courier_id string

Identificateur de courrier.
Date par défaut
 preferred_date string

Date par défaut.
Durée maximale préférée
 preferred_max_time string

Durée maximale recommandée.
Durée minimale préférée
 preferred_min_time string

Durée minimale recommandée.
ID d’expédition easyship
 easyship_shipment_ids array of string

Les identifers easyship.

Retours

Nom Chemin d’accès Type Description
ID de courrier
 courier_id string

Identificateur de courrier.
Nom du courrier
 courier_name string

Nom du courrier.
ID d’expédition easyship
 easyship_shipment_ids array of string

Identificateurs d’expédition Easyship.
ID d’enlèvement Easyship
 pickup.easyship_pickup_id string

Identificateur de enlèvement Easyship.
Durée minimale préférée
 pickup.preferred_min_time string

Durée minimale recommandée.
Durée maximale préférée
 pickup.preferred_max_time string

Durée maximale recommandée.
Numéro de référence de prise en charge
 pickup.pickup_reference_number string

Numéro de référence de prise en charge.
Frais de prise en charge
 pickup.pickup_fee string

Les frais de prise en charge.
Nom du fournisseur
 pickup.provider_name string

Nom du fournisseur.
Téléphone du service clientèle du fournisseur
 pickup.provider_customer_service_phone string

Numéro de téléphone du service clientèle du fournisseur.
Nombre d’expéditions
 pickup.shipments_count string

Le nombre d’expéditions.
Poids réel total
 pickup.total_actual_weight string

Poids réel total.
État de l’enlèvement
 pickup.pickup_state string

État de l’enlèvement.
Adresse
 pickup.address.line_1 string

Adresse.
Ligne d’adresse 2
 pickup.address.line_2 string

Ligne d’adresse 2.
Ligne d’adresse 3
 pickup.address.line_3 string

Ligne d’adresse 3.
Code postal
 pickup.address.postal_code string

Code postal.
Ville
 pickup.address.city string

Ville.
État
 pickup.address.state string

État.
Pays
 pickup.address.country string

Le pays.
E-mail de contact
 pickup.address.contact_email string

Adresse e-mail du contact.
Numéro de téléphone du contact
 pickup.address.contact_phone string

Numéro de téléphone du contact.
Nom de l’entreprise
 pickup.address.company_name string

Nom de la société.
Nom du contact
 pickup.address.contact_name string

Nom du contact.

Mettre à jour l’état de l’entrepôt

ID d’opération :
UpdateWarehouseState

Mettez à jour l’état de l’entrepôt d’une expédition. Disponible uniquement pour les expéditions remplies à l’un des entrepôts intégrés Easyship.

Paramètres

Nom Clé Obligatoire Type Description
ID d’expédition easyship
 easyship_shipment_id string

Identificateur unique de l’expédition Easyship.
État de l’entrepôt
 warehouse_state string

État de l’entrepôt.
Message
 message string

Message.
Numéro de série
 serial_number string

Numéro de série.

Retours

Nom Chemin d’accès Type Description
Message
 message array of object
ID d’expédition easyship
 message.easyship_shipment_id string

Identificateur unique de l’expédition Easyship.
État de l’entrepôt mis à jour
 message.warehouse_state_updated string

État de l’entrepôt mis à jour.

Mettre à jour une expédition

ID d’opération :
UpdateAShipment

Mettez à jour les détails d’une expédition.

Paramètres

Nom Clé Obligatoire Type Description
ID d’expédition easyship
 easyship_shipment_id True string

Identificateur d’expédition Easyship.
Code du pays de destination
 destination_country_alpha2 string

Code du pays de destination.
Destination City
 destination_city string

Ville de destination.
Nom de destination
 destination_name string

Nom de destination.
Adresse de destination
 destination_address_line_1 string

Adresse de destination.
Numéro de téléphone de destination
 destination_phone_number string

Numéro de téléphone de destination.
Descriptif
 description string

Description.
Poids réel
 actual_weight float

Poids réel.
Hauteur
 height integer

Hauteur.
Largeur
 width integer

Largeur.
Length
 length integer

Longueur.
Catégorie
 category string

Catégorie.
Devise déclarée
 declared_currency string

Devise déclarée.
Valeur douanière déclarée
 declared_customs_value integer

Valeur douanière déclarée.
Référence (SKU)
 sku string

Référence SKU.
Nom de la plateforme
 platform_name string

Nom de la plateforme.
Numéro d’ordre de plateforme
 platform_order_number string

Numéro de commande de la plateforme.
Taxes payées par
 taxes_duties_paid_by string

Les taxes et les droits payés par.
Est assuré
 is_insured boolean

S’il est assuré.
ID de courrier sélectionné
 selected_courier_id string

Identificateur de courrier sélectionné.
Destination Postal Code
 destination_postal_code integer

Code postal de destination.
État de destination
 destination_state string

État de destination.
Ligne d’adresse de destination 2
 destination_address_line_2 string

Ligne d’adresse de destination 2.
Adresse e-mail de destination
 destination_email_address string

Adresse e-mail de destination.

Retours

Nom Chemin d’accès Type Description
Créé à
 shipment.created_at string

Créé à.
Mise à jour à
 shipment.updated_at string

Lorsqu’il est mis à jour à l’adresse.
ID d’expédition easyship
 shipment.easyship_shipment_id string

Identificateur d’expédition Easyship.
Nom de destination
 shipment.destination_name string

Nom de destination.
Adresse de destination
 shipment.destination_address_line_1 string

Adresse de destination.
Ligne d’adresse de destination 2
 shipment.destination_address_line_2 string

Ligne d’adresse de destination 2.
Destination City
 shipment.destination_city string

Ville de destination.
État de destination
 shipment.destination_state string

État de destination.
Destination Postal Code
 shipment.destination_postal_code string

Code postal de destination.
Numéro de téléphone de destination
 shipment.destination_phone_number string

Numéro de téléphone de destination.
Adresse e-mail de destination
 shipment.destination_email_address string

Adresse e-mail de destination.
Nom de la plateforme
 shipment.platform_name string

Nom de la plateforme.
Numéro d’ordre de plateforme
 shipment.platform_order_number string

Numéro de commande de la plateforme.
Valeur douanière totale
 shipment.total_customs_value float

Valeur douanière totale.
Poids réel total
 shipment.total_actual_weight float

Poids réel total.
Poids total dimensionnel
 shipment.total_dimensional_weight float

Poids total de la dimension.
Poids volume total
 shipment.total_volumetric_weight float

Poids volumétrique total.
Est assuré
 shipment.is_insured boolean

S’il est assuré.
Monnaie
 shipment.currency string

La devise.
Nom
 shipment.origin_country.name string

Nom.
Code pays
 shipment.origin_country.alpha2 string

Code du pays.
Nom
 shipment.destination_country.name string

Nom.
Code pays
 shipment.destination_country.alpha2 string

Code du pays.
Objets
 shipment.items array of object
ID
 shipment.items.id string

Identificateur unique.
Descriptif
 shipment.items.description string

Description.
Référence (SKU)
 shipment.items.sku string

Référence SKU.
Largeur
 shipment.items.width integer

Largeur.
Length
 shipment.items.length integer

Longueur.
Hauteur
 shipment.items.height integer

Hauteur.
Poids réel
 shipment.items.actual_weight float

Poids réel.
Poids dimensionnel
 shipment.items.dimensional_weight float

Poids dimensionnel.
Poids volumétrique
 shipment.items.volumetric_weight float

Poids columétrique.
Valeur douanière déclarée
 shipment.items.declared_customs_value integer

Valeur douanière déclarée.
Devise déclarée
 shipment.items.declared_currency string

Devise déclarée.
Valeur douanière d’origine
 shipment.items.origin_customs_value float

Valeur douanière d’origine.
Devise d’origine
 shipment.items.origin_currency string

Devise d’origine.
Catégorie
 shipment.items.category string

Catégorie.
Nom
 shipment.box.name string

Nom.
Length
 shipment.box.length integer

Longueur.
Largeur
 shipment.box.width integer

Largeur.
Hauteur
 shipment.box.height integer

Hauteur.
ID
 shipment.selected_courier.id string

Identificateur unique.
Nom
 shipment.selected_courier.name string

Nom.
Durée de livraison minimale
 shipment.selected_courier.min_delivery_time integer

Délai de livraison minimal.
Durée de livraison maximale
 shipment.selected_courier.max_delivery_time integer

Délai de livraison maximal.
Frais d’expédition
 shipment.selected_courier.shipment_charge float

Frais d’expédition.
Surcharge de carburant
 shipment.selected_courier.fuel_surcharge float

Le supplément de carburant.
Surcharge de zone distante
 shipment.selected_courier.remote_area_surcharge integer

Surcharge de la zone distante.
Total des frais d’expédition
 shipment.selected_courier.shipment_charge_total float

Total des frais d’expédition.
Frais de gestion des entrepôts
 shipment.selected_courier.warehouse_handling_fee integer

Frais de gestion de l’entrepôt.
Frais d’assurance
 shipment.selected_courier.insurance_fee integer

Les frais d’assurance.
Frais fiscaux d’importation
 shipment.selected_courier.import_tax_charge integer

Frais fiscaux d’importation.
Frais d’importation
 shipment.selected_courier.import_duty_charge integer

Frais d’importation.
Frais de gestion DDP
 shipment.selected_courier.ddp_handling_fee integer

Frais de traitement du DDP.
Total Des frais
 shipment.selected_courier.total_charge float

Frais totaux.
Est au-dessus du seuil
 shipment.selected_courier.is_above_threshold boolean

Indique s’il est au-dessus du seuil.
Incoterms effectifs
 shipment.selected_courier.effective_incoterms string

L’incoterms efficace.
Taxe d’importation estimée
 shipment.selected_courier.estimated_import_tax integer

Estimation de la taxe d’importation.
Estimation des droits d’importation
 shipment.selected_courier.estimated_import_duty integer

Droits d’importation estimés.
Courier effectue un enlèvement
 shipment.selected_courier.courier_does_pickup boolean

Indique si le courrier effectue un enlèvement.
URL de dépôt de courrier
 shipment.selected_courier.courier_dropoff_url string

Adresse URL de dépôt du courrier.
Remarques de courrier
 shipment.selected_courier.courier_remarks string

Le courrier remarque.
Destinataire du paiement
 shipment.selected_courier.payment_recipient string

Destinataire du paiement.
Tarifs
 shipment.rates array of object
ID de courrier
 shipment.rates.courier_id string

Identificateur de courrier.
Nom du courrier
 shipment.rates.courier_name string

Nom du courrier.
Durée de livraison minimale
 shipment.rates.min_delivery_time integer

Délai de livraison minimal.
Durée de livraison maximale
 shipment.rates.max_delivery_time integer

Délai de livraison maximal.
Classement de valeur pour l’argent
 shipment.rates.value_for_money_rank integer

Valeur du classement de l’argent.
Classement de l’heure de remise
 shipment.rates.delivery_time_rank integer

Classement du délai de livraison.
Frais d’expédition
 shipment.rates.shipment_charge float

Frais d’expédition.
Surcharge de carburant
 shipment.rates.fuel_surcharge float

Le supplément de carburant.
Surcharge de zone distante
 shipment.rates.remote_area_surcharge integer

Surcharge de la zone distante.
Total des frais d’expédition
 shipment.rates.shipment_charge_total float

Total des frais d’expédition.
Frais de gestion des entrepôts
 shipment.rates.warehouse_handling_fee integer

Frais de gestion de l’entrepôt.
Frais d’assurance
 shipment.rates.insurance_fee integer

Les frais d’assurance.
Frais de gestion DDP
 shipment.rates.ddp_handling_fee integer

Frais de traitement du DDP.
Frais fiscaux d’importation
 shipment.rates.import_tax_charge integer

Modification de la taxe d’importation.
Frais d’importation
 shipment.rates.import_duty_charge integer

Frais d’importation.
Total Des frais
 shipment.rates.total_charge float

Frais totaux.
Est au-dessus du seuil
 shipment.rates.is_above_threshold boolean

Indique s’il est au-dessus du seuil.
Incoterms effectifs
 shipment.rates.effective_incoterms string

L’incoterms efficace.
Taxe d’importation estimée
 shipment.rates.estimated_import_tax integer

Taxe d’importation estimée.
Estimation des droits d’importation
 shipment.rates.estimated_import_duty integer

Droits d’importation estimés.
Courier effectue un enlèvement
 shipment.rates.courier_does_pickup boolean

Indique si le courrier effectue un enlèvement.
URL de dépôt de courrier
 shipment.rates.courier_dropoff_url string

Adresse URL de dépôt du courrier.
Évaluation du suivi
 shipment.rates.tracking_rating integer

Évaluation du suivi.
Easyship Rating
 shipment.rates.easyship_rating float

La cote Easyship.
Remarques de courrier
 shipment.rates.courier_remarks string

Le courrier remarque.
Destinataire du paiement
 shipment.rates.payment_recipient string

Destinataire du paiement.

Obtenir des points de contrôle

ID d’opération :
GetCheckpoints

Récupère les détails des points de contrôle d’expédition.

Paramètres

Nom Clé Obligatoire Type Description
ID d’expédition easyship
 easyship_shipment_id True string

Identificateur unique de l’expédition Easyship.
Numéro d’ordre de plateforme
 platform_order_number string

Numéro de commande de la plateforme.
Page
 page integer

La page.
Par page
 per_page integer

Nombre par page.

Retours

Nom Chemin d’accès Type Description
Total Page
 total_page integer

Page totale.
Page active
 current_page integer

Page active.
Expéditions
 shipments array of object
ID d’expédition easyship
 shipments.easyship_shipment_id string

Identificateur unique de l’expédition Easyship.
Numéro d’ordre de plateforme
 shipments.platform_order_number string

Numéro de commande de la plateforme.
Origin
 shipments.origin string

Origine.
Destination
 shipments.destination string

Destination.
Statut
 shipments.status string

État.
Numéro de suivi
 shipments.tracking_number string

Numéro de suivi.
URL de la page de suivi
 shipments.tracking_page_url string

Adresse URL de la page de suivi.
Points de contrôle
 shipments.checkpoints array of object
Numéro de commande
 shipments.checkpoints.order_number integer

Numéro de commande.
Handler
 shipments.checkpoints.handler string

Gestionnaire.
Message
 shipments.checkpoints.message string

Message.
Emplacement
 shipments.checkpoints.location string

Emplacement.
Ville
 shipments.checkpoints.city string

Ville.
Pays
 shipments.checkpoints.country_name string

Le pays.
Code pays
 shipments.checkpoints.country_iso3 string

Code du pays.
Coordonnées
 shipments.checkpoints.coordinates array of

Coordonnées.
État
 shipments.checkpoints.state string

État.
Code postal
 shipments.checkpoints.postal_code string

Code postal.
Heure du point de contrôle
 shipments.checkpoints.checkpoint_time string

Heure du point de contrôle.
État principal
 shipments.checkpoints.primary_status string

État principal.

Obtenir la catégories de l’élément

ID d’opération :
GetItemCategories

Récupère une liste de catégories d’expéditions et de la slug pour utiliser la catégorie.

Retours

Nom Chemin d’accès Type Description
Catégories
 categories array of object
Nom
 categories.name string

Nom.
Slug
 categories.slug string

La.

Obtenir les emplacements de prise en charge disponibles (V1)

ID d’opération :
GetAvailablePickupSlots

Les emplacements de prise en charge disponibles seront calculés pour un courrier spécifique, dans l’heure locale et pour les 7 prochains jours. Un enlèvement peut ensuite être demandé à l’aide de l’action « Demande d’enlèvement ».

Paramètres

Nom Clé Obligatoire Type Description
ID de courrier
 courier_id True string

Identificateur de courrier.

Retours

Nom Chemin d’accès Type Description
ID de courrier
 courier_id string

Identificateur de courrier.
Nom du courrier
 courier_name string

Nom du courrier.
Message
 message string

Message.
Nom du fournisseur
 pickup.provider_name string

Nom du fournisseur.
Téléphone du service clientèle du fournisseur
 pickup.provider_customer_service_phone string

Numéro de téléphone du service clientèle du fournisseur.

Obtenir les tarifs et les taxes

ID d’opération :
GetRatesTaxes

Récupérez une liste de devis d’expédition pour une expédition potentielle.

Paramètres

Nom Clé Obligatoire Type Description
Adresse
 line_1 string

Adresse.
Ligne d’adresse 2
 line_2 string

Ligne d’adresse 2.
État
 state string

État.
Ville
 city string

Ville.
Code postal
 postal_code string

Code postal.
Code pays
 country_alpha2 string

Code du pays.
Adresse
 line_1 string

Adresse.
Ligne d’adresse 2
 line_2 string

Ligne d’adresse 2.
État
 state string

État.
Ville
 city string

Ville.
Code postal
 postal_code string

Code postal.
Code pays
 country_alpha2 string

Code du pays.
Incoterms
 incoterms string

Les incoterms.
Est assuré
 is_insured boolean

S’il est assuré.
Montant assuré
 insured_amount integer

Montant assuré.
Devise assurée
 insured_currency string

Devise assurée.
Appliquer des règles d’expédition
 apply_shipping_rules boolean

Indique si les règles d’expédition ont été appliquées.
Weight
 weight string

Le poids.
Taille
 dimensions string

Dimensions.
Devise de sortie
 output_currency string

Devise de sortie.
Poids réel total
 total_actual_weight float

Poids réel total.
Slug
 slug string

La référence s’est inclinée.
Length
 length integer

Longueur.
Largeur
 width integer

Largeur.
Hauteur
 height integer

Hauteur.
Descriptif
 description string

Description.
Catégorie
 category string

Catégorie.
Référence (SKU)
 sku string

Référence SKU.
Quantité
 quantity integer

Quantité.
Length
 length string

Longueur.
Largeur
 width string

Largeur.
Hauteur
 height string

Hauteur.
Poids réel
 actual_weight integer

Poids réel.
Devise déclarée
 declared_currency string

Devise déclarée.
Valeur douanière déclarée
 declared_customs_value integer

Valeur douanière déclarée.

Retours

Nom Chemin d’accès Type Description
Tarifs
 rates array of object
ID de courrier
 rates.courier_id string

Identificateur unique de courrier.
Nom du courrier
 rates.courier_name string

Nom du courrier.
Durée de livraison minimale
 rates.min_delivery_time integer

Délai de livraison minimal.
Durée de livraison maximale
 rates.max_delivery_time integer

Délai de livraison maximal.
Classement de valeur pour l’argent
 rates.value_for_money_rank integer

Valeur du classement de l’argent.
Classement de l’heure de remise
 rates.delivery_time_rank integer

Classement du délai de livraison.
Frais d’expédition
 rates.shipment_charge float

Frais d’expédition.
Surcharge de carburant
 rates.fuel_surcharge float

Le supplément de carburant.
Surcharge de zone distante
 rates.remote_area_surcharge integer

Surcharge de la zone distante.
Total des frais d’expédition
 rates.shipment_charge_total float

Total des frais d’expédition.
Frais de gestion des entrepôts
 rates.warehouse_handling_fee integer

Frais de gestion de l’entrepôt.
Frais d’assurance
 rates.insurance_fee integer

Les frais d’assurance.
Frais de gestion DDP
 rates.ddp_handling_fee integer

Frais de gestion du DDP si incoterm est DDP.
Frais fiscaux d’importation
 rates.import_tax_charge integer

Frais fiscaux d’importation.
Frais d’importation
 rates.import_duty_charge integer

Frais d’importation.
Total Des frais
 rates.total_charge float

Frais totaux.
Est au-dessus du seuil
 rates.is_above_threshold boolean

Indique s’il est au-dessus du seuil.
Incoterms effectifs
 rates.effective_incoterms string

L’incoterms efficace.
Taxe d’importation estimée
 rates.estimated_import_tax integer

Taxe d’importation estimée.
Estimation des droits d’importation
 rates.estimated_import_duty integer

Droits d’importation estimés.
Courier effectue un enlèvement
 rates.courier_does_pickup boolean

Indique si le courrier effectue un enlèvement.
URL de dépôt de courrier
 rates.courier_dropoff_url string

Adresse URL de dépôt du courrier.
Évaluation du suivi
 rates.tracking_rating integer

Évaluation du suivi.
Destinataire du paiement
 rates.payment_recipient string

Destinataire du paiement.
Remarques de courrier
 rates.courier_remarks string

Le courrier remarque.
Monnaie
 rates.currency string

La devise.
Nom
 rates.box.name string

Nom.
Length
 rates.box.length integer

Longueur.
Largeur
 rates.box.width integer

Largeur.
Hauteur
 rates.box.height integer

Hauteur.
Frais d’enlèvement minimum
 rates.minimum_pickup_fee integer

Les frais minimum de prise en charge.
Descriptif
 rates.title string

Description.
Description complète
 rates.full_description string

Description complète.

Obtenir l’état du suivi

ID d’opération :
GetStatus

Récupère l’état de suivi d’une expédition.

Paramètres

Nom Clé Obligatoire Type Description
ID d’expédition easyship
 easyship_shipment_id True string

Identificateurs d’expédition Easyship.
Numéro d’ordre de plateforme
 platform_order_number string

Numéro de commande de la plateforme.
Page
 page integer

La page.
Par page
 per_page integer

Nombre par page.

Retours

Nom Chemin d’accès Type Description
Total Page
 total_page integer

Page totale.
Page active
 current_page integer

Page active.
Expéditions
 shipments array of object
ID d’expédition easyship
 shipments.easyship_shipment_id string

Identificateur unique de l’expédition Easyship.
Numéro d’ordre de plateforme
 shipments.platform_order_number string

Numéro de commande de la plateforme.
Origin
 shipments.origin string

Origine.
Destination
 shipments.destination string

Destination.
Statut
 shipments.status string

État.
Numéro de suivi
 shipments.tracking_number string

Numéro de suivi.
URL de la page de suivi
 shipments.tracking_page_url string

Adresse URL de la page de suivi.

Obtenir une expédition

ID d’opération :
GetAShipment

Obtenez les détails d’une expédition.

Paramètres

Nom Clé Obligatoire Type Description
ID d’expédition easyship
 easyship_shipment_id True string

Identificateur d’expédition Easyship.
Format
 format string

Format.
Étiquette
 label string

Étiquette.
Facture commerciale
 commercial_invoice string

Facture commerciale.
Bon de livraison
 packing_slip string

Le glissement d’emballage.

Retours

Nom Chemin d’accès Type Description
Créé à
 created_at string

Quand il est créé à l’adresse.
Mise à jour à
 updated_at string

Lors de la mise à jour à l’adresse.
ID d’expédition easyship
 easyship_shipment_id string

Retrait de l’expédition Easyship.
Nom de destination
 destination_name string

Nom de destination.
Adresse de destination
 destination_address_line_1 string

Adresse de destination.
Ligne d’adresse de destination 2
 destination_address_line_2 string

Ligne d’adresse de destination 2.
Destination City
 destination_city string

Ville de destination.
État de destination
 destination_state string

État de destination.
Destination Postal Code
 destination_postal_code string

Code postal de destination.
Numéro de téléphone de destination
 destination_phone_number string

Numéro de téléphone de destination.
Adresse e-mail de destination
 destination_email_address string

Adresse e-mail de destination.
Notes de commande
 order_notes string

Notes de commande.
Ordre créé à l’adresse
 order_created_at string

Ordre créé à l’adresse.
Nom de la plateforme
 platform_name string

Nom de la plateforme.
Numéro d’ordre de plateforme
 platform_order_number string

Numéro de commande de la plateforme.
Valeur douanière totale
 total_customs_value float

Valeur douanière totale.
Poids réel total
 total_actual_weight float

Poids réel total.
Poids total dimensionnel
 total_dimensional_weight float

Poids total de la dimension.
Poids volume total
 total_volumetric_weight float

Poids volumétrique total.
Est assuré
 is_insured boolean

S’il est assuré.
Monnaie
 currency string

La devise.
État de l’entrepôt
 warehouse_state string

État de l’entrepôt.
Nom
 origin_country.name string

Nom.
Code pays
 origin_country.alpha2 string

Code du pays.
Nom
 destination_country.name string

Nom.
Code pays
 destination_country.alpha2 string

Code du pays.
Objets
 items array of object
ID
 items.id string

Identificateur unique.
Descriptif
 items.title string

Description.
Référence (SKU)
 items.sku string

Référence SKU.
Largeur
 items.width integer

Largeur.
Length
 items.length integer

Longueur.
Hauteur
 items.height integer

Hauteur.
Poids réel
 items.actual_weight float

Poids réel.
Poids dimensionnel
 items.dimensional_weight float

Poids dimensionnel.
Poids volumétrique
 items.volumetric_weight float

Poids volumétrique.
Valeur douanière déclarée
 items.declared_customs_value integer

Valeur douanière déclarée.
Devise déclarée
 items.declared_currency string

Devise déclarée.
Valeur douanière d’origine
 items.origin_customs_value float

Valeur douanière d’origine.
Devise d’origine
 items.origin_currency string

Devise d’origine.
Catégorie
 items.category string

Catégorie.
Nom
 box.name string

Nom.
Length
 box.length integer

Longueur.
Largeur
 box.width integer

Largeur.
Hauteur
 box.height integer

Hauteur.
ID
 selected_courier.id string

Identificateur unique.
Nom
 selected_courier.name string

Nom.
Durée de livraison minimale
 selected_courier.min_delivery_time integer

Délai de livraison minimal.
Durée de livraison maximale
 selected_courier.max_delivery_time integer

Délai de livraison maximal.
Frais d’expédition
 selected_courier.shipment_charge float

Frais d’expédition.
Surcharge de carburant
 selected_courier.fuel_surcharge float

Le supplément de carburant.
Surcharge de zone distante
 selected_courier.remote_area_surcharge integer

Surcharge de la zone distante.
Total des frais d’expédition
 selected_courier.shipment_charge_total float

Total des frais d’expédition.
Frais de gestion des entrepôts
 selected_courier.warehouse_handling_fee integer

Frais de gestion de l’entrepôt.
Frais d’assurance
 selected_courier.insurance_fee integer

Les frais d’assurance.
Frais fiscaux d’importation
 selected_courier.import_tax_charge integer

Frais fiscaux d’importation.
Frais d’importation
 selected_courier.import_duty_charge integer

Frais d’importation.
Frais de gestion DDP
 selected_courier.ddp_handling_fee integer

Frais de traitement du DDP.
Total Des frais
 selected_courier.total_charge float

Frais totaux.
Est au-dessus du seuil
 selected_courier.is_above_threshold boolean

Indique s’il est au-dessus du seuil.
Incoterms effectifs
 selected_courier.effective_incoterms string

L’incoterms efficace.
Taxe d’importation estimée
 selected_courier.estimated_import_tax integer

Taxe d’importation estimée.
Estimation des droits d’importation
 selected_courier.estimated_import_duty integer

Droits d’importation estimés.
Courier effectue un enlèvement
 selected_courier.courier_does_pickup boolean

Indique si le courrier effectue un enlèvement.
URL de dépôt de courrier
 selected_courier.courier_dropoff_url string

Adresse URL de dépôt du courrier.
Remarques de courrier
 selected_courier.courier_remarks string

Le courrier remarque.
Destinataire du paiement
 selected_courier.payment_recipient string

Destinataire du paiement.
Obligatoire
 shipping_documents.label.required boolean

Indique si nécessaire.
Taille de page
 shipping_documents.label.page_size string

Taille de la page.
Format
 shipping_documents.label.format string

Format.
Chaînes encodées en base64
 shipping_documents.label.base64_encoded_strings array of string

Chaînes encodées en Base64.
URL
 shipping_documents.label.url string

Adresse URL.
Message
 shipping_documents.label.message string

Message.
Obligatoire
 shipping_documents.commercial_invoice.required boolean

Indique si nécessaire.
Taille de page
 shipping_documents.commercial_invoice.page_size string

Taille de la page.
Format
 shipping_documents.commercial_invoice.format string

Format.
Chaînes encodées en base64
 shipping_documents.commercial_invoice.base64_encoded_strings array of

Chaînes encodées en Base64.
URL
 shipping_documents.commercial_invoice.url string

Adresse URL.
Obligatoire
 shipping_documents.packing_slip.required boolean

Indique si nécessaire.
Taille de page
 shipping_documents.packing_slip.page_size string

Taille de la page.
Format
 shipping_documents.packing_slip.format string

Format.
Chaînes encodées en base64
 shipping_documents.packing_slip.base64_encoded_strings array of string

Chaînes encodées en Base64.
URL
 shipping_documents.packing_slip.url string

Adresse URL.
Obligatoire
 shipping_documents.battery_form.required boolean

Indique si nécessaire.
Taille de page
 shipping_documents.battery_form.page_size string

Taille de la page.
Format
 shipping_documents.battery_form.format string

Format.
Chaînes encodées en base64
 shipping_documents.battery_form.base64_encoded_strings array of

Chaînes encodées en Base64.
URL
 shipping_documents.battery_form.url string

Adresse URL.
Obligatoire
 shipping_documents.battery_caution_label.required boolean

Indique si nécessaire.
Taille de page
 shipping_documents.battery_caution_label.page_size string

Taille de la page.
Format
 shipping_documents.battery_caution_label.format string

Format.
Chaînes encodées en base64
 shipping_documents.battery_caution_label.base64_encoded_strings array of

Chaînes encodées en Base64.
URL
 shipping_documents.battery_caution_label.url string

Adresse URL.

Répertorier toutes les expéditions

ID d’opération :
ListAllShipments

Récupère une liste de toutes les expéditions.

Paramètres

Nom Clé Obligatoire Type Description
ID d’expédition easyship
 easyship_shipment_id string

Identificateur unique de l’expédition Easyship.
Numéro d’ordre de plateforme
 platform_order_number string

Numéro de commande de la plateforme.
Page
 page integer

La page.
Par page
 per_page integer

Nombre par page.
Créé à partir de
 created_at_from string

Créé à partir de.
Créé à
 created_at_to string

Créé à.
Confirmé à partir de
 confirmed_at_from string

Confirmé à partir de.
Confirmé à
 confirm_at_to string

Confirmé à.
Générer une étiquette à partir de
 label_generated_at_from string

Étiquette générée à partir de.
Étiquette générée à to
 label_generated_at_to string

Étiquette générée à.
État de l’expédition
 shipment_state string

État de l’expédition.
État de l’enlèvement
 pickup_state string

État de l’enlèvement.
État de remise
 delivery_state string

État de remise.
État de l’étiquette
 label_state string

État de l’étiquette.
État de l’entrepôt
 warehouse_state string

État de l’entrepôt.

Retours

Nom Chemin d’accès Type Description
Expéditions
 shipments array of object
ID d’expédition easyship
 shipments.easyship_shipment_id string

Identificateur unique de l’expédition Easyship.
Créé à
 shipments.created_at string

Créé à.
Mise à jour à
 shipments.updated_at string

Mise à jour à l’adresse.
Étiquette payée à
 shipments.label_paid_at string

Étiquette payée.
Étiquette générée à
 shipments.label_generated_at string

Généré à.
Ordre créé à l’adresse
 shipments.order_created_at string

Ordre créé à l’adresse.
Adresse
 shipments.origin_address.line_1 string

Adresse.
Ligne d’adresse 2
 shipments.origin_address.line_2 string

Ligne d’adresse 2.
État
 shipments.origin_address.state string

État.
Ville
 shipments.origin_address.city string

Ville.
Code postal
 shipments.origin_address.postal_code string

Code postal.
Code pays
 shipments.origin_address.country_alpha2 string

Code du pays.
Nom du contact
 shipments.origin_address.contact_name string

Nom du contact.
Nom de l’entreprise
 shipments.origin_address.company_name string

Nom de la société.
Numéro de téléphone du contact
 shipments.origin_address.contact_phone string

Numéro de téléphone du contact.
E-mail de contact
 shipments.origin_address.contact_email string

Adresse e-mail du contact.
Adresse
 shipments.sender_address.line_1 string

Adresse.
Ligne d’adresse 2
 shipments.sender_address.line_2 string

Ligne d’adresse 2.
État
 shipments.sender_address.state string

État.
Ville
 shipments.sender_address.city string

Ville.
Code postal
 shipments.sender_address.postal_code string

Code postal.
Code pays
 shipments.sender_address.country_alpha2 string

Code du pays.
Nom du contact
 shipments.sender_address.contact_name string

Nom du contact.
Nom de l’entreprise
 shipments.sender_address.company_name string

Nom de la société.
Numéro de téléphone du contact
 shipments.sender_address.contact_phone string

Numéro de téléphone du contact.
E-mail de contact
 shipments.sender_address.contact_email string

Adresse e-mail du contact.
Adresse
 shipments.return_address.line_1 string

Adresse.
Ligne d’adresse 2
 shipments.return_address.line_2 string

Ligne d’adresse 2.
État
 shipments.return_address.state string

État.
Ville
 shipments.return_address.city string

Ville.
Code postal
 shipments.return_address.postal_code string

Code postal.
Code pays
 shipments.return_address.country_alpha2 string

Code du pays.
Nom du contact
 shipments.return_address.contact_name string

Nom du contact.
Nom de l’entreprise
 shipments.return_address.company_name string

Nom de la société.
Numéro de téléphone du contact
 shipments.return_address.contact_phone string

Numéro de téléphone du contact.
E-mail de contact
 shipments.return_address.contact_email string

Adresse e-mail du contact.
Adresse
 shipments.destination_address.line_1 string

Adresse.
Ligne d’adresse 2
 shipments.destination_address.line_2 string

Ligne d’adresse 2.
État
 shipments.destination_address.state string

État.
Ville
 shipments.destination_address.city string

Ville.
Code postal
 shipments.destination_address.postal_code string

Code postal.
Code pays
 shipments.destination_address.country_alpha2 string

Code du pays.
Nom du contact
 shipments.destination_address.contact_name string

Nom du contact.
Nom de l’entreprise
 shipments.destination_address.company_name string

Nom de la société.
Numéro de téléphone du contact
 shipments.destination_address.contact_phone string

Numéro de téléphone du contact.
E-mail de contact
 shipments.destination_address.contact_email string

Adresse e-mail du contact.
Nom de la plateforme
 shipments.order_data.platform_name string

Nom de la plateforme.
Numéro d’ordre de plateforme
 shipments.order_data.platform_order_number string

Numéro de commande de la plateforme.
Liste des étiquettes de commande
 shipments.order_data.order_tag_list array of string

Liste des étiquettes de commande
Notes du vendeur
 shipments.order_data.seller_notes string

Notes du vendeur.
Notes de l’acheteur
 shipments.order_data.buyer_notes string

Note de l’acheteur.
Définir comme résidentiel
 shipments.set_as_residential boolean

Si elle est définie comme résidentielle.
ID fiscal du destinataire
 shipments.consignee_tax_id string

Identificateur fiscal du destinataire.
Informations de référence sur l’EEI
 shipments.eei_reference string

Référence EEI.
Incoterms
 shipments.incoterms string

Les incoterms.
Est assuré
 shipments.insurance.is_insured boolean

S’il est assuré.
Montant assuré
 shipments.insurance.insured_amount integer

Montant assuré.
Devise assurée
 shipments.insurance.insured_currency string

Devise assurée.
Colis
 shipments.parcels array of object
Poids réel total
 shipments.parcels.total_actual_weight float

Poids réel total.
Valeur douanière totale
 shipments.parcels.total_customs_value float

Valeur douanière totale.
Poids total dimensionnel
 shipments.parcels.total_dimensional_weight float

Poids total de la dimension.
Poids volume total
 shipments.parcels.total_volumetric_weight float

Poids volumétrique total.
ID
 shipments.parcels.box.id string

Identificateur unique.
Nom du parapluie de courrier
 shipments.parcels.box.courier_umbrella_name string

Nom du parapluie de courrier.
Nom
 shipments.parcels.box.name string

Nom.
Slug
 shipments.parcels.box.slug string

La.
Longueur externe
 shipments.parcels.box.outer_length float

Longueur externe.
Largeur externe
 shipments.parcels.box.outer_width float

Largeur extérieure.
Hauteur externe
 shipments.parcels.box.outer_height float

Hauteur extérieure.
Weight
 shipments.parcels.box.weight integer

Le poids.
Objets
 shipments.parcels.items array of object
Descriptif
 shipments.parcels.items.description string

Description.
Catégorie
 shipments.parcels.items.category string

Catégorie.
Référence (SKU)
 shipments.parcels.items.sku string

Référence SKU.
Quantité
 shipments.parcels.items.quantity integer

Quantité.
Poids réel
 shipments.parcels.items.actual_weight integer

Poids réel.
Poids dimensionnel
 shipments.parcels.items.dimensional_weight integer

Poids dimensionnel.
Poids volumétrique
 shipments.parcels.items.volumetric_weight integer

Poids volumétrique.
Devise d’origine
 shipments.parcels.items.origin_currency string

Devise d’origine.
Valeur douanière d’origine
 shipments.parcels.items.origin_customs_value integer

Valeur douanière d’origine.
Devise déclarée
 shipments.parcels.items.declared_currency string

Devise déclarée.
Valeur douanière déclarée
 shipments.parcels.items.declared_customs_value integer

Valeur douanière déclarée.
Length
 shipments.parcels.items.dimensions.length integer

Longueur.
Largeur
 shipments.parcels.items.dimensions.width integer

Largeur.
Hauteur
 shipments.parcels.items.dimensions.height integer

Hauteur.
Valeur douanière totale
 shipments.total_customs_value float

Valeur douanière totale.
Poids réel total
 shipments.total_actual_weight float

Poids réel total.
Poids total dimensionnel
 shipments.total_dimensional_weight float

Poids total de la dimension.
Poids volume total
 shipments.total_volumetric_weight float

Poids volumétrique total.
État de l’expédition
 shipments.shipment_state string

État de l’expédition.
État de l’enlèvement
 shipments.pickup_state string

État de l’enlèvement.
État de remise
 shipments.delivery_state string

État de remise.
État de l’étiquette
 shipments.label_state string

État de l’étiquette.
État de l’entrepôt
 shipments.warehouse_state string

État de l’entrepôt.
Suivis
 shipments.trackings array of object
Numéro de suivi
 shipments.trackings.tracking_number string

Numéro de suivi.
Numéro de suivi local
 shipments.trackings.local_tracking_number string

Numéro de suivi local.
Autre numéro de suivi
 shipments.trackings.alternate_tracking_number string

Numéro de suivi de remplacement.
Numéro de la jambe
 shipments.trackings.leg_number integer

Numéro de jambe.
Handler
 shipments.trackings.handler string

Gestionnaire.
État de suivi
 shipments.trackings.tracking_state string

État de suivi.
URL de la page de suivi
 shipments.tracking_page_url string

Adresse URL de la page de suivi.
Documents d’expédition
 shipments.shipping_documents array of

Documents d’expédition.
Monnaie
 shipments.currency string

La devise.
ID
 shipments.selected_courier.id string

Identificateur unique.
Tarifs
 shipments.rates array of object
ID de courrier
 shipments.rates.courier_id string

Identificateur unique de courrier.
Nom du courrier
 shipments.rates.courier_name string

Nom du courrier.
Durée de livraison minimale
 shipments.rates.min_delivery_time integer

Délai de livraison minimal.
Durée de livraison maximale
 shipments.rates.max_delivery_time integer

Délai de livraison maximal.
Classement de valeur pour l’argent
 shipments.rates.value_for_money_rank integer

Valeur du classement de l’argent.
Classement de l’heure de remise
 shipments.rates.delivery_time_rank integer

Classement du délai de livraison.
Frais d’expédition
 shipments.rates.shipment_charge float

Frais d’expédition.
Surcharge de carburant
 shipments.rates.fuel_surcharge float

Le supplément de carburant.
Surcharge de zone distante
 shipments.rates.remote_area_surcharge integer

Surcharge de la zone distante.
Surcharge surdimensionnée
 shipments.rates.oversized_surcharge integer

Surcharge surdimensionnée.
Surcharge supplémentaire sur les services
 shipments.rates.additional_services_surcharge integer

Frais supplémentaires sur les services.
Frais complets résidentiels
 shipments.rates.residential_full_fee integer

Les frais d’habitation complets.
Frais d’escompte résidentiels
 shipments.rates.residential_discounted_fee integer

Les frais d’habitation réduits.
Total des frais d’expédition
 shipments.rates.shipment_charge_total float

Total des frais d’expédition.
Frais de gestion des entrepôts
 shipments.rates.warehouse_handling_fee integer

Frais de gestion de l’entrepôt.
Frais d’assurance
 shipments.rates.insurance_fee integer

Les frais d’assurance.
Taxe de vente
 shipments.rates.sales_tax integer

Taxe de vente.
Taxe de vente provinciale
 shipments.rates.provincial_sales_tax integer

Taxe de vente provinciale.
Frais de gestion DDP
 shipments.rates.ddp_handling_fee integer

Frais de traitement du DDP.
Frais fiscaux d’importation
 shipments.rates.import_tax_charge integer

Frais fiscaux d’importation.
Frais d’importation
 shipments.rates.import_duty_charge integer

Frais d’importation.
Total Des frais
 shipments.rates.total_charge float

Frais totaux.
Est au-dessus du seuil
 shipments.rates.is_above_threshold boolean

Indique s’il est au-dessus du seuil.
Incoterms
 shipments.rates.incoterms string

Les incoterms.
Taxe d’importation estimée
 shipments.rates.estimated_import_tax integer

Taxe d’importation estimée.
Estimation des droits d’importation
 shipments.rates.estimated_import_duty integer

Droits d’importation estimés.
Options de remise disponibles
 shipments.rates.available_handover_options string

Options de remise disponibles.
Évaluation du suivi
 shipments.rates.tracking_rating integer

Évaluation du suivi.
Easyship Rating
 shipments.rates.easyship_rating integer

La cote Easyship.
Remarques de courrier
 shipments.rates.courier_remarks string

Le courrier remarque.
Destinataire du paiement
 shipments.rates.payment_recipient string

Destinataire du paiement.
Code
 shipments.rates.discount.code string

Code.
Montant
 shipments.rates.discount.amount integer

Montant.
Expire à
 shipments.rates.discount.expires_at string

Expire à.
Pourcentage
 shipments.rates.discount.percentage string

Pourcentage.
Incoterms effectifs
 shipments.rates.effective_incoterms string

L’incoterms efficace.

Répertorier toutes les zones

ID d’opération :
ListAllBoxes

Récupère une liste de toutes les boîtes de messagerie disponibles.

Retours

Nom Chemin d’accès Type Description
Boîtes
 boxes array of object
ID
 boxes.id string

Identificateur unique.
Nom du parapluie de courrier
 boxes.courier_umbrella_name string

Nom du parapluie de courrier.
Nom
 boxes.name string

Nom.
Slug
 boxes.slug string

La.
Longueur externe
 boxes.outer_length float

Longueur externe.
Largeur externe
 boxes.outer_width float

Largeur extérieure.
Hauteur externe
 boxes.outer_height float

Hauteur extérieure.
Weight
 boxes.weight float

Le poids.

Supprimer une expédition (V1)

ID d’opération :
DeleteAShipment

Supprimez et recevez la confirmation d’une suppression d’expédition.

Paramètres

Nom Clé Obligatoire Type Description
ID d’expédition easyship
 easyship_shipment_id True string

Identificateur d’expédition Easyship.

Retours

Nom Chemin d’accès Type Description
Statut
 status string

État.