APIs para Wholesale Pricing

Este documento descreve como usar a API pública para obter a lista de registros de Wholesale Pricing do aplicativo Samita Wholesale.

---

1. Endpoint

Para obter a lista de Wholesale Pricing, use o seguinte endpoint da API:

GET - https://wholesale.samita.io/api/v1/wholesale-pricings

---

2. Cabeçalhos da requisição

Todas as requisições à API devem incluir os seguintes cabeçalhos obrigatórios:

Cabeçalho	Descrição	Obrigatório
X-SAMITA-API-KEY	Chave de API fornecida no app Wholesale	Sim
X-SAMITA-SHOP-URL	Domínio da loja Shopify no formato xxx.myshopify.com	Sim
CONTENT-TYPE	Deve ser application/json	Sim

Se algum desses cabeçalhos estiver ausente, a requisição será rejeitada.

---

3. Parâmetros da requisição (query / corpo)

Os seguintes parâmetros podem ser incluídos para personalizar a requisição à API:

Parâmetro	Descrição	Obrigatório
limit	Define o número máximo de registros retornados em uma requisição	Não
query	Usado para buscar registros por título ou ID	Não
status	Usado para filtrar registros por status	Não
sort	Usado para ordenar registros pela data de criação	Não

a. limit

• Define o número máximo de registros retornados em uma requisição
• Deve ser um valor numérico
• Valor mínimo: 1
• Valor máximo: 20
• Parâmetro opcional
• Se ficar vazio, o valor padrão será 20

Exemplo:

limit=10

---

b. query

• Usado para buscar registros por título ou ID
• Deve ser um valor de texto (string)
• Tamanho máximo: 255 caracteres
• Parâmetro opcional

Exemplo:

query=pricing rule

---

c. status

• Usado para filtrar registros por status
• Parâmetro opcional
• Se ficar vazio, a API retornará todos os registros
• Se informado, apenas os seguintes valores são aceitos:

Valor	Descrição
active	Somente registros ativos
draft	Somente registros em rascunho

Qualquer outro valor será rejeitado.

Exemplo:

status=active

---

d. sort

• Usado para ordenar registros pela data de criação
• Parâmetro opcional
• Se ficar vazio, os registros serão ordenados do mais recente para o mais antigo
• Apenas dois valores são aceitos:

Valor	Descrição
descrease	Ordena do mais recente para o mais antigo
ascrease	Ordena do mais antigo para o mais recente

Exemplo:

sort=descrease

---

Exemplo de requisição:

GET /wholesale-pricing?page=1&limit=20&status=active&sort=descrease

4. Resposta da API

A API retornará um dos seguintes códigos de status HTTP:

a. Respostas de erro

401 – Unauthorized

Este erro ocorre quando a requisição não está autenticada corretamente.

Possíveis motivos:

• URL da loja ausente
• Chave de API ausente
• URL da loja incorreta
• Chave de API incorreta
• A chave de API não corresponde à loja informada

---

403 – This action is unauthorized

Este erro ocorre quando a chave de API não tem permissões suficientes.

Cada chave de API pode receber as seguintes permissões:

• View
• Create
• Update
• Delete

A API de listagem de Wholesale Pricing exige a permissão View.
Se a chave de API não tiver a permissão View, este erro será retornado.

---

429 – Too Many Requests

Este erro ocorre quando a requisição excede o limite de requisições permitido.

Limites de requisições atuais:

• No máximo 1 requisição a cada 5 minutos
• No máximo 50 requisições por dia

Se esses limites forem excedidos, o sistema retornará este erro.

---

b. Resposta de sucesso

200 – API Success

• A requisição é válida
• A autenticação foi bem-sucedida
• Os dados são retornados corretamente
• A lista de Wholesale Pricing é fornecida em formato JSON

---

Exemplo de sucesso da API:

[
  {
    "id": 1,
    "title": "New Wholesale Pricing",
    "status": true,
    "apply_customer": {
      "type": "all",
      "tags": []
    },
    "exclude_customer": {
      "type": "none",
      "tags": []
    },
    "apply_product": {
      "type": "all",
      "product_ids": [],
      "product_tags": [],
      "collection_ids": [],
      "apply_for_variants": false
    },
    "exclude_product": {
      "type": "none",
      "product_ids": [],
      "collection_ids": []
    },
    "discount_for_variants": [
      {
        "id": 8516448190631,
        "variant_pricing": true,
        "variants": [
          {
            "id": 46747346763943,
            "discount_groups": [
              {
                "name": "all",
                "type": "percent",
                "value": "10"
              }
            ]
          }
        ]
      }
    ],
    "apply_market": {
      "type": "all",
      "handle": []
    },
    "discount_group": {
      "type": "percent",
      "value": "10"
    },
    "active_date": {
      "types": [],
      "start_at": "",
      "end_at": ""
    },
    "created_at": "2026-01-15T10:00:00",
    "updated_at": "2026-01-15T10:00:00"
  }
]