Documentation
Hub pour développeursÉtat de l'APIAssistance
Commencez à saisir du texte pour lancer une recherche...

Guide des cas d'utilisation de l'API Réapprovisionnement v2022-11-07

Accéder aux statistiques du programme de réapprovisionnement et aux informations sur les offres d'un partenaire de vente.

Version de l'API : 2022-11-07

Qu'est-ce que l'API Réapprovisionnement ?

L'API partenaire de vente pour le réapprovisionnement (API Réapprovisionnement) vous permet de renvoyer des informations sur les activités du programme de réapprovisionnement d'un partenaire de vente. Actuellement, le programme de réapprovisionnement Économisez en vous abonnant est pris en charge. Grâce à l'API Réapprovisionnement, vous pouvez créer des applications qui renvoient des statistiques sur les performances commerciales d'un partenaire de vente en matière de réapprovisionnement ainsi que des informations sur ses offres de programme de réapprovisionnement.

Certains attributs ou cas d'utilisation peuvent ne pas s'appliquer à la fois aux vendeurs et aux fournisseurs. Pour en savoir plus, consultez la section Référence de l'API Réapprovisionnement v2022-11-07.

L'API de réapprovisionnement est disponible partout où Amazon Subscribe & Save est en ligne. L'API est également disponible pour les fournisseurs et les partenaires commerciaux de Fulfillment by Amazon (FBA).

Principales fonctionnalités

  • Récupérer les données des statistiques commerciales : l'API Réapprovisionnement permet d'accéder à un certain nombre de statistiques agrégées sur une période donnée, ainsi qu'à des données sur les articles du catalogue (ASIN).

  • Récupérer les détails de l'offre du vendeur : l'API Réapprovisionnement permet d'accéder à des informations sur les offres d'un programme de réapprovisionnement d'un vendeur dans le cadre du programme Économisez en vous abonnant.

Terminologie

  • Programme de réapprovisionnement : programme permettant d'assurer la livraison récurrente d'un article réapprovisionnable à une fréquence choisie par le destinataire.

  • Économisez en vous abonnant : programme de réapprovisionnement Amazon permettant d'assurer la livraison récurrente (automatique ou manuelle) de tout article réapprovisionnable à une fréquence choisie par le client.

  • Offre : à ne pas confondre avec une offre de mise en vente, une offre réapprovisionnable est identifiée de manière unique dans le service backend par le numéro d’identification standard Amazon (ASIN), l'identifiant du partenaire de vente, l'identifiant du site de vente et le SKU.

  • Offre activée : offre du programme de réapprovisionnement éligible à de nouveaux abonnements.

  • Partenaire de vente : un partenaire de vente peut être un vendeur ou un fournisseur.

Tutoriel : Filtrer toutes les offres de réapprovisionnement d'un partenaire de vente selon des critères spécifiques

Ce tutoriel explique comment utiliser l'API Réapprovisionnement pour accéder aux offres de réapprovisionnement d'un partenaire de vente (actuellement du programme Économisez en vous abonnant) en fonction de critères de filtrage.

Conditions préalables

Pour réussir ce tutoriel, vous devez disposer de :

Tâche 1 : Accéder à toutes les offres activées d'un partenaire de vente.

Les offres activées sont celles qui sont éligibles à de nouveaux abonnements. Pour accéder aux offres activées, appelez l'opération listOffers, en fournissant les paramètres suivants :

Paramètres du corps

Paramètre Description Obligatoire
pagination Utilisez ces paramètres pour faire défiler les réponses.

Type : ListOffersRequestPagination

 Oui
filters Utilisez ces paramètres pour filtrer les résultats. Tous les résultats doivent correspondre aux paramètres fournis. Pour tout paramètre au format tableau, le résultat doit correspondre à au moins un élément du tableau fourni.

Type : ListOffersRequestFilters

 Oui
sort Utilisez ces paramètres pour trier les réponses.

Type : ListOffersRequestSort

 Non

Le paramètre filters prend en charge un tableau eligibilities facultatif dans lequel vous pouvez indiquer les statuts d'éligibilité des offres que vous souhaitez afficher. Pour accéder uniquement aux offres activées ou éligibles, il vous suffit de préciser la valeur d'énumération “ELIGIBLE” dans le tableau eligibilities, comme illustré dans l'exemple de demande suivant :

Exemple de demande

