Inventory

WIP: A summary needs to be written for Inventory

GET/v3/inventory_part/export

Export Inventory Parts

Export Inventory Parts data as Excel spreadsheet

Produces

The response content type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

200 Response

the data in excel format

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request

GET
/v3/inventory_part/export
curl https://api.shopmonkey.cloud/v3/inventory_part/export \
  -H "Authorization: Bearer ${SM_TOKEN}"
POST/v3/inventory_part/export

Export Inventory Parts

Export Inventory Parts data as Excel spreadsheet

Produces

The response content type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

200 Response

the data in excel format

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

POST
/v3/inventory_part/export
curl https://api.shopmonkey.cloud/v3/inventory_part/export \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -H 'Content-Type: application/json' \
  --data '{}'
POST/v3/inventory_part/availability_search

Global Search Inventory Parts

Global search for inventory parts

Body parameters

Consumes

The following content type is required: application/json

  • Name
    locationId
    Type
    one of: any, any
    Description
    locationId
  • Name
    term
    Type
    string Required
    Description
    the search term

Produces

The response content type: application/json

200 Response

  • Name
    data
    Type
    array Required
    Description
  • Name
    success
    Type
    boolean Required
    Description

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

POST
/v3/inventory_part/availability_search
curl https://api.shopmonkey.cloud/v3/inventory_part/availability_search \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -H 'Content-Type: application/json' \
  --data '{ "term" : "value" }'

Example Response
application/json

{
  "data": [
    {
      "binLocation": null,
      "brandName": null,
      "categoryName": null,
      "companyId": null,
      "id": null,
      "locationId": null,
      "name": null,
      "normalizedName": null,
      "normalizedSKU": null,
      "note": null,
      "number": null,
      "quantity": null,
      "retailCostCents": null,
      "type": null,
      "updatedDate": null,
      "vendorName": null,
      "wholesaleCostCents": null,
      "availableQuantity": null
    }
  ],
  "success": true
}