Discounts

Retrieve an existing discount

get

Autorizações

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

idstringObrigatório

Respostas

200

OK

application/json

idstringOpcional

namestringOpcional

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

quantity_conditionstring · enumOpcionalValores possíveis:

404

Discount was not found

application/json

500

An internal server error was thrown

application/json

get/discounts/{id}

GET /api/sales/discounts/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "name": "text",
  "minimum_value": 1,
  "maximum_value": 1,
  "start_date": "2026-01-01",
  "end_date": "2026-01-01",
  "is_discount_over_discount": true,
  "criteria": [
    {
      "name": "text",
      "criteria_id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "FIXED",
      "products_quantity": 1,
      "criteria_type": "FILTER",
      "config": {
        "ANY_ADDITIONAL_PROPERTY": {
          "key": "text",
          "values": [
            "text"
          ],
          "type": "SQL",
          "config": "text"
        }
      }
    }
  ],
  "ranges": [
    {
      "minimum_quantity": 1,
      "type": "PERCENTAGE",
      "value": 1,
      "is_product_value": true
    }
  ],
  "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",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ],
  "is_payment_method": true,
  "payment_methods": [
    {
      "id": "text",
      "payment_method_id": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ],
  "is_active": true,
  "quantity_condition": "INDIVIDUAL",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

Update an existing discount

put

Autorizações

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

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

quantity_conditionstring · enumOpcionalValores possíveis:

Respostas

200

OK

application/json

idstringOpcional

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/discounts/{id}

PUT /api/sales/discounts/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 687

{
  "name": "text",
  "minimum_value": 1,
  "maximum_value": 1,
  "start_date": "2026-01-01",
  "end_date": "2026-01-01",
  "is_discount_over_discount": true,
  "is_partner": true,
  "partners": [
    {
      "id": "text",
      "partner_id": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ],
  "is_profile": true,
  "profiles": [
    {
      "id": "text",
      "profile_id": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ],
  "is_company": true,
  "companies": [
    {
      "id": "text",
      "company_id": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ],
  "is_payment_method": true,
  "payment_methods": [
    {
      "id": "text",
      "payment_method_id": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ],
  "is_active": true,
  "quantity_condition": "INDIVIDUAL",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

{
  "id": "text"
}

Remove an existing discount

delete

Autorizações

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

idstringObrigatório

Respostas

204

OK

Sem conteúdo

404

PriceTable was not removed

500

An internal server error was thrown

delete/discounts/{id}

DELETE /api/sales/discounts/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

Sem conteúdo

Retrieve a page of discounts

get

Autorizações

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de consulta

searchstringOpcionalDefault: ""

pageinteger · int32OpcionalDefault: 0

perPageinteger · int32OpcionalDefault: 25

sortstringOpcionalDefault: ""

dirstringOpcionalDefault: asc

Respostas

200

OK

application/json

currentPageinteger · int32Opcional

perPageinteger · int32Opcional

totalinteger · int64Opcional

404

Discount was not found

application/json

500

An internal server error was thrown

application/json

get/discounts

GET /api/sales/discounts HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
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": "2026-01-01",
      "end_date": "2026-01-01"
    }
  ]
}

Create a new discount

post

Autorizações

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

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

quantity_conditionstring · enumOpcionalValores possíveis:

Respostas

201

Discount created successfully

application/json

idstringOpcional

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

post/discounts

POST /api/sales/discounts HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 699

{
  "id": "text",
  "name": "text",
  "minimum_value": 1,
  "maximum_value": 1,
  "start_date": "2026-01-01",
  "end_date": "2026-01-01",
  "is_discount_over_discount": true,
  "is_partner": true,
  "partners": [
    {
      "id": "text",
      "partner_id": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ],
  "is_profile": true,
  "profiles": [
    {
      "id": "text",
      "profile_id": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ],
  "is_company": true,
  "companies": [
    {
      "id": "text",
      "company_id": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ],
  "is_payment_method": true,
  "payment_methods": [
    {
      "id": "text",
      "payment_method_id": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ],
  "is_active": true,
  "quantity_condition": "INDIVIDUAL",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

{
  "id": "text"
}