Rate Endpoints

In the context of our API, a rate represents an important entity. This rate will be associated with a product by referring to the ProductRate entity.

Common Rate Characteristics

1. Unique Identification: Each rate has a unique identifier id that distinguishes them from other rates in the system. It also has an idRemote field, which refers to the id that may be stored in the client's ERP database.

2. Rate Data: A rate has associated information such as description, last update timestamp, and other details.

3. Activities and Logging: Activities performed by a rate within the system, such as creation or deletion of resources, may be logged.

Endpoints

GET/Currency/getCurrency

Retrieve Rates

Description

This endpoint retrieves a paginated list of currencies from the system. It allows clients to fetch rate data based on pagination parameters such as page number (page) and the number of items per page (pageSize). The response includes detailed information about each currency, including their ID, description and isoCode.

Parameters

Name	Description	Type	Default Value
page	Rate number	Integer	1
pageSize	Number of items per page	Integer	10

Responses

JSON

  {
      "data": [
          {
          "id": "string",
          "description": "string",
          "isoCode": "string"
          }
      ],
      "pagination": {
          "totalItems": 0,
          "itemsPerPage": 0,
          "currentPage": 0,
          "totalPages": 0,
          "nextPageUrl": "string"
      }
  }

XML

  <?xml version="1.0" encoding="UTF-8"?>
  <export>
    <data>
      <item>
        <id>string</id>
        <description>string</description>
        <isoCode>string</isoCode>
      </item>
    </data>
    <pagination>
      <totalItems>0</totalItems>
      <itemsPerPage>0</itemsPerPage>
      <currentPage>0</currentPage>
      <totalPages>0</totalPages>
      <nextPageUrl>string</nextPageUrl>
    </pagination>
  </export>

👉Try it out🌱

Possible Response Errors

Error	Response Status	Response Body
This error occurs when a connection to the database cannot be established. It is an internal server problem.	500	{"code": 500,"error": "Database connection failed."}
This error occurs when you cannot insert or update items into the database.	500	{"code": 500,"error": "Invalid connection name, you cannot insert in default"}
This error occurs when a parameter is missing.	400	{"code": 400,"error": "Parameter $parameter is required"}
This error occurs when you are not authorized.	401	{"code": 401,"error": "Unauthorized."}
This error occurs when the Rate could not be found.	404	{"code": 404,"error": "No entity found for Rate."}
This error occurs when you try to send too many requests in a short period of time.	429	{"code": 429,"error": "Too Many Requests"}