squareconnect.apis.orders_api

All endpoints are relative to Square Connect V2 Documentation

Method	HTTP request
batch_retrieve_orders	POST /v2/locations/{location_id}/orders/batch-retrieve
create_order	POST /v2/locations/{location_id}/orders
search_orders	POST /v2/orders/search

batch_retrieve_orders

BatchRetrieveOrdersResponse batch_retrieve_orders(location_id, body)

Description

Retrieves a set of Orders by their IDs. If a given Order ID does not exist, the ID is ignored instead of generating an error.

Parameters

Name	Type	Notes	Default Value
location_id	str
body	BatchRetrieveOrdersRequest

Return type

BatchRetrieveOrdersResponse

Authorization

Assign your Access Token from developer portal to the authorization parameter.

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_order

CreateOrderResponse create_order(location_id, body)

Description

Creates an Order that can then be referenced as order_id in a request to the Charge endpoint. Orders specify products for purchase, along with discounts, taxes, and other settings to apply to the purchase. To associate a created order with a request to the Charge endpoint, provide the order's id in the order_id field of your request. You cannot modify an order after you create it. If you need to modify an order, instead create a new order with modified details. To learn more about the Orders API, see the Orders API Overview.

Parameters

Name	Type	Notes	Default Value
location_id	str
body	CreateOrderRequest

Return type

CreateOrderResponse

Authorization

Assign your Access Token from developer portal to the authorization parameter.

[Back to top] [Back to API list] [Back to Model list] [Back to README]

search_orders

SearchOrdersResponse search_orders(body)

Description

Search all Orders for a merchant and return either Orders or OrderEntries. Note that details for orders processed with Square Point of Sale while in offline mode may not be transmitted to Square for up to 72 hours. Offline orders have a created_at value that reflects the time the order was originally processed, not the time it was subsequently transmitted to Square. Consequently, the SearchOrder endpoint might list an offline Order chronologically between online Orders that were seen in a previous request. When fetching additional pages using a cursor, the query must be equal to the query used to fetch the first page of results.

Parameters

Name	Type	Notes	Default Value
body	SearchOrdersRequest

Return type

SearchOrdersResponse

Authorization

Assign your Access Token from developer portal to the authorization parameter.

[Back to top] [Back to API list] [Back to Model list] [Back to README]