Pular para o conteúdo
ShopentlyLearn

Descontos · Listar

Descontos · Listar. Todos os códigos devem permitir combinações. Os descontos são aplicados em ordem.

GET/api/v1/discounts/coupons

Autenticação
Bearer
Disponível a partir de
STANDARD
Permissões necessárias
discounts.coupons:read

Exemplos de código

Exemplo de requisição

cURL

: "${SHOPENTLY_SHOP_URL:?}"

curl --disable --globoff --fail-with-body --silent --show-error \
  --proto '=https' --connect-timeout 5 --max-time 30 \
  --request GET \
  --header "Authorization: Bearer ${SHOPENTLY_ACCESS_TOKEN:?}" \
  --url "${SHOPENTLY_SHOP_URL%/}"/api/v1/discounts/coupons

PHP

<?php
declare(strict_types=1);

$baseUrl = rtrim(getenv('SHOPENTLY_SHOP_URL') ?: '', '/');
$origin = parse_url($baseUrl);
if (!$origin || ($origin['scheme'] ?? '') !== 'https' || empty($origin['host']) ||
    isset($origin['user'], $origin['pass']) || isset($origin['user']) || isset($origin['path']) ||
    isset($origin['query']) || isset($origin['fragment'])) {
    throw new RuntimeException('SHOPENTLY_SHOP_URL must be an HTTPS origin');
}
$credential = getenv('SHOPENTLY_ACCESS_TOKEN') ?: '';
if ($credential === '' || strpbrk($credential, "\r\n") !== false) {
    throw new RuntimeException('Invalid credential');
}
$headers = [];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/discounts/coupons');
curl_setopt_array($handle, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_FOLLOWLOCATION => false,
    CURLOPT_PROTOCOLS => CURLPROTO_HTTPS,
    CURLOPT_SSL_VERIFYPEER => true,
    CURLOPT_SSL_VERIFYHOST => 2,
    CURLOPT_CONNECTTIMEOUT => 5,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HEADERFUNCTION => static function ($handle, string $line) use (&$responseHeaders): int {
        if (str_contains($line, ':')) {
            [$name, $value] = explode(':', $line, 2);
            $responseHeaders[strtolower(trim($name))] = trim($value);
        }
        return strlen($line);
    },
]);
$raw = curl_exec($handle);
$status = curl_getinfo($handle, CURLINFO_RESPONSE_CODE);
$error = curl_error($handle);
curl_close($handle);
if ($raw === false) {
    throw new RuntimeException('Transport error: ' . $error);
}
if ($status < 200 || $status >= 300) {
    throw new RuntimeException('HTTP ' . $status . '; request_id=' .
        ($responseHeaders['x-request-id'] ?? '') . '; retry_after=' . ($responseHeaders['retry-after'] ?? ''));
}
$result = $raw === '' ? null : json_decode($raw, true, 512, JSON_THROW_ON_ERROR | JSON_BIGINT_AS_STRING);
echo json_encode($result, JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE), PHP_EOL;

Python

from contextlib import ExitStack
import json
import os
from urllib.parse import urlsplit

import requests  # python -m pip install requests

base_url = os.environ["SHOPENTLY_SHOP_URL"].rstrip("/")
origin = urlsplit(base_url)
if origin.scheme != "https" or not origin.hostname or origin.username or origin.password or origin.path or origin.query or origin.fragment:
    raise ValueError("SHOPENTLY_SHOP_URL must be an HTTPS origin")
credential = os.environ['SHOPENTLY_ACCESS_TOKEN']
if not credential or "\r" in credential or "\n" in credential:
    raise ValueError("Invalid credential")
headers = {}
headers["Authorization"] = 'Bearer' + " " + credential
body = None
if body is not None:
    headers["Content-Type"] = "application/json"

with ExitStack() as stack:
    session = stack.enter_context(requests.Session())
    files = None
    if False:
        image = stack.enter_context(open(os.environ["SHOPENTLY_IMAGE_FILE"], "rb"))
        if os.fstat(image.fileno()).st_size > 5242880:
            raise ValueError("Image exceeds 5 MiB")
        files = {"file": ("article.png", image, "image/png")}
    response = session.request(
        'GET', base_url + '/api/v1/discounts/coupons', headers=headers,
        data=body.encode("utf-8") if body is not None else None, files=files,
        timeout=(5, 30), allow_redirects=False,
    )
    if not 200 <= response.status_code < 300:
        raise RuntimeError(f"HTTP {response.status_code}; request_id={response.headers.get('X-Request-ID', '')}; retry_after={response.headers.get('Retry-After', '')}")
    if False:
        if response.headers.get("Content-Type") != "image/webp" or len(response.content) > 5242880:
            raise ValueError("Unexpected image response")
        with open(os.environ["SHOPENTLY_OUTPUT_FILE"], "xb") as output:
            output.write(response.content)
    else:
        result = response.json() if response.content else None
        print(json.dumps(result, ensure_ascii=False, indent=2))

Exemplo de resposta 200

JSON
{
  "data": [],
  "meta": {
    "locale": "example",
    "market_code": "example",
    "market_id": "poland",
    "pagination": {
      "has_more": false,
      "limit": 1,
      "next_cursor": null
    },
    "request_id": "learn-example-request"
  }
}

Visão geral

São incluídos os produtos e categorias selecionados. As categorias incluem produtos atribuídos diretamente.

Parâmetros

Parâmetros de consulta

limitNúmero inteiroOpcional

Número máximo de registros nesta página.

minimum: 1maximum: 100
Padrão: 50
cursorTexto nullOpcional

