⚡
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. Pedidos

Coupons

Remover Cupom

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

Listar Cupons

get
Autorizações
Parâmetros de consulta
searchstringOpcionalDefault: ""
pageinteger · int32OpcionalDefault: 0
perPageinteger · int32OpcionalDefault: 25
sortstringOpcionalDefault: ""
dirstringOpcionalDefault: asc
Respostas
200
OK
application/json
404
Coupon was not found
application/json
500
An internal server error was thrown
application/json
get
GET /api/sales/coupons HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Accept: */*
{
  "id": "text",
  "name": "text",
  "code": "text",
  "value_type": "MONETARY",
  "coupon_use_limit": 1,
  "coupon_used_quantity": 1,
  "status": "INACTIVE",
  "start_date": "2025-05-18T09:44:20.547Z",
  "end_date": "2025-05-18T09:44:20.547Z"
}
  • GETObter Cupom
  • PUTAtualizar Cupom
  • DELETERemover Cupom
  • GETListar Cupons
  • POSTCriar Cupom

Obter Cupom

get
Autorizações
Parâmetros de rota
idstringObrigatório
Respostas
200
OK
application/json
404
Coupon was not found
application/json
500
An internal server error was thrown
application/json
get
GET /api/sales/coupons/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Accept: */*
{
  "id": "text",
  "is_active": true,
  "type": "ORDER_VALUE",
  "name": "text",
  "code": "text",
  "value_type": "MONETARY",
  "value": 1,
  "partner_use_limit": 1,
  "coupon_use_limit": 1,
  "start_date": "2025-05-18T09:44:20.547Z",
  "end_date": "2025-05-18T09:44:20.547Z",
  "minimum_items_quantity": 1,
  "minimum_items_value": 1,
  "only_available_for_mobile_app": true,
  "maximum_discount_value": 1,
  "only_available_for_first_sale": true,
  "allowed_with_free_shipping_discount": true,
  "allowed_with_product_discount": true,
  "allowed_with_order_value_discount": true,
  "maximum_cumulative_discount_value": 1,
  "is_partner_specific": true,
  "partners": [
    {
      "id": "text",
      "partner_id": "text",
      "partner_name": "text"
    }
  ],
  "is_company_specific": true,
  "companies": [
    {
      "id": "text",
      "company_id": "text",
      "name": "text"
    }
  ],
  "is_payment_method_specific": true,
  "payment_methods": [
    {
      "id": "text",
      "payment_method_id": "text"
    }
  ]
}

Atualizar Cupom

put
Autorizações
Parâmetros de rota
idstringObrigatório
Corpo
is_activebooleanObrigatório
typestring · enumObrigatórioValores possíveis:
namestringObrigatório
codestringOpcional
value_typestring · enumObrigatórioValores possíveis:
valuenumberObrigatório
partner_use_limitinteger · int32Opcional
coupon_use_limitinteger · int32Opcional
start_datestring · dateOpcional
end_datestring · dateOpcional
minimum_items_quantitynumberObrigatório
minimum_items_valuenumberObrigatório
only_available_for_mobile_appbooleanObrigatório
maximum_discount_valuenumberOpcional
only_available_for_first_salebooleanObrigatório
allowed_with_free_shipping_discountbooleanObrigatório
allowed_with_product_discountbooleanObrigatório
allowed_with_order_value_discountbooleanObrigatório
maximum_cumulative_discount_valuenumberOpcional
is_partner_specificbooleanObrigatório
is_company_specificbooleanObrigatório
is_payment_method_specificbooleanObrigatório
Respostas
201
Coupon updated successfully
application/json
422
A validation error was thrown
application/json
500
An internal server error was thrown
application/json
put
PUT /api/sales/coupons/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 749

{
  "is_active": true,
  "type": "ORDER_VALUE",
  "name": "text",
  "code": "text",
  "value_type": "MONETARY",
  "value": 1,
  "partner_use_limit": 1,
  "coupon_use_limit": 1,
  "start_date": "2025-05-18",
  "end_date": "2025-05-18",
  "minimum_items_quantity": 1,
  "minimum_items_value": 1,
  "only_available_for_mobile_app": true,
  "maximum_discount_value": 1,
  "only_available_for_first_sale": true,
  "allowed_with_free_shipping_discount": true,
  "allowed_with_product_discount": true,
  "allowed_with_order_value_discount": true,
  "maximum_cumulative_discount_value": 1,
  "is_partner_specific": true,
  "partners": [
    {
      "id": "text",
      "partner_id": "text"
    }
  ],
  "is_company_specific": true,
  "companies": [
    {
      "id": "text",
      "company_id": "text"
    }
  ],
  "is_payment_method_specific": true,
  "payment_methods": [
    {
      "id": "text",
      "payment_method_id": "text"
    }
  ]
}
{
  "id": "text"
}

Criar Cupom

post
Autorizações
Corpo
idstringOpcional
is_activebooleanObrigatório
typestring · enumObrigatórioValores possíveis:
namestringObrigatório
codestringOpcional
value_typestring · enumObrigatórioValores possíveis:
valuenumberObrigatório
partner_use_limitinteger · int32Opcional
coupon_use_limitinteger · int32Opcional
start_datestring · dateOpcional
end_datestring · dateOpcional
minimum_items_quantitynumberObrigatório
minimum_items_valuenumberObrigatório
only_available_for_mobile_appbooleanObrigatório
maximum_discount_valuenumberOpcional
only_available_for_first_salebooleanObrigatório
allowed_with_free_shipping_discountbooleanObrigatório
allowed_with_product_discountbooleanObrigatório
allowed_with_order_value_discountbooleanObrigatório
maximum_cumulative_discount_valuenumberOpcional
is_partner_specificbooleanObrigatório
is_company_specificbooleanObrigatório
is_payment_method_specificbooleanObrigatório
Respostas
201
Coupon 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/coupons HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 761

{
  "id": "text",
  "is_active": true,
  "type": "ORDER_VALUE",
  "name": "text",
  "code": "text",
  "value_type": "MONETARY",
  "value": 1,
  "partner_use_limit": 1,
  "coupon_use_limit": 1,
  "start_date": "2025-05-18",
  "end_date": "2025-05-18",
  "minimum_items_quantity": 1,
  "minimum_items_value": 1,
  "only_available_for_mobile_app": true,
  "maximum_discount_value": 1,
  "only_available_for_first_sale": true,
  "allowed_with_free_shipping_discount": true,
  "allowed_with_product_discount": true,
  "allowed_with_order_value_discount": true,
  "maximum_cumulative_discount_value": 1,
  "is_partner_specific": true,
  "partners": [
    {
      "id": "text",
      "partner_id": "text"
    }
  ],
  "is_company_specific": true,
  "companies": [
    {
      "id": "text",
      "company_id": "text"
    }
  ],
  "is_payment_method_specific": true,
  "payment_methods": [
    {
      "id": "text",
      "payment_method_id": "text"
    }
  ]
}
{
  "id": "text"
}