S&S Activewear REST API

Authentication
UserName: Account Number
Password: API Key
Don't have an API Key? Find it here or email [email protected]

UserName = Account Number, Password = API Key

Don't have an API Key? Find it here or email [email protected]

GET - Orders

The orders API gives information about previous and pending orders.

Resource URL:

GET     https://api.ssactivewear.com/v2/orders/

Request Options:

Get All Open /v2/orders/ Returns all orders that have not been invoiced.
Get All Open and Invoiced (Last 3 months /v2/orders/?All=True Returns all orders that have been placed in last 3 months.
Filter Results /v2/orders/{order} /v2/orders/PO,123456 Returns specs matching filter condition

{order} = is a comma separated list of order identifiers
identifiers = PONumber, OrderNumber, InvoiceNumber, GUID
Filter Results By Invoice Date /v2/orders/?invoicedate={invoicedate} /v2/orders/?invoicedate=2014-06-18 /v2/orders/?invoicedate=2014-06-18,2014-06-19 /v2/orders/?invoicestartdate=2014-06-18&invoiceenddate=2015-06-19 Returns specs matching filter condition

{invoicedate} = is a date (fromat = yyyy-MM-dd)
{invoicestartdate&invoiceenddate} = Both InvoiceStartdate, InvoiceEnddate are required (fromat = yyyy-MM-dd)
Filter Results By Shipping Label Barcode /v2/orders/?shippinglabelbarcode={shippinglabelbarcode} /v2/orders/?shippinglabelbarcode=57926652.0031 Returns specs matching filter condition

{shippinglabelbarcode} = is a string (format = InvoiceNumber.BoxNumberLane)
Filter Fields /v2/orders/?fields={fields} /v2/orders/?invoicedate=2014-06-18&fields=InvoiceNumber,OrderNumber,TrackingNumber,Total Returns only the fields that you request

{fields} = is a comma separated list of style object fields
Include Lines /v2/orders/?lines=true Returns the order lines for each order.
Include Boxes /v2/orders/?Boxes=true Returns the order Boxes for each order.
Include AR Child Invoices /v2/orders/?includeARChildInvoices=true Returns orders for the primary (parent) account and also orders for any AR child accounts.
Include Billing Address /v2/orders/?Billing=true Returns the Billing Address for each order.
Response Format /v2/orders/?mediatype={mediatype} /v2/orders/?mediatype=json Determines the response type

{mediatype} = json or xml (Default=json)

Example Request:

GET     https://api.ssactivewear.com/v2/orders/4629304

Response:

	[
   {
     "guid": "e66b7667-868f-4ae0-b605-2f45fbd288c0",
     "companyName":"Bolingbrook",
     "warehouseAbbr":"IL",
     "orderNumber": "4629304",
     "invoiceNumber": "907070",
     "poNumber": "Jim B",
     "customerNumber": "00002",
     "orderDate": "2014-06-18T10:59:06.43",
     "shipDate": "2014-06-18T14:15:31.613",
     "invoiceDate": "2014-06-18T00:00:00",
     "orderType": "CSR",
     "terms": "Credit Card",
     "orderStatus": "Shipped",
     "dropship": false,
     "shippingCarrier": "UPS",
     "shippingMethod": "Ground",
     "shipBlind": false,
     "shippingCollectNumber": "",
     "trackingNumber": "1ZE9W0610315091599",
     "shippingAddress":
	 {
       "customer": "Timesaver",
       "attn": "Jim Beale",
       "address": "W8020 W Clay School Rd",
       "city": "Merrillan",
       "state": "WI",
       "zip": "54754"
     },
     "subtotal": 144.38,
     "shipping": 0,
     "shippingSaved": 0.00,
     "cod": 0,
     "tax": 0,
     "lostCashDiscount": 0,
     "smallOrderFee": 0,
     "cuponDiscount": 0,
     "sampleDiscount": 0,
     "setUpFee": 0,
     "restockFee": 0,
     "debitCredit": 0,
     "total": 144.38,
     "totalPieces": 30,
     "totalLines": 18,
     "totalWeight": 17.35,
     "totalBoxes": 1
	}
]

Order Object Definition:

guid String Unique ID for this order (does not change)
companyName String Company name
warehouseAbbr String Options:
  • IL = Lockport, IL
  • NV = Reno, NV
  • NJ = Robbinsville, NJ
  • KS = Olathe, KS
  • GA = McDonough, GA
  • TX = Fort Worth, TX
  • FL = Pompano Beach, FL
  • OH = West Chester, OH
  • DS = Dropship
orderNumber String The order and confirmation number assigned when orders are placed.
invoice Number String The invoice number is assigned shortly after you place your order.
poNumber String The PO number submitted with the order.
customerNumber String Customer number of account.
orderDate DateTime Date order was placed. Example: 2014-06-12T09:41:17.837 (ISO 8601)
shipDate DateTime Date order was shipped. Example: 2014-06-12T09:41:17.837 (ISO 8601)
*Will not be available until the order has shipped.
invoiceDate DateTime Date order was Invoiced. Example: 2014-06-12T00:00:00.000 (ISO 8601)
*Will not be available until the order is invoiced.
orderType String How the order was placed. (Options: CSR, Web, EDI, Credit)
terms String Terms of the order.
orderStatus String Status of order. (Order statues: InProgress (order has been received and being prepared for shipment), Shipped (order has shipped), Completed (order is ready for pickup at Will Call), Canceled (order is cancelled))
dropship Boolean If the order is a dropship order.
shippingCarrier String Carrier used.
shippingMethod String Freight service Used
shipBlind Boolean Determines if the order has blind shipping.
shippingCollectNumber String Freight account that was charged
trackingNumber String TrackingNumber if available.
*Will not be available until the order has shipped.
shippingAddress Object
customer String Customer Name
attn String Attention Line
address String Address Line
city String City
state String State
zip String Zip
billingAddress Object
billTo String Billing Name
attn String Attention Line
address String Address Line
city String City
state String State
zip String Zip
subtotal Decimal Merchandise value of the order.
shipping Decimal Shipping and handling charged
shippingSaved Decimal Difference between the calculated cost of the shipment from the carrier and what S&S charges.
cod Decimal COD amount
tax Decimal Tax charged
lostCashDiscount Decimal Lost Cash Discount amount
smallOrderFee Decimal Small Order Fee
cuponDiscount Decimal Misc discount (not used)
sampleDiscount Decimal Sample Discount
setUpFee Decimal Set Up Fee
restockFee Decimal Restock Fee
debitCredit Decimal Debit/Credit
total Decimal Total order amount
totalPieces Integer Total pieces on order
totalLines Integer Total lines on order
totalWeight Decimal Total weight of order
totalBoxes Decimal Total boxes on the order
deliveryStatus String Orders Current Delivery Status. (Options: Picked Up, Shipped, Shipped - Delivered, Shipped - Exception, Shipped - Expired, Shipped - In Transit, Shipped - Out For Delivery, Shipped - Pending, Shipped - Unknown.)
lines List Of Object
lineNumber Integer Line Number of the order
type String S = Stocked Skus, NS = Not Stocked Skus
skuID Integer Unique ID for this sku (Will never change)
sku String Part Number for product
gtin String Industry standard identifier used by all suppliers.
yourSku String YourSku has been set up using the CrossRef API.
qtyOrdered Integer Qty ordered
qtyShipped Integer Qty shipped
price Decimal Price of each item
brandName String Brand name
styleName String Style Name
title String Description of product
colorName String Color name
sizeName String Size Name
returnable Boolean This product is eligible for return.

Looking for our customer site? Head to www.ssactivewear.com to view our products.