Create Stock for Product

POST 
/inventories/:product_uuid

Sets the inventory quantity for the specified product. When you take this action, you are choosing to manage the inventory for this product in Commerce.

Request

Path Parameters

product_uuid stringrequired

The unique identifier of the product.

application/json

Body

data InventoryCreaterequired

quantity integerrequired

The amount of inventory available.

Responses

201

Success. Stock was successfully created for product

application/json

Schema

Schema

data Inventory

id string

The unique identifier of the product.

type stringrequired

Possible values: [stock]

Default value: stock

The type represents the object being returned. Always stock.

total integer

The total amount of stock we have.

available integer

The amount of stock available for purchase.

allocated integer

The amount of paid for stock, also known as reserved.

Example (from schema)

{
  "data": {
    "id": "f976dace-450f-4a5d-8877-d119c5a550a1",
    "type": "stock",
    "total": 100,
    "available": 75,
    "allocated": 25
  }
}

400

Bad request. The request failed validation.

application/json

Schema

Schema

errors ErrorBody[]required
Array [
status intrequired
The HTTP response code of the error.
title stringrequired
A brief summary of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "status": 500,
      "title": "Internal server error",
      "detail": "An internal error has occurred."
    }
  ]
}

missing-name

{
  "errors": [
    {
      "title": "Validation Error",
      "status": 400,
      "detail": "Your request was invalid"
    }
  ]
}

500

Internal server error. There was a system failure in the platform.

application/json

Schema

Schema

errors ErrorBody[]required
Array [
status intrequired
The HTTP response code of the error.
title stringrequired
A brief summary of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "status": 500,
      "title": "Internal server error",
      "detail": "An internal error has occurred."
    }
  ]
}

internal-server-error

{
  "errors": [
    {
      "title": "Internal Server Error",
      "status": 500
    }
  ]
}

Loading...