Stock Adjustment Item

Supported Formats

json
>>>

GET /api/v2/stock_adjustment_items.json
Retrieves a list of stock adjustment items

Supported Formats

json

Examples

Response Example:

HTTP/1.1 200 OK
{
  "stock_adjustment_items": [
    {
      "id": 1,
      "quantity": 2,
      "updated_at": "2021-02-09T19:12:01.000Z",
      "status": "adjusted",
      "previous_quantity": 3,
      "new_quantity": 5,
      "stock_adjustment_id": 2,
      "adjusted_at": "2021-02-08T19:12:01.000Z",
      "variant": {
        "id": 278,
        "shopify_id": 35671873093654,
        "title": "quadriporticus",
        "sku": "RisorgimentosBavarians01",
        "barcode": null
      }
    },
    {
      "id": 2,
      "quantity": 5,
      "updated_at": "2021-02-09T19:12:01.000Z",
      "status": "adjusted",
      "previous_quantity": 3,
      "new_quantity": 8,
      "stock_adjustment_id": 2,
      "adjusted_at": "2021-02-08T19:12:01.000Z",
      "variant": {
        "id": 16,
        "shopify_id": 35671796252694,
        "title": "Default Title",
        "sku": "",
        "barcode": "01000009"
      }
    }
  ]
}

Params

Param name Description
status
optional

