Guide des cas d'utilisation de l'API Expédition directe par le fournisseur v1

Comment aider les fournisseurs participant au programme d'expédition directe à utiliser l'API d'expédition pour gérer leurs opérations d'expédition directe.

Version de l'API : v1

Qu'est-ce que l'API Expédition directe ?

Les fournisseurs peuvent utiliser l'API Expédition directe pour échanger des documents relatifs à l'expédition avec Amazon. Les fournisseurs peuvent demander des étiquettes d'expédition, recevoir des étiquettes d'expédition, envoyer des confirmations d'expédition, obtenir des bordereaux d'expédition et récupérer les factures des clients.

Veuillez noter que les factures des clients sont spécifiques à la région de l'Inde.

Les opérations suivantes sont disponibles :

Opération Méthode HTTP Path Description
submitShippingLabelRequest POST /vendor/directFulfillment/shipping/v1/shippingLabels Soumettez une ou plusieurs demande(s) d'étiquettes d'expédition.
getShippingLabels GET /vendor/directFulfillment/shipping/v1/shippingLabels Obtenez une liste des étiquettes d'expédition en fonction des critères de filtrage.

Note: This is a restricted operation and therefore requires a Restricted Data Token (RDT) for authorization. For more information, refer to the Tokens API Use Case Guide.
Note: Shipping labels will expire 90 days after creation through a submit shipping label request, hence shipping labels older than 90 days should not be requested.

getShippingLabel GET

/vendor/directFulfillment/shipping/v1/shippingLabels/{purchaseOrderNumber}

Obtenez une étiquette d'expédition par numéro de bon de commande.
Remarque : les étiquettes d'expédition expireront 90 jours après leur création par le biais d'une demande de soumission d'étiquette d'expédition. Par conséquent, il ne faut pas demander des étiquettes d'expédition datant de plus de 90 jours.
submitShipmentConfirmations POST /vendor/directFulfillment/shipping/v1/shipmentConfirmations Soumettez une ou plusieurs confirmation(s) d'expédition à Amazon.
submitShipmentStatusUpdates POST /vendor/directFulfillment/shipping/v1/shipmentStatusUpdates Soumettez une mise à jour du statut de l'expédition. Uniquement pour les fournisseurs ayant recours à leur propre transporteur.
getPackingSlips GET /vendor/directFulfillment/shipping/v1/packingSlips Obtenez une liste de bordereaux d'expédition en fonction des dates de création.

Note: This is a restricted operation and therefore requires a Restricted Data Token (RDT) for authorization. For more information, refer to the Tokens API Use Case Guide.
Note: Data retrieval can only go back six months, meaning that createdBefore cannot be more than six months in the past.

getPackingSlip GET /vendor/directFulfillment/shipping/v1/packingSlips/{purchaseOrderNumber} Obtenez le bordereau d'expédition d'une commande spécifique par numéro de bon de commande.
Remarque : la récupération des données ne peut remonter que six mois en arrière, ce qui signifie que createdBefore ne peut pas dater de plus de six mois.
getCustomerInvoices GET /vendor/directFulfillment/shipping/v1/customerInvoices Obtenez une liste des factures clients en fonction des critères de filtrage.

Note: This is a restricted operation and therefore requires a Restricted Data Token (RDT) for authorization. For more information, refer to the Tokens API Use Case Guide.
Note: Data retrieval can only go back six months, meaning that createdBefore cannot be more than six months in the past.

getCustomerInvoice GET /vendor/directFulfillment/shipping/v1/customerInvoices/{purchaseOrderNumber} Obtenez la facture client par numéro de bon de commande.
Remarque : la récupération des données ne peut remonter que six mois en arrière, ce qui signifie que createdBefore ne peut pas dater de plus de six mois.

submitShippingLabelRequest

L'opération submitShippingLabelRequest permet aux fournisseurs de demander des informations sur les étiquettes d'expédition à Amazon pour chaque bon de commande. Vous pouvez envoyer plusieurs demandes d'étiquettes d'expédition en vrac en un seul appel d'API en respectant le schéma. Lorsque les étiquettes d'expédition sont créées par Amazon, elles peuvent être téléchargées à l'aide de l'opération getShippingLabel.

Vérification des demandes d'étiquettes d'expédition soumises avec succès

Vendors can verify the status of their shipping label requests using the Direct Fulfillment Transaction Status API. Allow the system up to 15 min to show the status after submission. If the transaction status is not updated after 30 minutes, open a Contact Us case in Vendor Central.

Workflows d'intégration de l'API Demande d'étiquettes d'expédition

