Commerce Layer will be proud to sponsor the next JAMstack Conf in London — 09-10 July, 2019 🎉 Stay tuned!

API REFERENCE

Shipping Categories

Shipping categories determine which shipping methods are available for the associated SKUs. An order is split into more shipments if it contains line items belonging to more than one shipping category.

The shipping category object

A Shipping category object is returned as part of the response body of each successful create, list, retrieve or update API call. The following table contains the list of all its fields along with their type, description and example values.

Object fields:
name
string
The shipping category name.
Example:
Merchandise
id
integer
Unique identifier for the resource.
Example:
1234
created_at
datetime
Time at which the resource was created.
Example:
2018-01-01T12:00:00.000Z
updated_at
datetime
Time at which the resource was last updated.
Example:
2018-01-01T12:00:00.000Z
reference
string
A string that you can use to add your own identifier to the resource. This can be useful for intergrating the resource to an external system, like an ERP, a marketing tool or a CRM.
Example:
ANYREFEFERNCE
metadata
object
Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
Example:
{"foo":"bar"}
relationship (1:N)
The associated skus.

Create a shipping category

To create a new shipping category, send a POST request to the /api/shipping_categories endpoint, passing the resource arguments in the request body. The following table contains the list of all the possible arguments, along with their type, description and examples values. All the arguments marked as required must be present in the request.

Arguments:
name
required
The shipping category name.
Example:
Merchandise
reference
optional
A string that you can use to add your own identifier to the resource. This can be useful for intergrating the resource to an external system, like an ERP, a marketing tool or a CRM.
Example:
ANYREFEFERNCE
metadata
optional
Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
Example:
{"foo":"bar"}
Example request:
POST /api/shipping_categories HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

{
  "data": {
    "type": "shipping_categories",
    "attributes": {
      "name": "Merchandise"
    }
  }
}
Example response:
HTTP/1.1 201 Created
Content-Type: application/vnd.api+json

{
  "data": {
    "id": "1234",
    "type": "shipping_categories",
    "links": {
      "self": "https://your-brand.commercelayer.io/api/shipping_categories/1234"
    },
    "attributes": {
      "name": "Merchandise",
      "id": "1234",
      "created_at": "2018-01-01T12:00:00.000Z",
      "updated_at": "2018-01-01T12:00:00.000Z",
      "reference": "ANYREFEFERNCE",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "skus": {
        "links": {
          "self": "https://your-brand.commercelayer.io/api/shipping_categories/1234/relationships/skus",
          "related": "https://your-brand.commercelayer.io/api/shipping_categories/1234/skus"
        }
      }
    },
    "meta": {
      "mode": "test"
    }
  }
}

List all shipping categories

To fetch a collection of shipping categories, send a GET request to the /api/shipping_categories endpoint.

Example request:
GET /api/shipping_categories HTTP/1.1
Accept: application/vnd.api+json
Example response:
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": [
    {
      "id": "1234",
      "type": "shipping_categories",
      "links": {
        "self": "https://your-brand.commercelayer.io/api/shipping_categories/1234"
      },
      "attributes": {
        "name": "Merchandise",
        "id": "1234",
        "created_at": "2018-01-01T12:00:00.000Z",
        "updated_at": "2018-01-01T12:00:00.000Z",
        "reference": "ANYREFEFERNCE",
        "metadata": {
          "foo": "bar"
        }
      },
      "relationships": {
        "skus": {
          "links": {
            "self": "https://your-brand.commercelayer.io/api/shipping_categories/1234/relationships/skus",
            "related": "https://your-brand.commercelayer.io/api/shipping_categories/1234/skus"
          }
        }
      },
      "meta": {
        "mode": "test"
      }
    },
    {
      "other": "... 24 shipping_categories (first page)"
    }
  ],
  "meta": {
    "record_count": 125,
    "page_count": 5
  },
  "links": {
    "first": "/api/shipping_categories?page[number]=1&page[size]=25",
    "prev": "/api/shipping_categories?page[number]=2&page[size]=25",
    "next": "/api/shipping_categories?page[number]=4&page[size]=25",
    "last": "/api/shipping_categories?page[number]=5&page[size]=25"
  }
}
Available filters
id q reference ids created_at_from created_at_to updated_at_from updated_at_to
Sortable attributes
name id created_at updated_at reference

Retrieve a shipping category

To fetch a single shipping category, send a GET request to the /api/shipping_categories/{{id}} endpoint, where {{id}} is the id of the resource that you want to retrieve.

Example request:
GET /api/shipping_categories/1234 HTTP/1.1
Accept: application/vnd.api+json
Example response:
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": {
    "id": "1234",
    "type": "shipping_categories",
    "links": {
      "self": "https://your-brand.commercelayer.io/api/shipping_categories/1234"
    },
    "attributes": {
      "name": "Merchandise",
      "id": "1234",
      "created_at": "2018-01-01T12:00:00.000Z",
      "updated_at": "2018-01-01T12:00:00.000Z",
      "reference": "ANYREFEFERNCE",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "skus": {
        "links": {
          "self": "https://your-brand.commercelayer.io/api/shipping_categories/1234/relationships/skus",
          "related": "https://your-brand.commercelayer.io/api/shipping_categories/1234/skus"
        }
      }
    },
    "meta": {
      "mode": "test"
    }
  }
}

Update a shipping category

To update an existing shipping category, send a PATCH request to the /api/shipping_categories/{{id}} endpoint, where {{id}} is the id of the resource that you want to update. The following table contains the list of all the possible arguments that you can pass with the request body, along with their type, description and examples values. Please note that all arguments are optional.

Arguments:
name
optional
The shipping category name.
Example:
Merchandise
reference
optional
A string that you can use to add your own identifier to the resource. This can be useful for intergrating the resource to an external system, like an ERP, a marketing tool or a CRM.
Example:
ANYREFEFERNCE
metadata
optional
Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
Example:
{"foo":"bar"}
Example request:
PATCH /api/shipping_categories/1234 HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

{
  "data": {
    "type": "shipping_categories",
    "id": 1234,
    "attributes": {
      "name": "Merchandise"
    },
    "relationships": {
    }
  }
}
Example response:
HTTP/1.1 201 Created
Content-Type: application/vnd.api+json

{
  "data": {
    "id": "1234",
    "type": "shipping_categories",
    "links": {
      "self": "https://your-brand.commercelayer.io/api/shipping_categories/1234"
    },
    "attributes": {
      "name": "Merchandise",
      "id": "1234",
      "created_at": "2018-01-01T12:00:00.000Z",
      "updated_at": "2018-01-01T12:00:00.000Z",
      "reference": "ANYREFEFERNCE",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "skus": {
        "links": {
          "self": "https://your-brand.commercelayer.io/api/shipping_categories/1234/relationships/skus",
          "related": "https://your-brand.commercelayer.io/api/shipping_categories/1234/skus"
        }
      }
    },
    "meta": {
      "mode": "test"
    }
  }
}

Delete a shipping category

To delete a shipping category, send a DELETE request to the /api/shipping_categories/{{id}} endpoint, where {{id}} is the id of the resource that you want to delete.

Example request:
DELETE /api/shipping_categories/1234 HTTP/1.1
Accept: application/vnd.api+json
Example response:
HTTP/1.1 204 No Content