Price tables

Retrieve a price table given an ID

GEThttps://api.zydon.com.br/api/sales/price-tables/{id}

Authorization

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

Path parameters

id*string

Response

200404500

OK

Body

application/json

idstring

namestring

start_datestring (date-time)

end_datestring (date-time)

criteriaarray of RetrievePriceTableCriteriaResponse (object)

is_partner_specificboolean

partnersarray of RetrievePriceTablePartnerResponse (object)

is_profile_specificboolean

profilesarray of RetrievePriceTableProfileResponse (object)

is_company_specificboolean

companiesarray of RetrievePriceTableCompanyResponse (object)

is_payment_method_specificboolean

payment_methodsarray of RetrievePriceTablePaymentMethodResponse (object)

Request

JavaScriptCurlPython

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

Response

200404500

{
  "id": "text",
  "name": "text",
  "start_date": "2024-12-21T14:55:18.182Z",
  "end_date": "2024-12-21T14:55:18.182Z",
  "criteria": [
    {
      "name": "text",
      "criteria_id": "123e4567-e89b-12d3-a456-426614174000",
      "rate_type": "INCREASE",
      "value_type": "MONETARY",
      "criteria_type": "FILTER",
      "value": 0,
      "products": [
        {
          "product_id": "text",
          "price": 0,
          "base_price": 0,
          "name": "text",
          "sku": "text"
        }
      ],
      "products_quantity": 0
    }
  ],
  "is_partner_specific": false,
  "partners": [
    {
      "id": "text",
      "partner_id": "text",
      "partner_name": "text"
    }
  ],
  "is_profile_specific": false,
  "profiles": [
    {
      "id": "text",
      "profile_id": "text"
    }
  ],
  "is_company_specific": false,
  "companies": [
    {
      "id": "text",
      "company_id": "text"
    }
  ],
  "is_payment_method_specific": false,
  "payment_methods": [
    {
      "id": "text",
      "payment_method_id": "text"
    }
  ]
}

Update an existing price table

PUThttps://api.zydon.com.br/api/sales/price-tables/{id}

Authorization

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

Path parameters

id*string

Body

application/json

name*string

start_date*string (date)

end_datestring (date)

criteriaarray of UpdatePriceTableCriteriaRequest (object)

is_partner_specific*boolean

partners*array of UpdatePriceTablePartnerRequest (object)

is_profile_specific*boolean

profiles*array of UpdatePriceTableProfileRequest (object)

is_company_specific*boolean

companies*array of UpdatePriceTableCompanyRequest (object)

is_payment_method_specific*boolean

payment_methods*array of UpdatePriceTablePaymentMethodRequest (object)

Response

200404500

OK

Body

application/json

idstring

namestring

start_datestring (date-time)

end_datestring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/price-tables/{id}', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "companies": [
        {
          "company_id": "text"
        }
      ],
      "is_company_specific": false,
      "is_partner_specific": false,
      "is_payment_method_specific": false,
      "is_profile_specific": false,
      "name": "text",
      "partners": [
        {
          "partner_id": "text"
        }
      ],
      "payment_methods": [
        {
          "payment_method_id": "text"
        }
      ],
      "profiles": [
        {
          "profile_id": "text"
        }
      ],
      "start_date": "2024-12-21"
    }),
});
const data = await response.json();

Response

200404500

{
  "id": "text",
  "name": "text",
  "start_date": "2024-12-21T14:55:18.182Z",
  "end_date": "2024-12-21T14:55:18.182Z"
}

Remove an existing price table

DELETEhttps://api.zydon.com.br/api/sales/price-tables/{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/price-tables/{id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Retrieve a page of price tables

GEThttps://api.zydon.com.br/api/sales/price-tables

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 ListPriceTableResponse (object)

Request

JavaScriptCurlPython

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

Response

200404500

{
  "currentPage": 0,
  "perPage": 0,
  "total": 0,
  "items": [
    {
      "id": "text",
      "name": "text",
      "partner_size": 0,
      "profile_size": 0,
      "company_size": 0,
      "payment_method_size": 0,
      "start_date": "2024-12-21T14:55:18.182Z",
      "end_date": "2024-12-21T14:55:18.182Z"
    }
  ]
}

Create a new price table

POSThttps://api.zydon.com.br/api/sales/price-tables

Authorization

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

Body

application/json

idstring

name*string

start_date*string (date)

end_datestring (date)

criteriaarray of CreatePriceTableCriteriaRequest (object)

is_partner_specific*boolean

partners*array of CreatePriceTablePartnerRequest (object)

is_profile_specific*boolean

profiles*array of CreatePriceTableProfileRequest (object)

is_company_specific*boolean

companies*array of CreatePriceTableCompanyRequest (object)

is_payment_method_specific*boolean

payment_methods*array of CreatePriceTablePaymentMethodRequest (object)

Response

200404500

OK

Body

application/json

idstring

namestring

start_datestring (date-time)

end_datestring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('https://api.zydon.com.br/api/sales/price-tables', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "companies": [
        {
          "company_id": "text"
        }
      ],
      "is_company_specific": false,
      "is_partner_specific": false,
      "is_payment_method_specific": false,
      "is_profile_specific": false,
      "name": "text",
      "partners": [
        {
          "partner_id": "text"
        }
      ],
      "payment_methods": [
        {
          "payment_method_id": "text"
        }
      ],
      "profiles": [
        {
          "profile_id": "text"
        }
      ],
      "start_date": "2024-12-21"
    }),
});
const data = await response.json();

Response

200404500

{
  "id": "text",
  "name": "text",
  "start_date": "2024-12-21T14:55:18.182Z",
  "end_date": "2024-12-21T14:55:18.182Z"
}