store_shipping_services

Description

This link relationship returns a collection of resources. You can easily paginate through this collection using the hypermedia links provided and the link relationships of first, prev, next, and last. Scroll down to view a representation of a single resource embedded within this collection.

Sandbox Example

You can interact with this resource and run actions against the sandbox API via our HAL Brower.

Actions

GET
View a list of store_shipping_services
POST
Create a new store_shipping_service
HEAD
Get just the header response
OPTIONS
Get a response explaining which HTTP methods are supported

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "...",
      "title": "This Collection"
    },
    "first": {
      "href": "...?offset=0",
      "title": "First Page of this Collection"
    },
    "prev": {
      "href": "...?offset=0",
      "title": "Previous Page of this Collection"
    },
    "next": {
      "href": "...?offset=0",
      "title": "Next Page of this Collection"
    },
    "last": {
      "href": "...?offset=0",
      "title": "Last Page of this Collection"
    }
  },
  "_embedded": {
    "fx:store_shipping_services": [...]
  },
  "total_items": "5",
  "returned_items": 5,
  "limit": 20,
  "offset": 0
}
<?xml version="1.0" encoding="UTF-8"?>
<resource href="...">
  <link rel="self" href="..." title="This Collection"/>
  <link rel="first" href="...?offset=0" title="First Page of this Collection"/>
  <link rel="prev" href="...?offset=0" title="Previous Page of this Collection"/>
  <link rel="next" href="...?offset=0" title="Next Page of this Collection"/>
  <link rel="last" href="...?offset=0" title="Last Page of this Collection"/>
  <resource href="..." rel="https://api.foxycart.com/rels/store_shipping_service">
  ...
  </resource>
  <total_items>5</total_items>
  <returned_items>5</returned_items>
  <limit>20</limit>
  <offset>0</offset>
</resource>
{
    "properties": {
        "total_items": "5",
        "returned_items": 5,
        "limit": 20,
        "offset": 0
    },
    "entities": [...],
    "links": [
        {
            "rel": [
                "self"
            ],
            "href": "..."
        },
        {
            "rel": [
                "first"
            ],
            "href": "...?offset=0"
        },
        {
            "rel": [
                "prev"
            ],
            "href": "...?offset=0"
        },
        {
            "rel": [
                "next"
            ],
            "href": "...?offset=0"
        },
        {
            "rel": [
                "last"
            ],
            "href": "...?offset=0"
        }
    ],
    "actions": [
    ]
}

Embedded Resource: store_shipping_service

Description

This resource represents an active shipping service configured for a given shipping method on your store.

Sandbox Example

You can interact with this resource and run actions against the sandbox API via our HAL Brower.

Actions

GET
View a store_shipping_service
PATCH
Update a store_shipping_service (send only the properties you want to modify)
PUT
Replace a store_shipping_service (send the entire representation)
DELETE
Delete a store_shipping_service
HEAD
Get just the header response
OPTIONS
Get a response explaining which HTTP methods are supported

Properties

Property Description Type Constraints
shipping_method_uri The full API URI of the shipping method defined in our property helpers. URL shipping_methods
shipping_service_uri The full API URI of the shipping method shipping service defined in our property helpers. Each shipping method will have it's own shipping services. URL See the shipping_services link relationship under shipping_methods
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/store_shipping_services/12718",
            "title": "This Store Shipping Service"
        },
        "fx:store": {
            "href": "https://api-sandbox.foxycart.com/stores/66",
            "title": "This Store"
        },
        "fx:shipping_method": {
            "href": "https://api-sandbox.foxycart.com/property_helpers/shipping_methods/2",
            "title": "This Shipping Method"
        },
        "fx:shipping_service": {
            "href": "https://api-sandbox.foxycart.com/property_helpers/shipping_services/54",
            "title": "This Shipping Service"
        },
        "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/2/shipping_services",
            "title": "All Shipping Services for this Shipping Method"
        }
    },
    "shipping_method_uri": "https://api-sandbox.foxycart.com/shipping_methods/2",
    "shipping_service_uri": "https://api-sandbox.foxycart.com/shipping_services/54",
    "date_created": null,
    "date_modified": null
}
<?xml version="1.0" encoding="UTF-8"?>
<resource href="https://api-sandbox.foxycart.com/store_shipping_services/12718">
  <link rel="self" href="https://api-sandbox.foxycart.com/store_shipping_services/12718" title="This Store Shipping Service"/>
  <link rel="https://api.foxycart.com/rels/store" href="https://api-sandbox.foxycart.com/stores/66" title="This Store"/>
  <link rel="https://api.foxycart.com/rels/shipping_method" href="https://api-sandbox.foxycart.com/property_helpers/shipping_methods/2" title="This Shipping Method"/>
  <link rel="https://api.foxycart.com/rels/shipping_service" href="https://api-sandbox.foxycart.com/property_helpers/shipping_services/54" title="This Shipping Service"/>
  <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/2/shipping_services" title="All Shipping Services for this Shipping Method"/>
  <shipping_method_uri>https://api-sandbox.foxycart.com/shipping_methods/2</shipping_method_uri>
  <shipping_service_uri>https://api-sandbox.foxycart.com/shipping_services/54</shipping_service_uri>
  <date_created></date_created>
  <date_modified></date_modified>
</resource>
{
    "class": [
        "store_shipping_service"
    ],
    "properties": {
        "shipping_method_uri": "https://api-sandbox.foxycart.com/shipping_methods/2",
        "shipping_service_uri": "https://api-sandbox.foxycart.com/shipping_services/54",
        "date_created": null,
        "date_modified": null
    },
    "links": [
        {
            "rel": [
                "self"
            ],
            "href": "https://api-sandbox.foxycart.com/store_shipping_services/12718"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/store"
            ],
            "href": "https://api-sandbox.foxycart.com/stores/66"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/shipping_method"
            ],
            "href": "https://api-sandbox.foxycart.com/property_helpers/shipping_methods/2"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/shipping_service"
            ],
            "href": "https://api-sandbox.foxycart.com/property_helpers/shipping_services/54"
        },
        {
            "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/2/shipping_services"
        }
    ],
    "actions": [
        {
            "name": "self",
            "title": "Update Store Shipping Service",
            "method": "PATCH",
            "href": "https://api-sandbox.foxycart.com/store_shipping_services/12718",
            "type": "application/x-www-form-urlencoded",
            "fields": [
                {
                    "name": "shipping_method_uri",
                    "title": "Shipping Method URI",
                    "type": "url",
                    "value": "https://api-sandbox.foxycart.com/shipping_methods/2"
                },
                {
                    "name": "shipping_service_uri",
                    "title": "Shipping Service URI",
                    "type": "url",
                    "value": "https://api-sandbox.foxycart.com/shipping_services/54"
                }
            ]
        }
    ]
}

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_service
shipping_method