Introduction

Search and update existing web orders. Admin order updates.

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

06000	Order not found.
06002	Order item not found.
06004	Order payment not found.
06005	Order not allowed to change.
06007	Order item not allowed to change.
06013	Order transaction error.
06025	Order already closed.
06026	Order not allowed to cancel partial order.
06029	Order resend email failed.
06038	Invalid state code.
06039	Payment timeout.
06040	SKU not available.
06041	Return label generation failed.
06042	Order has not been shipped, not eligible for return label.

WebItem

Parameters

id: int

Order Item Id generated by database.
orderid: int

Order number
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.
unitprice: float

Price of the item after discount
regularunitprice: float

Regular price before coupon and category discount
quantity: int

Quantity
discountcode: string
optional

Discount code applied to a order item.
discountcodedescription: string
optional

Description of the discount code used
stylecode: string

Style code of the order item placed for example 12977
colorcode: string

Code code of the order itemm for example WBKB.
color: string

Various options for the color of the order items provided, for example WHT/BLACK/BLUE
itemtype: string

Type of the item, for example 'REWARD' or 'SHOE'.
image: string

Product image applied to order item.
trackingnumber: string
optional

A string provided by a carrier to track the package.
trackinglink: string
optional

A url created by Skechers to allow customer tracks their package.
orderstatus: string

Status in which the order is, for example: NEW,SHIP,CANC etc.
quantityprice: float

The price of total quanity bought.
itemdiscountamount: float

The discount amount 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
itemshippingcost: float

The shipping cost applied to order item.
categorydiscountamount: float

The category discount applied to order item.
refundamount: float

Total refund amount applied to order item.
creditamount: float

Total credit amount applied to order item.
divisioncode: string

Skechers defined product divison for order item.
skutype: string
optional

Type of shoe width for order item, for example EW, EEW.
webwidth: string
optional

The web width for order item.
productname: string

Skechers defined product name for order item, for example D'Lites 2 - One Piece.
pickdate: Calendar
optional

The date that order has been processed by Skechers E2 systme.
shipdate: Calendar
optional

Expected shipping date of the Order
shipstorenum: string

Shipping store number
canceldate: Calendar
optional

Order cancel date
returndate: Calendar
optional

Order return date
cancelreason: string
optional

Order cancel reason
returnreason: string
optional

Order return reason
giftcard_recipient_name: string
optional

gift card's recipient name.
giftcard_recipient_email: string
optional

gidtcard’s recipient’s email address.
giftcard_sender_name: string
optional

gift card's sender name.
giftcard_cardnum: string
optional

Gift card CardNumber
giftcard_pin: string
optional

Gift card’s PIN number.
giftcard_msg: string
optional

Gift card message.
giftcard_amount: float
optional

Gift card amount
giftcard_expiration: Long
optional

Gift card’s expiration date
item_shipping_fname: string

Customer’s item’s shipping first name.
item_shipping_lname: string

Customer’s item’s shipping last name.
item_shipping_address1: string

Customer’s item’s shipping address line1.
item_shipping_address2: string

Customer’s item’s shipping address line2.
item_shipping_city: string

Customer’s item’s shipping city.
item_shipping_zip: string

Customer’s item’s shipping zipCode.
item_shipping_state: string

Customer’s item’s shipping state.
item_shipping_country: string

Customer’s item’s shipping country
item_shipping_phone: string

Customer’s item’s shipping phone number
.appCancellable: boolean

Status indicates order item is cancellable by a customer.
adminEditable: boolean

Status indicates order item is eidtable Skechers CS associate through Skxadmin.
adminReturnable: boolean

Status indicates order item is returnable Skechers CS associate through Skxadmin.
adminRevokable: boolean

Status indicates order item is revokable Skechers CS associate through Skxadmin.
adminRevoked: boolean

Status indicates order item is revoked Skechers CS associate through Skxadmin.
appReturnable: boolean

Status indicates order item is returnable by a customer.
isCreditedPoints: boolean

Status indicates order item is allow to credit.
itemtaxes: List[TaxCalculation]

List of taxs applied to order item.
itemtaxes[0].tax: float

Tax amount based on subtotal.
itemtaxes[0].taxtype: string

Tax type. Default tax type is TAX
item_issue_creditinvoice: boolean

Status indicates order item is allow to issue credit invoice.
isShoes: boolean

Boolean variable that defines if this order item is of type shoe or not.

WebItem-OMS

Parameters

id: int

Order Item Id generated by database.
orderid: String

Order number
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.
unitprice: float

Price of the item after discount
regularunitprice: float

Regular price before coupon and category discount
quantity: int

Quantity
stylecode: string

Style code of the order item placed for example 12977
colorcode: string

Code code of the order itemm for example WBKB.
color: string

Various options for the color of the order items provided, for example WHT/BLACK/BLUE
itemtype: string

Type of the item, for example 'REWARD' or 'SHOE'.
image: string

Product image applied to order item.
trackingnumber: string
optional

A string provided by a carrier to track the package.
trackinglink: string
optional

A url created by Skechers to allow customer tracks their package.
orderstatus: string

Status in which the order is, for example: NEW,SHIP,CANC etc.
quantityprice: float

The price of total quanity bought.
itemdiscountamount: float

The discount amount 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
itemshippingcost: float

The shipping cost applied to order item.
categorydiscountamount: float

The category discount applied to order item.
refundamount: float

Total refund amount applied to order item.
creditamount: float

Total credit amount applied to order item.
divisioncode: string

Skechers defined product divison for order item.
skutype: string
optional

Type of shoe width for order item, for example EW, EEW.
webwidth: string
optional

The web width for order item.
productname: string

Skechers defined product name for order item, for example D'Lites 2 - One Piece.
pickdate: Calendar
optional

The date that order has been processed by Skechers E2 systme.
shipdate: Calendar
optional

Expected shipping date of the Order
shipstorenum: string

Shipping store number
canceldate: Calendar
optional

Order cancel date
returndate: Calendar
optional

Order return date
cancelreason: string
optional

Order cancel reason
returnreason: string
optional

Order return reason
giftcard_recipient_name: string
optional

gift card's recipient name.
giftcard_recipient_email: string
optional

gidtcard’s recipient’s email address.
giftcard_sender_name: string
optional

gift card's sender name.
giftcard_cardnum: string
optional

Gift card CardNumber
giftcard_pin: string
optional

Gift card’s PIN number.
giftcard_msg: string
optional

Gift card message.
giftcard_amount: float
optional

Gift card amount
giftcard_expiration: Long
optional

Gift card’s expiration date
item_shipping_fname: string

Customer’s item’s shipping first name.
item_shipping_lname: string

Customer’s item’s shipping last name.
item_shipping_address1: string

Customer’s item’s shipping address line1.
item_shipping_address2: string

Customer’s item’s shipping address line2.
item_shipping_city: string

Customer’s item’s shipping city.
item_shipping_zip: string

Customer’s item’s shipping zipCode.
item_shipping_state: string

Customer’s item’s shipping state.
item_shipping_country: string

Customer’s item’s shipping country
item_shipping_phone: string

Customer’s item’s shipping phone number
isCreditedPoints: boolean

Status indicates order item is allow to credit.
itemtaxes: List[TaxCalculation]

List of taxs applied to order item.
itemtaxes[0].tax: float

Tax amount based on subtotal.
itemtaxes[0].taxtype: string

