Catalog

Version 1.0

Serves as the foundation for managing catalogs. Catalogs are essential entities that group and organize various products or items in a structured manner.

# Endpoints
POST
/v1/catalogs# Create a single catalog
GET
/v1/catalogs# Retrieve all catalogs
GET
/v1/catalogs/123456789# Retrieve a single catalog
PATCH
/v1/catalogs/123456789# Update a single catalog
DELETE
/v1/catalogs/123456789# Delete a single catalog
GET
/v1/catalogs/123456789/products# Retrieve all products in a catalog
POST
/v1/catalogs/123456789/products# Create a single product in a catalog
DELETE
/v1/catalogs/123456789/products/123456789# Delete a single product in a catalog

Catalog Entity

  • Name
    id
    Type
    string
    Required
    Description

    Every catalog is assigned a unique identifier - an unsigned 64-bit integer known as the Catalog ID. This specific number is exclusive and distinct across the entire Qooly platform, ensuring an unparalleled level of uniqueness.

  • Name
    name
    Type
    string
    Required
    Description

    The name of the catalog.

  • Name
    created_at
    Type
    timestamp
    Description

    This property indicates the time in ISO_8601 when the catalog was created.

  • Name
    updated_at
    Type
    timestamp
    Description

    This property indicates the time in ISO_8601 when the catalog was last updated.

  • Name
    created_by
    Type
    foreignId
    Description

    This property indicates the user who created the catalog.

  • Name
    updated_by
    Type
    foreignId
    Description

    This property indicates the user who recently updated the catalog.

The Catalog Entity

JSON
{
  "id": "123456789",
  "name": "Example Catalog",
  "created_at": "2024-01-07T12:30:00Z",
  "updated_at": "2024-01-07T14:45:00Z",
  "created_by": "123456789",
  "updated_by": "123456789"
}

Create a Single Catalog

This endpoint allows you to create a single catalog.

Required Fields

  • Name
    name
    Type
    string
    Required
    Description

Examples

Create a single catalog

POST
/v1/catalogs
curl --request POST \
  --url https://api.qooly.io/v1/catalogs \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Example Catalog"
  }'

Create a single catalog

POST
/v1/catalogs
curl --request POST \
  --url https://api.qooly.io/v1/catalogs \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Example Catalog"
  }'
JSON
{
  "id": "123456789",
  "name": "Example Catalog",
  "created_at": "2024-01-07T12:30:00Z",
  "updated_at": "2024-01-07T14:45:00Z",
  "created_by": "123456789",
  "updated_by": "123456789",
  "products": "https://api.qooly.io/v1/catalogs/123456789/products"
}

Retrieve all Catalogs

This endpoint allows you to retrieve all catalogs.

Examples

Retrieve all catalogs

GET
/v1/catalogs
curl --request GET \
  --url https://api.qooly.io/v1/catalogs

Retrieve a single catalog

GET
/v1/catalogs
curl --request GET \
  --url https://api.qooly.io/v1/catalogs
JSON
[
    {
        "id": "123456789",
        "name": "Example Catalog",
        "created_at": "2024-01-07T12:30:00Z",
        "updated_at": "2024-01-07T14:45:00Z",
        "created_by": "123456789",
        "updated_by": "123456789",
        "products": "https://api.qooly.io/v1/catalogs/123456789/products"
    },
    {
        "id": "987654321",
        "name": "Example Catalog 2",
        "created_at": "2024-01-07T12:30:00Z",
        "updated_at": "2024-01-07T14:45:00Z",
        "created_by": "123456789",
        "updated_by": "123456789",
        "products": "https://api.qooly.io/v1/catalogs/987654321/products"
    }
]

Retrieve a Single Catalog

This endpoint allows you to retrieve a single catalog.

Required Parameters

  • Name
    id
    Type
    string
    Required
    Description

Examples

Retrieve a single catalog

GET
/v1/catalogs/123456789
curl --request GET \
  --url https://api.qooly.io/v1/catalogs/123456789

Retrieve a single catalog

GET
/v1/catalogs/123456789
curl --request GET \
  --url https://api.qooly.io/v1/catalogs/123456789
JSON
{
  "id": "123456789",
  "name": "Example Catalog",
  "created_at": "2024-01-07T12:30:00Z",
  "updated_at": "2024-01-07T14:45:00Z",
  "created_by": "123456789",
  "updated_by": "123456789",
  "products": "https://api.qooly.io/v1/catalogs/123456789/products"
}

Update a Single Catalog

This endpoint allows you to update a single catalog.

Required Parameters

  • Name
    id
    Type
    string
    Required
    Description

Examples

Update a single catalog

PATCH
/v1/catalogs/123456789
curl --request PATCH \
  --url https://api.qooly.io/v1/catalogs/123456789 \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "New Catalog Name"
  }'

Update a single catalog

PATCH
/v1/catalogs/123456789
curl --request PATCH \
  --url https://api.qooly.io/v1/catalogs/123456789 \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "New Catalog Name"
  }'
