FileMaster
Search
Toggle Dark Mode
Home
/
.
/
wp-content
/
plugins
/
ameliabooking
/
vendor
/
square
/
square
/
doc
/
models
Edit File: calculate-order-request.md
# Calculate Order Request ## Structure `CalculateOrderRequest` ## Fields | Name | Type | Tags | Description | Getter | Setter | | --- | --- | --- | --- | --- | --- | | `order` | [`Order`](../../doc/models/order.md) | Required | Contains all information related to a single order to process with Square,<br>including line items that specify the products to purchase. `Order` objects also<br>include information about any associated tenders, refunds, and returns.<br><br>All Connect V2 Transactions have all been converted to Orders including all associated<br>itemization data. | getOrder(): Order | setOrder(Order order): void | | `proposedRewards` | [`?(OrderReward[])`](../../doc/models/order-reward.md) | Optional | Identifies one or more loyalty reward tiers to apply during the order calculation.<br>The discounts defined by the reward tiers are added to the order only to preview the<br>effect of applying the specified rewards. The rewards do not correspond to actual<br>redemptions; that is, no `reward`s are created. Therefore, the reward `id`s are<br>random strings used only to reference the reward tier. | getProposedRewards(): ?array | setProposedRewards(?array proposedRewards): void | ## Example (as JSON) ```json { "idempotency_key": "b3e98fe3-b8de-471c-82f1-545f371e637c", "order": { "discounts": [ { "name": "50% Off", "percentage": "50", "scope": "ORDER" } ], "line_items": [ { "base_price_money": { "amount": 500, "currency": "USD" }, "name": "Item 1", "quantity": "1", "uid": "uid8", "quantity_unit": { "measurement_unit": { "custom_unit": { "name": "name2", "abbreviation": "abbreviation4" }, "area_unit": "IMPERIAL_ACRE", "length_unit": "IMPERIAL_INCH", "volume_unit": "METRIC_LITER", "weight_unit": "IMPERIAL_WEIGHT_OUNCE" }, "precision": 54, "catalog_object_id": "catalog_object_id0", "catalog_version": 12 }, "note": "note4", "catalog_object_id": "catalog_object_id2" }, { "base_price_money": { "amount": 300, "currency": "USD" }, "name": "Item 2", "quantity": "2", "uid": "uid8", "quantity_unit": { "measurement_unit": { "custom_unit": { "name": "name2", "abbreviation": "abbreviation4" }, "area_unit": "IMPERIAL_ACRE", "length_unit": "IMPERIAL_INCH", "volume_unit": "METRIC_LITER", "weight_unit": "IMPERIAL_WEIGHT_OUNCE" }, "precision": 54, "catalog_object_id": "catalog_object_id0", "catalog_version": 12 }, "note": "note4", "catalog_object_id": "catalog_object_id2" } ], "location_id": "D7AVYMEAPJ3A3", "id": "id6", "reference_id": "reference_id4", "source": { "name": "name4" }, "customer_id": "customer_id4" }, "proposed_rewards": [ { "id": "id0", "reward_tier_id": "reward_tier_id6" } ] } ```
Save
Back