Skip to content

Store adapter — DropStream SCFE

The adapter object contains properties for connecting to the DropStream SCFE API.

Parent object: a store with property "platform" : "file_transfer"

Required properties

The following adapter properties are required for DropStream SCFE stores.

connection_string

Propertyconnection_string
NameFTP Connection String
Data typestring
Example"ftp://user:pass@host:port"
Required?Yes

file_adapter

Propertyfile_adapter
NameFile Adapter
Data typestring
Required?Yes

Optional properties

The following adapter properties are optional for DropStream SCFE stores.

file_extension

Propertyfile_extension
NameFile Extension
Data typestring
Default"csv"

remote_inventory_path

Propertyremote_inventory_path
NameRemote Inventory Path
Data typestring
Default"/production/outgoing/inventory"

remote_order_archive_path

Propertyremote_order_archive_path
NameRemote Orders Archive Path
Data typestring
Default"/production/incoming/orders/archive"

remote_order_path

Propertyremote_order_path
NameRemote Orders Path
Data typestring
Default"/production/incoming/orders"

remote_shipments_path

Propertyremote_shipments_path
NameRemote Shipments Path
Data typestring
Default"/production/outgoing/shipments"

Example

Example: create a new DropStream SCFE store
curl -X POST \
    -H "Authorization: Bearer $JWT_TOKEN" \
    -H "Content-Type: application/json" \
    https://api.getdropstream.com/stores \
    -d @- <<EOF
{ "customer_id": "3775",
  "name": "Your DropStream SCFE Store",
  "platform": "file_transfer",
  "adapter": {
    "connection_string": "ftp://user:pass@domain.com:21",
    "file_adapter": "abc123",
    "file_extension": "csv",
    "remote_inventory_path": "/production/outgoing/inventory",
    "remote_order_archive_path": "/production/incoming/orders/archive",
    "remote_order_path": "/production/incoming/orders",
    "remote_shipments_path": "/production/outgoing/shipments"
  }
}
EOF

For details about this request type, see: Create a new store.