Shipping Methods
Return a Shipping Method
Storefront API
- Authentication
- Account
- Account / Address
- Account / Credit Cards
- Account / Orders
- Order Status
- Cart
- Cart / Line Items
- Cart / Other
- Cart / Coupons
- Checkout
- Checkout / State
- Checkout / Shipments
- Checkout / Payments
- Checkout / Store Credit
- Stripe
- Products
- Vendors
- Stores
- Taxons
- Countries
- CMS Pages
- Menus
- Wishlists
- Wishlists / Wished Items
- Digital Downloads
Platform API
- Authentication
- Addresses
- Adjustments
- Classifications
- CMS Pages
- CMS Sections
- Countries
- Data Feeds
- Digital Links
- Digital Assets
- Line Items
- Menu Items
- Menus
- Option Types
- Option Values
- Orders
- Payment Methods
- Payments
- Products
- Promotion Actions
- Promotion Categories
- Promotion Rules
- Promotions
- Roles
- Shipments
- Shipping Categories
- Shipping Methods
- States
- Stock Items
- Stock Locations
- Store Credit Categories
- Store Credit Types
- Store Credits
- Tax Categories
- Tax Rates
- Taxonomies
- Taxons
- Users
- Variants
- Vendors
- Webhook Events
- Webhook Subscribers
- Wished Items
- Wishlists
- Zones
Shipping Methods
Return a Shipping Method
Returns a Shipping Method
GET
/
api
/
v2
/
platform
/
shipping_methods
/
{id}
curl --request GET \
--url http://{defaultHost}/api/v2/platform/shipping_methods/{id} \
--header 'Authorization: Bearer <token>'
{
"data": {
"id": "82",
"type": "shipping_method",
"attributes": {
"name": "UPS Ground",
"code": "UPS_GROUND",
"admin_name": null,
"display_on": "both",
"tracking_url": null,
"created_at": "2022-11-08T19:35:24.769Z",
"updated_at": "2022-11-08T19:35:24.769Z",
"deleted_at": null,
"public_metadata": {},
"private_metadata": {}
},
"relationships": {
"shipping_categories": {
"data": [
{
"id": "149",
"type": "shipping_category"
}
]
},
"shipping_rates": {
"data": []
},
"tax_category": {
"data": null
},
"calculator": {
"data": {
"id": "142",
"type": "calculator"
}
}
}
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Query Parameters
Select which associated resources you would like to fetch, see:
Was this page helpful?
curl --request GET \
--url http://{defaultHost}/api/v2/platform/shipping_methods/{id} \
--header 'Authorization: Bearer <token>'
{
"data": {
"id": "82",
"type": "shipping_method",
"attributes": {
"name": "UPS Ground",
"code": "UPS_GROUND",
"admin_name": null,
"display_on": "both",
"tracking_url": null,
"created_at": "2022-11-08T19:35:24.769Z",
"updated_at": "2022-11-08T19:35:24.769Z",
"deleted_at": null,
"public_metadata": {},
"private_metadata": {}
},
"relationships": {
"shipping_categories": {
"data": [
{
"id": "149",
"type": "shipping_category"
}
]
},
"shipping_rates": {
"data": []
},
"tax_category": {
"data": null
},
"calculator": {
"data": {
"id": "142",
"type": "calculator"
}
}
}
}
}