⚡
Zydon
Uptime serviços Zydon
  • Bem-vindo à Zydon
  • Quickstart
    • Chaves de acesso
    • Autenticação
  • Cadastros Gerais
    • Profiles
      • Import
      • Get import spreadsheet
    • Sellers
      • Enable
      • Disable
      • Import
      • Get import spreadsheet
      • Partners
    • Companies
      • Import
      • Get import spreadsheet
    • Resource files
      • Details
    • Partners
      • Sellers
        • Import
        • Get import spreadsheet
      • Contact
      • Address
        • Import
        • Get import spreadsheet
      • Enable
      • Disable
      • Query
      • Import
      • Get import spreadsheet
      • Analysis
  • Produtos
    • Products
      • Variations
        • Import
        • Get import spreadsheet
      • Specification
        • Import
        • Get import spreadsheet
      • Images
      • Enable
      • Disable
      • Alternative units
        • Import
        • Get import spreadsheet
      • Search
        • Synchronize
        • Status
      • Main images
      • Import
      • Get import spreadsheet
      • Generate sku code
      • Similar
      • Recommended
      • Image
      • Analysis
        • Most sold
        • Highlight
    • Prices
      • Product
        • Calculate
    • Stock
      • Enable
      • Disable
      • Override
      • Movement
      • Query
    • Discounts
      • Products
    • Price tables
      • Copy
      • Products
    • Warehouses
      • Import
      • Get import spreadsheet
    • Brands
      • Enable
      • Disable
      • Import
      • Get import spreadsheet
      • Image
    • Categories
      • Order
      • Enable
      • Disable
      • Specification
        • Import
        • Get import spreadsheet
      • Import
      • Get import spreadsheet
      • Image
      • Has products
      • Tree
    • Variations
      • Values
      • Import
      • Get import spreadsheet
    • Measure units
      • Enable
      • Disable
      • Import
      • Get import spreadsheet
      • Description
    • Portal User Search
      • User
        • Search
  • Pedidos
    • Payment groups
    • Orders
      • Items
        • Import
        • Get import spreadsheet
      • Payments
        • Import
        • Get import spreadsheet
      • Joint
      • Attachments
      • Report
      • Invoices
      • Import
      • Get import spreadsheet
      • Status
      • Summary
    • Payment methods
      • Enable
      • Disable
      • Query
      • Import
      • Get import spreadsheet
    • Status
    • Coupons
      • Manual
      • Automatic
    • Sales
      • Statuses
        • Available
  • Financeiro
    • Financials
      • Attachments
      • Import
      • Get import spreadsheet
      • Order
  • Webhooks
    • Sincronização de dados
    • Envio de Pedido
    • Cadastro de Parceiro
  • About
  • API reference
    • Warehouses
      • Import
      • Get import spreadsheet
    • Variations
      • Values
      • Import
      • Get import spreadsheet
    • Status
    • Sellers
      • Enable
      • Disable
      • Import
      • Get import spreadsheet
      • Partners
    • Profiles
      • Import
      • Get import spreadsheet
    • Products
      • Variations
        • Import
        • Get import spreadsheet
      • Specification
        • Import
        • Get import spreadsheet
      • Images
      • Enable
      • Disable
      • Alternative units
        • Import
        • Get import spreadsheet
      • Search
        • Synchronize
        • Status
      • Main images
      • Import
      • Get import spreadsheet
      • Generate sku code
      • Similar
      • Recommended
      • Image
      • Analysis
        • Most sold
        • Highlight
    • Price tables
      • Copy
      • Products
    • Payment methods
      • Enable
      • Disable
      • Query
      • Import
      • Get import spreadsheet
    • Payment groups
    • Partners
      • Sellers
        • Import
        • Get import spreadsheet
      • Contact
      • Address
        • Import
        • Get import spreadsheet
      • Enable
      • Disable
      • Query
      • Import
      • Get import spreadsheet
      • Analysis
    • Orders
      • Items
        • Import
        • Get import spreadsheet
      • Payments
        • Import
        • Get import spreadsheet
      • Joint
      • Attachments
      • Report
      • Invoices
      • Import
      • Get import spreadsheet
      • Status
      • Summary
    • Measure units
      • Enable
      • Disable
      • Import
      • Get import spreadsheet
      • Description
    • Financials
      • Attachments
      • Import
      • Get import spreadsheet
      • Order
    • Discounts
      • Products
    • Coupons
      • Manual
      • Automatic
    • Companies
      • Import
      • Get import spreadsheet
    • Categories
      • Order
      • Enable
      • Disable
      • Specification
        • Import
        • Get import spreadsheet
      • Import
      • Get import spreadsheet
      • Image
      • Has products
      • Tree
    • Brands
      • Enable
      • Disable
      • Import
      • Get import spreadsheet
      • Image
    • Sales
      • Statuses
        • Available
    • Resource files
      • Details
    • Stock
      • Enable
      • Disable
      • Override
      • Movement
      • Query
    • Sales funnel
    • Template
      • Validate
      • Install
      • Export
    • Home
      • Sales
      • Sales by period
      • Products
      • Users
    • Prices
      • Product
        • Calculate
  • Specification
  • About
  • Specification
Fornecido por GitBook
Nesta página
  1. Produtos

Discounts

Remove an existing discount

