shipping_method

Description

A property helper supported shipping method.

Interact with this resource

To interact with this resource and see it in the context of the API, you can utilise Postman or your Terminal/Console to perform requests. If you have a Foxy store, you can also use the API browser in the admin to interact with resources connected to your store.

Actions

GET
View a shipping_method
HEAD
Get just the header response
OPTIONS
Get a response explaining which HTTP methods are supported

Properties

Property Description Type Constraints
name The name of this shipping method String Read only
code The code for this shipping method String Read only
date_created The date this resource was created. Date Read only
date_modified The date this resource was last modified. Date Read only

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api-sandbox.foxycart.com/property_helpers/shipping_methods/1",
      "title": "This Shipping Method"
    },
    "fx:shipping_methods": {
      "href": "https://api-sandbox.foxycart.com/property_helpers/shipping_methods",
      "title": "All Shipping Methods"
    },
    "fx:shipping_services": {
      "href": "https://api-sandbox.foxycart.com/property_helpers/shipping_methods/1/shipping_services",
      "title": "Shipping Services for this Shipping Method"
    },
    "fx:shipping_containers": {
      "href": "https://api-sandbox.foxycart.com/property_helpers/shipping_methods/1/shipping_containers",
      "title": "Shipping Containers for this Shipping Method"
    },
    "fx:shipping_drop_types": {
      "href": "https://api-sandbox.foxycart.com/property_helpers/shipping_methods/1/shipping_drop_types",
      "title": "Shipping Drop Types for this Shipping Method"
    },
    "fx:property_helpers": {
      "href": "https://api-sandbox.foxycart.com/property_helpers/",
      "title": "Property Helpers Home Page"
    }
  },
  "name": "United States Postal Service",
  "code": "USPS",
  "date_created": null,
  "date_modified": null
}
<?xml version="1.0" encoding="UTF-8"?>
<resource href="https://api-sandbox.foxycart.com/property_helpers/shipping_methods/1" rel="https://api.foxycart.com/rels/shipping_method">
  <link rel="self" href="https://api-sandbox.foxycart.com/property_helpers/shipping_methods/1" title="This Shipping Method"/>
  <link rel="https://api.foxycart.com/rels/shipping_methods" href="https://api-sandbox.foxycart.com/property_helpers/shipping_methods" title="All Shipping Methods"/>
  <link rel="https://api.foxycart.com/rels/shipping_services" href="https://api-sandbox.foxycart.com/property_helpers/shipping_methods/1/shipping_services" title="Shipping Services for this Shipping Method"/>
  <link rel="https://api.foxycart.com/rels/shipping_containers" href="https://api-sandbox.foxycart.com/property_helpers/shipping_methods/1/shipping_containers" title="Shipping Containers for this Shipping Method"/>
  <link rel="https://api.foxycart.com/rels/shipping_drop_types" href="https://api-sandbox.foxycart.com/property_helpers/shipping_methods/1/shipping_drop_types" title="Shipping Drop Types for this Shipping Method"/>
  <link rel="https://api.foxycart.com/rels/property_helpers" href="https://api-sandbox.foxycart.com/property_helpers/" title="Property Helpers Home Page"/>
  <name>United States Postal Service</name>
  <code>USPS</code>
  <date_created></date_created>
  <date_modified></date_modified>
</resource>
{
    "class": [
        "shipping_method"
    ],
    "properties": {
        "name": "United States Postal Service",
        "code": "USPS",
        "date_created": null,
        "date_modified": null
    },
    "links": [
        {
            "rel": [
                "self"
            ],
            "href": "https://api-sandbox.foxycart.com/property_helpers/shipping_methods/1"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/shipping_methods"
            ],
            "href": "https://api-sandbox.foxycart.com/property_helpers/shipping_methods"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/shipping_services"
            ],
            "href": "https://api-sandbox.foxycart.com/property_helpers/shipping_methods/1/shipping_services"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/shipping_containers"
            ],
            "href": "https://api-sandbox.foxycart.com/property_helpers/shipping_methods/1/shipping_containers"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/shipping_drop_types"
            ],
            "href": "https://api-sandbox.foxycart.com/property_helpers/shipping_methods/1/shipping_drop_types"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/property_helpers"
            ],
            "href": "https://api-sandbox.foxycart.com/property_helpers/"
        }
    ],
    "actions": [
    ]
}

Zoomable Resources

The following related resources can be embedded within this resource by including a ?zoom=<child_resource> parameter. You can also filter by child resources by ?child_resource:property=<property_value>

shipping_services
shipping_containers
shipping_drop_types