Tax type. Default tax type is TAX
item_issue_creditinvoice: boolean

Status indicates order item is allow to issue credit invoice.
isShoes: boolean

Boolean variable that defines if this order item is of type shoe or not.

WebOrder

Parameters

orderid: int

Skechers order number.
locale: string

Location from where the order enters the system. For example , en_US for USA orders.
parentid: int
optional

New order number for exchange order action.
storenum: string

Store where the order is placed.
customerid: int

For guest customer, userid is -1, for order placed through Omni, userid is -2, for Skechers Elite member, userid is any number greater than 0
emailaddress: string

Customer email used for placing order.
billing_fname: string

Customer’s billing first name.
billing_lname: string

Customer’s billing last name.
billing_address1: string

Customer’s billing address line1.
billing_address2: string
optional

Customer’s billing address line2.
billing_city: string

Customer’s billing city.
billing_zip: string

Customer’s billing zipCode.
billing_state: string

Customer’s billing state.
billing_country: string

Customer’s billing country.
billing_phone: string

Customer’s billing phone number.
shipping_fname: string

Customer’s shipping first name.
shipping_lname: string

Customer’s shipping last name.
shipping_address1: string

Customer’s shipping address line1.
shipping_address2: string
optional

Customer’s shipping address line2.
shipping_city: string

Customer’s shipping city.
shipping_zip: string

Customer’s shipping zipCode.
shipping_state: string

Customer’s shipping state.
shipping_country: string

Customer’s shipping country.
shipping_phone: string

Customer’s shipping phone number.
shippingmethod: string

Order shipping method, for example Standard shipping method.
shippingdescription: string

Description of shipping method, for example : Standard Shipping (4-10 business day for Standard shipping method).
discountcode: string
optional

Discount code used for placing the order.
tax: float

Tax amount applied to order.
discountamount: float

Discount amount applied to order.
shippingcost: float

Shipping amount applied to order.
referralid: string
optional

Order placed through Skechers affiliate member site. The referalid is an pre-defined name associated with each Skechers affiliate member, for example, the mobile-predictspring refers to the order placed by Skechers mobile application.
currencycode: string

Currency Code applied to order, for example: USD for Skechers US site.
ordertimestamp: Calendar

The time at which order is placed.
failedPaymentRetry: boolean
optional

Status indicates order has failed payments and 'Retry' option is allowed.
garpacid: string
optional

Applied to Skechers B2B site, a unique number provided by Skechers E2 system.
networkid: string
optional

Applied to Skechers B2B site, a unique string provided by a B2B employee while placing an order on Skechers's B2B site.
taxrate: float

Tax rate applied to order.
groupname: string
optional

Applied to Skechers B2B site, a unique name provided by B2B to identify a business unit.
estimatedShippingDate: Calendar
optional

Estimated Shipping Date applied to order.
crmecode: string
optional

A unique string for Skechers's Elite member.
crmcardnum: string
optional

A unique number for Skechers's Elite member.
subtotal: float

Sum of item total after item's category discount.
total: float

Total amount applied to order.
gcpaymentamount: float

Sum of total paid by gift cards.
totalaftergcpaymentamount: float

Order total amount after gift card payments.
orderAppCancellable: boolean
optional

Status indicates order is cancellable by a customer.
orderAdminEditable: boolean
optional

Status indicates order is cancellable by a Skechers CS associate through Skxadmin.
orderAdminReturnable: boolean
optional

Status indicates order qualifies for return by a Skechers CS associate through Skxadmin.
orderAdminDiscountable: boolean
optional

Status indicates order qualifies for discount by a Skechers CS associate through Skxadmin.
orderAdminRevokable: boolean
optional

Status indicates order qualifies for revoke by a Skechers CS associate through Skxadmin.
orderAdminRevoked: boolean
optional

Status indicates order has been revoked.
orderAdminVoidable: boolean
optional

Status indicates order qualifies for void by a Skechers CS associate through Skxadmin.
inReturnGracePeriod: boolean
optional

Status indicates order is under Skechers defined return period.
inPayPalReturnGracePeriod: boolean
optional

Status indicates order is under PayPal defined refund period.
orderDisplayReturn: boolean
optional

Status notifies front-end to show 'Return' option on 'MANAGER ORDER' dropdown selection on 'Order Detail' page.
failedCCPayment: boolean
optional

Status indicates order has failed payments
exchangeOrderIds: List[int]

List of exchanged order numbers.
orderitemwrites: List[WebItem]

Refers to WebItem object to Models -> WebItem.
exchangedOrderItems: List[WebItem]
optional

Order items linked to exchanged order, refers to WebItem object to Models -> WebItem.
creditedGiftCardItems: List[WebItem]
optional

Order items associated with refunded gift card items, refers to WebItem object to Models -> WebItem.
transactionwrites: List[TransactionWrites]

List of order transactions applied to order.
transactionwrites[0].id: int

A unique id generated by database.
transactionwrites[0].transactiontype: String
optional

Transaction type, for examle CVV, CC_SALE, CC_REFUND ...
transactionwrites[0].transactionamount: Float

The amount applied to payment gateway transaction.
transactionwrites[0].cctype: String

Credit card type applied to order.
transactionwrites[0].accountnumber: string

Payment's account number, for example credit card's acct number is last 4-digits prefixed with x, PayPal's acct number is payerId provided by PayPal.
transactionwrites[0].serverreferencenum: string

A unique number generated by Skechers to identify each transaction request.
transactionwrites[0].voidable: Boolean

Status indicates transaction is voidable.
transactionwrites[0].voided: Boolean
optional

Status indicates transaction has been voided.
ordercommentwrites: List[OrderCommentWrites]

List of comments applied to order.
ordercommentwrites[0].author: string

The user who adds the comment. For example : info@skechers.com or pshah@skechers.com
ordercommentwrites[0].commenttype: String

Type of comment. For example, Admin Add Comment, Cancel Comment, Revoke Comment.
ordercommentwrites[0].comment: string

Actual comment string
ordercommentwrites[0].entrytimeStr: string

The time at which the comment is created.
paymentwrites: List[PaymentWrites]

List of gateway payments applied to order.
paymentwrites[0].paymentid: int

A unique id generated by database.
paymentwrites[0].accountnumber: string

Payment's account number, for example credit card's acct number is last 4-digits prefixed with x, PayPal's acct number is payerId provided by PayPal.
paymentwrites[0].token: string

A unique string provided by payment gateway to identify individual credit card, gift card, PayPal paymet, Afterpay payment ...
paymentwrites[0].paymenttype: string

Skechers defined payment type, for example 'CREDIT' is for credit card payment, 'PAYPAL' is for PayPal payment, 'GIFT' is for gift card payment and 'REWARD' is for reward certificate payment.
paymentwrites[0].ccexp: string
optional

Credit card expiration.
paymentwrites[0].ccexpmonth: string

Credit card expiration month.
paymentwrites[0].ccexpyear: string

Credit card expiration year.
paymentwrites[0].cctype: string

Credit card type, for example MasterCard, visa, Discover etc.
paymentwrites[0].activeok: boolean

Status indicates credit card is active.
paymentwrites[0].totalrefundamount: float

Total refund amount occurs on a payment.
paymentwrites[0].totalchargedamount: float

Total charge amount occurs on a payment.
paymentwrites[0].updatedateStr: string