POST https://sellingpartnerapi-na.amazon.com/replenishment/2022-11-07/offers/search
{
  "filters":{
    "eligibilities":["ELIGIBLE"],
    "marketplaceId": "A21TJRUUN4KGV",
    "programTypes": ["SUBSCRIBE_AND_SAVE"]
  },
  "pagination": {
    "limit": 25,
    "offset": 10
  }
}

Réponse

Une réponse satisfaisante comprend la liste des offres activées ainsi que des informations supplémentaires sur chaque offre.

Exemple de réponse

{
  "offers": [
    {
      "marketplaceId": "ATVPDKIKX0DER",
      "offerProgramConfiguration": {
        "preferences": {
          "autoEnrollment": "OPTED_IN"
        },
        "promotions": {
          "sellingPartnerFundedBaseDiscount": {
            "percentage": 5
          },
          "sellingPartnerFundedTieredDiscount": {
            "percentage": 0
          },
          "amazonFundedBaseDiscount": {
            "percentage": 5
          },
          "amazonFundedTieredDiscount": {
            "percentage": 10
          }
        },
        "enrollmentMethod": "AUTOMATIC"
      },
      "programType": "SUBSCRIBE_AND_SAVE",
      "eligibility": "ELIGIBLE",
      "asin": "ASIN_1",
      "sku": "SKU_OPTED_IN"
    }
  ],
  "pagination": {
    "totalResults": 1
  }
}

Tâche 2 : Accéder à toutes les offres d'un partenaire de vente en fonction d'ASIN spécifiques.

Pour afficher toutes les offres relatives aux ASIN indiqués, appelez l'opération listOffers, en fournissant les paramètres suivants :

Paramètres du corps

Paramètre Description Obligatoire
pagination Utilisez ces paramètres pour faire défiler les réponses.

Type : ListOffersRequestPagination

 Oui
filters Utilisez ces paramètres pour filtrer les résultats. Tous les résultats doivent correspondre aux paramètres fournis. Pour tout paramètre au format tableau, le résultat doit correspondre à au moins un élément du tableau fourni.

Type : ListOffersRequestFilters

 Oui
sort Utilisez ces paramètres pour trier les réponses.

Type : ListOffersRequestSort

 Non

Le paramètre filters prend en charge un tableau asins facultatif dans lequel vous pouvez fournir la liste des ASIN pour les offres que vous souhaitez afficher, comme illustré dans l'exemple de demande suivant :

Exemple de demande

POST https://sellingpartnerapi-na.amazon.com/replenishment/2022-11-07/offers/search
{
  "filters": {
    "asins": ["ASIN_1", "ASIN_2"],
    "marketplaceId": "A21TJRUUN4KGV",
    "programTypes": ["SUBSCRIBE_AND_SAVE"]
  },
  "pagination": {
    "limit": 25,
    "offset": 10
  }
}

Réponse

Une réponse satisfaisante comprend la liste des offres associées à l'un des ASIN demandés, ainsi que des informations supplémentaires sur chaque offre.

Exemple de réponse

{
  "offers": [
    {
      "marketplaceId": "ATVPDKIKX0DER",
      "offerProgramConfiguration": {
        "preferences": {
          "autoEnrollment": "OPTED_IN"
        },
        "promotions": {
          "sellingPartnerFundedBaseDiscount": {
            "percentage": 5
          },
          "sellingPartnerFundedTieredDiscount": {
            "percentage": 0
          },
          "amazonFundedBaseDiscount": {
            "percentage": 5
          },
          "amazonFundedTieredDiscount": {
            "percentage": 10
          }
        },
        "enrollmentMethod": "AUTOMATIC"
      },
      "programType": "SUBSCRIBE_AND_SAVE",
      "eligibility": "ELIGIBLE",
      "asin": "ASIN_1",
      "sku": "SKU_OPTED_IN"
    }
  ],
  "pagination": {
    "totalResults": 1
  }
}

Tâche 3 : Accéder à toutes les offres d'un partenaire de vente qui bénéficient d'une remise financée par le vendeur.

Pour afficher toutes les offres dont la remise a été financée par le vendeur, appelez l'opération listOffers, en fournissant les paramètres suivants :

Paramètres du corps

Paramètre Description Obligatoire
pagination Utilisez ces paramètres pour faire défiler les réponses.

Type : ListOffersRequestPagination

 Oui
filters Utilisez ces paramètres pour filtrer les résultats. Tous les résultats doivent correspondre aux paramètres fournis. Pour tout paramètre au format tableau, le résultat doit correspondre à au moins un élément du tableau fourni.

Type : ListOffersRequestFilters

 Oui
sort Utilisez ces paramètres pour trier les réponses.

