Inventories

Resource Representation ↑

Example:
{
  "id": 2,
  "qty": 5,
  "available_qty": 7
  "stock_availability": null,
  "out_of_stock_threshold": null,
  "dispatch_time": null,
  "dispatch_time_unit": "day",
  "unit_cost": null,
  "style": "dynamic",
  "sku": null,
  "support_shipping": true,
  "inventory_source": {
    "id": 1,
    "name": "MOTUL"
  }
}

Supported Formats

json
>>>

GET /api/v2/inventories
List inventories

Supported Formats

json

Errors

Code Description
401 Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
403 Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource.
404 Not Found. The requested resource could not be found.
422 Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.
500 Internal Server Error. An unexpected condition was encountered.

Examples

Response:
  {
    "page": 1,
    "per_page": 50,
    "total_pages": 1,
    "total_entries": 1,
    "entries": [
      {
        "id": 2,
        "qty": 5,
        "available_qty": 7,
        "product_id": 7,
        "stock_availability": null,
        "out_of_stock_threshold": null,
        "dispatch_time": null,
        "dispatch_time_unit": "day",
        "unit_cost": null,
        "style": "dynamic",
        "sku": null,
        "lead_time": 48,
        "lead_time_unit": "hours",
        "stock_arrival_date": null,
        "back_order_handling": null,
        "back_order_allocation": null,
        "source_system_stock_timestamp": null,
        "support_shipping": true,
        "inventory_source": {
          "id": 1,
          "name": "MOTUL"
        }
      }
    ]
  }

Params

Param name Description
per_page
optional

Number of objects in one response. Default is 50

Validations:

  • Must be a number.
page
optional

Page number. Default is 1

Validations:

  • Must be a number.
response_inventory_fields
optional

One of ‘id’, ‘product_id’, ‘qty’. The inventory information to be included in the inventory data response. Use comma to join multiple fields.

Validations:

  • Must be a String
response_associated_fields
optional

Use ‘inventory_source’. The information related to the inventory source to be included in the inventory data response. Use comma to join multiple fields.

Validations:

  • Must be a String
created_time_from
optional

ISO_8601 format 2016-05-30T05:13:26Z

Validations:

  • Must be a String
created_time_to
optional

ISO_8601 format 2016-05-30T05:13:26Z

Validations:

  • Must be a String
updated_time_from
optional

ISO_8601 format 2016-05-30T05:13:26Z

Validations:

  • Must be a String
updated_time_to
optional

ISO_8601 format 2016-05-30T05:13:26Z

Validations:

  • Must be a String
>>>

POST /api/v2/inventories
Create an inventory

Supported Formats

json

Errors

Code Description
401 Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
403 Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource.
404 Not Found. The requested resource could not be found.
422 Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.
500 Internal Server Error. An unexpected condition was encountered.

Examples

request:
  {
      "inventory": {
          "inventory_source": "MOTUL",
          "product_id": 1,
          "qty": 5
      }
  }

response:
  {
    "id": 2,
    "qty": 5,
    "available_qty": 7
    "stock_availability": null,
    "out_of_stock_threshold": null,
    "dispatch_time": null,
    "dispatch_time_unit": "day",
    "unit_cost": null,
    "style": "dynamic",
    "sku": null,
    "lead_time": 48,
    "lead_time_unit": "hours",
    "stock_arrival_date": null,
    "back_order_handling": null,
    "back_order_allocation": null,
    "source_system_stock_timestamp": null,
    "support_shipping": true,
    "inventory_source": {
      "id": 1,
      "name": "MOTUL"
    }
  }

Params

Param name Description
inventory
required

Validations:

  • Must be a Hash
inventory[inventory_source]
required

Name of the inventory source

Validations:

  • Must be a String
inventory[product_code]
optional , nil allowed

Product code. Do not provide if ‘product_id’ is provided

Validations:

  • Must be a String
inventory[product_id]
optional , nil allowed

Product ID. Do not provide if ‘product_code’ is provided

Validations:

  • Must be a Integer
inventory[sku]
optional , nil allowed

SKU for this inventory source

Validations:

  • Must be a String
inventory[qty]
required

Quantity

Validations:

  • Must be a Integer
inventory[available_qty]
optional , nil allowed

Available Quantity

Validations:

  • Must be a Integer
inventory[stock_availability]
optional , nil allowed

Stock availability

Validations:

  • Must be one of: out_of_stock, in_stock.
inventory[out_of_stock_threshold]
optional , nil allowed

Out of stock threshold

Validations:

  • Must be a Integer
inventory[dispatch_time]
optional , nil allowed

Dispatch time

Validations:

  • Must be a Integer
inventory[dispatch_time_unit]
optional , nil allowed

Dispatch time unit

Validations:

  • Must be one of: day, hour.
inventory[lead_time]
optional , nil allowed

Lead time

Validations:

  • Must be a Integer
inventory[lead_time_unit]
optional , nil allowed

Lead time unit

Validations:

  • Must be one of: months, weeks, days, hours.
inventory[stock_arrival_date]
optional , nil allowed

Valid Stock Arrival Date. ISO_8601 format 2016-05-30T05:13:26Z.

Validations:

  • Must be a String
inventory[back_order_handling]
optional , nil allowed

Back order handling

Validations:

  • Must be one of: pre_orderable, back_orderable.
inventory[back_order_allocation]
optional , nil allowed

