shipping_service

Description

A property helper supported shipping method service.

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_service
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 service String Read only
code The code for this shipping service String Read only
is_international Specifies whether or not this shipping service is for international rate requests only. Boolean 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_services/14",
            "title": "This Shipping Service"
        },
        "fx:shipping_method": {
            "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:property_helpers": {
            "href": "https://api-sandbox.foxycart.com/property_helpers/",
            "title": "Property Helpers Home Page"
        }
    },
    "name": "Priority Mail",
    "code": "1",
    "date_created": null,
    "date_modified": null
}

<?xml version="1.0" encoding="UTF-8"?>
<resource href="https://api-sandbox.foxycart.com/property_helpers/shipping_services/14">
  <link rel="self" href="https://api-sandbox.foxycart.com/property_helpers/shipping_services/14" title="This Shipping Service"/>
  <link rel="https://api.foxycart.com/rels/shipping_method" 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/property_helpers" href="https://api-sandbox.foxycart.com/property_helpers/" title="Property Helpers Home Page"/>
  <name>Priority Mail</name>
  <code>1</code>
  <date_created></date_created>
  <date_modified></date_modified>
</resource>

{
    "class": [
        "shipping_service"
    ],
    "properties": {
        "name": "Priority Mail",
        "code": "1",
        "date_created": null,
        "date_modified": null
    },
    "links": [
        {
            "rel": [
                "self"
            ],
            "href": "https://api-sandbox.foxycart.com/property_helpers/shipping_services/14"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/shipping_method"
            ],
            "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/property_helpers"
            ],
            "href": "https://api-sandbox.foxycart.com/property_helpers/"
        }
    ],
    "actions": [
    ]
}

Zoomable Resources

This resource has no linked resources which can be "zoomed" in on, filtered and embedded within this resource.