Heartwork API

Stocks

Endpointhttps://api.heart.work

Download schema

Fetches a collection of all stocks, for the provided workspace

GET

https://api.heart.work

/core-api/inventory/stocks

Fetches a collection of all stocks, for the provided workspace › query Parameters

productIds

string[] · required

locationIds

string[]

Fetches a collection of all stocks, for the provided workspace › Responses

object[] · required

total

integer · int32 · required

GET/core-api/inventory/stocks

curl --request GET \
  --url 'https://api.heart.work/core-api/inventory/stocks?productIds=%3Cvalue%3E'

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "product": {
        "id": "id",
        "sku": "sku",
        "name": "name"
      },
      "location": {
        "id": "id",
        "name": "name",
        "externalReference": "externalReference"
      },
      "quantity": 0
    }
  ],
  "total": 0
}

plain

Creates and stores a new stock.

POST

https://api.heart.work

/core-api/inventory/stocks

On success, returns the newly created entity in the response.

Creates and stores a new stock. › Request Body

productId

string · required

locationId

string · required

quantity

integer · int32 · required

Creates and stores a new stock. › Responses

id

string · required

object · required

quantity

number · double · required

POST/core-api/inventory/stocks

curl --request POST \
  --url https://api.heart.work/core-api/inventory/stocks \
  --header 'Content-Type: application/json' \
  --data '
{
  "productId": "productId",
  "locationId": "locationId",
  "quantity": 0
}
'

shell

Example Request Body

{
  "productId": "productId",
  "locationId": "locationId",
  "quantity": 0
}

json

Example Responses

{
  "id": "id",
  "product": {
    "id": "id",
    "sku": "sku",
    "name": "name"
  },
  "location": {
    "id": "id",
    "name": "name",
    "externalReference": "externalReference"
  },
  "quantity": 0
}

plain

Updates an existing stock, replacing it entirely.

PUT

https://api.heart.work

/core-api/inventory/stocks/{id}

On success, returns the updated entity in the response.

Updates an existing stock, replacing it entirely. › path Parameters

id

string · required

Updates an existing stock, replacing it entirely. › Request Body

id

string · required

quantity

integer · int32 · required

Updates an existing stock, replacing it entirely. › Responses

id

string · required

object · required

quantity

number · double · required

PUT/core-api/inventory/stocks/{id}

curl --request PUT \
  --url https://api.heart.work/core-api/inventory/stocks/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "id",
  "quantity": 0
}
'

shell

Example Request Body

{
  "id": "id",
  "quantity": 0
}

json

Example Responses

{
  "id": "id",
  "product": {
    "id": "id",
    "sku": "sku",
    "name": "name"
  },
  "location": {
    "id": "id",
    "name": "name",
    "externalReference": "externalReference"
  },
  "quantity": 0
}

plain

Deletes an existing stock, by id.

DELETE

https://api.heart.work

/core-api/inventory/stocks/{id}

Deletes an existing stock, by id. › path Parameters

id

string · required

Unique id of the stock to delete.

Deletes an existing stock, by id. › Responses

No data returned

DELETE/core-api/inventory/stocks/{id}

curl --request DELETE \
  --url https://api.heart.work/core-api/inventory/stocks/:id

shell

Example Responses

No example specified for this content type

SalesOrderStatistics Tags

Heartwork API

Stocks

Endpointhttps://api.heart.work

Download schema

Fetches a collection of all stocks, for the provided workspace

GET

https://api.heart.work

/core-api/inventory/stocks

Fetches a collection of all stocks, for the provided workspace › query Parameters

productIds

string[] · required

locationIds

string[]

Fetches a collection of all stocks, for the provided workspace › Responses

object[] · required

total

integer · int32 · required

GET/core-api/inventory/stocks

curl --request GET \
  --url 'https://api.heart.work/core-api/inventory/stocks?productIds=%3Cvalue%3E'

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "product": {
        "id": "id",
        "sku": "sku",
        "name": "name"
      },
      "location": {
        "id": "id",
        "name": "name",
        "externalReference": "externalReference"
      },
      "quantity": 0
    }
  ],
  "total": 0
}

plain

Creates and stores a new stock.

POST

https://api.heart.work

/core-api/inventory/stocks

On success, returns the newly created entity in the response.

Creates and stores a new stock. › Request Body

productId

string · required

locationId

string · required

quantity

integer · int32 · required

Creates and stores a new stock. › Responses

id

string · required

object · required

quantity

number · double · required

POST/core-api/inventory/stocks

curl --request POST \
  --url https://api.heart.work/core-api/inventory/stocks \
  --header 'Content-Type: application/json' \
  --data '
{
  "productId": "productId",
  "locationId": "locationId",
  "quantity": 0
}
'

shell

Example Request Body

{
  "productId": "productId",
  "locationId": "locationId",
  "quantity": 0
}

json

Example Responses

{
  "id": "id",
  "product": {
    "id": "id",
    "sku": "sku",
    "name": "name"
  },
  "location": {
    "id": "id",
    "name": "name",
    "externalReference": "externalReference"
  },
  "quantity": 0
}

plain

Updates an existing stock, replacing it entirely.

PUT

https://api.heart.work

/core-api/inventory/stocks/{id}

On success, returns the updated entity in the response.

Updates an existing stock, replacing it entirely. › path Parameters

id

string · required

Updates an existing stock, replacing it entirely. › Request Body

id

string · required

quantity

integer · int32 · required

Updates an existing stock, replacing it entirely. › Responses

id

string · required

object · required

quantity

number · double · required

PUT/core-api/inventory/stocks/{id}

curl --request PUT \
  --url https://api.heart.work/core-api/inventory/stocks/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "id",
  "quantity": 0
}
'

shell

Example Request Body

{
  "id": "id",
  "quantity": 0
}

json

Example Responses

{
  "id": "id",
  "product": {
    "id": "id",
    "sku": "sku",
    "name": "name"
  },
  "location": {
    "id": "id",
    "name": "name",
    "externalReference": "externalReference"
  },
  "quantity": 0
}

plain

Deletes an existing stock, by id.

DELETE

https://api.heart.work

/core-api/inventory/stocks/{id}

Deletes an existing stock, by id. › path Parameters

id

string · required

Unique id of the stock to delete.

Deletes an existing stock, by id. › Responses

No data returned

DELETE/core-api/inventory/stocks/{id}

curl --request DELETE \
  --url https://api.heart.work/core-api/inventory/stocks/:id

shell

Example Responses

No example specified for this content type

SalesOrderStatistics Tags