Discounts

Retrieve an existing discount

GEThttps://api.zydon.com.br/api/sales/discounts/{id}

Authorization

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

Path parameters

id*string

Response

200404500

OK

Body

application/json

idstring

namestring

minimum_valuenumber

maximum_valuenumber

start_datestring (date-time)

end_datestring (date-time)

is_discount_over_discountboolean

criteriaarray of RetrieveDiscountCriteriaResponse (object)

is_partnerboolean

partnersarray of RetrieveDiscountPartnerResponse (object)

is_profileboolean

profilesarray of RetrieveDiscountProfileResponse (object)

is_companyboolean

companiesarray of RetrieveDiscountCompanyResponse (object)

is_payment_methodboolean

payment_methodsarray of RetrieveDiscountPaymentMethodResponse (object)

is_activeboolean

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/discounts/{id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200404500

{
  "id": "text",
  "name": "text",
  "minimum_value": 0,
  "maximum_value": 0,
  "start_date": "2024-12-21T15:08:24.849Z",
  "end_date": "2024-12-21T15:08:24.849Z",
  "is_discount_over_discount": false,
  "criteria": [
    {
      "name": "text",
      "criteria_id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "FIXED",
      "ranges": [
        {
          "minimum_quantity": 0,
          "type": "PERCENTAGE",
          "value": 0,
          "is_product_value": false
        }
      ],
      "products_quantity": 0,
      "criteria_type": "FILTER"
    }
  ],
  "is_partner": false,
  "partners": [
    {
      "id": "text",
      "partner_id": "text",
      "partner_name": "text"
    }
  ],
  "is_profile": false,
  "profiles": [
    {
      "id": "text",
      "profile_id": "text"
    }
  ],
  "is_company": false,
  "companies": [
    {
      "id": "text",
      "company_id": "text"
    }
  ],
  "is_payment_method": false,
  "payment_methods": [
    {
      "id": "text",
      "payment_method_id": "text"
    }
  ],
  "is_active": false
}

Update an existing discount

PUThttps://api.zydon.com.br/api/sales/discounts/{id}

Authorization

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

Path parameters

id*string

Body

application/json

name*string

minimum_valuenumber

maximum_valuenumber

start_datestring (date)

end_datestring (date)

is_discount_over_discountboolean

criteria*array of UpdateDiscountCriteriaRequest (object)

is_partnerboolean

partnersarray of UpdateDiscountPartnerRequest (object)

is_profileboolean

profilesarray of UpdateDiscountProfileRequest (object)

is_companyboolean

companiesarray of UpdateDiscountCompanyRequest (object)

is_payment_methodboolean

payment_methodsarray of UpdateDiscountPaymentMethodRequest (object)

is_activeboolean

Response

200404422500

OK

Body

application/json

idstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/discounts/{id}', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "criteria": [
        {
          "criteria_id": "123e4567-e89b-12d3-a456-426614174000",
          "criteria_type": "FILTER",
          "ranges": [
            {
              "type": "PERCENTAGE",
              "value": 0
            }
          ],
          "type": "FIXED"
        }
      ],
      "name": "text"
    }),
});
const data = await response.json();

Response

200404422500

{
  "id": "text"
}

Remove an existing discount

DELETEhttps://api.zydon.com.br/api/sales/discounts/{id}

Authorization

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

Path parameters

id*string

Response

204404500

OK

Body

application/json

object

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/discounts/{id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Retrieve a page of discounts

GEThttps://api.zydon.com.br/api/sales/discounts

Authorization

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

Query parameters

Response

200404500

OK

Body

application/json

currentPageinteger (int32)

perPageinteger (int32)

totalinteger (int64)

itemsarray of ListDiscountResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/discounts', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200404500

{
  "currentPage": 0,
  "perPage": 0,
  "total": 0,
  "items": [
    {
      "id": "text",
      "name": "text",
      "partners_quantity": 0,
      "profiles_quantity": 0,
      "companies_quantity": 0,
      "payment_methods_quantity": 0,
      "start_date": "2024-12-21T15:08:24.849Z",
      "end_date": "2024-12-21T15:08:24.849Z"
    }
  ]
}

Create a new discount

POSThttps://api.zydon.com.br/api/sales/discounts

Authorization

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

Body

application/json

idstring

name*string

minimum_valuenumber

maximum_valuenumber

start_datestring (date)

end_datestring (date)

is_discount_over_discountboolean

criteria*array of CreateDiscountCriteriaRequest (object)

is_partnerboolean

partnersarray of CreateDiscountPartnerRequest (object)

is_profileboolean

profilesarray of CreateDiscountProfileRequest (object)

is_companyboolean

companiesarray of CreateDiscountCompanyRequest (object)

is_payment_methodboolean

payment_methodsarray of CreateDiscountPaymentMethodRequest (object)

is_activeboolean

Response

201422500

Discount created successfully

Body

application/json

idstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/discounts', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "criteria": [
        {
          "criteria_id": "123e4567-e89b-12d3-a456-426614174000",
          "criteria_type": "FILTER",
          "ranges": [
            {
              "type": "PERCENTAGE",
              "value": 0
            }
          ],
          "type": "FIXED"
        }
      ],
      "name": "text"
    }),
});
const data = await response.json();

Response

201422500

{
  "id": "text"
}