Stock Items

A stock item keeps the available inventory of an SKU in a given stock location. When you create a line item, the associated SKU must be available in one of the market's stock locations. When you place an order, the stock item quantities get decremented. When an order is canceled, or a return is approved, the stock item quantities get incremented.

The stock item object

A stock item 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:
sku_code
string
The code of the associated sku.
Example:
TSHIRTMM000000FFFFFFXLXX
quantity
integer
The stock item quantity.
Example:
100
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 (N:1)
The associated stock location.
sku
relationship (N:1)
The associated stock sku.

Create a stock item

To create a new stock item, send a POST request to the /api/stock_items 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:
sku_code
optional
The code of the associated sku.
Example:
TSHIRTMM000000FFFFFFXLXX
quantity
required
The stock item quantity.
Example:
100
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:
#
required
The associated stock location.
sku
required, if not set through the sku_code attribute
The associated stock sku.
Example request:
POST /api/stock_items HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

{
  "data": {
    "type": "stock_items",
    "attributes": {
      "quantity": "100"
    },
    "relationships": {
      "stock_location": {
        "data": {
          "type": "stock_locations",
          "id": "1234"
        }
      }
    }
  }
}
Example response: 201 Created
HTTP/1.1 201 Created
Content-Type: application/vnd.api+json

{
  "data": {
    "id": "1234",
    "type": "stock_items",
    "links": {
      "self": "https://your-brand.commercelayer.io/api/stock_items/1234"
    },
    "attributes": {
      "sku_code": "TSHIRTMM000000FFFFFFXLXX",
      "quantity": "100",
      "id": "1234",
      "created_at": "2018-01-01T12:00:00.000Z",
      "updated_at": "2018-01-01T12:00:00.000Z",
      "reference": "ANYREFEFERNCE",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "stock_location": {
        "links": {
          "self": "https://your-brand.commercelayer.io/api/stock_items/1234/relationships/stock_location",
          "related": "https://your-brand.commercelayer.io/api/stock_items/1234/stock_location"
        }
      },
      "sku": {
        "links": {
          "self": "https://your-brand.commercelayer.io/api/stock_items/1234/relationships/sku",
          "related": "https://your-brand.commercelayer.io/api/stock_items/1234/sku"
        }
      }
    },
    "meta": {
      "mode": "test"
    }
  }
}

List all stock items

To fetch a collection of stock items, send a GET request to the /api/stock_items endpoint.

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

{
  "data": [
    {
      "id": "1234",
      "type": "stock_items",
      "links": {
        "self": "https://your-brand.commercelayer.io/api/stock_items/1234"
      },
      "attributes": {
        "sku_code": "TSHIRTMM000000FFFFFFXLXX",
        "quantity": "100",
        "id": "1234",
        "created_at": "2018-01-01T12:00:00.000Z",
        "updated_at": "2018-01-01T12:00:00.000Z",
        "reference": "ANYREFEFERNCE",
        "metadata": {
          "foo": "bar"
        }
      },
      "relationships": {
        "stock_location": {
          "links": {
            "self": "https://your-brand.commercelayer.io/api/stock_items/1234/relationships/stock_location",
            "related": "https://your-brand.commercelayer.io/api/stock_items/1234/stock_location"
          }
        },
        "sku": {
          "links": {
            "self": "https://your-brand.commercelayer.io/api/stock_items/1234/relationships/sku",
            "related": "https://your-brand.commercelayer.io/api/stock_items/1234/sku"
          }
        }
      },
      "meta": {
        "mode": "test"
      }
    },
    {
      "other": "... 24 stock_items (first page)"
    }
  ],
  "meta": {
    "record_count": 125,
    "page_count": 5
  },
  "links": {
    "first": "/api/stock_items?page[number]=1&page[size]=25",
    "prev": "/api/stock_items?page[number]=2&page[size]=25",
    "next": "/api/stock_items?page[number]=4&page[size]=25",
    "last": "/api/stock_items?page[number]=5&page[size]=25"
  }
}
Available filters
idreferencestock_location_idsku_ididscreated_at_fromcreated_at_toupdated_at_fromupdated_at_tosku_codessku_ids
Sortable attributes
quantityidcreated_atupdated_atreference

