Sign in

v1

latestOpenAPI 3.0.02026-07-26376212496.4 KB
Descontos

Criar um desconto da loja

Cria um desconto na loja

post/{alias}/discounts

Path parameters

aliasstring required

Alias da loja

Request body

namestring required

Nome do desconto.

codestring nullable

Código do desconto.

automaticboolean

Define se o desconto é automático.

store_idinteger

ID da loja.

discount_method'percent' | 'amount' required

Método de desconto.

discount_valuenumber float required

Valor do desconto. Se percentual, o máximo é 100.

discount_type'buy_x_get_y' | 'by_payment_method' required

Tipo do desconto.

entry_condition_type'amount' | 'quantity' required

Tipo de condição para aplicar o desconto.

accumulateboolean required

Define se o desconto pode acumular com outras promoções.

start_atstring date-time required

Data e hora de início

end_atstring date-time

Data e hora de término

Example request

{
  "name": "Promoção de Outubro",
  "code": "OCTOBERTAMPO25",
  "automatic": true,
  "store_id": 1319250,
  "discount_method": "percent",
  "discount_value": 20,
  "discount_type": "buy_x_get_y",
  "entry_condition_type": "amount",
  "entry_condition_value": 1,
  "start_at": "2025-06-01 00:00:00",
  "end_at": "2025-08-10 00:00:00",
  "restrictions": {
    "include": {
      "brands_ids": [
        1,
        2,
        3
      ],
      "products_ids": [
        5,
        6
      ],
      "categories_ids": [
        10,
        11
      ],
      "collections_ids": [
        20,
        21
      ]
    }
  },
  "specifications": {
    "payment_method_type": "pix",
    "set_cart_usage_limit": true,
    "cart_usage_limit": 1,
    "get_products_quantity": 1,
    "restrictions": {
      "include": {
        "brands_ids": [
          11
        ],
        "products_ids": [
          51
        ],
        "categories_ids": [
          4
        ],
        "collections_ids": [
          9
        ]
      }
    }
  }
}

Response

Detalhes do desconto

idinteger
store_idinteger
discount_type_idinteger
namestring
entry_condition_typestring
entry_condition_valuenumber
discount_methodstring
discount_valuenumber
discount_typestring
accumulateboolean

Example response

{
  "id": 1520,
  "store_id": 1319250,
  "discount_type_id": 1520,
  "name": "Lucas",
  "entry_condition_type": "amount",
  "entry_condition_value": 10,
  "discount_method": "percent",
  "discount_value": 100,
  "discount_type": "buy_x_get_y",
  "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"
  }
}