You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**name** | **str** | The category's name. Searchable. | [optional]
11
+
**name** | **str** | The category's name. Searchable. This field has max length of 255 Unicode code points. | [optional]
12
12
13
13
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
**name** | **str** | The discount's name. Searchable. | [optional]
11
+
**name** | **str** | The discount's name. Searchable. This field has max length of 255 Unicode code points. | [optional]
12
12
**discount_type** | **str** | Indicates whether the discount is a fixed amount or percentage, or entered at the time of sale. See [CatalogDiscountType](#type-catalogdiscounttype) for all possible values. | [optional]
13
13
**percentage** | **str** | The percentage of the discount as a string representation of a decimal number, using a `.` as the decimal separator and without a `%` sign. A value of `7.5` corresponds to `7.5%`. Specify a percentage of `0` if `discount_type` is `VARIABLE_PERCENTAGE`. Do not include this field for amount-based or variable discounts. | [optional]
14
14
**amount_money** | [**Money**](Money.md) | The amount of the discount. Specify an amount of `0` if `discount_type` is `VARIABLE_AMOUNT`. Do not include this field for percentage-based or variable discounts. | [optional]
15
15
**pin_required** | **bool** | Indicates whether a mobile staff member needs to enter their PIN to apply the discount to a payment in the Square Point of Sale app. | [optional]
16
-
**label_color** | **str** | The color of the discount's display label in the Square Point of Sale app. | [optional]
16
+
**label_color** | **str** | The color of the discount's display label in the Square Point of Sale app. This must be a valid hex color code. | [optional]
17
17
18
18
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
**name** | **str** | The item's name. Searchable. | [optional]
12
-
**description** | **str** | The item's description. Searchable. | [optional]
13
-
**abbreviation** | **str** | The text of the item's display label in the Square Point of Sale app. Only up to the first five characters of the string are used. Searchable. | [optional]
14
-
**label_color** | **str** | The color of the item's display label in the Square Point of Sale app. | [optional]
11
+
**name** | **str** | The item's name. Searchable. This field must not be empty. This field has max length of 512 Unicode code points. | [optional]
12
+
**description** | **str** | The item's description. Searchable. This field has max length of 4096 Unicode code points. | [optional]
13
+
**abbreviation** | **str** | The text of the item's display label in the Square Point of Sale app. Only up to the first five characters of the string are used. Searchable. This field has max length of 24 Unicode code points. | [optional]
14
+
**label_color** | **str** | The color of the item's display label in the Square Point of Sale app. This must be a valid hex color code. | [optional]
15
15
**available_online** | **bool** | If `true`, the item can be added to shipping orders from the merchant's online store. | [optional]
16
16
**available_for_pickup** | **bool** | If `true`, the item can be added to pickup orders from the merchant's online store. | [optional]
17
17
**available_electronically** | **bool** | If `true`, the item can be added to electronically fulfilled orders from the merchant's online store. | [optional]
**name** | **str** | The item variation's name. Searchable. This field has max length of 255 Unicode code points. | [optional]
13
13
**sku** | **str** | The item variation's SKU, if any. Searchable. | [optional]
14
14
**upc** | **str** | The item variation's UPC, if any. Searchable in the Connect API. This field is only exposed in the Connect API. It is not exposed in Square's Dashboard, Square Point of Sale app or Retail Point of Sale app. | [optional]
15
15
**ordinal** | **int** | The order in which this item variation should be displayed. This value is read-only. On writes, the ordinal for each item variation within a parent [CatalogItem](#type-catalogitem) is set according to the item variations's position. On reads, the value is not guaranteed to be sequential or unique. | [optional]
@@ -19,7 +19,7 @@ Name | Type | Description | Notes
19
19
**track_inventory** | **bool** | If `true`, inventory tracking is active for the variation. | [optional]
20
20
**inventory_alert_type** | **str** | Indicates whether the item variation displays an alert when its inventory quantity is less than or equal to its `inventory_alert_threshold`. See [InventoryAlertType](#type-inventoryalerttype) for all possible values. | [optional]
21
21
**inventory_alert_threshold** | **int** | If the inventory quantity for the variation is less than or equal to this value and `inventory_alert_type` is `LOW_QUANTITY`, the variation displays an alert in the merchant dashboard. This value is always an integer. | [optional]
22
-
**user_data** | **str** | Arbitrary user metadata to associate with the item variation. Cannot exceed 255 characters. Searchable. | [optional]
22
+
**user_data** | **str** | Arbitrary user metadata to associate with the item variation. Searchable. This field has max length of 255 Unicode code points. | [optional]
23
23
**service_duration** | **int** | If the [CatalogItem](#type-catalogitem) that owns this item variation is of type `APPOINTMENTS_SERVICE`, then this is the duration of the service in milliseconds. For example, a 30 minute appointment would have the value `1800000`, which is equal to 30 (minutes) * 60 (seconds per minute) * 1000 (milliseconds per second). | [optional]
24
24
25
25
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
**name** | **str** | The modifier's name. Searchable. | [optional]
11
+
**name** | **str** | The modifier's name. Searchable. This field has max length of 255 Unicode code points. | [optional]
12
12
**price_money** | [**Money**](Money.md) | The modifier's price. | [optional]
13
13
14
14
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
**name** | **str** | The [CatalogModifierList](#type-catalogmodifierlist)'s name. Searchable. | [optional]
11
+
**name** | **str** | The [CatalogModifierList](#type-catalogmodifierlist)'s name. Searchable. This field has max length of 255 Unicode code points. | [optional]
12
12
**selection_type** | **str** | Indicates whether multiple options from the [CatalogModifierList](#type-catalogmodifierlist) can be applied to a single [CatalogItem](#type-catalogitem). See [CatalogModifierListSelectionType](#type-catalogmodifierlistselectiontype) for all possible values. | [optional]
13
13
**modifiers** | [**list[CatalogObject]**](CatalogObject.md) | The options included in the [CatalogModifierList](#type-catalogmodifierlist). You must include at least one [CatalogModifier](#type-catalogmodifier). Each [CatalogObject](#type-catalogobject) must have type `MODIFIER` and contain [CatalogModifier](#type-catalogmodifier) data. | [optional]
Copy file name to clipboardExpand all lines: docs/CatalogObject.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
11
11
**type** | **str** | The type of this object. Each object type has expected properties expressed in a structured format within its corresponding `*_data` field below. See [CatalogObjectType](#type-catalogobjecttype) for all possible values. |
12
12
**id** | **str** | An identifier to reference this object in the catalog. When a new CatalogObject is inserted, the client should set the id to a temporary identifier starting with a `'#'` character. Other objects being inserted or updated within the same request may use this identifier to refer to the new object. When the server receives the new object, it will supply a unique identifier that replaces the temporary identifier for all future references. |
13
13
**updated_at** | **str** | Last modification [timestamp](#workingwithdates) in RFC 3339 format, e.g., `\"2016-08-15T23:59:33.123Z\"` would indicate the UTC time (denoted by `Z`) of August 15, 2016 at 23:59:33 and 123 milliseconds. | [optional]
14
-
**version** | **int** | The version of the object. When updating an object, the version supplied by the must match the version in the database, otherwise the write will be rejected as conflicting. | [optional]
14
+
**version** | **int** | The version of the object. When updating an object, the version supplied must match the version in the database, otherwise the write will be rejected as conflicting. | [optional]
15
15
**is_deleted** | **bool** | If `true`, the object has been deleted from the database. Must be `false` for new objects being inserted. When deleted, the `updated_at` field will equal the deletion time. | [optional]
16
16
**catalog_v1_ids** | [**list[CatalogV1Id]**](CatalogV1Id.md) | The Connect V1 IDs for this object at each [location](#type-location) where it is present, where they differ from the object's Connect V2 ID. The field will only be present for objects that have been created or modified by legacy APIs. | [optional]
17
17
**present_at_all_locations** | **bool** | If `true`, this object is present at all locations (including future locations), except where specified in the `absent_at_location_ids` field. If `false`, this object is not present at any locations (including future locations), except where specified in the `present_at_location_ids` field. If not specified, defaults to `true`. | [optional]
Copy file name to clipboardExpand all lines: docs/CatalogObjectType.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
4
4
### Description
5
5
6
-
Possible kinds of [CatalogObject](#type-catalogobject)s returned from the Catalog, each contaning type-specific properties in the `*_data` field corresponding to the object type.
6
+
Possible kinds of [CatalogObject](#type-catalogobject)s returned from the Catalog, each containing type-specific properties in the `*_data` field corresponding to the object type.
**name** | **str** | The tax's name. Searchable. | [optional]
11
+
**name** | **str** | The tax's name. Searchable. This field has max length of 255 Unicode code points. | [optional]
12
12
**calculation_phase** | **str** | Whether the tax is calculated based on a payment's subtotal or total. See [TaxCalculationPhase](#type-taxcalculationphase) for all possible values. | [optional]
13
13
**inclusion_type** | **str** | Whether the tax is `ADDITIVE` or `INCLUSIVE`. See [TaxInclusionType](#type-taxinclusiontype) for all possible values. | [optional]
14
14
**percentage** | **str** | The percentage of the tax in decimal form, using a `'.'` as the decimal separator and without a `'%'` sign. A value of `7.5` corresponds to 7.5%. | [optional]
Copy file name to clipboardExpand all lines: docs/CheckoutApi.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ Method | HTTP request
14
14
15
15
### Description
16
16
17
-
Creates a [Checkout](#type-checkout) response that links a `checkoutId`and `checkout_page_url` that customers can be directed to in order to provide their payment information using a payment processing workflow hosted on connect.squareup.com.
17
+
Links a `checkoutId`to a `checkout_page_url` that customers will be directed to in order to provide their payment information using a payment processing workflow hosted on connect.squareup.com.
**order** | [**Order**](Order.md) | The order to create. If this field is set, then the only other top-level field that can be set is the idempotency_key. | [optional]
11
12
**idempotency_key** | **str** | A value you specify that uniquely identifies this order among orders you've created. If you're unsure whether a particular order was created successfully, you can reattempt it with the same idempotency key without worrying about creating duplicate orders. See [Idempotency keys](#idempotencykeys) for more information. | [optional]
12
-
**reference_id** | **str** | An optional ID you can associate with the order for your own purposes (such as to associate the order with an entity ID in your own database). This value cannot exceed 40 characters. | [optional]
13
-
**line_items** | [**list[CreateOrderRequestLineItem]**](CreateOrderRequestLineItem.md) | The line items to associate with this order. Each line item represents a different product to include in a purchase. |
14
-
**taxes** | [**list[CreateOrderRequestTax]**](CreateOrderRequestTax.md) | The taxes to include on the order. | [optional]
15
-
**discounts** | [**list[CreateOrderRequestDiscount]**](CreateOrderRequestDiscount.md) | The discounts to include on the order. | [optional]
13
+
**reference_id** | **str** | __Deprecated__: Please set the reference_id on the nested [order](#type-order) field instead. An optional ID you can associate with the order for your own purposes (such as to associate the order with an entity ID in your own database). This value cannot exceed 40 characters. | [optional]
14
+
**line_items** | [**list[CreateOrderRequestLineItem]**](CreateOrderRequestLineItem.md) | __Deprecated__: Please set the line_items on the nested [order](#type-order) field instead. The line items to associate with this order. Each line item represents a different product to include in a purchase. |[optional]
15
+
**taxes** | [**list[CreateOrderRequestTax]**](CreateOrderRequestTax.md) | __Deprecated__: Please set the taxes on the nested [order](#type-order) field instead. The taxes to include on the order. | [optional]
16
+
**discounts** | [**list[CreateOrderRequestDiscount]**](CreateOrderRequestDiscount.md) | __Deprecated__: Please set the discounts on the nested [order](#type-order) field instead. The discounts to include on the order. | [optional]
16
17
17
18
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
Copy file name to clipboardExpand all lines: docs/CreateOrderRequestDiscount.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
4
4
### Description
5
5
6
-
Represents a discount that can apply to either a single line item or an entire order.
6
+
__Deprecated__: Please use the [OrderLineItemDiscount](#type-orderlineitemdiscount) type in the order field of [CreateOrderRequest](#type-createorderrequest) instead. Represents a discount that can apply to either a single line item or an entire order.
Copy file name to clipboardExpand all lines: docs/CreateOrderRequestLineItem.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
4
4
### Description
5
5
6
-
Represents a line item to include in an order. Each line item describes a different product to purchase, with its own quantity and price details. Line items can either reference objects from the merchant's catalog, or can alternatively specify a name and price instead.
6
+
__Deprecated__: Please use the [OrderLineItem](#type-orderlineitem) type in the order field of [CreateOrderRequest](#type-createorderrequest) instead. Represents a line item to include in an order. Each line item describes a different product to purchase, with its own quantity and price details. Line items can either reference objects from the merchant's catalog, or can alternatively specify a name and price instead.
Copy file name to clipboardExpand all lines: docs/CreateOrderRequestModifier.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
4
4
### Description
5
5
6
-
Represents a modifier applied to a single line item. Modifiers can reference existing objects in a merchant catalog or be constructed ad hoc at the time of purchase by providing a name and price.
6
+
__Deprecated__: Please use the [OrderLineItemModifier](#type-orderlineitemmodifier) type instead. Represents a modifier applied to a single line item. Modifiers can reference existing objects in a merchant catalog or be constructed ad hoc at the time of purchase by providing a name and price.
Copy file name to clipboardExpand all lines: docs/CreateOrderRequestTax.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
4
4
### Description
5
5
6
-
Represents a tax that can apply to either a single line item or an entire order.
6
+
__Deprecated__: Please use the [OrderLineItemTax](#type-orderlineitemtax) type in the order field of [CreateOrderRequest](#type-createorderrequest) instead. Represents a tax that can apply to either a single line item or an entire order.
0 commit comments