The timestamp with formatted string at which the payment is updated, for example: Jan 17, 2019 11:52 PST.
paymentwrites[0].allowCredit: boolean
optional

Total amount allows to credit on a payment.
paymentwrites[0].availableamount: float

Total available amount current on a payment.
paymentwrites[0].status: string
optional

Current status of payment.
paymentwrites[0].paymentservice: string
optional

Service provided by payment gateway, for example credit card have APPL(ApplePay) and GOOG(Google Wallet).
paymentwrites[0].authcode: string
optional

A unique number provided by payment gateway to identify each payment transaction.
PaymentWrites[0].numofinstallments: int
optional

Only applied to Webpay, number of payments a payment gateway offers.
emailWrites: List[OrderEmailWrites]

List of emails applied to order.
emailWrites[0].orderid: int

Customer’s order number.
emailWrites[0].storenum: string

Store Number from where the order was placed
emailWrites[0].recipient: string

Customer's email address.
emailWrites[0].subject: string

Email’s subject text. For example : Order_Confirmation_en_US order - #497552
emailWrites[0].log: string

While sending an email to the customer, a log message is generated that has the important information about the order and the customer. For example. {"orderid":"497552","emailaddress":"SHAHPANK1428@GMAIL.COM","orderDateStr":"Jan 17, 2019","hasGiftCardPayments":false,"hasPaypalPayments":false,"hasCreditCardPayments":true,"hasPayrollPayments":false,"hasWebpayPayments":false,"employeeid":"","numofinstallments":"","shippingCostStr":"FREE","hasDiscount":false,"discountcode":"","discountStr":"$0.00","shippingMethodStr":"FREE Standard Shipping (4-10 business days)*","paypalPaymentList":[],"giftCardPaymentList":[],"creditCardPaymentList":[{"accountnumber":"x1111","ccexp":"04/2031","cctype":"Visa","chargedamountStr":"$0.00","paymentType":"","paymentFee":"","authorizationCode":"8212339"}],"shippedItemList":[],"outofstockItemList":[],"currencyCode":null,"totalStr":"$91.80","totalAfterGCPaymentStr":"$91.80","totalGCPaymentStr":"$0.00","subtotalStr":"$85.00","taxStr":"$6.80","taxRateStr":"","taxStr2":"$0.00","taxType":null,"taxType2":null,"hasTax1":false,"hasTax2":false,"isWebOrder":true,"isRetailOrder":false,"isFreeOrder":false,"orderHistoryLinkStr":"http://localhost:9000/en-us/secure/signin","hasShippingAddress":false,"shiptoaddress":{"id":4146349,"firstname":"PANKTI","lastname":"SHAH","address1":"3700 WILSHIRE BLVD","address2":"350","city":"LOS ANGELES","state":"CA","zip":"30330","country":"USA","homephone":"4513111111","cellphone":"4513111111","createtimestamp":1547754737287},"orderbillingaddress":{"id":2221207,"firstname":"PANKTI","lastname":"SHAH","address1":"3700 WILSHIRE BLVD","address2":"350","city":"LOS ANGELES","state":"CA","zip":"30330","country":"USA","homephone":"4513111111","cellphone":"4513111111","createtimestamp":1547754737294},"hasShiptoAddress2":true,"shipToAddress2":"350","orderitems":[{"skunumber":"192283758959","skuvalue":"8.0","webwidth":"","webwidthlabel":"","skutype":"","stylecode":"12977","colorcode":"WBKB","productname":"D'Lites 2 - One Piece","imageUrl":"https://image.skechers.com/img/productimages/small/12977_WBKB.jpg","unitprice":"$85.00","regularunitprice":"$85.00","quantity":1,"quantityprice":"$85.00","discountcode":"","discountcodedescription":"","discountamount":"$0.00","categorydiscountamount":"$0.00","tax":"$6.80","shippingcost":"$0.00","totalprice":"$91.80","orderstatus":"NEW","hasTrackingNumber":false,"hascategorydiscount":false,"hasnocategorydiscount":true,"isEGiftCard":false,"isNotEGiftCard":true,"trackingnumber":null,"trackingLinkStr":"","giftcard_cardnum":"","giftcard_pin":"","recvremail":null,"recvrname":null,"sendername":null,"senderemail":null,"message":null,"carryStr":null,"productUrl":"http://localhost:9000/en-us/style/12977/d-lites-2-one-piece/WBKB","creditamount":"$0.00"}],"hasGiftCardRefund":false,"gcRefundAmountStr":null,"gcRefundCardNum":null,"gcRefundDateStr":null,"hasPaypalRefund":false,"payPalRefundAmountStr":null,"payPalRefundDateStr":null,"hasCreditCardRefund":false,"ccRefundAmountStr":null,"ccRefundAccountNum":null,"ccRefundDateStr":null,"hasAfterpayRefund":false,"apRefundAmountStr":null,"apRefundAccountNum":null,"apRefundDateStr":null,"totalRefundStr":null,"hasRewardCodeRefund":false,"rewardCodeRefundAmountStr":"$0.00","returnedItemList":[],"cancelledItemList":[],"cancelledItemsAmountStr":null,"totalAfterCancelStr":null,"cancelPartialOrder":false,"cancelWholeOrder":false,"fromJob":false,"originalItemList":[],"exchangedItemList":[],"updatedItemList":[],"adminChargeBackCardNumber":null,"adminChargeBackCardType":null,"adminChargeBackAmountStr":null,"adminChargeBackDateStr":null,"useEliteRewardCode":false,"estimatedShippingDateStr":"","isAfterpayOrder":false,"afterpayId":null,"storename":"600","website":"skechers.com","locale":"en_US","serverUrl":"http://localhost:9000/en-us","sslServerUrl":"http://localhost:9000/en-us"},
emailWrites[0].timestampStr: string

The time at which the email is sent out.
emailWrites[0].status: string

The status of the email that was sent ie if it is successfully sent or it is a failure
emailWrites[0].comment: string

If any extra comments that were mentioned in the email.
hasShippedItems: boolean
optional

Status indicates order has the items already delivered.
hasGCRCItem: boolean
optional

Status indicates order has the refunded gift card items.
hasInvoice: boolean

Status indicates order has a invoice.
hasNif: boolean

Status indicates order provides nif number.
requireNif: boolean

Status indicates order requires nif number.
isPayrollOrder: boolean

Status indicates order has PayPal payment.
isFreeOrder: boolean

Status indicates order is free and no payment needed.
orderAllowPartialCancel: boolean

Status indicates order allows to cancel some of order itmes.
taxes: List[TaxCalculation]

List of tax types applied to order.
taxes[0].tax: float

Tax amount based on subtotal. For example. $6.80
taxes[0].taxtype: string

Tax Type. Default tax type is TAX
numOfInstallments: Int
optional

Webpay only(Chile site), the number of payments Chile site offers.
printOrderSummary: boolean

Status indicates order has printable order summary available.
vatid: string
optional

Germany and Spain site only, a number is required for placing a order on Germany or Spain site.
isAfterpayOrder: boolean

Status indicates order uses Afterpay payment gateway.
afterpayId: string
optional

Afterpay only, a unique number provided by Afterpay to identify each order.

WebOrder-Oms

Parameters

orderid: String

Skechers order number.
locale: string

Location from where the order enters the system. For example , en_US for USA orders.
parentid: int
optional

New order number for exchange order action.
storenum: string

