Introduction
Pull web orders, update existing orders and payments, and run reports.
Error Codes
The Skechers Web Service uses conventional HTTP response codes to indicate the success or failure of an API request. When a request is valid, but does not complete successfully (e.g. user not found), a response is given containing a specific error code and error message about the point of failure.
Response Parameters
-
errorCode: string
An error code that can be referenced in the table to the right. Refer to this error code when identifying errors. -
errorMessage: string
A human-readable message providing more details about this error.
Codes
00001 | Request Timeout. |
---|---|
00002 | Invalid form data. |
000007 | Unauthorized, use the proper API key. |
12001 | Store search failure. |
12002 | Store update failure. |
12003 | Store update payment failure. |
12004 | Store reports failure |
190000 | Store return error, ok to resend. |
190001 | Store return error, do not resend. |
Completed Orders By Time
Order Details by a ship_date time range with RTNC and SHIP status, completed end of lifecycle.
Request Parameters
Example Request
curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"begintime":1400789406000,"endtime":1432325406000}} ' http://retailapi-skechers-com.dev.skechers.com/api/store/reports/finance/completed
Example Response
Live Response
Finance Returns By Time
Finance report for RTNC orders by return_date time range with RTNC status
Request Parameters
Example Request
curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"begintime":1400789406000,"endtime":1432325406000}} ' http://retailapi-skechers-com.dev.skechers.com/api/store/reports/finance/returns
Example Response
Live Response
Garpac Do Order Sale
Garpac do order sale
Request Parameters
Example Request
curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderid":317941,"orderitemids":[7343757,7343760,7343763]}} ' http://retailapi-skechers-com.dev.skechers.com/api/store/orders/sale
Example Response
Live Response
Get Cancelled Orders
Retrieve user cancelled (CNCQ) orders. Only will query last 45 days if timestamp not specified.
Request Parameters
Example Request
curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH"} ' http://retailapi-skechers-com.dev.skechers.com/api/store/orders/usercancelled
Example Response
Live Response
Get Current Orders
Retrieve current (RETRY/OPEN/PICK/PKMS/CHRGD) orders. Only will query last 45 days if timestamp not specified.
Request Parameters
Example Request
curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH"} ' http://retailapi-skechers-com.dev.skechers.com/api/store/orders/current
Example Response
Live Response
Get Data Warehouse Orders
Retrieve an orders by date range on either order timestamp or update timestamp
Request Parameters
-
startOrderTimestamp: long
optionalPass in start order timestamp, numeric value. -
endOrderTimestamp: long
optionalPass in end order timestamp, numeric value. -
startUpdateTimestamp: long
optionalPass in start update timestamp, numeric value. -
endUpdateTimestamp: long
optionalPass in end update timestamp, numeric value. -
storenum: string
Pass in store id, numeric value.
Example Request
curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"startOrderTimestamp":1516493311000,"endOrderTimestamp":1518998911000,"storenum":"600"}} ' http://retailapi-skechers-com.dev.skechers.com/api/store/warehouseOrders
Example Response
Live Response
Get Failed Orders
Retrieve new (FAILED) orders. Only will query last 45 days if timestamp not specified.
Request Parameters
Example Request
curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH"} ' http://retailapi-skechers-com.dev.skechers.com/api/store/orders/failed
Example Response
Live Response
Get New Orders
Retrieve new (NEW) orders. Only will query last 45 days if timestamp not specified.
Request Parameters
Example Request
curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH"} ' http://retailapi-skechers-com.dev.skechers.com/api/store/orders/new
Example Response
Live Response
Get Order By ID
Retrieve an order by ID, exclude all CANC items. Only will query last 45 days if timestamp not specified.
Request Parameters
-
orderid: int
Pass in order id, numeric value.
Response Parameters
-
WebOrder object: WebOrder
The overall information about the order after return action includes item info and payment info, the order status per item is updated to RTNC, and total refund amount is updated into payment totalrefundamount field.
Example Request
curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderid":526522}} ' http://retailapi-skechers-com.dev.skechers.com/api/store/order
Example Response
Live Response
Get Order Item(s)
Get Order Item(s) for an Order
Request Parameters
-
orderid: int
Order ID for which order items needs to be returned.
Response Parameters
-
orderitemid: int
Order item ID -
orderid: int
Order ID / invoice number -
availabledate: long
Available date. UNIX timestamp in milliseconds. OPTIONAL field. -
canceldate: long
Cancel date. UNIX timestamp in milliseconds. OPTIONAL field -
categorydiscountamount: float
Category Discounts if applied. This field will have a non-zero value. -
chargetimestamp: long
Charged timestamp. UNIX timestamp in milliseconds. OPTIONAL field. -
color: string
Various options for the color of the order items provided, for example WHT/BLACK/BLUE -
colorcode: string
Code code of the order itemm for example WBKB. -
creditamount: float
Total credit amount applied to order item. -
discountcode: string
Discount code applied to a order item.OPTIONAL field -
discountcodedescription: string
Description of the discount code used.OPTIONAL field -
divisioncode: string
Skechers defined product divison for order item. -
image: string
Product image applied to order item. -
itemdiscountamount: float
The discount amount applied to order item. -
itemshippingcost: float
The shipping cost applied to order item. -
itemtax: float
The tax amount calculated per item. -
itemtotalprice: float
Total price of the item after adding the tax amount. For example : Shoe price : 85$ and Tax amount : 6.80. Total Item Cost : $91.80 -
itemtype: string
Type of the item, for example 'REWARD' or 'SHOE'. -
orderstatus: string
Status in which the order is, for example: NEW,SHIP,CANC etc. -
pickdate: long
Pick date. UNIX timestamp in milliseconds. Not required. -
pickok: string
PickOK. Varchar. -
productname: string
Skechers defined product name for order item, for example D'Lites 2 - One Piece. -
quantity: int
Quantity -
quantityprice: float
The price of total quanity bought. -
refundamount: float
Total refund amount applied to order item. -
regularunitprice: float
Regular price before coupon and category discount -
returndate: Calendar
Order return date.UNIX timestamp in milliseconds. Not required. -
shipdate: long
Ship date. UNIX timestamp in milliseconds. Not required. -
shippingvendor: string
Shipping vendor. Not required. -
skunumber: string
Sku Number that uniquely identifies that product in the inventory. For example : sku Number for product D'Lites 2 - One Piece Style : 12977 Color Code : WBKB is 192283758959 -
skuvalue: string
Skechers defined shoe size. -
stylecode: string
Style code of the order item placed for example 12977 -
trackingnumber: string
A string provided by a carrier to track the package. -
trackinglink: string
A url created by Skechers to allow customer tracks their package. -
unitprice: float
Price of the item after discount
Example Request
curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderid":538608}} ' http://retailapi-skechers-com.dev.skechers.com/api/store/order/orderItemsByID
Example Response
Live Response
Get Order Item(s) by Dates
Get Order Item(s) for an Order by passing start order timestamp and end order timestamp
Request Parameters
-
startOrderTimestamp: long
The start order timestamp in Long. -
endOrderTimestamp: long
The end order timestamp in Long. Should not exceed 92 days from the start date.
Response Parameters
-
orderitemid: int
Order item ID -
orderid: int
Order ID / invoice number -
availabledate: long
Available date. UNIX timestamp in milliseconds. OPTIONAL field. -
canceldate: long
Cancel date. UNIX timestamp in milliseconds. OPTIONAL field -
categorydiscountamount: float
Category Discounts if applied. This field will have a non-zero value. -
chargetimestamp: long
Charged timestamp. UNIX timestamp in milliseconds. OPTIONAL field. -
color: string
Various options for the color of the order items provided, for example WHT/BLACK/BLUE -
colorcode: string
Code code of the order itemm for example WBKB. -
creditamount: float
Total credit amount applied to order item. -
discountcode: string
Discount code applied to a order item.OPTIONAL field -
discountcodedescription: string
Description of the discount code used.OPTIONAL field -
divisioncode: string
Skechers defined product divison for order item. -
image: string
Product image applied to order item. -
itemdiscountamount: float
The discount amount applied to order item. -
itemshippingcost: float
The shipping cost applied to order item. -
itemtax: float
The tax amount calculated per item. -
itemtotalprice: float
Total price of the item after adding the tax amount. For example : Shoe price : 85$ and Tax amount : 6.80. Total Item Cost : $91.80 -
itemtype: string
Type of the item, for example 'REWARD' or 'SHOE'. -
orderstatus: string
Status in which the order is, for example: NEW,SHIP,CANC etc. -
pickdate: long
Pick date. UNIX timestamp in milliseconds. Not required. -
pickok: string
PickOK. Varchar. -
productname: string
Skechers defined product name for order item, for example D'Lites 2 - One Piece. -
quantity: int
Quantity -
quantityprice: float
The price of total quanity bought. -
refundamount: float
Total refund amount applied to order item. -
regularunitprice: float
Regular price before coupon and category discount -
returndate: Calendar
Order return date.UNIX timestamp in milliseconds. Not required. -
shipdate: long
Ship date. UNIX timestamp in milliseconds. Not required. -
shippingvendor: string
Shipping vendor. Not required. -
skunumber: string
Sku Number that uniquely identifies that product in the inventory. For example : sku Number for product D'Lites 2 - One Piece Style : 12977 Color Code : WBKB is 192283758959 -
skuvalue: string
Skechers defined shoe size. -
stylecode: string
Style code of the order item placed for example 12977 -
trackingnumber: string
A string provided by a carrier to track the package. -
trackinglink: string
A url created by Skechers to allow customer tracks their package. -
unitprice: float
Price of the item after discount
Example Request
curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"startOrderTimestamp":1550102400000,"endOrderTimestamp":1557878400000}} ' http://retailapi-skechers-com.dev.skechers.com/api/store/order/orderItemsByTimestamp
Example Response
Live Response
Get Order Payment
Get Order Payment(s) for an Order
Request Parameters
Example Request
curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderid":317941}} ' http://retailapi-skechers-com.dev.skechers.com/api/store/order/payment
Example Response
Live Response
Get Order Payments by Dates
Get Order Payment(s) for a date range
Request Parameters
Example Request
curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"startOrderTimestamp":1555781589000,"endOrderTimestamp":1556581589000}} ' http://retailapi-skechers-com.dev.skechers.com/api/store/orders/paymentsbydates
Example Response
Live Response
Get Payroll Orders
Retrieve all shipped (SHIP) payroll orders by shipdate. Only will query last 45 days if timestamp not specified.
Request Parameters
Example Request
curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"shipdate":1471158000000,"enddate":1481158000000}} ' http://retailapi-skechers-com.dev.skechers.com/api/store/orders/payroll
Example Response
Live Response
Get Returned Orders
Retrieve all returned (RTNC) orders by return date. Order return date has to be specified.
Request Parameters
-
returndate: Long
Return date in Long. -
enddate: Long
optionalEnd date in Long. -
paymenttypes: List
optionalPayment type.
Example Request
curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"returndate":1701131374000,"enddate":1701217774000,"paymenttypes":["PAYROLL","CREDIT"]}} ' http://retailapi-skechers-com.dev.skechers.com/api/store/orders/return
Example Response
Live Response
Get SHIP Orders with Payments
Retrieve all shipped (SHIP) orders by shipdate with specified payment types[CREDIT,PAYROLL,PAYPAL,DIRECTBILL,GIFT,REWARD,AFTERPAY]. Only will query last 45 days if timestamp not specified.
Request Parameters
Example Request
curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"paymenttypes":["PAYROLL","CREDIT"],"shipdate":1691715626000,"enddate":1692330284000}} ' http://retailapi-skechers-com.dev.skechers.com/api/store/orders
Example Response
Live Response
Get Transactions
Retrieve transactions by time
Request Parameters
Example Request
curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"begintime":1400789406000,"endtime":1432325406000}} ' http://retailapi-skechers-com.dev.skechers.com/api/store/reports/transactions
Example Response
Live Response
Get Updated Orders
Retrieve updated (UPDQ) orders.
Request Parameters
Example Request
curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH"} ' http://retailapi-skechers-com.dev.skechers.com/api/store/orders/updated
Example Response
Live Response
Order Details By Time
Retrieve Order Details by orderlog order_timestamp with status not CANC, CNCP, CNCQ, FAILED, RETRY, RVKC
Request Parameters
Example Request
curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"begintime":1400789406000,"endtime":1432325406000}} ' http://retailapi-skechers-com.dev.skechers.com/api/store/reports/orders
Example Response
Live Response
Returned Details By Time
Retrieve Returned Order Details by a return_date with status not CANC, CNCP, CNCQ, FAILED, RETRY, RVKC
Request Parameters
Example Request
curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"begintime":1400789406000,"endtime":1432325406000}} ' http://retailapi-skechers-com.dev.skechers.com/api/store/reports/returns
Example Response
Live Response
Sync Item Status
Sync Order Item Status
Request Parameters
-
orderid: int
Order ID. -
orderitemid: int
Item ID. -
status: string
Item status, allowed status ACK(MAO's 1000.00), READY(MAO's 3600.00), SHIP(MAO's 7000.00) and CANC(MAO's 9000.00). -
cancelreason: string
optionalCancel reason, map MAO's 'Back Ordered' to Skx's cancel reason 'HS', MAO's cancel by customer to Skx's cancel reason 'CC'.
Response Parameters
-
boomiEmailOrderLog: BoomiEmailOrderLog object
Refers BoomiEmailOrderLog to Models -> BoomiEmailOrderLog.
Example Request
curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderid":726864,"orderitems":[{"orderitemid":"10649492","status":"ACK"},{"orderitemid":"10649493","status":"CANC","cancelreason":"CC"}]}} ' http://retailapi-skechers-com.dev.skechers.com/api/v2/store/order/status
Example Response
Live Response
Top Selling Skus By Time
Retrieve top selling skus
Request Parameters
Example Request
curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"begintime":1400789406000,"endtime":1432325406000}} ' http://retailapi-skechers-com.dev.skechers.com/api/store/reports/topselling
Example Response
Live Response
Track Return Items By Time
Pull order items that have return label generated.
Request Parameters
Example Request
curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"startTimestamp":1597417683000,"endTimestamp":1597471683000}} ' http://retailapi-skechers-com.dev.skechers.com/api/store/order/trackReturn
Example Response
Live Response
Update In-flight Return Item
Update In-flight Return Item's Status
Request Parameters
-
orderid: int
Order ID. -
orderitemid: int
Item ID.
Example Request
curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderid":753479,"orderitemid":10711036}} ' http://retailapi-skechers-com.dev.skechers.com/api/store/order/updateInFlightReturnItem
Example Response
Live Response
Update Payments
Update Payments
Request Parameters
-
orderid: int
Order ID. -
payment_info_id: int
Payment ID. -
totalchargedamount: float
optionalTotal charged amount. Not required. -
availableamount: float
optionalAvailable amount. Not required. -
status: string
optionalPayment status. Not required. -
updatetime: long
optionalUpdate timestamp. UNIX timestamp in milliseconds. Not required. -
updateuser: string
optionalUpdate user. Not required. -
activeok: boolean
optionalActive ok. Not required.
Example Request
curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderid":35,"paymentinfo":[{"updateuser":"Garpac","availableamount":32.25,"activeok":true,"updatetime":1444508283000,"status":"CHRGD","payment_info_id":"1324","totalchargedamount":100.4}]}} ' http://retailapi-skechers-com.dev.skechers.com/api/store/order/update/payment
Example Response
Live Response
Update Status
Update staus of an order and its orderitems
Request Parameters
-
orderid: int
Order ID / invoice number -
orderitemid: int
Order item ID -
upc: string
Sku number, upc -
status: string
New status, etc.. OPEN, PICK, CNCQ.. -
pickok: string
PickOK, required field. Varchar. -
availabledate: long
optionalAvailable date. UNIX timestamp in milliseconds. Not required. -
canceldate: long
optionalCancel date. UNIX timestamp in milliseconds. Not required. -
pickdate: long
optionalPick date. UNIX timestamp in milliseconds. Not required. -
shipdate: long
optionalShip date. UNIX timestamp in milliseconds. Not required. -
chargetimestamp: long
optionalCharged timestamp. UNIX timestamp in milliseconds. Not required. -
shippingvendor: string
optionalShipping vendor. Not required. -
trackingnumber: string
optionalTracking number. Not required. -
failed_notified: int
optionalOrder failed notified. Not required. -
failed_last_notified: long
optionalOrder failed last notified. UNIX timestamp in milliseconds. Not required. -
comment: string
Order comment. -
commenttype: string
Order comment type, example: 'stat'. -
author: string
Order comment author, example: p_statweb.
Example Request
curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderid":44036,"orderitems":[{"author":"p_statweb","orderitemid":3707969,"failed_notified":"1","upc":"887047153575","availabledate":1444508283000,"canceldate":1444508283000,"status":"SHIP","comment":"GARPAC: Order updated successfully. upc <887047957012> qty <1>","commenttype":"stat","trackingnumber":"1Z16X53A0317212345","cancelreason":"HA","pickdate":1444508283000,"shipdate":1444508283000,"shippingvendor":"URG","pickok":"E","failed_last_notified":"1544508283000","chargetimestamp":1549406746789}]}} ' http://retailapi-skechers-com.dev.skechers.com/api/store/order/update/status