Le schéma suivant montre le workflow pour la soumission des demandes d'étiquettes d'expédition.

The Direct Fulfillment integration workflow for submitting shipping label requests.

Exigences commerciales

Amazon doit recevoir une demande d'étiquette d'expédition après la confirmation de l'acceptation de la commande par le fournisseur à l'aide de l'API d'accusé de réception de la commande.

Si vous utilisez les étiquettes d'expédition d'Amazon, l'envoi des informations relatives à l'article ou au colis dans la demande est facultatif.

Exigences commerciales spécifiques à chaque pays

Il n'existe pas d'exigences spécifiques aux pays.

Demande submitShippingLabelRequest

Pour demander des étiquettes d'expédition, appelez l'opérationsubmitShippingLabelRequest et transmettez le paramètre suivant :

Paramètres du corps :

Nom

Description

Obligatoire
shippingLabelRequests Demande d'une ou plusieurs étiquette(s) d'expédition.

Type : tableau < ShippingLabelRequest >

Oui

Exemple de demande :

POST "https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/shipping/v1/shippingLabels" { "shippingLabelRequests": [ { "purchaseOrderNumber": "2JK3S9VC", "sellingParty": { "partyId": "999US" }, "shipFromParty": { "partyId": "ABCD" }, "containers": [ { "containerType": "carton", "containerIdentifier": "123", "trackingNumber": "XXXX", "dimensions": { "length": "12", "width": "12", "height": "12", "unitOfMeasure": "IN" }, "weight": { "unitOfMeasure": "KG", "value": "10" }, "packedItems": [ { "itemSequenceNumber": 1, "buyerProductIdentifier": "B07DFVDRAB", "packedQuantity": { "amount": 1, "unitOfMeasure": "Each" } } ] } ] } ] }

Réponse submitShippingLabelRequest

Une réponse réussie comprend les éléments suivants :

Nom

Description

Obligatoire
transactionId GUID pour identifier cette transaction. Cette valeur peut être utilisée avec l'API Statut des transactions pour renvoyer le statut de cette transaction.

Type : chaîne

Non

Exemple de réponse :

{ "transactionId": "20190905010908-8a3b6901-ef20-412f-9270-21c021796605" }

getShippingLabels

The getShippingLabels operation returns shipping labels for all orders which meet the filter criteria specified in the request. You must have already requested shipping labels using the submitShippingLabelRequest operation before you use this API to get shipping labels available to you for fulfillment. Amazon recommends that vendors check for shipping labels at least once per hour during business hours. Depending on your business volume, you can choose to check more frequently. You can get up to 100 shipping labels in one API call. If there are more than 100 shipping labels you can use the nextToken value to get the next set of shipping labels.

📘

Jeton de données restreint pour autorisation

Il s'agit d'une opération restreinte qui nécessite donc un jeton de données restreint pour l'autorisation. Pour plus d'informations, consultez le Guide des cas d'utilisation de l'API Jetons.

Le schéma suivant illustre le workflow d'intégration lors de la récupération des étiquettes d'expédition :

The Direct Fulfillment integration workflow when retrieving shipping labels.

Demande getShippingLabels

Pour récupérer une liste d'étiquettes d'expédition, appelez l'opération getShippingLabels et transmettez les paramètres suivants :

Paramètres de requête :

Nom Description Obligatoire
shipFromPartyId L'identifiant de l'entrepôt du fournisseur à partir duquel la commande sera traitée. S'il n'est pas précisé, le résultat contiendra les commandes pour tous les entrepôts.

Type : chaîne

Non
limit La limite du nombre d'enregistrements renvoyés.

Minimum : 1

Maximum : 100

Type : entier

Non
createdAfter Les étiquettes d'expédition disponibles après cette date et cette heure seront incluses dans le résultat. Doit être au format ISO-8601 date/heure.

Type : chaîne (date-heure)

Oui
createdBefore Les étiquettes d'expédition disponibles avant cette date et cette heure seront incluses dans le résultat. Doit être au format ISO-8601 date/heure.

Type : chaîne (date-heure)

Oui
sortOrder Trier par ordre croissant (ASC) ou décroissant (DESC) par date de création de la commande.

Type : enum (SortOrder)

Non
nextToken Utilisé pour la pagination lorsque le nombre d'étiquettes d'expédition est supérieur à la limite de taille de résultat spécifiée. La valeur du jeton est renvoyée lors de l'appel API précédent.

Type : chaîne

Non

Exemple de demande :

GET https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/shipping/v1/shippingLabels?limit=2&createdAfter=2020-02-15T14:00:00-08:00&createdBefore=2020-02-20T00:00:00-08:00&sortOrder=DESC

