API docs by Redocly

Repzo API - Variant (1.0.0)

Download OpenAPI specification:Download

OpenAPI specification for Repzo Variant endpoints.

Find variants

query Parameters
params
object

Query parameters for filtering variants

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total_result": 0,
  • "current_count": 0,
  • "total_pages": 0,
  • "current_page": 0,
  • "per_page": 0,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "next_page_url": "string",
  • "prev_page_url": "string",
  • "path": "string"
}

Create a variant

Request Body schema: application/json
name
required
string

Name of the variant

product
required
string

ID of the product this variant belongs to

price
required
number

Price of the variant

company_namespace
Array of strings

Company namespaces

disabled
boolean

Whether the variant is disabled

uuid
string

UUID for the variant

local_name
string

Localized name of the variant

sku
string

Stock keeping unit

barcode
string

Barcode of the variant

weight
number

Weight of the variant

length
number

Length of the variant

width
number

Width of the variant

height
number

Height of the variant

position
number

Position of the variant

default
boolean

Whether this is the default variant

variant_img
string

Image URL for the variant

modifiers_groups
Array of strings

Modifier groups for the variant

object

Integration metadata

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "product": "string",
  • "price": 0,
  • "company_namespace": [
    ],
  • "disabled": true,
  • "uuid": "string",
  • "local_name": "string",
  • "sku": "string",
  • "barcode": "string",
  • "weight": 0,
  • "length": 0,
  • "width": 0,
  • "height": 0,
  • "position": 0,
  • "default": true,
  • "variant_img": "string",
  • "modifiers_groups": [
    ],
  • "integration_meta": { }
}

Response samples

Content type
application/json
{
  • "$ref": null
}

Get a variant by ID

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "product": "string",
  • "price": 0,
  • "company_namespace": [
    ],
  • "disabled": true,
  • "uuid": "string",
  • "local_name": "string",
  • "sku": "string",
  • "barcode": "string",
  • "weight": 0,
  • "length": 0,
  • "width": 0,
  • "height": 0,
  • "position": 0,
  • "default": true,
  • "variant_img": "string",
  • "modifiers_groups": [
    ],
  • "integration_meta": { },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Update a variant

path Parameters
id
required
string
Request Body schema: application/json
name
string

Name of the variant

product
string

ID of the product this variant belongs to

price
number

Price of the variant

company_namespace
Array of strings

Company namespaces

disabled
boolean

Whether the variant is disabled

uuid
string

UUID for the variant

local_name
string

Localized name of the variant

sku
string

Stock keeping unit

barcode
string

Barcode of the variant

weight
number

Weight of the variant

length
number

Length of the variant

width
number

Width of the variant

height
number

Height of the variant

position
number

Position of the variant

default
boolean

Whether this is the default variant

variant_img
string

Image URL for the variant

modifiers_groups
Array of strings

Modifier groups for the variant

object

Integration metadata

_id
string

Unique identifier for the variant

createdAt
string <date-time>

Creation timestamp

updatedAt
string <date-time>

Last update timestamp

__v
number

Version number

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "product": "string",
  • "price": 0,
  • "company_namespace": [
    ],
  • "disabled": true,
  • "uuid": "string",
  • "local_name": "string",
  • "sku": "string",
  • "barcode": "string",
  • "weight": 0,
  • "length": 0,
  • "width": 0,
  • "height": 0,
  • "position": 0,
  • "default": true,
  • "variant_img": "string",
  • "modifiers_groups": [
    ],
  • "integration_meta": { },
  • "_id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "product": "string",
  • "price": 0,
  • "company_namespace": [
    ],
  • "disabled": true,
  • "uuid": "string",
  • "local_name": "string",
  • "sku": "string",
  • "barcode": "string",
  • "weight": 0,
  • "length": 0,
  • "width": 0,
  • "height": 0,
  • "position": 0,
  • "default": true,
  • "variant_img": "string",
  • "modifiers_groups": [
    ],
  • "integration_meta": { },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Remove a variant

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "product": "string",
  • "price": 0,
  • "company_namespace": [
    ],
  • "disabled": true,
  • "uuid": "string",
  • "local_name": "string",
  • "sku": "string",
  • "barcode": "string",
  • "weight": 0,
  • "length": 0,
  • "width": 0,
  • "height": 0,
  • "position": 0,
  • "default": true,
  • "variant_img": "string",
  • "modifiers_groups": [
    ],
  • "integration_meta": { },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}