Passer au contenu
/
Créer une promotion

Subscriptions API (2.0)

Présentation

  • Version : 2.0
  • Serveurs : https://api.xsolla.com/merchant/v2/

Cette référence API décrit les endpoints pour la gestion des abonnements, des coupons et des promotions. Pour plus d'informations sur les abonnements, consultez le guide du produit et le glossaire.

Télécharger la description d'OpenAPI
index.json
index.yaml
Langues
Serveurs
Mock server
https://xsolla.redocly.app/_mock/fr/api/subscriptions/

Jeton

Opérations

Plans

Opérations

Produits

Opérations

Subscription management

Opérations

Paiements

Opérations

Promotions

Opérations

Lire la liste des promotions

Requête

Liste de toutes les promotions.

Remarque

Cet appel API ne contient pas le paramètre de cheminproject_id, vous devez donc utiliser la clé API valide dans tous les projets de l'entreprise pour l'autorisation.

Sécurité
basicAuth
Chemin
merchant_idintegerobligatoire

ID de commerçant.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/fr/api/subscriptions/merchants/{merchant_id}/promotions'

Réponses

OK.

Corpsapplication/json
Réponse
application/json
[
  {
    "datetime": { … },
    "enabled": true,
    "id": 17840,
    "is_active": true,
    "is_infinite": false,
    "project": { … },
    "read_only": false,
    "technical_name": "christmas"
  },
  {
    "datetime": null,
    "enabled": false,
    "id": 17891,
    "is_active": false,
    "is_infinite": true,
    "project": { … },
    "read_only": false,
    "technical_name": "Sale promotion"
  }
]

Créer une promotion

Requête

Créer une nouvelle promotion.

Remarque

Cet appel API ne contient pas le paramètre de cheminproject_id, vous devez donc utiliser la clé API valide dans tous les projets de l'entreprise pour l'autorisation.

Sécurité
basicAuth
Chemin
merchant_idintegerobligatoire

ID de commerçant.

Corpsapplication/jsonobligatoire
descriptionobject

Tableau des descriptions localisées de la promotion.

labelobject

Tableau des étiquettes localisées à afficher dans l'interface de paiement.

nameobject

Tableau des noms localisés de la promotion.

project_idintegerobligatoire

ID de projet.

technical_namestringobligatoire

Nom technique de la promotion.

enabledboolean
idinteger
read_onlyboolean
show_bannerboolean
curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/fr/api/subscriptions/merchants/{merchant_id}/promotions' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": {
      "en": "Promotion with 30% discount",
      "ru": "Акция со скидкой 30%"
    },
    "label": {
      "en": "30%",
      "ru": "30%"
    },
    "name": {
      "en": "30% discount",
      "ru": "скидка 30%"
    },
    "project_id": 12345,
    "technical_name": "Sale promotion"
  }'

Réponses

Created.

Corpsapplication/json
idinteger

ID de promotion.

Réponse
application/json
{
  "id": 17890
}

Supprimer une promotion

Requête

Supprime une promotion. Vous ne pouvez supprimer que les promotions avec enabled = false.

Remarque

Cet appel API ne contient pas le paramètre de cheminproject_id, vous devez donc utiliser la clé API valide dans tous les projets de l'entreprise pour l'autorisation.

Sécurité
basicAuth
Chemin
merchant_idintegerobligatoire

ID de commerçant.

promotion_idintegerobligatoire

ID de promotion.

curl -i -X DELETE \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/fr/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}'

Réponses

No content.

Coupons

Opérations

Subscription management

Opérations