square_connect 2.20190410.1.300 → 2.20190508.0.304
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGES.md +10 -0
- data/README.md +32 -1
- data/docs/BatchRetrieveOrdersResponse.md +1 -0
- data/docs/BusinessHours.md +12 -0
- data/docs/BusinessHoursPeriod.md +14 -0
- data/docs/ChargeRequest.md +3 -3
- data/docs/CreateOrderRequest.md +1 -1
- data/docs/CreateOrderRequestTax.md +1 -1
- data/docs/DayOfWeek.md +18 -0
- data/docs/ErrorCode.md +2 -0
- data/docs/InventoryAdjustment.md +1 -1
- data/docs/InventoryCount.md +2 -2
- data/docs/InventoryPhysicalCount.md +2 -2
- data/docs/InventoryTransfer.md +1 -1
- data/docs/Location.md +1 -0
- data/docs/MeasurementUnit.md +16 -0
- data/docs/MeasurementUnitArea.md +19 -0
- data/docs/MeasurementUnitCustom.md +13 -0
- data/docs/MeasurementUnitLength.md +19 -0
- data/docs/MeasurementUnitVolume.md +22 -0
- data/docs/MeasurementUnitWeight.md +17 -0
- data/docs/Order.md +12 -1
- data/docs/OrderEntry.md +13 -0
- data/docs/OrderLineItem.md +5 -2
- data/docs/OrderLineItemDiscount.md +2 -1
- data/docs/OrderLineItemModifier.md +2 -1
- data/docs/OrderLineItemTax.md +1 -0
- data/docs/OrderMoneyAmounts.md +16 -0
- data/docs/OrderQuantityUnit.md +13 -0
- data/docs/OrderReturn.md +18 -0
- data/docs/OrderReturnDiscount.md +20 -0
- data/docs/OrderReturnLineItem.md +28 -0
- data/docs/OrderReturnLineItemModifier.md +17 -0
- data/docs/OrderReturnTax.md +19 -0
- data/docs/OrderRoundingAdjustment.md +14 -0
- data/docs/OrderSource.md +1 -1
- data/docs/OrderState.md +14 -0
- data/docs/OrdersApi.md +54 -1
- data/docs/SearchOrdersCustomerFilter.md +12 -0
- data/docs/SearchOrdersDateTimeFilter.md +14 -0
- data/docs/SearchOrdersFilter.md +16 -0
- data/docs/SearchOrdersFulfillmentFilter.md +13 -0
- data/docs/SearchOrdersQuery.md +13 -0
- data/docs/SearchOrdersRequest.md +16 -0
- data/docs/SearchOrdersResponse.md +16 -0
- data/docs/SearchOrdersSort.md +13 -0
- data/docs/SearchOrdersSortField.md +14 -0
- data/docs/SearchOrdersSourceFilter.md +12 -0
- data/docs/SearchOrdersStateFilter.md +12 -0
- data/docs/TransactionsApi.md +1 -1
- data/lib/square_connect.rb +30 -0
- data/lib/square_connect/api/apple_pay_api.rb +1 -1
- data/lib/square_connect/api/catalog_api.rb +11 -11
- data/lib/square_connect/api/checkout_api.rb +1 -1
- data/lib/square_connect/api/customers_api.rb +8 -8
- data/lib/square_connect/api/employees_api.rb +2 -2
- data/lib/square_connect/api/inventory_api.rb +7 -7
- data/lib/square_connect/api/labor_api.rb +14 -14
- data/lib/square_connect/api/locations_api.rb +1 -1
- data/lib/square_connect/api/mobile_authorization_api.rb +1 -1
- data/lib/square_connect/api/o_auth_api.rb +3 -3
- data/lib/square_connect/api/orders_api.rb +59 -4
- data/lib/square_connect/api/reporting_api.rb +2 -2
- data/lib/square_connect/api/transactions_api.rb +9 -9
- data/lib/square_connect/api/v1_employees_api.rb +16 -16
- data/lib/square_connect/api/v1_items_api.rb +40 -40
- data/lib/square_connect/api/v1_locations_api.rb +2 -2
- data/lib/square_connect/api/v1_transactions_api.rb +11 -11
- data/lib/square_connect/api_client.rb +1 -1
- data/lib/square_connect/models/batch_retrieve_orders_response.rb +16 -4
- data/lib/square_connect/models/business_hours.rb +188 -0
- data/lib/square_connect/models/business_hours_period.rb +239 -0
- data/lib/square_connect/models/charge_request.rb +3 -3
- data/lib/square_connect/models/create_order_request.rb +1 -1
- data/lib/square_connect/models/create_order_request_tax.rb +1 -1
- data/lib/square_connect/models/day_of_week.rb +24 -0
- data/lib/square_connect/models/error.rb +2 -2
- data/lib/square_connect/models/error_code.rb +2 -0
- data/lib/square_connect/models/inventory_adjustment.rb +1 -1
- data/lib/square_connect/models/inventory_count.rb +2 -2
- data/lib/square_connect/models/inventory_physical_count.rb +2 -2
- data/lib/square_connect/models/inventory_transfer.rb +1 -1
- data/lib/square_connect/models/location.rb +14 -4
- data/lib/square_connect/models/measurement_unit.rb +295 -0
- data/lib/square_connect/models/measurement_unit_area.rb +25 -0
- data/lib/square_connect/models/measurement_unit_custom.rb +206 -0
- data/lib/square_connect/models/measurement_unit_length.rb +25 -0
- data/lib/square_connect/models/measurement_unit_volume.rb +28 -0
- data/lib/square_connect/models/measurement_unit_weight.rb +23 -0
- data/lib/square_connect/models/order.rb +151 -2
- data/lib/square_connect/models/order_entry.rb +196 -0
- data/lib/square_connect/models/order_line_item.rb +54 -8
- data/lib/square_connect/models/order_line_item_discount.rb +28 -2
- data/lib/square_connect/models/order_line_item_modifier.rb +28 -2
- data/lib/square_connect/models/order_line_item_tax.rb +27 -1
- data/lib/square_connect/models/order_money_amounts.rb +226 -0
- data/lib/square_connect/models/order_quantity_unit.rb +196 -0
- data/lib/square_connect/models/order_return.rb +268 -0
- data/lib/square_connect/models/order_return_discount.rb +391 -0
- data/lib/square_connect/models/order_return_line_item.rb +481 -0
- data/lib/square_connect/models/order_return_line_item_modifier.rb +300 -0
- data/lib/square_connect/models/order_return_tax.rb +381 -0
- data/lib/square_connect/models/order_rounding_adjustment.rb +222 -0
- data/lib/square_connect/models/order_source.rb +1 -1
- data/lib/square_connect/models/order_state.rb +20 -0
- data/lib/square_connect/models/search_orders_customer_filter.rb +188 -0
- data/lib/square_connect/models/search_orders_date_time_filter.rb +206 -0
- data/lib/square_connect/models/search_orders_filter.rb +226 -0
- data/lib/square_connect/models/search_orders_fulfillment_filter.rb +226 -0
- data/lib/square_connect/models/search_orders_query.rb +196 -0
- data/lib/square_connect/models/search_orders_request.rb +244 -0
- data/lib/square_connect/models/search_orders_response.rb +234 -0
- data/lib/square_connect/models/search_orders_sort.rb +246 -0
- data/lib/square_connect/models/search_orders_sort_field.rb +20 -0
- data/lib/square_connect/models/search_orders_source_filter.rb +188 -0
- data/lib/square_connect/models/search_orders_state_filter.rb +214 -0
- data/lib/square_connect/version.rb +1 -1
- data/spec/models/business_hours_period_spec.rb +55 -0
- data/spec/models/business_hours_spec.rb +39 -0
- data/spec/models/day_of_week_spec.rb +33 -0
- data/spec/models/measurement_unit_area_spec.rb +33 -0
- data/spec/models/measurement_unit_custom_spec.rb +45 -0
- data/spec/models/measurement_unit_length_spec.rb +33 -0
- data/spec/models/measurement_unit_spec.rb +79 -0
- data/spec/models/measurement_unit_volume_spec.rb +33 -0
- data/spec/models/measurement_unit_weight_spec.rb +33 -0
- data/spec/models/order_entry_spec.rb +45 -0
- data/spec/models/order_money_amounts_spec.rb +63 -0
- data/spec/models/order_quantity_unit_spec.rb +45 -0
- data/spec/models/order_return_discount_spec.rb +95 -0
- data/spec/models/order_return_line_item_modifier_spec.rb +69 -0
- data/spec/models/order_return_line_item_spec.rb +135 -0
- data/spec/models/order_return_spec.rb +75 -0
- data/spec/models/order_return_tax_spec.rb +89 -0
- data/spec/models/order_rounding_adjustment_spec.rb +51 -0
- data/spec/models/order_state_spec.rb +33 -0
- data/spec/models/search_orders_customer_filter_spec.rb +39 -0
- data/spec/models/search_orders_date_time_filter_spec.rb +51 -0
- data/spec/models/search_orders_filter_spec.rb +63 -0
- data/spec/models/search_orders_fulfillment_filter_spec.rb +53 -0
- data/spec/models/search_orders_query_spec.rb +45 -0
- data/spec/models/search_orders_request_spec.rb +63 -0
- data/spec/models/search_orders_response_spec.rb +63 -0
- data/spec/models/search_orders_sort_field_spec.rb +33 -0
- data/spec/models/search_orders_sort_spec.rb +53 -0
- data/spec/models/search_orders_source_filter_spec.rb +39 -0
- data/spec/models/search_orders_state_filter_spec.rb +43 -0
- metadata +122 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 85d184fb9366b2252308d8dc627cb0b8e233bf2d10c10787bb5b17bf323a3bfa
|
4
|
+
data.tar.gz: 01e70bc43a761089a79e9d0137b3f70c801ed22ad5ef90a246934de0dfc84b28
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 178a78fe16e6c3a9f18fa0fb6a2a8c82ab22d02ce159354b3cbf610acaa2a825e31246940622aef6b957cb40d30d8311cc68567430bcb1b3d3cfbb20b2fc75fa
|
7
|
+
data.tar.gz: c1726f1fd4c56fee51df0732b8c119f868431c19f662ae9746a1c251921249fd16d03c1d67a5654dcd3728ae3e1678ba54dd296c90ca9e376d44c9b3c4fe8611
|
data/CHANGES.md
CHANGED
@@ -1,5 +1,15 @@
|
|
1
1
|
# Change Log
|
2
2
|
|
3
|
+
## Version 2.20190508.0 (2019-05-08)
|
4
|
+
|
5
|
+
## Details
|
6
|
+
|
7
|
+
* **Beta functionality**: Orders API — support for fractional quantities,
|
8
|
+
expanded metadata, and embedded information on payments, refunds, and returns.
|
9
|
+
* **Beta functionality**: Inventory API — support for fractional quantities.
|
10
|
+
* **New functionality**: `Locations.business_hours` — read-only field with
|
11
|
+
information about the business hours at a particular location.
|
12
|
+
|
3
13
|
## Version 2.20190410.1 (2019-04-24)
|
4
14
|
|
5
15
|
## Details
|
data/README.md
CHANGED
@@ -10,7 +10,7 @@ for the specification and template files we used to generate this.
|
|
10
10
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
11
11
|
|
12
12
|
- API version: 2.0
|
13
|
-
- Package version: 2.
|
13
|
+
- Package version: 2.20190508.0
|
14
14
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
15
15
|
|
16
16
|
For more information, please visit [https://squareup.com/developers](https://squareup.com/developers)
|
@@ -124,6 +124,7 @@ Class | Method | HTTP request | Description
|
|
124
124
|
*SquareConnect::OAuthApi* | [**revoke_token**](docs/OAuthApi.md#revoke_token) | **POST** /oauth2/revoke | RevokeToken
|
125
125
|
*SquareConnect::OrdersApi* | [**batch_retrieve_orders**](docs/OrdersApi.md#batch_retrieve_orders) | **POST** /v2/locations/{location_id}/orders/batch-retrieve | BatchRetrieveOrders
|
126
126
|
*SquareConnect::OrdersApi* | [**create_order**](docs/OrdersApi.md#create_order) | **POST** /v2/locations/{location_id}/orders | CreateOrder
|
127
|
+
*SquareConnect::OrdersApi* | [**search_orders**](docs/OrdersApi.md#search_orders) | **POST** /v2/orders/search | SearchOrders
|
127
128
|
*SquareConnect::ReportingApi* | [**list_additional_recipient_receivable_refunds**](docs/ReportingApi.md#list_additional_recipient_receivable_refunds) | **GET** /v2/locations/{location_id}/additional-recipient-receivable-refunds | ListAdditionalRecipientReceivableRefunds
|
128
129
|
*SquareConnect::ReportingApi* | [**list_additional_recipient_receivables**](docs/ReportingApi.md#list_additional_recipient_receivables) | **GET** /v2/locations/{location_id}/additional-recipient-receivables | ListAdditionalRecipientReceivables
|
129
130
|
*SquareConnect::TransactionsApi* | [**capture_transaction**](docs/TransactionsApi.md#capture_transaction) | **POST** /v2/locations/{location_id}/transactions/{transaction_id}/capture | CaptureTransaction
|
@@ -225,6 +226,8 @@ Class | Method | HTTP request | Description
|
|
225
226
|
- [SquareConnect::BatchUpsertCatalogObjectsRequest](docs/BatchUpsertCatalogObjectsRequest.md)
|
226
227
|
- [SquareConnect::BatchUpsertCatalogObjectsResponse](docs/BatchUpsertCatalogObjectsResponse.md)
|
227
228
|
- [SquareConnect::BreakType](docs/BreakType.md)
|
229
|
+
- [SquareConnect::BusinessHours](docs/BusinessHours.md)
|
230
|
+
- [SquareConnect::BusinessHoursPeriod](docs/BusinessHoursPeriod.md)
|
228
231
|
- [SquareConnect::CaptureTransactionRequest](docs/CaptureTransactionRequest.md)
|
229
232
|
- [SquareConnect::CaptureTransactionResponse](docs/CaptureTransactionResponse.md)
|
230
233
|
- [SquareConnect::Card](docs/Card.md)
|
@@ -296,6 +299,7 @@ Class | Method | HTTP request | Description
|
|
296
299
|
- [SquareConnect::CustomerSort](docs/CustomerSort.md)
|
297
300
|
- [SquareConnect::CustomerSortField](docs/CustomerSortField.md)
|
298
301
|
- [SquareConnect::DateRange](docs/DateRange.md)
|
302
|
+
- [SquareConnect::DayOfWeek](docs/DayOfWeek.md)
|
299
303
|
- [SquareConnect::DeleteBreakTypeRequest](docs/DeleteBreakTypeRequest.md)
|
300
304
|
- [SquareConnect::DeleteBreakTypeResponse](docs/DeleteBreakTypeResponse.md)
|
301
305
|
- [SquareConnect::DeleteCatalogObjectRequest](docs/DeleteCatalogObjectRequest.md)
|
@@ -354,11 +358,18 @@ Class | Method | HTTP request | Description
|
|
354
358
|
- [SquareConnect::LocationCapability](docs/LocationCapability.md)
|
355
359
|
- [SquareConnect::LocationStatus](docs/LocationStatus.md)
|
356
360
|
- [SquareConnect::LocationType](docs/LocationType.md)
|
361
|
+
- [SquareConnect::MeasurementUnit](docs/MeasurementUnit.md)
|
362
|
+
- [SquareConnect::MeasurementUnitArea](docs/MeasurementUnitArea.md)
|
363
|
+
- [SquareConnect::MeasurementUnitCustom](docs/MeasurementUnitCustom.md)
|
364
|
+
- [SquareConnect::MeasurementUnitLength](docs/MeasurementUnitLength.md)
|
365
|
+
- [SquareConnect::MeasurementUnitVolume](docs/MeasurementUnitVolume.md)
|
366
|
+
- [SquareConnect::MeasurementUnitWeight](docs/MeasurementUnitWeight.md)
|
357
367
|
- [SquareConnect::ModelBreak](docs/ModelBreak.md)
|
358
368
|
- [SquareConnect::Money](docs/Money.md)
|
359
369
|
- [SquareConnect::ObtainTokenRequest](docs/ObtainTokenRequest.md)
|
360
370
|
- [SquareConnect::ObtainTokenResponse](docs/ObtainTokenResponse.md)
|
361
371
|
- [SquareConnect::Order](docs/Order.md)
|
372
|
+
- [SquareConnect::OrderEntry](docs/OrderEntry.md)
|
362
373
|
- [SquareConnect::OrderFulfillment](docs/OrderFulfillment.md)
|
363
374
|
- [SquareConnect::OrderFulfillmentPickupDetails](docs/OrderFulfillmentPickupDetails.md)
|
364
375
|
- [SquareConnect::OrderFulfillmentPickupDetailsScheduleType](docs/OrderFulfillmentPickupDetailsScheduleType.md)
|
@@ -373,7 +384,16 @@ Class | Method | HTTP request | Description
|
|
373
384
|
- [SquareConnect::OrderLineItemTax](docs/OrderLineItemTax.md)
|
374
385
|
- [SquareConnect::OrderLineItemTaxScope](docs/OrderLineItemTaxScope.md)
|
375
386
|
- [SquareConnect::OrderLineItemTaxType](docs/OrderLineItemTaxType.md)
|
387
|
+
- [SquareConnect::OrderMoneyAmounts](docs/OrderMoneyAmounts.md)
|
388
|
+
- [SquareConnect::OrderQuantityUnit](docs/OrderQuantityUnit.md)
|
389
|
+
- [SquareConnect::OrderReturn](docs/OrderReturn.md)
|
390
|
+
- [SquareConnect::OrderReturnDiscount](docs/OrderReturnDiscount.md)
|
391
|
+
- [SquareConnect::OrderReturnLineItem](docs/OrderReturnLineItem.md)
|
392
|
+
- [SquareConnect::OrderReturnLineItemModifier](docs/OrderReturnLineItemModifier.md)
|
393
|
+
- [SquareConnect::OrderReturnTax](docs/OrderReturnTax.md)
|
394
|
+
- [SquareConnect::OrderRoundingAdjustment](docs/OrderRoundingAdjustment.md)
|
376
395
|
- [SquareConnect::OrderSource](docs/OrderSource.md)
|
396
|
+
- [SquareConnect::OrderState](docs/OrderState.md)
|
377
397
|
- [SquareConnect::Product](docs/Product.md)
|
378
398
|
- [SquareConnect::Refund](docs/Refund.md)
|
379
399
|
- [SquareConnect::RefundStatus](docs/RefundStatus.md)
|
@@ -404,6 +424,17 @@ Class | Method | HTTP request | Description
|
|
404
424
|
- [SquareConnect::SearchCatalogObjectsResponse](docs/SearchCatalogObjectsResponse.md)
|
405
425
|
- [SquareConnect::SearchCustomersRequest](docs/SearchCustomersRequest.md)
|
406
426
|
- [SquareConnect::SearchCustomersResponse](docs/SearchCustomersResponse.md)
|
427
|
+
- [SquareConnect::SearchOrdersCustomerFilter](docs/SearchOrdersCustomerFilter.md)
|
428
|
+
- [SquareConnect::SearchOrdersDateTimeFilter](docs/SearchOrdersDateTimeFilter.md)
|
429
|
+
- [SquareConnect::SearchOrdersFilter](docs/SearchOrdersFilter.md)
|
430
|
+
- [SquareConnect::SearchOrdersFulfillmentFilter](docs/SearchOrdersFulfillmentFilter.md)
|
431
|
+
- [SquareConnect::SearchOrdersQuery](docs/SearchOrdersQuery.md)
|
432
|
+
- [SquareConnect::SearchOrdersRequest](docs/SearchOrdersRequest.md)
|
433
|
+
- [SquareConnect::SearchOrdersResponse](docs/SearchOrdersResponse.md)
|
434
|
+
- [SquareConnect::SearchOrdersSort](docs/SearchOrdersSort.md)
|
435
|
+
- [SquareConnect::SearchOrdersSortField](docs/SearchOrdersSortField.md)
|
436
|
+
- [SquareConnect::SearchOrdersSourceFilter](docs/SearchOrdersSourceFilter.md)
|
437
|
+
- [SquareConnect::SearchOrdersStateFilter](docs/SearchOrdersStateFilter.md)
|
407
438
|
- [SquareConnect::SearchShiftsRequest](docs/SearchShiftsRequest.md)
|
408
439
|
- [SquareConnect::SearchShiftsResponse](docs/SearchShiftsResponse.md)
|
409
440
|
- [SquareConnect::Shift](docs/Shift.md)
|
@@ -9,5 +9,6 @@ Name | Type | Description | Notes
|
|
9
9
|
------------ | ------------- | ------------- | -------------
|
10
10
|
**orders** | [**Array<Order>**](Order.md) | The requested orders. This will omit any requested orders that do not exist or are not charged. | [optional]
|
11
11
|
**errors** | [**Array<Error>**](Error.md) | Any errors that occurred during the request. | [optional]
|
12
|
+
**unconvertible_transaction_ids** | **Array<String>** | List of transaction ids within the requested set of ids that encountered transformation issues when being converted to an Order. | [optional]
|
12
13
|
|
13
14
|
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# SquareConnect::BusinessHours
|
2
|
+
|
3
|
+
### Description
|
4
|
+
|
5
|
+
Represents the hours of operation for a business location.
|
6
|
+
|
7
|
+
## Properties
|
8
|
+
Name | Type | Description | Notes
|
9
|
+
------------ | ------------- | ------------- | -------------
|
10
|
+
**periods** | [**Array<BusinessHoursPeriod>**](BusinessHoursPeriod.md) | The list of time periods during which the business is open. There may be at most 10 periods per day. | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# SquareConnect::BusinessHoursPeriod
|
2
|
+
|
3
|
+
### Description
|
4
|
+
|
5
|
+
Represents a period of time during which a business location is open.
|
6
|
+
|
7
|
+
## Properties
|
8
|
+
Name | Type | Description | Notes
|
9
|
+
------------ | ------------- | ------------- | -------------
|
10
|
+
**day_of_week** | **String** | The day of week for this time period. See [DayOfWeek](#type-dayofweek) for possible values | [optional]
|
11
|
+
**start_local_time** | **String** | The start time of a business hours period, specified in local time using partial-time RFC3339 format. | [optional]
|
12
|
+
**end_local_time** | **String** | The end time of a business hours period, specified in local time using partial-time RFC3339 format. | [optional]
|
13
|
+
|
14
|
+
|
data/docs/ChargeRequest.md
CHANGED
@@ -15,9 +15,9 @@ Name | Type | Description | Notes
|
|
15
15
|
**reference_id** | **String** | An optional ID you can associate with the transaction for your own purposes (such as to associate the transaction with an entity ID in your own database). This value cannot exceed 40 characters. | [optional]
|
16
16
|
**note** | **String** | An optional note to associate with the transaction. This value cannot exceed 60 characters. | [optional]
|
17
17
|
**customer_id** | **String** | The ID of the customer to associate this transaction with. This field is required if you provide a value for `customer_card_id`, and optional otherwise. | [optional]
|
18
|
-
**billing_address** | [**Address**](Address.md) | The buyer's billing address.
|
19
|
-
**shipping_address** | [**Address**](Address.md) | The buyer's shipping address, if available.
|
20
|
-
**buyer_email_address** | **String** | The buyer's email address, if available.
|
18
|
+
**billing_address** | [**Address**](Address.md) | The buyer's billing address. | [optional]
|
19
|
+
**shipping_address** | [**Address**](Address.md) | The buyer's shipping address, if available. | [optional]
|
20
|
+
**buyer_email_address** | **String** | The buyer's email address, if available. | [optional]
|
21
21
|
**order_id** | **String** | The ID of the order to associate with this transaction. If you provide this value, the `amount_money` value of your request must __exactly match__ the value of the order's `total_money` field. | [optional]
|
22
22
|
**additional_recipients** | [**Array<AdditionalRecipient>**](AdditionalRecipient.md) | The basic primitive of multi-party transaction. The value is optional. The transaction facilitated by you can be split from here. If you provide this value, the `amount_money` value in your additional_recipients must not be more than 90% of the `amount_money` value in the charge request. The `location_id` must be the valid location of the app owner merchant. This field requires the `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission. This field is currently not supported in sandbox. | [optional]
|
23
23
|
|
data/docs/CreateOrderRequest.md
CHANGED
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
|
|
9
9
|
------------ | ------------- | ------------- | -------------
|
10
10
|
**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
11
|
**idempotency_key** | **String** | 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](/basics/api101/idempotency) for more information. | [optional]
|
12
|
-
**reference_id** | **String** | __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]
|
12
|
+
**reference_id** | **String** | __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. -- Top-level fields necessary to support the connect v2 CreateOrderRequest shape. | [optional]
|
13
13
|
**line_items** | [**Array<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]
|
14
14
|
**taxes** | [**Array<CreateOrderRequestTax>**](CreateOrderRequestTax.md) | __Deprecated__: Please set the taxes on the nested [order](#type-order) field instead. The taxes to include on the order. | [optional]
|
15
15
|
**discounts** | [**Array<CreateOrderRequestDiscount>**](CreateOrderRequestDiscount.md) | __Deprecated__: Please set the discounts on the nested [order](#type-order) field instead. The discounts to include on the order. | [optional]
|
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
|
|
9
9
|
------------ | ------------- | ------------- | -------------
|
10
10
|
**catalog_object_id** | **String** | Only used for catalog taxes. The catalog object ID of an existing [CatalogTax](#type-catalogtax). Do not provide a value for this field if you provide values in other fields for an ad hoc tax. | [optional]
|
11
11
|
**name** | **String** | Only used for ad hoc taxes. The tax's name. Do not provide a value for this field if you set `catalog_object_id`. | [optional]
|
12
|
-
**type** | **String** | Only used for ad hoc taxes. Indicates the calculation method used to apply the line item tax. Default: `ADDITIVE`; See [OrderLineItemTaxType](#type-orderlineitemtaxtype) for possible values | [optional]
|
12
|
+
**type** | **String** | Only used for ad hoc taxes. Indicates the calculation method used to apply the line item tax. Default: `ADDITIVE`; See [OrderLineItemTaxType](#type-orderlineitemtaxtype) for possible values. See [OrderLineItemTaxType](#type-orderlineitemtaxtype) for possible values | [optional]
|
13
13
|
**percentage** | **String** | Only used for ad hoc taxes. The percentage of the tax, as a string representation of a decimal number. A value of `7.25` corresponds to a percentage of 7.25%. This value range between 0.0 up to 100.0 | [optional]
|
14
14
|
|
15
15
|
|
data/docs/DayOfWeek.md
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
# SquareConnect::DayOfWeek
|
2
|
+
|
3
|
+
### Description
|
4
|
+
|
5
|
+
Indicates the specific day of the week.
|
6
|
+
|
7
|
+
## Properties
|
8
|
+
Name | Type
|
9
|
+
------------ | -------------
|
10
|
+
**SUN** | string
|
11
|
+
**MON** | string
|
12
|
+
**TUE** | string
|
13
|
+
**WED** | string
|
14
|
+
**THU** | string
|
15
|
+
**FRI** | string
|
16
|
+
**SAT** | string
|
17
|
+
|
18
|
+
|
data/docs/ErrorCode.md
CHANGED
@@ -80,6 +80,8 @@ Name | Type
|
|
80
80
|
**INVALID_PHONE_NUMBER** | string
|
81
81
|
**CHECKOUT_EXPIRED** | string
|
82
82
|
**BAD_CERTIFICATE** | string
|
83
|
+
**INVALID_SQUARE_VERSION_FORMAT** | string
|
84
|
+
**API_VERSION_INCOMPATIBLE** | string
|
83
85
|
**CARD_DECLINED** | string
|
84
86
|
**VERIFY_CVV_FAILURE** | string
|
85
87
|
**VERIFY_AVS_FAILURE** | string
|
data/docs/InventoryAdjustment.md
CHANGED
@@ -14,7 +14,7 @@ Name | Type | Description | Notes
|
|
14
14
|
**location_id** | **String** | The Square ID of the [Location](#type-location) where the related quantity of items are being tracked. | [optional]
|
15
15
|
**catalog_object_id** | **String** | The Square generated ID of the [CatalogObject](#type-catalogobject) being tracked. | [optional]
|
16
16
|
**catalog_object_type** | **String** | The [CatalogObjectType](#type-catalogobjecttype) of the [CatalogObject](#type-catalogobject) being tracked. Tracking is only supported for the `ITEM_VARIATION` type. | [optional]
|
17
|
-
**quantity** | **String** | The number of items affected by the adjustment as a decimal string.
|
17
|
+
**quantity** | **String** | The number of items affected by the adjustment as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](/more-apis/inventory/overview#decimal-quantities-beta) for more information. | [optional]
|
18
18
|
**total_price_money** | [**Money**](Money.md) | The read-only total price paid for goods associated with the adjustment. Present if and only if `to_state` is `SOLD`. Always non-negative. | [optional]
|
19
19
|
**occurred_at** | **String** | A client-generated timestamp in RFC 3339 format that indicates when the adjustment took place. For write actions, the `occurred_at` timestamp cannot be older than 24 hours or in the future relative to the time of the request. | [optional]
|
20
20
|
**created_at** | **String** | A read-only timestamp in RFC 3339 format that indicates when Square received the adjustment. | [optional]
|
data/docs/InventoryCount.md
CHANGED
@@ -2,7 +2,7 @@
|
|
2
2
|
|
3
3
|
### Description
|
4
4
|
|
5
|
-
Represents
|
5
|
+
Represents Square's estimated quantity of items in a particular state at a particular location based on the known history of physical counts and inventory adjustments
|
6
6
|
|
7
7
|
## Properties
|
8
8
|
Name | Type | Description | Notes
|
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
|
|
11
11
|
**catalog_object_type** | **String** | The [CatalogObjectType](#type-catalogobjecttype) of the [CatalogObject](#type-catalogobject) being tracked. Tracking is only supported for the `ITEM_VARIATION` type. | [optional]
|
12
12
|
**state** | **String** | The current [InventoryState](#type-inventorystate) for the related quantity of items. See [InventoryState](#type-inventorystate) for possible values | [optional]
|
13
13
|
**location_id** | **String** | The Square ID of the [Location](#type-location) where the related quantity of items are being tracked. | [optional]
|
14
|
-
**quantity** | **String** | The number of items in the count as a decimal string.
|
14
|
+
**quantity** | **String** | The number of items in the count as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](/more-apis/inventory/overview#decimal-quantities-beta) for more information. | [optional]
|
15
15
|
**calculated_at** | **String** | A read-only timestamp in RFC 3339 format that indicates when Square received the most recent physical count or adjustment that had an affect on the estimated count. | [optional]
|
16
16
|
|
17
17
|
|
@@ -2,7 +2,7 @@
|
|
2
2
|
|
3
3
|
### Description
|
4
4
|
|
5
|
-
Represents
|
5
|
+
Represents the quantity of an item variation that is physically present at a specific location, verified by a seller or a seller's employee. For example, a physical count might come from an employee counting the item variations on hand or from syncing with an external system.
|
6
6
|
|
7
7
|
## Properties
|
8
8
|
Name | Type | Description | Notes
|
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
|
|
13
13
|
**catalog_object_type** | **String** | The [CatalogObjectType](#type-catalogobjecttype) of the [CatalogObject](#type-catalogobject) being tracked. Tracking is only supported for the `ITEM_VARIATION` type. | [optional]
|
14
14
|
**state** | **String** | The current [InventoryState](#type-inventorystate) for the related quantity of items. See [InventoryState](#type-inventorystate) for possible values | [optional]
|
15
15
|
**location_id** | **String** | The Square ID of the [Location](#type-location) where the related quantity of items are being tracked. | [optional]
|
16
|
-
**quantity** | **String** | The number of items affected by the physical count as a decimal string.
|
16
|
+
**quantity** | **String** | The number of items affected by the physical count as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](/more-apis/inventory/overview#decimal-quantities-beta) for more information. | [optional]
|
17
17
|
**source** | [**SourceApplication**](SourceApplication.md) | Read-only information about the application that submitted the physical count. | [optional]
|
18
18
|
**employee_id** | **String** | The Square ID of the [Employee](#type-employee) responsible for the physical count. | [optional]
|
19
19
|
**occurred_at** | **String** | A client-generated timestamp in RFC 3339 format that indicates when the physical count took place. For write actions, the `occurred_at` timestamp cannot be older than 24 hours or in the future relative to the time of the request. | [optional]
|
data/docs/InventoryTransfer.md
CHANGED
@@ -14,7 +14,7 @@ Name | Type | Description | Notes
|
|
14
14
|
**to_location_id** | **String** | The Square ID of the [Location](#type-location) where the related quantity of items were tracked after the transfer. | [optional]
|
15
15
|
**catalog_object_id** | **String** | The Square generated ID of the [CatalogObject](#type-catalogobject) being tracked. | [optional]
|
16
16
|
**catalog_object_type** | **String** | The [CatalogObjectType](#type-catalogobjecttype) of the [CatalogObject](#type-catalogobject) being tracked.Tracking is only supported for the `ITEM_VARIATION` type. | [optional]
|
17
|
-
**quantity** | **String** | The number of items affected by the transfer as a decimal string.
|
17
|
+
**quantity** | **String** | The number of items affected by the transfer as a decimal string. Can support up to 5 digits after the decimal point. _Important_: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, `2.5` will become `2`, and `-2.5` will become `-3`. Read [Decimal Quantities (BETA)](/more-apis/inventory/overview#decimal-quantities-beta) for more information. | [optional]
|
18
18
|
**occurred_at** | **String** | A client-generated timestamp in RFC 3339 format that indicates when the transfer took place. For write actions, the `occurred_at` timestamp cannot be older than 24 hours or in the future relative to the time of the request. | [optional]
|
19
19
|
**created_at** | **String** | A read-only timestamp in RFC 3339 format that indicates when Square received the transfer request. | [optional]
|
20
20
|
**source** | [**SourceApplication**](SourceApplication.md) | Read-only information about the application that initiated the inventory transfer. | [optional]
|
data/docs/Location.md
CHANGED
@@ -22,5 +22,6 @@ Name | Type | Description | Notes
|
|
22
22
|
**business_name** | **String** | The location's business_name which is shown to its customers. For example, this is the name printed on its customer's receipts. | [optional]
|
23
23
|
**type** | **String** | The location's type, as set by the account owner in the Square dashboard. Typically used to indicate whether or not the location object represents a physical space like a building or mall space. See [LocationType](#type-locationtype) for possible values | [optional]
|
24
24
|
**website_url** | **String** | The location's website, as set by the account owner in the Square dashboard. Default: none; only exists if explicitly set. | [optional]
|
25
|
+
**business_hours** | [**BusinessHours**](BusinessHours.md) | The hours of operation for a business location. Default: none; only exists if explicitly set. | [optional]
|
25
26
|
|
26
27
|
|
@@ -0,0 +1,16 @@
|
|
1
|
+
# SquareConnect::MeasurementUnit
|
2
|
+
|
3
|
+
### Description
|
4
|
+
|
5
|
+
Represents a unit of measurement to use with a quantity, such as ounces or inches. Exactly one of the following fields are required: `custom_unit`, `area_unit`, `length_unit`, `volume_unit`, and `weight_unit`. The `family` field describes the type of measurement. For example, ounces are in the weight family.
|
6
|
+
|
7
|
+
## Properties
|
8
|
+
Name | Type | Description | Notes
|
9
|
+
------------ | ------------- | ------------- | -------------
|
10
|
+
**custom_unit** | [**MeasurementUnitCustom**](MeasurementUnitCustom.md) | A custom unit of measurement defined by the seller using the Point of Sale app or ad-hoc as an order line item. | [optional]
|
11
|
+
**area_unit** | **String** | Represents a standard area unit. See [MeasurementUnitArea](#type-measurementunitarea) for possible values | [optional]
|
12
|
+
**length_unit** | **String** | Represents a standard length unit. See [MeasurementUnitLength](#type-measurementunitlength) for possible values | [optional]
|
13
|
+
**volume_unit** | **String** | Represents a standard volume unit. See [MeasurementUnitVolume](#type-measurementunitvolume) for possible values | [optional]
|
14
|
+
**weight_unit** | **String** | Represents a standard unit of weight or mass. See [MeasurementUnitWeight](#type-measurementunitweight) for possible values | [optional]
|
15
|
+
|
16
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# SquareConnect::MeasurementUnitArea
|
2
|
+
|
3
|
+
### Description
|
4
|
+
|
5
|
+
Unit of area used to measure a quantity.
|
6
|
+
|
7
|
+
## Properties
|
8
|
+
Name | Type
|
9
|
+
------------ | -------------
|
10
|
+
**IMPERIAL_ACRE** | string
|
11
|
+
**IMPERIAL_SQUARE_INCH** | string
|
12
|
+
**IMPERIAL_SQUARE_FOOT** | string
|
13
|
+
**IMPERIAL_SQUARE_YARD** | string
|
14
|
+
**IMPERIAL_SQUARE_MILE** | string
|
15
|
+
**METRIC_SQUARE_CENTIMETER** | string
|
16
|
+
**METRIC_SQUARE_METER** | string
|
17
|
+
**METRIC_SQUARE_KILOMETER** | string
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# SquareConnect::MeasurementUnitCustom
|
2
|
+
|
3
|
+
### Description
|
4
|
+
|
5
|
+
The information needed to define a custom unit, provided by the seller.
|
6
|
+
|
7
|
+
## Properties
|
8
|
+
Name | Type | Description | Notes
|
9
|
+
------------ | ------------- | ------------- | -------------
|
10
|
+
**name** | **String** | The name of the custom unit, for example \"bushel\". |
|
11
|
+
**abbreviation** | **String** | The abbreviation of the custom unit, such as \"bsh\" (bushel). This appears in the cart for the Point of Sale app, and in reports. |
|
12
|
+
|
13
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# SquareConnect::MeasurementUnitLength
|
2
|
+
|
3
|
+
### Description
|
4
|
+
|
5
|
+
The unit of length used to measure a quantity.
|
6
|
+
|
7
|
+
## Properties
|
8
|
+
Name | Type
|
9
|
+
------------ | -------------
|
10
|
+
**IMPERIAL_INCH** | string
|
11
|
+
**IMPERIAL_FOOT** | string
|
12
|
+
**IMPERIAL_YARD** | string
|
13
|
+
**IMPERIAL_MILE** | string
|
14
|
+
**METRIC_MILLIMETER** | string
|
15
|
+
**METRIC_CENTIMETER** | string
|
16
|
+
**METRIC_METER** | string
|
17
|
+
**METRIC_KILOMETER** | string
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# SquareConnect::MeasurementUnitVolume
|
2
|
+
|
3
|
+
### Description
|
4
|
+
|
5
|
+
The unit of volume used to measure a quantity.
|
6
|
+
|
7
|
+
## Properties
|
8
|
+
Name | Type
|
9
|
+
------------ | -------------
|
10
|
+
**GENERIC_FLUID_OUNCE** | string
|
11
|
+
**GENERIC_SHOT** | string
|
12
|
+
**GENERIC_CUP** | string
|
13
|
+
**GENERIC_PINT** | string
|
14
|
+
**GENERIC_QUART** | string
|
15
|
+
**GENERIC_GALLON** | string
|
16
|
+
**IMPERIAL_CUBIC_INCH** | string
|
17
|
+
**IMPERIAL_CUBIC_FOOT** | string
|
18
|
+
**IMPERIAL_CUBIC_YARD** | string
|
19
|
+
**METRIC_MILLILITER** | string
|
20
|
+
**METRIC_LITER** | string
|
21
|
+
|
22
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# SquareConnect::MeasurementUnitWeight
|
2
|
+
|
3
|
+
### Description
|
4
|
+
|
5
|
+
Unit of weight used to measure a quantity.
|
6
|
+
|
7
|
+
## Properties
|
8
|
+
Name | Type
|
9
|
+
------------ | -------------
|
10
|
+
**IMPERIAL_WEIGHT_OUNCE** | string
|
11
|
+
**IMPERIAL_POUND** | string
|
12
|
+
**IMPERIAL_STONE** | string
|
13
|
+
**METRIC_MILLIGRAM** | string
|
14
|
+
**METRIC_GRAM** | string
|
15
|
+
**METRIC_KILOGRAM** | string
|
16
|
+
|
17
|
+
|
data/docs/Order.md
CHANGED
@@ -2,7 +2,7 @@
|
|
2
2
|
|
3
3
|
### Description
|
4
4
|
|
5
|
-
Contains all information related to a single order to process with Square, including line items that specify the products to purchase
|
5
|
+
Contains all information related to a single order to process with Square, including line items that specify the products to purchase. Order objects also include information on any associated tenders, refunds, and returns. All Connect V2 Transactions have all been converted to Orders including all associated itemization data.
|
6
6
|
|
7
7
|
## Properties
|
8
8
|
Name | Type | Description | Notes
|
@@ -11,10 +11,21 @@ Name | Type | Description | Notes
|
|
11
11
|
**location_id** | **String** | The ID of the merchant location this order is associated with. |
|
12
12
|
**reference_id** | **String** | A client specified identifier to associate an entity in another system with this order. | [optional]
|
13
13
|
**source** | [**OrderSource**](OrderSource.md) | The origination details of the order. | [optional]
|
14
|
+
**customer_id** | **String** | The [Customer](#type-customer) ID of the customer associated with the order. | [optional]
|
14
15
|
**line_items** | [**Array<OrderLineItem>**](OrderLineItem.md) | The line items included in the order. | [optional]
|
15
16
|
**taxes** | [**Array<OrderLineItemTax>**](OrderLineItemTax.md) | A list of taxes applied to this order. On read or retrieve, this list includes both order-level and item-level taxes. When creating an Order, set your order-level taxes in this list. | [optional]
|
16
17
|
**discounts** | [**Array<OrderLineItemDiscount>**](OrderLineItemDiscount.md) | A list of discounts applied to this order. On read or retrieve, this list includes both order-level and item-level discounts. When creating an Order, set your order-level discounts in this list. | [optional]
|
17
18
|
**fulfillments** | [**Array<OrderFulfillment>**](OrderFulfillment.md) | Details on order fulfillment. Orders can only be created with at most one fulfillment. However, orders returned by the API may contain multiple fulfillments. | [optional]
|
19
|
+
**returns** | [**Array<OrderReturn>**](OrderReturn.md) | Collection of items from sale Orders being returned in this one. Normally part of an Itemized Return or Exchange. There will be exactly one `Return` object per sale Order being referenced. | [optional]
|
20
|
+
**return_amounts** | [**OrderMoneyAmounts**](OrderMoneyAmounts.md) | Rollup of returned money amounts. | [optional]
|
21
|
+
**net_amounts** | [**OrderMoneyAmounts**](OrderMoneyAmounts.md) | Net money amounts (sale money - return money). | [optional]
|
22
|
+
**rounding_adjustment** | [**OrderRoundingAdjustment**](OrderRoundingAdjustment.md) | A positive or negative rounding adjustment to the total of the order, commonly used to apply Cash Rounding when the minimum unit of account is smaller than the lowest physical denomination of currency. | [optional]
|
23
|
+
**tenders** | [**Array<Tender>**](Tender.md) | The Tenders which were used to pay for the Order. This field is read-only. | [optional]
|
24
|
+
**refunds** | [**Array<Refund>**](Refund.md) | The Refunds that are part of this Order. This field is read-only. | [optional]
|
25
|
+
**created_at** | **String** | Timestamp for when the order was created. In RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional]
|
26
|
+
**updated_at** | **String** | Timestamp for when the order was last updated. In RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional]
|
27
|
+
**closed_at** | **String** | Timestamp for when the order was closed. In RFC 3339 format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional]
|
28
|
+
**state** | **String** | The current state of the order. `OPEN`,`COMPLETED`,`CANCELED` See [OrderState](#type-orderstate) for possible values | [optional]
|
18
29
|
**total_money** | [**Money**](Money.md) | The total amount of money to collect for the order. | [optional]
|
19
30
|
**total_tax_money** | [**Money**](Money.md) | The total tax amount of money to collect for the order. | [optional]
|
20
31
|
**total_discount_money** | [**Money**](Money.md) | The total discount amount of money to collect for the order. | [optional]
|
data/docs/OrderEntry.md
ADDED
@@ -0,0 +1,13 @@
|
|
1
|
+
# SquareConnect::OrderEntry
|
2
|
+
|
3
|
+
### Description
|
4
|
+
|
5
|
+
A lightweight description of an [Order](#type-order) that is returned when `returned_entries` is true on a [SearchOrderRequest](#type-searchorderrequest)
|
6
|
+
|
7
|
+
## Properties
|
8
|
+
Name | Type | Description | Notes
|
9
|
+
------------ | ------------- | ------------- | -------------
|
10
|
+
**order_id** | **String** | The id of the Order | [optional]
|
11
|
+
**location_id** | **String** | The location id the Order belongs to. | [optional]
|
12
|
+
|
13
|
+
|
data/docs/OrderLineItem.md
CHANGED
@@ -7,8 +7,10 @@ Represents a line item in an order. Each line item describes a different product
|
|
7
7
|
## Properties
|
8
8
|
Name | Type | Description | Notes
|
9
9
|
------------ | ------------- | ------------- | -------------
|
10
|
+
**uid** | **String** | The line item's Unique identifier, unique only within this order. This field is read-only. | [optional]
|
10
11
|
**name** | **String** | The name of the line item. | [optional]
|
11
|
-
**quantity** | **String** | The quantity purchased, as a
|
12
|
+
**quantity** | **String** | The quantity purchased, formatted as a decimal number. For example: `\"3\"`. Line items with a `quantity_unit` can have non-integer quantities. For example: `\"1.70000\"`. Orders Hub and older versions of Connect do not support non-integer quantities. See [Decimal quantities with Orders hub and older versions of Connect](/more-apis/orders/overview#decimal-quantities). |
|
13
|
+
**quantity_unit** | [**OrderQuantityUnit**](OrderQuantityUnit.md) | The unit and precision that this line item's quantity is measured in. | [optional]
|
12
14
|
**note** | **String** | The note of the line item. | [optional]
|
13
15
|
**catalog_object_id** | **String** | The [CatalogItemVariation](#type-catalogitemvariation) id applied to this line item. | [optional]
|
14
16
|
**variation_name** | **String** | The name of the variation applied to this line item. | [optional]
|
@@ -16,7 +18,8 @@ Name | Type | Description | Notes
|
|
16
18
|
**taxes** | [**Array<OrderLineItemTax>**](OrderLineItemTax.md) | A list of taxes applied to this line item. On read or retrieve, this list includes both item-level taxes and any order-level taxes apportioned to this item. When creating an Order, set your item-level taxes in this list. | [optional]
|
17
19
|
**discounts** | [**Array<OrderLineItemDiscount>**](OrderLineItemDiscount.md) | A list of discounts applied to this line item. On read or retrieve, this list includes both item-level discounts and any order-level discounts apportioned to this item. When creating an Order, set your item-level discounts in this list. | [optional]
|
18
20
|
**base_price_money** | [**Money**](Money.md) | The base price for a single unit of the line item. | [optional]
|
19
|
-
**
|
21
|
+
**variation_total_price_money** | [**Money**](Money.md) | The total price of all item variations sold in this line item. Calculated as `base_price_money` multiplied by `quantity`. Does not include modifiers. | [optional]
|
22
|
+
**gross_sales_money** | [**Money**](Money.md) | The amount of money made in gross sales for this line item. Calculated as the sum of the variation's total price and each modifier's total price. | [optional]
|
20
23
|
**total_tax_money** | [**Money**](Money.md) | The total tax amount of money to collect for the line item. | [optional]
|
21
24
|
**total_discount_money** | [**Money**](Money.md) | The total discount amount of money to collect for the line item. | [optional]
|
22
25
|
**total_money** | [**Money**](Money.md) | The total amount of money to collect for this line item. | [optional]
|