Type : ListOffersRequestSort

 Non

Le paramètre filters prend en charge une propriété promotions facultative vous permettant de filtrer les résultats pour n'inclure que les offres avec les pourcentages de réduction spécifiés, comme indiqué dans l'exemple de demande suivant :

Exemple de demande pour renvoyer des offres avec l'un ou l'autre 0 ou 5 financement des vendeurs

POST https://sellingpartnerapi-na.amazon.com/replenishment/2022-11-07/offers/search
{
  "filters": {
    "marketplaceId": "ATVPDKIKX0DER",
    "promotions": {
      "sellingPartnerFundedBaseDiscount": {
        "percentage": [
          0,
          5
        ]
      }
    },
    "programTypes": [
      "SUBSCRIBE_AND_SAVE"
    ]
  },
  "pagination": {
    "limit": 25,
    "offset": 10
  },
  "sort": {
    "order": "ASC",
    "key": "ASIN"
  }
}

Réponse

Une réponse satisfaisante comprend la liste des offres comportant l'une des remises financées par le vendeur demandées, ainsi que des informations supplémentaires sur chaque offre.

Exemple de réponse

{
  "offers": [
    {
      "marketplaceId": "ATVPDKIKX0DER",
      "offerProgramConfiguration": {
        "preferences": {
          "autoEnrollment": "OPTED_IN"
        },
        "promotions": {
          "sellingPartnerFundedBaseDiscount": {
            "percentage": 0
          },
          "sellingPartnerFundedTieredDiscount": {
            "percentage": 0
          },
          "amazonFundedBaseDiscount": {
            "percentage": 5
          },
          "amazonFundedTieredDiscount": {
            "percentage": 10
          }
        },
        "enrollmentMethod": "AUTOMATIC"
      },
      "programType": "SUBSCRIBE_AND_SAVE",
      "eligibility": "ELIGIBLE",
      "asin": "ASIN_1",
      "sku": "SKU_OPTED_IN"
    },
    {
      "marketplaceId": "ATVPDKIKX0DER",
      "offerProgramConfiguration": {
        "preferences": {
          "autoEnrollment": "OPTED_IN"
        },
        "promotions": {
          "sellingPartnerFundedBaseDiscount": {
            "percentage": 5
          },
          "sellingPartnerFundedTieredDiscount": {
            "percentage": 0
          },
          "amazonFundedBaseDiscount": {
            "percentage": 5
          },
          "amazonFundedTieredDiscount": {
            "percentage": 10
          }
        },
        "enrollmentMethod": "AUTOMATIC"
      },
      "programType": "SUBSCRIBE_AND_SAVE",
      "eligibility": "ELIGIBLE",
      "asin": "ASIN_2",
      "sku": "SKU_OPTED_IN_2"
    }
  ],
  "pagination": {
    "totalResults": 2
  }
}

Tâche 3 : Accéder à toutes les offres d'un partenaire de vente correspondant aux préférences d'inscription automatique indiquées (applicable uniquement aux vendeurs)

Pour accéder à toutes les offres correspondant à la préférence d'inscription automatique, appelez l'opération listOffers, en fournissant les paramètres suivants :

Paramètres du corps

Paramètre Description Obligatoire
pagination Utilisez ces paramètres pour faire défiler les réponses.

Type : ListOffersRequestPagination

 Oui
filters Utilisez ces paramètres pour filtrer les résultats. Tous les résultats doivent correspondre aux paramètres fournis. Pour tout paramètre au format tableau, le résultat doit correspondre à au moins un élément du tableau fourni.

Type : ListOffersRequestFilters

 Oui
sort Utilisez ces paramètres pour trier les réponses.

Type : ListOffersRequestSort

 Non

Le paramètre filters prend en charge une propriété preferences facultative vous permettant de filtrer les résultats pour n'inclure que les offres correspondant aux préférences autoEnrollment spécifiées, comme indiqué dans l'exemple de demande suivant :

Exemple de demande

POST https://sellingpartnerapi-na.amazon.com/replenishment/2022-11-07/offers/search
{
  "filters": {
    "marketplaceId": "A21TJRUUN4KGV",
    "preferences": {
      "autoEnrollment": [
        "OPTED_IN"
      ]
    },
    "programTypes": [
      "SUBSCRIBE_AND_SAVE"
    ]
  },
  "pagination": {
    "limit": 10,
    "offset": 20
  },
  "sort": {
    "order": "ASC",
    "key": "ASIN"
  }
}

Réponse