Valor opaco de continuação retornado pela página anterior.

Texto:minLength: 1maxLength: 1024
market_idTexto nullOpcional

Identificador do mercado retornado pelo endpoint de contexto.

Restrições · Texto 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"

Esta operação não aceita um corpo JSON.

Respostas

Resposta 200

dataLista <CampaignData > Obrigatório

Conteúdo de uma resposta bem-sucedida.

Campos · data

CampaignData

audienceTextoOpcional

Clientes

Restrições
enum
["all", "guest", "customer", "selected"]

Padrão: "all"

benefit_typeTextoOpcional

Variante da estrutura de dados definida pelos valores permitidos.

Restrições
enum
["percentage", "fixed", "none"]

Padrão: "percentage"

category_idsLista <Texto> Opcional

Identificadores das categorias relacionadas.

maxItems: 1000
Restrições · Lista 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
codeTexto nullOpcional

Código estável legível por programas.

Restrições · Texto 1
pattern
"^[A-Za-z0-9]{6,16}$"
combine_couponsBooleanoOpcional

Combinar com outros códigos

Padrão: false

combine_promotionsBooleanoOpcional

Permitir este código em produtos com promoções automáticas

Padrão: false

created_atTextoObrigatório

Momento da criação.

format: "date-time"
created_byCreatorData Obrigatório

Criado por

customer_idsLista <Texto> Opcional

Informações do cliente registradas para este recurso.

maxItems: 1000
Restrições · Lista 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
enabledBooleanoObrigatório

Indica se esta configuração está habilitada.

ends_atTexto nullOpcional

Ativo até

Texto:format: "date-time"
free_shippingBooleanoOpcional

Frete grátis

Padrão: false

idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado.

kindTextoObrigatório

Variante da estrutura de dados definida pelos valores permitidos.

Restrições
enum
["coupon", "promotion"]
marketsLista <shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData > Obrigatório

Mercados disponíveis no contexto da loja.

minItems: 1maxItems: 1000
minimum_quantityNúmero inteiroOpcional

Número mínimo de itens no carrinho

minimum: 1maximum: 2147483647

Padrão: 1

nameTextoObrigatório

Nome do recurso no contexto correspondente.

minLength: 1maxLength: 160
per_customer_limitNúmero inteiroOpcional

Limite de utilizações por cliente

minimum: -1maximum: 2147483647

Padrão: -1

percentageTextoOpcional

Porcentagem

maxLength: 19
Restrições
pattern
"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"

Padrão: "10"

product_idsLista <Texto> Opcional

Identificadores dos produtos relacionados.

maxItems: 1000
Restrições · Lista 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
product_scopeTextoOpcional

Produtos

Restrições
enum
["all", "selected"]

Padrão: "all"

show_accountBooleanoOpcional

Na conta do cliente

Padrão: false

show_cartBooleanoOpcional

No carrinho

Padrão: false

show_productBooleanoOpcional

Nas páginas dos produtos

Padrão: false

starts_atTexto nullOpcional

Ativo a partir de

Texto:format: "date-time"
updated_atTextoObrigatório

Momento da atualização mais recente.

format: "date-time"
usage_limitNúmero inteiroOpcional

Limite de utilizações

minimum: -1maximum: 2147483647

Padrão: -1

used_countNúmero inteiroObrigatório

Utilizações realizados

versionNúmero inteiroObrigatório

Versão do recurso utilizada para controle de concorrência.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obrigatório

Metadados da resposta.

Campos · meta

ContextPageMeta

localeTextoObrigatório

Idioma selecionado para esta requisição.

market_codeTextoObrigatório

Código do mercado retornado pelo endpoint de contexto.

market_idTextoObrigatório

Identificador do mercado retornado pelo endpoint de contexto.

paginationPagination Obrigatório

Metadados da paginação por cursor.

request_idTextoObrigatório

Identificador da solicitação; nos metadados da resposta identifica a requisição HTTP.

minLength: 1maxLength: 100

ContextMeta

localeTextoObrigatório

Idioma selecionado para esta requisição.

market_codeTextoObrigatório

Código do mercado retornado pelo endpoint de contexto.

market_idTextoObrigatório

Identificador do mercado retornado pelo endpoint de contexto.

request_idTextoObrigatório

Identificador da solicitação; nos metadados da resposta identifica a requisição HTTP.

minLength: 1maxLength: 100

PageMeta

paginationPagination Obrigatório

Metadados da paginação por cursor.

request_idTextoObrigatório

Identificador da solicitação; nos metadados da resposta identifica a requisição HTTP.

minLength: 1maxLength: 100

RequestMeta

request_idTextoObrigatório

Identificador da solicitação; nos metadados da resposta identifica a requisição HTTP.

minLength: 1maxLength: 100
Exemplo de resposta

Estado HTTP

200
Resposta bem-sucedida Esquema
400
Requisição inválida
401
Autenticação necessária
403
Permissão negada
404
Recurso não encontrado
409
Conflito de versão
422
Falha na validação
429
Limite de requisições excedido
Outros status HTTP (7)
405
Método não permitido
413
Requisição muito grande
415
Formato não suportado
500
Erro do servidor
502
Erro do gateway da API
503
Serviço indisponível
504
Tempo de espera excedido

Catálogo de erros: ErrorResponse

Cabeçalhos

401

WWW-AuthenticateTextoOpcional

Esquema de autenticação exigido pelo servidor.

405

AllowTextoOpcional

Métodos HTTP aceitos por este recurso.

429, 503

Retry-AfterNúmero inteiroOpcional

Espera mínima antes de tentar novamente, em segundos.

minimum: 0