Back Order Allocation

Validations:

  • Must be a Integer
inventory[source_system_stock_timestamp]
optional , nil allowed

Valid Source System Stock Timestamp. ISO_8601 format 2016-05-30T05:13:26Z.

Validations:

  • Must be a String
inventory[unit_cost]
optional , nil allowed

Unit cost of the product for this inventory source

Validations:

  • Must be a Numeric
inventory[style]
optional , nil allowed

Dynamic means Qty changes and Static means Qty stays the same. This is related to inventory decrement for order download

Validations:

  • Must be one of: dynamic, static, perpetual.
>>>

PUT /api/v2/inventories/:id
Update an inventory

Supported Formats

json

Errors

Code Description
401 Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
403 Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource.
404 Not Found. The requested resource could not be found.
422 Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.
500 Internal Server Error. An unexpected condition was encountered.

Examples

request:
  {
      "inventory": {
          "inventory_source": "MOTUL",
          "product_id": 1,
          "qty": 8
      }
  }

response:
  {
    "id": 2,
    "qty": 8,
    "available_qty": 7
    "stock_availability": null,
    "out_of_stock_threshold": null,
    "dispatch_time": null,
    "dispatch_time_unit": "day",
    "unit_cost": null,
    "style": "dynamic",
    "sku": null,
    "lead_time": 48,
    "lead_time_unit": "hours",
    "stock_arrival_date": null,
    "back_order_handling": null,
    "back_order_allocation": null,
    "source_system_stock_timestamp": null,
    "support_shipping": true,
    "inventory_source": {
      "id": 1,
      "name": "MOTUL"
    }
  }

Params

Param name Description
inventory
required

Validations:

  • Must be a Hash
inventory[inventory_source]
optional

Name of the inventory source

Validations:

  • Must be a String
inventory[product_code]
optional , nil allowed

Product code. Do not provide if ‘product_id’ is provided

Validations:

  • Must be a String
inventory[product_id]
optional , nil allowed

Product ID. Do not provide if ‘product_code’ is provided

Validations:

  • Must be a Integer
inventory[sku]
optional , nil allowed

SKU for this inventory source

Validations:

  • Must be a String
inventory[qty]
optional

Quantity

Validations:

  • Must be a Integer
inventory[available_qty]
optional , nil allowed

Available Quantity

Validations:

  • Must be a Integer
inventory[stock_availability]
optional , nil allowed

Stock availability

Validations:

  • Must be one of: out_of_stock, in_stock.
inventory[out_of_stock_threshold]
optional , nil allowed

Out of stock threshold

Validations:

  • Must be a Integer
inventory[dispatch_time]
optional , nil allowed

Dispatch time

Validations:

  • Must be a Integer
inventory[dispatch_time_unit]
optional , nil allowed

Dispatch time unit

Validations:

  • Must be one of: day, hour.
inventory[lead_time]
optional , nil allowed

Lead time

Validations:

  • Must be a Integer
inventory[lead_time_unit]
optional , nil allowed

Lead time unit

Validations:

  • Must be one of: months, weeks, days, hours.
inventory[stock_arrival_date]
optional , nil allowed

Valid Stock Arrival Date. ISO_8601 format 2016-05-30T05:13:26Z.

Validations:

  • Must be a String
inventory[back_order_handling]
optional , nil allowed

Back order handling

Validations:

  • Must be one of: pre_orderable, back_orderable.
inventory[back_order_allocation]
optional , nil allowed

Back Order Allocation

Validations:

  • Must be a Integer
inventory[source_system_stock_timestamp]
optional , nil allowed

Valid Source System Stock Timestamp. ISO_8601 format 2016-05-30T05:13:26Z.

Validations:

  • Must be a String
inventory[unit_cost]
optional , nil allowed

Unit cost of the product for this inventory source

Validations:

  • Must be a Numeric
inventory[style]
optional , nil allowed

Dynamic means Qty changes and Static means Qty stays the same. This is related to inventory decrement for order download

Validations:

  • Must be one of: dynamic, static, perpetual.
>>>

PUT /api/v2/inventories/:id/increment
Increment or decrement an inventory

Supported Formats

json

Errors

Code Description
401 Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
403 Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource.
404 Not Found. The requested resource could not be found.
422 Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.
500 Internal Server Error. An unexpected condition was encountered.

Examples

request:
  {
      "inventory": {
          "inventory_source": "MOTUL",
          "product_id": 1,
          "increment": -8,
          "description": "From ERP"
      }
  }

response:
  {
    "id": 2,
    "qty": 2,
    "available_qty": 7
    "stock_availability": null,
    "out_of_stock_threshold": null,
    "dispatch_time": null,
    "dispatch_time_unit": "day",
    "unit_cost": null,
    "style": "dynamic",
    "sku": null,
    "stock_arrival_date": null,
    "back_order_handling": null,
    "back_order_allocation": null,
    "source_system_stock_timestamp": null,
    "support_shipping": true,
    "inventory_source": {
      "id": 1,
      "name": "MOTUL"
    }
  }
>>>

DELETE /api/v2/inventories/:id
Delete an inventory

Supported Formats

json

Errors

Code Description
401 Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
403 Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource.
404 Not Found. The requested resource could not be found.
422 Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.
500 Internal Server Error. An unexpected condition was encountered.

Examples

response:
  {
    "id": 2
  }