store_shipping_methods

Resource: store_shipping_method

This link relationship returns a collection of store shipping methods. You can paginate through this collection using the hypermedia links provided and the link relationships of first, prev, next, and last.

Required Scopes

Full store_full_access
Read shipping_settings_read
Write shipping_settings_write

Collection Resource

store_shipping_method

Actions

GET View a list of store_shipping_methods
POST Create a new store shipping method
HEAD Get just the header response
OPTIONS Get a response explaining which HTTP methods are supported

Properties (5)

_embedded Object · Read-only

Contains fx:store_shipping_methods[] — array of store_shipping_method resources

total_items String · Read-only

Total number of resources in this collection.

returned_items Number · Read-only

Number of resources returned in this page.

limit Number · Read-only

Maximum number of resources per page.

offset Number · Read-only

Number of resources skipped.

Link Relations (5)

self This Collection
first First Page of this Collection
prev Previous Page of this Collection
next Next Page of this Collection
last Last Page of this Collection
https://api.foxycart.com/stores/{store_id}/store_shipping_methods
Available via fx:store_shipping_methods on store

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/stores/123/store_shipping_methods",
      "title": "This Collection"
    },
    "first": {
      "href": "https://api.foxycart.com/stores/123/store_shipping_methods?offset=0",
      "title": "First Page of this Collection"
    },
    "prev": {
      "href": "https://api.foxycart.com/stores/123/store_shipping_methods?offset=0",
      "title": "Previous Page of this Collection"
    },
    "next": {
      "href": "https://api.foxycart.com/stores/123/store_shipping_methods?offset=20",
      "title": "Next Page of this Collection"
    },
    "last": {
      "href": "https://api.foxycart.com/stores/123/store_shipping_methods?offset=20",
      "title": "Last Page of this Collection"
    }
  },
  "_embedded": {
    "fx:store_shipping_methods": [
      {
        "_links": {
          "curies": [
            {
              "name": "fx",
              "href": "https://api.foxycart.com/rels/{rel}",
              "templated": true
            }
          ],
          "self": {
            "href": "https://api.foxycart.com/store_shipping_methods/456",
            "title": "This Store Shipping Method"
          },
          "fx:store": {
            "href": "https://api.foxycart.com/stores/456",
            "title": "This Store"
          },
          "fx:store_shipping_services": {
            "href": "https://api.foxycart.com/store_shipping_methods/123/store_shipping_services",
            "title": "Shipping Services for This Shipping Method"
          },
          "fx:shipping_method": {
            "href": "https://api.foxycart.com/property_helpers/shipping_methods/999",
            "title": "This Shipping Method"
          },
          "fx:shipping_container": {
            "href": "https://api.foxycart.com/property_helpers/shipping_containers/999",
            "title": "This Shipping Container"
          },
          "fx:shipping_drop_type": {
            "href": "https://api.foxycart.com/shipping_drop_type/456",
            "title": "This Shipping Drop Type"
          },
          "fx:shipping_methods": {
            "href": "https://api.foxycart.com/property_helpers/shipping_methods",
            "title": "All Shipping Methods"
          },
          "fx:shipping_services": {
            "href": "https://api.foxycart.com/property_helpers/shipping_methods/999/shipping_services",
            "title": "All Shipping Services for this Shipping Method"
          },
          "fx:shipping_containers": {
            "href": "https://api.foxycart.com/property_helpers/shipping_methods/999/shipping_containers",
            "title": "All Shipping Containers for this Shipping Method"
          },
          "fx:shipping_drop_types": {
            "href": "https://api.foxycart.com/property_helpers/shipping_methods/999/shipping_drop_types",
            "title": "All Shipping Drop Types for this Shipping Method"
          }
        },
        "shipping_method_uri": "https://api-sandbox.foxycart.com/shipping_methods/2",
        "shipping_container_uri": "https://api-sandbox.foxycart.com/shipping_containers/12",
        "shipping_drop_type_uri": "https://api-sandbox.foxycart.com/shipping_drop_types/7",
        "accountid": "",
        "password": "",
        "meter_number": "",
        "authentication_key": "",
        "use_for_domestic": true,
        "use_for_international": true,
        "date_created": null,
        "date_modified": null
      }
    ]
  },
  "total_items": 1,
  "returned_items": 1,
  "limit": 20,
  "offset": 0
}