Store where the order is placed.
externaluserid: String

External User Id that was given by B2B, B2C.
emailaddress: string

Customer email used for placing order.
billing_fname: string

Customer’s billing first name.
billing_lname: string

Customer’s billing last name.
billing_address1: string

Customer’s billing address line1.
billing_address2: string
optional

Customer’s billing address line2.
billing_city: string

Customer’s billing city.
billing_zip: string

Customer’s billing zipCode.
billing_state: string

Customer’s billing state.
billing_country: string

Customer’s billing country.
billing_phone: string

Customer’s billing phone number.
shipping_fname: string

Customer’s shipping first name.
shipping_lname: string

Customer’s shipping last name.
shipping_address1: string

Customer’s shipping address line1.
shipping_address2: string
optional

Customer’s shipping address line2.
shipping_city: string

Customer’s shipping city.
shipping_zip: string

Customer’s shipping zipCode.
shipping_state: string

Customer’s shipping state.
shipping_country: string

Customer’s shipping country.
shipping_phone: string

Customer’s shipping phone number.
shippingmethod: string

Order shipping method, for example Standard shipping method.
shippingdescription: string

Description of shipping method, for example : Standard Shipping (4-10 business day for Standard shipping method).
tax: float

Tax amount applied to order.
shippingcost: float

Shipping amount applied to order.
referralid: string
optional

Order placed through Skechers affiliate member site. The referalid is an pre-defined name associated with each Skechers affiliate member, for example, the mobile-predictspring refers to the order placed by Skechers mobile application.
currencycode: string

Currency Code applied to order, for example: USD for Skechers US site.
ordertimestamp: Calendar

The time at which order is placed.
garpacid: string
optional

Applied to Skechers B2B site, a unique number provided by Skechers E2 system.
networkid: string
optional

Applied to Skechers B2B site, a unique string provided by a B2B employee while placing an order on Skechers's B2B site.
taxrate: float

Tax rate applied to order.
groupname: string
optional

Applied to Skechers B2B site, a unique name provided by B2B to identify a business unit.
estimatedShippingDate: Calendar
optional

Estimated Shipping Date applied to order.
crmecode: string
optional

A unique string for Skechers's Elite member.
crmcardnum: string
optional

A unique number for Skechers's Elite member.
subtotal: float

Sum of item total after item's category discount.
total: float

Total amount applied to order.
orderitemwrites: List[WebItem]

Refers to WebItem object to Models -> WebItem.
creditedGiftCardItems: List[WebItem]
optional

Order items associated with refunded gift card items, refers to WebItem object to Models -> WebItem.
paymentwrites: List[PaymentWrites]

List of gateway payments applied to order.
paymentwrites[0].paymentid: int

A unique id generated by database.
paymentwrites[0].accountnumber: string

Payment's account number, for example credit card's acct number is last 4-digits prefixed with x, PayPal's acct number is payerId provided by PayPal.
paymentwrites[0].token: string

A unique string provided by payment gateway to identify individual credit card, gift card, PayPal paymet, Afterpay payment ...
paymentwrites[0].paymenttype: string

Skechers defined payment type, for example 'CREDIT' is for credit card payment, 'PAYPAL' is for PayPal payment, 'GIFT' is for gift card payment and 'REWARD' is for reward certificate payment.
paymentwrites[0].ccexp: string
optional

Credit card expiration.
paymentwrites[0].ccexpmonth: string

Credit card expiration month.
paymentwrites[0].ccexpyear: string

Credit card expiration year.
paymentwrites[0].cctype: string

Credit card type, for example MasterCard, visa, Discover etc.
paymentwrites[0].activeok: boolean

Status indicates credit card is active.
paymentwrites[0].totalrefundamount: float

Total refund amount occurs on a payment.
paymentwrites[0].totalchargedamount: float

Total charge amount occurs on a payment.
paymentwrites[0].updatedateStr: string

The timestamp with formatted string at which the payment is updated, for example: Jan 17, 2019 11:52 PST.
paymentwrites[0].allowCredit: boolean
optional

Total amount allows to credit on a payment.
paymentwrites[0].availableamount: float

Total available amount current on a payment.
paymentwrites[0].status: string
optional

Current status of payment.
paymentwrites[0].paymentservice: string
optional

Service provided by payment gateway, for example credit card have APPL(ApplePay) and GOOG(Google Wallet).
paymentwrites[0].authcode: string
optional

A unique number provided by payment gateway to identify each payment transaction.
PaymentWrites[0].numofinstallments: int
optional

Only applied to Webpay, number of payments a payment gateway offers.
hasShippedItems: boolean
optional

Status indicates order has the items already delivered.
hasGCRCItem: boolean
optional

Status indicates order has the refunded gift card items.
hasInvoice: boolean

Status indicates order has a invoice.
hasNif: boolean

Status indicates order provides nif number.
requireNif: boolean

Status indicates order requires nif number.
numOfInstallments: Int
optional

Webpay only(Chile site), the number of payments Chile site offers.
printOrderSummary: boolean

Status indicates order has printable order summary available.
vatid: string
optional

Germany and Spain site only, a number is required for placing a order on Germany or Spain site.

BrainTree - Get Client Token

Retrieves client token from Braintree.

Request Parameters

userid: string

User's id

Response Parameters

token: string

User's client token generated by Braintree.
btUserId: string

User's id that is saved in Braintree.

POST /api/order/clientToken

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"userid":"63355474"}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/order/clientToken

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"userid":"63355474"}}

Example Response

{"result":{"token":"AbCdEfG","btUserId":"63355474"}}

Live Response

BrainTree - Get Nonce

Retrieves payment method nonce from Braintree by passing in the card id.

Request Parameters

cardid: int

Id associated with customer's credit card.

Response Parameters

paymentMethodNonce: string

Payment method nonce retrieved from Braintree.

POST /api/order/paymentMethodNonce

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"cardid":532915}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/order/paymentMethodNonce

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"cardid":532915}}

Example Response

{"result":"AbCdEfG"}

Live Response

BrainTree - Next User ID

Retrieves next user ID for BrainTree.

Request Parameters

Response Parameters

userid: string

User ID newly generated for use with BrainTree.

POST /api/order/payment/nextUserId

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH"}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/order/payment/nextUserId

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH"}

Example Response

{"result":{"userid":"MOBILE3704"}}

Live Response

Oms - Get Barcode Image

Get barcode image based on card number / pin or order id / item id combination. If both combinations exist, the lookup is based on the order id/ item id combination. The successful response is a base64 encoded string.

Request Parameters

orderid: int
optional

Order ID, numeric only, no dashes.
orderitemid: int
optional

Order item ID, numeric only, no dashes.
cardnum: string
optional

Card Number
pin: String
optional

Pin number for the card
format: String
optional

Format of the code, either 'QR' or 'code128', default is 'code128'
width: Int
optional

Width of the barcode image, default value is 350
height: Int
optional

Height of the barcode image, default value is 50

Response Parameters

imageStr: String

A base64 encoded string of the image.

POST /api/v2/order/getBarcode

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderid":652249,"orderitemid":10511676,"cardnum":"6035710349460000000","pin":"1234"}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/v2/order/getBarcode

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderid":652249,"orderitemid":10511676,"cardnum":"6035710349460000000","pin":"1234"}}

Example Response

{"errorCode":"200000","errorMessage":"Order id | item id : 65224 | 10511676 not found in web system."}