Réponse getShippingLabels

Une réponse réussie comprend les éléments suivants :

Nom Description Obligatoire
pagination Si plus de 100 étiquettes d'expédition sont retournées, nextToken est renvoyé dans la réponse pour pagination.

Type : chaîne

Non
shippingLabels Liste des étiquettes des colis.

Type : tableau < ShippingLabel >

Non

Exemple de réponse :

{ "pagination": { "nextToken": "MDAwMDAwMDAwMQ==" }, "shippingLabels": [ { "purchaseOrderNumber": "2JK3S9VC", "sellingParty": { "partyId": "999US" }, "shipFromParty": { "partyId": "ABCD" }, "labelFormat": "PNG", "labelData": [ { "packageIdentifier": "PKG001", "trackingNumber": "1Z6A34Y60369738804", "shipMethod": "UPS_GR_RES", "shipMethodName": "UPS Ground Residential", "content": "Base 64 encoded string goes here " } ] }, { "purchaseOrderNumber": "2JK3S9VD", "sellingParty": { "partyId": "999US" }, "shipFromParty": { "partyId": "ABCD" }, "labelFormat": "PNG", "labelData": [ { "packageIdentifier": "PKG002", "trackingNumber": "1Z6A34Y60369738805", "shipMethod": "UPS_GR_RES", "shipMethodName": "UPS Ground Residential", "content": "Base 64 encoded string goes here " } ] } ] }

Obtenir une étiquette d'expédition

L'opération getShippingLabel renvoie des informations sur l'étiquette d'expédition que vous avez indiquée à l'aide du numéro de commande. La réponse comprend des informations complètes sur l'étiquette d'expédition pour la commande, notamment le type d'étiquette, les détails de la commande et la méthode d'expédition.

You can also use this API to get details for any shipping label (in the time range of seven days from a rolling window of the last six months, after the vendor went live on API).

Le diagramme suivant montre le workflow d'intégration pour la récupération d'une étiquette d'expédition spécifique :

The Direct Fulfillment integration workflow for retrieving a specific shipping label.

Quand l'étiquette d'expédition doit-elle être demandée ?

Les étiquettes ZPL et PNG ne doivent être demandées que le jour où les commandes doivent être expédiées.

Exigences commerciales spécifiques à chaque pays

Il n'y a pas d'exigences spécifiques aux pays pour les réponses concernant les étiquettes d'expédition.

Demande getShippingLabel

Pour demander une étiquette d'expédition, appelez l'opérationgetShippingLabel et transmettez le paramètre suivant :

Paramètre de chemin d'accès :

Nom Description Obligatoire
purchaseOrderNumber Le numéro de la commande pour laquelle vous souhaitez renvoyer l'étiquette d'expédition. Il doit être le même purchaseOrderNumber que celui reçu dans la commande.

Type : chaîne

Oui

Exemple de demande :

GET https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/shipping/v1/shippingLabels/2JK3S9VC

Réponse getShippingLabel

Une réponse réussie comprend les éléments suivants :

Nom Description Obligatoire
purchaseOrderNumber Ce champ contiendra le numéro de bon de commande pour cette commande.

Type : chaîne

Oui
sellingParty Identifiant du vendeur ou du fournisseur.

Type : PartyIdentification

Oui
shipFromParty Code d'entrepôt du fournisseur.

Type : PartyIdentification

Oui
labelFormat Format de l'étiquette.

enum ( LabelFormat )

Oui
labelData Fournit les détails des colis de cette expédition.

Type : tableau < LabelData >

Oui

Exemple de réponse :

{ "purchaseOrderNumber": "2JK3S9VC", "sellingParty": { "partyId": "999US" }, "shipFromParty": { "partyId": "ABCD" }, "labelFormat": "PNG", "labelData": [ { "packageIdentifier": "PKG001", "trackingNumber": "1Z6A34Y60369738804", "shipMethod": "UPS_GR_RES", "shipMethodName": "UPS Ground Residential", "content": "Base 64 encoded string goes here" } ] }

submitShipmentConfirmations

L'opération submitShipmentConfirmations permet aux fournisseurs de soumettre des confirmations d'expédition à Amazon. Votre confirmation d'expédition nous permet de suivre efficacement vos expéditions et d'informer nos clients. Il contient des informations sur les articles expédiés, notamment le numéro de bon de commande, la date d'expédition, la date de livraison estimée et le numéro de suivi.

Les confirmations d'expédition nous permettent de collaborer plus efficacement avec les transporteurs pour le suivi de vos expéditions.