Une réponse satisfaisante comprend la liste des offres correspondant à l'une des préférences d'inscription automatique spécifiées, ainsi que des informations supplémentaires sur chaque offre.

Exemple de réponse

{
  "offers": [
    {
      "marketplaceId": "ATVPDKIKX0DER",
      "offerProgramConfiguration": {
        "preferences": {
          "autoEnrollment": "OPTED_IN"
        },
        "promotions": {
          "sellingPartnerFundedBaseDiscount": {
            "percentage": 5
          },
          "sellingPartnerFundedTieredDiscount": {
            "percentage": 0
          },
          "amazonFundedBaseDiscount": {
            "percentage": 5
          },
          "amazonFundedTieredDiscount": {
            "percentage": 10
          }
        },
        "enrollmentMethod": "AUTOMATIC"
      },
      "programType": "SUBSCRIBE_AND_SAVE",
      "eligibility": "ELIGIBLE",
      "asin": "ASIN_2",
      "sku": "SKU_OPTED_IN_2"
    }
  ],
  "pagination": {
    "totalResults": 2
  }
}

Tutoriel : Accéder aux statistiques commerciales d'un partenaire de vente en matière de réapprovisionnement

Ce tutoriel explique comment utiliser l'API Réapprovisionnement pour accéder aux statistiques commerciales d'un programme de réapprovisionnement d'un partenaire de vente (actuellement le programme Économisez en vous abonnant). Les statistiques suivantes sont prises en charge :

  • SHIPPED_SUBSCRIPTION_UNITS
  • TOTAL_SUBSCRIPTIONS_REVENUE
  • ACTIVE_SUBSCRIPTIONS
  • NOT_DELIVERED_DUE_TO_OOS
  • SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REVENUE
  • LOST_REVENUE_DUE_TO_OOS
  • SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REORDERS
  • COUPONS_REVENUE_PENETRATION
  • REVENUE_BY_DELIVERIES
  • SUBSCRIBER_RETENTION
  • REVENUE_PENETRATION_BY_SELLER_FUNDING
  • SHARE_OF_COUPON_SUBSCRIPTIONS

Pour connaître les noms et les descriptions des statistiques, reportez-vous à la section Metric.

Conditions préalables

Pour réussir ce tutoriel, vous devez disposer de :

Tâche 1 : Accéder à toutes les statistiques de performance agrégées sur la fréquence spécifiée.

Pour afficher les statistiques de performance antérieures d'un partenaire de vente, appelez l'opération getSellingPartnerMetrics, en fournissant les paramètres suivants :

Paramètres du corps

Paramètre Description Obligatoire
aggregationFrequency Ce paramètre correspond à la période utilisée pour regrouper les données dans la réponse. Notez qu'il n'est valable que pour le type de période relatif aux performances.

Type : AggregationFrequency

 Non
timeInterval Ce paramètre correspond à l'intervalle de temps utilisé pour calculer les statistiques.

Type : TimeInterval

 Oui
metrics Ce paramètre correspond à la liste des statistiques demandées. Si aucune valeur de statistique n'est précisée, les données de toutes les statistiques seront renvoyées.

Type : tableau < Metric >

 Non
timePeriodType Ce paramètre correspond au type de période qui détermine si les statistiques demandées sont rétrospectives (relatives aux performances) ou prospectives (relatives aux prévisions).

Type : TimePeriodType

 Oui
marketplaceId Ce paramètre fait référence à l'identifiant du site de vente. Les sites de vente pris en charge par les vendeurs et les fournisseurs sont ceux des États-Unis, du Canada, de l'Espagne, du Royaume-Uni, de la France, de l'Italie, de l'Inde, de l'Allemagne et du Japon. Les sites de vente pris en charge par les fournisseurs uniquement sont ceux du Brésil, de l'Australie, du Mexique, des Émirats Arabes Unis et des Pays-Bas. Pour trouver l'identifiant de votre site de vente, reportez-vous à la section Identifiants de sites de vente.

Type : chaîne

 Oui
programTypes Ce paramètre correspond à la liste des types de programmes de réapprovisionnement pour lesquels des statistiques doivent être renvoyées.

Type : ProgramTypes

 Oui

Par défaut, le paramètre metrics renvoie toutes les statistiques disponibles. Par conséquent, pour afficher toutes les statistiques disponibles, vous pouvez omettre le paramètre metrics, comme le montre l'exemple de demande suivant :

Exemple de demande

