Price tables

Retrieve a price table given an ID

get

Autorizações

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

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

idstringObrigatório

Respostas

200

OK

application/json

404

PriceTable was not found

application/json

500

An internal server error was thrown

application/json

get

/price-tables/{id}

HTTPcURLJavaScriptPython

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

{
  "id": "text",
  "name": "text",
  "start_date": "2025-12-08",
  "end_date": "2025-12-08",
  "criteria": [
    {
      "name": "text",
      "criteria_id": "123e4567-e89b-12d3-a456-426614174000",
      "rate_type": "INCREASE",
      "value_type": "MONETARY",
      "criteria_type": "FILTER",
      "value": 1,
      "products": [
        {
          "product_id": "text",
          "price": 1,
          "base_price": 1,
          "name": "text",
          "sku": "text",
          "product_variation_id": "text"
        }
      ],
      "products_quantity": 1
    }
  ],
  "is_partner_specific": true,
  "partners": [
    {
      "id": "text",
      "partner_id": "text",
      "partner_name": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ],
  "is_profile_specific": true,
  "profiles": [
    {
      "id": "text",
      "profile_id": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ],
  "is_company_specific": true,
  "companies": [
    {
      "id": "text",
      "company_id": "text",
      "company_name": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ],
  "is_payment_method_specific": true,
  "payment_methods": [
    {
      "id": "text",
      "payment_method_id": "text"
    }
  ],
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

Update an existing price table

put

Autorizações

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

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

idstringObrigatório

Corpo

application/json

namestringObrigatório

start_datestring · dateObrigatório

end_datestring · dateOpcional

is_partner_specificbooleanObrigatório

is_profile_specificbooleanObrigatório

is_company_specificbooleanObrigatório

is_payment_method_specificbooleanObrigatório

Respostas

200

OK

application/json

404

PriceTable was not updated

application/json

500

An internal server error was thrown

application/json

put

/price-tables/{id}

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "start_date": "2025-12-08",
  "end_date": "2025-12-08",
  "criteria": [
    {
      "criteria_id": "123e4567-e89b-12d3-a456-426614174000",
      "rate_type": "INCREASE",
      "value_type": "MONETARY",
      "criteria_type": "FILTER",
      "value": 1,
      "products": [
        {
          "product_id": "text",
          "price": 1,
          "product_variation_id": "text",
          "attributes": {
            "ANY_ADDITIONAL_PROPERTY": {}
          }
        }
      ]
    }
  ],
  "is_partner_specific": true,
  "partners": [
    {
      "id": "text",
      "partner_id": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ],
  "is_profile_specific": true,
  "profiles": [
    {
      "id": "text",
      "profile_id": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ],
  "is_company_specific": true,
  "companies": [
    {
      "id": "text",
      "company_id": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ],
  "is_payment_method_specific": true,
  "payment_methods": [
    {
      "id": "text",
      "payment_method_id": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ],
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

{
  "id": "text",
  "name": "text",
  "start_date": "2025-12-08",
  "end_date": "2025-12-08",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

Remove an existing price table

delete

Autorizações

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

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

idstringObrigatório

Respostas

204

OK

404

PriceTable was not removed

500

An internal server error was thrown

delete

/price-tables/{id}

HTTPcURLJavaScriptPython

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

Sem conteúdo

Retrieve a page of price tables

get

Autorizações

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

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

404

PriceTable was not found

application/json

500

An internal server error was thrown

application/json

get

/price-tables

HTTPcURLJavaScriptPython

GET /api/sales/price-tables 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",
      "partner_size": 1,
      "profile_size": 1,
      "company_size": 1,
      "payment_method_size": 1,
      "start_date": "2025-12-08",
      "end_date": "2025-12-08",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ]
}

Create a new price table

post

Autorizações

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

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Corpo

application/json

idstringOpcional

namestringObrigatório

start_datestring · dateObrigatório

end_datestring · dateOpcional

is_partner_specificbooleanObrigatório

is_profile_specificbooleanObrigatório

is_company_specificbooleanObrigatório

is_payment_method_specificbooleanObrigatório

Respostas

200

OK

application/json

404

PriceTable was not created

application/json

500

An internal server error was thrown

application/json

post

/price-tables

HTTPcURLJavaScriptPython

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

{
  "id": "text",
  "name": "text",
  "start_date": "2025-12-08",
  "end_date": "2025-12-08",
  "criteria": [
    {
      "criteria_id": "123e4567-e89b-12d3-a456-426614174000",
      "rate_type": "INCREASE",
      "value_type": "MONETARY",
      "criteria_type": "FILTER",
      "value": 1,
      "products": [
        {
          "product_id": "text",
          "price": 1,
          "product_variation_id": "text",
          "attributes": {
            "ANY_ADDITIONAL_PROPERTY": {}
          }
        }
      ]
    }
  ],
  "is_partner_specific": true,
  "partners": [
    {
      "id": "text",
      "partner_id": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ],
  "is_profile_specific": true,
  "profiles": [
    {
      "id": "text",
      "profile_id": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ],
  "is_company_specific": true,
  "companies": [
    {
      "id": "text",
      "company_id": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ],
  "is_payment_method_specific": true,
  "payment_methods": [
    {
      "id": "text",
      "payment_method_id": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ],
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

{
  "id": "text",
  "name": "text",
  "start_date": "2025-12-08",
  "end_date": "2025-12-08",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}