{ "opencollection": "1.0.0", "info": { "name": "Square ApplePay Orders API", "version": "2.0" }, "items": [ { "info": { "name": "Orders", "type": "folder" }, "items": [ { "info": { "name": "Square Create Order", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/orders", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a new [order](entity:Order) that can include information about products for\npurchase and settings to apply to the purchase.\n\nTo pay for a created order, see\n[Pay for Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders).\n\nYou can modify open orders using the [UpdateOrder](api-endpoint:Orders-UpdateOrder) endpoint." }, { "info": { "name": "Square Batch Retrieve Orders", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/orders/batch-retrieve", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a set of [orders](entity:Order) by their IDs.\n\nIf a given order ID does not exist, the ID is ignored instead of generating an error." }, { "info": { "name": "Square Calculate Order", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/orders/calculate", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Enables applications to preview order pricing without creating an order." }, { "info": { "name": "Square Clone Order", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/orders/clone", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a new order, in the `DRAFT` state, by duplicating an existing order. The newly created order has\nonly the core fields (such as line items, taxes, and discounts) copied from the original order." }, { "info": { "name": "Square Search Orders", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/orders/search", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Search all orders for one or more locations. Orders include all sales,\nreturns, and exchanges regardless of how or when they entered the Square\necosystem (such as Point of Sale, Invoices, and Connect APIs).\n\n`SearchOrders` requests need to specify which locations to search and define a\n[SearchOrdersQuery](entity:SearchOrdersQuery) object that controls\nhow to sort or filter the results. Your `SearchOrdersQuery` can:\n\n Set filter criteria.\n Set the sort order.\n Determine whether to return resul" }, { "info": { "name": "Square Retrieve Order", "type": "http" }, "http": { "method": "GET", "url": "https://connect.squareup.com/v2/orders/:order_id", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "The ID of the order to retrieve." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves an [Order](entity:Order) by ID." }, { "info": { "name": "Square Update Order", "type": "http" }, "http": { "method": "PUT", "url": "https://connect.squareup.com/v2/orders/:order_id", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "The ID of the order to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates an open [order](entity:Order) by adding, replacing, or deleting\nfields. Orders with a `COMPLETED` or `CANCELED` state cannot be updated.\n\nAn `UpdateOrder` request requires the following:\n\n- The `order_id` in the endpoint path, identifying the order to update.\n- The latest `version` of the order to update.\n- The [sparse order](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#sparse-order-objects)\ncontaining only the fields to update and the version to which the u" }, { "info": { "name": "Square Pay Order", "type": "http" }, "http": { "method": "POST", "url": "https://connect.squareup.com/v2/orders/:order_id/pay", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "The ID of the order being paid." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://connect.squareup.com/oauth2/authorize", "accessTokenUrl": "https://connect.squareup.com/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Pay for an [order](entity:Order) using one or more approved [payments](entity:Payment)\nor settle an order with a total of `0`.\n\nThe total of the `payment_ids` listed in the request must be equal to the order\ntotal. Orders with a total amount of `0` can be marked as paid by specifying an empty\narray of `payment_ids` in the request.\n\nTo be used with `PayOrder`, a payment must:\n\n- Reference the order by specifying the `order_id` when [creating the payment](api-endpoint:Payments-CreatePayment).\nAny " } ] } ], "bundled": true }