Skip to content

store object

A store object contains the properties that define a DropStream store.

Store objects are managed by the /stores endpoint.

store properties

The following are the properties of a store object.

id

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

customer_id

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

name

Propertyname
Data typestring
DescriptionStore name
Example"My Store"

description

Propertydescription
Data typestring
DescriptionStore description
Example"Store Description"

url

Propertyurl
Data typestring, or null
DescriptionStore URL
Example"https://mystore.com"
Defaultnull

platform

Propertyplatform
Data typestring
DescriptionA platform string specifying the store platform
Example"shopify"

adapter

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

created_at

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

enabled_at

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

order_imported_at

Propertyorder_imported_at
Data typedateString
DescriptionDate when orders were last imported for the store, or null if order import has not yet occurred
Example"2020-08-19T14:59:20.000Z"

inventory_updated_at

Propertyinventory_updated_at
Data typedateString
DescriptionDate when inventory was last updated for the store, or null if inventory update has not yet occurred, or is unsupported by the platform
Example"2020-08-19T15:01:20.000Z"

Example store object

{
    "id": 5603,
    "customer_id": 3775,
    "name": "My Amazon Store",
    "description": "Store Description",
    "url": "https://mystore.com",
    "platform": "shopify",
    "adapter": {
        "shop_name" : "mystore",
        "access_token" : "abc123",
        "enable_sku_instance" : true,
        "exclude_empty_orders" : false,
        "include_partial_fulfillments" : true,
        "location_id" : 3,
        "order_import_financial_status" : [ "Paid", "Partially Paid" ]
    },
    "created_at": "2020-08-19T14:57:20.000Z",
    "enabled_at": "2020-08-19T14:57:20.000Z",
    "order_imported_at": "2020-08-19T14:57:20.000Z",
    "inventory_updated_at": null
},