Variations

Obter Variação

get

Autorizações

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

idstringObrigatório

Respostas

200

application/json

idstringOpcional

namestringOpcional

activebooleanOpcional

valuesstring[]Opcional

is_searchablebooleanOpcional

display_typestring · enumOpcionalValores possíveis:

404

Variation was not found

application/json

500

An internal server error was thrown

application/json

get/variations/{id}

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

{
  "id": "text",
  "name": "text",
  "active": true,
  "values": [
    "text"
  ],
  "is_searchable": true,
  "display_type": "COLOR",
  "variant_options": [
    {
      "id": "text",
      "name": "text",
      "display_value": "text",
      "order": 1
    }
  ]
}

Atualizar Variação

put

Autorizações

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

idstringObrigatório

Corpo

namestringObrigatório

activebooleanObrigatório

valuesstring[]Obrigatório

is_searchablebooleanOpcional

display_typestring · enumOpcionalValores possíveis:

Respostas

200

Variation updated successfully

application/json

idstringOpcional

namestringOpcional

activebooleanOpcional

valuesstring[]Opcional

is_searchablebooleanOpcional

display_typestring · enumOpcionalValores possíveis:

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

put/variations/{id}

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

{
  "name": "text",
  "active": true,
  "values": [
    "text"
  ],
  "is_searchable": true,
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "display_type": "COLOR",
  "variant_options": [
    {
      "name": "text",
      "display_value": "text"
    }
  ]
}

{
  "id": "text",
  "name": "text",
  "active": true,
  "values": [
    "text"
  ],
  "is_searchable": true,
  "display_type": "COLOR",
  "variant_options": [
    {
      "id": "text",
      "name": "text",
      "display_value": "text",
      "order": 1
    }
  ]
}

Remover Variação

delete

Autorizações

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

idstringObrigatório

Respostas

204

Variation removed successfully

application/json

idstringOpcional

422

A validation error was thrown

500

An internal server error was thrown

delete/variations/{id}

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

{
  "id": "text"
}

Listar Variações

get

Autorizações

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

application/json

idstringOpcional

namestringOpcional

activebooleanOpcional

valuesstring[]Opcional

is_searchablebooleanOpcional

display_typestring · enumOpcionalValores possíveis:

404

Variation was not found

application/json

500

An internal server error was thrown

application/json

get/variations

GET /api/sales/variations HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "name": "text",
  "active": true,
  "values": [
    "text"
  ],
  "is_searchable": true,
  "display_type": "COLOR",
  "variant_options": [
    {
      "id": "text",
      "name": "text",
      "display_value": "text",
      "order": 1
    }
  ]
}

Criar Variação

post

Autorizações

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Corpo

idstringOpcional

namestringObrigatório

activebooleanObrigatório

valuesstring[]Obrigatório

is_searchablebooleanOpcional

display_typestring · enumOpcionalValores possíveis:

Respostas

201

Variation created successfully

application/json

idstringOpcional

namestringOpcional

activebooleanOpcional

valuesstring[]Opcional

is_searchablebooleanOpcional

display_typestring · enumOpcionalValores possíveis:

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

post/variations

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

{
  "id": "text",
  "name": "text",
  "active": true,
  "values": [
    "text"
  ],
  "is_searchable": true,
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "display_type": "COLOR",
  "variant_options": [
    {
      "name": "text",
      "display_value": "text"
    }
  ]
}

{
  "id": "text",
  "name": "text",
  "active": true,
  "values": [
    "text"
  ],
  "is_searchable": true,
  "display_type": "COLOR",
  "variant_options": [
    {
      "id": "text",
      "name": "text",
      "display_value": "text",
      "order": 1
    }
  ]
}