delete
Autorizações
Parâmetros de rota
idstringObrigatório
Respostas
204
OK
application/json
Respostaobject
404
PriceTable was not removed
application/json
500
An internal server error was thrown
application/json
delete
DELETE /api/sales/discounts/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Accept: */*
{}

Retrieve a page of discounts

get
Autorizações
Parâmetros de consulta
searchstringOpcionalDefault: ""
pageinteger · int32OpcionalDefault: 0
perPageinteger · int32OpcionalDefault: 25
sortstringOpcionalDefault: ""
dirstringOpcionalDefault: asc
Respostas
200
OK
application/json
404
Discount was not found
application/json
500
An internal server error was thrown
application/json
get
GET /api/sales/discounts HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Accept: */*
{
  "currentPage": 1,
  "perPage": 1,
  "total": 1,
  "items": [
    {
      "id": "text",
      "name": "text",
      "partners_quantity": 1,
      "profiles_quantity": 1,
      "companies_quantity": 1,
      "payment_methods_quantity": 1,
      "start_date": "2025-05-18T09:11:30.940Z",
      "end_date": "2025-05-18T09:11:30.940Z"
    }
  ]
}
  • GETRetrieve an existing discount
  • PUTUpdate an existing discount
  • DELETERemove an existing discount
  • GETRetrieve a page of discounts
  • POSTCreate a new discount

Retrieve an existing discount

get
Autorizações
Parâmetros de rota
idstringObrigatório
Respostas
200
OK
application/json
404
Discount was not found
application/json
500
An internal server error was thrown
application/json
get
GET /api/sales/discounts/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Accept: */*
{
  "id": "text",
  "name": "text",
  "minimum_value": 1,
  "maximum_value": 1,
  "start_date": "2025-05-18T09:11:30.940Z",
  "end_date": "2025-05-18T09:11:30.940Z",
  "is_discount_over_discount": true,
  "criteria": [
    {
      "name": "text",
      "criteria_id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "FIXED",
      "ranges": [
        {
          "minimum_quantity": 1,
          "type": "PERCENTAGE",
          "value": 1,
          "is_product_value": true
        }
      ],
      "products_quantity": 1,
      "criteria_type": "FILTER"
    }
  ],
  "is_partner": true,
  "partners": [
    {
      "id": "text",
      "partner_id": "text",
      "partner_name": "text"
    }
  ],
  "is_profile": true,
  "profiles": [
    {
      "id": "text",
      "profile_id": "text"
    }
  ],
  "is_company": true,
  "companies": [
    {
      "id": "text",
      "company_id": "text",
      "company_name": "text"
    }
  ],
  "is_payment_method": true,
  "payment_methods": [
    {
      "id": "text",
      "payment_method_id": "text"
    }
  ],
  "is_active": true
}

Update an existing discount

put
Autorizações
Parâmetros de rota
idstringObrigatório
Corpo
namestringObrigatório
minimum_valuenumberOpcional
maximum_valuenumberOpcional
start_datestring · dateOpcional
end_datestring · dateOpcional
is_discount_over_discountbooleanOpcional
is_partnerbooleanOpcional
is_profilebooleanOpcional
is_companybooleanOpcional
is_payment_methodbooleanOpcional
is_activebooleanOpcional
Respostas
200
OK
application/json
404
Discount was not found
application/json
422
A validation error was thrown
application/json
500
An internal server error was thrown
application/json
put
PUT /api/sales/discounts/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 629

{
  "name": "text",
  "minimum_value": 1,
  "maximum_value": 1,
  "start_date": "2025-05-18",
  "end_date": "2025-05-18",
  "is_discount_over_discount": true,
  "criteria": [
    {
      "criteria_id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "FIXED",
      "ranges": [
        {
          "minimum_quantity": 1,
          "type": "PERCENTAGE",
          "value": 1,
          "is_product_value": true
        }
      ],
      "criteria_type": "FILTER"
    }
  ],
  "is_partner": true,
  "partners": [
    {
      "id": "text",
      "partner_id": "text"
    }
  ],
  "is_profile": true,
  "profiles": [
    {
      "id": "text",
      "profile_id": "text"
    }
  ],
  "is_company": true,
  "companies": [
    {
      "id": "text",
      "company_id": "text"
    }
  ],
  "is_payment_method": true,
  "payment_methods": [
    {
      "id": "text",
      "payment_method_id": "text"
    }
  ],
  "is_active": true
}
{
  "id": "text"
}

Create a new discount

post
Autorizações
Corpo
idstringOpcional
namestringObrigatório
minimum_valuenumberOpcional
maximum_valuenumberOpcional
start_datestring · dateOpcional
end_datestring · dateOpcional
is_discount_over_discountbooleanOpcional
is_partnerbooleanOpcional
is_profilebooleanOpcional
is_companybooleanOpcional
is_payment_methodbooleanOpcional
is_activebooleanOpcional
Respostas
201
Discount created successfully
application/json
422
A validation error was thrown
application/json
500
An internal server error was thrown
application/json
post
POST /api/sales/discounts HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 641

{
  "id": "text",
  "name": "text",
  "minimum_value": 1,
  "maximum_value": 1,
  "start_date": "2025-05-18",
  "end_date": "2025-05-18",
  "is_discount_over_discount": true,
  "criteria": [
    {
      "criteria_id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "FIXED",
      "ranges": [
        {
          "minimum_quantity": 1,
          "type": "PERCENTAGE",
          "value": 1,
          "is_product_value": true
        }
      ],
      "criteria_type": "FILTER"
    }
  ],
  "is_partner": true,
  "partners": [
    {
      "id": "text",
      "partner_id": "text"
    }
  ],
  "is_profile": true,
  "profiles": [
    {
      "id": "text",
      "profile_id": "text"
    }
  ],
  "is_company": true,
  "companies": [
    {
      "id": "text",
      "company_id": "text"
    }
  ],
  "is_payment_method": true,
  "payment_methods": [
    {
      "id": "text",
      "payment_method_id": "text"
    }
  ],
  "is_active": true
}
{
  "id": "text"
}