Skip to content

connection object

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

Connection objects are managed using the /connections endpoint.

connection properties

The following are the properties of a connection object.

id

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

customer_id

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

warehouse_id

Propertywarehouse_id
Data typeinteger
DescriptionUnique ID of the warehouse associated with the connection
Example34567

store_id

Propertystore_id
Data typeinteger
DescriptionUnique ID of the store associated with the connection
Example45678

name

Propertyname
Data typestring
DescriptionThe connection name
Example"My Connection"

connection_type

Propertyconnection_type
Data typestring
DescriptionThe connection type
Example"fulfillment"

created_at

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

enabled_at

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

locations

Propertylocations
Data typearray of strings
DescriptionLocations associated with this connection
Example[ "location_1", "location_2" ]

channels

Propertychannels
Data typearray of channels
Example 
[
    {
        "id": 27987,
        "enabled_at": "2020-08-19T14:57:20.000Z",
        "type": "sales_order_return"
    },
    {
        "id": 27988,
        "enabled_at": "2020-08-19T14:57:20.000Z",
        "type": "sales_order"
    },
    {
        "id": 27989,
        "enabled_at": null,
        "type": "shipment"
    },
    {
        "id": 27990,
        "enabled_at": null,
        "type": "inventory"
    },
    {
        "id": 27991,
        "enabled_at": "2020-08-19T14:57:20.000Z",
        "type": "catalog"
    },
    {
        "id": 27992,
        "enabled_at": null,
        "type": "purchase_order"
    },
    {
        "id": 27993,
        "enabled_at": "2020-08-19T14:57:20.000Z",
        "type": "advanced_ship_notice"
    }
]

Example connection object

{
    "id": 4200,
    "customer_id": 3775,
    "warehouse_id": 5189,
    "store_id": 5603,
    "name": "My Connection",
    "connection_type": "fulfillment",
    "created_at": "2021-03-12T16:32:11.000Z",
    "enabled_at": null,
    "locations": [],
    "channels": [
        {
            "id": 27987,
            "enabled_at": null,
            "type": "sales_order_return"
        },
        {
            "id": 27988,
            "enabled_at": "2020-08-19T14:57:20.000Z",
            "type": "sales_order"
        },
        {
            "id": 27989,
            "enabled_at": "2020-08-19T14:57:20.000Z",
            "type": "shipment"
        },
        {
            "id": 27990,
            "enabled_at": "2020-08-19T14:57:20.000Z",
            "type": "inventory"
        },
        {
            "id": 27991,
            "enabled_at": null,
            "type": "catalog"
        },
        {
            "id": 27992,
            "enabled_at": null,
            "type": "purchase_order"
        },
        {
            "id": 27993,
            "enabled_at": null,
            "type": "advanced_ship_notice"
        }
    ]
}