POST https://sellingpartnerapi-na.amazon.com/replenishment/2022-11-07/sellingPartners/metrics/search
{
  "aggregationFrequency": "WEEK",
  "timeInterval": {
    "endDate": "2023-03-11T00:00:00Z",
    "startDate": "2023-03-05T00:00:00Z"
  },
  "timePeriodType": "PERFORMANCE",
  "marketplaceId": "ATVPDKIKX0DER",
  "programTypes": [
    "SUBSCRIBE_AND_SAVE"
  ]
}

Réponse

Une réponse satisfaisante comprend les données de chaque statistique disponible. Pour chaque statistique, le timeInterval utilisé est renvoyé dans la réponse et aura été déterminé en fonction de la fréquence d'agrégation. Pour en savoir plus, reportez-vous à TimeInterval.

Exemple de réponse

{
  "metrics": [
    {
      "shippedSubscriptionUnits": 5290,
      "notDeliveredDueToOOS": 5.54,
      "totalSubscriptionsRevenue": 131340.24,
      "lostRevenueDueToOOS": 93.29,
      "couponsRevenuePenetration": 46.22,
      "activeSubscriptions": 0,
      "currencyCode": "USD",
      "timeInterval": {
        "endDate": "2023-03-11T00:00:00Z",
        "startDate": "2023-03-05T00:00:00Z"
      }
    },
    {
      "subscriberAverageRevenue": 125.93,
      "nonSubscriberAverageRevenue": 73.62,
      "currencyCode": "USD",
      "subscriberAverageReorders": 4.61,
      "nonSubscriberAverageReorders": 2.38,
      "timeInterval": {
        "endDate": "2023-05-24T21:13:55Z",
        "startDate": "2022-05-24T21:13:55Z"
      }
    }
  ]
}

Tâche 2 : Accéder à une statistique de performance agrégée spécifique selon une fréquence spécifiée.

Vous pouvez demander des statistiques spécifiques au lieu d'afficher toutes les statistiques disponibles en fournissant le paramètre facultatif metrics.

Pour afficher les statistiques de performance antérieures d'un partenaire de vente, appelez l'opération getSellingPartnerMetrics, en fournissant les paramètres suivants :

Paramètres du corps

Paramètre Description Obligatoire
aggregationFrequency Ce paramètre correspond à la période utilisée pour regrouper les données dans la réponse. Notez qu'il n'est valable que pour le type de période relatif aux performances.

Type : AggregationFrequency

 Non
timeInterval Ce paramètre correspond à l'intervalle de temps utilisé pour calculer les statistiques.

Type : TimeInterval

 Oui
metrics Ce paramètre correspond à la liste des statistiques demandées. Si aucune valeur de statistique n'est précisée, les données de toutes les statistiques seront renvoyées.

Type : tableau < Metric >

 Non
timePeriodType Ce paramètre correspond au type de période qui détermine si les statistiques demandées sont rétrospectives (relatives aux performances) ou prospectives (relatives aux prévisions).

Type : TimePeriodType

 Oui
marketplaceId Ce paramètre fait référence à l'identifiant du site de vente. Les sites de vente pris en charge par les vendeurs et les fournisseurs sont ceux des États-Unis, du Canada, de l'Espagne, du Royaume-Uni, de la France, de l'Italie, de l'Inde, de l'Allemagne et du Japon. Les sites de vente pris en charge par les fournisseurs uniquement sont ceux du Brésil, de l'Australie, du Mexique, des Émirats Arabes Unis et des Pays-Bas. Pour trouver l'identifiant de votre site de vente, reportez-vous à la section Identifiants de sites de vente.

Type : chaîne

 Oui
programTypes Ce paramètre correspond à la liste des types de programmes de réapprovisionnement pour lesquels des statistiques doivent être renvoyées.

Type : ProgramTypes

 Oui

Pour afficher des statistiques spécifiques pour un partenaire de vente, indiquez une ou plusieurs valeurs Metric dans le paramètre metrics, comme illustré dans l'exemple de demande suivant :

Exemple de demande

POST https://sellingpartnerapi-na.amazon.com/replenishment/2022-11-07/sellingPartners/metrics/search
{
  "aggregationFrequency": "WEEK",
  "timeInterval": {
    "endDate": "2023-03-11T00:00:00Z",
    "startDate": "2023-03-05T00:00:00Z"
  },
  "metrics": [
    "SHIPPED_SUBSCRIPTION_UNITS",
  ],
  "timePeriodType": "PERFORMANCE",
  "marketplaceId": "ATVPDKIKX0DER",
  "programTypes": [
    "SUBSCRIBE_AND_SAVE"
  ]
}

Réponse

