Skip to main content
POST
/
v1
/
shipping_profiles
Create
curl --request POST \
  --url https://{defaultHost}/v1/shipping_profiles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "shipping_profile": {
    "name": "EU"
  }
}
'
{
  "id": "c98ba700-994a-4b05-8c44-c9677c97d548",
  "object": "shipping_profile",
  "default": false,
  "name": "EU",
  "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.

Body

application/json
​
shipping_profile
object

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.