L'absence de confirmation d'expédition valide peut entraîner :

  • une visibilité insuffisante sur les expéditions entrantes ;

  • Erreurs lors de la comparaison des expéditions physiques avec les bons de commande.

  • Suivis manuels pour résoudre les incohérences.

Vérification des confirmations d'expédition réussies

Vendors can verify the status of their shipment confirmations via Vendor Central > Orders > Direct Fulfillment Orders or using the Direct Fulfillment Transaction Status API. Allow the system up to 10 min to determine the status after submission. If Vendor Central is not showing the correct values for the shipment confirmation, open a Contact Us case in Vendor Central. Refer to the Business Requirements section for information about creating shipment confirmations.

Le schéma suivant montre le workflow d'intégration pour la soumission des confirmations d'expéditions :

The Direct Fulfillment integration workflow for submitting shipment confirmations.

Exigences commerciales

Vous devez utiliser cette API pour confirmer l'expédition d'une commande dans les 4 heures suivant l'expédition de la commande depuis votre entrepôt.

Pour les expéditions au sol refusées, réglez la valeur du champ shipmentStatus sur FLOOR_DENIAL.

Tous les articles du bon de commande doivent figurer dans la confirmation d'expédition. L'expédition partielle des commandes n'est pas autorisée. Les fournisseurs doivent rejeter la commande en tant que refus d'approvisionnement si l'un des articles de la gamme n'est pas disponible pour être expédié.

La valeur itemSequenceNumber pour un article doit être identique à celle reçue dans le message de commande.

Soit buyerProductIdentifier ou vendorProductIdentifier est obligatoire pour envoyer la confirmation d'expédition. Vous devez envoyer la même valeur que celle reçue dans le bon de commande.

Pour les transporteurs propres au fournisseur, l'envoi de la valeur scacCode est obligatoire.

Si l'étiquette d'expédition est fournie par Amazon, la section contenant est facultative car Amazon a accès aux informations du colis. La section des articles doit obligatoirement être soumise.

Le contenant figurant dans une confirmation d'expédition doit comporter une valeur shipMethod spécifiée.

Exigences commerciales spécifiques à chaque pays

Aucune

Demande submitShipmentConfirmations

Pour soumettre des confirmations d'expédition, appelez l'opération submitShipmentConfirmations et transmettez le paramètre suivant :

Paramètres du corps :

Nom Description Obligatoire
shipmentConfirmations Liste des expéditions confirmées

Type : tableau < ShipmentConfirmation >

Oui

Exemple de demande :

POST https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/shipping/v1/shipmentConfirmations
{ "shipmentConfirmations": [ { "purchaseOrderNumber": "PO00050003", "shipmentDetails": { "shippedDate": "2019-08-07T19:56:45.632Z", "shipmentStatus": "SHIPPED", "isPriorityShipment": true, "estimatedDeliveryDate": "2019-08-07T19:56:45.632Z" }, "sellingParty": { "partyId": "VENDORCODE" }, "shipFromParty": { "partyId": "VENDORWAREHOUSECODE" }, "items": [ { "itemSequenceNumber": 1, "buyerProductIdentifier": "ASIN001", "vendorProductIdentifier": "9782700001659", "shippedQuantity": { "amount": 100, "unitOfMeasure": "Each" } }, { "itemSequenceNumber": 2, "buyerProductIdentifier": "ASIN002", "vendorProductIdentifier": "9782700001659", "shippedQuantity": { "amount": 100, "unitOfMeasure": "Each" } }, { "itemSequenceNumber": 3, "buyerProductIdentifier": "ASIN003", "vendorProductIdentifier": "9782700001659", "shippedQuantity": { "amount": 100, "unitOfMeasure": "Each" } }, { "itemSequenceNumber": 4, "buyerProductIdentifier": "ASIN004", "vendorProductIdentifier": "9782700001659", "shippedQuantity": { "amount": 100, "unitOfMeasure": "Each" } } ], "containers": [ { "containerType": "carton", "containerIdentifier": "123", "trackingNumber": "TRACK001", "scacCode": "SCAC001", "carrier": "ABCD001", "shipMethod": "UPS", "dimensions": { "length": "10", "width": "10", "height": "10", "unitOfMeasure": "IN" }, "weight": { "unitOfMeasure": "KG", "value": "10" }, "packedItems": [ { "itemSequenceNumber": 1, "buyerProductIdentifier": "ASIN001", "packedQuantity": { "amount": 100, "unitOfMeasure": "Each" } } ] }, { "containerType": "carton", "containerIdentifier": "234", "trackingNumber": "TRACK002", "scacCode": "SCAC001", "carrier": "ABCD001", "shipMethod": "UPS", "dimensions": { "length": "10", "width": "10", "height": "10", "unitOfMeasure": "IN" }, "weight": { "unitOfMeasure": "KG", "value": "10" }, "packedItems": [ { "itemSequenceNumber": 2, "buyerProductIdentifier": "ASIN002", "packedQuantity": { "amount": 100, "unitOfMeasure": "Each" } } ] }, { "containerType": "carton", "containerIdentifier": "ABCD", "trackingNumber": "TRACK003", "scacCode": "SCAC001", "carrier": "ABCD001", "shipMethod": "UPS", "dimensions": { "length": "10", "width": "10", "height": "10", "unitOfMeasure": "IN" }, "weight": { "unitOfMeasure": "KG", "value": "10" }, "packedItems": [ { "itemSequenceNumber": 3, "buyerProductIdentifier": "ASIN003", "packedQuantity": { "amount": 100, "unitOfMeasure": "Each" } } ] }, { "containerType": "carton", "containerIdentifier": "id12", "trackingNumber": "TRACK004", "scacCode": "SCAC001", "carrier": "ABCD001", "shipMethod": "UPS", "dimensions": { "length": "10", "width": "10", "height": "10", "unitOfMeasure": "IN" }, "weight": { "unitOfMeasure": "KG", "value": "10" }, "packedItems": [ { "itemSequenceNumber": 4, "buyerProductIdentifier": "ASIN004", "packedQuantity": { "amount": 100, "unitOfMeasure": "Each" } } ] } ] } ] }