JSON
{
  "id": "123456789",
  "name": "New Catalog Name",
  "created_at": "2024-01-07T12:30:00Z",
  "updated_at": "2024-01-07T14:45:00Z",
  "created_by": "123456789",
  "updated_by": "123456789",
  "products": "https://api.qooly.io/v1/catalogs/123456789/products"
}

Delete a Single Catalog

This endpoint allows you to delete a single catalog.

Required Parameters

  • Name
    id
    Type
    string
    Required
    Description

Examples

Delete a single catalog

DELETE
/v1/catalogs/123456789
curl --request DELETE \
  --url https://api.qooly.io/v1/catalogs/123456789

Delete a single catalog

DELETE
/v1/catalogs/123456789
curl --request DELETE \
  --url https://api.qooly.io/v1/catalogs/123456789
JSON
{}

Retrieve all Products in a Catalog

This endpoint allows you to retrieve all products in a catalog. It returns an array of Product Entity.

Required Parameters

  • Name
    id
    Type
    string
    Required
    Description

Examples

Retrieve all products in a catalog

GET
/v1/catalogs/123456789/products
curl --request GET \
  --url https://api.qooly.io/v1/catalogs/123456789/products

Retrieve all products in a catalog

GET
/v1/catalogs/123456789/products
curl --request GET \
  --url https://api.qooly.io/v1/catalogs/123456789/products
JSON
[
  {
      "id": "123456789",
      "brand_id": "987654321",
      "metadata_id": "456789012",
      "image_id": "789012345",
      "is_tangible": true,
      "has_details": false,
      "has_pricing": false,
      "is_organized": true,
      "is_published": false,
      "needs_review": true,
      "out_of_sync": false,
      "syncing_paused_at": null,
      "status": "DRAFT",
      "name": "Sample Product",
      "model_type": "Simple",
      "product_code": "ABC123",
      "product_category": "Electronics",
      "product_type": "Gadget",
      "product_lifecycle_status": "Active",
      "weight": "1.5",
      "weight_unit": "kg",
      "size_unit": "cm",
      "length": "10",
      "width": "5",
      "height": "15",
      "country_of_origin": "US",
      "commodity_description": "A high-quality electronic gadget.",
      "taxable": false,
      "tax_code": "TAX123",
      "created_at": "2024-01-07T12:30:00Z",
      "updated_at": "2024-01-07T14:45:00Z",
      "created_by": "789012345",
      "updated_by": "123456789"
  },
  {
      "id": "987654321",
      "brand_id": "987654321",
      "metadata_id": "456789012",
      "image_id": "789012345",
      "is_tangible": true,
      "has_details": false,
      "has_pricing": false,
      "is_organized": true,
      "is_published": false,
      "needs_review": true,
      "out_of_sync": false,
      "syncing_paused_at": null,
      "status": "DRAFT",
      "name": "Sample Product 2",
      "model_type": "Simple",
      "product_code": "123ABC",
      "product_category": "Electronics",
      "product_type": "Gadget",
      "product_lifecycle_status": "Active",
      "weight": "1.5",
      "weight_unit": "kg",
      "size_unit": "cm",
      "length": "10",
      "width": "5",
      "height": "15",
      "country_of_origin": "US",
      "commodity_description": "Another description.",
      "taxable": false,
      "tax_code": "TAX123",
      "created_at": "2024-01-07T12:30:00Z",
      "updated_at": "2024-01-07T14:45:00Z",
      "created_by": "789012345",
      "updated_by": "123456789"
  }
]

Create a Single Product in a Catalog

This endpoint allows you to add products in a catalog.

Required Parameters

  • Name
    id
    Type
    string
    Required
    Description
  • Name
    product_id
    Type
    string
    Required
    Description

Examples

Create a single product in a catalog

POST
/v1/catalogs/123456789/products
curl --request POST \
  --url https://api.qooly.io/v1/catalogs/123456789/products \
  --data '{
    "product_id": "123456789"
  }'

Create a single product in a catalog

POST
/v1/catalogs/123456789/products
curl --request POST \
  --url https://api.qooly.io/v1/catalogs/123456789/products \
  --data '{
    "product_id": "123456789"
  }'
JSON
  {}

Delete a Single Product in a Catalog

This endpoint allows you to remove products in a catalog.

Required Parameters

  • Name
    id
    Type
    string
    Required
    Description
  • Name
    product_id
    Type
    string
    Required
    Description

Examples

Delete a single product in a catalog

DELETE
/v1/catalogs/123456789/products
curl --request DELETE \
  --url https://api.qooly.io/v1/catalogs/123456789/products \
  --data '{
    "product_id": "123456789"
  }'

Delete a single product in a catalog

DELETE
/v1/catalogs/123456789/products
curl --request DELETE \
  --url https://api.qooly.io/v1/catalogs/123456789/products \
  --data '{
    "product_id": "123456789"
  }'
JSON
  {}