Live Response

Oms - Shipping Label

Get shipping label for the customer to return shoes. On error, returns an error code. On success, returns an URL for accessing AWS S3.

Request Parameters

orderid: int

Order ID, numeric only, no dashes.
orderitemid: int

Order item ID, numeric only, no dashes.

Response Parameters

s3bucket: string

Name of AWS S3 bucket, the place to store Skx's return order shipping labels.
s3objectkey: string

The key of return order shipping label in AWS S3 which is used to retrieve AWS S3 object.
url: string

The presigned url which is used to retrieve AWS S3 object.

POST /api/v2/ups/getReturnShippingLabel

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderid":538619,"orderitemid":10295219}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/v2/ups/getReturnShippingLabel

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderid":538619,"orderitemid":10295219}}

Example Response

{"result":[{"s3bucket":"skx-dev-catalog.skechers.com","s3objectkey":"skx-b2c-shippinglabel/2019/05/shipping_label_10295219.pdf","url":"https://{bucketname}.s3.amazonaws.com/{pathtoobject}?AWSAccessKeyId={accesskey}&Expires={expirationdate}&Signature={signature}"}]}

Live Response

Order - Add Comment

Add order comment.

Request Parameters

orderid: int

Order Id for which comment is being added.
comment: string

Comment String
adminuser: string
optional

Admin user adding comment. Example : pshah

Response Parameters

WebOrder: WebOrder object

Refers WebOrder to Models -> WebOrder.

POST /api/order/addOrderComment

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderid":"fill in order id","comment":"fill in comment","adminuser":"amyr@skechers.com"}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/order/addOrderComment

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderid":"fill in order id","comment":"fill in comment","adminuser":"amyr@skechers.com"}}

Example Response

{"result":"WebOrder object."}

Live Response

Order - Add Payment

CC charge failed, customer adds new credit card

Request Parameters

orderid: int

Order id for the payment being added
creditcard: object

Customers credit card information
creditcard.accountnumber: string

Credit card account number start with x with cc's last 4 digits, example as x1234.
creditcard.token: string

Token number generated for the card. If not mentioned it will take blank
creditcard.creditcardid: int
optional

required if customer uses saved credit card.
creditcard.refnum: string
optional

required if customer applies new credit card, refum is provided by Skechers web server. If not mentioned, it will take default value as blank string
creditcard.txnid: string
optional

required if customer applies new credit card, txnid is provided by Payment Gateway
creditcard.exp: string

Expiration of the card
creditcard.expmonth: string

Expiration month
creditcard.expyear: string

Expiration year
creditcard.cardtype: string

Type of card. For example : MasterCard, Visa, etc.
creditcard.default: boolean

If this card is the default card being used.
creditcard.srvc: string
optional

Payment service type, required for ApplePay(APPL), GoogleWallet(GOOG), Afterpay(AP), Webpay(WP).

Response Parameters

WebOrder: WebOrder object

Refers WebOrder to Models -> WebOrder.

POST /api/order/addOrderPayment

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderid":"fill in order id","creditcard":{"refnum":"2089","exp":"12/2018","accountnumber":"x1111","txnid":"2005027643","token":"","default":true,"expyear":"2018","expmonth":"12","cardtype":"Visa"}}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/order/addOrderPayment

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderid":"fill in order id","creditcard":{"refnum":"2089","exp":"12/2018","accountnumber":"x1111","txnid":"2005027643","token":"","default":true,"expyear":"2018","expmonth":"12","cardtype":"Visa"}}}

Example Response

{"result":"WebOrder object."}

Live Response

Order - Calculate Exchange

Calculate exchange items tax and shipping cost

Request Parameters

orderid: int

Order Id order being exchanged
lineitems: list

List of lineitems to be exchanged.
lineitems[0].shipstorenum: string
optional

pickup store number
lineitems[0].upccode: string

sku number of each order item in the placed order
lineitems[0].quantity: int

Quantity of the item being exchanged
lineitems[0].giftcard: object
optional

required for ordering virtual gift card.
lineitems[0].giftcard.recvremail: string

gift card's recipient email.
lineitems[0].giftcard.recvrname: string
optional

gift card's recipient name.
lineitems[0].giftcard.sendername: string
optional

gift card's sender name.
lineitems[0].giftcard.message: string
optional

Gift card message.
lineitems[0].shippingaddress: object
optional

Customer's shipping address information
lineitems[0].shippingaddress.firstname: string

Customer's shipping First name with maxlength = 255
lineitems[0].shippingaddress.lastname: string

Customer's shipping Last name with maxlength = 255
lineitems[0].shippingaddress.address1: string

Customer's shipping address line1 with maxlength = 255
lineitems[0].shippingaddress.address2: string

Customer's shipping address line2 with maxlength = 255
lineitems[0].shippingaddress.city: string

Customer's shipping city with maxlength = 50
lineitems[0].shippingaddress.state: string

Customer's shipping state with maxlength = 10
lineitems[0].shippingaddress.zip: string

Customer's shipping zipCode with maxlength = 25
lineitems[0].shippingaddress.country: string

Customer's shipping country with maxlength = 50
lineitems[0].shippingaddress.phone: string

Customer's shipping phone number with maxlength = 255
lineitems[0].shippingaddress.default: boolean

To denote if this is a default shipping address or not

Response Parameters

WebItem: WebItem object

Refers WebOrder to Models -> WebItem.

POST /api/order/exchangeOrderItems

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderid":"please fill in order id placed before","lineitems":[{"quantity":1,"upccode":"887047153575"}]}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/order/exchangeOrderItems

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderid":"please fill in order id placed before","lineitems":[{"quantity":1,"upccode":"887047153575"}]}}

Example Response

{"result":"List of WebItem objects."}

Live Response

Order - Close Order

Close order

Request Parameters

orderid: int

Order Id for the order being closed. Example : 496057
adminuser: string
optional

Admin username taking the action of closing the order. Example : pshah

Response Parameters

message: Message object

Skechers defined response message either Success or Error

POST /api/order/closeOrder

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderid":"207306","adminuser":"amy"}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/order/closeOrder

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderid":"207306","adminuser":"amy"}}

Example Response

{"result":"success / error"}

Live Response

Order Summaries

Retrieve customer's order history. On error, returns an error code. On success, returns order summary information associated with the customer.

Request Parameters

userid: int

Customer's ID.

Response Parameters

locale: string

Locale where the order was executed by the customer. en_US is US, en_US_direct is US Direct. es_CL is Chile, en_CA is Canada, fr_CA is French Canada, en_GB is UK, de_DE is Germany, and es_ES is Spain.
statuses: list

Status of the order. Example: NEW for pending, HOLD for questionable orders, SHIP for already shipped orders, or CANC for cancelled.
images: list

Images of the order items, excluding gift card/reward certificate image.
orderid: int

Order ID, numeric only, no dashes. Example: 497436.
timestamp: long

Expressed as a Unix timestamp in milliseconds. Example: 12/31/2025 is represented as 1767139200000.
total: double

Total amount of the order. Example: 100.00
ordertype: string

Type of order. Example: Online.
points: int

Number of points credited to an order. Example: 1000.

POST /api/v2/order/summaries

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"userid":"990093"}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/v2/order/summaries

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"userid":"990093"}}

Example Response

