Warehouse adapter — Synapse
The adapter object contains properties for connecting to the Synapse API.
Parent object: a warehouse with property "platform" : "synapse"
Required properties
The following adapter properties are required for Synapse warehouses.
customer_id
| Property | customer_id |
|---|
| Name | Synapse Customer ID |
|---|
| Data type | integer |
|---|
| Required? | Yes |
|---|
facility_id
| Property | facility_id |
|---|
| Name | Synapse Facility ID |
|---|
| Data type | integer |
|---|
| Required? | Yes |
|---|
password
| Property | password |
|---|
| Name | Synapse API Password |
|---|
| Data type | string |
|---|
| Required? | Yes |
|---|
url
| Property | url |
|---|
| Name | Synapse Web Service URL |
|---|
| Data type | string |
|---|
| Example | "http://example.com" |
|---|
| Required? | Yes |
|---|
username
| Property | username |
|---|
| Name | Synapse API Username |
|---|
| Data type | string |
|---|
| Required? | Yes |
|---|
Optional properties
The following adapter properties are optional for Synapse warehouses.
api_version
| Property | api_version |
|---|
| Name | Synapse API Version |
|---|
| Data type | integer |
|---|
| Accepted values | |
|---|
| Default | 1 |
|---|
carrier_billing_code
| Property | carrier_billing_code |
|---|
| Name | Carrier Billing Code |
|---|
| Data type | string |
|---|
| Accepted values | "Prepaid""Consignee to Pick Up""3rd Party""COL"
|
|---|
consignee
| Property | consignee |
|---|
| Name | Consignee |
|---|
| Data type | string |
|---|
