FileMaster
Search
Toggle Dark Mode
Home
/
.
/
wp-content
/
plugins
/
ameliabooking
/
vendor
/
square
/
square
/
doc
/
apis
Edit File: orders.md
# Orders ```php $ordersApi = $client->getOrdersApi(); ``` ## Class Name `OrdersApi` ## Methods * [Create Order](../../doc/apis/orders.md#create-order) * [Batch Retrieve Orders](../../doc/apis/orders.md#batch-retrieve-orders) * [Calculate Order](../../doc/apis/orders.md#calculate-order) * [Clone Order](../../doc/apis/orders.md#clone-order) * [Search Orders](../../doc/apis/orders.md#search-orders) * [Retrieve Order](../../doc/apis/orders.md#retrieve-order) * [Update Order](../../doc/apis/orders.md#update-order) * [Pay Order](../../doc/apis/orders.md#pay-order) # Create Order Creates a new [order](../../doc/models/order.md) that can include information about products for purchase and settings to apply to the purchase. To pay for a created order, see [Pay for Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders). You can modify open orders using the [UpdateOrder](../../doc/apis/orders.md#update-order) endpoint. ```php function createOrder(CreateOrderRequest $body): ApiResponse ``` ## Parameters | Parameter | Type | Tags | Description | | --- | --- | --- | --- | | `body` | [`CreateOrderRequest`](../../doc/models/create-order-request.md) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. | ## Response Type This method returns a `Square\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`CreateOrderResponse`](../../doc/models/create-order-response.md). ## Example Usage ```php $body = CreateOrderRequestBuilder::init() ->order( OrderBuilder::init( '057P5VYJ4A5X1' ) ->referenceId('my-order-001') ->lineItems( [ OrderLineItemBuilder::init( '1' ) ->name('New York Strip Steak') ->basePriceMoney( MoneyBuilder::init() ->amount(1599) ->currency(Currency::USD) ->build() ) ->build(), OrderLineItemBuilder::init( '2' ) ->catalogObjectId('BEMYCSMIJL46OCDV4KYIKXIB') ->modifiers( [ OrderLineItemModifierBuilder::init() ->catalogObjectId('CHQX7Y4KY6N5KINJKZCFURPZ') ->build() ] ) ->appliedDiscounts( [ OrderLineItemAppliedDiscountBuilder::init( 'one-dollar-off' )->build() ] )->build() ] ) ->taxes( [ OrderLineItemTaxBuilder::init() ->uid('state-sales-tax') ->name('State Sales Tax') ->percentage('9') ->scope(OrderLineItemTaxScope::ORDER) ->build() ] ) ->discounts( [ OrderLineItemDiscountBuilder::init() ->uid('labor-day-sale') ->name('Labor Day Sale') ->percentage('5') ->scope(OrderLineItemDiscountScope::ORDER) ->build(), OrderLineItemDiscountBuilder::init() ->uid('membership-discount') ->catalogObjectId('DB7L55ZH2BGWI4H23ULIWOQ7') ->scope(OrderLineItemDiscountScope::ORDER) ->build(), OrderLineItemDiscountBuilder::init() ->uid('one-dollar-off') ->name('Sale - $1.00 off') ->amountMoney( MoneyBuilder::init() ->amount(100) ->currency(Currency::USD) ->build() ) ->scope(OrderLineItemDiscountScope::LINE_ITEM) ->build() ] ) ->build() ) ->idempotencyKey('8193148c-9586-11e6-99f9-28cfe92138cf') ->build(); $apiResponse = $ordersApi->createOrder($body); if ($apiResponse->isSuccess()) { $createOrderResponse = $apiResponse->getResult(); } else { $errors = $apiResponse->getErrors(); } // Getting more response information var_dump($apiResponse->getStatusCode()); var_dump($apiResponse->getHeaders()); ``` # Batch Retrieve Orders Retrieves a set of [orders](../../doc/models/order.md) by their IDs. If a given order ID does not exist, the ID is ignored instead of generating an error. ```php function batchRetrieveOrders(BatchRetrieveOrdersRequest $body): ApiResponse ``` ## Parameters | Parameter | Type | Tags | Description | | --- | --- | --- | --- | | `body` | [`BatchRetrieveOrdersRequest`](../../doc/models/batch-retrieve-orders-request.md) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. | ## Response Type This method returns a `Square\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`BatchRetrieveOrdersResponse`](../../doc/models/batch-retrieve-orders-response.md). ## Example Usage ```php $body = BatchRetrieveOrdersRequestBuilder::init( [ 'CAISEM82RcpmcFBM0TfOyiHV3es', 'CAISENgvlJ6jLWAzERDzjyHVybY' ] ) ->locationId('057P5VYJ4A5X1') ->build(); $apiResponse = $ordersApi->batchRetrieveOrders($body); if ($apiResponse->isSuccess()) { $batchRetrieveOrdersResponse = $apiResponse->getResult(); } else { $errors = $apiResponse->getErrors(); } // Getting more response information var_dump($apiResponse->getStatusCode()); var_dump($apiResponse->getHeaders()); ``` # Calculate Order Enables applications to preview order pricing without creating an order. ```php function calculateOrder(CalculateOrderRequest $body): ApiResponse ``` ## Parameters | Parameter | Type | Tags | Description | | --- | --- | --- | --- | | `body` | [`CalculateOrderRequest`](../../doc/models/calculate-order-request.md) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. | ## Response Type This method returns a `Square\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`CalculateOrderResponse`](../../doc/models/calculate-order-response.md). ## Example Usage ```php $body = CalculateOrderRequestBuilder::init( OrderBuilder::init( 'D7AVYMEAPJ3A3' ) ->lineItems( [ OrderLineItemBuilder::init( '1' ) ->name('Item 1') ->basePriceMoney( MoneyBuilder::init() ->amount(500) ->currency(Currency::USD) ->build() ) ->build(), OrderLineItemBuilder::init( '2' ) ->name('Item 2') ->basePriceMoney( MoneyBuilder::init() ->amount(300) ->currency(Currency::USD) ->build() ) ->build() ] ) ->discounts( [ OrderLineItemDiscountBuilder::init() ->name('50% Off') ->percentage('50') ->scope(OrderLineItemDiscountScope::ORDER) ->build() ] ) ->build() )->build(); $apiResponse = $ordersApi->calculateOrder($body); if ($apiResponse->isSuccess()) { $calculateOrderResponse = $apiResponse->getResult(); } else { $errors = $apiResponse->getErrors(); } // Getting more response information var_dump($apiResponse->getStatusCode()); var_dump($apiResponse->getHeaders()); ``` # Clone Order Creates a new order, in the `DRAFT` state, by duplicating an existing order. The newly created order has only the core fields (such as line items, taxes, and discounts) copied from the original order. ```php function cloneOrder(CloneOrderRequest $body): ApiResponse ``` ## Parameters | Parameter | Type | Tags | Description | | --- | --- | --- | --- | | `body` | [`CloneOrderRequest`](../../doc/models/clone-order-request.md) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. | ## Response Type This method returns a `Square\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`CloneOrderResponse`](../../doc/models/clone-order-response.md). ## Example Usage ```php $body = CloneOrderRequestBuilder::init( 'ZAISEM52YcpmcWAzERDOyiWS123' ) ->version(3) ->idempotencyKey('UNIQUE_STRING') ->build(); $apiResponse = $ordersApi->cloneOrder($body); if ($apiResponse->isSuccess()) { $cloneOrderResponse = $apiResponse->getResult(); } else { $errors = $apiResponse->getErrors(); } // Getting more response information var_dump($apiResponse->getStatusCode()); var_dump($apiResponse->getHeaders()); ``` # Search Orders Search all orders for one or more locations. Orders include all sales, returns, and exchanges regardless of how or when they entered the Square ecosystem (such as Point of Sale, Invoices, and Connect APIs). `SearchOrders` requests need to specify which locations to search and define a [SearchOrdersQuery](../../doc/models/search-orders-query.md) object that controls how to sort or filter the results. Your `SearchOrdersQuery` can: Set filter criteria. Set the sort order. Determine whether to return results as complete `Order` objects or as [OrderEntry](../../doc/models/order-entry.md) objects. Note that details for orders processed with Square Point of Sale while in offline mode might not be transmitted to Square for up to 72 hours. Offline orders have a `created_at` value that reflects the time the order was created, not the time it was subsequently transmitted to Square. ```php function searchOrders(SearchOrdersRequest $body): ApiResponse ``` ## Parameters | Parameter | Type | Tags | Description | | --- | --- | --- | --- | | `body` | [`SearchOrdersRequest`](../../doc/models/search-orders-request.md) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. | ## Response Type This method returns a `Square\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`SearchOrdersResponse`](../../doc/models/search-orders-response.md). ## Example Usage ```php $body = SearchOrdersRequestBuilder::init() ->locationIds( [ '057P5VYJ4A5X1', '18YC4JDH91E1H' ] ) ->query( SearchOrdersQueryBuilder::init() ->filter( SearchOrdersFilterBuilder::init() ->stateFilter( SearchOrdersStateFilterBuilder::init( [ OrderState::COMPLETED ] )->build() ) ->dateTimeFilter( SearchOrdersDateTimeFilterBuilder::init() ->closedAt( TimeRangeBuilder::init() ->startAt('2018-03-03T20:00:00+00:00') ->endAt('2019-03-04T21:54:45+00:00') ->build() ) ->build() ) ->build() ) ->sort( SearchOrdersSortBuilder::init( SearchOrdersSortField::CLOSED_AT ) ->sortOrder(SortOrder::DESC) ->build() ) ->build() ) ->limit(3) ->returnEntries(true) ->build(); $apiResponse = $ordersApi->searchOrders($body); if ($apiResponse->isSuccess()) { $searchOrdersResponse = $apiResponse->getResult(); } else { $errors = $apiResponse->getErrors(); } // Getting more response information var_dump($apiResponse->getStatusCode()); var_dump($apiResponse->getHeaders()); ``` # Retrieve Order Retrieves an [Order](../../doc/models/order.md) by ID. ```php function retrieveOrder(string $orderId): ApiResponse ``` ## Parameters | Parameter | Type | Tags | Description | | --- | --- | --- | --- | | `orderId` | `string` | Template, Required | The ID of the order to retrieve. | ## Response Type This method returns a `Square\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`RetrieveOrderResponse`](../../doc/models/retrieve-order-response.md). ## Example Usage ```php $orderId = 'order_id6'; $apiResponse = $ordersApi->retrieveOrder($orderId); if ($apiResponse->isSuccess()) { $retrieveOrderResponse = $apiResponse->getResult(); } else { $errors = $apiResponse->getErrors(); } // Getting more response information var_dump($apiResponse->getStatusCode()); var_dump($apiResponse->getHeaders()); ``` # Update Order Updates an open [order](../../doc/models/order.md) by adding, replacing, or deleting fields. Orders with a `COMPLETED` or `CANCELED` state cannot be updated. An `UpdateOrder` request requires the following: - The `order_id` in the endpoint path, identifying the order to update. - The latest `version` of the order to update. - The [sparse order](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#sparse-order-objects) containing only the fields to update and the version to which the update is being applied. - If deleting fields, the [dot notation paths](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#identifying-fields-to-delete) identifying the fields to clear. To pay for an order, see [Pay for Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders). ```php function updateOrder(string $orderId, UpdateOrderRequest $body): ApiResponse ``` ## Parameters | Parameter | Type | Tags | Description | | --- | --- | --- | --- | | `orderId` | `string` | Template, Required | The ID of the order to update. | | `body` | [`UpdateOrderRequest`](../../doc/models/update-order-request.md) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. | ## Response Type This method returns a `Square\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`UpdateOrderResponse`](../../doc/models/update-order-response.md). ## Example Usage ```php $orderId = 'order_id6'; $body = UpdateOrderRequestBuilder::init()->build(); $apiResponse = $ordersApi->updateOrder( $orderId, $body ); if ($apiResponse->isSuccess()) { $updateOrderResponse = $apiResponse->getResult(); } else { $errors = $apiResponse->getErrors(); } // Getting more response information var_dump($apiResponse->getStatusCode()); var_dump($apiResponse->getHeaders()); ``` # Pay Order Pay for an [order](../../doc/models/order.md) using one or more approved [payments](../../doc/models/payment.md) or settle an order with a total of `0`. The total of the `payment_ids` listed in the request must be equal to the order total. Orders with a total amount of `0` can be marked as paid by specifying an empty array of `payment_ids` in the request. To be used with `PayOrder`, a payment must: - Reference the order by specifying the `order_id` when [creating the payment](../../doc/apis/payments.md#create-payment). Any approved payments that reference the same `order_id` not specified in the `payment_ids` is canceled. - Be approved with [delayed capture](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture). Using a delayed capture payment with `PayOrder` completes the approved payment. ```php function payOrder(string $orderId, PayOrderRequest $body): ApiResponse ``` ## Parameters | Parameter | Type | Tags | Description | | --- | --- | --- | --- | | `orderId` | `string` | Template, Required | The ID of the order being paid. | | `body` | [`PayOrderRequest`](../../doc/models/pay-order-request.md) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. | ## Response Type This method returns a `Square\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`PayOrderResponse`](../../doc/models/pay-order-response.md). ## Example Usage ```php $orderId = 'order_id6'; $body = PayOrderRequestBuilder::init( 'c043a359-7ad9-4136-82a9-c3f1d66dcbff' ) ->paymentIds( [ 'EnZdNAlWCmfh6Mt5FMNST1o7taB', '0LRiVlbXVwe8ozu4KbZxd12mvaB' ] ) ->build(); $apiResponse = $ordersApi->payOrder( $orderId, $body ); if ($apiResponse->isSuccess()) { $payOrderResponse = $apiResponse->getResult(); } else { $errors = $apiResponse->getErrors(); } // Getting more response information var_dump($apiResponse->getStatusCode()); var_dump($apiResponse->getHeaders()); ```
Save
Back