APIs para Volume Pricing

Este documento explica como obter uma lista de registros de Volume Pricing usando a API pública.

---

1. Endpoint

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

Este endpoint permite obter uma lista de registros de Volume Pricing com base em parâmetros de filtro e ordenação.

---

2. Cabeçalhos da requisição

Todas as requisições 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 cabeçalho obrigatório estiver ausente ou for inválido, a requisição será rejeitada.

---

3. Parâmetros da requisição

A requisição GET aceita os seguintes parâmetros de query opcionais:

---

a. limit

Define o número máximo de registros retornados.

• Deve ser um número
• Valor mínimo: 1
• Valor máximo: 20
• Se ficar vazio, o valor padrão é 20

Exemplo:

?limit=10

---

b. query

Texto de busca usado para filtrar registros por título ou ID.

• Deve ser uma string
• Tamanho máximo: 255 caracteres

Exemplo:

?query=pricing rule

---

c. status

Filtra os registros por status.

• Pode ficar vazio para obter todos os registros

• Se informado, apenas os seguintes valores são aceitos:

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

Exemplo:

?status=active

---

d. sort

Ordena os registros pela data de criação.

• Pode ficar vazio (padrão: registros mais recentes primeiro)
• Se informado, aceita apenas um dos seguintes valores:
  • descrease
  • ascrease

Exemplo:

?sort=descrease

---

Exemplo de requisição completa

GET https://wholesale.samita.io/api/v1/volume-pricings?limit=10&status=active&sort=descrease

---

4. Resposta da API

---

4.1 Respostas de erro

401 – Unauthorized

Retornado quando a autenticação falha.

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

---

403 – This action is unauthorized

Retornado 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 List Volume Pricing API exige a permissão View.

---

429 – Too Many Requests

Retornado quando o limite de requisições é excedido.

Limites atuais:

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

---

4.2 Resposta de sucesso

200 – API Success

Retornado quando a requisição é válida e foi processada com sucesso.

A resposta retorna uma lista de registros de Volume Pricing em formato JSON.

---

Exemplo de sucesso da API:

[
  {
    "id": 1,
    "title": "New Volume Pricing",
    "status": true,
    "type": "quantity",
    "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,
        "duplicated": false,
        "variant_pricing": true,
        "from_qty": "0",
        "from_amount": "0",
        "to_qty": "10",
        "to_amount": "0",
        "discount_groups": [
          {
            "name": "all",
            "type": "percent",
            "value": "10"
          }
        ],
        "variants": [
          {
            "id": 46747346763943,
            "duplicated": false,
            "from_qty": "0",
            "from_amount": "0",
            "to_qty": "10",
            "to_amount": "0",
            "discount_groups": [
              {
                "name": "all",
                "type": "percent",
                "value": "10"
              }
            ]
          }
        ]
      }
    ],
    "apply_market": {
      "type": "all",
      "handle": []
    },
    "discount_method": "variant",
    "discount_groups": [
      {
        "from_qty": "0",
        "from_amount": "0",
        "to_qty": "10",
        "to_amount": "0",
        "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"
  }
]