Catalog


POST /api/catalog/addStyles

Add styles to category.

Default Example

{"apikey":"API-KEY","request":{"categoryuri":"/collections","stylecodes":["12340"]}}

POST /api/catalog/exportStyles

Export Styles. IMPORTANT: Must set processEmail = true in application.conf in order to receieve email.

Request Parameters

  • request: string

    Destination Email

Default Example

{"apikey":"API-KEY","request":"juna@skechers.com"}

POST /api/catalog/getAvailableSizes

Get available sizes by sku numbers

Request Parameters

  • skus: list of strings

    list of sku numbers to get all available sizes for the corresponding skus

Default Example

{"apikey":"API-KEY","request":{"skus":["683973000019","887047694979"]}}

POST /api/catalog/removeStyles

Remove styles from category.

Default Example

{"apikey":"API-KEY","request":{"categoryuri":"/collections","stylecodes":["12340"]}}

POST /api/retail/checkout/search

Searches the web inventory.

Request Parameters

  • style: string optional

    Style code of the product being searched.
  • color: string optional

    Color code of the product being searched.
  • upc: string optional

    Universal product codeof the product being searched.
  • size: string optional

    Size of the product being searched.
  • ipaddress: string optional

    IP address of the device for which the inventory search is being performed.

Response Parameters

  • message: string

    Returns success if a product is found, invalid request if there are not enough search parameters that are provided, no result when the provided parameters did not match any inventory records, and null if there are multiple products that fit the general description of the search parameters that are provided.
  • skus: Array of SKU objects

    Each SKU object fits the general description of the performed search query. Each sku object has a upc code and size.

Default Example

{"apikey":"API-KEY","request":{"size":"5.0","style":"48863","ipaddress":"172:1:2:3","color":"NAT","upc":"192283020858"}}

POST /api/catalog/updateAttributes

Update Attributes.

Request Parameters

  • attributes: list of strings

    list of attributes to be updated. It would replace existing list of attributes.

Default Example

{"apikey":"API-KEY","request":{"attributes":["Vegetarian","Memory Foam"]}}

POST /api/catalog/updateColorMap

Update ColorMap.

Request Parameters

  • colorcode: string

    ie. WSPK
  • color: string

    Primary color; Used for color refinement ie. WHITE
  • secondarycolor: String optional

    Secondary color; Used for color refinement ie. SILVER
  • colordesc: String optional

    Used to display on screen ie. 'WHITE / SILVER / PINK'

Default Example

{"apikey":"API-KEY","request":{"colorcode":"TEST","color":"WHITE"}}

POST /api/catalog/updateStyle

Update Style and the products

Request Parameters

  • stylecode: string

    stylecode
  • active: boolean

    true if active else inactive
  • name: string

    style name
  • gender: string

    M for Man, W for Woman, B for boy, G for girl, U for Unisex
  • overview: string

    overview
  • details: string optional

    details
  • construction: string optional

    construction
  • videourl: string optional

    video url such as youtube of the style
  • categories: list of strings

    categories
  • metatext: list of strings

    metatext to be used for searching
  • attributes: list of strings optional

    attributes
  • products: string optional

    products

Default Example

{"apikey":"API-KEY","request":{"stylecode":"10001","name":"S LIGHTS - STARLIGHT","products":[{"colorcode":"BKS","active":true}],"metatexts":["test"],"categories":["/test"],"overview":"test","gender":"G","active":true}}

POST /api/catalog/verifyUPC

This service will verify whether the list of UPC is in-stock and valid. If the UPC comes back with result with a boolean, then it's valid and the boolean represents in-stock status.

Request Parameters

  • request: list of strings

    List of UPC code to be verified

Default Example

{"apikey":"API-KEY","request":["683973000019","887047694979","886005987146"]}

POST /api/catalog/addAttributeToStyles

Add attribute to Styles

Default Example

{"apikey":"API-KEY","request":{"attribute":"","stylecodes":[]}}

POST /api/catalog/addCategory

Add a Category

Default Example

{"apikey":"API-KEY","request":{"name":"coolbrand"}}

POST /api/catalog/batchActivateStyles

Update styles' active field

Default Example

{"apikey":"API-KEY","request":{"locale":"en-US","active":"true","stylecodes":["4442"]}}

POST /api/catalog/createStyleLog

Create StyleLog

Default Example

{"apikey":"API-KEY","request":{"locale":"en-US","stylecode":"4442","userid":"test","logs":["test log message"]}}

POST /api/catalog/deleteCategory

Delete a Category

Default Example

{"apikey":"API-KEY","request":{"uri":"/collections/coolbrands"}}

POST /api/catalog/deleteColorMap

Delete a ColorMap

Default Example

{"apikey":"API-KEY","request":{"colorcode":""}}

POST /api/catalog/dequeueCatalogUpdate

Dequeue CatalogUpdate

Default Example

{"apikey":"API-KEY","request":{"locale":"en-US","stylecodes":["4442"]}}

POST /api/catalog/getAvailableColorsMaria

Get Available Colors for a Style

Request Parameters

  • style: string

    style code

Default Example

{"apikey":"API-KEY","request":{"style":"4442"}}

POST /api/catalog/getAvailableSizesMaria

Get Available Sizes for a Product from Maria

Request Parameters

  • style: string

    style code
  • color: string

    color code
  • isComplete: Boolean optional

    if the product is active and in stock

Default Example

{"apikey":"API-KEY","request":{"style":"4442","color":"BOL","isComplete":true}}

POST /api/catalog/getStructuredCategoryList

Get a structured category list

Default Example

{"apikey":"API-KEY","request":{"uris":["/collections/canvas","/styles/boots/ankle-boots","/styles/boots/motorcycle-boots"]}}

POST /api/catalog/queueCatalogUpdate

Queue CatalogUpdate

Default Example

{"apikey":"API-KEY","request":{"locale":"en-US","stylecodes":["4442"]}}

POST /api/catalog/update

Update whole catalog by locale regardless of lastupdate timestamp

Default Example

{"apikey":"API-KEY","request":{"locale":"en-US"}}

POST /api/catalog/updateCategory

Update a Category

Default Example

{"apikey":"API-KEY","request":{"uri":"/collections/coolbrand","name":"coolbrands"}}

POST /api/catalog/updateColorMapping

Update ColorMapping

Default Example

{"apikey":"API-KEY","request":{"locale":"fr-CA","colors":{},"colordesc":{}}}

POST /api/catalog/getOMSProductInfo

Get available product Info for OMS, which will only return active and complete product(s) with active and in-stock size(s). When a request contains a color code(for order update), response won't include style name and color.

Request Parameters

  • locale: string

    locale
  • styleCode: string

    Style code
  • colorCode: string optional

    color code for the product

Default Example

{"apikey":"API-KEY","request":{"locale":"en_US","styleCode":"4442","colorCode":"bol"}}


Checkout Engine


POST /api/order/afterpayCompleteOrder

Afterpay - capture payment and complete order.

Request Parameters

  • afterpayToken: string

    A unique string returns from 'Afterpay - Create Order' call used to identify each order request.
  • merchantRef: string

    A unique Skechers order number returns from 'Afterpay - Create Order' call.

Response Parameters

  • webOrder: WebOrder object

    Refers webOrder to Models -> WebOrder.

Default Example

{"apikey":"API-KEY","request":{"afterpaytoken":"","merchantref":""}}

POST /api/order/afterpayCreateOrder

Create afterpay order, to qualify afterpay, the total value of order has to be between $35.00 and $300.00 inclusvie, afterpay payment excludes the order with gift card purchase

Request Parameters

  • orderLogMsg: OrderLogMsg object

    Refers to Models -> OrderLogMsg, if there is a discrepancy in the param's definition between here and models, please use param definition below.
  • payments.creditcards: List[CreditCardMsg]

    List of credit cards.
  • payments.creditcards(0).accountnumber: string

    Afterpay only - static value as AP.
  • payments.creditcards(0).srvc: string

    Afterpay only - static value as AFTERPAY.

Response Parameters

  • afterpayToken: string

    A unique string to identify each order in Afterpay.
  • tokenExp: string

    Afterpay token expiration time.
  • merchantRef: string

    Skechers generated order id.

Afterpay Only

