Saltar para o conteúdo

Visão geral

  • Versão: 2.0
  • Servidores: https://api.xsolla.com/merchant/v2/

Essa referência API descreve os pontos de extremidade na gerência de assinaturas, cupons e promoções. Para obter mais informações sobre as Assinaturas, veja o guia do produto e o glossário.

Transferir a descrição da OpenAPI
Idiomas
Servidores
Mock server
https://xsolla.redocly.app/_mock/pt/api/subscriptions/
Operações
Operações
Operações
Operações
Operações
Operações

Pedido

Crie uma nova promoção.

Aviso

Esta chamada de API não contém o trajeto-parâmetro project_id, então é preciso usar a chave API que for válida em todos os projetos da empresa para configurar a autorização.

Segurança
basicAuth
Caminho
merchant_idintegerobrigatório

ID de comerciante.

Corpoapplication/jsonobrigatório
descriptionobject

Matriz de descrições de promoções traduzidas.

description.​arstring

Árabe.

description.​bgstring

Búlgaro.

description.​cnstring

Chinês (Simplificado).

description.​csstring

Tcheco.

description.​destring

Alemão.

description.​enstring

Inglês.

description.​esstring

Espanhol.

description.​frstring

Francês.

description.​hestring

Hebreu.

description.​itstring

Italiano.

description.​jastring

Japonês.

description.​kostring

Coreano.

description.​plstring

Polonês.

description.​ptstring

Português.

description.​rostring

Romeno.

description.​rustring

Russo.

description.​thstring

Tailandês.

description.​trstring

Turco.

description.​twstring

Chinês (Tradicional).

description.​vistring

Vietnamita.

labelobject

Matriz de rótutlos traduzidos a serem exibidos na interface de pagamento.

label.​arstring

Árabe.

label.​bgstring

Búlgaro.

label.​cnstring

Chinês (Simplificado).

label.​csstring

Tcheco.

label.​destring

Alemão.

label.​enstring

Inglês.

label.​esstring

Espanhol.

label.​frstring

Francês.

label.​hestring

Hebreu.

label.​itstring

Italiano.

label.​jastring

Japonês.

label.​kostring

Coreano.

label.​plstring

Polonês.

label.​ptstring

Português.

label.​rostring

Romeno.

label.​rustring

Russo.

label.​thstring

Tailandês.

label.​trstring

Turco.

label.​twstring

Chinês (Tradicional).

label.​vistring

Vietnamita.

nameobject

Matriz de nomes de promoções traduzidas.

name.​arstring

Árabe.

name.​bgstring

Búlgaro.

name.​cnstring

Chinês (Simplificado).

name.​csstring

Tcheco.

name.​destring

Alemão.

name.​enstring

Inglês.

name.​esstring

Espanhol.

name.​frstring

Francês.

name.​hestring

Hebreu.

name.​itstring

Italiano.

name.​jastring

Japonês.

name.​kostring

Coreano.

name.​plstring

Polonês.

name.​ptstring

Português.

name.​rostring

Romeno.

name.​rustring

Russo.

name.​thstring

Tailandês.

name.​trstring

Turco.

name.​twstring

Chinês (Tradicional).

name.​vistring

Vietnamita.

project_idintegerobrigatório

ID de projeto.

technical_namestringobrigatório

Nome técnico da promoção.

enabledboolean
idinteger
read_onlyboolean
show_bannerboolean
curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/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"
  }'

Respostas

Criado.

Corpoapplication/json
idinteger

ID de promoção.

Resposta
application/json
{ "id": 17890 }

Pedido

Exclui uma promoção. Você só pode excluir promoções com enabled = false.

Aviso

Esta chamada de API não contém o trajeto-parâmetro project_id, então é preciso usar a chave API que for válida em todos os projetos da empresa para configurar a autorização.

Segurança
basicAuth
Caminho
merchant_idintegerobrigatório

ID de comerciante.

promotion_idintegerobrigatório

ID de promoção.

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

Respostas

Nenhum conteúdo.

Pedido

Recupera uma promoção.

Aviso

Esta chamada de API não contém o trajeto-parâmetro project_id, então é preciso usar a chave API que for válida em todos os projetos da empresa para configurar a autorização.

Segurança
basicAuth
Caminho
merchant_idintegerobrigatório

ID de comerciante.

promotion_idintegerobrigatório

ID de promoção.

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

Respostas

OK.

Corpoapplication/json
descriptionobject

Matriz de descrições de promoções traduzidas.

description.​arstring

Árabe.

description.​bgstring

Búlgaro.

description.​cnstring

Chinês (Simplificado).

description.​csstring

Tcheco.

description.​destring

Alemão.

description.​enstring

Inglês.

description.​esstring

Espanhol.

description.​frstring

Francês.

description.​hestring

Hebreu.

description.​itstring

Italiano.

description.​jastring

Japonês.

description.​kostring

Coreano.

description.​plstring

Polonês.

description.​ptstring

Português.

description.​rostring

Romeno.

description.​rustring

Russo.

description.​thstring

Tailandês.

description.​trstring

Turco.

description.​twstring

Chinês (Tradicional).

description.​vistring

Vietnamita.

labelobject

Matriz de rótutlos traduzidos a serem exibidos na interface de pagamento.

label.​arstring

Árabe.

label.​bgstring

Búlgaro.

label.​cnstring

Chinês (Simplificado).

label.​csstring

Tcheco.

label.​destring

Alemão.

label.​enstring

Inglês.

label.​esstring

Espanhol.

label.​frstring

Francês.

label.​hestring

Hebreu.

label.​itstring

Italiano.

label.​jastring

Japonês.

label.​kostring

Coreano.

label.​plstring

Polonês.

label.​ptstring

Português.

label.​rostring

Romeno.

label.​rustring

Russo.

label.​thstring

Tailandês.

label.​trstring

Turco.

label.​twstring

Chinês (Tradicional).

label.​vistring

Vietnamita.

nameobject

Matriz de nomes de promoções traduzidas.

name.​arstring

Árabe.

name.​bgstring

Búlgaro.

name.​cnstring

Chinês (Simplificado).

name.​csstring

Tcheco.

name.​destring

Alemão.

name.​enstring

Inglês.

name.​esstring

Espanhol.

name.​frstring

Francês.

name.​hestring

Hebreu.

name.​itstring

Italiano.

name.​jastring

Japonês.

name.​kostring

Coreano.

name.​plstring

Polonês.

name.​ptstring

Português.

name.​rostring

Romeno.

name.​rustring

Russo.

name.​thstring

Tailandês.

name.​trstring

Turco.

name.​twstring

Chinês (Tradicional).

name.​vistring

Vietnamita.

project_idinteger

ID de projeto.

technical_namestring

Nome técnico da promoção.

enabledboolean
idinteger
read_onlyboolean
show_bannerboolean
Resposta
application/json
{ "description": { "en": "Promotion with 30% discount", "ru": "Акция со скидкой 30%" }, "enabled": false, "id": 17890, "label": { "en": "30%", "ru": "30%" }, "name": { "en": "30% discount", "ru": "Скидка 30%" }, "project_id": 40544, "read_only": false, "show_banner": true, "technical_name": "Sale promotion" }
Operações
Operações