API Explorer
CREDENTIALS
Request Scope
external
internal
Public Key
Secret Key
Authenticate via query string parameters
PARAMETERS
Response Type
json
xml
flat
API Method
showrooms/search [GET]
orders/search [GET]
orders/status [PUT]
orders/shippingDetails [PUT]
* orders/getNewOrders (obsolete since v2) [GET]
* orders/confirmExportedOrders (obsolete since v2) [PUT]
* orders/confirmShippedOrders (obsolete since v2) [PUT]
* orders/confirmPaidOrders (obsolete since v2) [PUT]
* orders/rejectOrders (obsolete since v2) [PUT]
orders/reject [PUT]
products/import [POST]
products/create [POST]
products/search [GET]
products/delete [DELETE]
skus/delete [DELETE]
priceTiers/search [GET]
priceTiers/create [POST]
priceTiers/update [PUT]
priceTiers/enableForShowroom [POST]
priceTiers/disableForShowroom [POST]
priceTiers/delete [DELETE]
customers/search [GET]
customers/import [POST]
customers/create [POST]
customers/update [PUT]
customers/delete [DELETE]
invoices/search [GET]
invoices/create [POST]
invoices/update [PUT]
invoices/status [PUT]
invoices/shippingDetails [PUT]
invoices/delete [DELETE]
payments/search [GET]
payments/create [POST]
payments/update [PUT]
payments/refund [PUT]
payments/delete [DELETE]
* imports/importProducts (obsolete since v2) [POST]
* imports/importInventory (obsolete since v2) [POST]
* imports/importCustomers (obsolete since v2) [POST]
Showroom ID
Orders
[ { "tmpOrderID": "_1234123", "orderID": -1, "orderNumber": "", "orderDate": "2017-03-10", "orderRecordID": "2149825", "dateModified": "2017-03-16 22:46:52", "orderType": "at once", "prepackMode": true, "showroomID": "683", "indexLocale": "en_US", "locale": "en_US", "status": { "approveStatus": 0, "deleteStatus": 0, "exportStatus": 0, "fulfillStatus": 1, "localStatus": 0, "payStatus": 0, "reopenStatus": 0, "reviewStatus": 1 }, "tags": [], "contact": "", "location": { "accountID": "", "address1": "", "address2": "", "city": "", "country": "", "currentClass": "Location", "displayOptions": {}, "id": "-1", "kind": "", "name": "", "phones": [], "postalCode": "", "state": "", "type": "", "userID": "-1" }, "salesRepCode": "", "salesRepEmail": "yoon@brandboom.com", "salesRepName": "Yoon Lee", "sellerUserID": "123632", "originalSellerUserID": -1, "buyerEmail": "v@fakebrandboom.com", "buyerFax": "", "buyerName": "version Test", "buyerPhone": "1231231233", "buyerUserID": "291542", "customer": { "accountID": -1, "address1": "", "address2": "", "addressName": "", "buyerName": "", "city": "", "country": "", "currentClass": "Customer", "customerCode1": "", "customerCode2": "", "customerID": -1, "dateCreated": "0000-00-00 00:00:00", "dateModified": "0000-00-00 00:00:00", "discountPercentage": "", "email": "", "erpCode": "", "fax": "", "id": -1, "isDeleted": false, "note": "", "phone": "", "postalCode": "", "referenceNumber": "", "state": "", "term": "", "type": "", "vatNumber": "" }, "billTo": { "address1": "", "address2": "", "city": "", "country": "United States", "currentClass": "Location", "displayOptions": {}, "id": "-1", "kind": "", "name": "", "phones": [], "postalCode": "", "state": "", "type": "", "userID": "-1" }, "shipTo": { "address1": "", "address2": "", "city": "", "country": "United States", "currentClass": "Location", "displayOptions": {}, "id": "-1", "kind": "", "name": "", "phones": [], "postalCode": "", "state": "", "type": "", "userID": "-1" }, "customerPO": "", "shipDate": "2017-03-10", "cancelAfter": "2017-03-10", "vatNumber": "", "shippingOption": "Priority USPS", "shippingInstructions": "FEEFEF", "comments": "Sadf", "terms": "Credit Card", "termsOptions": [ "Credit Card", "COD", "Check" ], "customFields": [ { "buyerEditable": true, "name": "Credit Card", "value": "" }, { "buyerEditable": true, "name": "Expiration MM/YY", "value": "" }, { "buyerEditable": true, "name": "CVC", "value": "" } ], "productLines": [ { "IDH": "000017934114BCE4", "MSRP": "30", "description": "Woven Scarf Winter 2014 Beautifully woven scarf with frayed edges.", "descriptionOnly": "Beautifully woven scarf with frayed edges.", "lineItems": [ { "actualPrice": "15", "disabledLine": false, "emptyLine": false, "numSubLines": 1, "optionIndex": "RD", "optionLocal": "Red", "originalPrice": "15", "prepacks": {}, "sizeX": "", "sizes": [ "One Size" ], "skus": { "One Size": { "UPC": "", "atOnce": null, "ats": "", "isActive": true, "isAvailable": true, "number": "", "quantity": "6", "size": "One Size", "skuNumber": "NN127-RD-ONESIZE" } }, "subLineIndex": 0, "totalLineQuantity": "6", "totalLineValue": "90", "unsellableLine": false } ], "locale": "en_US", "minQTY": "6", "name": "Woven Scarf", "prepacks": [], "productID": "1209816", "removedSizes": [], "season": [ "Winter 2014" ], "sizeRange": "One Size", "sizes": [ "One Size" ], "styleNumber": "NN127" } ], "globalDiscountPercentage": "0", "subtotalOrderQuantity": "0", "subtotalOrderValue": "90", "shippingCost": "0", "taxAmount": "0", "taxPercentage": "0", "taxRatio": null, "credit": "0", "totalNumLineItems": 0, "totalOrderQuantity": "6", "totalOrderValue": "90", "finalInvoiceValue": "90", "currency": "USD", "disclaimer": "" } ]
Overwrite
false
true
Keywords
Status
open
processing
complete
void
Ship Status
unshipped
pick-and-packed
partially-shipped
shipped
Pay Status
unpaid
partially-paid
paid
failed
Export Status
unexported
export
exporting
partially-exported
exported
Order Date Start
Order Date End
Ship Date Start
Ship Date End
Modified Date Start
Modified Date End
Lock
false
true
Showroom ID
Num Results
Result Offset
Status
exported
shipped
unshipped
paid
unpaid
failed
Order IDs / Reasons
Order ID
Details
{ "shippingCost": "35.30", "shippingOption": "FEDEX", "shippingInstructions": "In one box. Tracking#: 1233 1233 3433 12" }
Vanity
Num Results
Result Offset
BB Order IDs
BB Order IDs
BB Order IDs
BB Order IDs / Reasons
BB Order IDs / Reasons
Mode
split
combine
inventory
Bypass Diff
false
true
Data
[ { "styleNumber": "MKD1233", "optionCode":"GRY", "optionName":"Gray", "size":"S", "skuNumber": "MKD1233-GRY-S", "UPC": "1231232213", "name": "Gray Tank", "description": "Gray Tank Top made out of 100% Cotton.", "type": "Mens", "category": "Tanks", "season": "Fall 2014", "priceTierName": "USD WHL", "wholesale": "11", "retail": "22", "inventoryCount": "100", "futureInventoryCount": "50", "deliveryDate": "2016-02-12", "minimumQuantity": "5", "isSellable": true, "isActive": true, "imageURL": "https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png" }, { "styleNumber": "MKD1233", "optionCode":"GRY", "optionName":"Gray", "size":"M", "skuNumber": "MKD1233-GRY-M", "UPC": "1231232213", "name": "Gray Tank", "description": "Gray Tank Top made out of 100% Cotton.", "type": "Mens", "category": "Tanks", "season": "Fall 2014", "priceTierName": "USD WHL", "wholesale": "12", "retail": "24", "inventoryCount": "120", "futureInventoryCount": "70", "deliveryDate": "2016-02-12", "minimumQuantity": "6", "isSellable": true, "isActive": true } ]
Data
Showroom ID
Template
auto
default
Importer Version
1
2
2.1
Overwrite Images (v2)
0
1
Overwrite Blank Values (v2)
true
false
Showroom ID
Product
abc
Showroom ID
PriceTier ID
Language
Keywords
Presentation Name
Style Numbers
Types
Seasons
Categories
Sizes
Num Results
Result Offset
Showroom ID
ID
Check In Images
false
true
Showroom ID
ID
Showroom ID
Price Tier
{ "currency": "USD", "name": "001" }
Price Tier
{ "id": 1, "name": "001", "currency": "USD", "brandID": "123" }
ID
Showroom ID
ID
Showroom ID
ID
Replacement ID
Customer ID
Keywords
Code 1
Code 2
Type
B
S
Date Modified
Num Results
Result Offset
Mode
update
overwrite
Data
[{ "id": 163252, "customerID": 163252, "accountID": 912, "customerCode1": "Nordstrom", "customerCode2": "Store102", "type": "S", "erpCode": "NRD-ST102", "referenceNumber": "Cust000234", "vatNumber": "BE0123456749", "buyerName": "John Smith", "addressName": "Nordstrom LA", "address1": "123 Main St", "address2": "", "city": "Los Angeles", "state": "California", "postalCode": "90015", "country": "US", "phone": "602-343-2322", "fax": "602-343-2321", "email": "store102@nordstrom.com", "note": "Always call before shipping.", "term": "Net 30", "discountPercentage": "15", "dateCreated": "2014-10-08 12:54:16", "dateModified": "2014-10-08 12:54:16", "currentClass": "Customer" }]
File
Template
auto
default
Customer
{ "id": 163252, "customerID": 163252, "accountID": 912, "customerCode1": "Nordstrom", "customerCode2": "Store102", "type": "S", "erpCode": "NRD-ST102", "referenceNumber": "Cust000234", "vatNumber": "BE0123456749", "buyerName": "John Smith", "addressName": "Nordstrom LA", "address1": "123 Main St", "address2": "", "city": "Los Angeles", "state": "California", "postalCode": "90015", "country": "US", "phone": "602-343-2322", "fax": "602-343-2321", "email": "store102@nordstrom.com", "note": "Always call before shipping.", "term": "Net 30", "discountPercentage": "15", "dateCreated": "2014-10-08 12:54:16", "dateModified": "2014-10-08 12:54:16", "currentClass": "Customer" }
Customer
{ "id": 163252, "customerID": 163252, "accountID": 912, "customerCode1": "Nordstrom", "customerCode2": "Store102", "type": "S", "erpCode": "NRD-ST102", "referenceNumber": "Cust000234", "vatNumber": "BE0123456749", "buyerName": "John Smith", "addressName": "Nordstrom LA", "address1": "123 Main St", "address2": "", "city": "Los Angeles", "state": "California", "postalCode": "90015", "country": "US", "phone": "602-343-2322", "fax": "602-343-2321", "email": "store102@nordstrom.com", "note": "Always call before shipping.", "term": "Net 30", "discountPercentage": "15", "dateCreated": "2014-10-08 12:54:16", "dateModified": "2014-10-08 12:54:16", "currentClass": "Customer" }
ID
Keywords
Invoice ID
Order ID
Status
unshipped
pick-and-pack
shipped
unpaid
partially-paid
paid
failed
unexported
export
exporting
exported
Order Date Start
Order Date End
Ship Date Start
Ship Date End
Invoice Date Start
Invoice Date End
Lock
false
true
Num Results
Result Offset
Order ID
Product IDs
Invoice
{ "id": 3, "orderID": 588891, "accountID": 912, "showroomID": 11594, "orderNumber": "RMP.5", "invoiceIndex": 1, "invoiceNumber": "RMP.5.1", "invoiceDate": "2015-04-28", "productIDs": [ "1402756" ], "currency": "GBP", "invoiceAmount": 28, "shippingMethod": "FEDEX GRND", "shippingInstructions": "In One Box", "shippingCost": 30, "shipDate": "2015-02-12", "shipStatus": 0, "trackingNumber": "", "comments": "Testing order.", "paymentMethod": "Credit Card", "paidAmount": 0, "taxAmount": 0, "exportStatus": 0, "exportError": "", "payStatus": 0, "reviewStatus": 0, "currentClass": "Invoice", "dateCreated": "2015-04-28 00:44:08", "dateModified": "2015-04-28 00:55:52" }
Invoice
{ "id": 3, "orderID": 588891, "accountID": 912, "showroomID": 11594, "orderNumber": "RMP.5", "invoiceIndex": 1, "invoiceNumber": "RMP.5.1", "invoiceDate": "2015-04-28", "productIDs": [ "1402756" ], "currency": "GBP", "invoiceAmount": 28, "shippingMethod": "FEDEX GRND", "shippingInstructions": "In One Box", "shippingCost": 30, "shipDate": "2015-02-12", "shipStatus": 0, "trackingNumber": "", "comments": "Testing order.", "paymentMethod": "Credit Card", "paidAmount": 0, "taxAmount": 0, "exportStatus": 0, "exportError": "", "payStatus": 0, "reviewStatus": 0, "currentClass": "Invoice", "dateCreated": "2015-04-28 00:44:08", "dateModified": "2015-04-28 00:55:52" }
Invoice ID
Status
unexported
export
exporting
exported
unshipped
pick-and-pack
shipped
Invoice ID
Details
{ "shippingCost": "35.30", "shippingMethod": "FEDEX", "shippingInstructions": "In one box. ", "trackingNumber": "1233 1233 3433 12" }
ID
Payment ID
Invoice ID
Payment
{ "id": 0, "invoiceID": 106, "method": 1, "amount": "12.50", "currency": "GBP", "notes": "Sample Payment", "date": "2015-05-14" }
Payment
{ "id": 0, "invoiceID": 106, "method": 1, "amount": "12.50", "currency": "GBP", "notes": "Sample Payment", "date": "2015-05-14" }
ID
Amount
ID
Refund*
true
false
Mode
split
combine
inventory
Bypass Diff
false
true
File
Brand ID
Showroom ID
Template
auto
default
Mode
INVENTORY
Brand ID
Showroom ID
Template
Skip
Bypass Diff
false
true
File
Mode
UPDATE
OVERWRITE
File
Skip
Template
Download
Send Request
REQUEST
HTTP Headers
X-Auth-Key
X-Auth-Timestamp
1713512715
X-Auth-Signature
53B5AD480139AAAC6D4CFEA5B7A116FD
Request Parameters
funcName
search
responseType
json
Full URL
RESPONSE
Content
TEXT
JSON
XML