{"apikey":"API-KEY","request":{"payments":{"creditcards":[{"accountnumber":"AP","srvc":"AFTERPAY"}]},"emailaddress":"amyr@skechers.com","billingaddress":{"city":"Manhattan Beach","zip":"30330","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"229 MANHATTAN BEACH BLVD","phone":"3103183100"},"lineitems":[{"upccode":"192283758935","quantity":1,"shippingaddress":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"first item address","phone":"3103183100"}}],"userid":990104,"shippingmethod":"Standard"}}

Afterpay with GC Payment

{"apikey":"API-KEY","request":{"payments":{"creditcards":[{"accountnumber":"AP","srvc":"AFTERPAY"}],"giftcards":[{"accountnumber":"6035710349460000000","pin":"1234","balance":50}]},"emailaddress":"amyr@skechers.com","billingaddress":{"city":"Manhattan Beach","zip":"30330","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"229 MANHATTAN BEACH BLVD","phone":"3103183100"},"lineitems":[{"upccode":"192283758935","quantity":2,"shippingaddress":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"first item address","phone":"3103183100"}}],"userid":990104,"shippingmethod":"Standard"}}

Afterpay (Guest)

{"apikey":"API-KEY","request":{"payments":{"creditcards":[{"accountnumber":"AP","srvc":"AFTERPAY"}]},"emailaddress":"newemail@skechers.com","billingaddress":{"city":"Manhattan Beach","zip":"30330","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"229 MANHATTAN BEACH BLVD","phone":"3103183100"},"lineitems":[{"upccode":"192283758935","quantity":1,"shippingaddress":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"first item address","phone":"3103183100"}}],"userid":-1,"shippingmethod":"Standard"}}

Afterpay with GC Purchase

{"apikey":"API-KEY","request":{"payments":{"creditcards":[{"accountnumber":"AP","srvc":"AFTERPAY"}]},"emailaddress":"amyr@skechers.com","billingaddress":{"city":"Manhattan Beach","zip":"30330","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"229 MANHATTAN BEACH BLVD","phone":"3103183100"},"lineitems":[{"upccode":"99990001","quantity":1,"giftcard":{"recvremail":"amyr@skechers.com","recvrname":"to","sendername":"from","message":"hello"},"shippingaddress":{"city":"Manhattan Beach","zip":"30330","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"2nd item address","phone":"3103183100"}}],"userid":990104,"shippingmethod":"Standard"}}

POST /api/v2/order/authorization/cc

Performs an authorization call based on credit card.

Request Parameters

  • cardnumber: string

    Card Number.
  • expirationMonth: string

    Expiration month.
  • expirationYear: string

    Expiration year.
  • securityCode: string

    Security Code
  • billing.email: string

    The email address that customer uses in Skechers website.
  • billing.firstName: string

    Order billing first name.
  • billing.lastName: string

    Order billing last name.
  • billing.address1: string

    Order billing address line 1.
  • billing.address2: string optional

    Order billing address line 2.
  • billing.city: string

    Order billing city
  • billing.state: string optional

    Order billing state, default to empty space.
  • billing.postalCode: string optional

    Order billing zip, default to empty space.
  • billing.country: string optional

    Order billing country.
  • billing.phoneNumber: string

    Order billing phone.
  • amount: float

    The amount to be authorized on the payment card. This corresponds to the exact amount that can be collected from a payment card.

Response Parameters

  • id: string

    Payment ID that can be used to capture.

Default Example

{"apikey":"API-KEY","request":{"appversion":9,"amount":100,"expirationYear":"2031","expirationMonth":"12","securityCode":"123","billing":{"city":"Manhattan Beach","phoneNumber":"3101230000","email":"jsmith23@skechers.com","state":"CA","country":"USA","address2":"","postalCode":"90505","lastName":"Smith","firstName":"John","address1":"225 S Sepulveda"},"cardnumber":"4111111111111111"}}

POST /api/v2/order/authorization/token

Performs an authorization call based on token.

Request Parameters

  • token: string

    This is a unique identifier that is associated with a payment card, for Aurus payment gateway, test token is 2000000000002629, for CyberSource payment gateway, test token is 9C9B43FD878BA458E05341588E0A2C8A.
  • billing.email: string

    The email address that customer uses in Skechers website.
  • billing.firstName: string

    Order billing first name.
  • billing.lastName: string

    Order billing last name.
  • billing.address1: string

    Order billing address line 1.
  • billing.address2: string optional

    Order billing address line 2.
  • billing.city: string

    Order billing city
  • billing.state: string optional

    Order billing state, default to empty space.
  • billing.postalCode: string optional

    Order billing zip, default to empty space.
  • billing.country: string optional

    Order billing country.
  • billing.phoneNumber: string

    Order billing phone.
  • amount: float

    The amount to be authorized on the payment card. This corresponds to the exact amount that can be collected from a payment card.

Response Parameters

  • ci: string

    The Card Identifier(CI) is a unique identifier that is associated with a payment card.
  • oot: string

    The One Order Token(OOT) is associated with a pre-auth transaction. This can be used to perform post-auth/void/refund against a single pre-auth.
  • aptn: string

    The Aurus Pay Ticket Num(APTN) is associated with an approved and completed transaction.
  • aptid: string

    The Aurus Pay Transaction Identifier(APTID) is a unique identifier returned in the original authorization response message.
  • amount: float

    This is the approved amount corresponding to the action performed (pre-auth, post-auth, void, refund, etc.).

Aurus Example

{"apikey":"API-KEY","request":{"token":"2000000000002629","amount":100,"appversion":8,"billing":{"city":"Manhattan Beach","phoneNumber":"3101230000","email":"jsmith23@skechers.com","state":"CA","country":"USA","address2":"","postalCode":"90505","lastName":"Smith","firstName":"John","address1":"225 S Sepulveda"}}}

CyberSource Example

{"apikey":"API-KEY","request":{"token":"9C9B43FD878BA458E05341588E0A2C8A","amount":100,"appversion":9,"billing":{"city":"Manhattan Beach","phoneNumber":"3101230000","email":"jsmith23@skechers.com","state":"CA","country":"USA","address2":"","postalCode":"90505","lastName":"Smith","firstName":"John","address1":"225 S Sepulveda"}}}

POST /api/order/settleBraintreeSale

This API is only be used for test environment, the call will automatically put credit card sale in settle status in Braintree, this allows QA to start testing credit card refund quickly

Request Parameters

  • orderid: int

    Skechers order Id

Response Parameters

  • orderLogTransaction: OrderLogTransaction object

    Order transaction details include txn type, timestamp, request and response etc...

Settle Sale Transaction

{"apikey":"API-KEY","request":{"orderid":123456}}

POST /api/shipping/calculate

Given order items, calculate the shipping amount. Free shipping is given if customer has a SKECHERS.com account, or if customer has a promocode that gives free shipping.

Request Parameters

  • orderLogMsg: OrderLogMsg object

    Refers OrderLogMsg to Models -> OrderLogMsg, if there is a discrepancy in the param's definition between here and models, please use param definition below.

Response Parameters

  • rate: float

    Shipping amount.

Default Example

{"apikey":"API-KEY","request":{"emailaddress":"skxtest1@skxtest.com","userid":-1,"lineitems":[{"upccode":"886005472598","quantity":1,"shippingaddress":{"city":"Fake City","zip":"90288","state":"CA","firstname":"First","country":"USA","lastname":"Last","address1":"123 Fake St.","default":true,"phone":99999999}}],"shippingmethod":"Standard"}}

POST /api/v2/tax/calculate

Calculate tax for each order item, exclude the item with 100% discount and e-giftcard item.

Request Parameters

  • upc: string

    A 12 digit unique number used to identify Skechers's product.
  • quantityprice: float

    Price per item, the price has to be after any type of discount such as category discount or promotion discount.
  • skuvalue: string optional

    Requires if shopping item is Canada's kid shoe. Canada provides the discount for infant and kid shoes, Skechers configures sku value such as 1.0N, 2.0N, 3.0N, 1.0L and 1.5L for these items in order for Canada order gets discount.
  • shippingcost: float

    Shipping cost per item, the shipping cost per order has to be prorated to each item.
  • zip: String

    Order shipping postal code.
  • state: String optional

    Order shipping state, requires if shipping address is in USA and CAN.
  • country: String

    Order shipping country, Skechers is using ISO-3 defined country code such as USA, DEU and GBR.

Response Parameters

  • applyTaxableItem: List[ApplyTaxableItem]

    List of tax amount, type and rate per item.
  • applyTaxableItem[0].upc: string

    Returning upc number matches upc number in request parameter.
  • applyTaxableItem[0].tax: float

    Tax amount per item.
  • applyTaxableItem[0].taxtype: string

    Tax type per item.
  • applyTaxableItem[0].taxrate: float

    Tax rate per item.
  • applyTaxableItem[0].tax2: float

    Tax amount per item for Candad order, Canada has GST (Goods and Services tax) and HST(Harmonized sales tax) for HST participating provinces, Skechers displays GST in tax's group and HST in tax2's group.
  • applyTaxableItem[0].taxtype2: string

    Tax type per item for Candad order.
  • applyTaxableItem[0].taxrate2: float

    Tax rate per item for Candad order.

Default Example

{"apikey":"API-KEY","request":{"taxableitems":[{"quantityprice":48.75,"zip":"90706","state":"CA","country":"USA","skuvalue":"9","upc":"192283759215","shippingcost":0}]}}

POST /api/checkout/checkGCBalance

Check the balance of a gift card.

Request Parameters

  • gc: GiftCardMsg object

    GiftCardMsg object.
  • accountnumber: string

    Gift card number.
  • pin: string

    Pin code.

Response Parameters

  • giftCardBalance: GiftCardBalance object

    GiftCardBalance holds gift card card number, pin, current balance and type of gift card (giftcard or rewardcard) .
  • giftCardBalance.accountnumber: string

    Gift card number .
  • giftCardBalance.token: string

    Same as gift card number .
  • giftCardBalance.pin: string

    Gift card pin .
  • giftCardBalance.balance: float

    Current gift card hold value.
  • giftCardBalance.cardtype: string

    Giftcard or rewardcard.

Default Example

{"apikey":"API-KEY","request":{"gc":{"accountnumber":"6035710349460000000","pin":"1234"}}}

POST /api/checkout/authorizeElementCreditCard

In order to meet PCI requirements, Skechers implements hosted-payment solution provided by Element on Checkout page while customer enter the new credit card, because of this implementation, Element will not return credit card expiration back to Skechers. This API is created for front-end to make a call to Element directly not only retrieving credit card expiration info also validating credit card's CVV code, then returns credit card expiration info and CVV validation result back to front-end.

Request Parameters

  • refnum: string

    Skechers generated transaction based number, the refnum used here need to be captured from Element -TxnSetup call.
  • email: string

    Customer email used for placing order.

Response Parameters

  • authorized: boolean

    Status indicates credit card CVV validation is approved
  • expMonth: string

    Credit card expiration month.
  • expYear: string

    Credit card expiration month.
  • cvvResp: string

    Credit card CVV response code M(CVV matches).
  • errorDetails: string

    An error returns from Element payment service.

Authorized Credit Card

{"apikey":"API-KEY","request":{"refnum":"","email":"amyr@skechers.com"}}

POST /api/checkout/transactionSetup

This is Get Transaction ID and

Request Parameters

  • email: string

    Customer email used for placing order.
  • guest: boolean

    Guest or Skechers Elite member.
  • customerBillingAddressMsg: CustomerBillingAddressMsg object optional

    Custoemr billing info
  • customerBillingAddressMsg.firstname: string

    Customer billing first name.
  • customerBillingAddressMsg.lastname: string

    Customer billing last name.
  • customerBillingAddressMsg.address1: string

    Customer billing address line 1.
  • customerBillingAddressMsg.address2: string optional

    Customer billing address line 2.
  • customerBillingAddressMsg.city: string

    Customer billing city
  • customerBillingAddressMsg.state: string

    Customer billing state, default to empty space.
  • customerBillingAddressMsg.zip: string

    Customer billing zip, default to empty space.
  • customerBillingAddressMsg.country: string

    Customer billing country.
  • customerBillingAddressMsg.phone: string

    Customer billing phone.
  • customerBillingAddressMsg.default: boolean

    A option to allow billing info to de default for next purchase.
  • customCss: string optional

    The stylesheet Skechers passes to Element to styling the Add New Card iFrame on Checkout page.
  • processTransactionTitle: string optional

    Passes a customized name to Element for submiting a new credit card button.

Response Parameters

  • url: string

    The url provided by Element.
  • tnxid: string

    A unique string provided by used to identify each request.
  • refnum: string

    Skechers generated transaction based number used to identify each transaction.
  • responsemsg: string

    Response message.

Transaction Setup

{"apikey":"API-KEY","request":{"guest":false,"processTransactionTitle":"Save and Review Order","email":"SKXTEST1@SKXTEST.COM","customerBillingAddressMsg":{"city":"Manhattan Beach","zip":"30330","state":"CA","firstname":"Test","country":"USA","lastname":"User","address1":"229 Manhattan Beach Blvd","default":true,"phone":"3103183100"},"customCss":".selectOption{border-style:solid;width:45%;height:44px;border-color:#ccc;position:relative;top:1px;font-size:16px}.tdTransactionButtons{text-align:left;border-style:none;padding-top:8px;padding-left:12px;padding-right:12px}#trManualEntryCardNumber{display:inline-block;width:55%;padding-right:15px}#trManualEntryExpDate{display:inline-block;width:40%;height:72px}#trCVV{display:block}.tdLabel{display:block;text-align:left;font-size:14px}.cardNumber{margin-top:3px;width:inherit;height:40px;border-style:solid;border-color:#ccc;color:#434343;margin-bottom:10px;font-size:16px;}#tableManualEntry{width:100%}.tdField{width:100%;display:block}.cvv{width:20%;height:40px;border:1pxsolid#ccc;border-color:#ccc;border-style:solid}.tdLabel{font-weight:normal}#tdCardInformation{display:none}#trTransactionInformation{display:none}.buttonEmbedded:visited{width:50%;height:40px;line-height:40px;background-color:#0063ba;border-bottom:3pxsolid#103877;color:#fff}.buttonEmbedded:link{width:50%;height:40px;line-height:40px;background-color:#0063ba;border-bottom:3pxsolid#103877;color:#fff}.buttonCancel{display:none}.buttonCancel:visited{color:#fff}.buttonCancel:link{color:#fff}.content{border-style:none}#pnlForm{background-color:#efefefpadding-top:0px;padding-left:5px;padding-bototm:10px;padding-right:5px}#submit{background-color:#fff;border-style:solid;border-color:#ccc;color:#0063ba;cursor:pointer;display:inline-block;letter-spacing:1px;line-height:50px;height:50px;min-width:50px;text-align:center;text-decoration:none;text-transform:uppercase;vertical-align:top;font-weight:600;border-bottom-style:solid;border-bottom-color:#0063ba;border-bottom-width:1px;padding:0px;width:100%}#submit:hover{box-shadow:001px0#434343inset;background-color:#e3e3e3}#trTransactionEntry{background-color:#efefef}#tableTransactionEntry{padding-top:10px;padding-bottom:20px}@mediaonlyscreenand(max-width:1000px){#trManualEntryExpDate{width:100%;}}"}}

Authorized Credit Card

{"apikey":"API-KEY","request":{"refnum":"please fill in","email":"SKXTEST1@SKXTEST.COM"}}

POST /api/shipping/active

Based on your API Key's locale, give all the shipping methods applicable to this order. Filters by expiration, excluded states, active = true, and also sets the price accordingly if VIP or promocode ensures free shipping.

Request Parameters

  • userid: int

    Customer's ID. Pass in -1 if guest.
  • country: string

    Country, maxLength = 50
  • state: string optional

    State, maxLength = 10
  • promocode: string optional

    Promocode, maxLength = 50
  • elite: string optional

    Is new elite member or not. This is for checkout where customers check the box to want to become free members, but are not actually signed up yet and won't be signed up until order is placed.
  • upcs: list(string) optional

    Filter shipping methods based on UPCs provided. Helpful for returning free shipping when the order is guest and only contains E-Giftcards.

Response Parameters

  • shippingMethods: list[ShippingMethod]

    Refers ShippingMethod to Models -> ShippingMethod, filter shipping methods based on UPCs provided. Helpful for returning free shipping when the order is guest and only contains E-Giftcards.

Default Example

{"apikey":"API-KEY","request":{"state":"CA","elite":false,"upcs":[],"country":"USA","userid":-1,"promocode":"TEST"}}

POST /api/v2/order/checkout/gcSales

Gift card sales for B2C

Request Parameters

  • giftcards: List[OmsGiftCardSaleMsg]

    list of gift card payments.
  • giftcards[0].giftcardnumber: string

    19-digits gift card number.
  • giftcards[0].giftcardpin: string

    gift card pin.
  • giftcards[0].giftcardbalance: float

    the balance on gift card.
  • saleamount: float

    Amount needs to sale.

Response Parameters

  • result: List[OmsGCSaleResponseMsg]

    list of gift card sale response
  • giftcardnumber: string

    the gift card number of gc that has been redeemed
  • giftcardpin: string

    the pin number of gc that has been redeemed
  • approvedamount: float

    approved redeem amount
  • processortxnrefnum: string

    the processortxnrefnum is returned from gateway processor for redeeming gc transaction, this processortxnrefnum is required for void gift card sale call
  • skxtxnrefnum: string

    the skxtxnrefnum is generated by Skx server and required by making gift card sale call, return this value for reference
  • processorauthcode: string

    the processorauthcode is a authorization code returned from gateway processor for redeeming gc transaction.
  • error: object

  • errorCode: string

    06047
  • errorMessage: string

    There is not enough balance for redeeming

Default Example

{"apikey":"API-KEY","request":{"giftcards":[{"giftcardnumber":"6035710349460000000","giftcardpin":"1234","giftcardbalance":50},{"giftcardnumber":"6035710349460000001","giftcardpin":"1234","giftcardbalance":20}],"saleamount":60}}

POST /api/v2/order/checkout

API to place a B2B online order.

Request Parameters

  • storenum: string

    Skechers defined number for each store, for e-commerce sites US: 600, Chile: 611, Canada: 612, UK: 614, German: 615, Spain: 620.
  • locale: string

    US: en_US, Chile: es_CL, Canada: en_CA and fr_CA, UK: en_GB, German: de_DE, Spain: es_ES.
  • fraudscore: int optional

    Fraud score returned back from CyberSource Decision Manager.
  • underreview: boolean optional

    Boolean flag to signal to the OMS whether an order is under review or not by Decision Manager.
  • clientip: string optional

    Customer's ip address
  • emailaddress: string

    The email address that customer uses in Skechers website.
  • externaluserid: string

    An unique number to identify each customer, for guest , external user id is -1, for Skechers Elite member, external user id is provided by Pixel.
  • shippingmethod: string

    Skechers defined delivery method, for B2C they are Standard and UWB, for B2B they are Standard and W20.
  • billingaddress: AddressMsg object

    Order billing information.
  • billingaddress.firstname: string

    Order billing first name. Use value 'Timeout Log'/'Timeout Error' to get a 408(timeout) error, the difference is an order will be logged for 'Timeout Log'. Use value 'Validation Error' to get a 400 error and 'Internal Server Error' to get a 500 error.
  • billingaddress.lastname: string

    Order billing last name.
  • billingaddress.address1: string

    Order billing address line 1.
  • billingaddress.address2: string optional

    Order billing address line 2.
  • billingaddress.city: string

    Order billing city
  • billingaddress.state: string optional

    Order billing state, default to empty space.
  • billingaddress.zip: string optional

    Order billing zip, default to empty space.
  • billingaddress.country: string optional

    Order billing country.
  • billingaddress.phone: string

    Order billing phone.
  • employee: EmployeePurchase ojbect optional

    Required for Skx Friends & Family Sale when Skechers employee place order with promo code starts with SKX.
  • employee.employeeid: string optional

    Required for Skx Friends & Family Sale when Skechers employee place order with promo code starts with SKX.
  • employee.employeeinfo: string optional

    Required for Skx Friends & Family Sale when Skechers employee place order with promo code starts with SKX.
  • referralid: string optional

    Required if order is placed by Skechers's afflitate members, the max length is 50.
  • numofinstallments: int optional

    Required if order is placed by Skechers Chile site.
  • vatid: string optional

    Required if order is placed by Skechers Spain site.
  • garpacid: string optional

    Required if order is placed by Skechers direct.
  • groupbrandcode: string optional

    Required for B2b - Brand code includes the brands like KFC,Startbucks.etc..
  • groupaddressid: string optional

    Required while placing order through B2b..
  • payments: List[OmsPaymentMsg] object

    Customer payments information.
  • payments[0].accountnumber: string

    Payment account number. The value of account number for creditCard is last 4-digits card number prefixed with X, example as X1111, for PayPal is PayPal provided payerId example as SZJZFPFZTCWZS, for gift card or reward card is 19-digits long card number example as 6035710349460000001, for Afterpay is Afterpay provided merchant reference number example as 100100019430.
  • payments[0].token: string

    Payment token. The value of token for creditCard is a tokenizated string provided by credit card payment vendor example as A7809103-30F8-4295-9DE3-51779777F8F1, for PayPal is the auth code provided by PalPal during the sale transaction example as 0M7923012C1034257, for gift card or reward card is 19-digits long card number example as 6035710349460000001, for Afterpay is a tokenizated string provided by Afterpay during CreateOrder API call example as 4q0acagsbort2l94q3gmnquovm4bev15skb4d6nbkbt22b54mr6f.
  • payments[0].hosttnxid: string

    Host transaction ID. (e.g. Payment ID, Capture ID) Provided by payment provider that is used to identify transaction.
  • payments[0].clientrefnum: string

    Client reference number (e.g. clientReferenceInformation.code in CYBS). Provided to payment provider as a reference to the pre-authorization transaction.
  • payments[0].paymenttype: string

    Skechers defined case sensitive payment types, they are CREDIT, GIFT, REWARD, PAYAPL and AFTERPAY.
  • payments[0].transactionauthcode: string optional

    Authorization code provided by payment vendor during sale transaction.
  • payments[0].saleamount: float

    The order amount includes tax and shipping cost.
  • payments[0].exp: string optional

    Only required in CreditCard payment, Credit card expiration.
  • payments[0].expmonth: string optional

    Only required in CreditCard payment, Credit card expiration month.
  • payments[0].expyear: string optional

    Only required in CreditCard payment, Credit card expiration month.
  • payments[0].cardtype: string optional

    Only required in CreditCard payment, Credit card type.
  • payments[0].pin: string optional

    Only required in gift card and reward certificate payment, card pin number.
  • items: List[OmsOrderItemMsg]

    List of order items.
  • items[0].style: string

    Skechers defined product style code.
  • items[0].color: string

    Skechers defined 4 letters product color.
  • items[0].productname: string

    Skechers defined product description.
  • items[0].skunumber: string

    Skechers defined product unique number.
  • items[0].skusize: string

    Shoe size
  • items[0].skutype: string optional

    Skechers defined shoe's widith example as EW and EWW.
  • items[0].division: string optional

    Skechers defined product division code.
  • items[0].gender: string

    Product gender.
  • items[0].quantity: int optional

    the quantity of same product in shopping cart.
  • items[0].shipstorenum: string optional

    Pickup store number
  • items[0].itemtype: string

    Either SHOE, GIFTCARD and REWARD, they are case sensitive.
  • items[0].categorydiscountamount: float optional

    The discount defined by Skechers merchandiser.
  • items[0].regularunitprice: float

    The price for product without applying any discount.
  • items[0].unitprice: float

    The price after category discount and promo discount.
  • items[0].totalprice: float

    The price after discounts, tax and shipping cost.
  • items[0].shippingcost: string

    Shipping cost, default to be 0.
  • items[0].discounts: List[OmsDiscountMsg] optional

    List of promotional discounts applied to the order.
  • items[0].discounts[0].discountcode: string optional

    Required if discount is applied to the order.
  • items[0].discounts[0].description: string optional

    Discount description.
  • items[0].discounts[0].discountamount: float optional

    Required if discount is applied to the order, default is 0.
  • items[0].taxes: List[OmsTaxMsg] optional

    Taxes applied to item, Canada is the only country has multiple taxes (HST, QST, GST and PST) applied to item.
  • items[0].taxes[0].taxamount: float optional

    Tax amount per item.
  • items[0].taxes[0].taxtype: string optional

    Tax type per item.
  • items[0].taxes[0].taxrate: float optional

    Tax rate per item.
  • items[0].giftcard: GiftCardItemMsg object optional

    Required for ordering virtual gift card.
  • items[0].giftcard.recvremail: string optional

    Gift card's recipient email.
  • items[0].giftcard.recvrename: string optional

    Gift card's recipient name.
  • items[0].giftcard.sendername: string optional

    Gift card's sender name.
  • items[0].giftcard.message: string optional

    Gift card message.
  • shippingaddress: AddressMsg object

    Order shipping information.
  • items[0].shippingaddress.firstname: string

    Order shipping first name.
  • items[0].shippingaddress.lastname: string

    Order shipping last name.
  • items[0].shippingaddress.address1: string

    Order shipping address line 1.
  • items[0].shippingaddress.address2: string optional

    Order shipping address line 2.
  • items[0].shippingaddress.city: string

    Order shipping city
  • items[0].shippingaddress.state: string optional

    Order shipping state, default to empty space.
  • items[0].shippingaddress.zip: string optional

    Order shipping zip, default to empty space.
  • items[0].shippingaddress.country: string optional

    Order shipping country.
  • items[0].shippingaddress.phone: string

    Order shipping phone.
  • items[0].comments: string optional

    Comment per item.
  • items[0].employeeinfo: object optional

    Employee information for an B2B order item.
  • items[0].employeeinfo.employeeid: string optional

    Employee id.
  • items[0].employeeinfo.firstname: string optional

    Employee first name.
  • items[0].employeeinfo.lastname: string optional

    Employee last name.
  • items[0].employeeinfo.attr1: string optional

    Attribute 1
  • items[0].employeeinfo.attr2: string optional

    Attribute 2
  • items[0].employeeinfo.attr3: string optional

    Attribute 3
  • items[0].employeeinfo.attr4: string optional

    Attribute 4

Response Parameters

  • WebOrder-OMS: OmsWebOrder object

    Refers WebOrder-OMS.Impersonate -> b2b/b2c -> Order Service -> Models -> WebOrder-OMS.

Credit Card

{"apikey":"API-KEY","request":{"fraudscore":80,"payments":[{"hosttnxid":"5780845260226960303001","exp":"12/2099","accountnumber":"x1111","paymenttype":"CREDIT","saleamount":57.38,"token":"7010000000016321111","clientrefnum":"9124984","expyear":"2099","expmonth":"12","cardtype":"VISA"}],"garpacid":"10001","emailaddress":"jsmith23@skechers.com","billingaddress":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"EDDIE","country":"USA","address2":"","lastname":"FIGUEROA","address1":"225 S Sepulveda Blvd","phone":"3103183100"},"externaluserid":"1111","items":[{"shippingaddress":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"JOHN","country":"USA","address2":"","lastname":"SMITH","address1":"225 S Sepulveda Blvd","phone":"3103183100"},"productname":"Work Relaxed Fit: Ghenter - Bronaugh SR","quantity":1,"skutype":"","style":"232175","unitprice":47,"categorydiscountamount":22,"color":"BLK","division":"2W","regularunitprice":70,"taxes":[{"taxrate":0.1025,"taxamount":5.43}],"shippingcost":4.95,"skusize":"8.5","totalprice":57.38,"discounts":[{"discountcode":"LOYALTY","description":"$1 OFF","discountamount":1}],"itemtype":"SHOE","skunumber":"194880789039","gender":"M"}],"storenum":"602","shippingmethod":"Standard","locale":"en_US_direct","clientip":"123.0.123.1","groupname":"Kentucky Fried Chicken","underreview":false}}

Direct Billing

{"apikey":"API-KEY","request":{"payments":[{"paymenttype":"DIRECTBILL","saleamount":57.38}],"garpacid":"10001","emailaddress":"test23@skechers.com","billingaddress":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"JOHN","country":"USA","address2":"","lastname":"SMITH","address1":"225 S Sepulveda Blvd","phone":"3103183100"},"externaluserid":"1111","items":[{"shippingaddress":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"JOHN","country":"USA","address2":"","lastname":"SMITH","address1":"225 S Sepulveda Blvd","phone":"3103183100"},"productname":"Work Relaxed Fit: Ghenter - Bronaugh SR","quantity":1,"skutype":"","style":"232175","unitprice":47,"categorydiscountamount":22,"color":"BLK","division":"2W","regularunitprice":70,"taxes":[{"taxrate":0.1025,"taxamount":5.43}],"shippingcost":4.95,"skusize":"8.5","totalprice":57.38,"discounts":[{"discountcode":"LOYALTY","description":"$1 OFF","discountamount":1}],"itemtype":"SHOE","skunumber":"194880789039","gender":"M"}],"storenum":"602","shippingmethod":"Standard","locale":"en_US_direct","groupname":"Kentucky Fried Chicken"}}

Payroll

{"apikey":"API-KEY","request":{"groupbrandcode":"KFC","payments":[{"paymenttype":"PAYROLL","saleamount":57.38}],"garpacid":"10001","emailaddress":"test23@skechers.com","billingaddress":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"EDDIE","country":"USA","address2":"","lastname":"FIGUEROA","address1":"225 S Sepulveda Blvd","phone":"3103183100"},"externaluserid":"1111","employeeid":"12345","items":[{"shippingaddress":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"JOHN","country":"USA","address2":"","lastname":"SMITH","address1":"225 S Sepulveda Blvd","phone":"3103183100"},"productname":"Work Relaxed Fit: Ghenter - Bronaugh SR","quantity":1,"skutype":"","style":"232175","unitprice":47,"categorydiscountamount":22,"color":"BLK","division":"2W","regularunitprice":70,"taxes":[{"taxrate":0.1025,"taxamount":5.43}],"shippingcost":4.95,"skusize":"8.5","totalprice":57.38,"discounts":[{"discountcode":"LOYALTY","description":"$1 OFF","discountamount":1}],"itemtype":"SHOE","employeeinfo":{"employeeid":"1234","firstname":"John","lastname":"Smith","attr3":"note:PO123","attr2":"title:Manager","attr1":"locationid:1ABC"},"skunumber":"194880789039","gender":"M"}],"storenum":"602","shippingmethod":"Standard","locale":"en_US_direct","groupname":"Kentucky Fried Chicken","groupaddressId":"110001"}}

POST /api/v2/order/checkout

API to place a B2C online order.

Request Parameters

  • storenum: string

    Skechers defined number for each store, for e-commerce sites US: 600, Chile: 611, Canada: 612, UK: 614, German: 615, Spain: 620.
  • locale: string

    US: en_US, Chile: es_CL, Canada: en_CA and fr_CA, UK: en_GB, German: de_DE, Spain: es_ES.
  • fraudscore: int optional

    Fraud score returned back from CyberSource Decision Manager.
  • underreview: boolean optional

    Boolean flag to signal to the OMS whether an order is under review or not by Decision Manager.
  • emailaddress: string

    The email address that customer uses in Skechers website.
  • externaluserid: string

    An unique number to identify each customer, for guest , external user id is -1, for Skechers Elite member, external user id is provided by Pixel.
  • shippingmethod: string

    An unique number to identify each customer, for guest , external user id is -1, for Skechers Elite member, external user id is provided by Pixel.
  • billingaddress: AddressMsg object

    Order billing information.
  • billingaddress.firstname: string

    Order billing first name. Use value 'Timeout Log'/'Timeout Error' to get a 408(timeout) error, the difference is an order will be logged for 'Timeout Log'. Use value 'Validation Error' to get a 400 error and 'Internal Server Error' to get a 500 error.
  • billingaddress.lastname: string

    Order billing last name.
  • billingaddress.address1: string

    Order billing address line 1.
  • billingaddress.address2: string optional

    Order billing address line 2.
  • billingaddress.city: string

    Order billing city
  • billingaddress.state: string optional

    Order billing state, default to empty space.
  • billingaddress.zip: string optional

    Order billing zip, default to empty space.
  • billingaddress.country: string optional

    Order billing country.
  • billingaddress.phone: string

    Order billing phone.
  • employee: EmployeePurchase ojbect optional

    Required for Skx Friends & Family Sale when Skechers employee place order with promo code starts with SKX.
  • employee.employeeid: string optional

    Required for Skx Friends & Family Sale when Skechers employee place order with promo code starts with SKX.
  • employee.employeeinfo: string optional

    Required for Skx Friends & Family Sale when Skechers employee place order with promo code starts with SKX.
  • referralid: string optional

    Required if order is placed by Skechers's afflitate members, the max length is 50. Use app-ios or app-android for mobile applications.
  • numofinstallments: int optional

    Required if order is placed by Skechers Chile site.
  • vatid: string optional

    Required if order is placed by Skechers Spain site.
  • payments: List[OmsPaymentMsg] object

    Customer payments information.
  • payments[0].accountnumber: string

    Payment account number. The value of account number for creditCard is last 4-digits card number prefixed with X, example as X1111, for PayPal is PayPal provided payerId example as SZJZFPFZTCWZS, for gift card or reward card is 19-digits long card number example as 6035710349460000001, for Afterpay is Afterpay provided merchant reference number example as 100100019430.
  • payments[0].token: string

    Payment token. The value of token for creditCard is a tokenizated string provided by credit card payment vendor example as A7809103-30F8-4295-9DE3-51779777F8F1, for PayPal is the auth code provided by PalPal during the sale transaction example as 0M7923012C1034257, for gift card or reward card is 19-digits long card number example as 6035710349460000001, for Afterpay is a tokenizated string provided by Afterpay during CreateOrder API call example as 4q0acagsbort2l94q3gmnquovm4bev15skb4d6nbkbt22b54mr6f.
  • payments[0].hosttnxid: string

    Host transaction ID. (e.g. Payment ID, Capture ID) Provided by payment provider that is used to identify transaction.
  • payments[0].clientrefnum: string

    Client reference number (e.g. clientReferenceInformation.code in CYBS). Provided to payment provider as a reference to the pre-authorization transaction.
  • payments[0].paymenttype: string

    Skechers defined case sensitive payment types, they are CREDIT, GIFT, REWARD, PAYAPL and AFTERPAY.
  • payments[0].transactionauthcode: string optional

    Authorization code provided by payment vendor during sale transaction.
  • payments[0].saleamount: float

    The order amount includes tax and shipping cost.
  • payments[0].exp: string optional

    Only required in CreditCard payment, Credit card expiration.
  • payments[0].expmonth: string optional

    Only required in CreditCard payment, Credit card expiration month.
  • payments[0].expyear: string optional

    Only required in CreditCard payment, Credit card expiration month.
  • payments[0].cardtype: string optional

    Only required in CreditCard payment, Credit card type.
  • payments[0].pin: string optional

    Only required in gift card and reward certificate payment, card pin number.
  • items: List[OmsOrderItemMsg]

    List of order items.
  • items[0].style: string

    Skechers defined product style code.
  • items[0].color: string

    Skechers defined 4 letters product color.
  • items[0].productname: string

    Skechers defined product description.
  • items[0].skunumber: string

    Skechers defined product unique number.
  • items[0].skusize: string

    Shoe size
  • items[0].skutype: string optional

    Skechers defined shoe's widith example as EW and EWW.
  • items[0].division: string

    Skechers defined product division code.
  • items[0].gender: string

    Product gender.
  • items[0].quantity: int optional

    the quantity of same product in shopping cart.
  • items[0].shipstorenum: string optional

    Pickup store number
  • items[0].itemtype: string

    Either SHOE, GIFTCARD and REWARD, they are case sensitive.
  • items[0].categorydiscountamount: float optional

    The discount defined by Skechers merchandiser.
  • items[0].regularunitprice: float

    The price for product without applying any discount.
  • items[0].unitprice: float

    The price after category discount and promo discount.
  • items[0].totalprice: float

    The price after discounts, tax and shipping cost.
  • items[0].shippingcost: string

    Shipping cost, default to be 0.
  • items[0].discounts: List[OmsDiscountMsg] optional

    List of promotional discounts applied to the order.
  • items[0].discounts[0].discountcode: string optional

    Required if discount is applied to the order.
  • items[0].discounts[0].description: string optional

    Discount description.
  • items[0].discounts[0].discountamount: float optional

    Required if discount is applied to the order, default is 0.
  • items[0].taxes: List[OmsTaxMsg] optional

    Taxes applied to item, Canada is the only country has multiple taxes (HST, QST, GST and PST) applied to item.
  • items[0].taxes[0].taxamount: float optional

    Tax amount per item.
  • items[0].taxes[0].taxtype: string optional

    Tax type per item.
  • items[0].taxes[0].taxrate: float optional

    Tax rate per item.
  • items[0].giftcard: GiftCardItemMsg object optional

    Required for ordering virtual gift card.
  • items[0].giftcard.recvremail: string optional

    Gift card's recipient email.
  • items[0].giftcard.recvrename: string optional

    Gift card's recipient name.
  • items[0].giftcard.sendername: string optional

    Gift card's sender name.
  • items[0].giftcard.message: string optional

    Gift card message.
  • shippingaddress: AddressMsg object

    Order shipping information.
  • items[0].shippingaddress.firstname: string

    Order recipient's first name, the recipient can be the person picks an order at store or receives an order at home.
  • items[0].shippingaddress.lastname: string

    Order recipient's last name, the recipient can be the person picks an order at store or receives an order at home.
  • items[0].shippingaddress.address1: string

    Order shipping address line 1.
  • items[0].shippingaddress.address2: string optional

    Order shipping address line 2.
  • items[0].shippingaddress.city: string

    Order shipping city
  • items[0].shippingaddress.state: string optional

    Order shipping state, default to empty space.
  • items[0].shippingaddress.zip: string optional

    Order shipping zip, default to empty space.
  • items[0].shippingaddress.country: string optional

    Order shipping country.
  • items[0].shippingaddress.phone: string

    Order shipping phone.
  • items[0].comments: string optional

    Comment per item.
  • items[0].deliverytype: string optional

    Required for InStore pickup order, default to InStore.

Response Parameters

  • WebOrder-OMS: OmsWebOrder object

    Refers WebOrder-OMS.Impersonate -> b2b/b2c -> Order Service -> Models -> WebOrder-OMS.

Credit Card + Gift Card + Reward Cert

{"apikey":"API-KEY","request":{"fraudscore":80,"payments":[{"hosttnxid":"5780845260226960303001","exp":"12/2099","accountnumber":"x1111","paymenttype":"CREDIT","saleamount":12.38,"token":"7010000000016321111","clientrefnum":"9124984","expyear":"2099","expmonth":"12","cardtype":"VISA"},{"hosttnxid":"683252","accountnumber":"6035710349460000001","paymenttype":"GIFT","saleamount":20,"token":"6035710349460000001","pin":"1234"},{"hosttnxid":"683252","accountnumber":"6035710349460000001","paymenttype":"REWARD","srvc":"GIVEX","saleamount":20,"token":"6035710349460000001","pin":"1234"}],"emailaddress":"jsmith23@skechers.com","billingaddress":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"JOHN","country":"USA","address2":"","lastname":"SMITH","address1":"225 S Sepulveda Blvd","phone":"3103183100"},"externaluserid":"1112","referralid":"app-ios","items":[{"shippingaddress":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"JOHN","country":"USA","address2":"","lastname":"SMITH","address1":"225 S Sepulveda Blvd","phone":"3103183100"},"productname":"Work Relaxed Fit: Ghenter - Bronaugh SR","quantity":1,"skutype":"","style":"232175","unitprice":42,"categorydiscountamount":22,"color":"BLK","division":"2W","regularunitprice":70,"taxes":[{"taxrate":0.1025,"taxamount":5.43}],"shippingcost":4.95,"skusize":"8.5","totalprice":52.38,"discounts":[{"discountcode":"5OFF","description":"$5 OFF all items","discountamount":5},{"discountcode":"LOYALTY","description":"$1 OFF","discountamount":1,"comment":"Discount Campaign"}],"itemtype":"SHOE","skunumber":"194880789039","gender":"M"}],"storenum":"600","shippingmethod":"Standard","locale":"en_US","clientip":"123.0.123.1","externalorderid":"ext-123","underreview":false}}

