Purchases

A purchase as it stands now

Live

GET https://shopitup.ca/api/v1/purchases/{purchase_id}

Access: purchase:write How to get a token
Returns: The purchase — paid, processing, cancelled or refunded; whether it has shipped

Request

curl "https://shopitup.ca/api/v1/purchases/pu_01j9z8y4q6r2t5v8w1x3z7c0b4" \
  -H "Authorization: Bearer $TOKEN"

const response = await fetch("https://shopitup.ca/api/v1/purchases/pu_01j9z8y4q6r2t5v8w1x3z7c0b4", {
  headers: {
    Authorization: `Bearer ${token}`,
  },
});

const data = await response.json();

import requests

response = requests.get(
    "https://shopitup.ca/api/v1/purchases/pu_01j9z8y4q6r2t5v8w1x3z7c0b4",
    headers={"Authorization": f"Bearer {token}"},
)

data = response.json()

Response

200 · The purchase — paid, processing, cancelled or refunded; whether it has shipped

{
  "purchase_id": "pu_01j9z8y4q6r2t5v8w1x3z7c0b4",
  "status": "paid",
  "order_number": "ORD-7KX2M9QP4R",
  "fulfilment": "shipped",
  "totals": {
    "grand_total": {
      "amount": "150.92",
      "currency": "CAD"
    }
  },
  "cancel_until": "2026-10-05T18:00:00Z",
  "created_at": "2026-10-04T18:00:00Z"
}

401 · Missing, invalid or expired access token

{
  "error": {
    "code": "unauthorized",
    "message": "The access token is missing, invalid or expired."
  }
}

403 · The token does not carry the scope this endpoint needs

{
  "error": {
    "code": "insufficient_scope",
    "message": "This request needs a token with the catalog:read scope."
  }
}

404 · Not found, or not listed on this marketplace

{
  "error": {
    "code": "not_found",
    "message": "No item with that id is listed on this marketplace."
  }
}

429 · Too many requests; retry after the number of seconds in `Retry-After`

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Try again in 30 seconds."
  }
}

503 · A service the API depends on is briefly unavailable; retry after the number of seconds in `Retry-After`

{
  "error": {
    "code": "unavailable",
    "message": "A service the API depends on is briefly unavailable. Try again in a few seconds."
  }
}

Path parameters

purchase_id string Required

Response

200 The purchase — paid, processing, cancelled or refunded; whether it has shipped

purchase_id string
status string

One of held paid processing requires_person refused cancelled refunded
order_number string
fulfilment string

One of processing shipped
totals object
1 child attribute
- grand_total Money
  2 child attributes
  - amount string Required
    
    Decimal string, two places
  - currency string Required
    
    One of CAD
cancel_until string date-time

Until when the person can cancel from their email. For a held purchase, cancelling releases the hold and nothing is charged.
charges_at string date-time

While held, when the card will be charged unless the person cancels; null once charged or closed.
created_at string date-time
checkout object

Only with requires_person — a checkout link for the person to pay themselves.
3 child attributes
- checkout_id string
- checkout_url string uri
- expires_at string date-time
error object

Why it was refused, or why the person must pay themselves.
2 child attributes
- code string
- message string

Status codes

200

The purchase — paid, processing, cancelled or refunded; whether it has shipped

401

Missing, invalid or expired access token

403

The token does not carry the scope this endpoint needs

404

Not found, or not listed on this marketplace

429

Too many requests; retry after the number of seconds in Retry-After

503

A service the API depends on is briefly unavailable; retry after the number of seconds in Retry-After

Errors share one shape — see Errors and rate limits.