{"result":{"webOrders":[{"timestamp":1559603572000,"statuses":["SHIP"],"total":97.2,"points":98,"orderid":"545924","ordertype":"WEB","images":["https://image.skechers.com/img/productimages/large/149057_BBK.jpg"]}],"retailOrders":[],"rewardsOrders":[{"timestamp":1559603481000,"statuses":["SHIP"],"total":10,"points":-100,"orderid":"545923","ordertype":"WEB_REDEMPTION","images":[]}],"adjustments":[]}}

Live Response

Order Summaries V3

Retrieve customer's order history. On error, returns an error code. On success, returns order summary information associated with the customer.

Request Parameters

userid: int

User id of the customer who placed the order.
locale: string
optional

Locale is where the order was executed by the customer. Locale is used in request body when searching orders with API key without locale information.

Response Parameters

locale: string

Locale where the order was executed by the customer. en_US is US, en_US_direct is US Direct. es_CL is Chile, en_CA is Canada, fr_CA is French Canada, en_GB is UK, de_DE is Germany, and es_ES is Spain.
statuses: list

Status of the order. Example: NEW for pending, HOLD for questionable orders, SHIP for already shipped orders, or CANC for cancelled.
images: list

Images of the order items, excluding gift card/reward certificate image.
orderid: int

Order ID, numeric only, no dashes. Example: 497436.
timestamp: long

Expressed as a Unix timestamp in milliseconds. Example: 12/31/2025 is represented as 1767139200000.
total: double

Total amount of the order. Example: 100.00
ordertype: string

Type of order. Example: Online.
points: int

Number of points credited to an order. Example: 1000.

POST /api/v3/order/summaries

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"userid":"990093","pagenumber":0,"pagesize":10}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/v3/order/summaries

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"userid":"990093","pagenumber":0,"pagesize":10}}

Example Response

Live Response

Order-Cancel

Used When user wants to cancel the order through skechers.com. MyAccount->Order History -> Click on the order you want to cancel -> Cancel

Request Parameters

orderid: int

Order Id for the cancel being requested
lineitems: List

A List of Order Items to be cancelled
lineitems[0].orderitemid: int

An order will have more than 1 items hence, orderitemid is the id of each item in the order
lineitems[0].reason: string
optional

A comment mentioning the reason for updating the order
comments: string
optional

A comment mentioning the reason for updating the order
adminuser: string
optional

Admin User ID who is modifying the order

Response Parameters

WebOrder: WebOrder object

Refers WebOrder to Models -> WebOrder.

POST /api/order/cancelOrder

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderid":"496437","lineitems":[{"orderitemid":10150042,"reason":"customer cancel"}]}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/order/cancelOrder

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderid":"496437","lineitems":[{"orderitemid":10150042,"reason":"customer cancel"}]}}

Example Response

{"result":"WebOrder object."}

Live Response

Order-Update

Updates the list of order items mentioned in the request and updates the order as a whole from Admin.

Request Parameters

orderid: int

Order Id for the update being requested
lineitems: List

List of Line items to be updated. Should have atleast 1 line item. Line item list cannot be empty.
lineitems[0].orderitemid: int

An order will have more than 1 items hence, orderitemid is the id of each item in the order
lineitems[0].upccode: string

sku number of each order item in the placed order
lineitems[0].reason: string
optional

A comment mentioning the reason for updating the order
lineitems[0].amount: float
optional

Amount of the order item being modified.
comments: string
optional

A comment mentioning the reason for updating the order
adminuser: string
optional

Admin User ID who is modifying the order

Response Parameters

WebOrder: WebOrder object

Refers WebOrder to Models -> WebOrder.

POST /api/order/updateOrder

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderid":492427,"lineitems":[{"orderitemid":10146598,"upccode":"190872953709"}],"comment":"udpate shoe","adminuser":true}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/order/updateOrder

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderid":492427,"lineitems":[{"orderitemid":10146598,"upccode":"190872953709"}],"comment":"udpate shoe","adminuser":true}}

Example Response

{"result":"WebOrder object."}

Live Response

Order-Update Items

Updates the order items mentioned in the input request. Update item is called whenever the Admin user tries to update a Customer's Line Update. ie. update the size , updateOrderItems is called.

Request Parameters

orderid: int

Order Id for the update being requested
lineitems: List

List of Line items to be updated.
lineitems[0].orderitemid: int

An order will have more than 1 items hence, orderitemid is the id of each item in the order
lineitems[0].upccode: string

sku number of each order item in the placed order
lineitems[0].reason: string
optional

A comment mentioning the reason for updating the order
lineitems[0].amount: float
optional

Amount of the order item being modified.
adminuser: string
optional

Admin User ID who is modifying the order

Response Parameters

WebItem: WebItem object

Refers WebItem to Models -> WebItem.

POST /api/order/updateOrderItems

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderid":46712,"lineitems":[{"orderitemid":3698677,"upccode":"887047153599"}]}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/order/updateOrderItems

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderid":46712,"lineitems":[{"orderitemid":3698677,"upccode":"887047153599"}]}}

Example Response

{"result":"List of WebItem Objects."}

Live Response

Payment-Credit CC POS Orders

Tool used by Retail department to refund back to credit card for POS orders

Request Parameters

refnum: string

Reference Number which is given by Element
creditamount: float

Total amount to be creditted
transid: string

Transaction ID generated by Element
storenumber: string

Store Number
user: string

User who is making the call

Response Parameters

OrderLogTransaction: object

Order transaction related information.
storenum: string

Store where order placed.
transactiontype: string

Transaction type, such as CVS, CC_SALE, CC_REFUND, PAYPAL_SALE, GC_ACTIVATE ...
serverauthorizationcode: string

A unique code returned by payment gateway to identify each transaction.
serverreferencenum: string

A unique number generated by Skechers to identify each transaction.
requestfile: string

Transaction request data sent by Skechers.
responsefile: string

Transaction response data returned by payment gateway.
cctype: string

Credit card type or prepaid payment such as PayPal.
amount: float

Transaction amount.
entrytimestamp: number

JSON deserialized transaction time.
orderLog: OrderLog object

OrderLog.
payment: OrderPayment object

OrderPayment.

POST /api/order/creditCCByElementAdmin

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"refnum":"001_001_0170552_001916_7566_01_01","creditamount":10,"transid":"2005027133","storenumber":"1","user":"amyr@skechers.com"}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/order/creditCCByElementAdmin

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"refnum":"001_001_0170552_001916_7566_01_01","creditamount":10,"transid":"2005027133","storenumber":"1","user":"amyr@skechers.com"}}

Example Response

{"result":"OrderLogTransaction object."}

Live Response

Payment-Retry Failed CC

Retry failed credit card payment.

Request Parameters

orderid: int

Order ID of the payment that needs to be retried.
paymentid: int

Payment ID of the payment that needs to be retried.

Response Parameters

WebOrder: WebOrder object

Refers WebOrder to Models -> WebOrder.

POST /api/order/retryOrderPayment

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"paymentid":987573,"orderid":56497}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/order/retryOrderPayment

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"paymentid":987573,"orderid":56497}}

Example Response

{"result":"WebOrder object."}

Live Response

Payment-Updt CC Total Amt

Update CC Total Charged Amount

Request Parameters

orderid: int

Order Id for the amount to be charged
adminuser: text
optional

Admin User ID who is modifying the charged amount
chargedInfo: List

List of Credit card Charged information
chargedInfo[0].token: string

