I/O Docs: Interactive API Documentation

• Products-v3

  • List Methods
  • Expand Methods

  • GET exampleMethod

    Parameter	Value	Type	Description
    exampleParameter		string

• Inventory-v3

  • List Methods
  • Expand Methods

  • GET exampleMethod

    Parameter	Value	Type	Description
    exampleParameter		string

• Content-v3

  • List Methods
  • Expand Methods

  • GET exampleMethod

    Parameter	Value	Type	Description
    exampleParameter		string

• Exchange Rates-v3

  • List Methods
  • Expand Methods

  • GET exampleMethod

    Parameter	Value	Type	Description
    exampleParameter		string

• Prices-v3

  • List Methods
  • Expand Methods

  • GET exampleMethod

    Parameter	Value	Type	Description
    exampleParameter		string

• Checkout-v3

  • List Methods
  • Expand Methods

  • POST validate-order checkout/validations/order

    Validate Order Endpoint

    Parameter	Value	Type	Description
    Content-Type		string	Content type header
    api_key		string	Api key header

    Request Body

    {"ref_num" : "ABC123456", "items" : [{"upc_code":"478508966416", "shipping_address_idx":0, "customer_display_unit_price":16800, "unit_price":16800, "quantity":1, "extended_price":16800, "gift_wrap":"", "shipping_method":"standard", "signature_required":false, "unit_msrp":16800, "promo_codes":[], "extended_shipping_charge":0, "extended_merchandise_tax":0, "extended_shipping_tax":0, "unit_offer_price": 16800, "extended_promo_amount":0, "estimated_delivery_date":"10/12/2017"}], "order_summary" : {"credit_card_total" : 16800, "gift_card_total" : 0, "gift_wrap_total" : 0, "original_items_total" : 16800, "order_discount" : 0, "items_total" : 16800, "msrp_total":16800, "you_save":0, "shipping_total" : 0, "total_before_tax" : 16800, "tax" : 0, "grand_total" : 16800 }, "order_source":"off5thweb", "batch":false, "cancelled_offline":false, "payment_method" : {"credit_card" : {"name" : "Feynman Felix", "brand" : "visa", "number" : "4445222299990007", "month" : "08", "year" : "2017", "security_code" : "123"}, "gift_cards": [] }, "shipping_addresses" : [{"address1" : "123 Washington Way", "address2" : "", "city" : "New York", "company" : "", "country" : "US", "first_name" : "Feynman", "last_name" : "Felix", "middle_name" : "", "phone" : "6036425555", "state" : "NY", "title" : "", "zip" : "10017", "modified_date" : "2013-09-09T13:18:00.000Z"}], "customer_info" : {"email" : "test@saks.com", "loyalties" : [{"name" : "More+", "id" : "00005003772707"}], "registered_customer": false, "account_creation_dt" : "2013-09-09T13:59:00.000Z", "ip_address" : "0.0.0.0"}, "billing_address" : {"address1" : "123 Washington Way", "address2" : "", "city" : "New York", "company" : "", "country" : "US", "first_name" : "Feynman", "last_name" : "Felix", "middle_name" : "", "phone" : "6036425555", "state" : "NY", "title" : "", "zip" : "10017"} }

    {"ref_num" : "ABC123456", "items" : [{"upc_code":"478508966416", "shipping_address_idx":0, "customer_display_unit_price":16800, "unit_price":16800, "quantity":1, "extended_price":16800, "gift_wrap":"", "shipping_method":"standard", "signature_required":false, "unit_msrp":16800, "promo_codes":[], "extended_shipping_charge":0, "extended_merchandise_tax":0, "extended_shipping_tax":0, "unit_offer_price": 16800, "extended_promo_amount":0, "estimated_delivery_date":"10/12/2017"}], "order_summary" : {"credit_card_total" : 16800, "gift_card_total" : 0, "gift_wrap_total" : 0, "original_items_total" : 16800, "order_discount" : 0, "items_total" : 16800, "msrp_total":16800, "you_save":0, "shipping_total" : 0, "total_before_tax" : 16800, "tax" : 0, "grand_total" : 16800 }, "order_source":"off5thweb", "batch":false, "cancelled_offline":false, "payment_method" : {"credit_card" : {"name" : "Feynman Felix", "brand" : "visa", "number" : "4445222299990007", "month" : "08", "year" : "2017", "security_code" : "123"}, "gift_cards": [] }, "shipping_addresses" : [{"address1" : "123 Washington Way", "address2" : "", "city" : "New York", "company" : "", "country" : "US", "first_name" : "Feynman", "last_name" : "Felix", "middle_name" : "", "phone" : "6036425555", "state" : "NY", "title" : "", "zip" : "10017", "modified_date" : "2013-09-09T13:18:00.000Z"}], "customer_info" : {"email" : "test@saks.com", "loyalties" : [{"name" : "More+", "id" : "00005003772707"}], "registered_customer": false, "account_creation_dt" : "2013-09-09T13:59:00.000Z", "ip_address" : "0.0.0.0"}, "billing_address" : {"address1" : "123 Washington Way", "address2" : "", "city" : "New York", "company" : "", "country" : "US", "first_name" : "Feynman", "last_name" : "Felix", "middle_name" : "", "phone" : "6036425555", "state" : "NY", "title" : "", "zip" : "10017"} }

