All API categories

    Products API

    5 endpoints

    Product catalog and management.

    POST
    Auth Required

    Create a new product for a collection (admin only).

    Create a new product for a collection (admin only).

    Endpoint

    /admin/collection/{collectionId}/product

    Parameters

    collectionId
    path
    string
    Required
    body
    body
    ProductCreateRequest
    Required

    See ProductCreateRequest schema

    Responses

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

    Update a product for a collection (admin only).

    Update a product for a collection (admin only).

    Endpoint

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

    Parameters

    collectionId
    path
    string
    Required
    productId
    path
    string
    Required
    body
    body
    ProductUpdateRequest
    Required

    See ProductUpdateRequest schema

    Responses

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

    Delete a product for a collection (admin only).

    Delete a product for a collection (admin only).

    Endpoint

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

    Parameters

    collectionId
    path
    string
    Required
    productId
    path
    string
    Required

    Responses

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

    Delete a product for a collection (admin only).

    Delete a product for a collection (admin only).

    Endpoint

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

    Parameters

    collectionId
    path
    string
    Required
    productId
    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 product (admin only).

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

    Endpoint

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

    Parameters

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

    Responses

    200
    Success
    400
    Bad request
    401
    Unauthorized
    404
    Not found