v1

latestOpenAPI 3.0.02026-07-26376212496.4 KB

Promoções - Cupons de desconto

Visualizar cupom

Obtém detalhes de um cupom de desconto específico

get/{alias}/pricing/promocodes/{id}

Path parameters

aliasstring required

Alias da loja

idinteger required

ID do cupom

Query parameters

includestring[]

Incluir relacionamentos adicionais

[
  "?include=customer,products"
]

Response

Detalhes do cupom

idinteger

codestring

descriptionstring

customer_idinteger

activeboolean

expiredboolean

discount_type'p' | 'v'

for_the_price_ofboolean

cart_defaultboolean

type_increment_valuestring

valuenumber float

price_productsnumber float

percent_productsnumber float

quantityinteger

total_customers_usedinteger

product_quantityinteger

product_max_quantityinteger

usedinteger

items_countinteger

min_valuenumber float

use_percentnumber float

shipment_percentnumber float

accumulateboolean

once_per_customerboolean

abandoned_cartboolean

newsletterboolean

payments_idsstring

free_shipmentboolean

ignore_promotion_productsboolean

include_idsinteger[]

Lista de IDs para inclusão

exclude_idsinteger[]

Lista de IDs para exclusão

Example response

{
  "code": "TEST",
  "value": 10,
  "used": 22,
  "min_value": 99.99,
  "use_percent": 0.02,
  "payments_ids": "[1, 2, 3, 4]",
  "start_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "end_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "created_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "updated_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  }
}