store_shipping_service

Collection: store_shipping_services

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

Required Scopes

Full store_full_access
Read shipping_settings_read
Write shipping_settings_write

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 (4)

shipping_method_uri String · Required

The full API URI of the shipping method defined in our property helpers.

See shipping_methods property helper.

shipping_service_uri String · Required

The full API URI of the shipping method shipping service defined in our property helpers. Each shipping method will have its own shipping services.

See the shipping_services link relationship under shipping_methods.

date_created String (nullable) · Read-only

The date this resource was created.

date_modified String (nullable) · Read-only

The date this resource was last modified.

Link Relations (6)

self This Store Shipping Service
fx:store GET PATCH PUT DELETE This Store
fx:shipping_method GET This Shipping Method
fx:shipping_service GET This Shipping Service
fx:shipping_methods GET All Shipping Methods
fx:shipping_services GET All Shipping Services for this Shipping Method

Zoomable Resources

Embed related resources using ?zoom=<resource>. Filter with ?resource:property=value.

shipping_service shipping_method
https://api.foxycart.com/store_shipping_services/{id}

Example Representation

Zoom
{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/store_shipping_services/123",
      "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
}