Store adapter — ApparelMagic
The adapter object contains properties for connecting to the ApparelMagic API.
Parent object: a store with property "platform" : "apparel_magic"
Required properties
The following adapter properties are required for ApparelMagic stores.
company
| Property | company |
|---|
| Name | ApparelMagic Account Subdomain |
|---|
| Data type | string |
|---|
| Required? | Yes |
|---|
token
| Property | token |
|---|
| Name | ApparelMagic API Token |
|---|
| Data type | string |
|---|
| Required? | Yes |
|---|
vendor_id
| Property | vendor_id |
|---|
| Name | Inventory Vendor Name |
|---|
| Data type | string |
|---|
| Required? | Yes |
|---|
warehouse_id
| Property | warehouse_id |
|---|
| Name | ApparelMagic Warehouse Name |
|---|
| Data type | string |
|---|
| Required? | Yes |
|---|
Optional properties
The following adapter properties are optional for ApparelMagic stores.
division_ids
| Property | division_ids |
|---|
| Name | Divisions To Import |
|---|
| Description | One or more Division IDs, separated by commas. If specified, only orders from those Divisions are imported. |
|---|
| Data type | string |
|---|
| Example | "div1,div2,div3" |
|---|
filter_sales_orders_by_warehouse_id
| Property | filter_sales_orders_by_warehouse_id |
|---|
| Name | Filter Sales Order By Warehouse |
|---|
| Data type | boolean |
|---|
| Default | false |
|---|
import_mode
| Property | import_mode |
|---|
| Name | Import Mode |
|---|
| Data type | string |
|---|
| Accepted values | "pick_ticket" — for Pick Ticket"sales_order" — for Sales Order
|
|---|
| Default | "sales_order" |
|---|
sku_identifier
| Property | sku_identifier |
|---|
| Name | SKU Identifier Type |
|---|
| Data type | string |
|---|
| Accepted values | "sku_alt" — for Alt SKU"retailer_sku" — for Retailer SKU"style_number" — for Style Number"upc" — for UPC
|
|---|
| Default | "sku_alt" |
|---|
Example
Example: create a new ApparelMagic 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 ApparelMagic Store",
"platform": "apparel_magic",
"adapter": {
"company": "abc123",
"token": "abc123",
"warehouse_id": "abc123",
"vendor_id": "abc123",
"import_mode": "sales_order",
"sku_identifier": "sku_alt",
"division_ids": "div1,div2,div3",
"filter_sales_orders_by_warehouse_id": false
}
}
EOF
For details about this request type, see: Create a new store.