Token generated by the payment Gateway
chargedInfo[0].accountnumber: string

Credit card account number start with x with cc's last 4 digits, example as x1234.
chargedInfo[0].oldtotal: float

Old Amount which is being modified
chargedInfo[0].newtotal: float

Amount being modified to

Response Parameters

token: string

Token generated by the payment Gateway
accountnumber: string

Credit card Account number
oldtotal: float

Old Amount which is being modified
newtotal: float

Amount being modified to

POST /api/order/updateCCTotalChargedAmount

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderid":"243495","adminuser":"pshah","chargedInfo":[{"token":"6035710349460000000","accountnumber":"x1111","oldtotal":100,"newtotal":50}]}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/order/updateCCTotalChargedAmount

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderid":"243495","adminuser":"pshah","chargedInfo":[{"token":"6035710349460000000","accountnumber":"x1111","oldtotal":100,"newtotal":50}]}}

Example Response

{"result":[{"token":"6035710349460000000","accountnumber":"x1111","oldtotal":100,"newtotal":50}]}

Live Response

Remove GC balance

Remove balance from gift card / reward card.

Request Parameters

cardnumber: string

Card Number involved in the transaction
cardpin: string

Card Pin Number. If not mentioned, it will take a default value as blank string
amount: float
optional

Amount to be refunded
adminuser: string
optional

Admin user taking the action. For Example : pshah

Response Parameters

message: Message object

Skechers defined response message either Success or Error

POST /api/order/removeGCBalance

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"cardnumber":"6035710349473900159","cardpin":"8768","amount":2,"adminuser":"amy"}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/order/removeGCBalance

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"cardnumber":"6035710349473900159","cardpin":"8768","amount":2,"adminuser":"amy"}}

Example Response

{"result":"success / error"}

Live Response

Resend - Email

Resend order email.

Request Parameters

orderId: int

Order ID for which Resend Email needs to be invoked
recipient: string
optional

Recipient of the email
emailType: string

Type of email to be resent. For Example : Confirmation, refund, etc.
adminuser: string
optional

Admin user taking the action. For Example : pshah

Response Parameters

message: Message object

Skechers defined response message either Success or Error

POST /api/order/resendEmail

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderid":"495911","emailtype":"Order_Confirmation_en_US order - #495911"}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/order/resendEmail

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderid":"495911","emailtype":"Order_Confirmation_en_US order - #495911"}}

Example Response

{"result":"success / error"}

Live Response

Resend - GC Emails

Resend CGC emails for Orders.

Request Parameters

orderids: List(int)

Order IDs for which Resend Email needs to be invoked
refundOnly: boolean
optional

RefundOnly whether required or not

Response Parameters

message: Message object

Skechers defined response message either Success or Error

POST /api/order/resendGCEmails

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderids":[439852],"refundOnly":true}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/order/resendGCEmails

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderids":[439852],"refundOnly":true}}

Example Response

{"result":"success / error"}

Live Response

Search - Orders

(Admin Default Order Search) Search orders by order timestamp, Order ID. Any of the below mentioned request parameters can be used in combination as the search criteria. If no criteria mentioned, it is return all today's orders

Request Parameters

start: long
optional

Start time for order time search
end: long
optional

End time for order time search
userid: int
optional

for guest customer, userid is -1, for order placed through Omni, userid is -2, for Skechers Elite member, userid is any number greater than 0.
orderid: int
optional

Order ID
email: string
optional

Customer's Email Address
phone: string
optional

Customer's Phone number
creditcardnum: string
optional

Last 4 digit of credit card number used on the order
firstname: string
optional

Customer's first name
lastname: string
optional

Customer's last name
billaddr: string
optional

Customer's billing address
billzip: string
optional

Customer's billing zip code
shipaddr: string
optional

Customer's shipping address
shipzip: string
optional

Customer's shipping zip code
orderids: list of number
optional

List of Order IDs
paypalinvoice: number
optional

PayPal Invoice Number
limit: int
optional

Max results to be displayed. Default value sent = 500

Response Parameters

OrderSummary: object

Search order Summary information.
locale: string

The Locale from where the order comes from. Example : en-us, en-ca etc.
status: List[string]

the Probable List of status this order can be into. For example : NEW,CANC
billtofirstname: string

Customer's billing FirstName
billtolastname: String

Customer's billing LastName
billtophone: String

Customer's billing phone number
userid: number

for guest customer, userid is -1, for order placed through Omni, userid is -2, for Skechers Elite member, userid is any number greater than 0.
orderid: int

Order Id
gcid: int

Garpac ID.
timestamp: long

Time at which order was placed
total: double

Total cost of the order
type: string

Order coming from which channel. For example : Online
points: int

The number of points collected
discountcode: string

promotion code applied in the order. If not it will return null
isrewardorder: boolean

If this order is a Reward order or not

POST /api/order/searchOrders

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"firstname":"amy","lastname":"ruan","limit":500}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/order/searchOrders

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"firstname":"amy","lastname":"ruan","limit":500}}

Example Response

{"result":"List[OrderSummary]"}

Live Response

SearchOrder - Hold

Fetches all the orders with HOLD order status. There are no request parameters passed for this API Call.

Request Parameters

Response Parameters

HoldOrders: object

List of Hold Orders
HoldOrders.Orders: List[HoldOrder]

List of Hold Orders
HoldOrders.gcOrders: List[HoldOrder]

List of Garpac Held Orders
HoldOrders.waitOrders: List[HoldOrder]

List of all Waiting orders.
HoldOrder.Orderid: int

Order ID
HolderOrder.orderDate: java.util.Calender

Order Date
Holdorders.total: double

OrderTotal
Holdorders.name: string

The Name of the customer who placed the order
phone: string

Phone Number of the customer

POST /api/order/searchHoldOrders

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH"}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/order/searchHoldOrders

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH"}

Example Response

{"result":"HoldOrders object"}

Live Response

SearchOrder - ID

(ThankYou Page) Search by order id. Used in Thankyou page and admin for Order Detail screen.

Request Parameters

orderid: int

Order ID for the order to be fetched.

Response Parameters

WebOrder: WebOrder object

Refers WebOrder to Models -> WebOrder.

POST /api/order/searchOrderByOrderId

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderid":130045}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/order/searchOrderByOrderId

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderid":130045}}

Example Response

{"result":"WebOrder object."}

Live Response

SearchOrder - ID, Email

(Order Status) Search by order id and Email Address. Used in Order Status check in skechers.com. This API provides customer an easy way to check the order status without login to My Account

Request Parameters

orderid: int

Order ID. for the order to be searched
email: string

Email address of the customer who placed the order. Follows skechers Email format.

Response Parameters

WebOrder: WebOrder object

Refers WebOrder to Models -> WebOrder.

POST /api/order/searchByOrderIdEmail

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderid":130045,"email":"AMYRUAN@SKECHERS.COM"}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/order/searchByOrderIdEmail

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderid":130045,"email":"AMYRUAN@SKECHERS.COM"}}

Example Response

{"result":"WebOrder object."}

Live Response

SearchOrder - ID, External UserID

(Order History) Search by order id and External User ID. Used in Order Detail through My Account in skechers.com. This API provides customer an easy way to check the order status after Customer login into My Account. This API will not work for guest user or omni orders. For Guest or Omni Order Status, please use /api/order/searchByOrderIdEmail

