YAyampi
Catálogo - Customizações

Visualizar customização

Visualiza os detalhes de uma customização específica

get/{alias}/catalog/customizations/{id}

Request

  • Base URL
    https://api.dooki.com.br/v2
  • URL
    https://api.dooki.com.br/v2/{alias}/catalog/customizations/{id}
  • Auth
    API key in header User-Token and API key in header User-Secret-Key

Path parameters

aliasstring required

Alias da loja

idinteger required

ID da customização

Response

Detalhes da customização

idinteger

ID do produto customizado

namestring

Nome do campo de customização, exibido ao cliente.

pricenumber

Preço do produto customizado

descriptionstring

Texto de ajuda exibido junto ao campo de customização.

typestring

Tipo do campo de customização (ex.: select para lista de valores).

requiredboolean

Indica se é obrigatório ou não

allowed_valuesstring

Valores permitidos para o campo

max_charsinteger

Há uma limitação de caracteres na customização. Exemplo: o número da camisa deve ter apenas 2 caracteres.

products_idsinteger[]

IDs dos produtos que possuem essa customização

valuesstring[]

Valores cadastrados para o cliente escolher, usados nos campos de seleção.

total_productsinteger

Quantidade de produtos que usam esta customização.

Example response

{
  "name": "Primeira Letra",
  "description": "Descrição",
  "type": "select",
  "required": true,
  "max_chars": 1,
  "created_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "updated_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  }
}

Changes

No recorded changes to this operation across all 3 revisions of this API.