GET
List shipping profiles

Authorizations

Authorization
string
header
required

A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.

Query Parameters

type
enum<string>

Omit it for all three. A value outside this set is a 400 rather than an empty page: a client that wrote "giftcard" would otherwise conclude the merchant has no gift-card profile.

Available options:
default,
gift_card,
custom
updated_after
string<date-time>

Profiles touched at or after this RFC3339 instant. A profile's name and type are edited as a merchant reorganises fulfilment, and every product points at one, so a stale copy mislabels the shipping behaviour of the whole catalogue. Supplying it CHANGES THE ORDER of this endpoint: the default walk descends created_at, and this one climbs updated_at, which is the only ordering in which a keyset walk over a mutable column cannot skip a row. A row edited mid-walk moves forward past your position and is returned again, so the walk is AT LEAST ONCE. The bound is INCLUSIVE, so resuming from the newest updated_at you hold re-delivers the rows sharing that instant. A cursor belongs to ONE ordering and is refused by the other.

limit
integer
default:20

Rows per page. Out of range is a 400 rather than a silent clamp, so a client asking for more than 100 learns it did not get it.

Required range: 1 <= x <= 100
after
string

The next_cursor from the previous page. Opaque: decode nothing from it and construct nothing by hand, since its encoding is not part of this contract. Omit it to read the first page.

Response

Success

data
object[]
page
object