Return only stock adjustment items that have been adjusted when status passed is ‘adjusted`

Validations:

  • Must be a String
adjusted_since
optional

Return only stock adjustment items that have been adjusted on or after a specified date (Using ISO 8601 format; e.g. 2014-04-25T16:15:47-04:00)

Validations:

  • Must be a DateTime
limit
optional

Return up to this many stock adjustment items per page

Validations:

  • Must be a Integer
offset
optional

Specifies the number of matching records to skip over. NOTE: This should not be used for pagination. Use the since_id param instead. If both offset and since_id are provided, only since_id will be used.

Validations:

  • Must be a Integer
updated_since
optional

Return only stock adjustment items that have been updated on or after a specified date (Using ISO 8601 format; e.g. 2014-04-25T16:15:47-04:00)

Validations:

  • Must be a String
since_id
optional

Return only stock adjustment items with ID values greater than the provided ID. Use in combination with the limit param for pagination. Can not be used in combination with the offset param. If both offset and since_id are provided, only since_id will be used.

Validations:

  • Must be a Integer

Returns

Code: 200

Description:

The requested stock adjustment items data

Param name Description
id
required

A unique numeric identifier for the Stock Adjustment Item.

Validations:

  • Must be a Integer
quantity
required

“quantity”: 10

The amount to adjust a Shopify InventoryLevel. 
A negative value subtracts from the InventoryLevel’s available quantity.

Validations:

  • Must be a Integer
updated_at
required

“updated_at”: “2021-02-09T19:47:30.000Z”

The date and time (ISO 8601 format) when the stock adjustment item was last updated.

Validations:

  • Must be a DateTime
status
required

“status”: “adjusted”

The status of the item's adjustment (e.g. "not adjusted" or "adjusted").

Validations:

  • Must be a String
previous_quantity
required

“previous_quantity”: 4

The available quantity at the Shopify InventoryLevel before the adjustment was performed. 
If this property is null, then the adjustment has not been performed yet.

Validations:

  • Must be a Integer
new_quantity
required

“new_quantity”: 10

The available quantity at the Shopify InventoryLevel after the adjustment was performed. 
If this property is null, then the adjustment has not been performed yet.

Validations:

  • Must be a Integer
stock_adjustment_id
required

“stock_adjustment_id”: 15

The unique numeric identifier for the stock adjustment.

Validations:

  • Must be a Integer
adjusted_at
required

“adjusted_at”: “2021-02-09T19:47:30.000Z”

The date and time (ISO 8601 format) when item's adjustment is performed.

Validations:

  • Must be a DateTime
variant
required

Information about the product variant associated with the stock adjustment item.

Validations:

  • Must be a Hash
variant[id]
required

“id”: 3824

The unique numeric identifier for the product variant.

Validations:

  • Must be a Integer
variant[shopify_id]
required

“shopify_id”: 35616076169238

The identifier for the associated Shopify Product Variant.

Validations:

  • Must be a Integer
variant[title]
required

“title”: “250ml”

The name of the product variant.

Validations:

  • Must be a String
variant[sku]
required

“sku”: “Int00154 . PEPERULO”

The Stock Keeping Unit (SKU) which is a unique alphanumeric code used to identify a product.

Validations:

  • Must be a String
variant[barcode]
required

“barcode”: “1234_pink”

The barcode, UPC, or ISBN number for the product.

Validations:

  • Must be a String
>>>

GET /api/v2/stock_adjustment_items/{stock_adjustment_item_id}.json
Retrieves a single stock adjustment item by ID

Supported Formats

json

Errors

Code Description
404 No stock adjustment items found

Examples

Response Example:

HTTP/1.1 200 OK
{
  "id": 1,
  "quantity": 2,
  "updated_at": "2021-02-09T19:12:01.000Z",
  "status": "adjusted",
  "previous_quantity": 3,
  "new_quantity": 5,
  "stock_adjustment_id": 2,
  "adjusted_at": "2021-02-08T19:12:01.000Z",
  "variant": {
    "id": 278,
    "shopify_id": 35671873093654,
    "title": "quadriporticus",
    "sku": "RisorgimentosBavarians01",
    "barcode": null
  }
}

Params

Param name Description
id
required

The ID of the stock adjustment item.

Validations:

  • Must be a number.

Returns

Code: 200

Description:

The requested stock adjustment item data

Param name Description
id
required

A unique numeric identifier for the Stock Adjustment Item.

Validations:

  • Must be a Integer
quantity
required

“quantity”: 10

The amount to adjust a Shopify InventoryLevel. 
A negative value subtracts from the InventoryLevel’s available quantity.

Validations:

  • Must be a Integer
updated_at
required

“updated_at”: “2021-02-09T19:47:30.000Z”

The date and time (ISO 8601 format) when the stock adjustment item was last updated.

Validations:

  • Must be a DateTime
status
required

“status”: “adjusted”

The status of the item's adjustment (e.g. "not adjusted" or "adjusted").

Validations:

  • Must be a String
previous_quantity
required

“previous_quantity”: 4

The available quantity at the Shopify InventoryLevel before the adjustment was performed. 
If this property is null, then the adjustment has not been performed yet.

Validations:

  • Must be a Integer
new_quantity
required

“new_quantity”: 10

The available quantity at the Shopify InventoryLevel after the adjustment was performed. 
If this property is null, then the adjustment has not been performed yet.

Validations:

  • Must be a Integer
stock_adjustment_id
required

“stock_adjustment_id”: 15

The unique numeric identifier for the stock adjustment.

Validations:

  • Must be a Integer
adjusted_at
required

“adjusted_at”: “2021-02-09T19:47:30.000Z”

The date and time (ISO 8601 format) when item's adjustment is performed.

Validations:

  • Must be a DateTime
variant
required

Information about the product variant associated with the stock adjustment item.

Validations:

  • Must be a Hash
variant[id]
required

“id”: 3824

The unique numeric identifier for the product variant.

Validations:

  • Must be a Integer
variant[shopify_id]
required

“shopify_id”: 35616076169238

The identifier for the associated Shopify Product Variant.

Validations:

  • Must be a Integer
variant[title]
required

“title”: “250ml”

The name of the product variant.

Validations:

  • Must be a String
variant[sku]
required

“sku”: “Int00154 . PEPERULO”

The Stock Keeping Unit (SKU) which is a unique alphanumeric code used to identify a product.

Validations:

  • Must be a String
variant[barcode]
required

“barcode”: “1234_pink”

The barcode, UPC, or ISBN number for the product.

Validations:

  • Must be a String