In store pickup

{"apikey":"API-KEY","request":{"fraudscore":80,"payments":[{"hosttnxid":"5780845260226960303001","exp":"12/2099","accountnumber":"x1111","paymenttype":"CREDIT","saleamount":71.66,"token":"7010000000016321111","clientrefnum":"9124984","expyear":"2099","expmonth":"12","cardtype":"VISA"}],"emailaddress":"jsmith23@skechers.com","billingaddress":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"JOHN","country":"USA","address2":"","lastname":"SMITH","address1":"225 S Sepulveda Blvd","phone":"3103183100"},"externaluserid":"1112","items":[{"shippingaddress":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"JOHN","country":"USA","address2":"","lastname":"SMITH","address1":"1121 Manhattan Ave","phone":"3103183116"},"productname":"Work Relaxed Fit: Ghenter - Bronaugh SR","quantity":1,"skutype":"","style":"232175","unitprice":65,"color":"BLK","division":"2W","regularunitprice":70,"taxes":[{"taxrate":0.1025,"taxamount":6.66}],"skusize":"8.5","totalprice":71.66,"deliverytype":"InStore","discounts":[{"discountcode":"5OFF","description":"$5 OFF all items","discountamount":5}],"itemtype":"SHOE","shipstorenum":"001","skunumber":"194880789039","gender":"M"}],"storenum":"600","locale":"en_US","clientip":"123.0.123.1","externalorderid":"ext-123","underreview":false}}

PayPal

{"apikey":"API-KEY","request":{"payments":[{"hosttnxid":"0M7923012C1034257(PP sale transaction_id)","accountnumber":"SZJZFPFZTCWZS(PP payerid)","paymenttype":"PAYPAL","saleamount":57.38,"token":"0M7923012C1034257(PP sale transaction_id)"}],"emailaddress":"jsmith23@skechers.com","billingaddress":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"JOHN","country":"USA","address2":"","lastname":"SMITH","address1":"225 S Sepulveda Blvd","phone":"3103183100"},"externaluserid":"1112","items":[{"shippingaddress":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"JOHN","country":"USA","address2":"","lastname":"SMITH","address1":"225 S Sepulveda Blvd","phone":"3103183100"},"productname":"Work Relaxed Fit: Ghenter - Bronaugh SR","quantity":1,"skutype":"","style":"232175","unitprice":47,"categorydiscountamount":22,"color":"BLK","division":"2W","regularunitprice":70,"taxes":[{"taxrate":0.1025,"taxamount":5.43}],"shippingcost":4.95,"skusize":"8.5","totalprice":57.38,"discounts":[{"discountcode":"LOYALTY","description":"$1 OFF","discountamount":1}],"itemtype":"SHOE","skunumber":"194880789039","gender":"M"}],"storenum":"600","shippingmethod":"Standard","locale":"en_US","externalorderid":"ext-123"}}

AfterPay

{"apikey":"API-KEY","request":{"payments":[{"hosttnxid":"100113240172 (A transaction id returned from AP when making CapturePayment API call),","accountnumber":"100113240172 (A transaction id returned from AP when making CapturePayment API call)","paymenttype":"AFTERPAY","saleamount":57.38,"token":"lpdh54q3omo2foomns7dldlmci7fngfvutjivktrtbr6ianmt84s (A token created by AP when making CreateOrder API call)"}],"emailaddress":"jsmith23@skechers.com","billingaddress":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"JOHN","country":"USA","address2":"","lastname":"SMITH","address1":"225 S Sepulveda Blvd","phone":"3103183100"},"externaluserid":"1112","items":[{"shippingaddress":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"JOHN","country":"USA","address2":"","lastname":"SMITH","address1":"225 S Sepulveda Blvd","phone":"3103183100"},"productname":"Work Relaxed Fit: Ghenter - Bronaugh SR","quantity":1,"skutype":"","style":"232175","unitprice":47,"categorydiscountamount":22,"color":"BLK","division":"2W","regularunitprice":70,"taxes":[{"taxrate":0.1025,"taxamount":5.43}],"shippingcost":4.95,"skusize":"8.5","totalprice":57.38,"discounts":[{"discountcode":"LOYALTY","description":"$1 OFF","discountamount":1}],"itemtype":"SHOE","skunumber":"194880789039","gender":"M"}],"storenum":"600","shippingmethod":"Standard","locale":"en_US","externalorderid":"ext-123"}}

Purchasing Gift Card + Shoes

{"apikey":"API-KEY","request":{"fraudscore":80,"payments":[{"hosttnxid":"5780845260226960303001","exp":"12/2099","accountnumber":"x1111","paymenttype":"CREDIT","saleamount":77.38,"token":"7010000000016321111","clientrefnum":"9124984","expyear":"2099","expmonth":"12","cardtype":"VISA"}],"emailaddress":"jsmith23@skechers.com","billingaddress":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"JOHN","country":"USA","address2":"","lastname":"SMITH","address1":"225 S Sepulveda Blvd","phone":"3103183100"},"externaluserid":"1112","items":[{"shippingaddress":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"JOHN","country":"USA","address2":"","lastname":"SMITH","address1":"225 S Sepulveda Blvd","phone":"3103183100"},"productname":"Work Relaxed Fit: Ghenter - Bronaugh SR","quantity":1,"skutype":"","style":"232175","unitprice":47,"categorydiscountamount":22,"color":"BLK","division":"2W","regularunitprice":70,"taxes":[{"taxrate":0.1025,"taxamount":5.43}],"shippingcost":4.95,"skusize":"8.5","totalprice":57.38,"discounts":[{"discountcode":"LOYALTY","description":"$1 OFF","discountamount":1}],"itemtype":"SHOE","skunumber":"194880789039","gender":"M"},{"shippingaddress":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"JOHN","country":"USA","address2":"","lastname":"SMITH","address1":"225 S Sepulveda Blvd","phone":"3103183100"},"productname":"GIFT CARD","quantity":1,"skutype":"","style":"SKXGC01","unitprice":20,"categorydiscountamount":0,"color":"NOCO","division":"Z","giftcard":{"recvremail":"test@skechers.com","recvrname":"Test User","sendername":"JOHN SMITH","message":"Happy Holidays, Test!"},"regularunitprice":20,"taxes":[{"taxrate":0,"taxtype":"TAX","taxamount":0}],"shippingcost":0,"skusize":"1","totalprice":20,"itemtype":"GIFTCARD","skunumber":"99990001","gender":"U"}],"storenum":"600","shippingmethod":"Standard","locale":"en_US","clientip":"123.0.123.1","externalorderid":"ext-123","underreview":false}}

ApplePay

{"apikey":"API-KEY","request":{"fraudscore":80,"payments":[{"hosttnxid":"5780845260226960303001","exp":"12/2099","accountnumber":"x1111","paymenttype":"CREDIT","srvc":"APPL","saleamount":57.38,"token":"7010000000016321111","clientrefnum":"9124984","expyear":"2099","expmonth":"12","cardtype":"VISA"}],"emailaddress":"jsmith23@skechers.com","billingaddress":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"JOHN","country":"USA","address2":"","lastname":"SMITH","address1":"225 S Sepulveda Blvd","phone":"3103183100"},"externaluserid":"1112","referralid":"app-ios","items":[{"shippingaddress":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"JOHN","country":"USA","address2":"","lastname":"SMITH","address1":"225 S Sepulveda Blvd","phone":"3103183100"},"productname":"Work Relaxed Fit: Ghenter - Bronaugh SR","quantity":1,"skutype":"","style":"232175","unitprice":47,"categorydiscountamount":22,"color":"BLK","division":"2W","regularunitprice":70,"taxes":[{"taxrate":0.1025,"taxamount":5.43}],"shippingcost":4.95,"skusize":"8.5","totalprice":57.38,"discounts":[{"discountcode":"LOYALTY","description":"$1 OFF","discountamount":1}],"itemtype":"SHOE","skunumber":"194880789039","gender":"M"}],"storenum":"600","shippingmethod":"Standard","locale":"en_US","externalorderid":"ext-123","underreview":false}}

Credit Card - CA

{"apikey":"","request":{"fraudscore":80,"payments":[{"hosttnxid":"5780845260226960303001","exp":"12/2099","accountnumber":"x1111","paymenttype":"CREDIT","saleamount":52.38,"token":"7010000000016321111","clientrefnum":"9124984","expyear":"2099","expmonth":"12","cardtype":"VISA"}],"emailaddress":"jsmith23@skechers.com","billingaddress":{"city":"Mississauga","zip":"L4W5K7","state":"ON","firstname":"JOHN","country":"CAN","address2":"","lastname":"SMITH","address1":"5055 Satellite Drive, Unit #6","phone":"3103183100"},"externaluserid":"1112","referralid":"app-ios","items":[{"shippingaddress":{"city":"Mississauga","zip":"L4W5K7","state":"ON","firstname":"JOHN","country":"CAN","address2":"","lastname":"SMITH","address1":"5055 Satellite Drive, Unit #6","phone":"3103183100"},"productname":"Work Relaxed Fit: Ghenter - Bronaugh SR","quantity":1,"skutype":"","style":"232175","unitprice":42,"categorydiscountamount":22,"color":"BLK","division":"2W","regularunitprice":70,"taxes":[{"taxrate":0.1025,"taxamount":5.43,"taxtype":"GST"}],"shippingcost":4.95,"skusize":"8.5","totalprice":52.38,"discounts":[{"discountcode":"5OFF","description":"$5 OFF all items","discountamount":5},{"discountcode":"LOYALTY","description":"$1 OFF","discountamount":1,"comment":"Discount Campaign"}],"itemtype":"SHOE","skunumber":"194880789039","gender":"M"}],"storenum":"612","shippingmethod":"Standard","locale":"en_CA","underreview":false}}

Credit Card + SFCC reward certificate - CA

{"apikey":"","request":{"fraudscore":80,"payments":[{"hosttnxid":"5780845260226960303001","exp":"12/2099","accountnumber":"x1111","paymenttype":"CREDIT","saleamount":42.38,"token":"7010000000016321111","clientrefnum":"9124984","expyear":"2099","expmonth":"12","cardtype":"VISA"},{"hosttnxid":"683252","accountnumber":"D8P69T3KEGSQTUXK","paymenttype":"REWARD","srvc":"SFCC","saleamount":10,"token":"D8P69T3KEGSQTUXK"}],"emailaddress":"jsmith23@skechers.com","billingaddress":{"city":"Mississauga","zip":"L4W5K7","state":"ON","firstname":"JOHN","country":"CAN","address2":"","lastname":"SMITH","address1":"5055 Satellite Drive, Unit #6","phone":"3103183100"},"externaluserid":"1112","referralid":"app-ios","items":[{"shippingaddress":{"city":"Mississauga","zip":"L4W5K7","state":"ON","firstname":"JOHN","country":"CAN","address2":"","lastname":"SMITH","address1":"5055 Satellite Drive, Unit #6","phone":"3103183100"},"productname":"Work Relaxed Fit: Ghenter - Bronaugh SR","quantity":1,"skutype":"","style":"232175","unitprice":42,"categorydiscountamount":22,"color":"BLK","division":"2W","regularunitprice":70,"taxes":[{"taxrate":0.1025,"taxamount":5.43,"taxtype":"GST"}],"shippingcost":4.95,"skusize":"8.5","totalprice":52.38,"discounts":[{"discountcode":"5OFF","description":"$5 OFF all items","discountamount":5},{"discountcode":"LOYALTY","description":"$1 OFF","discountamount":1,"comment":"Discount Campaign"}],"itemtype":"SHOE","skunumber":"194880789039","gender":"M"}],"storenum":"612","shippingmethod":"Standard","locale":"en_CA","underreview":false}}

POST /api/checkout/logAuthDecline

Log any payment gateways' failed transactions into Order_Decline table

Request Parameters

  • email: string

    Customer email used for placing order.
  • avsresp: string optional

    Required if transaction is credit card address validation, such as M(street address and postal code match), N(neither street address nor postal code matches) etc ...
  • cvvresp: string optional

    Required if transaction is credit card CVV code validation, such as M(CVV match), N(CVV not match) etc ...
  • respcode: string optional

    Response code from payment gateway.
  • respmsg: string optional

    Detailed response message from payment gateway.

Response Parameters

  • message: Message object

    Skechers defined response message either Success or Error

Default Example

{"apikey":"API-KEY","request":{"avsresp":"Z","email":"amyr@skechers.com","respmsg":"Failed to match zip code","cvvresp":"Z","respcode":"0","acctnum":"x1111"}}

POST /api/order/checkout

Place a skechers direct order

Request Parameters

  • orderLogMsg: OrderLogMsg object

    Refers OrderLogMsg to Models -> OrderLogMsg, if there is a discrepancy in the param's definition between here and models, please use param definition below.
  • garpacid: string optional

    Required for en_US_direct locale
  • payment.payroll.employeeid: string optional

    Required for en_US_direct locale and payroll payment
  • employeeid: string optional

    Required for en_US_direct locale with Yun Brand group (garpacid: 28837)

Response Parameters

  • webOrder: WebOrder object

    Refers webOrder to Models -> WebOrder.

Pay with Payroll

