Skip to main content
GET
Get a sale

Authorizations

x-api-key
string
header
required

Your API key, for example cmp_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx. Create one on the Integrations page of the compliance dashboard.

Path Parameters

id
string
required

The id of a sale or credit note, as returned in data.sale.id.

Query Parameters

businessId
string

The business to act for. Required for organisation-wide keys; omit it for a business-bound key. List the ids you can use with GET /v1/businesses.

Response

The sale.

data
object
required