Réponse submitShipmentConfirmations

Une réponse réussie comprend les éléments suivants :

Nom Description Obligatoire
transactionId GUID pour identifier cette transaction. Cette valeur peut être utilisée avec l'API Statut des transactions pour renvoyer le statut de cette transaction.

Type : chaîne

Oui

Exemple de réponse :

{ "transactionId": "20190905010908-8a3b6901-ef20-412f-9270-21c021796605" }

submitShipmentStatusUpdates

⚠️

Important

Les mises à jour du statut des expéditions ne doivent être utilisées que par les fournisseurs VOC (Vendor Own Carrier, transporteur propre au fournisseur). Cela signifie que les fournisseurs utilisent leur propre transporteur pour la livraison de l'expédition et ne font pas appel aux transporteurs d'Amazon pour acheminer l'expédition jusqu'au client. Les fournisseurs couvriront en fin de compte les frais de transport et la responsabilité de la livraison au client.

L'opération submitShipmentStatusUpdates permet aux fournisseurs de mettre à jour le statut d'expédition pour les expéditions en cours d'acheminement vers le client final. Les fournisseurs VOC sont tenus de mettre à jour le statut d'expédition pendant la phase d'acheminement.

Ces informations seront ensuite transmises aux clients d'Amazon sur la page “Vos commandes” et amélioreront ainsi la visibilité sur le suivi de la commande et le processus de livraison.

L'absence de mise à jour du statut d'expédition peut entraîner de mauvais KPI opérationnels, tels qu'un faible taux de numérisation et, à terme, une interruption de l'activité de l'entrepôt.

Vérification des mises à jour du statut des expéditions soumises avec succès

Vendors can verify the status of their shipment status updates via Vendor Central > Orders > Direct Fulfillment Orders or by using the Direct Fulfillment Transaction Status API. Allow the system up to 10 min to determine the status after submission. If Vendor Central is not showing the correct values for the shipment confirmation, open a Contact Us case in Vendor Central. Refer to the Business Requirements section for information about creating shipment confirmations.

Le schéma suivant montre le workflow d'intégration pour la soumission des mises à jour du statut des expéditions :

The Direct Fulfillment integration workflow for submitting shipment status updates.

Exigences commerciales

Vous ne devez utiliser cette API que si vous êtes un fournisseur de VOC (Vendor Own Carrier), ce qui signifie que vous utilisez votre propre transporteur pour transporter l'envoi jusqu'au client.

Vous ne devez utiliser cette API que pour mettre à jour le statut d'une expédition une fois que celle-ci a été confirmée via l'API de confirmation d'expédition ou la confirmation d'expédition de Vendor Central.

La valeur trackingNumber dans l'API du statut d'expédition doit être identique à 100 % à la valeur trackingNumber fournie dans la confirmation d'expédition, sinon la mise à jour du statut d'expédition échouera.