{"apikey":"API-KEY","request":{"payments":{"payroll":{"employeeid":"1000"}},"garpacid":"10001","emailaddress":"amyr@skechers.com","billingaddress":{"city":"Manhattan Beach","zip":"30330","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"229 MANHATTAN BEACH BLVD","phone":"3103183100"},"employeeid":"","lineitems":[{"upccode":"827443976705","quantity":1,"shippingaddress":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"first item address","phone":"3103183100"}}],"userid":4067686,"shippingmethod":"Standard"}}

Yum Brand Order

{"apikey":"API-KEY","request":{"payments":{"payroll":{"employeeid":"1000"}},"garpacid":"28837","emailaddress":"amyr@skechers.com","billingaddress":{"city":"Manhattan Beach","zip":"30330","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"229 MANHATTAN BEACH BLVD","phone":"3103183100"},"employeeid":"1000","lineitems":[{"upccode":"827443976705","quantity":1,"shippingaddress":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"first item address","phone":"3103183100"}}],"userid":4067686,"shippingmethod":"Standard"}}

Pay with New CC

{"apikey":"API-KEY","request":{"payments":{"creditcards":[{"exp":"12/2099","accountnumber":"x1111","default":true,"creditcardid":14059,"expyear":"2099","expmonth":"12","cardtype":"Visa"}]},"garpacid":"10001","emailaddress":"amyr@skechers.com","billingaddress":{"city":"Manhattan Beach","zip":"30330","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"229 MANHATTAN BEACH BLVD","phone":"3103183100"},"lineitems":[{"upccode":"889110447918","quantity":1,"shippingaddress":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"first item address","phone":"3103183100"}}],"userid":4067686,"shippingmethod":"Standard"}}

Pay with Existing CC

{"apikey":"API-KEY","request":{"payments":{"creditcards":[{"exp":"01/2021","accountnumber":"x1111","default":true,"creditcardid":481891,"expyear":"2021","expmonth":"01","cardtype":"Visa"}]},"garpacid":"10001","emailaddress":"amyr@skechers.com","billingaddress":{"city":"Manhattan Beach","zip":"30330","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"229 MANHATTAN BEACH BLVD","phone":"3103183100"},"lineitems":[{"upccode":"827443976705","quantity":1,"shippingaddress":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"first item address","phone":"3103183100"}}],"userid":4067686,"shippingmethod":"Standard"}}

POST /api/order/checkout

Place an order. 1st case: token only, 2nd case: creditcard id only (use creditcardid to retrieve token), 3rd case: refnum & txnid (request new token), 4th case: no payment, test validation code, 5th case: tempus test

Request Parameters

  • orderLogMsg: OrderLogMsg object

    refers OrderLogMsg to Models -> OrderLogMsg, if there is a discrepancy in the param's definition between here and models, please use param definition below.

Response Parameters

  • webOrder: WebOrder object

    Refers webOrder to Models -> WebOrder.

New CC with Shoe Item

{"apikey":"API-KEY","request":{"payments":{"creditcards":[{"refnum":"13563078","exp":"undefined/undefined","accountnumber":"x1111","txnid":"2101746167","default":true,"expyear":"2999","expmonth":"01","cardtype":"Visa"}]},"emailaddress":"amyr@skechers.com","billingaddress":{"city":"Manhattan Beach","zip":"30330","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"229 MANHATTAN BEACH BLVD","phone":"3103183100"},"lineitems":[{"upccode":"192283758935","quantity":1,"shippingaddress":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"first item address","phone":"3103183100"}}],"userid":990104,"shippingmethod":"Standard"}}

New CC with Shoe Item - test for timeout

{"apikey":"API-KEY","request":{"payments":{"creditcards":[{"refnum":"13563078","exp":"undefined/undefined","accountnumber":"x1111","txnid":"element_timeout_txnid","default":true,"expyear":"2999","expmonth":"01","cardtype":"Visa"}]},"emailaddress":"amyr@skechers.com","billingaddress":{"city":"Manhattan Beach","zip":"30330","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"229 MANHATTAN BEACH BLVD","phone":"3103183100"},"lineitems":[{"upccode":"192283758935","quantity":1,"shippingaddress":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"first item address","phone":"3103183100"}}],"userid":990104,"shippingmethod":"Standard"}}

Existing CC with Shoe Item

{"apikey":"API-KEY","request":{"payments":{"creditcards":[{"exp":"01/2021","accountnumber":"x1111","default":true,"creditcardid":464266,"expyear":"2021","expmonth":"01","cardtype":"Visa"}]},"emailaddress":"amyr@skechers.com","billingaddress":{"city":"Manhattan Beach","zip":"30330","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"229 MANHATTAN BEACH BLVD","phone":"3103183100"},"lineitems":[{"upccode":"192283758935","quantity":1,"shippingaddress":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"first item address","phone":"3103183100"}}],"userid":990104,"shippingmethod":"Standard"}}

Existing CC Payment with Multiple Shoe Items

{"apikey":"API-KEY","request":{"payments":{"creditcards":[{"exp":"01/2021","accountnumber":"x1111","default":true,"creditcardid":464266,"expyear":"2021","expmonth":"01","cardtype":"Visa"}]},"emailaddress":"amyr@skechers.com","billingaddress":{"city":"Manhattan Beach","zip":"30330","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"229 MANHATTAN BEACH BLVD","phone":"3103183100"},"lineitems":[{"upccode":"192283758935","quantity":1,"shippingaddress":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"first item address","phone":"3103183100"}},{"upccode":"193113135780","quantity":1,"shippingaddress":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"first item address","phone":"3103183100"}}],"userid":990104,"shippingmethod":"Standard"}}

Existing CC Payment with Shoe Item and GC Item

{"apikey":"API-KEY","request":{"payments":{"creditcards":[{"exp":"01/2021","accountnumber":"x1111","default":true,"creditcardid":464266,"expyear":"2021","expmonth":"01","cardtype":"Visa"}]},"emailaddress":"amyr@skechers.com","billingaddress":{"city":"Manhattan Beach","zip":"30330","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"229 MANHATTAN BEACH BLVD","phone":"3103183100"},"lineitems":[{"upccode":"192283758935","quantity":1,"shippingaddress":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"first item address","phone":"3103183100"}},{"upccode":"99990001","quantity":1,"giftcard":{"recvremail":"amyr@skechers.com","recvrname":"to","sendername":"from","message":"hello"},"shippingaddress":{"city":"Manhattan Beach","zip":"30330","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"2nd item address","phone":"3103183100"}}],"userid":990104,"shippingmethod":"Standard"}}

Existing CC Payment + GC Payment

{"apikey":"API-KEY","request":{"payments":{"creditcards":[{"exp":"12/2099","accountnumber":"x1111","default":true,"creditcardid":464266,"expyear":"2099","expmonth":"12","cardtype":"Visa"}],"giftcards":[{"accountnumber":"6035710349460000000","pin":"1234","balance":50}]},"emailaddress":"amyr@skechers.com","billingaddress":{"city":"Manhattan Beach","zip":"30330","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"229 MANHATTAN BEACH BLVD","phone":"3103183100"},"lineitems":[{"upccode":"192283758935","quantity":2,"shippingaddress":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"first item address","phone":"3103183100"}}],"userid":990104,"shippingmethod":"Standard"}}

GC Payment - test for timeout

{"apikey":"API-KEY","request":{"payments":{"creditcards":[{"exp":"12/2099","accountnumber":"x1111","default":true,"creditcardid":464266,"expyear":"2099","expmonth":"12","cardtype":"Visa"}],"giftcards":[{"accountnumber":"603571034946timeout","pin":"1234","balance":50}]},"emailaddress":"amyr@skechers.com","billingaddress":{"city":"Manhattan Beach","zip":"30330","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"229 MANHATTAN BEACH BLVD","phone":"3103183100"},"lineitems":[{"upccode":"192283758935","quantity":2,"shippingaddress":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"first item address","phone":"3103183100"}}],"userid":990104,"shippingmethod":"Standard"}}

Existing CC Payment with Discount

{"apikey":"API-KEY","request":{"payments":{"creditcards":[{"exp":"01/2021","accountnumber":"x1111","default":true,"creditcardid":464266,"expyear":"2021","expmonth":"01","cardtype":"Visa"}]},"emailaddress":"amyr@skechers.com","billingaddress":{"city":"Manhattan Beach","zip":"30330","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"229 MANHATTAN BEACH BLVD","phone":"3103183100"},"lineitems":[{"upccode":"192283758935","quantity":1,"shippingaddress":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"first item address","phone":"3103183100"}}],"userid":990104,"shippingmethod":"Standard","discountcode":"QHUANG6TSO"}}

Free Order with 100% off

{"apikey":"API-KEY","request":{"emailaddress":"amyr@skechers.com","billingaddress":{"city":"Manhattan Beach","zip":"30330","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"229 MANHATTAN BEACH BLVD","phone":"3103183100"},"lineitems":[{"upccode":"192283758935","quantity":1,"shippingaddress":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"first item address","phone":"3103183100"}}],"userid":990104,"shippingmethod":"Standard","discountcode":"100OFF"}}

Skechers F&F Sale

{"apikey":"API-KEY","request":{"payments":{"creditcards":[{"exp":"01/2021","accountnumber":"x1111","default":true,"creditcardid":464266,"expyear":"2021","expmonth":"01","cardtype":"Visa"}]},"emailaddress":"amyr@skechers.com","billingaddress":{"city":"Manhattan Beach","zip":"30330","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"229 MANHATTAN BEACH BLVD","phone":"3103183100"},"employee":{"employeeid":"1234","employerinfo":"Skechers"},"lineitems":[{"upccode":"192283758935","quantity":1,"shippingaddress":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"first item address","phone":"3103183100"}}],"userid":990104,"shippingmethod":"Standard","discountcode":"skxff"}}

POST /api/order/checkout

Place a UK order.

Request Parameters

  • orderLogMsg: OrderLogMsg object

    Refers OrderLogMsg to Models -> OrderLogMsg, if there is a discrepancy in the param's definition between here and models, please use param definition below.
  • payments.creditcards: list

    List of credit card payments
  • payments.creditcards[0].txnid: string optional

    Required for Braintree add new credit card payment, tnxid is passed by Braintree when using tokenizationized call in js and Braintree provides test txnid as fake-valid-nonce.
  • payments.creditcards[0].creditcardid: string optional

    Required for Braintree using existing credit card payment, the creditcardid is the primary key defined in DB credit_cards table .

Response Parameters

  • webOrder: WebOrder object

    Refers webOrder to Models -> WebOrder.

New CC Payment with Shoe Item

{"apikey":"API-KEY","request":{"payments":{"creditcards":[{"accountnumber":"x1111","txnid":"fake-valid-nonce","token":"3DS-auth-id","default":true}]},"emailaddress":"amyr@skechers.com","billingaddress":{"city":"POTTERS BAR","zip":"EN6 2JD","firstname":"AMY","country":"GBR","address2":"DARKES LANE","lastname":"RUAN","address1":"9-11 WYLLYOTTS PLACE","phone":"1707655955"},"lineitems":[{"upccode":"884808386623","quantity":1,"shippingaddress":{"city":"POTTERS BAR","zip":"EN6 2JD","firstname":"AMY","country":"GBR","address2":"DARKES LANE","lastname":"RUAN","address1":"9-11 WYLLYOTTS PLACE","phone":"1707655955"}}],"userid":3064563,"shippingmethod":"Standard"}}

New CC Payment with Shoe Item - test for timeout

{"apikey":"API-KEY","request":{"payments":{"creditcards":[{"accountnumber":"x1111","txnid":"braintree_timeout_nonce","default":true}]},"emailaddress":"amyr@skechers.com","billingaddress":{"city":"POTTERS BAR","zip":"EN6 2JD","firstname":"AMY","country":"GBR","address2":"DARKES LANE","lastname":"RUAN","address1":"9-11 WYLLYOTTS PLACE","phone":"1707655955"},"lineitems":[{"upccode":"884808386623","quantity":1,"shippingaddress":{"city":"POTTERS BAR","zip":"EN6 2JD","firstname":"AMY","country":"GBR","address2":"DARKES LANE","lastname":"RUAN","address1":"9-11 WYLLYOTTS PLACE","phone":"1707655955"}}],"userid":3064563,"shippingmethod":"Standard"}}

Existing CC Payment with Shoe Item

{"apikey":"API-KEY","request":{"payments":{"creditcards":[{"accountnumber":"x1111","creditcardid":493099,"default":true,"cardtype":"Visa"}]},"emailaddress":"amyr@skechers.com","billingaddress":{"city":"POTTERS BAR","zip":"EN6 2JD","firstname":"AMY","country":"GBR","address2":"DARKES LANE","lastname":"RUAN","address1":"9-11 WYLLYOTTS PLACE","phone":"1707655955"},"lineitems":[{"upccode":"884808386623","quantity":1,"shippingaddress":{"city":"POTTERS BAR","zip":"EN6 2JD","firstname":"AMY","country":"GBR","address2":"DARKES LANE","lastname":"RUAN","address1":"9-11 WYLLYOTTS PLACE","phone":"1707655955"}}],"userid":3064563,"shippingmethod":"Standard"}}

Existing CC Payment with Multiple Shoe Items

{"apikey":"API-KEY","request":{"payments":{"creditcards":[{"accountnumber":"x1111","creditcardid":493099,"default":true,"cardtype":"Visa"}]},"emailaddress":"amyr@skechers.com","billingaddress":{"city":"POTTERS BAR","zip":"EN6 2JD","firstname":"AMY","country":"GBR","address2":"DARKES LANE","lastname":"RUAN","address1":"9-11 WYLLYOTTS PLACE","phone":"1707655955"},"lineitems":[{"upccode":"884808386623","quantity":1,"shippingaddress":{"city":"POTTERS BAR","zip":"EN6 2JD","firstname":"AMY","country":"GBR","address2":"DARKES LANE","lastname":"RUAN","address1":"9-11 WYLLYOTTS PLACE","phone":"1707655955"}},{"upccode":"888222283483","quantity":1,"shippingaddress":{"city":"POTTERS BAR","zip":"EN6 2JD","firstname":"AMY","country":"GBR","address2":"DARKES LANE","lastname":"RUAN","address1":"9-11 WYLLYOTTS PLACE","phone":"1707655955"}}],"userid":3064563,"shippingmethod":"Standard"}}

POST /api/order/checkout

Place an order through Skechers mobile application

Request Parameters

  • orderLogMsg: OrderLogMsg object

    Refers OrderLogMsg to Models -> OrderLogMsg, if there is a discrepancy in the param's definition between here and models, please use param definition below.
  • payments.creditcards: list

    List of credit card payments
  • payments.creditcards[0].srvc: string optional

    Required for Applypay and Google Wallet implementation, static value as AAPL and GOOG
  • refid: string

    Required for skechers mobile app, static value as mobile-predictspring

Response Parameters

  • webOrder: WebOrder object

    Refers webOrder to Models -> WebOrder.

New CC Payment

{"apikey":"API-KEY","request":{"payments":{"creditcards":[{"exp":"01/2022","accountnumber":"x1111","token":"WMdPwjyrqDgfErwlzrHwLpImwQfhKbzyvtae","default":true,"expyear":"2022","expmonth":"1","cardtype":"Visa"}]},"refid":"mobile-predictspring","emailaddress":"amyr@skechers.com","billingaddress":{"city":"Manhattan Beach","zip":"30330","state":"CA","firstname":"AMY","country":"USA","address2":"","lastname":"RUAN","address1":"229 MANHATTAN BEACH BLVD","phone":"3103183100"},"lineitems":[{"upccode":"889110373606","quantity":1,"shippingaddress":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"AMY","country":"USA","lastname":"RUAN","address1":"first item address","phone":"3103183100"}}],"userid":990104,"shippingmethod":"Standard"}}

Exist CC Payment

{"apikey":"API-KEY","request":{"payments":{"creditcards":[{"accountnumber":"x1111","default":true,"creditcardid":14059,"cardtype":"Visa"}]},"refid":"mobile-predictspring","emailaddress":"amyr@skechers.com","billingaddress":{"city":"Manhattan Beach","zip":"30330","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"229 MANHATTAN BEACH BLVD","phone":"3103183100"},"lineitems":[{"upccode":"889110447918","quantity":1,"shippingaddress":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"first item address","phone":"3103183100"}}],"userid":990104,"shippingmethod":"Standard","discountcode":"QHUANG6TSO"}}

ApplePay

{"apikey":"API-KEY","request":{"payments":{"creditcards":[{"exp":"01/2022","accountnumber":"x1111","srvc":"APPL","token":"g7yrpr","default":true,"expyear":"2022","expmonth":"1","cardtype":"Visa"}]},"refid":"mobile-predictspring","emailaddress":"amyr@skechers.com","billingaddress":{"city":"Manhattan Beach","zip":"30330","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"229 MANHATTAN BEACH BLVD","phone":"3103183100"},"lineitems":[{"upccode":"889110447918","quantity":1,"shippingaddress":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"first item address","phone":"3103183100"}}],"userid":990104,"shippingmethod":"Standard"}}

POST /api/checkout/payPalGetECDetail

Capture order related information such as order total, shipping and tax and customer's billing and shipping information.

Request Parameters

  • token: string

    A unique string returns from 'PayPal - Txn Setup' call

Response Parameters

  • email: string

    Customer's email.
  • shippingtoname: string

    Order shipping name.
  • shippingtostreet: string

    Order shipping address.
  • shippingtostreet2: string

    Order shipping address line 2.
  • shippingtocity: string

    Order shipping city.
  • shippingtostate: string

    Order shipping state.
  • shippingtozip: string

    Order shipping postal code.
  • shippingtocountrycode: string

    Order shipping country code.
  • shippingtocountryname: string

    Order shipping country name.
  • phone: string

    Order contacted phone.
  • billingname: string

    Order billing name
  • billingstreet: string

    Order billing street.
  • billingstreet2: string

    Order billing street line 2.
  • billingcity: string

    Order billing city.
  • billingstate: string

    Order billing state.
  • billingzip: string

    Order billing postal code.
  • billingcountrycode: string

    Order billing country code.
  • billingcountryname: string

    Order billing country name.

PayPal Get Checkout Detail Call

{"apikey":"API-KEY","request":{"token":"EC-86E55983RB147044B"}}

POST /api/order/checkout

Place a PayPal payment order,

Request Parameters

  • orderLogMsg: OrderLogMsg object

    Refers OrderLogMsg to Models -> OrderLogMsg, if there is a discrepancy in the param's definition between here and models, please use param definition below.
  • payments.paypal.token: string

    A unique string returns from 'PayPal - Txn Setup' call.
  • payments.paypal.payerid: string

    Returns from PayPal when PayPal redirects back to Skechers with 'https://dev.skechers.com/en-us/secure/checkout/customer?service=PayPal&token=EC-86E55983RB147044B&PayerID=SZJZFPFZTCWZS', the payerID 'SZJZFPFZTCWZS' is Skechers US test account, you can use this payerID with token returns from 'PayPal - Txn Setup' call to place PayPal order
  • payments.paypal.accountnumber: string

    Skechers treats accountnumber as PayPal payerID

Response Parameters

  • webOrder: WebOrder object

    Refers webOrder to Models -> WebOrder.

Place Order with PayPal Payment

{"apikey":"API-KEY","request":{"payments":{"paypal":{"accountnumber":"SZJZFPFZTCWZS","token":"EC-86E55983RB147044B","payerid":"SZJZFPFZTCWZS"}},"emailaddress":"amyr@skechers.com","billingaddress":{"city":"Manhattan Beach","zip":"30330","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"229 MANHATTAN BEACH BLVD","phone":"3103183100"},"lineitems":[{"upccode":"192283758935","quantity":1,"shippingaddress":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"first item address","phone":"3103183100"}}],"userid":990104,"shippingmethod":"Standard"}}

Place Order with PayPal Payment - test for timeout

{"apikey":"API-KEY","request":{"payments":{"paypal":{"accountnumber":"SZJZFPFZTCWZS","token":"EC-timeout_token","payerid":"SZJZFPFZTCWZS"}},"emailaddress":"amyr@skechers.com","billingaddress":{"city":"Manhattan Beach","zip":"30330","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"229 MANHATTAN BEACH BLVD","phone":"3103183100"},"lineitems":[{"upccode":"192283758935","quantity":1,"shippingaddress":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"first item address","phone":"3103183100"}}],"userid":990104,"shippingmethod":"Standard"}}

POST /api/checkout/paypalTransactionSetupWithItems

Setup an inital call with order info to PayPal

Request Parameters

  • email: string

    Customer's email.
  • taxamount: float

    Order tax amount.
  • shippingamount: float

    Order shipping cost
  • itemsamount: float

    Sum of the each item's amount, example as above itemsamount: 49.00 + 2 x 30.00 = 109.00.
  • ordertotal: float

    Sum of itemsamount, taxamount and shippingamount, example as above ordertotal: 109.00 + 5.00 + 5.00 = 119.00.
  • gcpaymentamount: float optional

    Sum of gift card payments.
  • discount: float optional

    Total discount per order.
  • minicartcheckout: boolean optional

    Use PayPal express checkout if it is true.
  • usepaypalshipping: boolean optional

    Use PayPal shipping adress if it is true.
  • items: List[PayPalTransactionSetupItemMsg]

    List of oder items.
  • items[0].prodname: string

    Name of item, such as 'SUNSHINES - SUMMERGLOW'.
  • items[0].amount: float

    Amount of item after discount.
  • items[0].stylecode: string

    Stylecode of item, such as 10270.
  • items[0].size: float

    Size of item, such as 12.0L.
  • items[0].qty: float

    Quantiry of item, such as 1, 2 ...

Response Parameters

  • token: string

    A unique string returns from PayPal, includes PayPal token.

PayPal Setup Call

{"apikey":"API-KEY","request":{"minicartcheckout":false,"ordertotal":119,"items":[{"stylecode":"10270","size":"12.0L","amount":30,"prodname":"SUNSHINES - SUMMERGLOW","qty":2},{"stylecode":"10249","size":"11.0L","amount":49,"prodname":"SHUFFLES - TRIPLE UP","qty":1}],"shippingamount":5,"taxamount":5,"usepaypalshipping":false,"discount":10,"itemsamount":109,"gcpaymentamount":50}}

POST /api/order/tempusCVVCheckWithTokenRequest

This call hasn't been implemented by Skechers global yet. This call shall be triggered when customer enter new credit card info on check out page, the call includes request cc token and cc's cvv validation

Request Parameters

  • tempus_tokenrequeststr: string

    When Skechers use Tempus js https://skechers-pp-prtldev.spectrumretailnet.com/PP?PAGE=JSENCRYPT call, Tempus will return a credit card tokne request str in Tempus RETURNMEMO field
  • cvv: string

    Credit card's cvv number

Default Example

{"apikey":"API-KEY","request":{"email":"amyr@skechers.com","tempus_tokenrequeststr":"","cvv":"201"}}

POST /api/order/checkout

Place an order with new cc

Request Parameters

  • orderLogMsg: OrderLogMsg object

    Refers OrderLogMsg to Models -> OrderLogMsg, if there is a discrepancy in the param's definition between here and models, please use param definition below.
  • payments.creditcards[0].token: string

    Tempus token combines transarmortoken & transarmortokenproviderid seperated by ':'

Response Parameters

  • webOrder: WebOrder object

    Refers webOrder to Models -> WebOrder.

new cc payment

{"apikey":"API-KEY","request":{"payments":{"creditcards":[{"exp":"04/2020","accountnumber":"x0026","token":"2905746509030026:002","default":true,"expyear":"2020","expmonth":"04","cardtype":"Visa"}]},"emailaddress":"amyr@skechers.com","billingaddress":{"city":"Manhattan Beach","zip":"46706","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"120E 7TH ST","phone":"3103183100"},"lineitems":[{"upccode":"192283758935","quantity":1,"shippingaddress":{"city":"Manhattan Beach","zip":"46706","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"120E 7TH ST","phone":"3103183100"}}],"userid":990104,"shippingmethod":"Standard"}}

POST /api/ups/validateAddress

Validate the given address using UPS Street Address Validation Service. Given a correct address, will return an empty list. If it has suggestions, it will return them in a list.

Request Parameters

  • address1: string

    Address Line 1.
  • address2: string optional

    Address Line 2.
  • city: string

    City.
  • state: string

    State code (ISO 3166-2).
  • zip: string

    Zip code.
  • country: string

    Country code (ISO 3).

Response Parameters

  • addresses: List[CustomerShippingAddress]

    List of UPS suggested addresses
  • addresses[0].id: string

    Id generated by database.
  • addresses[0].firstname: string

    Shipping first name.
  • addresses[0].lastname: string

    Shipping last name.
  • addresses[0].address1: string

    Shipping address line1.
  • addresses[0].address2: string

    Shipping address line 2.
  • addresses[0].city: string

    Shipping city.
  • addresses[0].state: string

    Shipping state.
  • addresses[0].zip: string

    Shipping postal code.
  • addresses[0].country: string

    Shipping country code.
  • addresses[0].homephone: string

    Shipping home phone.
  • addresses[0].cellphone: string

    Shipping cell phone.
  • addresses[0].createtimestamp: number

    Shipping address creation time.
  • addresses[0].default: boolean

    A option to setup shipping address to be default.

Default Example

{"apikey":"API-KEY","request":{"city":"Manhattan Beach","zip":"30330","state":"CA","country":"USA","address1":"225 S Sepulveda"}}

POST /api/order/webpayNormalAckOrder

Normal Pay - get tran result.

Request Parameters

  • token_ws: string

    A unique string created by Webpay returns from 'Webpay Normal Init' API call.
  • userid: string optional

    Customer's web id.

Response Parameters

  • redirectUrl: string

  • orderId: string

    Skechers order number.
  • token: string

    The token setup in request call.

Default Example

{"apikey":"API-KEY","request":{"token_ws":"","userid":"4065573"}}

POST /api/order/checkout

Normal Pay - InitTransaction.

Request Parameters

  • orderLogMsg: OrderLogMsg object

    Refers OrderLogMsg to Models -> OrderLogMsg, if there is a discrepancy in the param's definition between here and models, please use param definition below.
  • payments.creditcards: List[CreditCardMsg]

    List of credit cards.
  • payments.creditcards(0).accountnumber: string

    Webpay normal payment only - static value as WP.
  • payments.creditcards(0).srvc: string

    Webpay normal payment only - static value as WP_NORMAL.

Response Parameters

  • token: string

    A unique string to identify the order request.
  • redirectUrl: string

    The url provided by Webpay.
  • orderId: string

    Skechers order number.

Default Example

{"apikey":"API-KEY","request":{"payments":{"creditcards":[{"accountnumber":"wp","srvc":"WP_NORMAL"}]},"emailaddress":"amyr@skechers.com","billingaddress":{"city":"EL BOSQUE","zip":"","state":"","firstname":"AMY","country":"CHL","address2":null,"lastname":"RUAN","address1":"229 MANHATTAN BEACH BLVD","phone":"3103183100"},"lineitems":[{"upccode":"884808713535","quantity":1,"shippingaddress":{"city":"EL BOSQUE","zip":"","state":"","firstname":"AMY","country":"CHL","address2":null,"lastname":"RUAN","address1":"first item address","phone":"3103183100"}}],"userid":4065573,"shippingmethod":"Standard"}}

POST /api/order/checkout

One Click - place order

Default Example

{"apikey":"API-KEY","request":{"payments":{"creditcards":[{"exp":"12/2099","accountnumber":"x1111","default":true,"creditcardid":14059,"expyear":"2099","expmonth":"12","cardtype":"Visa"},{"exp":"12/2099","accountnumber":"x1111","token":"5F1C7C73-F57B-4B2C-96EC-BCF9A4E37E6F","default":true,"expyear":"2099","expmonth":"12","cardtype":"Visa"},{"refnum":"21333","exp":"12/2018","accountnumber":"x1111","txnid":"2005005341","default":true,"expyear":"2018","expmonth":"12","cardtype":"Visa"},{"exp":"12/2018","accountnumber":"x1111","default":true,"expyear":"2018","expmonth":"12","cardtype":"Visa"},{"exp":"04/20","accountnumber":"x0026","token":"9855610944010026:002","default":true,"expyear":"2020","expmonth":"04","cardtype":"Visa"}],"giftcards":[{"accountnumber":"6035710349460000000","pin":"1234","balance":50}]},"emailaddress":"amyr@skechers.com","billingaddress":{"city":"Manhattan Beach","zip":"30330","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"229 MANHATTAN BEACH BLVD","phone":"3103183100"},"lineitems":[{"upccode":"889110447918","quantity":1,"shippingaddress":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"first item address","phone":"3103183100"}},{"upccode":"99990001","quantity":1,"giftcard":{"recvremail":"amyr@skechers.com","recvrname":"to","sendername":"from","message":"hello"},"shippingaddress":{"city":"Manhattan Beach","zip":"30330","state":"CA","firstname":"AMY","country":"USA","address2":null,"lastname":"RUAN","address1":"2nd item address","phone":"3103183100"}}],"userid":990104,"shippingmethod":"Standard","discountcode":"QHUANG6TSO","payroll":{"employeeid":"12345","employerinfo":"skechers"}}}

POST /api/checkout/transactionSetup

get transaction token and redirect URl.

Default Example

{"apikey":"API-KEY","request":{"email":"SKXTEST1@SKXTEST.COM","guest":false,"customerBillingAddressMsg":{"city":"Manhattan Beach","zip":"30330","state":"CA","firstname":"Test","country":"USA","lastname":"User","address1":"229 Manhattan Beach Blvd","default":true,"phone":"3103183100"},"customCss":"#tdCardInformation{color: blue}"}}

POST /api/checkout/webpayOneClickRegisterUser

get tbkUser Id

Default Example

{"apikey":"API-KEY","request":{"email":"amyr@skechers.com","token":"please fill in token from OneClickTransactionSetupApi"}}

POST /api/v2/order/checkout/voidGcSales

Gift card void sales for B2C

Request Parameters

  • voidablegiftcards: List[OmsVoidGiftCardSaleMsg]

    list of voidable gift cards.
  • voidablegiftcards[0].processortxnrefnum: string

    Gift card sale Chase provided transaction id.
  • voidablegiftcards[0].skxrefnum: string

    Gift card sale Skechers provided reference number.
  • voidablegiftcards[0].voidamount: number optional

    Partial void is supported by sending void amount in request, without sending void amount in request, full amount is voided .

Response Parameters

  • voidgiftcardsalesresult: List[OmsVoidGiftCardSaleResponseMsg]

    list of gift card void sale response
  • voidgiftcardsalesresult[0].processortxnrefnum: string

    Original voidable gift card Chase provided transaction id.
  • voidgiftcardsalesresult[0].skxrefnum: string

    Original voidable gift card Skechers provided reference number.
  • voidgiftcardsalesresult[0].status: boolean

    Status of void gift card sale.

Default Example

{"apikey":"API-KEY","request":{"voidablegiftcards":[{"processortxnrefnum":"6035710349460000000","skxrefnum":"1234","voidamount":50}]}}


Content Management


POST /api/cms/addMessageToAllLocales

add messages to a MessageComponent with a specific name

Request Parameters

  • kvp: map

  • name: string

Default Example

{"apikey":"API-KEY","request":{"name":"/test","kvp":{"test1":"test1","test2":"test2"}}}

POST /api/cms/createContentDoc

persistent a content document to couch via file upload.

Request Parameters

  • prefixfile: string

    media file base name , like delivery_man
  • filename: string optional

    generic content document file name.
  • locale: string

    locale ID, such as en_us, en_uk, de_de
  • title: string optional

    content document title.
  • linkurl: string optional

    linkurl associated with the file.
  • linktype: string optional

    link type.
  • title: string optional

    content document title.
  • alttext: string optional

    alt text.
  • imagemap: string optional

    imagemap.
  • height: int optional

    image file height.
  • width: int optional

    image file width.
  • startdate: long

    start date in long integer format by js conversion.
  • enddate: long

    end date in long integer format by js conversion.

Default Example

{"apikey":"API-KEY","request":{"imagemap":"test image map","linktype":"Info","alttext":"SKECHERS Delivery Guy","height":483,"locale":"en_US","linkurl":"/info/slip-and-fall-warranty","prefixfile":"delivery-man","filename":"TEST_1234.jpg","title":"SKECHERS Delivery Guy","enddate":2951917525475,"width":269,"startdate":1374044400000}}

POST /api/cms/createKeywordGroup

Use this to create a keyword group

Request Parameters

  • locale: string

  • keywordtype: string

  • input: list[string]

  • output: list[string]

Default Example

{"apikey":"API-KEY","request":{"locale":"en_US","keywordtype":"search_redirects","input":["silver","grey","sparking"],"output":["silver"]}}

POST /api/group/createGroup

Create a new Group

Request Parameters

  • locale: string

  • admin: boolean

Default Example

{"apikey":"API-KEY","request":{"name":"test company","garpacid":"12345","url":"/testCompany","shippingmethods":{},"description":"empty","locale":"en_US_direct","code":"adf93d","discountcode":"30%off","status":"active"}}

POST /api/cms/updatePage

Use this to create/update a page

Request Parameters

  • url: string

  • locale: string

  • pagetitle: string

  • metatext: string optional

  • topnav: boolean

    indicates whether the page contains a top navigation
  • sitemap: boolean

    indicates whether the page will be included in the siteamp
  • lastmodifiedname: string

  • lastmodifiedtime: long

  • startdate: long

  • enddate: long

  • rows: list

Default Example

{"apikey":"API-KEY","request":{"sitemap":true,"url":"/fortest","pagetitle":"for test","topnav":true,"locale":"en_UK","lastmodifiedname":"frontend@skx.com","metatext":"this is for test","lastmodifiedtime":123456,"id":"page:en_uk:/fortest","status":"active","enddate":1411494671167,"rows":[{"rowtype":"full","slots":[{"bgcolor":"black","droplets":[{"dtype":"html","styles":[],"link":"http://www.skechers.com/en-us","title":"View All","enddate":123459,"html":"hello","productlimit":0,"startdate":123456}],"lastmodifiedname":"frontend@skx.com","key":"header","lastmodifiedtime":123456,"bgimage":"none"}]}],"startdate":1411424671167}}

POST /api/cms/updatePageDraft

Use this to create/update a page draft

Request Parameters

  • url: string

  • locale: string

  • template: string

  • pagetitle: string

  • metatext: string optional

  • topnav: boolean

    indicates whether the page contains a top navigation
  • dynamic: boolean

  • lastmodifiedname: string

  • lastmodifiedtime: long

  • droplets: list

Default Example

{"apikey":"API-KEY","request":{"url":"/fortest","pagetitle":"for test","topnav":true,"locale":"en_UK","lastmodifiedname":"frontend@skx.com","metatext":"this is for test","lastmodifiedtime":123456,"id":"pagedraft:en_uk:/fortest","status":"active","template":"templateA","rows":[{"rowtype":"full","slots":[{"bgcolor":"black","droplets":[{"dtype":"html","styles":[],"enddate":123459,"html":"hello","productlimit":0,"startdate":123456}],"lastmodifiedname":"frontend@skx.com","key":"header","lastmodifiedtime":123456,"bgimage":"none"}]}]}}

POST /api/cms/updateSlot

Use this to update a global slot

Request Parameters

  • id: string

  • key: string

  • refid: string optional

  • lastmodifiedname: string

  • lastmodifiedtime: long

  • droplets: list

Default Example

{"apikey":"API-KEY","request":{"bgcolor":"black","droplets":[{"dtype":"html","link":"http://www.skechers.com/en-us","title":"View All","enddate":123459,"html":"hello","productlimit":0,"startdate":123456}],"lastmodifiedname":"frontend@skx.com","key":"en_CA:testfooter","lastmodifiedtime":123456,"id":"slot:en_CA:testfooter","bgimage":"none"}}

POST /api/cms/updateKeywordGroup

Use this to create/update a keyword group

Request Parameters

  • id: string

  • locale: string

  • keywordtype: string

  • input: list[string]

  • output: list[string]

Default Example

{"apikey":"API-KEY","request":{"locale":"en_US","keywordtype":"search_redirects","input":["silver","grey","sparking"],"output":["silver"]}}

POST /api/cms/deleteContentDoc

Use this to delete a contentDocument

Request Parameters

  • locale: string

  • filename: string

Default Example

{"apikey":"API-KEY","request":{"locale":"en_US","filename":"yellowduck_cbabe62db51b.png"}}

POST /api/group/deleteGroup

Use this to delete a specific group

Request Parameters

  • locale: string

Default Example

{"apikey":"API-KEY","request":{"url":"/testCompany"}}

POST /api/cms/deleteSlot

Use this to delete a global slot

Request Parameters

  • locale: string optional

  • key: string

Default Example

{"apikey":"API-KEY","request":{"locale":"en_US","key":"en_US:footer"}}

POST /api/cms/deleteKeywordGroup

Use this to delete a KeywordGroup

Request Parameters

  • locale: string

  • id: string

Default Example

{"apikey":"API-KEY","request":{"locale":"en_US","id":"test_search_keywordgroup123"}}

POST /api/cms/deletePage

Use this to delete a page

Request Parameters

  • locale: string

  • url: string

Default Example

{"apikey":"API-KEY","request":{"locale":"en_US","url":"/info/help"}}

POST /api/cms/deletePageDraft

Use this to delete a page draft

Request Parameters

  • locale: string

  • url: string

Default Example

{"apikey":"API-KEY","request":{"locale":"en_US","url":"/info/help"}}

POST /api/cms/getRedirects

Use this to get all Redirects by a locale

Request Parameters

  • locale: string

Default Example

{"apikey":"API-KEY","request":{"locale":"en_US"}}

POST /api/cms/getThesaurus

Use this to get all Thesaurus by a locale

Request Parameters

  • locale: string

Default Example

{"apikey":"API-KEY","request":{"locale":"en_US"}}

POST /api/cms/getApostrophe

Use this to get a Apostrophe by locale

Request Parameters

  • locale: string

  • searchword: string

Default Example

{"apikey":"API-KEY","request":{"locale":"en_US","searchword":""}}

POST /api/cms/getCMSRevisions

Use this to get Revisions for page, pagedraft, slot, messages, emailContent

Request Parameters

  • id: string

Default Example

{"apikey":"API-KEY","request":{"id":"page:en_us:"}}

POST /api/cms/getEmailContent

Use this to get an EmailContent with a specific name

Request Parameters

  • locale: string

  • name: string

Default Example

{"apikey":"API-KEY","request":{"locale":"en_US","name":"orderConfirmation"}}

POST /api/cms/getEmailContents

Use this to get a list of EmailContents for a specific locale

Request Parameters

  • locale: string

Default Example

{"apikey":"API-KEY","request":{"locale":"en_US"}}

POST /api/group/getGroup

Use this to get a specific group with a specific locale

Request Parameters

  • locale: string

  • url: string

Default Example

{"apikey":"API-KEY","request":{"locale":"en_US_direct","url":"/testCompany"}}

POST /api/group/getGroupByGarpacId

Use this to get a specific group by garpac id

Request Parameters

  • locale: string

  • garpacId: string

Default Example

{"apikey":"API-KEY","request":{"locale":"en_US_direct","garpacId":"10469"}}

POST /api/group/getGroupByCode

Use this to get a specific group by group code

Request Parameters

  • locale: string

  • code: string

Default Example

{"apikey":"API-KEY","request":{"locale":"en_US_direct","code":"J8fImA"}}

POST /api/group/getGroups

Use this to get all the groups for a specific locale

Request Parameters

  • locale: string

Default Example

{"apikey":"API-KEY","request":{"locale":"en_US_direct"}}

POST /api/cms/getMessageComponent

Use this to get a MessageComponent with a specific name

Request Parameters

  • locale: string

  • name: string

Default Example

{"apikey":"API-KEY","request":{"locale":"en_US","name":"/style/default"}}

POST /api/cms/getMessageComponents

Use this to get a list of MessageComponents for a specific locale

Request Parameters

  • locale: string

Default Example

{"apikey":"API-KEY","request":{"locale":"en_US"}}

POST /api/cms/getPageDrafts

Use this to get a list of pages drafts belong to a specific locale

Request Parameters

  • locale: string

  • url: string optional

  • lastmodifiedname: string optional

Default Example

{"apikey":"API-KEY","request":{"locale":"en_US"}}

POST /api/cms/getPages

Use this to get a list of pages belong to a specific locale

Request Parameters

  • locale: string

  • url: string optional

  • lastmodifiedname: string optional

Default Example

{"apikey":"API-KEY","request":{"locale":"en_US"}}

POST /api/cms/getPagesByFileName

Use this to get a list of pages with specific locale and media file name

Request Parameters

  • locale: string

  • filename: string optional

Default Example

{"apikey":"API-KEY","request":{"locale":"en_US","filename":"delivery-man_1beef7999160.jpg"}}

POST /api/cms/getSiteMaintenanceSetting

Get Site maintenance Setting

Request Parameters

  • locale: string

  • admin: boolean

Default Example

{"apikey":"API-KEY","request":{"locale":"en_US","admin":"false"}}

POST /api/cms/getSiteMapForUpdate

Use this to get the sitemap

Request Parameters

  • locale: string

Default Example

{"apikey":"API-KEY","request":{"locale":"en_US"}}

POST /api/cms/getSlots

Use this to get a list of Slots

Request Parameters

  • locale: string optional

  • key: string optional

Default Example

{"apikey":"API-KEY","request":{"locale":"en_US","key":"en_US:footer"}}

POST /api/cms/getPageDraft

Use this to get a PageDraft using its locale and url

Request Parameters

  • locale: string

  • url: string

Default Example

{"apikey":"API-KEY","request":{"locale":"en_US","url":"/"}}

POST /api/cms/getRedirects

Use this to get a Redirect by a search keyword

Request Parameters

  • locale: string

  • searchword: string

Default Example

{"apikey":"API-KEY","request":{"locale":"en_US"}}

POST /api/cms/getSlot

Use this to get a Slot using its key

Request Parameters

  • locale: string

  • key: string

Default Example

{"apikey":"API-KEY","request":{"locale":"en_US","key":"en_US:footer"}}

POST /api/cms/getThesaurus

Use this to get a Thesaurus by a search keyword

Request Parameters

  • locale: string

  • searchword: string

Default Example

{"apikey":"API-KEY","request":{"locale":"en_US"}}

POST /api/cms/getStopwords

Use this to get a Stopwords by a search keyword

Request Parameters

  • locale: string

  • searchword: string

Default Example

{"apikey":"API-KEY","request":{"locale":"en_US","searchword":""}}

POST /api/cms/getContentDocs

retrieves a list of the contentDocuments by locale

Request Parameters

  • locale: string

    locale ID, such as en_us, en_uk, de_de
  • filename: string optional

    generic content document file name.

Default Example

{"apikey":"API-KEY","request":{"locale":"en_us"}}

POST /api/group/getEmployeeShippingAddress

Get shipping address using garpac id and employee id

Request Parameters

  • employeeid: string optional

  • garpacid: string

Default Example

{"apikey":"API-KEY","request":{"employeeid":"56789","garpacid":"123"}}

POST /api/cms/preview

Use this to write the Page object to the preview cache

Request Parameters

  • url: string

  • locale: string

  • pagetitle: string

  • metatext: string optional

  • topnav: boolean

    indicates whether the page contains a top navigation
  • lastmodifiedname: string

  • lastmodifiedtime: long

  • startdate: long

  • enddate: long

  • droplets: list

Default Example

{"apikey":"API-KEY","request":{"url":"/fortest","pagetitle":"for test","topnav":true,"locale":"en_UK","lastmodifiedname":"frontend@skx.com","metatext":"this is for test","lastmodifiedtime":123456,"status":"active","enddate":1411494671167,"rows":[{"rowtype":"full","slots":[{"key":"header","lastmodifiedname":"frontend@skx.com","lastmodifiedtime":123456,"droplets":[{"dtype":"html","enddate":123459,"html":"hello","productlimit":0,"startdate":123456}]}]}],"startdate":1411424671167}}

POST /api/cms/previewEmail

Use this to preview an EmailContent with a specific name

Request Parameters

  • name: string

  • emailTo: string

  • subject: string

  • html: string optional

  • text: string optional

Default Example

{"apikey":"API-KEY","request":{"name":"Order Confirmation","subject":"Order Confirmation","text":"Order id:{{orderid}}","previewDataNames":["CC"],"emailTo":"test@yahoo.com","from":"order@skechers.com","html":"Order id:{{orderid}}"}}

POST /api/cms/updateGlobalSlot

Reassign Global Slot

Request Parameters

  • pages: List[string] optional

  • drafts: List[string] optional

Default Example

{"apikey":"API-KEY","request":{"pages":["page:en_us:/jmc-test"],"key":"slot:en_US:AUH","newkey":"slot:en_US:Footer"}}

POST /api/cms/removeMessageFromAllLocales

Remove messages of MessageComponent with a specific name from specific locales, if you don't specify the locales(empty list), then the change will apply to all locales. if the name of the messageComponent is not specified, then the message(s) will be removed from all messageComponents.

Request Parameters

  • name: string optional

  • keys: List[String]

    keys of the messages
  • locs: List[String]

    locales

Default Example

{"apikey":"API-KEY","request":{"name":"/test","keys":["test1","test2"],"locs":["en_US"]}}

POST /api/cms/updateMessageComponent

update Message Component with a specific name

Request Parameters

  • locale: String

  • kvp: map

  • name: string

Default Example

{"apikey":"API-KEY","request":{"name":"/test","locale":"en_US","kvp":{"test1":"test1","test2":"test2"}}}

POST /api/cms/updateEmailContent

Use this to update an EmailContent

Request Parameters

  • id: string

  • locale: string

  • name: string

  • from: string

  • subject: string

  • html: string

  • text: string

  • previewdata: string

Default Example

{"apikey":"API-KEY","request":{"name":"checkout","subject":"order confirmation","description":"","text":"{{name}}, {{feature.description}}!","previewdata":"","locale":"en_US","id":"checkout","from":"order@skechers.com","html":"{{name}}, {{feature.description}}!"}}

POST /api/group/updateGroup

Update Group

Request Parameters

  • locale: string

  • admin: boolean

Default Example

{"apikey":"API-KEY","request":{"name":"test company","garpacid":"12345","url":"/testCompany","shippingmethods":{},"description":"description","locale":"en_US_direct","code":"adf93d","id":"group:en_us_direct:/testCompany","discountcode":"30%off","status":"active"}}

POST /api/cms/updateSiteMaintenanceSetting

Update Site maintenance Setting

Request Parameters

  • locale: string

  • maintenanceMsg: string

  • maintenanceUrl: string

  • start: string optional

  • end: string optional

Default Example

{"apikey":"API-KEY","request":{"maintenanceUrl":"http://localhost:9000","locale":"en_US","maintenanceMsg":"123","end":0,"start":0}}

POST /api/cms/updateSiteMaintenanceDoc

Update Site maintenance doc

Request Parameters

  • status: Int

    0 -> Not in Maintenance, 1 -> Site shows Maintenance Message, 2 -> Pages Gets Redirected to Maintenance Static Page, 3 -> Site is readonly
  • start: long

    Start time of site maintenance in milliseconds
  • end: long

    End time of site maintenance in milliseconds

Default Example

{"apikey":"API-KEY","request":{"status":0,"start":0,"end":0}}

POST /api/cms/updateSiteMap

Use this to update sitemap

Request Parameters

  • locale: string

  • values: list of string

Default Example

{"apikey":"API-KEY","request":{"values":["/help","/info/return"],"locale":"en_US"},"exampleResponse":{"result":{}}}

POST /api/cms/updateContentDoc

update a content document its attributes

Request Parameters

  • locale: string

    locale ID, such as en_us, en_uk, de_de
  • filename: string optional

    generic content document file name.
  • title: string optional

    content document title.
  • linkurl: string optional

    linkurl associated with the file.
  • linktype: string optional

    link type.
  • title: string optional

    content document title.
  • alttext: string optional

    alt text.
  • imagemap: string optional

    imagemap.
  • height: int optional

    image file height.
  • width: int optional

    image file width.
  • startdate: long

    start date in long integer format by js conversion.
  • enddate: long

    end date in long integer format by js conversion.

Default Example

{"apikey":"API-KEY","request":{"imagemap":"delivery man","linktype":"Info","alttext":"SKECHERS Delivery Man","height":160,"locale":"en_US","linkurl":"/info/slip-and-fall-warranty","filename":"delivery-man_2a5a8d49da2a.jpg","title":"SKECHERS Delivery Guy","enddate":2951917525475,"width":320,"startdate":1374044400000}}


Customers


POST /api/user/validateCustomer

Validate update parameters against SessionM.

Request Parameters

  • id: int

    Internal Skechers Web ID.
  • email: string optional

    Customer's email address.
  • phone: string optional

    Customer's phone number.
  • crmID: string optional

    Customer's LOYL / Subscriber Key / CRM ID.

Response Parameters

  • sessionmid: string

    Internal SessionM GUID.
  • email: string

    Customer's email address.
  • phone: string

    Customer's phone number.
  • crmID: string

    Customer's LOYL / Subscriber Key / CRM ID.

Default Example

{"apikey":"API-KEY","request":{"id":990093,"email":"EDDIEF@SKECHERS2.COM","phone":"5555553133","crmID":"9200000061"}}

POST /api/customer/addBillingAddress

Add a billing address to the customer. On error, returns an error code. On success, returns a Customer object.

Request Parameters

  • email: string

    Customer's email address, nonEmptyText.
  • billing.firstname: string

    Customer's first name, nonEmptyText( maxLength = 255).
  • billing.lastname: string

    Customer's last name, nonEmptyText( maxLength = 255).
  • billing.address1: string

    Customer's billing address 1, nonEmptyText( maxLength = 255).
  • billing.address2: string optional

    Customer's billing address 2, if passed in then nonEmptyText( maxLength = 255).
  • billing.city: string

    Customer's billing address city, nonEmptyText( maxLength = 50).
  • billing.state: string

    Customer's billing address state in ISO Alpha-2 format, maxLength = 10, default = "".
  • billing.zip: string

    Customer's billing address zip code, maxLength = 25, default = "".
  • billing.country: string

    Customer's billing address country in ISO Alpha-3 format, maxLength = 50.
  • billing.phone: string

    Customer's billing address phone number, nonEmptyText(maxLength = 255).
  • billing.default: boolean

    Is default billing? True to set to yes, false otherwise.

Response Parameters

  • Customer: object

    Refers to a Customer object for which the model can be found in the Models section of this document under Models -> Customer.

Default Example

{"apikey":"API-KEY","request":{"email":"skx_tester@skechers.com","billing":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"Test","country":"USA","address2":"Second Address","lastname":"Tester","address1":"225 S Sepulveda Blvd","default":true,"phone":"8007463411"}}}

POST /api/customer/removeBillingAddress

Delete a billing address of a customer. On error, returns an error code. On success, returns a Customer object.

Request Parameters

  • id: int

    Billing address ID, numeric only, no dashes.
  • email: string

    Customer's email address, nonEmptyText.

Response Parameters

  • Customer: object

    Refers to a Customer object for which the model can be found in the Models section of this document under Models -> Customer.

Default Example

{"apikey":"API-KEY","request":{"email":"skx_tester@skechers.com","id":1132306}}

POST /api/customer/updateBillingAddress

Update a billing address of a customer. On error, returns an error code. On success, returns a Customer object.

Request Parameters

  • email: string

    Customer's email, nonEmptyText
  • id: int

    Billing address id, numeric only, no dashes.
  • billing.firstname: string

    Customer's first name, nonEmptyText( maxLength = 255).
  • billing.lastname: string

    Customer's last name, nonEmptyText( maxLength = 255).
  • billing.address1: string

    Customer's billing address 1, nonEmptyText(maxLength = 255).
  • billing.address2: string optional

    Customer's billing address 2, if passed in then nonEmptyText(maxLength = 255).
  • billing.city: string

    Customer's billing address city, nonEmptyText( maxLength = 50).
  • billing.state: string

    Customer's billing address state in ISO Alpha-2 format, maxLength = 10, default = "".
  • billing.zip: string

    Customer's billing address zip code, maxLength = 25, default = "".
  • billing.country: string

    Customer's billing address country in ISO Alpha-3 format, maxLength = 50.
  • billing.phone: string

    Customer's billing address phone number, nonEmptyText(maxLength = 255).
  • billing.default: boolean

    Is default billing? True to set to yes, false otherwise.

Response Parameters

  • Customer: object

    Refers to a Customer object for which the model can be found in the Models section of this document under Models -> Customer.

Default Example

{"apikey":"API-KEY","request":{"email":"skx_tester@skechers.com","id":1132306,"billing":{"city":"City Update","zip":"90266","state":"CA","firstname":"Test Update","country":"USA","address2":"My Second Address Update","lastname":"Tester Update","address1":"My First Address Update","default":false,"phone":"9991237654"}}}

POST /api/v2/customer/authenticate

Authenticate customer. On error, returns an error code. On success, returns a Customer object.

Request Parameters

  • username: string

    Customer's username. Must be email or phone, nonEmptyText
  • password: string

    Customer's password, nonEmptyText(minLength = 6).

Response Parameters

  • Customer: object

    Refers to a Customer object for which the model can be found in the Models section of this document under Models -> Customer.

Default Example

{"apikey":"API-KEY","request":{"username":"skx_tester@skechers.com","password":"test123456"}}

POST /api/customer/createAccount

Create a customer account. On error, returns an error code. On success, returns a Customer object.

Request Parameters

  • firstname: string

    Customer's first name, nonEmptyText(maxLength = 255).
  • lastname: string

    Customer's last name. nonEmptyText(maxLength = 255).
  • email: string

    Customer's email address. Email format, nonEmptyText(maxLength = 255).
  • phone: string optional

    Customer's phone number, if passed in then nonEmptyText.
  • password: string

    Customer's password. Plain text password, nonEmptyText(minLength = 8, maxLength = 255).
  • confirmpwd: string

    Customer's password to match entered password. Plain text password, default = "".
  • optin: boolean

    Boolean. If true, opt-in to receiving marketing emails.

Response Parameters

  • Customer: object

    Refers to a Customer object for which the model can be found in the Models section of this document under Models -> Customer.

Default Example

{"apikey":"API-KEY","request":{"email":"john.smith@skx.com","firstname":"John","lastname":"Smith","optin":false,"confirmpwd":"mysecret99","phone":"8881238765","password":"mysecret99"}}

POST /api/customer/forgotPassword

If customer forgets their password, it will generate a new temporary 72-hour long password and email it to them. On error, returns an error code. On success, returns a Customer object.

Request Parameters

  • email: string

    Customer's email address, nonEmptyText.

Response Parameters

  • Customer: object

    Refers to a Customer object for which the model can be found in the Models section of this document under Models -> Customer.

Default Example

{"apikey":"API-KEY","request":{"email":"skx_tester@skechers.com"}}

POST /api/customer/resetPasswordWithToken

Update customer's password with Token. On error, returns an error code. On success, returns a Customer object.

Request Parameters

  • token: string

    Token for resetting password, nonEmptyText.
  • password: string

    new password for customer, nonEmptyText(minLength = 8, maxLength = 255).

Response Parameters

  • Customer: object

    Refers to a Customer object for which the model can be found in the Models section of this document under Models -> Customer.

Default Example

{"apikey":"API-KEY","request":{"token":"2b10c977-25cd-4730-b4c7-a75e62bf8b9f","password":"test12345"}}

POST /api/customer/update

Update a customer's profile information. On error, returns an error code. On success, returns a Customer object.

Request Parameters

  • id: int

    Customer's ID, numeric only, no dashes.
  • firstname: string

    Customer's first name, nonEmptyText(maxLength = 255).
  • lastname: string

    Customer's last name, nonEmptyText(maxLength = 255).
  • email: string

    Customer's email address. Email format, nonEmptyText(maxLength = 255).
  • phone: string optional

    Customer's phone number, if passed in then nonEmptyText(maxLength=25).
  • gender: string

    Customer's gender, one char. Set 'M' to set to male, 'F' to set to female, or 'U' to set to unspecified. Default = "U"
  • birthday: int optional

    Customer's birth day(range of 1-31 inclusive).
  • birthmonth: int optional

    Customer's birth month(range of 1-12 inclusive).
  • birthyear: int optional

    Customer's birth year(range of 1901-2099 inclusive).

Response Parameters

  • Customer: object

    Refers to a Customer object for which the model can be found in the Models section of this document under Models -> Customer.

Default Example

{"apikey":"API-KEY","request":{"birthday":13,"email":"skx_tester@skechers.com","firstname":"Charles","lastname":"Smith","id":63370603,"birthmonth":11,"birthyear":1990,"gender":"M"}}

POST /api/customer/update/password

Update customer's password. On error, returns an error code. On success, returns a Customer object.

Request Parameters

  • userid: int

    Customer's ID, numeric only, no dashes.
  • currentPassword: string

    Customer's current password.
  • newPassword: string

    Customer's desired new password, nonEmptyText(minLength = 8).

Response Parameters

  • Customer: object

    Refers to a Customer object for which the model can be found in the Models section of this document under Models -> Customer.

Default Example

{"apikey":"API-KEY","request":{"userid":63370603,"currentPassword":"test12345","newPassword":"test123456"}}

POST /api/customer/ordersummaries

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, numeric only, no dashes.
  • limit: int

    Limit of the number of orders to retrieve, default = 100.

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.
  • status: list

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

    Billing first name related to the order. Example: John.
  • billtolastname: string

    Billing last name related to the order. Example: Smith.
  • billtophone: int

    Billing phone number related to the order. Example: 9991239876.
  • userid: int

    Customer's ID, numeric only, no dashes. Example: 6337060.
  • orderid: int

    Order ID, numeric only, no dashes. Example: 497436.
  • gcid: int

    Gift card ID, numeric only, no dashes. Example: -1.
  • 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
  • type: string

    Type of order. Example: Online.
  • points: int

    Number of points credited to an order. Example: 1000.
  • discountcode: string

    Discount code applied to an order. Example: $10_OFF.
  • isrewardorder: boolean

    True if the order is a reward order, false otherwise.

Default Example

{"apikey":"API-KEY","request":{"userid":63370603,"limit":50}}

POST /api/customer/addShippingAddress

Add a shipping address to customer. On error, returns an error code. On success, returns a Customer object.

Request Parameters

  • email: string

    Customer's email address, nonEmptyText.
  • shipping.firstname: string

    Customer's first name, nonEmptyText( maxLength = 255).
  • shipping.lastname: string

    Customer's last name, nonEmptyText( maxLength = 255).
  • shipping.address1: string

    Customer's shipping address 1, nonEmptyText( maxLength = 255).
  • shipping.address2: string optional

    Customer's shipping address 2, if passed in then nonEmptyText( maxLength = 255).
  • shipping.city: string

    Customer's shipping address city, nonEmptyText( maxLength = 50).
  • shipping.state: string

    Customer's shipping address state in ISO Alpha-2 format, maxLength = 10, default = "".
  • shipping.zip: string

    Customer's shipping address zip code, maxLength = 25, default = "".
  • shipping.country: string

    Customer's shipping address country in ISO Alpha-3 format, maxLength = 50.
  • shipping.phone: string

    Customer's shipping address phone number, nonEmptyText(maxLength = 255).
  • shipping.default: boolean

    Is default shipping? True to set to yes, false otherwise.

Response Parameters

  • Customer: object

    Refers to a Customer object for which the model can be found in the Models section of this document under Models -> Customer.

Default Example

{"apikey":"API-KEY","request":{"email":"skx_tester@skechers.com","shipping":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"Test","country":"USA","address2":"Second Address","lastname":"Tester","address1":"225 S Sepulveda Blvd","default":true,"phone":"8007463411"}}}

POST /api/customer/removeShippingAddress

Delete shipping address of customer. On error, returns an error code. On success, returns a Customer object.

Request Parameters

  • id: int

    Shipping address ID, numeric only, no dashes.
  • email: string

    Customer's email address, nonEmptyText.

Response Parameters

  • Customer: object

    Refers to a Customer object for which the model can be found in the Models section of this document under Models -> Customer.

Default Example

{"apikey":"API-KEY","request":{"email":"skx_tester@skechers.com","id":1124497}}

POST /api/customer/updateShippingAddress

Update a shipping address of customer. On error, returns an error code. On success, returns a Customer object.

Request Parameters

  • email: string

    Customer's email address, nonEmptyText.
  • id: int

    Shipping address ID, numeric only, no dashes.
  • shipping.firstname: string

    Customer's first name, nonEmptyText( maxLength = 255).
  • shipping.lastname: string

    Customer's last name, nonEmptyText( maxLength = 255).
  • shipping.address1: string

    Customer's shipping address 1, nonEmptyText( maxLength = 255).
  • shipping.address2: string optional

    Customer's shipping address 2, if passed in then nonEmptyText( maxLength = 255).
  • shipping.city: string

    Customer's shipping address city, nonEmptyText( maxLength = 50).
  • shipping.state: string

    Customer's shipping address state in ISO Alpha-2 format, maxLength = 10, default = "".
  • shipping.zip: string

    Customer's shipping address zip code, maxLength = 25, default = "".
  • shipping.country: string

    Customer's shipping address country in ISO Alpha-3 format, maxLength = 50.
  • shipping.phone: string

    Customer's shipping address phone number, nonEmptyText(maxLength = 255).
  • shipping.default: boolean

    Is default shipping? True to set to yes, false otherwise.

Response Parameters

  • Customer: object

    Refers to a Customer object for which the model can be found in the Models section of this document under Models -> Customer.

Default Example

{"apikey":"API-KEY","request":{"email":"skx_tester@skechers.com","id":1124491,"shipping":{"city":"Manhattan Beach","zip":"90266","state":"CA","firstname":"Test","country":"USA","address2":"Second Shipping Address","lastname":"Tester","address1":"First Shipping Address","default":false,"phone":"8007463411"}}}

POST /api/ups/getReturnShippingLabel

Get shipping label for the customer to return shoes. On error, returns an error code. On success, returns an OrderLog object.

Request Parameters

  • itemid: int

    Order item ID, numeric only, no dashes.
  • userid: int

    Customer's ID, numeric only, no dashes.
  • labelinfo: boolean optional

    Flag to use UPS default shipping label. Default = true.

Default Example

{"apikey":"API-KEY","request":{"itemid":10155664,"userid":63370603,"labelinfo":true}}

POST /api/v3/subscriberkey

Retrieve subscriber key by email.

Request Parameters

  • email: email

    Customer's email address.

Response Parameters

  • subscriberkey: string

    Subscriber key, the unique ID for salesforce and loyalty systems within Skechers.

Default Example

{"apikey":"API-KEY","request":{"email":"skx_tester@skechers.com"}}

POST /api/customer/saveShoeAlert

Create an email alert for a particular UPC / shoe for when it comes back in stock again. On error, returns an error code. On success, returns information about the shoe alert that was initiated.

Request Parameters

  • email: email

    Customer's email address.
  • sku: string

    Sku / UPC code for item, nonEmptyText, string that is numeric only, no dashes.
  • optin: boolean

    Flag for opting in promotional emails.

Response Parameters

  • email: string

    Customer's email address. Example: skx_tester@skechers.com
  • entryTimestamp: long

    When the process of being alerted was initiated by the customer, expressed as a Unix timestamp in milliseconds. Example: Example: 12/31/2025 is represented as 1767139200000.
  • locale: string

    Locale where the process of being alerted was initiated 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.
  • id: int

    Customer alert email ID, numeric only, no dashes. Example: 19558.
  • notifiedTimestamp: long

    When the customer was notified that the item was back in stock, expressed as a Unix timestamp in milliseconds. Example: 12/31/2025 is represented as 1767139200000.
  • notified: boolean

    True if the customer was notified when the item was back in stock, false otherwise.
  • alertType: string

    Alert type. Example: notify for notify type.
  • skuNumber: string

    Sku / UPC code for item, string that is numeric only, no dashes. Example: 192283965500.

Default Example

{"apikey":"API-KEY","request":{"email":"skx_tester@skechers.com","sku":"192283965500","optin":true}}

POST /api/customer/addCard

Add a credit card to a customer. On error, returns an error code. On success, returns a CreditCard object.

Request Parameters

  • userid: int

    Customer's ID, numeric only, no dashes.
  • cardtype: string

    Card type returned from payment processor, e.g., Visa, American Express, Discover, MasterCard, Visa, JCB, nonEmptyText.
  • token: string

    Credit card token returned from Element, nonEmptyText.
  • accountnumber: string

    Last 4 digits of the Credit Card, nonEmptyText(minLength = 4, maxLength = 4).
  • expirationmonth: int

    Expiration month (range of 1 to 12 inclusive).
  • expirationyear: int

    Expiration year (range of 1970 to 2050 inclusive).

Response Parameters

  • CreditCard: object

    Refers to a CreditCard object for which the model can be found in the Models section of this document under Models -> CreditCard.

Default Example

{"apikey":"API-KEY","request":{"expirationyear":2025,"userid":15,"accountnumber":"1111","token":"H4959F8A-240E-4457-8CFC-F43CA52EFDD1","expirationmonth":1,"cardtype":"Visa"}}

POST /api/customer/deleteCard

Delete a credit card from customer. On error, returns an error code. On success, returns a Customer object.

Request Parameters

  • userid: int

    Customer's ID, numeric only, no dashes.
  • cardid: int

    Credit card ID, numeric only, no dashes.

Response Parameters

  • Customer: object

    Refers to a Customer object for which the model can be found in the Models section of this document under Models -> Customer.

Default Example

{"apikey":"API-KEY","request":{"userid":63370603,"cardid":504820}}

POST /api/customer/defaultCreditCard

Set default credit card of customer. On error, returns an error code. On success, returns a Customer object.

Request Parameters

  • userid: int

    Customer's ID, numeric only, no dashes.
  • cardid: int

    Credit card ID, numeric only, no dashes.

Response Parameters

  • Customer: object

    Refers to a Customer object for which the model can be found in the Models section of this document under Models -> Customer.

Default Example

{"apikey":"API-KEY","request":{"userid":63370603,"cardid":504820}}

POST /api/customer/getWishBag

Get customer's wishlist. On error, returns an error code. On success, returns a list of bagitems associated with the customer and the relevant information for each item such as name, gender, division, colorcode, etc. (see response parameters).

Request Parameters

  • userid: int

    Customer's ID, numeric only, no dashes.

Response Parameters

  • locale: string

    Locale associated with the customer. Locale associated with 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.
  • stylecode: string

    Product style code. Example: 52675.
  • name: string

    Product name. Example: D'Lites.
  • gender: string

    Gender associated with the product. M for male, F for female, and U for unspecified.
  • division: string

    Product division code. Example: TC for Men's Sport Casual.
  • colorcode: string

    Product color code. Example: BKW for black/white.
  • color: string

    Product color. Example: BLACK.
  • colordesc: string

    Product color description. Example: BLACK/WHITE.
  • images: string

    Product's file name and extension. Example: 52675_BKW.jpg.
  • upc: string

    Product's UPC code, string that is numeric only, no dashes. Example: 888222488215.
  • size: string

    Product size. Example: 9.5.
  • width: string

    Product width. Example: W for wide.
  • instock: boolean

    If the product is in stock, true, otherwise false.
  • price: float

    Product price. Example: 100.00.
  • discountprice: float

    Product discounted price. Example: 75.00.
  • isShoes: boolean

    If the product is a shoe, true, otherwise false.

Default Example

{"apikey":"API-KEY","request":{"userid":63370603}}

POST /api/customer/addWishlistItem

Add item to customer's wishlist. On error, returns an error code. On success, returns a wishlist of items with the item added.

Request Parameters

  • userid: int

    Customer's ID, numeric only, no dashes.
  • upc: string

    Item's UPC code, string that is numeric only, no dashes.

Response Parameters

  • id: int

    Customer wishlist items wishlist ID, numeric only, no dashes.
  • wishlistItems: list

    List of wish list objects. Refers to a WishlistItem object for which the model can be found in the Models section of this document under Models -> WishlistItem.

Default Example

{"apikey":"API-KEY","request":{"userid":63370603,"upc":"192283965500"}}

POST /api/customer/removeWishlistItem

Remove item from customer's wishlist. On error, returns an error code. On success, returns a wishlist of items with the item removed.

Request Parameters

  • userid: int

    Customer's ID, numeric only, no dashes.
  • upc: string

    Item's UPC code, string that is numeric only, no dashes.

Response Parameters

  • id: int

    Customer wishlist items wishlist ID, numeric only, no dashes.
  • wishlistItems: list

    List of wish list objects. Refers to a WishlistItem object for which the model can be found in the Models section of this document under Models -> WishlistItem.

Default Example

{"apikey":"API-KEY","request":{"userid":63370603,"upc":"192283965500"}}


Discount Service


POST /api/discount/applyDiscount

On error, returns an error code. On success, applies a discount to an order and returns the discount amount. It also returns the list of items for which the discount is applicable to as well as the list of excluded items for which the discount is not applicable to. The discount amount is divided evenly among each of the applicable items.

Request Parameters

  • discountcode: string

    Discount code, nonEmptyText(maxLength = 50).
  • lineitems.upccode: string

    Item's UPC Code, nonEmptyText, string that is numeric only, no dashes.
  • lineitems.quantity: int

    Item Quantity.

Response Parameters

  • amount: float

    Amount taken off the subtotal as a result of applying the discount.
  • applicableItems: list

    Items that the discount is applicable to. Refers to a list of objects for which the fields are listed below this entry.
  • upc: string

    Item's UPC code, string that is numeric only, no dashes. Example: 888222488215.
  • productname: string

    Name of the product. Example: D'Lites.
  • code: string

    Discount code applied to the order. Example: $10_OFF.
  • discountType: string

    Type of discount. Example: O for order type discount.

Default Example

{"apikey":"API-KEY","request":{"discountcode":"$10_OFF","lineitems":[{"upccode":"193113109125","quantity":1},{"upccode":"884292343003","quantity":1}]}}

POST /api/discount/batchCreate

Batch create discounts. On error, returns an error code. On success, sends csv file to provided email address and returns a confirmation message stating that an email has been sent to the email address provided.

Request Parameters

  • refid: string

    Reference Id to avoid duplicates. Non-empty text, minLength = 5.
  • email: string

    Email address to send the codes to. Non-empty text.
  • suffixlength: int

    Discount code suffix length. MaxLength = 50.
  • numofdiscounts: int

    Number of discounts to generate. Max limit of 500,000.
  • prefix: string

    Discount prefix, nonEmptyText( maxLength = 10).
  • excludes: string

    List of chars to exclude from generated codes.
  • alphanumeric: boolean

    True if alphanumeric code, else it will be entirely numeric.
  • freeshipping: boolean optional

    Free standard shipping. Default value=false
  • usesPerCustomer: int optional

    Number of times a customer can use the discount.
  • maxusage: int optional

    Max number of times the discount can be used.
  • minItemAmount: float optional

    Min item amount.
  • maxItemAmount: float optional

    Max item amount.
  • minOrderAmount: float optional

    Min order amount.
  • maxOrderAmount: float optional

    Max order amount.
  • minqty: int optional

    Min quantity.
  • maxqty: int optional

    Max quantity.
  • mustbuyall: boolean optional

    If all specified stylecodes / catids are required for discount to be applicable. Default value=false
  • includeDiscountItems: boolean optional

    If the discount is applicable to discounted items. Default value=false
  • genders: list optional

    Genders the discount applies to. List of strings.
  • stylecodes: list optional

    Stylecodes the discount applies to. List of strings.
  • excludedstyles: list optional

    Stylecodes the discount doesn't apply to. List of strings.
  • catids: list optional

    Category IDs the discount applies to. List of strings.
  • excludedcatids: list optional

    Category IDs the discount doesn't apply to. List of strings.
  • divisions: list optional

    Divisions the discount applies to. List of strings.
  • excludeddivisions: list optional

    Divisions the discount doesn't apply to. List of strings.
  • code: string

    Discount code, nonEmptyText(maxLength= 50).
  • amount: float

    Discount amount.
  • description: string

    Discount description.
  • notes: string optional

    Discount notes.
  • amounttype: string

    Whether the discount is percentage-based or fixed, nonEmptyText. Char. Either P for Percent, or F for Fixed.
  • discounttype: string

    Whether the discount is an item, order, or PWP discount, nonEmptyText. Char. I for Item Discount, O for Order Discount, P for PWP Discount.
  • begindate: long

    Begin date discount should go into effect, expressed as a Unix timestamp in milliseconds.
  • enddate: long

    End date discount should end, expressed as a Unix timestamp in milliseconds.
  • garpacid: string optional

    Garpac ID if this is a B2B discount.
  • pwpConditions: object optional

    Another set of conditions.

Default Example

{"apikey":"API-KEY","request":{"refid":"L39F5","email":"skxtest@skechers.com","suffixlength":10,"numofdiscounts":10,"prefix":"SKX","excludes":["!","#"],"alphanumeric":true,"discount":{"conditions":{"excludedcatids":[],"maxqty":5,"excludeddivisions":[],"excludedstyles":[],"catids":[],"maxOrderAmount":250,"mustbuyall":false,"includeDiscountItems":false,"freeshipping":true,"maxusage":40,"stylecodes":["193113109125"],"minOrderAmount":100,"divisions":[],"genders":["M"],"maxItemAmount":110.5,"minqty":1,"minItemAmount":5.5},"description":"Another description","amount":"40.00","begindate":1403549175000,"code":"$10_OFF","discounttype":"O","notes":"Notes","enddate":1435085175000,"amounttype":"P"}}}

POST /api/discount/createDiscount

Add a discount. Automatically set to inactive, requires approval first. On error, returns an error code. On success, returns a Discount object.

Request Parameters

  • code: string

    Discount code, nonEmptyText(maxLength= 50).
  • amount: float

    Discount amount.
  • description: string

    Discount description.
  • notes: string optional

    Discount notes.
  • amounttype: string

    Whether the discount is percentage-based or fixed, nonEmptyText. Char. Either P for Percent, or F for Fixed.
  • discounttype: string

    Whether the discount is an item, order, or PWP discount, nonEmptyText. Char. I for Item Discount, O for Order Discount, P for PWP Discount.
  • begindate: long

    Begin date discount should go into effect, expressed as a Unix timestamp in milliseconds.
  • enddate: long

    End date discount should end, expressed as a Unix timestamp in milliseconds.
  • garpacid: string optional

    Garpac ID if this is a B2B discount.
  • freeshipping: boolean optional

    Free standard shipping. Default value=false
  • usesPerCustomer: int optional

    Number of times a customer can use the discount.
  • maxusage: int optional

    Max number of times the discount can be used.
  • minItemAmount: float optional

    Min item amount.
  • maxItemAmount: float optional

    Max item amount.
  • minOrderAmount: float optional

    Min order amount.
  • maxOrderAmount: float optional

    Max order amount.
  • minqty: int optional

    Min quantity.
  • maxqty: int optional

    Max quantity.
  • mustbuyall: boolean optional

    If all specified stylecodes / catids are required for discount to be applicable. Default value=false
  • includeDiscountItems: boolean optional

    If the discount is applicable to discounted items. Default value=false
  • genders: list optional

    Genders the discount applies to. List of strings.
  • stylecodes: list optional

    Stylecodes the discount applies to. List of strings.
  • excludedstyles: list optional

    Stylecodes the discount doesn't apply to. List of strings.
  • catids: list optional

    Category IDs the discount applies to. List of strings.
  • excludedcatids: list optional

    Category IDs the discount doesn't apply to. List of strings.
  • divisions: list optional

    Divisions the discount applies to. List of strings.
  • excludeddivisions: string optional

    Divisions the discount doesn't apply to. List of strings.
  • giveAwayConditions: object optional

    Another set of conditions.

Response Parameters

  • Discount: object

    Refers to a Discount object for which the model can be found in the Models section of this document under Models -> Discount.

Default Example

{"apikey":"API-KEY","request":{"conditions":{"excludedcatids":[],"maxqty":2,"excludeddivisions":[],"excludedstyles":["52619"],"catids":[],"maxOrderAmount":500,"mustbuyall":false,"includeDiscountItems":false,"freeshipping":false,"maxusage":1,"stylecodes":["53927"],"minOrderAmount":15,"divisions":[],"genders":["M"],"maxItemAmount":200,"minqty":1,"usesPerCustomer":1,"minItemAmount":10},"garpacid":"88888","description":"Another description","amount":30,"begindate":1403549175000,"code":"$30_OFF","discounttype":"O","pwpConditions":{"stylecodes":["68135"]},"notes":"Notes","enddate":1435085175000,"amounttype":"P"}}

POST /api/discount/getDiscountByCode

Get discount by code and locale. On error, returns an error code. On success, returns a Discount object.

Request Parameters

  • code: string

    Discount code, case insensitive. Non-empty text.

Response Parameters

  • Discount: object

    Refers to a Discount object for which the model can be found in the Models section of this document under Models -> Discount.

Default Example

{"apikey":"API-KEY","request":{"code":"QHUANG6TSO"}}

POST /api/discount/getDiscountsByStatus

Get all discounts associated with a status. 'A' for Active, 'P' for Pending, 'D' for disabled. On error, returns an error code. On success, returns a list of Discount objects that meet the status criteria.

Request Parameters

  • status: string

    Discount status, nonEmptyText. A for Active, P for Pending, D for Disabled.

Response Parameters

  • Discount: object

    Refers to a Discount object for which the model can be found in the Models section of this document under Models -> Discount.

Default Example

{"apikey":"API-KEY","request":{"status":["P"]}}

POST /api/discount/incrementUsage

Increment usage of a discount. On error, returns an error code. On success, increments the usage of the discount provided and returns a success confirmation message.

Request Parameters

  • code: string

    Discount code, nonEmptyText.

Default Example

{"apikey":"API-KEY","request":{"code":"$10_OFF"}}

POST /api/discount/resendBatchEmail

Send email with csv of generated codes from previous batch creation. On error, returns an error code. On success, resends csv file containing the batch of discounts associated with prefix and refid provided to the email address provided. Also returns a confirmation message stating that an email has been sent to the email address provided.

Request Parameters

  • prefix: string

    Discount prefix, nonEmptyText.
  • email: string

    Email address to send the codes to. Non-empty text.
  • refid: string

    Reference Id to avoid duplicates. Non-empty text.

Default Example

{"apikey":"API-KEY","request":{"email":"skxtest@skechers.com","prefix":"SKX","refid":"L39F5"}}

POST /api/discount/searchByField

Search discounts by code, begin date, end date, or description. All optional fields. Does not include batch discounts. Limit 1000. On error, returns an error code. On success, returns a list of Discount objects that meet the search criteria.

Request Parameters

  • code: string optional

    Discount code.
  • begindate: long optional

    Beginning of date range to search, expressed as a Unix timestamp in milliseconds.
  • enddate: long optional

    End of date range to search, expressed as a Unix timestamp in milliseconds.
  • description: string optional

    Discount description.

Response Parameters

  • Discount: object

    Refers to a Discount object for which the model can be found in the Models section of this document under Models -> Discount.

Default Example

{"apikey":"API-KEY","request":{"code":"$10_OFF","begindate":1388534400000,"enddate":1580284800000,"description":"Get $10 off your total order"}}

POST /api/discount/updateDiscount

Update a discount. Automatically set to inactive, requires approval first. On error, returns an error code. On success, returns the updated Discount object.

Request Parameters

  • amount: string

    Must be a string that contains a float.
  • description: string

  • notes: string optional

  • begindate: int

    Begin date discount should go into effect, in milliseconds.
  • enddate: int

    End date discount should end, in milliseconds.
  • freeshipping: boolean

    Free standard shipping.
  • garpacid: string optional

    Garpac ID if this is a B2B discount.
  • maxusage: string optional

  • minItemAmount: int optional

    Min item amount. Float.
  • maxItemAmount: int optional

    Max item amount. Float.
  • minOrderAmount: int optional

    Min order amount. Float.
  • maxOrderAmount: int optional

    Max order amount. Float.
  • minqty: int optional

    Min quantity.
  • maxqty: int optional

    Max quantity.
  • mustbuyall: boolean optional

    If all specified stylecodes / catids are required for discount to be applicable.
  • genders: list optional

    Genders discount applies to. List of strings.
  • stylecodes: list optional

    Excluded stylecodes discount applies to. List of strings.
  • excludedstyles: list optional

    Stylecodes discount doesn't apply to. List of strings.
  • catids: list optional

    Category IDs that discount applies to. List of strings.
  • excludedcatids: list optional

    Category IDs that discount doesn't apply to. List of strings.
  • pwpConditions: object optional

    Another set of conditions.

Response Parameters

  • Discount: object

    Refers to a Discount object for which the model can be found in the Models section of this document under Models -> Discount.

Default Example

{"apikey":"API-KEY","request":{"discount":{"conditions":{"stylecodes":["53927"]},"giveAwayConditions":{"stylecodes":["68135"]},"description":"Another description","amount":"100.00","begindate":1403549175000,"code":"GIVEAWAY10","discounttype":"O","notes":"Notes","enddate":1435085175000,"amounttype":"P"}}}

POST /api/discount/updateStatus

Approve, disable, activate a discount. On error, returns an error code. On success, updates the status of the provided discount and returns a success confirmation message.

Request Parameters

  • code: string

    Discount code, nonEmptyText.
  • status: string

    Discount status will be updated to the value provided in this field, nonEmptyText. Set 'A' to set to active, 'P' for pending, 'D' for disabled.
  • author: string

    Email address of the discount author, nonEmptyText.

Default Example

{"apikey":"API-KEY","request":{"code":"$10_OFF","status":"A","author":"skxtest@skechers.com"}}


Order Fulfillment


POST /api/store/reports/finance/completed

Order Details by a ship_date time range with RTNC and SHIP status, completed end of lifecycle.

Default Example

{"apikey":"API-KEY","request":{"begintime":1400789406000,"endtime":1432325406000}}

POST /api/store/reports/finance/returns

Finance report for RTNC orders by return_date time range with RTNC status

Default Example

{"apikey":"API-KEY","request":{"begintime":1400789406000,"endtime":1432325406000}}

POST /api/store/order/payment

Get Order Payment(s) for an Order

Default Example

{"apikey":"API-KEY","request":{"orderid":317941}}

POST /api/store/orders/paymentsbydates

Get Order Payment(s) for a date range

Default Example

{"apikey":"API-KEY","request":{"startOrderTimestamp":1555781589000,"endOrderTimestamp":1556581589000}}

POST /api/store/order/orderItemsByID

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

Default Example

{"apikey":"API-KEY","request":{"orderid":538608}}

POST /api/store/order/orderItemsByTimestamp

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

Default Example

{"apikey":"API-KEY","request":{"startOrderTimestamp":1550102400000,"endOrderTimestamp":1557878400000}}

POST /api/store/orders/sale

Garpac do order sale

Default Example

{"apikey":"API-KEY","request":{"orderid":317941,"orderitemids":[7343757,7343760,7343763]}}

POST /api/store/orders/usercancelled

Retrieve user cancelled (CNCQ) orders. Only will query last 45 days if timestamp not specified.

Default Example

{"apikey":"API-KEY"}

POST /api/store/orders/current

Retrieve current (RETRY/OPEN/PICK/PKMS/CHRGD) orders. Only will query last 45 days if timestamp not specified.

Default Example

{"apikey":"API-KEY"}

POST /api/store/warehouseOrders

Retrieve an orders by date range on either order timestamp or update timestamp

Request Parameters

  • startOrderTimestamp: long optional

    Pass in start order timestamp, numeric value.
  • endOrderTimestamp: long optional

    Pass in end order timestamp, numeric value.
  • startUpdateTimestamp: long optional

    Pass in start update timestamp, numeric value.
  • endUpdateTimestamp: long optional

    Pass in end update timestamp, numeric value.
  • storenum: string

    Pass in store id, numeric value.

Default Example

{"apikey":"API-KEY","request":{"startOrderTimestamp":1516493311000,"endOrderTimestamp":1518998911000,"storenum":"600"}}

POST /api/store/orders/failed

Retrieve new (FAILED) orders. Only will query last 45 days if timestamp not specified.

Default Example

{"apikey":"API-KEY"}

POST /api/store/orders/new

Retrieve new (NEW) orders. Only will query last 45 days if timestamp not specified.

Default Example

{"apikey":"API-KEY"}

POST /api/store/order

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.

Default Example

{"apikey":"API-KEY","request":{"orderid":526522}}

POST /api/store/orders/return

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 optional

    End date in Long.
  • paymenttypes: List optional

    Payment type.

Default Example

{"apikey":"API-KEY","request":{"returndate":1701131374000,"enddate":1701217774000,"paymenttypes":["PAYROLL","CREDIT"]}}

POST /api/store/orders/payroll

Retrieve all shipped (SHIP) payroll orders by shipdate. Only will query last 45 days if timestamp not specified.

Default Example

{"apikey":"API-KEY","request":{"shipdate":1471158000000,"enddate":1481158000000}}

POST /api/store/orders

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.

Default Example

{"apikey":"API-KEY","request":{"paymenttypes":["PAYROLL","CREDIT"],"shipdate":1691715626000,"enddate":1692330284000}}

POST /api/store/reports/transactions

Retrieve transactions by time

Default Example

{"apikey":"API-KEY","request":{"begintime":1400789406000,"endtime":1432325406000}}

POST /api/store/orders/updated

Retrieve updated (UPDQ) orders.

Default Example

{"apikey":"API-KEY"}

POST /api/store/reports/orders

Retrieve Order Details by orderlog order_timestamp with status not CANC, CNCP, CNCQ, FAILED, RETRY, RVKC

Default Example

{"apikey":"API-KEY","request":{"begintime":1400789406000,"endtime":1432325406000}}

POST /api/store/reports/returns

Retrieve Returned Order Details by a return_date with status not CANC, CNCP, CNCQ, FAILED, RETRY, RVKC

Default Example

{"apikey":"API-KEY","request":{"begintime":1400789406000,"endtime":1432325406000}}

POST /api/store/order/trackReturn

Pull order items that have return label generated.

Default Example

{"apikey":"API-KEY","request":{"startTimestamp":1597417683000,"endTimestamp":1597471683000}}

POST /api/store/reports/topselling

Retrieve top selling skus

Default Example

{"apikey":"API-KEY","request":{"begintime":1400789406000,"endtime":1432325406000}}

POST /api/store/order/update/payment

Update Payments

Request Parameters

  • orderid: int

    Order ID.
  • payment_info_id: int

    Payment ID.
  • totalchargedamount: float optional

    Total charged amount. Not required.
  • availableamount: float optional

    Available amount. Not required.
  • status: string optional

    Payment status. Not required.
  • updatetime: long optional

    Update timestamp. UNIX timestamp in milliseconds. Not required.
  • updateuser: string optional

    Update user. Not required.
  • activeok: boolean optional

    Active ok. Not required.

Default Example

{"apikey":"API-KEY","request":{"orderid":35,"paymentinfo":[{"updateuser":"Garpac","availableamount":32.25,"activeok":true,"updatetime":1444508283000,"status":"CHRGD","payment_info_id":"1324","totalchargedamount":100.4}]}}

POST /api/v2/store/order/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 optional

    Cancel 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.

Default Example

{"apikey":"API-KEY","request":{"orderid":726864,"orderitems":[{"orderitemid":"10649492","status":"ACK"},{"orderitemid":"10649493","status":"CANC","cancelreason":"CC"}]}}

POST /api/store/order/updateInFlightReturnItem

Update In-flight Return Item's Status

Request Parameters

  • orderid: int

    Order ID.
  • orderitemid: int

    Item ID.

Default Example

{"apikey":"API-KEY","request":{"orderid":753479,"orderitemid":10711036}}

POST /api/store/order/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 optional

    Available date. UNIX timestamp in milliseconds. Not required.
  • canceldate: long optional

    Cancel date. UNIX timestamp in milliseconds. Not required.
  • pickdate: long optional

    Pick date. UNIX timestamp in milliseconds. Not required.
  • shipdate: long optional

    Ship date. UNIX timestamp in milliseconds. Not required.
  • chargetimestamp: long optional

    Charged timestamp. UNIX timestamp in milliseconds. Not required.
  • shippingvendor: string optional

    Shipping vendor. Not required.
  • trackingnumber: string optional

    Tracking number. Not required.
  • failed_notified: int optional

    Order failed notified. Not required.
  • failed_last_notified: long optional

    Order 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.

Default Example

{"apikey":"API-KEY","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}]}}


Loyalty


POST /api/crm/user/create

Create POS User in SessionM.

Request Parameters

  • email: string

    Email address.
  • phone: string

    Phone number, 10 digits, numeric string only

Response Parameters

  • result: string

    Newly generated Crm ID of customer.

Default Example

{"apikey":"API-KEY","request":{"email":"skxtest400@skx.com","phone":"1234567890","storenum":"1"}}

POST /api/crm/gencards

Bulk generate card numbers. Supply a quantity and the API will return a list of card numbers.

Request Parameters

  • quantity: int

    Quantity of card numbers expected back.
  • email: string optional

    Optional. Recipient email of attachment. If email is specified, email will be sent. Otherwise, the list of cards will be returned.
  • csv: boolean optional

    Yes/No: Email csv of cardnumbers.
  • txt: boolean optional

    Yes/No: Email text of cardnumbers.

Default Example

{"apikey":"API-KEY","request":{"quantity":1}}

POST /api/crm/retail/redeem

Use this API to redeem points for a reward certificate.

Request Parameters

  • crmid: string

    User's CRM ID, known in Epicor as Customer Number (customer_no).

Response Parameters

  • cardnum: string

    The card number.
  • pin: string

    The pin number.
  • orderitemid: int

    The order item ID of the reward certificate generated.
  • amount: int

    The amount of the certificate generated.
  • expiration: long

    UNIX timestamp in milliseconds of the expiration date of this certificate.
  • createdate: long

    UNIX timestamp in milliseconds of the creation date of this certificate.
  • points: int

    The points deducted to generate this certificate.

Default Example

{"apikey":"API-KEY","request":{"crmid":"9010052660"}}

POST /api/crm/redeem

Use this API to redeem points for a reward certificate.

Request Parameters

  • userid: int

    Web User's ID.

Response Parameters

  • cardnum: string

    The card number.
  • pin: string

    The pin number.
  • orderitemid: int

    The order item ID of the reward certificate generated.
  • amount: int

    The amount of the certificate generated.
  • expiration: long

    UNIX timestamp in milliseconds of the expiration date of this certificate.
  • createdate: long

    UNIX timestamp in milliseconds of the creation date of this certificate.
  • points: int

    The points deducted to generate this certificate.

Default Example

{"apikey":"API-KEY","request":{"userid":15}}

POST /api/v2/crm/redeem

Use this API to redeem points for a reward certificate.

Request Parameters

  • externaluserid: String

    Web User's ID.
  • subscriberkey: String

    Web User's customer relationship management ID.
  • email: String

    Web User's first name.
  • phone: String optional

    Web User's phone number.
  • firstname: String

    Web User's ID.
  • lastname: String

    Web User's last name.

Response Parameters

  • cardnum: string

    The card number.
  • pin: string

    The pin number.
  • orderitemid: String

    The order item ID of the reward certificate generated.
  • amount: int

    The amount of the certificate generated.
  • expiration: long

    UNIX timestamp in milliseconds of the expiration date of this certificate.
  • createdate: long

    UNIX timestamp in milliseconds of the creation date of this certificate.
  • points: int

    The points deducted to generate this certificate.

Default Example

{"apikey":"API-KEY","request":{"email":"jcrisan@skechers.com","externaluserid":"63409054","firstname":"John","lastname":"Crisanto","subscriberkey":"7000003180","phone":"9234567890"}}

POST /api/v3/crm/redeem

Use this API to redeem points for a reward certificate.

Request Parameters

  • orderid: String

    Web Order ID.
  • externaluserid: String

    Web User's ID.
  • subscriberkey: String

    Web User's customer relationship management ID.
  • email: String

    Web User's first name.
  • phone: String optional

    Web User's phone number.
  • firstname: String

    Web User's ID.
  • lastname: String

    Web User's last name.

Response Parameters

  • cardnum: string

    The card number.
  • pin: string

    The pin number.
  • orderitemid: int

    The order item ID of the reward certificate generated.
  • amount: int

    The amount of the certificate generated.
  • expiration: long

    UNIX timestamp in milliseconds of the expiration date of this certificate.
  • createdate: long

    UNIX timestamp in milliseconds of the creation date of this certificate.
  • points: int

    The points deducted to generate this certificate.

Default Example

{"apikey":"API-KEY","request":{"email":"AMYRUK1@SKX.COM","firstname":"test","userid":"63508275","lastname":"test","orderid":"23232323","subscriberkey":"6200017759","phone":"9234567890"}}

POST /api/crm/creditTransaction

Credit in-store purchase by ecode

Request Parameters

  • ecode: string optional

    eCode. Non-empty text.
  • cardnum: string optional

    User's CRM ID, known in Epicor as Customer Number (customer_no), maxLength = 20

Response Parameters

  • crmid: string

    User's CRM ID, known in Epicor as Customer Number (customer_no), maxLength = 20
  • email: string

    Email. (minLength = 1, maxLength = 20)
  • phone: string

    Phone number.
  • firstname: string

    First name. (minLength = 1, maxLength = 20)
  • cardnum: string

    Elite member number.
  • lastname: string

    Last name. (minLength = 1, maxLength = 20)
  • points: int

    Current points.
  • gcvalue: int

    Current gift card amount available. If gc = 10, customer can redeem rewards to get a $10 gift card.

DEFAULT

{"apikey":"API-KEY","request":{"ecode":"1BF9DP8KRKFNXQ","cardnum":"9003444555"}}

POST /api/crm/credit/instore

Credit in-store purchase by ecode

Request Parameters

  • ecode: string optional

    eCode. Non-empty text.
  • crmid: string optional

    User's CRM ID, known in Epicor as Customer Number (customer_no), maxLength = 20

Response Parameters

  • customerid: string

    User's CRM ID, known in Epicor as Customer Number (customer_no), maxLength = 20
  • refid: string

    eCode. Non-empty text.

Aptos

{"apikey":"API-KEY","request":{"ecode":"0990201000356010720","crmid":"9003444555"}}

Apropos

{"apikey":"API-KEY","request":{"ecode":"1BF9DP8KRKFNXQ","crmid":"9003444555"}}

POST /api/v2/crm/search

Search Epicor's database for customers by criteria.

Request Parameters

  • crmid: string optional

    User's CRM ID, known in Epicor as Customer Number (customer_no), maxLength = 20
  • email: string optional

    Email. (minLength = 1, maxLength = 20)
  • phone: string optional

    Phone number or (deprecated) elite member card number.
  • firstname: string optional

    First name. (minLength = 1, maxLength = 20)
  • lastname: string optional

    Last name. (minLength = 1, maxLength = 20)

Response Parameters

  • crmid: string

    User's CRM ID, known in Epicor as Customer Number (customer_no), maxLength = 20
  • email: string

    Email. (minLength = 1, maxLength = 20)
  • phone: string

    Phone number.
  • firstname: string

    First name. (minLength = 1, maxLength = 20)
  • cardnum: string

    Elite member number.
  • lastname: string

    Last name. (minLength = 1, maxLength = 20)
  • points: int

    Current points.
  • gcvalue: int

    Current gift card amount available. If gc = 10, customer can redeem rewards to get a $10 gift card.

Search By Phone

{"apikey":"API-KEY","request":{"phone":"9981234567"}}

Search By Email

{"apikey":"API-KEY","request":{"email":"cstest@skx.com"}}

Search By CrmID / LOYL

{"apikey":"API-KEY","request":{"crmid":"9010052904"}}

POST /api/v2/crm/search/employee

Search SessionM database for employees by criteria.

Request Parameters

  • employeeid: string optional

    User's Employee ID/File Number
  • filenumber: string optional

    User's Employee File Number
  • email: string optional

    Email. (minLength = 1, maxLength = 20)
  • phone: string optional

    Phone number or (deprecated) elite member card number.

Response Parameters

  • employeeid: string

    User's Employee ID
  • email: string

    Email. (minLength = 1, maxLength = 20)
  • phone: string

    Phone number.
  • firstname: string

    First name. (minLength = 1, maxLength = 20)
  • lastname: string

    Last name. (minLength = 1, maxLength = 20)
  • filenum: string

    File number of the employee.
  • externalIds: list

    External ids of the employee.

Search By Phone

{"apikey":"API-KEY","request":{"phone":"9981234567"}}

Search By Email

{"apikey":"API-KEY","request":{"email":"cstest@skx.com"}}

Search By Employee Id / File Number

{"apikey":"API-KEY","request":{"employeeid":"666666"}}

POST /api/v2/crm/advSearchUser

Search user by crmId, email, phone, first & last name, external id(B2B corp code), employeeId and employee file number, this API replaces deprecated Search Users and Search Employee APIs, the searching result includes user detailed tier info from SessionM.

Request Parameters

  • crmid: string optional

    Loyalty number, SessionM's external id with prefix loyl.
  • phone: string optional

    Phone number, phone number can be either with or without dialing code.
  • email: string optional

    Email. (minLength = 1, maxLength = 65)
  • firstname: string optional

    First name. (minLength = 1, maxLength = 40)
  • lastname: string optional

    Last name. (minLength = 1, maxLength = 40)
  • employeeid: string optional

    Skechers employee id.(minLength = 1, maxLength = 40)
  • filenumber: string optional

    Skechers employee file number.
  • externalid: string optional

    B2B biz corporate code.

Response Parameters

  • sessionmid: string

    An unique id from SessionM.
  • email: string

    SessionM member email.
  • phone: string

    SessionM member phone number.
  • webid: string

    An unique id for Skechers's customer.
  • eliteNumber: string

    An unique number for Skechers's SessionM member.
  • firstname: string

    SessionM member first name.
  • lastname: string

    SessionM member last name.
  • employeeid: string

    Skechers employee id.
  • filenumber: string

    Skechers employee's file number.
  • points: int

    Current available points.
  • gcvalue: string

    Current gift card amount available. If gc = 10, customer can redeem rewards to get a $10 gift card.
  • smuser: SMUser object

    User raw data from SessionM.

Search By Phone/Phone as External Id/Phone as Elite Num

{"apikey":"API-KEY","request":{"phone":"3104567890"}}

Search By Email

{"apikey":"API-KEY","request":{"email":"srid@skechers.com"}}

Search By CrmID / LOYL

{"apikey":"API-KEY","request":{"crmid":"9017870016"}}

Search By Employee Id

{"apikey":"API-KEY","request":{"employeeid":"81877"}}

Search By Employee File Number

{"apikey":"API-KEY","request":{"filenumber":"88472"}}

Search By First Name and Last Name

{"apikey":"API-KEY","request":{"firstname":"sridevi1","lastname":"devi"}}

Search By External Id

{"apikey":"API-KEY","request":{"externalid":"SKD"}}

POST /api/crm/user/sync

Syncs user from Web to Epicor.

Request Parameters

  • crmid: string

    The 10-digit CRM ID of the user.

Default Example

{"apikey":"API-KEY","request":{"userid":4129266}}

POST /api/crm/order/sync

Syncs transaction to SessionM.

Request Parameters

  • crmid: string

    SessionM LOYL or SFMC Subscriber Key.
  • invoiceNum: string

    Order ID or Invoice Number.
  • date: string

    Expecting date in the format of yyyyMMdd.
  • store: string

    Store number, not padded with zeros.
  • payments: array[string]

    Array of payment type, such as VISA.
  • isReturn: boolean

    Is this order a return or a purchase?
  • items.upc: string

    UPC or Sku number.
  • items.description: string

    Product name.
  • items.amount: string

    Item price after discount but before tax and shipping.
  • items.discounts[0].amount: string

    Item discount amount.
  • items.discounts[0].description: string

    Item discount description.

Response Parameters

  • orderid: string

    Item Order ID or Invoice Number.
  • delta: int

    Points delta.

Sync Purchase

{"apikey":"API-KEY","request":{"payments":["VISA"],"isReturn":false,"items":[{"upc":"193113404053","description":"Skechers On the GO 600 - Breezy Sprints","amount":25.6,"discounts":[{"amount":6.4,"description":"APRIL20"}]}],"store":"1","crmid":"920000130114","date":"20181108","invoiceNum":"22222222"}}

Sync Return

{"apikey":"API-KEY","request":{"isReturn":true,"items":[{"upc":"193113404053","description":"Skechers On the GO 600 - Breezy Sprints","amount":25.6}],"invoicenum":"22222222","store":"1","crmid":"920000130114","date":"20181108"}}

POST api/crm/order/syncByID

Syncs transaction from Web DB to SessionM. This will credit new web purchases and deduct new web returns. Becomes a no-op if there's nothing new to sync.

Request Parameters

  • orderid: number

    Web Order ID to be synced.

Default Example

{"apikey":"API-KEY","request":{"orderid":123}}

POST /api/crm/user/update/phone

Update a customer's phone # if it's null.

Request Parameters

  • crmid: string

    The 10-digit CRM ID of the user.
  • phone: string

    Phone number. Min length = 10. String of numbers only. No formatting.

Default Example

{"apikey":"API-KEY","request":{"crmid":"9010052904","phone":"9981234567"}}

POST /api/crm/validation

Validates elite member info

Request Parameters

  • phone: string optional

    Phone number. Min length = 10. String of numbers only. No formatting.
  • cardnum: string optional

    Skechers Elite Card Number, maxLength = 10.

Response Parameters

  • isValidPhone: boolean

    Confirm whether phone is valid or not.
  • isValidCard: boolean

    Confirm whether cardnum is valid or not.

Default Example

{"apikey":"API-KEY","request":{"cardnum":"AK0OMZ","phone":"9981234567"}}

POST /api/crm/employee/create

Create Skechers Employee in SessionM.

Request Parameters

  • employeeid: string

    Unique id generated by SuccessFactor for every employee.
  • filenumber: string optional

    Unique generated by SuccessFactor for every employee, mostly employeeid is same as filenumber.
  • email: string optional

    An email address in SuccessFactor for every employee.
  • firstname: string optional

    Employee's first name.
  • lastname: string optional

    Employee's last name.
  • country: string optional

    Country for employee is located.
  • employeetitle: string optional

    Employee's title.
  • employeelocation: string optional

    Employee's working location.
  • isemployee: boolean optional

    Skechers's employee.
  • employeetier: string optional

    Employee's tier that the employee will be assigned to. An employee can be assigned to one of the following tiers by passing in the value provided inside the parenthesis: Non-Management Employee (NON_MANAGEMENT_EMPLOYEE), Management Employee(MANAGEMENT_EMPLOYEE), and Directors and Above(DIRECTORS_AND_ABOVE)

Response Parameters

  • sessionmid: string

    Unique alphanumeric SessionM generates for every SessionM account.
  • externalIds: list

    List of combination of external Id and external type.
  • externalIds.externalId: string

    Formatted by SessionM defined external type followed by numeric number.
  • externalIds.externalIdType: string

    SessionM defined external type such as EMPLOYEEID, FILENUMBER, WEBID etc ...
  • employeeid: string

    Employee's employee id consisted in create employee request.
  • filenum: string

    Employee's file number consisted in create employee request, if not in create employee request, an employee id is returned as file number.
  • phone: string

    Employee's phone number.
  • email: string

    Employee's email consisted in create employee request.
  • firstname: string

    Employee's first name consisted in create employee request.
  • lastname: string

    Employee's last name consisted in create employee request.
  • country: string

    Employee's working country consisted in create employee request.
  • employeetitle: string

    Employee's title consisted in create employee request.
  • employeelocation: string

    Employee's location consisted in create employee request.
  • isemployee: boolean

Default Example

{"apikey":"API-KEY","request":{"email":"amyr@skechers.com","employeeid":"0000001","firstname":"amy","employeetitle":"tester","employeelocation":"headquarter","country":"usa","isemployee":true,"employeetier":"NON_MANAGEMENT_EMPLOYEE","lastname":"ruan","filenumber":"111119"}}

POST /api/crm/employee/update

Update Skechers Employee in SessionM.

Request Parameters

  • origemployeeid: string

    Existed employee id in SessionM.
  • filenumber: string optional

    Updated employee's file number.
  • email: string optional

    Updated employee's email.
  • firstname: string optional

    Updated employee's first name.
  • lastname: string optional

    Updated employee's last name.
  • country: string optional

    Updated employee's country.
  • employeetitle: string optional

    Updated employee's title.
  • employeelocation: string optional

    Updated employee's location.
  • isemployee: boolean optional

    Updated employee status.
  • employeetier: string optional

    Employee's tier that the employee will be assigned to. An employee can be assigned to one of the following tiers by passing in the value provided inside the parenthesis: Non-Management Employee (NON_MANAGEMENT_EMPLOYEE), Management Employee(MANAGEMENT_EMPLOYEE), and Directors and Above(DIRECTORS_AND_ABOVE)

Response Parameters

  • sessionmid: string

    Unique alphanumeric SessionM generates for every SessionM account.
  • externalIds: list

    List of combination of external Id and external type.
  • externalIds.externalId: string

    Formatted by SessionM defined external type followed by numeric number.
  • externalIds.externalIdType: string

    SessionM defined external type such as EMPLOYEEID, FILENUMBER, WEBID etc ...
  • filenum: string

    Employee's file number passed from update employee request.
  • phone: string

    Employee's phone number.
  • email: string

    Employee's email passed from update employee request.
  • firstname: string

    Employee's first name passed from update employee request.
  • lastname: string

    Employee's last name passed from update employee request.
  • country: string

    Employee's working country passed from update employee request.
  • employeetitle: string

    Employee's title passed from update employee request.
  • employeelocation: string

    Employee's location passed from in update employee request.
  • isemployee: boolean

Default Example

{"apikey":"API-KEY","request":{"email":"amyr@skechers.com","firstname":"amy","employeetitle":"tester","employeelocation":"headquarter","country":"usa","origemployeeid":"0000001","isemployee":true,"employeetier":"NON_MANAGEMENT_EMPLOYEE","lastname":"ruan","filenumber":"111119"}}

POST /api/crm/employee/delete

Delete Skechers Employee in SessionM.

Request Parameters

  • employeeid: string

    Existed employee id in SessionM.

Response Parameters

  • result: string

    Result of delete.

Default Example

{"apikey":"API-KEY","request":{"employeeid":"0000001"}}


Order Service


POST /api/v3/order/searchOrder

(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.

Default Example for US-Deprecated Soon

{"apikey":"API-KEY","request":{"orderid":"130045","email":"AMYRUAN@SKECHERS.COM"}}

Default Example-with Locale

{"apikey":"API-KEY","locale":"en_US","request":{"orderid":"985146","email":"sebastian@sancirilo.cl"}}

POST /api/order/clientToken

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.

Default Example

{"apikey":"API-KEY","request":{"userid":"63355474"}}

POST /api/order/paymentMethodNonce

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.

Default Example

{"apikey":"API-KEY","request":{"cardid":532915}}

POST /api/order/payment/nextUserId

Retrieves next user ID for BrainTree.

Response Parameters

  • userid: string

    User ID newly generated for use with BrainTree.

Default Example

{"apikey":"API-KEY"}

POST /api/v2/ups/getReturnShippingLabel

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.

Default Example

{"apikey":"API-KEY","request":{"orderid":538619,"orderitemid":10295219}}

POST /api/v2/order/getBarcode

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.

Default Example

{"apikey":"API-KEY","request":{"orderid":652249,"orderitemid":10511676,"cardnum":"6035710349460000000","pin":"1234"}}

POST /api/order/addOrderComment

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.

Default Example

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

POST /api/order/addOrderPayment

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.

Default Example

{"apikey":"API-KEY","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"}}}

POST /api/order/exchangeOrderItems

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.

Default Example

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

POST /api/order/closeOrder

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

Default Example

{"apikey":"API-KEY","request":{"orderid":"207306","adminuser":"amy"}}

POST /api/v2/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.

Default Example

{"apikey":"API-KEY","request":{"userid":"990093"}}

POST /api/v3/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

    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.

Default Example for US-Deprecated Soon

{"apikey":"API-KEY","request":{"userid":"990093","pagenumber":0,"pagesize":10}}

Default Example-with Locale

{"apikey":"API-KEY","locale":"en_US","request":{"userid":"990093","pagenumber":0,"pagesize":10}}

POST /api/order/cancelOrder

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.

Default Example

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

POST /api/order/updateOrder

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.

Default Example

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

POST /api/order/updateOrderItems

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.

Default Example

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

POST /api/order/creditCCByElementAdmin

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.

Default Example

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

POST /api/order/retryOrderPayment

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.

Default Example

{"apikey":"API-KEY","request":{"paymentid":987573,"orderid":56497}}

POST /api/order/updateCCTotalChargedAmount

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

Default Example

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

POST /api/order/removeGCBalance

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

Default Example

{"apikey":"API-KEY","request":{"cardnumber":"6035710349473900159","cardpin":"8768","amount":2,"adminuser":"amy"}}

POST /api/order/resendEmail

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

Default Example

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

POST /api/order/resendGCEmails

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

Default Example

{"apikey":"API-KEY","request":{"orderids":[439852],"refundOnly":true}}

POST /api/order/searchOrders

(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

Searching on firstname and lastname

{"apikey":"API-KEY","request":{"firstname":"amy","lastname":"ruan","limit":500}}

Searching on startdate and enddate

{"apikey":"API-KEY","request":{"start":"1546329600000","end":"1547107200000","limit":500}}

Searching without criteria

{"apikey":"API-KEY","request":{"limit":500}}

POST /api/order/searchHoldOrders

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

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

Default Example

{"apikey":"API-KEY"}

POST /api/order/searchOrderByOrderId

(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.

Default Example

{"apikey":"API-KEY","request":{"orderid":130045}}

POST /api/order/searchByOrderIdEmail

(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.

Default Example

{"apikey":"API-KEY","request":{"orderid":130045,"email":"AMYRUAN@SKECHERS.COM"}}

POST /api/v2/order/searchByOrderIdUserIdOMS

(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.

Default Example

{"apikey":"API-KEY","request":{"orderid":544528,"externaluserid":990104}}

POST /api/order/searchByOrderIdUserId

(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.

Default Example

{"apikey":"API-KEY","request":{"orderid":753,"userid":990104}}

POST /api/order/findOrderInvoice

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

Default Example

{"apikey":"API-KEY","request":{"orderid":236931}}

POST /api/order/searchByOrderItemIdToken

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.

Default Example

{"apikey":"API-KEY","request":{"orderitemid":8082634,"token":"OYqsw2j"}}


Retail Orders


POST /api/store/apikey

Create a new API Key, requestable up to 48 hours. Optionally be closed off if ack=true.

Request Parameters

  • storenum: string

    Store number, string value.
  • app: string

    App type, should correspond with locale. ex: For US, send 'skechers_us'
  • locale: string

    Locale, should correspond with app. ex: For US, send 'en_US'
  • client: string

    Accepted values are 'web', 'garpac', or 'pos'.
  • ack: boolean optional

    If ack = false, api key is requestable up to 48 hours. If ack = true, this particular apikey is closed off and not requestable anymore.

Response Parameters

  • apikey: string

    This is the api key generated.

Default Example

{"apikey":"API-KEY","request":{"storenum":"617","app":"skechers_us","locale":"en_US","client":"pos"}}

POST /api/store/web/return

Return web order through store.

Request Parameters

  • storeNum: string

    Store number for the return transaction.
  • orderid: int

    Web Order ID.
  • comment: string

    POS return Web order Store: xxx, RTNCItems: stylecode1colorcode1/size1/upc1/itemId1, stylecode2colorcode2/size2/upc2/itemId2, ExchangedItems: stylecodecolorcode/size/upc (if has exchange) RefundTo: CreditCard: Visa, X4111, $100.00, GIFTCARD: xxxx, $20.00, Cash: $20.00 ChargeTo: CreditCard: Visa, X4111, $100.00, GIFTCARD: xxxx, $20.00 (if exchange to more expensive item)
  • lineitems: List

    List of returned items, require at least one item.
  • lineitems[0].orderitemid: int

    Unique web order item id, it can be located in the response of 'Get Order By ID' API call, example as orderitems -> id
  • lineitems[0].amount: float

    Refund amount for the line item, which is determined by store associate.
  • lineitems[0].reason: string optional

    Reason for returning the line item.

Default Example

{"apikey":"API-KEY","request":{"storeNum":"500","lineitems":[{"orderitemid":10330830,"amount":48.6,"reason":"doesn't fit"},{"orderitemid":10341913,"amount":55.49,"reason":"doesn't fit"}],"comment":"POS return Web order\nStore: xxx,\nRTNCItems: stylecode1colorcode1/size1/upc1/itemId1, stylecode2colorcode2/size2/upc2/itemId2,\nExchangedItems: stylecodecolorcode/size/upc  (if has exchange)\nRefundTo: CreditCard: Visa, X4111, $100.00, GIFTCARD: xxxx, $20.00, Cash: $20.00\nChargeTo: CreditCard: Visa, X4111, $100.00, GIFTCARD: xxxx, $20.00 (if exchange to more expensive item)","orderid":553239}}

POST /api/retail/checkout/search

Searches web inventory by sku or style/color/size combination.

Request Parameters

  • upc: string

    Product UPC Code or SKU.
  • style: string

    Product Style Code
  • color: string

    Product Color Code
  • size: string

    Product Size Number.

Response Parameters

  • message: string

    SUCCESS, NO_RESULT, or INVALID_REQUEST. This is only not null if the search is by UPC/SKU.
  • skus: string

    List of UPCs and Sizes available for that search query. This is only not null if the search is by Style/Color/Size.

Search By Style/Color

{"apikey":"API-KEY","request":{"style":"52675","color":"BBK"}}

Search By UPC

{"apikey":"API-KEY","request":{"upc":"888222488079"}}

Search By Style/Color/Size

{"apikey":"API-KEY","request":{"style":"52675","color":"BBK","size":"9.0"}}

POST /api/retail/checkout/confirm

Place a new omnichannel order.

Request Parameters

  • emailaddress: string

    Customer email used for placing order.
  • shippingmethod: string

    Order shipping method, for example Standard shipping method.
  • shippingcost: float

    Order shipping cost.
  • taxrate: float

    Order tax rate cost.
  • chargedamount: float

    Amount that has been charged to the customer.
  • invoicenum: string optional

    Store invoice number.
  • terminalid: string optional

    Store terminal ID.
  • cashierid: string optional

    Store cashier ID.
  • shippingaddress.firstname: string

    Customer's shipping First name with maxlength = 255
  • shippingaddress.lastname: string

    Customer's shipping Last name with maxlength = 255
  • shippingaddress.address1: string

    Customer's shipping address line1 with maxlength = 255
  • shippingaddress.address2: string

    Customer's shipping address line2 with maxlength = 255
  • shippingaddress.city: string

    Customer's shipping city with maxlength = 50
  • shippingaddress.state: string

    Customer's shipping state with maxlength = 10
  • shippingaddress.zip: string

    Customer's shipping zipCode with maxlength = 25
  • shippingaddress.country: string

    Customer's shipping country with maxlength = 50
  • shippingaddress.phone: string

    Customer's shipping phone number with maxlength = 255
  • billingaddress.firstname: string

    Customer's shipping First name with maxlength = 255
  • billingaddress.lastname: string

    Customer's shipping Last name with maxlength = 255
  • billingaddress.address1: string

    Customer's shipping address line1 with maxlength = 255
  • billingaddress.address2: string

    Customer's shipping address line2 with maxlength = 255
  • billingaddress.city: string

    Customer's shipping city with maxlength = 50
  • billingaddress.state: string

    Customer's shipping state with maxlength = 10
  • billingaddress.zip: string

    Customer's shipping zipCode with maxlength = 25
  • billingaddress.country: string

    Customer's shipping country with maxlength = 50
  • billingaddress.phone: string

    Customer's shipping phone number with maxlength = 255
  • payment.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.
  • payment.token: string

    A unique string provided by payment gateway to identify individual credit card, gift card, PayPal paymet, Afterpay payment .... For Aurus payment, the param refers to Aurus's CardIdentifier(CI or KI), the specification of OOT shall refer to Aurus documentation.
  • payment.providertoken: string optional

    A unique string provided by payment gateway. For Aurus payment, the param refers to Aurus's OneOrderToken(OOT), the specification of OOT shall refer to Aurus documentation.
  • payment.providerrefnum: string optional

    A unique string provided by payment gateway. For Aurus payment, the param refers to Aurus's AurusPayTicketNum(APTN), the specification of APTN shall refer to Aurus documentation.
  • payment.providertxnid: string optional

    A unique string provided by payment gateway. For Aurus payment, the param refers to Aurus's TransactionIdentifier(APTID), the specification of APTID shall refer to Aurus documentation.
  • payment.exp: string optional

    Credit card expiration.
  • payment.expmonth: string

    Credit card expiration month.
  • payment.expyear: string

    Credit card expiration year.
  • lineitems.upccode: string

    UPC/SKU of item.
  • lineitems.regularunitprice: float

    Regular price before coupon and category discount.
  • lineitems.discountamount: float

    The discount amount applied to order item.
  • lineitems.unitprice: float

    Price of the item after discount
  • lineitems.tax: float

    Tax amount applied to order.
  • lineitems.shippingcost: float

    Shipping amount applied to order.
  • lineitems.totalprice: 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

Response Parameters

  • order: WebOrder

    Refer to Models - WebOrder.

Default Example

{"apikey":"API-KEY","request":{"shippingaddress":{"city":"OKLAHOMA CITY","zip":"30330","state":"CA","firstname":"JOHN","country":"USA","address2":"APT 4","lastname":"SMITH","address1":"123 MUCEASY STREET","default":false,"phone":"1231231234"},"emailaddress":"MYTEST+SKECHERS@SKECHERS.COM","billingaddress":{"city":"LOS ANGELES","zip":"30330","state":"CA","firstname":"JOHN","country":"USA","address2":"1121 Manhattan Avenue","lastname":"SMITH","address1":"Store 001","default":false,"phone":"1231231234"},"invoicenum":"","lineitems":[{"tax":2.61,"unitprice":29,"upccode":"190211914439","discountamount":10,"regularunitprice":39,"shippingcost":0,"totalprice":31.61},{"tax":2.61,"unitprice":29,"upccode":"190211914439","discountamount":10,"regularunitprice":39,"shippingcost":0,"totalprice":31.61}],"chargedamount":63.22,"shippingmethod":"Standard","payment":{"exp":"3/2022","accountnumber":"1111","token":"1313561542810119","expyear":"2022","expmonth":"3","cardtype":"Visa"},"shippingcost":0,"taxrate":0.09,"terminalid":"","cashierid":""}}

POST /api/retail/checkout/void

Cancels and voids an omnichannel order. Can only be canceled and voided if the order is in NEW status and hasn't been pulled by Garpac.

Request Parameters

  • orderid: int

    OMS Order ID of the Order that needs to be voided.

Response Parameters

  • order: WebOrder

    Refer to Models - WebOrder.

Default Example

{"apikey":"API-KEY","request":{"orderid":6174242}}


Sales Reports


POST /api/order/searchDiscountCodeSales

search discount code sales summary based on start/end date, discount codes and order item status.

Request Parameters

  • start: long optional

    Start time for order time search
  • end: long optional

    End time for order time search
  • discountcodes: list of string optional

    list of discount codes
  • excludestatus: list of String optional

    excluded order item status, example:"CANC", "CNCQ", "CNCP"

Default Example

{"apikey":"API-KEY","request":{"discountcodes":["QHUANG6TSO"],"excludestatus":["CANC","CNCQ","CNCP"]}}

POST /api/order/searchGcOrRc

search information about gift card or reward certificate.

Request Parameters

  • orderid: Int optional

    order id of the gift card or reward
  • email: string optional

    Email of the user who orders the gift card or reward
  • crmid: string optional

    crm id
  • cardnum: string optional

    card number of the gift card / reward payment
  • pin: string optional

    pin of the gift card / reward payment

Default Example

{"apikey":"API-KEY","request":{"email":""}}

POST /api/order/searchItemizedDiscountSales

search Itemized discount code sales based on start/end date, discount code and order item status.

Request Parameters

  • start: long optional

    Start time for order time search
  • end: long optional

    End time for order time search
  • discountcode: string optional

    discount code
  • excludestatus: list of String optional

    excluded order item status, example:"CANC", "CNCQ", "CNCP"

Default Example

{"apikey":"API-KEY","request":{"discountcode":"QHUANG6TSO","excludestatus":["CANC","CNCQ","CNCP"]}}

POST /api/order/searchItemizedReferralSales

search Itemized Referral sales based on start/end date, discount code and order item status.

Request Parameters

  • start: long optional

    Start time for order time search
  • end: long optional

    End time for order time search
  • refid: string optional

    referral id
  • excludestatus: list of String optional

    excluded order item status, example:"CANC", "CNCQ", "CNCP"

Default Example

{"apikey":"API-KEY","request":{"refid":"QHUANG6TSO","excludestatus":["CANC","CNCQ","CNCP"]}}

POST /api/order/searchReferralSales

search Referral sales summary based on start/end date, optional referral id and order item status.

Request Parameters

  • start: long optional

    Start time for order time search
  • end: long optional

    End time for order time search
  • refid: string optional

    referral id
  • excludestatus: list of String optional

    excluded order item status, example:"CANC", "CNCQ", "CNCP"

Default Example

{"apikey":"API-KEY","request":{"start":1383497079767,"end":1413997339767,"refid":"OBWelcomeElite","excludestatus":["CANC","CNCQ","CNCP"]}}

POST /api/order/searchStoreSales

search retail web sales summary based on start/end date, store numbers and order item status.

Request Parameters

  • start: long optional

    Start time for order time search
  • end: long optional

    End time for order time search
  • storenums: list of string optional

    list of store numbers
  • excludestatus: list of String optional

    excluded order item status, example:"CANC", "CNCQ", "CNCP"

Default Example

{"apikey":"API-KEY","request":{"start":1413497079767,"end":1413997339767,"storenums":["900"],"excludestatus":["CANC","CNCQ","CNCP"]}}

POST /api/order/searchStyleCodeSales

search style code sales summary based on start/end date, style codes and order item status.

Request Parameters

  • start: long optional

    Start time for order time search
  • end: long optional

    End time for order time search
  • stylecodes: list of string optional

    list of style codes
  • discountcodes: list of string optional

    list of discount codes
  • divisions: list of string optional

    list of divisions
  • excludestatus: list of String optional

    excluded order item status, example:"CANC", "CNCQ", "CNCP"

Default Example

{"apikey":"API-KEY","request":{"stylecodes":["10239","10249"]}}

POST /api/order/searchOrderAttempts

Search order attempts by order timestamp, Order ID...

Request Parameters

  • start: long optional

    Start time for order time search
  • end: long optional

    End time for order time search
  • orderid: int optional

    Order ID
  • email: string optional

    Customer's Email Address
  • phone: string optional

    Customer's Phone number
  • firstname: string optional

    Customer's first name
  • lastname: string optional

    Customer's last name
  • limit: number optional

    Max Results

Default Example

{"apikey":"API-KEY","request":{"firstname":"amy","lastname":"ruan"}}

POST /api/order/searchSalesStat

Search sales statistics for today, today previous year, YTD, YTD previous year.

Request Parameters

  • excludestatus: list of String optional

    excluded order item status, example:"CANC", "CNCQ", "CNCP"

Default Example

{"apikey":"API-KEY","request":{}}

POST /api/order/searchSales

Search sales by order timestamp, Order ID,

Request Parameters

  • start: long optional

    Start time for order time search
  • end: long optional

    End time for order time search
  • limit: number optional

    Max Results
  • salesType: String optional

    either daily/weekly
  • excludestatus: list of String optional

    excluded order item status, example:"CANC", "CNCQ", "CNCP"

Default Example

{"apikey":"API-KEY","request":{"start":1403997079767,"end":1413997339767}}


Store Catalog


POST /api/v3/catalog/600/upc/884292068890

Update Store Inventory for a specific UPC. Also need to specify stylecode and colorcode as UPC gets recycled so they are not uniquely identifiable.

Request Parameters

  • stylecode: string

    The stylecode of the UPC
  • colorcode: string

    The colorcode of the UPC
  • quantity: int

    The new quantity to be updated

Response Parameters

  • storeid: string

    The stylecode of the UPC
  • stylecode: string

    The colorcode of the UPC
  • colorcode: string

    The colorcode of the UPC
  • quantity: int

    The new quantity

Default Example

{"apikey":"API-KEY","request":{"stylecode":"4442","colorcode":"BOL","quantity":7}}

POST /api/v3/catalog/updateStores

Request Parameters

  • storenum: string

  • storetype: string

  • name: string

  • address1: string

  • address2: String optional

  • city: string

  • state: string

  • country: string

  • description: string optional

  • phone: string

  • postalcode: string

  • hours: map

  • region: string optional

  • climate: string optional

  • latitude: double

  • longtitude: double

Default Example

{"apikey":"API-KEY","request":[{"city":"Manhattan Beach","name":"SKECHERS Retail","latitude":33.8845894,"state":"CA","description":"Manhattan Beach","storenum":"1","country":"USA","storetype":"Retail","hours":{"mon":"10:00:19:00","tue":"11:00:18:00","sun":"10:00:19:00","thur":"10:00:19:00","fri":"10:00:19:00","sat":"10:00:19:00","wed":"10:00:19:00"},"climate":"WARM","address1":"1121 Manhattan Avenue","postalcode":"90266","longtitude":-118.4108153,"region":"SOUTHWEST","phone":"(310) 318-3116"},{"city":"Gardena","name":"SKECHERS Factory Outlet","latitude":33.8585645,"state":"CA","storenum":"2","country":"USA","storetype":"Outlet","hours":{"mon":"10:00:19:00","tue":"11:00:18:00","sun":"10:00:19:00","thur":"10:00:19:00","fri":"10:00:19:00","sat":"10:00:19:00","wed":"10:00:19:00"},"address1":"19000 S Vermont Ave.","postalcode":"90248","longtitude":-118.2899724,"phone":"(310) 327-4600"}]}



API Errors


Error Code Error Description
000007 Unauthorized, use the proper API key.
00001 Request Timeout.
00002 Invalid form data.
00003 Invalid response.
00004 API unavailable.
00005 Generic fail.
00006 Not found.
00007 Unauthorized.
00008 Too many requests.
01000 CRM Service is currently down.
01001 CRM Service timeout.
01002 Could not retrieve rewards for that CRM ID.
01003 Could not redeem rewards.
01004 Invalid CRM User data, CRM User not added.
01005 Invalid CRM User cardnumber or webid, this data was not saved.
01007 Invalid CRM User data or CRM Address data, data not updated.
01014 Could not generate new card number.
01015 Invalid card number.
01016 Invalid CRM ID.
01017 Invalid data, could not reverse redemption
01019 Invalid ECode.
01020 Unknown CRM Error.
01021 Not enough points to redeem.
01023 Could not find sale by that E-Code.
01024 ECode credit already claimed.
01026 Retry redemption again.
01031 User already exists.
03000 user not found.
03001 User already exists.
03002 User banned.
03003 Invalid credentials.
03004 Password expired.
03006 Passwords don't match.
05000 Discount already exists.
05001 Discount not found.
05002 Discount expired.
05003 Discount not started.
05004 Max usage reached.
05006 Min purchase amount not met.
05007 Max purchase amount exceeded.
05008 Min quantity not met.
05009 Max quantity exceeded.
05010 Does not match gender specified for discount.
05011 Required style code not met.
05012 Must buy all required styles for this discount.
05013 Excluded style codes used.
05014 Discount cannot be approved.
05015 Discount not applicable to redlined items.
05016 Generic Error - Discount not applicable.
06000 Order not found.
06001 Order attempt not found.
06002 Order item not found.
06003 Order transaction not found.
06004 Payment not found.
06005 Not allow to change.
06006 Not allow to change address.
06007 Order item not allow to change.
06008 Checkout fail.
06009 Refund exceeds amount.
06010 Refund beyone one thousand.
06011 The PO box not allow to ship.
06012 Invalid shipping option.
06013 Transaction error.
06015 Email address is required.
06016 Confirmed password is required.
06017 Could not find taxrule.
06018 Tax calculation failed.
06020 Card number or PIN incorrect.
06021 Gift card zero balance.
06022 Gift card not found.
06023 Invalid shipping address.
06024 Reward card not found.
06025 Order already closed.
06026 Order not allowed to cancel partial order.
06028 Find order invoice failed.
06029 Email not found, unable to resend.
06030 Webpay service error.
06031 Not allow to generate credit invoice.
06033 Invalid order item Id.
06034 Afterpay service error.
06036 Afterpay order has gift card payments balance changes.
06037 Sum of afterpay and gc payments doesn't match order total.
06038 B2C - Invalid shipping state, only for USA and CAN.
06039 Order payment timeout, apply for Worldpay, Braintree, PayPal and Chase.
06040 Some items in cart are not available.
06041 Return label generation failed.
06042 Order has not been shipped, not eligible for return label.
07000 Catalog not found
07002 Catalog update fail
07003 ColorMap not found
07004 ColorMap update failed
07016 Catalog Attribute update failed
08000 Customer not found.
08001 Customer already exists.
08002 Passwords don't match.
08005 Wishlist doesn't exist.
08006 Rate limited by Email.
08007 Rate limited by IP.
12001 Store search failure.
12002 Store update failure.
12003 Store update payment failure.
12004 Store reports failure
130000 Store Catalog API failed
130001 Store Catalog API Get failed
130002 Store Catalog API Update failed
190000 Store return error, ok to resend.
190001 Store return error, do not resend.

API Models