API v2.0 - Store Documentation

GET /store/user/cart

Will return the products, pricing, shipping rates and payment options set in a customer's cart.

Route Parameters

Response

Status: 200 OK

{
    "totalNumItems": 7,
    "totals": {
        "subtotal": {
            "name": "subtotal",
            "amount": "171.30",
            "amountStr": "$171.30"
        },
        "tax": {
            "name": "tax",
            "amount": "14.66",
            "amountStr": "$14.66"
        },
        "discount": {
            "name": "discount",
            "amount": "0.00",
            "amountStr": "$0.00"
        },
        "couponAmount": {
            "name": "couponAmount",
            "amount": "0.00",
            "amountStr": "$0.00"
        },
        "shipping": {
            "name": "shipping",
            "amount": "11.90",
            "amountStr": "$11.90"
        },
        "total": {
            "name": "total",
            "amount": "197.86",
            "amountStr": "$197.86"
        }
    },
    "couponName": "",
    "hasCustomer": true,
    "hasCoupon": false,
    "hasFreeShipping": false,
    "hasPriceDiscount": false,
    "shipping": {
        "countryCode": "US",
        "postalCode": "93401",
        "shippingid": 82,
        "selectedRateInfo": {
            "shippingid": 82,
            "name": "USPS Priority Mail",
            "rate": "11.90",
            "rate_string": "$11.90",
            "min_transit_date": "Tue, Aug 16th",
            "max_transit_date": "Thu, Aug 18th",
            "min_transit_date_timestamp": 1471389107,
            "max_transit_date_timestamp": 1471561907
        },
        "possibleRates": {
            "82": {
                "shippingid": 82,
                "name": "USPS Priority Mail",
                "rate": "11.90",
                "rate_string": "$11.90",
                "min_transit_date": "Tue, Aug 16th",
                "max_transit_date": "Thu, Aug 18th",
                "min_transit_date_timestamp": 1471389107,
                "max_transit_date_timestamp": 1471561907
            },
            "85": {
                "shippingid": 85,
                "name": "UPS 2nd Day Air",
                "rate": "23.03",
                "rate_string": "$23.03",
                "min_transit_date": "Mon, Aug 15th",
                "max_transit_date": "Mon, Aug 15th",
                "min_transit_date_timestamp": 1471302707,
                "max_transit_date_timestamp": 1471302707
            },
            "83": {
                "shippingid": 83,
                "name": "UPS Next Day Air",
                "rate": "28.93",
                "rate_string": "$28.93",
                "min_transit_date": "Fri, Aug 12th",
                "max_transit_date": "Fri, Aug 12th",
                "min_transit_date_timestamp": 1471043507,
                "max_transit_date_timestamp": 1471043507
            }
        }
    },
    "products": [
        {
            "name": "Pro Tech Toolkit",
            "itemcode": "IF145-307-4",
            "imageSrc": "https:\/\/www.ifixit.com\/cart-products\/aPHhGCHLa6Ot2sCK.thumbnail",
            "maxToAdd": 10,
            "quantity": 1,
            "subPrice": "69.95",
            "subPriceStr": "$69.95",
            "discount": "0.00",
            "subTotal": "69.95",
            "subTotalStr": "$69.95"
        },
        {
            "name": "Head Magnifier",
            "itemcode": "IF145-172-1",
            "imageSrc": "https:\/\/www.ifixit.com\/cart-products\/pSVy31ckKDqbVuIB.thumbnail",
            "maxToAdd": 89,
            "quantity": 1,
            "subPrice": "24.95",
            "subPriceStr": "$24.95",
            "discount": "0.00",
            "subTotal": "24.95",
            "subTotalStr": "$24.95"
        },
        {
            "name": "Anti-Static Mat \/ 20\" x 24\" \/ iFixit",
            "itemcode": "IF145-036-5",
            "imageSrc": "https:\/\/www.ifixit.com\/cart-products\/RUV2aAMsGplVf4Da.thumbnail",
            "maxToAdd": 224,
            "quantity": 1,
            "subPrice": "29.95",
            "subPriceStr": "$29.95",
            "discount": "0.00",
            "subTotal": "29.95",
            "subTotalStr": "$29.95"
        },
        {
            "name": "iPad 2 Front Glass\/Digitizer Touch Panel Full Assembly \/ Part Only \/ Black",
            "itemcode": "IF112-002-1",
            "imageSrc": "https:\/\/www.ifixit.com\/cart-products\/tCsAlFDEsO3GhDan.thumbnail",
            "maxToAdd": 218,
            "quantity": 1,
            "subPrice": "44.95",
            "subPriceStr": "$44.95",
            "discount": "0.00",
            "subTotal": "44.95",
            "subTotalStr": "$44.95"
        },
        {
            "name": "Self-Repair Manifesto",
            "itemcode": "IF179-020-1",
            "imageSrc": "https:\/\/www.ifixit.com\/cart-products\/aZeYANt4O1xuiXDk.thumbnail",
            "maxToAdd": 503,
            "quantity": 3,
            "subPrice": "0.50",
            "subPriceStr": "$0.50",
            "discount": "0.00",
            "subTotal": "1.50",
            "subTotalStr": "$1.50"
        }
    ],
    "paymentOptions": [
        {
            "paymentid": 9,
            "cardid": "card_194eTZADkLJNGSBfu9qRD2dV",
            "displayName": "Visa-4242"
        }
    ]
}