Une réponse satisfaisante comprend les statistiques demandées. Pour chaque statistique, le timeInterval utilisé est renvoyé dans la réponse et aura été déterminé en fonction de la fréquence d'agrégation. Pour en savoir plus, reportez-vous à TimeInterval.

Exemple de réponse

{
  "metrics": [
    {
      "shippedSubscriptionUnits": 50,
      "timeInterval": {
        "endDate": "2023-03-11T00:00:00Z",
        "startDate": "2023-03-05T00:00:00Z"
      }
    }
  ]
}

Tâche 3 : Accéder à des données statistiques prévisionnelles pour les 30, 60 ou 90 prochains jours (applicable uniquement aux vendeurs).

Pour afficher les statistiques des prévisions pour les 30, 60 ou 90 prochains jours, appelez l'opération getSellingPartnerMetrics, en fournissant les paramètres suivants :

Paramètres du corps

Paramètre Description Obligatoire
timeInterval Ce paramètre correspond à l'intervalle de temps utilisé pour calculer les statistiques.

Type : TimeInterval

 Oui
metrics Ce paramètre correspond à la liste des statistiques demandées. Si aucune valeur de statistique n'est précisée, les données de toutes les statistiques seront renvoyées.

Type : tableau < Metric >

 Non
timePeriodType Ce paramètre correspond au type de période qui détermine si les statistiques demandées sont rétrospectives (relatives aux performances) ou prospectives (relatives aux prévisions).

Type : TimePeriodType

 Oui
marketplaceId Ce paramètre fait référence à l'identifiant du site de vente. Les sites de vente pris en charge par les vendeurs et les fournisseurs sont ceux des États-Unis, du Canada, de l'Espagne, du Royaume-Uni, de la France, de l'Italie, de l'Inde, de l'Allemagne et du Japon. Les sites de vente pris en charge par les fournisseurs uniquement sont ceux du Brésil, de l'Australie, du Mexique, des Émirats Arabes Unis et des Pays-Bas. Pour trouver l'identifiant de votre site de vente, reportez-vous à la section Identifiants de sites de vente.

Type : chaîne

 Oui
programTypes Ce paramètre correspond à la liste des types de programmes de réapprovisionnement pour lesquels des statistiques doivent être renvoyées.

Type : ProgramTypes

 Oui

Lorsque vous appelez l'opération getSellingPartnerMetrics, vous pouvez choisir d'afficher des statistiques prévisionnelles prospectives plutôt que des statistiques de performance passées. Pour obtenir des statistiques prévisionnelles, indiquez la valeur FORECAST pour le paramètre timePeriodType.

Des données sont disponibles pour les 30, 60 et 90 prochains jours. Pour afficher des données prévisionnelles, vous devez définir une période de 30, 60 ou 90 jours dans les valeurs de plage de dates et d'heures demandées que vous fournissez pour le paramètre timeInterval. Notez que si la valeur timeInterval que vous indiquez ne correspond pas exactement à 30, 60 ou 90 jours, celle-ci sera arrondie au nombre supérieur de jours de prévision.

Par exemple, si la durée de l'intervalle est de 91 jours, la réponse présentera des statistiques prévisionnelles pour les 30, 60 et 90 prochains jours, de même si la durée est de 89 jours. En revanche, si la durée de l'intervalle est de 59 jours, la réponse contiendra des statistiques prévisionnelles pour les 30 et 60 prochains jours.

Les statistiques TOTAL_SUBSCRIPTIONS_REVENUE et SHIPPED_SUBSCRIPTION_UNITS sont les seules statistiques prévisionnelles prises en charge.

Les statistiques prévisionnelles sont uniquement disponibles pour les vendeurs.

Supposons qu'aujourd'hui soit le 2023-05-25T00:00:00Z et que vous souhaitiez afficher une statistique prévisionnelle. L'exemple de demande suivant montre comment accéder aux données prévisionnelles des 90 prochains jours pour la statistique SHIPPED_SUBSCRIPTION_UNITS :

Exemple de demande

POST https://sellingpartnerapi-na.amazon.com/replenishment/2022-11-07/sellingPartners/metrics/search
{
    "timeInterval": {
      "endDate": "2023-08-23T00:00:00Z",
      "startDate": "2023-05-25T00:00:00Z"
    },
    "metrics":["SHIPPED_SUBSCRIPTION_UNITS"],
    "timePeriodType": "FORECAST",
    "marketplaceId": "ATVPDKIKX0DER",
    "programTypes": ["SUBSCRIBE_AND_SAVE"]
}

