Skip to content

warehouse object

A warehouse object contains the properties that define a warehouse in DropStream.

Warehouse objects are managed by the /warehouses endpoint.

warehouse properties

The following are the properties of a warehouse object.

id

Propertyid
Data typeinteger
DescriptionUnique ID, assigned when the warehouse object is created
NoteIn other contexts, "warehouse_id" refers to this property
Example12345

customer_id

Propertycustomer_id
Data typeinteger
DescriptionUnique ID of the customer associated with the warehouse
Example23456

description

Propertydescription
Data typestring
DescriptionWarehouse description
Example"Warehouse Description"

platform

Propertyplatform
Data typestring
DescriptionA warehouse platform string specifying the warehouse platform
Example"ship_station"

adapter

Propertyadapter
Data typeadapter object
DescriptionPlatform-specific API credentials and settings
Example 
...
"adapter": {
    "auth_token" : "abc123",
    "include_discount_code": false
},
...

created_at

Propertycreated_at
Data typedateString
DescriptionDate when the warehouse was created
Example"2020-08-19T14:57:20.000Z"

enabled_at

Propertyenabled_at
Data typedateString, or null
DescriptionDate when the warehouse was most recently enabled, or null if currently disabled
More info
  • Set this value to a dateString to enable the warehouse
  • Set this value to null to disable the warehouse
Example"2020-08-19T14:57:20.000Z"

order_status_imported_at

Propertyorder_status_imported_at
Data typedateString
DescriptionDate when order status was most recently imported for the warehouse, or null if that has not yet occurred
Example"2020-08-19T14:59:20.000Z"

inventory_updated_at

Propertyinventory_updated_at
Data typedateTime, or null
DescriptionDate when inventory was most recently updated for the warehouse, or null if that has not yet occurred
Example"2020-08-19T14:59:20.000Z"

Example warehouse object

{
    "id": 4609,
    "customer_id": 3775,
    "description": "My VeraCore Warehouse",
    "platform": "veracore",
    "adapter": {
        "billing_code" : "Bill To",
        "hostname" : "http://rhu-5678.veracore.com",
        "username" : "myuser",
        "password": "mypass123",
        "include_discount_code" : true,
        "include_package_details" : false
    },
    "created_at": "2020-08-19T14:57:20.000Z",
    "enabled_at": "2020-08-19T14:57:20.000Z",
    "order_status_imported_at": "2020-08-19T14:57:20.000Z",
    "inventory_updated_at": null
}