Server : ApacheSystem : Linux host.digitalbabaji.in 4.18.0-513.11.1.el8_9.x86_64 #1 SMP Wed Jan 17 02:00:40 EST 2024 x86_64 User : addictionfreeind ( 1003) PHP Version : 7.2.34 Disable Function : exec,passthru,shell_exec,system Directory : /home/addictionfreeind/www/admin1/vendor/square/square/doc/models/ |
Upload File : |
# Create Order Request
## Structure
`CreateOrderRequest`
## Fields
| Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- |
| `order` | [`?Order`](/doc/models/order.md) | Optional | 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 |
| `idempotencyKey` | `?string` | Optional | A value you specify that uniquely identifies this<br>order among orders you have created.<br><br>If you are unsure whether a particular order was created successfully,<br>you can try it again with the same idempotency key without<br>worrying about creating duplicate orders.<br><br>For more information, see [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency).<br>**Constraints**: *Maximum Length*: `192` | getIdempotencyKey(): ?string | setIdempotencyKey(?string idempotencyKey): void |
## Example (as JSON)
```json
{
"idempotency_key": "8193148c-9586-11e6-99f9-28cfe92138cf",
"order": {
"discounts": [
{
"name": "Labor Day Sale",
"percentage": "5",
"scope": "ORDER",
"uid": "labor-day-sale"
},
{
"catalog_object_id": "DB7L55ZH2BGWI4H23ULIWOQ7",
"scope": "ORDER",
"uid": "membership-discount"
},
{
"amount_money": {
"amount": 100,
"currency": "USD"
},
"name": "Sale - $1.00 off",
"scope": "LINE_ITEM",
"uid": "one-dollar-off"
}
],
"line_items": [
{
"base_price_money": {
"amount": 1599,
"currency": "USD"
},
"name": "New York Strip Steak",
"quantity": "1"
},
{
"applied_discounts": [
{
"discount_uid": "one-dollar-off"
}
],
"catalog_object_id": "BEMYCSMIJL46OCDV4KYIKXIB",
"modifiers": [
{
"catalog_object_id": "CHQX7Y4KY6N5KINJKZCFURPZ"
}
],
"quantity": "2"
}
],
"location_id": "057P5VYJ4A5X1",
"reference_id": "my-order-001",
"taxes": [
{
"name": "State Sales Tax",
"percentage": "9",
"scope": "ORDER",
"uid": "state-sales-tax"
}
]
}
}
```