API legada/Referência completa/Variáveis de idioma

Paginação de langvars

Os parâmetros page e items_per_page, que controlam quantas variáveis de idioma a listagem devolve, e o objeto params da resposta.

Ao obter as variáveis de idioma, você controla quantos resultados voltam e qual página de resultados é exibida com dois parâmetros de consulta. Uma loja pode ter milhares de variáveis, então a resposta de GET /api/langvars/ é uma página com uma quantidade limitada delas.

Parâmetros de paginação

Parâmetros de consulta

pageintegerpadrão: 1

Define qual página de variáveis de idioma exibir. Este parâmetro indica o número da página a devolver.

items_per_pageintegerpadrão: 10

Controla quantas variáveis de idioma entram em cada página.

Exemplo

GET/api/langvarsAdmin

Devolver 2 variáveis de idioma da 2ª página da lista

Exemplo de requisição

Esta requisição devolve um array com informações de 2 variáveis de idioma da 2ª página da lista.

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/langvars/?page=2&items_per_page=2"

Resposta

A referência examina a requisição GET /api/languages/1/langvars, que obtém as variáveis de idioma do idioma de id 1. Quando dá certo, você recebe HTTP/1.1 200 OK e este JSON.

200Variáveis de idioma com dados de paginação

json

{
  "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"
  }
}