Create Product Local Inventory

POST 
https://api.helice.cloud/api/g/v1/products/:lookupkey/:key/inventory/local

This endpoint allows creating local inventory data for a product based on a lookup key.

Available fields

Name	Required
quantity (integer)	yes
warehouseId (integer)	no Default value is 0
company (InventoryCompanyUsergroupResource)	no
usergroup (InventoryCompanyUsergroupResource)	no
location (string)	no Default value is empty
costPrice (integer)	no Default value is product costprice
nextDeliveryDate (date)	no
notes (string)	no

dateModified is always updated with the current date and time.

On creating a record, inventory type local is matching the product on the lookup key. If the product is found, inventory record will be created.

If an inventory record is found, matching on: sku, warehouseId and location, error is thrown that duplicate record can't be created.

Request

Path Parameters

lookupkey stringrequired

Available lookup keys: id, sourceId, sku, supplierCode

key stringrequired

Lookup key value

application/json

Body

costPricenumber
Example: 11.31
locationstring
Example: L5
nextDeliveryDatestring
Example: 2022-02-20T00:00:00
notesstring
Example:
quantitynumber
Example: 16
usergroup object
idnumber
Example: 143

Responses

201

Create Product Local Inventory - 201 / Create Product Local Inventory for a usergroup - 200

Response Headers

Connection
Content-Length
Date
Keep-Alive
Return-Format

application/json

Schema

Schema

data object
companyIdnumber
Example: 0
costPricenumber
Example: 11.31
dateModifiedstring
Example: 2022-03-11T11:04:29
idnumber
Example: 16194
locationstring
Example: L5
nextDeliveryDatestring
Example: 2022-02-20T00:00:00
notesstring
Example:
productIdnumber
Example: 38952
quantitynumber
Example: 16
skustring
Example: AA 0635613
supplierstring
Example: INTERN
supplierCodestring
Example: AA 0635613
usergroupIdnumber
Example: 0
warehouseIdnumber
Example: 4
messagesstring[]
Example: ["Inventory created"]
totalnumber
Example: 1

Example (auto)

{
  "data": {
    "companyId": 0,
    "costPrice": 11.31,
    "dateModified": "2022-03-11T11:04:29",
    "id": 16194,
    "location": "L5",
    "nextDeliveryDate": "2022-02-20T00:00:00",
    "notes": "",
    "productId": 38952,
    "quantity": 16,
    "sku": "AA 0635613",
    "supplier": "INTERN",
    "supplierCode": "AA 0635613",
    "usergroupId": 0,
    "warehouseId": 4
  },
  "messages": [
    "Inventory created"
  ],
  "total": 1
}

Create Product Local Inventory - 201

{
  "data": {
    "companyId": 0,
    "costPrice": 11.31,
    "dateModified": "2022-03-11T11:04:29",
    "id": 16194,
    "location": "L5",
    "nextDeliveryDate": "2022-02-20T00:00:00",
    "notes": "",
    "productId": 38952,
    "quantity": 16,
    "sku": "AA 0635613",
    "supplier": "INTERN",
    "supplierCode": "AA 0635613",
    "usergroupId": 0,
    "warehouseId": 4
  },
  "messages": [
    "Inventory created"
  ],
  "total": 1
}

Create Product Local Inventory for a usergroup - 200

{
  "data": {
    "companyId": 0,
    "costPrice": 11.31,
    "dateModified": "2023-10-02T15:08:39",
    "id": 16148,
    "location": "L5",
    "nextDeliveryDate": "2022-02-20T00:00:00",
    "notes": "",
    "productId": 227235,
    "quantity": 16,
    "sku": "9789006953374",
    "supplier": "INTERN",
    "supplierCode": "",
    "usergroupId": 143,
    "warehouseId": 0
  },
  "messages": [
    "Inventory created"
  ],
  "total": 1
}

400

Create Product Local Inventory - 400

Response Headers

Alt-Svc
Via
alt-svc
content-length
date
return-format
server
x-request-id

application/json

Schema

Schema

error object
codenumber
Example: 13004
messagesstring[]
Example: ["Inventory already exists"]
moreInfostring
Example: https://www.propel.us/docs/errors/13004
statusnumber
Example: 400
typestring
Example: InventoryExists

Example (auto)

{
  "error": {
    "code": 13004,
    "messages": [
      "Inventory already exists"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/13004",
    "status": 400,
    "type": "InventoryExists"
  }
}

Create Product Local Inventory - 400

{
  "error": {
    "code": 13004,
    "messages": [
      "Inventory already exists"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/13004",
    "status": 400,
    "type": "InventoryExists"
  }
}

404

Create Product Local Inventory - 404

Response Headers

Alt-Svc
Via
alt-svc
content-length
date
return-format
server
x-request-id

application/json

Schema

Schema

error object
codenumber
Example: 80006
messagesstring[]
Example: ["Product with id [98952] not found"]
moreInfostring
Example: https://www.propel.us/docs/errors/80006
statusnumber
Example: 404
typestring
Example: ProductNotFound

Example (auto)

{
  "error": {
    "code": 80006,
    "messages": [
      "Product with id [98952] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/80006",
    "status": 404,
    "type": "ProductNotFound"
  }
}

Create Product Local Inventory - 404

{
  "error": {
    "code": 80006,
    "messages": [
      "Product with id [98952] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/80006",
    "status": 404,
    "type": "ProductNotFound"
  }
}

Authorization: OAuth2

name: OAuth2type: oauth2bearerFormat: tokenscheme: bearerdescription: OAuth2 Authorizationin: headerflows: {
  "clientCredentials": {
    "tokenUrl": "https://api.helice.cloud/oauth2/token/",
    "scopes": {}
  }
}

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

Request Collapse all

Base URL

https://api.helice.cloud/api/g/v1

Auth

Bearer Token

Parameters

lookupkey — pathrequired

key — pathrequired

Body

• Example (from schema)
• Create Product Local Inventory

{
  "costPrice": 11.31,
  "location": "L5",
  "nextDeliveryDate": "2022-02-20T00:00:00",
  "notes": "",
  "quantity": 16,
  "usergroup": {
    "id": 143
  }
}

ResponseClear

Click the Send API Request button above and see the response here!