Discounts

Retrieve an existing discount

get
Autorizações
Parâmetros de rota
idstringObrigatório
Respostas
200
OK
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-07-03T08:18:31.222Z",
  "end_date": "2025-07-03T08:18:31.222Z",
  "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
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-07-03",
  "end_date": "2025-07-03",
  "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"
}

Remove an existing discount

delete
Autorizações
Parâmetros de rota
idstringObrigatório
Respostas
204
OK
application/json
Respostaobject
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
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-07-03T08:18:31.222Z",
      "end_date": "2025-07-03T08:18:31.222Z"
    }
  ]
}

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
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-07-03",
  "end_date": "2025-07-03",
  "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"
}