All API categories

    Variants API

    8 endpoints

    Product variant management.

    GET
    Auth Required

    Get a single variant by ID for a collection and product (admin only).

    Get a single variant by ID for a collection and product (admin only).

    Endpoint

    /admin/collection/{collectionId}/product/{collectionId}/variant/{variantId}

    Parameters

    variantId
    path
    string
    Required

    Responses

    200
    Success
    {
  "schema": "VariantResponse"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    PUT
    Auth Required

    Update a variant for a collection and product (admin only).

    Update a variant for a collection and product (admin only).

    Endpoint

    /admin/collection/{collectionId}/product/{collectionId}/variant/{variantId}

    Parameters

    variantId
    path
    string
    Required
    body
    body
    VariantUpdateRequest
    Required

    See VariantUpdateRequest schema

    Responses

    200
    Success
    {
  "schema": "VariantResponse"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    DELETE
    Auth Required

    Delete a variant for a collection and product (admin only).

    Delete a variant for a collection and product (admin only).

    Endpoint

    /admin/collection/{collectionId}/product/{collectionId}/variant/{variantId}

    Parameters

    variantId
    path
    string
    Required

    Responses

    200
    Success
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    GET
    Auth Required

    List all variants for a collection and product (admin only).

    List all variants for a collection and product (admin only).

    Endpoint

    /admin/collection/{collectionId}/product/{productId}/variant

    Parameters

    productId
    path
    string
    Required

    Responses

    200
    Success
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    List all variants for a collection and product (admin only).

    List all variants for a collection and product (admin only).

    Endpoint

    /admin/collection/{collectionId}/product/{productId}/variant

    Parameters

    productId
    path
    string
    Required
    body
    body
    VariantCreateRequest
    Required

    See VariantCreateRequest schema

    Responses

    200
    Success
    {
  "schema": "VariantResponse"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    GET
    Auth Required

    Get serial numbers for a variant (admin only).

    Get serial numbers for a variant (admin only).

    Endpoint

    /admin/collection/{collectionId}/product/{productId}/variant/{variantId}/getSN

    Parameters

    collectionId
    path
    string
    Required
    productId
    path
    string
    Required
    variantId
    path
    string
    Required

    Responses

    200
    Success
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    GET
    Auth Required

    Look up a serial number by code for a variant (admin only).

    Look up a serial number by code for a variant (admin only).

    Endpoint

    /admin/collection/{collectionId}/product/{productId}/variant/{variantId}/lookupSN/{codeId}

    Parameters

    collectionId
    path
    string
    Required
    productId
    path
    string
    Required
    variantId
    path
    string
    Required
    codeId
    path
    string
    Required

    Responses

    200
    Success
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    GET
    Auth Required

    Get a single variant by ID for a collection and product (public endpoint).

    Get a single variant by ID for a collection and product (public endpoint).

    Endpoint

    /public/collection/{collectionId}/product/{collectionId}/variant/{variantId}

    Parameters

    variantId
    path
    string
    Required

    Responses

    200
    Success
    {
  "schema": "VariantResponse"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found