Pagination - Language Variables

Overview

When retrieving language variables through the Venddor API, you can control how many results are returned and which page of results to display using pagination parameters.

Base URL: https://www.venddor.com.br/api

Pagination Parameters

Add these parameters to your API requests to control the pagination of language variables:

Parameter Default Value Description
page 1 Determines which page of language variables to display. The response to GET /api/langvars/ is a page with a limited number of language variables. This parameter specifies the page number to be returned.
items_per_page 10 Controls how many language variables are included on each page.
Tip: If you don't specify these parameters, the API will return the first 10 language variables by default.

Example

GET /api/langvars/?page=2&items_per_page=2

This request will return an array with information about 2 language variables from the 2nd page of the list.

Response Format

Let's examine a sample request to understand the response format:

GET /api/languages/1/langvars

This request retrieves language variables for a specific language (with ID 1).

If the request is successful, you'll receive HTTP/1.1 200 OK with the following JSON response:

{
  "langvars": [
    {
      "value": "Enable support of fraud notification",
      "name": "2co_enable_fraud_verification"
    },
    {
      "value": "Status for orders with failed fraud review",
      "name": "2co_fraud_fail"
    },
    {
      "value": "Status for orders waiting for fraud review",
      "name": "2co_fraud_wait"
    },
    {
      "value": "3-D Secure",
      "name": "3d_secure"
    },
    {
      "value": "The 404 Not Found error message",
      "name": "404"
    },
    {
      "value": "Absolute",
      "name": "absolute"
    },
    {
      "value": "Accept",
      "name": "accept"
    },
    {
      "value": "Accept products",
      "name": "accept_products"
    },
    {
      "value": "Access denied",
      "name": "access_denied"
    },
    {
      "value": "You don't have permission to access the page.",
      "name": "access_denied_text"
    }
  ],
  "params": {
    "page": 1,
    "items_per_page": "10",
    "total_items": "4673"
  }
}
Note: The response includes both the requested language variables and pagination metadata in the params object, which shows the current page, items per page, and total available items.