DELETE /store/user/cart

Will remove all products from the customers cart and set everything to their initial state.

POST /store/user/cart/product/{$itemcode}

Will add the provided quantity to the existing quantity of the product in the cart.

PATCH /store/user/cart/product/{$itemcode}

Will set the provided quantity of the product in the cart.

DELETE /store/user/cart/product/{$itemcode}

Will remove all of the product from the cart.

POST /store/user/order

Will take payment information and create an order for items currently set in the customer's cart. Can also take in a shippingid to change how the order is shipped.

Route Parameters

paymentid — Required — integer: The paymentid used to place an order for the customer. Currently only Credit Card payments are accepted.
paymentInfo — Required — array: A generic way of supplying data specific to the payment option. We only support Credit Card payments so it would have a cardid entry.
shippingid — Optional — integer: Sets the shipping option for the order.

Response

Status: 200 OK

{
    "orderid": 1213045,
    "email": "Tester680250274@test.com",
    "phone": "1234567890",
    "extension": null,
    "shipping_address": {
        "first_name": "Test",
        "last_name": "McTester",
        "company": "test company",
        "address_line1": "1330 Monterey St.",
        "address_line2": "",
        "city": "San Luis Obispo",
        "state": "CA",
        "postal_code": "93401",
        "country_code": "US"
    },
    "billing_address": {
        "first_name": "Kari",
        "last_name": "Bailey",
        "company": "",
        "address_line1": "1330 Monterey St.",
        "address_line2": null,
        "city": "San Luis Obispo",
        "state": "CA",
        "postal_code": "93401",
        "country_code": "US"
    },
    "items": [
        {
            "name": "FIVE_DOLLAR-TEST_PRODUCT-0",
            "itemcode": "IF179-061-1",
            "price": "5.00",
            "quantity": 4
        }
    ],
    "shipping_name": "UPS Ground",
    "totals": {
        "subtotal": 20,
        "shipping_cost": 18.5,
        "tax": 3.0800000000000000710542735760100185871124267578125,
        "total": 41.5799999999999982946974341757595539093017578125,
        "discount": 0
    }
}

Reference Implementations

Official Apps

Third-party Apps

Third-party Libraries

API Versions

Store

GET /store/user/cart

Route Parameters

Response

DELETE /store/user/cart

Route Parameters

Response

POST /store/user/cart/product/{$itemcode}

Route Parameters

Request Body

Response

PATCH /store/user/cart/product/{$itemcode}

Route Parameters

Request Body

Response

DELETE /store/user/cart/product/{$itemcode}

Route Parameters

Response

POST /store/user/order

Route Parameters

Response