Skip to main content
GET
/
v1
/
shipping_profiles
/
{id}
Retrieve
curl --request GET \
  --url https://{defaultHost}/v1/shipping_profiles/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "fe20dd33-9168-465e-8708-10a8690a247b",
  "object": "shipping_profile",
  "default": false,
  "name": "General",
  "fallback_shipping_zone": null,
  "created_at": 1767909772,
  "updated_at": 1767909772
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Response

200 - application/json

Success

id
string | null

The UUID of the specific object.

object
string

A string describing the object type returned.

name
string

A name for this shipping profile that will be visible to customers.

metadata
object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

default
boolean

Whether or not this shipping profile is the default for the account.

fallback_shipping_zone

Expandable – The associated shipping zone ID.

products

Expandable – Property not returned unless expanded.

shipping_zones

Expandable – Property not returned unless expanded.

created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.