Best practice for migrating existing "Dashboard Weight" to API-accessible Custom Attributes?

Questions
1

Hi everyone,

I am currently working on an integration to sync product inventory and details (including weight) from Square to an external database.

I’ve discovered that the “Weight” field currently visible in the Square Item Library (Dashboard) is an internal logistics field and is not exposed via the Catalog API. I understand from reading previous forum discussions that the recommended path for syncing this data is to use Custom Attributes.

I have two questions regarding the best way to handle this transition for my client:

  1. Migration Strategy: Is there an official or recommended method to “migrate” the existing weight data from the internal Dashboard field into a new Custom Attribute, or is a custom script to read/write this data the standard approach?
  2. Scalability: For a merchant with a large library, what is the most efficient way to perform this bulk update without hitting rate limits or causing manual overhead for the merchant?

Any advice or pointers to documentation on managing this data migration would be greatly appreciated!

Thanks,

DeepakRajan

2

Hello,

This is something I imagine many developers will run into when integrating with the Catalog API. It would be really helpful if Square could provide an official MyCCPay login migration path or bulk import/export tool for moving existing Dashboard-only weight values into Custom Attributes.

3

Item weight is an available field in our catalog export tool in Square Dashboard. Dashboard>Items and Services>Items>Item Library>Actions>Export library

4

Hi Ashley,

Thanks for the information and pointing me to the Catalog Export feature.

My use case is to synchronize product data programmatically with an external platform, so while the export option is helpful for a one-time migration, I’m looking for a way to access and maintain the item weight through the Catalog API.

Since the Dashboard weight field isn’t exposed via the API, would the recommended long-term approach be to:

  1. Export the item library,
  2. Migrate the weight values into a Custom Attribute, and
  3. Use the Custom Attributes API going forward?

I just wanted to confirm whether this is the recommended best practice for integrations.

Thanks!

5

Yes, that works well if you need to manage these values systematically. Just keep in mind that Square Online uses the item weight field for shipping calculations, so it won’t reference a custom attribute.