Skip to main content
GET
/
api
/
v2
/
platform
/
shipping_methods
/
{id}
Return a Shipping Method
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://{defaultHost}/api/v2/platform/shipping_methods/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "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

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Query Parameters

​
include
string

Select which associated resources you would like to fetch, see: https://jsonapi.org/format/#fetching-includes

Response

Record found

​
data
object
required