shipping_services

Resource: property_helpers/shipping_service

Collection of available shipping services for a shipping method.

Actions

GET View a list of shipping services
HEAD Get just the header response
OPTIONS Get a response explaining which HTTP methods are supported

Properties (1)

_embedded Object · Read-only

Contains fx:shipping_services[] — array of property_helpers/shipping_service resources

https://api.foxycart.com/shipping_services
Available via shipping_services on shipping_method·fx:shipping_services on store_shipping_method·fx:shipping_services on store_shipping_service

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/stores/123/shipping_services",
      "title": "This Collection"
    },
    "first": {
      "href": "https://api.foxycart.com/stores/123/shipping_services?offset=0",
      "title": "First Page of this Collection"
    },
    "prev": {
      "href": "https://api.foxycart.com/stores/123/shipping_services?offset=0",
      "title": "Previous Page of this Collection"
    },
    "next": {
      "href": "https://api.foxycart.com/stores/123/shipping_services?offset=20",
      "title": "Next Page of this Collection"
    },
    "last": {
      "href": "https://api.foxycart.com/stores/123/shipping_services?offset=20",
      "title": "Last Page of this Collection"
    }
  },
  "_embedded": {
    "fx:shipping_services": [
      {
        "_links": {
          "curies": [
            {
              "name": "fx",
              "href": "https://api.foxycart.com/rels/{rel}",
              "templated": true
            }
          ],
          "self": {
            "href": "https://api.foxycart.com/shipping_service/456",
            "title": "This Shipping Service"
          },
          "shipping_method": {
            "href": "https://api.foxycart.com/shipping_method/456",
            "title": "This Shipping Method"
          },
          "shipping_methods": {
            "href": "https://api.foxycart.com/shipping_methods",
            "title": "All Shipping Methods"
          }
        }
      }
    ]
  },
  "total_items": 1,
  "returned_items": 1,
  "limit": 20,
  "offset": 0
}