Un appel à l'API de mise à jour du statut d'expédition doit correspondre à un seul colis physique. Vous pouvez mettre à jour le statut d'expédition de plusieurs colis en un seul appel API en les regroupant dans un tableau de mises à jour du statut d'expédition.

Une commande d'expédition directe peut donner lieu à plusieurs colis physiques à livrer au client. Plusieurs mises à jour du statut d'expédition sont donc nécessaires pour refléter le statut d'expédition de la commande complète.

Les fournisseurs doivent, dans la mesure du possible, envoyer le statut de l'expédition en suivant les directives d'Amazon relatives au statut de l'expédition.

Pour les commandes à livraison planifiée, les fournisseurs doivent envoyer le tableau de shipmentSchedule qui indique le délai de livraison estimé et la fenêtre de livraison.

Exigences commerciales spécifiques à chaque pays

Aucune

Explication des champs supplémentaires

statusCode and reasonCode

Ces champs sont des codes standard utilisés dans les normes EDI (par exemple, ISA X12 et EDIFACT) qui sont utilisés pour fournir un statut spécifique et le motif derrière ce statut. Nous attendons une combinaison spécifique de statusCode et reasonCode qui détermine un événement dans la phase de transport de l'expédition vers le client final.

Voici les codes de statut et de motif que nous prenons en charge et leur équivalence par rapport à la version actuelle de Vendor Central :

Code de statut EDIFACTCode de motif EDIFACTDescription opérationnelleEquivalence de l'interface utilisateur de Vendor Central
404117Expédition retardée en raison d'un accident de grande envergureDELAYED
301000Expédition livrée au clientDELIVERED
101000L'expédition a quitté le centre de distributionDEPARTED\_FROM\_FC
201000Expédition arrivée dans un établissement du transporteurIN\_TRANSIT
409000Le transporteur a perdu l'expéditionLOST
302000Expédition en cours de livraisonOUT\_FOR\_DELIVERY
407000Le destinataire a refusé d'accepter l'expéditionREJECTED
416000L'expédition ne peut pas être livrée et sera détruiteUNDELIVERABLE
Code de statut X12Code de motif X12Description opérationnelleEquivalence de l'interface utilisateur de Vendor Central
DEAFExpédition retardée en raison d'un accident de grande envergureDELAYED
D1NSExpédition livrée au clientDELIVERED
XBNSL'expédition a quitté le centre de distributionDEPARTED\_FROM\_FC
O1NSExpédition arrivée dans un établissement du transporteurIN\_TRANSIT
CAPLLe transporteur a perdu l'expéditionLOST
ODNSExpédition en cours de livraisonOUT\_FOR\_DELIVERY
A7AMLe destinataire a refusé d'accepter l'expéditionREJECTED
APBGL'expédition ne peut pas être livrée et sera détruiteUNDELIVERABLE

Demande submitShipmentStatusUpdates

Pour soumettre des mises à jour de statut d'expédition, appelez l'opération submitShipmentStatusUpdates et transmettez le paramètre suivant :

Paramètres du corps :

Nom Description Obligatoire
shipmentStatusUpdates Liste des expéditions confirmées.

Type : tableau < ShipmentStatusUpdate >

Oui

Exemple de demande :

POST https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/shipping/v1/shipmentStatusUpdates { "shipmentStatusUpdates": [ { "purchaseOrderNumber": "DX00050015", "sellingParty": { "partyId": "999US" }, "shipFromParty": { "partyId": "ABCD" }, "statusUpdateDetails": { "trackingNumber": "TRACK005", "statusCode": "D1", "reasonCode": "NS", "statusDateTime": "2020-08-07T19:56:45Z", "statusLocationAddress": { "city": "Any Town", "postalCode": "98101", "stateOrRegion": "Washington", "countryCode": "US" } } } ] }

Demande submitShipmentStatusUpdates

Une réponse réussie comprend les éléments suivants :

Nom Description Obligatoire
transactionId GUID pour identifier cette transaction. Cette valeur peut être utilisée avec l'API Statut des transactions pour renvoyer le statut de cette transaction.

Type : chaîne

Oui

Exemple de réponse :

{ "transactionId": "20190905010908-8a3b6901-ef20-412f-9270-21c021796605" }

getPackingSlips

L'opération getPackingSlips renvoie une liste de bordereaux d'expédition pour les commandes qui répondent aux critères indiqués. Si vous avez besoin d'obtenir un bordereau d'expédition pour une commande spécifique, utilisez plutôt l'opération getPackingSlip.

📘

Jeton de données restreint pour autorisation

