Account

The linked person's saved shipping address

Live

GET https://shopitup.ca/api/v1/me/shipping-address

Their saved address in this marketplace's country, in the shape POST /checkout/quotes takes — for "ship to my address on file". null when they have none saved here; ask them for one. Its own scope, which the person approves on the consent page.

Access: address:read How to get a token
Returns: The saved address, or null

Request

curl "https://shopitup.ca/api/v1/me/shipping-address" \
  -H "Authorization: Bearer $TOKEN"

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

const data = await response.json();

import requests

response = requests.get(
    "https://shopitup.ca/api/v1/me/shipping-address",
    headers={"Authorization": f"Bearer {token}"},
)

data = response.json()

Response

200 · The saved address, or null

{
  "shipping_address": {
    "name": "Sam Taylor",
    "line1": "100 Queen St W",
    "line2": null,
    "city": "Toronto",
    "province": "ON",
    "postal_code": "M5H 2N2",
    "country": "CA"
  }
}

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."
  }
}

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."
  }
}

Response

200 The saved address, or null

shipping_address string

Status codes

200

The saved address, or null

401

Missing, invalid or expired access token

403

The token does not carry the scope this endpoint needs

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.