Breaking Change - Resource product to item property renames (Deprecable)

Deployed Date: 3/6/24

Deprecation Date: 03/25/2024

We discovered an inconstency of using the terms product and item in our property names interchangeably. To align it with with Item resource, we’ve decided to ensure we use item everywhere. This results in any property name that had product in it to be replaced with item. All the product properties will remain in a deprecated state until 03/25/2024 at which point they will be removed. The resource docs have been updated to reflect the new item names.

• Cart
• Category
• CategoryList
• DiscountList
• Item
• ItemList
• AfterpayRestrictions

Migration path

If you use the SDK’s getEventEndDate, you’ll need to update to the SDK version uploaded on 03/25/2024 in the share which uses the newly named item_type_details property.

Cart

{
    "order": {
        "line_items": [
            {
-               "square_online_product_id": "2",
+               "square_online_item_id": "2",
            }
        ]
    }
}

Category

See Item resource for breaking changes.

{
-   "preferred_order_square_online_product_ids": [
-       "9",
-       "4",
-       "6",
-       "7",
-       "15"
-   ],
+   "preferred_order_square_online_item_ids": [
+       "9",
+       "4",
+       "6",
+       "7",
+       "15"
+   ],
    "items": [
        {
            // See Item
        }
    ]
}

CategoryList

See Category and Item resources for breaking changes.

[
    {
        // See Category
        "items": [
            {
                // See Item
            }
        ]
    }
]

DiscountList

[
    {
-       "match_square_online_product_ids": [
-           "1"
-       ],
+       "match_square_online_item_ids": [
+           "1"
+       ],
-       "exclude_square_online_product_ids": [
-           "2"
-       ],
+       "exclude_square_online_item_ids": [
+           "2"
+       ],
-       "all_products": false,
+       "all_items": false,
    }
]

Item

Item variations incorrectly had the square_online_item_id and square_online_id in number form instead of string form. Item modifier lists incorrectly had the square_online_item_id in number form instead of string form.

{
-   "product_type": "REGULAR",
+   "item_type": "REGULAR",
-   "product_type_details": {},
+   "item_type_details": {},
}

ItemList

See Item resource for breaking changes

[
    {
        // See Item
    }
]

AfterpayRestrictions

{
-   "product_price_min": {
-       "amount": 1800,
-       "currency": "USD",
-       "formatted": "$18.00"
-   },
+   "item_price_min": {
+       "amount": 1800,
+       "currency": "USD",
+      "formatted": "$18.00"
+   },
-   "product_price_max": {
-       "amount": 1800,
-       "currency": "USD",
-       "formatted": "$18.00"
-   },
+   "item_price_max": {
+       "amount": 1800,
+       "currency": "USD",
+       "formatted": "$18.00"
+   },
}