• Checkout-submit-order-v3

  • List Methods
  • Expand Methods

  • GET exampleMethod

    Parameter	Value	Type	Description
    exampleParameter		string

• Orders-v3

  • List Methods
  • Expand Methods

  • GET exampleMethod

    Parameter	Value	Type	Description
    exampleParameter		string

• Orders-ref-num-v3

  • List Methods
  • Expand Methods

  • GET exampleMethod

    Parameter	Value	Type	Description
    exampleParameter		string

• Video Search Method

  • List Methods
  • Expand Methods

  • GET Get Video Page v2/content/videos

    make a request to our video page

• Store and Events Search Method

  • List Methods
  • Expand Methods

  • GET Get Store and Events Page v2/content/events

    make a request to our store and events page

• International Rates Search Method

  • List Methods
  • Expand Methods

  • GET Get International Rates Page v2/exchange_rates/

    make a request to our international rates page

• Products Method

  • List Methods
  • Expand Methods

  • GET Get Products from first page v2/products/

    make a request to our product catalog and get first page

• Products by Page Number Method

  • List Methods
  • Expand Methods

  • GET Get Products by Page Number v2/products/page/number

    make a request to our product page by catalog page number

    Parameter	Value	Type	Description
    number		string	Product page number

• Product by Product Code Method

  • List Methods
  • Expand Methods

  • GET Get Product by Product Code v2/products/product_code

    make a request to our product page by product code to get an individual product

    Parameter	Value	Type	Description
    product_code		string	Product code number starting with 04

• Product by UPC Code Method

  • List Methods
  • Expand Methods

  • GET Get Product by UPC Code v2/products/variant/upc_code

    make a request to our product page by UPC code to get an individual product

    Parameter	Value	Type	Description
    upc_code		string	UPC code from one particular product from Product Catalog

• Inventory by Product Code Search Method

  • List Methods
  • Expand Methods

  • GET Get Inventory by Product Code Page v2/inventory/product/product_code

    make a request by product code to our product inventory page

    Parameter	Value	Type	Description
    product_code		string	Product code starting with 04

• Inventory by UPC Code Search Method

  • List Methods
  • Expand Methods

  • GET Get Inventory by UPC code Page v2/inventory/variant/upc_code

    make a request by UPC code to our product inventory page

    Parameter	Value	Type	Description
    upc_code		string	UPC code from a particular product from our product catalog

• Products Method

  • List Methods
  • Expand Methods

  • GET Get Products from first page qa/v2/products/

    make a request to our product catalog and get first page

• Products by Page Number Method

  • List Methods
  • Expand Methods

  • GET Get Products by Page Number qa/v2/products/page/number

    make a request to our product page by catalog page number

    Parameter	Value	Type	Description
    number		string	Product page number

• Product by Product Code Method

  • List Methods
  • Expand Methods

  • GET Get Product by Product Code qa/v2/products/product_code

    make a request to our product page by product code to get an individual product

    Parameter	Value	Type	Description
    product_code		string	Product code number starting with 04

• Product by UPC Code Method

  • List Methods
  • Expand Methods

  • GET Get Product by UPC Code qa/v2/products/variant/upc_code

    make a request to our product page by UPC code to get an individual product

    Parameter	Value	Type	Description
    upc_code		string	UPC code from one particular product from Product Catalog