Retrieve a stock item

To fetch a single stock item, send a GET request to the /api/stock_items/{{id}} endpoint, where {{id}} is the id of the resource that you want to retrieve.
Example request:
GET /api/stock_items/1234 HTTP/1.1
Accept: application/vnd.api+json
Example response: 200 OK
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": {
    "id": "1234",
    "type": "stock_items",
    "links": {
      "self": "https://your-brand.commercelayer.io/api/stock_items/1234"
    },
    "attributes": {
      "sku_code": "TSHIRTMM000000FFFFFFXLXX",
      "quantity": "100",
      "id": "1234",
      "created_at": "2018-01-01T12:00:00.000Z",
      "updated_at": "2018-01-01T12:00:00.000Z",
      "reference": "ANYREFEFERNCE",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "stock_location": {
        "links": {
          "self": "https://your-brand.commercelayer.io/api/stock_items/1234/relationships/stock_location",
          "related": "https://your-brand.commercelayer.io/api/stock_items/1234/stock_location"
        }
      },
      "sku": {
        "links": {
          "self": "https://your-brand.commercelayer.io/api/stock_items/1234/relationships/sku",
          "related": "https://your-brand.commercelayer.io/api/stock_items/1234/sku"
        }
      }
    },
    "meta": {
      "mode": "test"
    }
  }
}

Update a stock item

To update an existing stock item, send a PATCH request to the /api/stock_items/{{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:
sku_code
optional
The code of the associated sku.
Example:
TSHIRTMM000000FFFFFFXLXX
quantity
optional
The stock item quantity.
Example:
100
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:
#
optional
The associated stock location.
sku
optional
The associated stock sku.
Example request:
PATCH /api/stock_items/1234 HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

{
  "data": {
    "type": "stock_items",
    "id": 1234,
    "attributes": {
      "sku_code": "TSHIRTMM000000FFFFFFXLXX"
    },
    "relationships": {
    }
  }
}
Example response: 200 OK
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": {
    "id": "1234",
    "type": "stock_items",
    "links": {
      "self": "https://your-brand.commercelayer.io/api/stock_items/1234"
    },
    "attributes": {
      "sku_code": "TSHIRTMM000000FFFFFFXLXX",
      "quantity": "100",
      "id": "1234",
      "created_at": "2018-01-01T12:00:00.000Z",
      "updated_at": "2018-01-01T12:00:00.000Z",
      "reference": "ANYREFEFERNCE",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "stock_location": {
        "links": {
          "self": "https://your-brand.commercelayer.io/api/stock_items/1234/relationships/stock_location",
          "related": "https://your-brand.commercelayer.io/api/stock_items/1234/stock_location"
        }
      },
      "sku": {
        "links": {
          "self": "https://your-brand.commercelayer.io/api/stock_items/1234/relationships/sku",
          "related": "https://your-brand.commercelayer.io/api/stock_items/1234/sku"
        }
      }
    },
    "meta": {
      "mode": "test"
    }
  }
}

Delete a stock item

To delete a stock item, send a DELETE request to the /api/stock_items/{{id}} endpoint, where {{id}} is the id of the resource that you want to delete.
Example request:
DELETE /api/stock_items/1234 HTTP/1.1
Accept: application/vnd.api+json
Example response: 204 No Content
HTTP/1.1 204 No Content

Get our machine-readable JSON schema that follows the OpenAPI Specification (formerly Swagger).

Get our Postman collection in one click and start making real calls to Commerce Layer API in minutes.

Get in touch with our support team if you have any questions or want to learn more about Commerce Layer.