Square
Point of sale and payment processing platform
| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://connect.squareup.com/v2 | link | — | — | — |
Actions (107)
Commerce · 14
- Batch delete catalog objectsPOST /v2/catalog/batch-delete
Deletes a set of CatalogObjects by IDs.
documented - Batch retrieve catalog objectsPOST /v2/catalog/batch-retrieve
Retrieves a set of objects by IDs.
documented - Batch upsert catalog objectsPOST /v2/catalog/batch-upsert
Creates or updates up to 10,000 catalog objects.
documented - Catalog infoGET /v2/catalog/info
Retrieves catalog API information and limits.
documented - Create catalog imagePOST /v2/catalog/images
Uploads an image for a catalog object.
documented - Delete catalog objectDELETE /v2/catalog/object/{object_id}
Deletes a catalog object.
documented - List catalogGET /v2/catalog/list
Lists catalog objects of a specified type.
documented - Retrieve catalog objectGET /v2/catalog/object/{object_id}
Retrieves a catalog object.
documented - Search catalog itemsPOST /v2/catalog/search-catalog-items
Searches catalog items and item variations.
documented - Search catalog objectsPOST /v2/catalog/search
Searches catalog objects by filters.
documented - Update catalog imagePUT /v2/catalog/images/{image_id}
Uploads a new image for a catalog image (Beta).
documented - Update item modifier listsPOST /v2/catalog/update-item-modifier-lists
Updates catalog item modifier lists.
documented - Update item taxesPOST /v2/catalog/update-item-taxes
Updates catalog item taxes.
documented - Upsert catalog objectPOST /v2/catalog/object
Creates or updates a catalog object.
documented
Invoices · 14
- Cancel invoicePOST /v2/invoices/{invoice_id}/cancel
Cancels an invoice.
documented - Cancel invoicePOST /v2/invoices/{invoice_id}/cancel
Cancels an invoice.
documented - Create invoicePOST /v2/invoices
Creates a draft invoice for an order.
documented - Create invoice attachmentPOST /v2/invoices/{invoice_id}/attachments
Uploads a file and attaches it to an invoice.
documented - Create invoice attachmentPOST /v2/invoices/{invoice_id}/attachments
Uploads a file and attaches it to an invoice.
documented - Delete invoiceDELETE /v2/invoices/{invoice_id}
Deletes an invoice.
documented - Delete invoice attachmentDELETE /v2/invoices/{invoice_id}/attachments/{attachment_id}
Removes an attachment from an invoice.
documented - Delete invoice attachmentDELETE /v2/invoices/{invoice_id}/attachments/{attachment_id}
Removes an attachment from an invoice.
documented - Get invoiceGET /v2/invoices/{invoice_id}
Retrieves an invoice.
documented - List invoicesGET /v2/invoices
Returns a list of invoices for a location.
documented - Publish invoicePOST /v2/invoices/{invoice_id}/publish
Publishes a draft invoice.
documented - Publish invoicePOST /v2/invoices/{invoice_id}/publish
Publishes a draft invoice.
documented - Search invoicesPOST /v2/invoices/search
Search invoices for a location.
documented - Update invoicePUT /v2/invoices/{invoice_id}
Updates an invoice.
documented
Bookings · 13
- Bulk retrieve bookingsPOST /v2/bookings/bulk-retrieve
Retrieve multiple bookings by IDs.
documented - Bulk retrieve team member booking profilesPOST /v2/bookings/team-member-booking-profiles/bulk-retrieve
Retrieves one or more team members' booking profiles.
documented - Cancel bookingPOST /v2/bookings/{booking_id}/cancel
Cancels a booking.
documented - Create bookingPOST /v2/bookings
Creates a booking.
documented - List bookingsGET /v2/bookings
Retrieve a collection of bookings.
documented - List location booking profilesGET /v2/bookings/location-booking-profiles
Lists location booking profiles.
documented - List team member booking profilesGET /v2/bookings/team-member-booking-profiles
Lists booking profiles for team members.
documented - Retrieve bookingGET /v2/bookings/{booking_id}
Retrieves a booking.
documented - Retrieve business booking profileGET /v2/bookings/business-booking-profile
Retrieves a seller's booking profile.
documented - Retrieve location booking profileGET /v2/bookings/location-booking-profiles/{location_id}
Retrieves a seller's location booking profile.
documented - Retrieve team member booking profileGET /v2/bookings/team-member-booking-profiles/{team_member_id}
Retrieves a team member's booking profile.
documented - Search availabilityPOST /v2/bookings/availability/search
Search availabilities for bookings.
documented - Update bookingPUT /v2/bookings/{booking_id}
Updates a booking.
documented
Disputes · 9
- Accept disputePOST /v2/disputes/{dispute_id}/accept
Accepts a dispute.
documented - Create dispute evidence filePOST /v2/disputes/{dispute_id}/evidence-files
Uploads an evidence file for a dispute.
documented - Create dispute evidence textPOST /v2/disputes/{dispute_id}/evidence-text
Uploads dispute evidence text.
documented - Delete dispute evidenceDELETE /v2/disputes/{dispute_id}/evidence/{evidence_id}
Deletes dispute evidence.
documented - List disputesGET /v2/disputes
Retrieves disputes for the account.
documented - Retrieve disputeGET /v2/disputes/{dispute_id}
Retrieves a dispute by ID.
documented - Retrieve dispute evidenceGET /v2/disputes/{dispute_id}/evidence/{evidence_id}
Retrieves dispute evidence.
documented - Submit dispute evidencePOST /v2/disputes/{dispute_id}/submit-evidence
Submits evidence for a dispute.
documented - Submit dispute evidencePOST /v2/disputes/{dispute_id}/submit-evidence
Submits dispute evidence.
documented
Webhooks · 9
- Create webhook subscriptionPOST /v2/webhooks/subscriptions
Creates a webhook subscription.
documented - Delete webhook subscriptionDELETE /v2/webhooks/subscriptions/{subscription_id}
Deletes a webhook subscription.
documented - List webhook event typesGET /v2/webhooks/event-types
Lists available webhook event types.
documented - List webhook event typesGET /v2/webhooks/event-types
Lists available webhook event types.
documented - List webhook subscriptionsGET /v2/webhooks/subscriptions
Lists webhook subscriptions owned by the application.
documented - Retrieve webhook subscriptionGET /v2/webhooks/subscriptions/{subscription_id}
Retrieves a webhook subscription.
documented - Test webhook subscriptionPOST /v2/webhooks/subscriptions/{subscription_id}/test
Sends a test notification for a webhook subscription.
documented - Update webhook subscriptionPUT /v2/webhooks/subscriptions/{subscription_id}
Updates a webhook subscription.
documented - Update webhook subscription signature keyPOST /v2/webhooks/subscriptions/{subscription_id}/signature-key
Rotates the webhook signature key for a subscription.
documented
Orders · 8
- Batch retrieve ordersPOST /v2/orders/batch-retrieve
Retrieves multiple orders by IDs.
documented - Calculate orderPOST /v2/orders/calculate
Preview pricing for an order.
documented - Clone orderPOST /v2/orders/clone
Creates a new draft order by duplicating an existing order.
documented - Create orderPOST /v2/orders
Creates a new order.
documented - Pay orderPOST /v2/orders/{order_id}/pay
Pays for an order.
documented - Retrieve orderGET /v2/orders/{order_id}
Retrieves an order by ID.
documented - Search ordersPOST /v2/orders/search
Searches all orders for specified locations.
documented - Update orderPUT /v2/orders/{order_id}
Updates an open order.
documented
Inventory · 7
- Batch change inventoryPOST /v2/inventory/changes/batch-create
Applies adjustments and counts to provided item quantities.
documented - Batch retrieve inventory changesPOST /v2/inventory/changes/batch-retrieve
Returns historical physical counts and adjustments.
documented - Batch retrieve inventory countsPOST /v2/inventory/counts/batch-retrieve
Returns current counts for provided catalog objects at locations.
documented - Retrieve inventory adjustmentGET /v2/inventory/adjustments/{adjustment_id}
Returns an InventoryAdjustment by ID.
documented - Retrieve inventory countGET /v2/inventory/{catalog_object_id}
Retrieves current stock count for a catalog object at given locations.
documented - Retrieve inventory physical countGET /v2/inventory/physical-counts/{physical_count_id}
Returns a physical count.
documented - Retrieve inventory transferGET /v2/inventory/transfers/{transfer_id}
Returns an inventory transfer (Beta).
documented
Vendors · 7
- Bulk create vendorsPOST /v2/vendors/bulk-create
Creates one or more Vendor objects.
documented - Bulk retrieve vendorsPOST /v2/vendors/bulk-retrieve
Retrieves multiple vendors by IDs.
documented - Bulk update vendorsPUT /v2/vendors/bulk-update
Updates multiple Vendor objects.
documented - Create vendorPOST /v2/vendors/create
Creates a single Vendor object.
documented - Retrieve vendorGET /v2/vendors/{vendor_id}
Retrieves a vendor by ID.
documented - Search vendorsPOST /v2/vendors/search
Searches for vendors with a filter.
documented - Update vendorPUT /v2/vendors/{vendor_id}
Updates a vendor by ID.
documented
Payments · 6
- Cancel paymentPOST /v2/payments/{payment_id}/cancel
Cancels (voids) a payment in APPROVED state.
documented - Complete paymentPOST /v2/payments/{payment_id}/complete
Completes a payment that is in a pending state.
documented - Create paymentPOST /v2/payments
Creates a new payment.
documented - Get paymentGET /v2/payments/{payment_id}
Retrieves a specific payment by ID.
documented - List paymentsGET /v2/payments
Retrieves a list of payments taken by the account.
documented - Update paymentPUT /v2/payments/{payment_id}
Updates a payment object.
documented
Locations · 4
OAuth · 4
- AuthorizeGET /oauth2/authorize
Authorize application to access seller data.
documented - Obtain tokenPOST /oauth2/token
Obtain an OAuth access token.
documented - Retrieve token statusPOST /oauth2/token/status
Retrieves status of an OAuth or personal access token.
documented - Revoke tokenPOST /oauth2/revoke
Revokes an OAuth token.
documented
Cash Drawers · 3
- List cash drawer shift eventsGET /v2/cash-drawers/shifts/{shift_id}/events
Lists events for a specific cash drawer shift.
documented - List cash drawer shiftsGET /v2/cash-drawers/shifts
Lists cash drawer shifts for a location in a date range.
documented - Retrieve cash drawer shiftGET /v2/cash-drawers/shifts/{shift_id}
Retrieves a single cash drawer shift.
documented