Réponse

Une réponse satisfaisante comprend les statistiques demandées. Pour chaque statistique, le timeInterval renvoyé dans la réponse est d'une durée de 30, 60 ou 90 jours en fonction des valeurs timeInterval fournies dans la demande.

Exemple de réponse

{
  "metrics": [
    {
      "shippedSubscriptionUnits": 10,
      "timeInterval": {
        "endDate": "2023-06-24T00:00:00Z",
        "startDate": "2023-05-25T00:00:00Z"
      }
    },
    {
      "shippedSubscriptionUnits": 20,
      "timeInterval": {
        "endDate": "2023-07-24T00:00:00Z",
        "startDate": "2023-05-25T00:00:00Z"
      }
    },
    {
      "shippedSubscriptionUnits": 30,
      "timeInterval": {
        "endDate": "2023-08-23T00:00:00Z",
        "startDate": "2023-05-25T00:00:00Z"
      }
    }
  ]
}

Tutoriel : Accéder aux statistiques commerciales de réapprovisionnement de chacune des offres d'un partenaire de vente

Ce tutoriel explique comment utiliser l'API Réapprovisionnement pour accéder aux statistiques de réapprovisionnement d'un partenaire de vente au niveau de l'ASIN. Les statistiques suivantes sont prises en charge :

  1. SHIPPED_SUBSCRIPTION_UNITS
  2. TOTAL_SUBSCRIPTIONS_REVENUE
  3. ACTIVE_SUBSCRIPTIONS
  4. NOT_DELIVERED_DUE_TO_OOS
  5. SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REVENUE
  6. LOST_REVENUE_DUE_TO_OOS
  7. COUPONS_REVENUE_PENETRATION
  8. REVENUE_BY_DELIVERIES
  9. SUBSCRIBER_RETENTION
  10. REVENUE_PENETRATION_BY_SELLER_FUNDING
  11. SHARE_OF_COUPON_SUBSCRIPTIONS

Pour connaître les noms et les descriptions des statistiques, reportez-vous à la section Metric.

Conditions préalables

Pour réussir ce tutoriel, vous devez disposer de :

Tâche 1 : Accéder à des données sur les statistiques de performance agrégées selon une fréquence spécifiée.

Pour obtenir les statistiques de performance d'un partenaire de vente pour chaque ASIN, appelez l'opération listOfferMetrics, en fournissant les paramètres suivants :

Paramètres du corps

Paramètre Description Obligatoire
pagination Utilisez ces paramètres pour faire défiler les réponses.

Type : ListOfferMetricsRequestPagination

 Oui
sort Utilisez ces paramètres pour trier les réponses.

Type : ListOfferMetricsRequestSort

 Non
filters Utilisez ces paramètres pour filtrer les résultats. Tous les résultats doivent correspondre aux paramètres fournis. Pour tout paramètre au format tableau, le résultat doit correspondre à au moins un élément du tableau fourni.

Type : ListOfferMetricsRequestFilters

 Oui

Le paramètre filters prend en charge une propriété timePeriodType qui vous permet d'afficher des statistiques de performance rétrospectives ou des statistiques prévisionnelles prospectives. Pour afficher des statistiques de performance, vous devez spécifier PERFORMANCE comme valeur timePeriodType.

L'opération listOfferMetrics prend uniquement en charge un intervalle de temps qui couvre une seule unité de la fréquence d'agrégation. Par exemple, pour une fréquence d'agrégation MONTH, la durée de l'intervalle entre startDate et endDate ne peut pas dépasser 1 mois.

Exemple de demande

POST https://sellingpartnerapi-na.amazon.com/replenishment/2022-11-07/offers/metrics/search
{
  "filters": {
    "aggregationFrequency": "WEEK",
    "timeInterval": {
      "endDate": "2023-03-11T00:00:00Z",
      "startDate": "2023-03-05T00:00:00Z"
    },
    "timePeriodType": "PERFORMANCE",
    "marketplaceId": "ATVPDKIKX0DER",
    "programTypes": [
      "SUBSCRIBE_AND_SAVE"
    ]
  },
  "pagination": {
    "limit": 10,
    "offset": 10
  },
  "sort": {
    "order": "ASC",
    "key": "SHIPPED_SUBSCRIPTION_UNITS"
  }
}

Réponse

Une réponse satisfaisante comprend les statistiques demandées pour chaque ASIN.

Exemple de réponse

