Get All Inventory Items

Get all the store's inventory items. You can search for which inventory items you'd like to return by passing the values below.

The search parameter matches against the name, code, and metadata together. Use code when the exact SKU is known.

The update_source_not parameter excludes items whose last update came from the named integration. When synchronizing in both directions, passing your own integration slug prevents your own updates from being returned.

get

Authorizations

ORDERDESK-API-KEYstringRequired

Your API key, found under Store Settings on the API tab. This should be kept server-side.

ORDERDESK-STORE-IDstringRequired

Your store ID, found under Store Settings on the API tab.

Query parameters

idintegerOptional

Order Desk's internal ID for the item.

searchstringOptional

Search metadata, name, and code for this value.

namestringOptional

Product name.

codestringOptional

The inventory item's unique SKU.

Example: ODU-HOOD-NVY-L

metadatastringOptional

A value that must be found somewhere in the list of the metadata keys and values.

manufacturer_skustringOptional

The SKU used by the manufacturer.

locationstringOptional

The warehouse or fulfillment method responsible for this item.

update_source_notstringOptional

The item must not have been updated by this integration. Use the integration slug.

updated_start_datestringOptional

Date and time in YYYY-MM-DD HH:MM:SS format. UTC unless otherwise stated.

Example: 2019-01-15 12:12:10

Responses

200

Matching inventory items.

application/json

statusstring · enumRequired

Either success or error.

Possible values:

messagestringOptional

Describes the result. Always present when an error occurs.

execution_timestringOptional

Time taken to process the request.

Example: 0.1524 seconds

total_recordsintegerOptionalExample: 5

records_returnedintegerOptionalExample: 5

idintegerRead-onlyOptionalExample: 100009

namestringOptionalExample: ODU Campus Hoodie

codestringOptional

Product's unique SKU. This is how Order Desk matches an order line to an inventory record, so it must match the code that your orders arrive with.

Example: ODU-HOOD-NVY-L

pricenumber · doubleOptionalExample: 19

costnumber · doubleOptional

Item cost in decimal format.

Example: 7.25

weightnumber · doubleOptional

The shipping weight of the item.

Example: 1.2

stockintegerOptional

The number of available units.

Example: 52

Other propertiesanyOptional

Other propertiesanyOptional

manufacturer_skustringOptional

The SKU used by the manufacturer. This can be used as print_sku.

Example: GT5000

locationstringOptional

Warehouse or fulfillment method responsible for the item.

Example: Main Warehouse

update_sourcestringOptional

The name of the last system to update the item's details. Setting this allows those updates to be excluded later using the update_source_not search parameter.

Example: Warehouse Sync

date_addedstringOptional

Date and time in YYYY-MM-DD HH:MM:SS format. UTC unless otherwise stated.

Example: 2019-01-15 12:12:10

date_updatedstringOptional

Date and time in YYYY-MM-DD HH:MM:SS format. UTC unless otherwise stated.

Example: 2019-01-15 12:12:10

400

The request was rejected. message names the problem.

application/json

401

Authentication failed. See the Authentication guide, and note that an invalid store ID blocks your store rather than simply failing the request.

application/json

429

You are sending too fast. Wait X-Retry-After seconds. See the Rate Limits guide.

application/json

default

The request could not be completed.

application/json

get/inventory-items

curl "https://app.orderdesk.me/api/v2/inventory-items?code=ODU-HOOD-NVY-L" \
  -H "ORDERDESK-STORE-ID: your-store-id" \
  -H "ORDERDESK-API-KEY: your-api-key"

{
  "status": "success",
  "message": "text",
  "execution_time": "0.1524 seconds",
  "total_records": 5,
  "records_returned": 5,
  "inventory_items": [
    {
      "id": 100009,
      "name": "ODU Campus Hoodie",
      "code": "ODU-HOOD-NVY-L",
      "price": 19,
      "cost": 7.25,
      "weight": 1.2,
      "stock": 52,
      "variation_list": {
        "Size": "Large",
        "Color": "Red"
      },
      "metadata": {
        "image": "https://example.com/odu-hoodie.jpg",
        "print_sku": "x533"
      },
      "manufacturer_sku": "GT5000",
      "location": "Main Warehouse",
      "update_source": "Warehouse Sync",
      "date_added": "2019-01-15 12:12:10",
      "date_updated": "2019-01-15 12:12:10"
    }
  ]
}