store_shipping_services

Resource: store_shipping_service

This link relationship returns a collection of store shipping services. 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_service

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

Properties (5)

_embedded Object · Read-only

Contains fx:store_shipping_services[] — array of store_shipping_service 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/store_shipping_methods/{store_shipping_method_id}/store_shipping_services
Available via fx:store_shipping_services on store_shipping_method

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_services",
      "title": "This Collection"
    },
    "first": {
      "href": "https://api.foxycart.com/stores/123/store_shipping_services?offset=0",
      "title": "First Page of this Collection"
    },
    "prev": {
      "href": "https://api.foxycart.com/stores/123/store_shipping_services?offset=0",
      "title": "Previous Page of this Collection"
    },
    "next": {
      "href": "https://api.foxycart.com/stores/123/store_shipping_services?offset=20",
      "title": "Next Page of this Collection"
    },
    "last": {
      "href": "https://api.foxycart.com/stores/123/store_shipping_services?offset=20",
      "title": "Last Page of this Collection"
    }
  },
  "_embedded": {
    "fx:store_shipping_services": [
      {
        "_links": {
          "curies": [
            {
              "name": "fx",
              "href": "https://api.foxycart.com/rels/{rel}",
              "templated": true
            }
          ],
          "self": {
            "href": "https://api.foxycart.com/store_shipping_services/456",
            "title": "This Store Shipping Service"
          },
          "fx:store": {
            "href": "https://api.foxycart.com/stores/456",
            "title": "This Store"
          },
          "fx:shipping_method": {
            "href": "https://api.foxycart.com/property_helpers/shipping_methods/999",
            "title": "This Shipping Method"
          },
          "fx:shipping_service": {
            "href": "https://api.foxycart.com/property_helpers/shipping_services/999",
            "title": "This Shipping Service"
          },
          "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"
          }
        },
        "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
      }
    ]
  },
  "total_items": 1,
  "returned_items": 1,
  "limit": 20,
  "offset": 0
}