Request Parameters

orderid: int

Order ID for the order to be searched.
externaluserid: String

External user ID will be passed by B2b, B2c.

Response Parameters

WebOrder-OMS: OmsWebOrder object

Refers WebOrder-OMS to Models -> WebOrder-OMS.

POST /api/v2/order/searchByOrderIdUserIdOMS

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderid":544528,"externaluserid":990104}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/v2/order/searchByOrderIdUserIdOMS

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderid":544528,"externaluserid":990104}}

Example Response

{"result":"WebOrder-OMS object. Refer Models."}

Live Response

SearchOrder - ID, UserID

(Order History) Search by order id and User ID. Used in Order Detail through My Account in skechers.com. This API provides customer an easy way to check the order status after Customer login into My Account. This API will not work for guest user or omni orders. For Guest or Omni Order Status, please use /api/order/searchByOrderIdEmail

Request Parameters

orderid: int

Order ID for the order to be searched.
userid: int

for guest customer, userid is -1, for order placed through Omni, userid is -2, for Skechers Elite member, userid is any number greater than 0.

Response Parameters

WebOrder: WebOrder object

Refers WebOrder to Models -> WebOrder.

POST /api/order/searchByOrderIdUserId

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderid":753,"userid":990104}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/order/searchByOrderIdUserId

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderid":753,"userid":990104}}

Example Response

{"result":"WebOrder object. Refer Models."}

Live Response

SearchOrder - Invoice By ID

Find order invoice by order id

Request Parameters

orderid: int

Customer's Order Id

Response Parameters

OrderInvoice: List of object

List of Order Invoice Information
id: int

A unique generated ID
invoiceid: string

Invoice ID. For example : CHL1002087 for CHILE locale
parentinvoiceid: string

Parent Invoice ID
orderid: int

Order Id
locale: string

Locale from where the order originated. For example : en_US
storenum: string

Store number. For example, en_US has store number : 600
invoicetype: string

Type of invoice generated.
invoicedate: calendar

Date of Invoice creation
nif: string

Tax Identification Number that deffers as per locale
taxrate: float

Tax rate applied.
createtimestamp: calendar

Invoice creation date time
updateuser: string
updatetimestamp: Calendar

Invoice update timestamp.
active: boolean

Whether this invoice is active or not
invoiceitems: List of objects

List of invoice item information
invoiceitems[0].orderitemid: int

Order item ID

POST /api/order/findOrderInvoice

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderid":236931}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/order/findOrderInvoice

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderid":236931}}

Example Response

{"result":"Optional[List[OrderInvoice]]"}

Live Response

SearchOrder - ItemId, Token

Search by order item id and gift card item token. This API allows customers to reprint their gift card and reward certifcate through the link that is embedded in gift card and reward certifcate emails.

Request Parameters

orderitemid: int
token: string

Response Parameters

WebOrder: WebOrder object

Refers WebOrder to Models -> WebOrder.

POST /api/order/searchByOrderItemIdToken

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderitemid":8082634,"token":"OYqsw2j"}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/order/searchByOrderItemIdToken

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderitemid":8082634,"token":"OYqsw2j"}}

Example Response

{"result":"WebOrder object."}

Live Response

V3 SearchOrder - Order ID, Email or user id

(Order Status) Search by order id and Email Address. Used in Order Status check in skechers.com. This API provides customer an easy way to check the order status without login to My Account

Request Parameters

orderid: String

Order ID. for the order to be searched
locale: string
optional

Locale is where the order was executed by the customer. Locale is used in request body when searching orders with API key without locale information.
email: string
optional

Email address of the customer who placed the order. Follows skechers Email format.
userid: string
optional

User id of the customer who placed the order.

Response Parameters

WebOrder: WebOrder object

Refers WebOrder to Models -> WebOrder.

POST /api/v3/order/searchOrder

Example Request

curl \
-X POST \
-H "Content-type: application/json" \
-d '{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderid":"130045","email":"AMYRUAN@SKECHERS.COM"}}
                            ' http://retailapi-skechers-com.dev.skechers.com/api/v3/order/searchOrder

{"apikey":"AY8ZRNUHN2I4MNM5JQDDWVBXWQBEUH","request":{"orderid":"130045","email":"AMYRUAN@SKECHERS.COM"}}

Example Response

{"result":"WebOrder object."}

ORDER

Models

APIs

Introduction

Error Codes

Response Parameters

errorCode: string

errorMessage: string

Codes

WebItem

Parameters

id: int

orderid: int

skunumber: string

skuvalue: string

unitprice: float

regularunitprice: float

quantity: int

discountcode: string optional

discountcodedescription: string optional

stylecode: string

colorcode: string

color: string

itemtype: string

image: string

trackingnumber: string optional

trackinglink: string optional

orderstatus: string

quantityprice: float

itemdiscountamount: float

itemtax: float

itemtotalprice: float

itemshippingcost: float

categorydiscountamount: float

refundamount: float

creditamount: float

divisioncode: string

skutype: string optional

webwidth: string optional

productname: string

pickdate: Calendar optional

shipdate: Calendar optional

shipstorenum: string

canceldate: Calendar optional

returndate: Calendar optional

cancelreason: string optional

returnreason: string optional

giftcard_recipient_name: string optional

giftcard_recipient_email: string optional

giftcard_sender_name: string optional

giftcard_cardnum: string optional

giftcard_pin: string optional

giftcard_msg: string optional

giftcard_amount: float optional

giftcard_expiration: Long optional

item_shipping_fname: string

item_shipping_lname: string

item_shipping_address1: string

item_shipping_address2: string

item_shipping_city: string

item_shipping_zip: string

item_shipping_state: string

item_shipping_country: string

item_shipping_phone: string

.appCancellable: boolean

adminEditable: boolean

adminReturnable: boolean

adminRevokable: boolean

adminRevoked: boolean

appReturnable: boolean

isCreditedPoints: boolean

itemtaxes: List[TaxCalculation]

itemtaxes[0].tax: float

itemtaxes[0].taxtype: string

item_issue_creditinvoice: boolean

isShoes: boolean

WebItem-OMS

Parameters

id: int

orderid: String

discountcode: string
optional

discountcodedescription: string
optional

trackingnumber: string
optional

trackinglink: string
optional

skutype: string
optional

webwidth: string
optional

pickdate: Calendar
optional

shipdate: Calendar
optional

canceldate: Calendar
optional

returndate: Calendar
optional

cancelreason: string
optional

returnreason: string
optional

giftcard_recipient_name: string
optional

giftcard_recipient_email: string
optional

giftcard_sender_name: string
optional

giftcard_cardnum: string
optional

giftcard_pin: string
optional

giftcard_msg: string
optional

giftcard_amount: float
optional

giftcard_expiration: Long
optional

trackingnumber: string
optional

trackinglink: string
optional

skutype: string
optional

webwidth: string
optional

pickdate: Calendar
optional

shipdate: Calendar
optional

canceldate: Calendar
optional

returndate: Calendar
optional

cancelreason: string
optional

returnreason: string
optional

giftcard_recipient_name: string
optional

giftcard_recipient_email: string
optional

giftcard_sender_name: string
optional

giftcard_cardnum: string
optional

giftcard_pin: string
optional

giftcard_msg: string
optional

giftcard_amount: float
optional

giftcard_expiration: Long
optional

parentid: int
optional

billing_address2: string
optional