Skip to main content
GET
/
v1
/
shipping_methods
/
{id}
Retrieve
curl --request GET \
  --url https://{defaultHost}/v1/shipping_methods/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "7af83c6b-92b7-4a65-a978-040bbdb6171d",
  "object": "shipping_method",
  "description": "Deliver within 1-2 days",
  "name": "Express",
  "created_at": 1771429908,
  "updated_at": 1771429908
}

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 method that will be visible to customers.

​
description
string | null

A short description for this shipping method 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.

​
shipping_rates

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.