Il s'agit d'une opération restreinte qui nécessite donc un jeton de données restreint pour l'autorisation. Pour plus d'informations, consultez le Guide des cas d'utilisation de l'API Jetons.

Nous vous recommandons d'utiliser cette API pour obtenir les bordereaux d'expédition des commandes dont vous disposez pour l'expédition. Amazon recommande aux fournisseurs de vérifier les commandes au moins une fois par heure pendant les heures ouvrées. En fonction de votre volume de ventes, vous pouvez choisir de vérifier plus fréquemment. Vous pouvez obtenir jusqu'à 100 bordereaux d'expédition en un seul appel API. S'il y a plus de 100 bordereaux d'expédition, vous pouvez utiliser la valeur nextToken comme paramètre dans votre prochaine requête pour obtenir le jeu suivant.

Le schéma suivant illustre le workflow d'intégration lors de la récupération des bordereaux d'expédition :

The Direct Fulfillment integration workflow when retrieving packing slips.

Demande getPackingSlips

Pour récupérer des bordereaux d'expédition, appelez l'opération getPackingSlips et transmettez les paramètres suivants :

Paramètres de requête :

Nom Description Obligatoire
shipFromPartyId warehouseId du fournisseur pour l'expédition des commandes. S'il n'est pas précisé, le résultat contiendra les commandes de tous les entrepôts.

Type : chaîne

Non
limit La limite du nombre d'enregistrements renvoyés.

Minimum : 1

Maximum : 100

Type : entier

Non
createdAfter Les bordereaux d’expédition disponibles après cette date et cette heure seront inclus dans le résultat. Doit être au format ISO-8601 date/heure.

Type : chaîne (date-heure)

Oui
createdBefore Les bordereaux d’expédition disponibles avant cette date et cette heure seront inclus dans le résultat. Doit être au format ISO-8601 date/heure.

Type : chaîne (date-heure)

Oui
sortOrder Tri de ASC ou DESC par date de création du bordereau d'expédition.

Type : enum (SortOrder)

Non
nextToken Utilisé pour la pagination lorsque le nombre de bordereaux d’expédition est supérieur à la limite de taille de résultat spécifiée. La valeur du jeton est renvoyée lors de l'appel API précédent.

Type : chaîne

Non

Exemple de demande :

GET https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/shipping/v1/packingSlips?createdBefore=2020-06-12T12:00:00-08:00&createdAfter=2020-06-12T00:00:00-08:00&limit=2&sortOrder=DESC

Réponse getPackingSlips

Une réponse réussie comprend les éléments suivants :

Nom Description Obligatoire
pagination Si plus de 100 commandes sont retournées, nextToken est renvoyé dans la réponse pour pagination.

Type : chaîne

Non
packingSlips Comprend les détails des bordereaux d'expédition.

Type : tableau < PackingSlip >

Non

Exemple de réponse :

{ "payload": { "pagination": { "nextToken": "NEBxNEBxNEBxNR==" }, "packingSlips": [ { "purchaseOrderNumber": "UvgABdBjQ", "content": "base64 encoded string", "contentType": "application/pdf" }, { "purchaseOrderNumber": "VvgCDdBjR", "content": "base64 encoded string", "contentType": "application/pdf" } ] } }

getPackingSlip

L'opération getPackingSlip renvoie des informations sur le bordereau d'expédition spécifique que vous indiquez à l'aide du numéro de commande. La réponse comprend une chaîne codée en base64 du bordereau d'expédition. Le type de contenu sera toujours “application/pdf”.

Le schéma suivant illustre le workflow d'intégration lors de la récupération d'un bordereau d'expédition :

The Direct Fulfillment integration workflow when retrieving a packing slip.

Demande getPackingSlip

Pour récupérer un bordereau d'expédition, appelez l'opération getPackingSlip et transmettez le paramètre suivant :

Paramètre de chemin d'accès :

Nom Description Obligatoire
purchaseOrderNumber Le purchaseOrderNumber pour le bordereau d'expédition souhaité.

Type : chaîne

Oui

Exemple de demande :

GET https://sellingpartnerapi-na.amazon.com /vendor/directFulfillment/shipping/v1/packingSlips/UkP3YkKDr

Réponse getPackingSlip

Une réponse réussie comprend les éléments suivants :

Nom Description Obligatoire
purchaseOrderNumber Numéro de commande de l'expédition à laquelle correspond le bordereau d'expédition.

Type : chaîne

Non
packingSlip

Informations sur le bordereau d'expédition.

Type : PackingSlip

Non

Exemple de réponse :