{
  "offers": [
    {
      "notDeliveredDueToOOS": 30.78,
      "shippedSubscriptionUnits": 20,
      "totalSubscriptionsRevenue": 12.89,
      "asin": "B000TMUDOW",
      "revenuePenetration": 10.34,
      "lostRevenueDueToOOS": 12.32,
      "couponsRevenuePenetration": 10,
      "shareOfCouponSubscriptions": 24.04,
      "timeInterval": {
        "endDate": "2023-03-11T00:00:00Z",
        "startDate": "2023-03-05T00:00:00Z"
      },
      "currencyCode": "USD"
    },
    {
      "notDeliveredDueToOOS": 40.78,
      "shippedSubscriptionUnits": 40,
      "totalSubscriptionsRevenue": 34.03,
      "asin": "B004CLH5CY",
      "revenuePenetration": 9.87,
      "lostRevenueDueToOOS": 17.82,
      "couponsRevenuePenetration": 17,
      "shareOfCouponSubscriptions": 20.04,
      "timeInterval": {
        "endDate": "2023-03-11T00:00:00Z",
        "startDate": "2023-03-05T00:00:00Z"
      },
      "currencyCode": "USD"
    }
  ],
  "pagination": {
    "totalResults": 17
  }
}

Tâche 3 : Accéder à des données statistiques prévisionnelles pour les 30, 60 ou 90 prochains jours (applicable uniquement aux vendeurs).

Pour afficher les données relatives aux statistiques prévisionnelles pour chaque ASIN, appelez l'opération listOfferMetrics,
en fournissant les paramètres suivants :

Paramètres du corps

Paramètre Description Obligatoire
pagination Utilisez ces paramètres pour faire défiler les réponses.

Type : ListOfferMetricsRequestPagination

 Oui
sort Utilisez ces paramètres pour trier les réponses.

Type : ListOfferMetricsRequestSort

 Non
filters Utilisez ces paramètres pour filtrer les résultats. Tous les résultats doivent correspondre aux paramètres fournis. Pour tout paramètre au format tableau, le résultat doit correspondre à au moins un élément du tableau fourni.

Type : ListOfferMetricsRequestFilters

 Oui

Lorsque vous appelez l'opération listOfferMetrics, vous pouvez choisir d'afficher des statistiques prévisionnelles prospectives plutôt que des statistiques de performance passées. Pour obtenir des statistiques prévisionnelles, indiquez la valeur FORECAST pour la propriété timePeriodType du paramètre filters.

L'opération listOfferMetrics prend uniquement en charge un intervalle de temps qui couvre une seule unité de la fréquence d'agrégation. Par exemple, pour une fréquence d'agrégation MONTH, la durée de l'intervalle entre startDate et endDate ne peut pas dépasser 1 mois.

Les statistiques TOTAL_SUBSCRIPTIONS_REVENUE et SHIPPED_SUBSCRIPTION_UNITS sont les seules statistiques prévisionnelles prises en charge.

Les statistiques prévisionnelles sont uniquement disponibles pour les vendeurs.

La demande suivante montre comment demander des données prévisionnelles pour les 90 prochains jours à partir d'un exemple de date actuelle de 2023-05-25T00:00:00Z:

Exemple de demande

POST https://sellingpartnerapi-na.amazon.com/replenishment/2022-11-07/offers/metrics/search
{
  "filters": {
    "timeInterval": {
      "endDate": "2023-08-23T00:00:00Z",
      "startDate": "2023-05-25T00:00:00Z"
    },
    "timePeriodType": "FORECAST",
    "marketplaceId": "ATVPDKIKX0DER",
    "programTypes": [
      "SUBSCRIBE_AND_SAVE"
    ]
  },
  "pagination": {
    "limit": 10,
    "offset": 10
  }
}

Réponse

Une réponse satisfaisante comprend les statistiques prévisionnelles disponibles pour chaque ASIN.

Exemple de réponse

{
  "offers": [
    {
      "next30DayTotalSubscriptionsRevenue": 0,
      "next60DayTotalSubscriptionsRevenue": 61.8,
      "next90DayTotalSubscriptionsRevenue": 30.9,
      "asin": "B0872JRNS2",
      "next90DayShippedSubscriptionUnits": 20,
      "next60DayShippedSubscriptionUnits": 10,
      "next30DayShippedSubscriptionUnits": 2,
      "currencyCode": "USD",
      "timeInterval": {
        "endDate": "2023-08-23T00:00:00Z",
        "startDate": "2023-05-25T00:00:00Z"
      }
    }
  ],
  "pagination": {
    "totalResults": 17
  }
}

Updated about 2 months ago

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