{ "payload": { "purchaseOrderNumber": "UvgABdBjQ", "content": "base64 encoded string", "contentType": "application/pdf" } }

Obtenir les factures des clients

The getCustomerInvoices operation returns customer invoices for all purchase orders which meet the filter criteria you specify. The use of this API is mandatory only in the India region and not required in any other region. Amazon recommends that vendors check for customer invoices at least once per hour during business hours. Depending on your business volume, you can choose to check more frequently. You can get up to 100 customer invoices in one API call. If there are more than 100 customer invoices you can use the nextToken value as a parameter in the next request to get the next set of customer invoices.

📘

Jeton de données restreint pour autorisation

Il s'agit d'une opération restreinte qui nécessite donc un jeton de données restreint pour l'autorisation. Pour plus d'informations, consultez le Guide des cas d'utilisation de l'API Jetons.

Le schéma suivant illustre le workflow d'intégration lors de la récupération des factures clients :

The Direct Fulfillment integration workflow when retrieving customer invoices.

Demande getCustomerInvoices

Pour renvoyer les factures clients, appelez l'opération getCustomerInvoices et transmettez les paramètres suivants :

Paramètres de requête :

Nom Description Obligatoire
shipFromPartyId warehouseId du fournisseur pour l'expédition des commandes. S'il n'est pas précisé, le résultat contiendra les commandes de tous les entrepôts.

Type : chaîne

Non
limit La limite du nombre d'enregistrements renvoyés.

Minimum : 1

Maximum : 10

Type : entier

Non
createdAfter Les commandes disponibles après cette date et cette heure seront incluses dans le résultat. Doit être au format ISO-8601 date/heure.

Type : chaîne (date-heure)

Oui
createdBefore Les commandes disponibles avant cette date et cette heure seront incluses dans le résultat. Doit être au format ISO-8601 date/heure.

Type : chaîne (date-heure)

Oui
sortOrder Tri par ordre ASC ou DESC en fonction de la date de création de la commande.

Type : enum (SortOrder)

Non
nextToken Utilisé pour la pagination lorsque le nombre de commandes est supérieur à la limite de taille de résultat spécifiée. La valeur du jeton est renvoyée lors de l'appel API précédent.

Type : chaîne

Non

Exemple de demande :

GET https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/shipping/v1/customerInvoices?limit=2&createdAfter=2020-02-15T14:00:00-08:00&createdBefore=2020-02-20T00:00:00-08:00&sortOrder=DESC

Réponse getCustomerInvoices

Une réponse réussie comprend les éléments suivants :

Nom Description Obligatoire
pagination Si plus de 100 factures clients sont retournées, nextToken est renvoyé dans la réponse pour pagination.

Type : chaîne

Non
customerInvoices Liste des factures des clients.

Type : tableau < CustomerInvoice >

Non

Exemple de réponse :

{ "pagination": { "nextToken": "MDAwMDAwMDAwMQ==" }, "customerInvoices": [ { "purchaseOrderNumber": "PO98676856", "content": "base 64 content goes here" } ] }

Obtenir la facture du client

L'opération getCustomerInvoice renvoie des informations sur la facture client que vous avez indiquée à l'aide du numéro de commande. La réponse comprend des informations complètes sur la facture client pour la commande.

Vous pouvez également utiliser cette API pour obtenir des informations sur n'importe quelle facture client (dans une période de 7 jours à partir de la période glissante des 6 derniers mois, après que le fournisseur a mis en service l'API).

Le schéma suivant illustre le workflow d'intégration pour le retour d'une facture client :

The Direct Fulfillment integration workflow for retrieving a customer invoice.

Exigences commerciales spécifiques à chaque pays

Seule la région de l'Inde doit utiliser l'API pour les factures clients.

Demande getCustomerInvoice

Pour renvoyer une facture client, appelez l'opération getCustomerInvoice et transmettez le paramètre suivant :

Paramètre de chemin d'accès :

Nom Description Obligatoire
purchaseOrderNumber Numéro de commande de l'expédition pour laquelle la facture doit être renvoyée.

Type : chaîne

Oui

Exemple de demande :

GET https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/shipping/v1/shippingLabels/2JK3S9VC

Réponse getCustomerInvoice

Une réponse réussie comprend les éléments suivants :

Nom Description Obligatoire
purchaseOrderNumber Le numéro de bon de commande pour cette commande.

Type : chaîne

Oui
content La facture client codée en Base64.

Type : chaîne

Oui

Exemple de réponse :

{ "payload": { "purchaseOrderNumber": "PO98676856", "content": "base 64 encoded string" } }

Cette page vous a-t-elle été utile ?