Remove Store Credit

DELETE

https://your_store.example.com/api/storefront/checkouts/:checkoutId/store-credit

DELETE

/api/storefront/checkouts/:checkoutId/store-credit

curl -X DELETE https://your_store.example.com/api/storefront/checkouts/checkoutId/store-credit \
     -H "Accept: application/json" \
     -H "Content-Type: application/json" \
     -d '{
  "version": 1
}'

{
  "billingAddress": {
    "countryCode": "US",
    "address1": "123 Main Street",
    "address2": "",
    "city": "Austin",
    "company": "",
    "country": "United States",
    "customFields": [
      {
        "fieldId": "field_25",
        "fieldValue": "Leave in backyard"
      }
    ],
    "email": "janedoe@example.com",
    "firstName": "Jane",
    "lastName": "Doe",
    "stateOrProvince": "Texas",
    "stateOrProvinceCode": "TX",
    "phone": "1234567890",
    "postalCode": "78751",
    "id": "5ba11e4a10fb5"
  },
  "cart": {
    "baseAmount": 119.93,
    "cartAmount": 112.93,
    "createdTime": "2018-09-18T15:48:26+00:00",
    "coupons": [
      {
        "code": "S2549JM0Y",
        "id": 1,
        "displayName": "$5.00 off the order total",
        "couponType": "per_total_discount",
        "discountedAmount": 5
      }
    ],
    "currency": {
      "code": "USD",
      "decimalPlaces": 2,
      "name": "US Dollars",
      "symbol": "$"
    },
    "customerId": 11,
    "discountAmount": 0,
    "discounts": [
      {
        "id": 1,
        "discountedAmount": 2.59
      },
      {
        "id": 2,
        "discountedAmount": 1.06
      },
      {
        "id": 3,
        "discountedAmount": 2.12
      },
      {
        "id": 4,
        "discountedAmount": 0.8
      },
      {
        "id": 5,
        "discountedAmount": 0.43
      }
    ],
    "email": "janedoe@example.com",
    "id": "b6fbd994-61a8-4f25-9167-6ec10489c448",
    "isTaxIncluded": false,
    "lineItems": {
      "digitalItems": [
        {
          "quantity": 1,
          "addedByPromotion": false,
          "categoryNames": [
            "Essentials",
            "Just arrived"
          ],
          "comparisonPrice": 0,
          "couponAmount": 0,
          "discounts": [
            {
              "id": 1,
              "discountedAmount": 0.8
            }
          ],
          "discountAmount": 0,
          "extendedComparisonPrice": 0,
          "extendedListPrice": 18.95,
          "extendedSalePrice": 18.95,
          "id": "6477a4a1-02cf-4287-8bf2-fd043bdd5234",
          "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/189/images/465/gather_1024x1024__17195__82620.1534344540.330.500.jpg?c=2",
          "isShippingRequired": false,
          "isTaxable": true,
          "listPrice": 18.95,
          "name": "Gather Journal Issue 7 - Digital",
          "options": [
            {
              "name": "Color",
              "nameId": 1,
              "value": "Red",
              "valueId": "2"
            }
          ],
          "originalPrice": 18.95,
          "parentId": "",
          "productId": 189,
          "salePrice": 18.95,
          "type": "digital",
          "url": "https://{store_domain}/all/gather-journal-issue-7/",
          "variantId": 360,
          "brand": "OFS"
        }
      ],
      "physicalItems": [
        {
          "quantity": 1,
          "addedByPromotion": false,
          "categoryNames": [
            "Essentials",
            "Just arrived"
          ],
          "comparisonPrice": 0,
          "couponAmount": 0,
          "discounts": [
            {
              "id": 1,
              "discountedAmount": 0.59
            },
            {
              "id": 2,
              "discountedAmount": 2
            }
          ],
          "discountAmount": 2,
          "extendedComparisonPrice": 0,
          "extendedListPrice": 15.99,
          "extendedSalePrice": 13.99,
          "giftWrapping": {},
          "id": "69791a88-85c9-4c19-8042-e537621e8a55",
          "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/184/images/445/naturalcanvascart2_1024x1024__92347__29648.1534344533.330.500.jpg?c=2",
          "isShippingRequired": true,
          "isTaxable": true,
          "listPrice": 15.99,
          "name": "Canvas Laundry Cart",
          "options": [
            {
              "name": "Color",
              "nameId": 1,
              "value": "Red",
              "valueId": "2"
            }
          ],
          "originalPrice": 17.99,
          "parentId": "",
          "productId": 184,
          "sku": "SMA-RED",
          "salePrice": 13.99,
          "url": "https://{store_domain}/all/canvas-laundry-cart/",
          "variantId": 364,
          "brand": "OFS"
        },
        {
          "quantity": 1,
          "addedByPromotion": false,
          "categoryNames": [
            "Essentials",
            "Just arrived"
          ],
          "comparisonPrice": 0,
          "couponAmount": 0,
          "discounts": [
            {
              "id": 1,
              "discountedAmount": 1.06
            }
          ],
          "discountAmount": 0,
          "extendedComparisonPrice": 0,
          "extendedListPrice": 25,
          "extendedSalePrice": 25,
          "giftWrapping": {},
          "id": "ba2c619d-e6b4-48c2-8809-d88e424ed450",
          "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/170/images/411/measuringsquares2_1024x1024__07108__95421.1534344522.330.500.jpg?c=2",
          "isShippingRequired": true,
          "isTaxable": true,
          "listPrice": 25,
          "name": "Ceramic Measuring Spoons",
          "options": [
            {
              "name": "Color",
              "nameId": 1,
              "value": "Red",
              "valueId": "2"
            }
          ],
          "originalPrice": 25,
          "parentId": "",
          "productId": 170,
          "sku": "",
          "salePrice": 25,
          "url": "https://{store_domain}/all/ceramic-measuring-spoons/",
          "variantId": 341,
          "brand": "OFS"
        },
        {
          "quantity": 1,
          "addedByPromotion": false,
          "categoryNames": [
            "Essentials",
            "Just arrived"
          ],
          "comparisonPrice": 0,
          "couponAmount": 0,
          "discounts": [
            {
              "id": 1,
              "discountedAmount": 2.12
            }
          ],
          "discountAmount": 0,
          "extendedComparisonPrice": 0,
          "extendedListPrice": 49.99,
          "extendedSalePrice": 49.99,
          "giftWrapping": {},
          "id": "c72d6651-978d-45e5-881b-c2bb5f7ff1d5",
          "imageUrl": "https://cdn8.bigcommerce.com/s-id30h7ohwf/products/158/images/382/foglinenbeigestripetowel1b_1024x1024__83011__60806.1534344511.330.500.jpg?c=2",
          "isShippingRequired": true,
          "isTaxable": true,
          "listPrice": 49.99,
          "name": "Chambray Towel",
          "options": [
            {
              "name": "Color",
              "nameId": 1,
              "value": "Red",
              "valueId": "2"
            }
          ],
          "originalPrice": 49.99,
          "parentId": "",
          "productId": 158,
          "sku": "SKU-A0C8A203",
          "salePrice": 49.99,
          "url": "https://{store_domain}/all/chambray-towel/",
          "variantId": 376,
          "brand": "OFS"
        }
      ],
      "customItems": [],
      "giftCertificates": [
        {
          "amount": 10,
          "recipient": {
            "name": "John Doe",
            "email": "johndoe@example.com"
          },
          "sender": {
            "name": "Jane Doe",
            "email": "janedoe@example.com"
          },
          "theme": "Celebration",
          "id": "871f1f56-4c88-43c3-a6e5-0a647d83d6ac",
          "message": "Thank you!",
          "name": "$10.00 Gift Certificate",
          "taxable": false,
          "type": "giftCertificate"
        }
      ]
    },
    "locale": "en",
    "updatedTime": "2018-09-18T16:59:45+00:00",
    "version": 1
  },
  "channelId": 1,
  "consignments": [
    {
      "address": {
        "countryCode": "US",
        "address1": "123 Main Street",
        "address2": "",
        "city": "Austin",
        "company": "",
        "country": "United States",
        "customFields": [
          {
            "fieldId": "field_25",
            "fieldValue": "Leave in backyard"
          }
        ],
        "email": "janedoe@example.com",
        "firstName": "Jane",
        "lastName": "Doe",
        "stateOrProvince": "Texas",
        "stateOrProvinceCode": "TX",
        "phone": "1234567890",
        "postalCode": "78751"
      },
      "availableShippingOptions": [
        {
          "cost": 8,
          "description": "Ship by Weight",
          "id": "d09e05c0-3788-44df-a1bb-b6d3afdf6841",
          "imageUrl": "",
          "transitTime": "",
          "type": "shipping_byweight",
          "additionalDescription": "Fragile items"
        }
      ],
      "couponDiscounts": [],
      "discounts": [],
      "handlingCost": 0,
      "id": "5ba121929619b",
      "selectedShippingOption": {
        "description": "UPS® (UPS Next Day Air®)",
        "id": "bb3c818f-17ce-46fe-9475-65933095da0d",
        "type": "shipping_upsready",
        "imageUrl": "",
        "cost": 69.94,
        "transitTime": "1 business day",
        "additionalDescription": "Fragile items"
      },
      "shippingCost": 69.94,
      "shippingCostBeforeDiscount": 69.94,
      "comparisonShippingCost": 64.94,
      "lineItemIds": [
        "69791a88-85c9-4c19-8042-e537621e8a55",
        "ba2c619d-e6b4-48c2-8809-d88e424ed450",
        "c72d6651-978d-45e5-881b-c2bb5f7ff1d5"
      ]
    }
  ],
  "coupons": [
    {
      "code": "S2549JM0Y",
      "id": 1,
      "displayName": "$5.00 off the order total",
      "couponType": 2,
      "discountedAmount": 5
    }
  ],
  "fees": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "type": "custom_fee",
      "name": "AAINS",
      "displayName": "Package Protection Insurance",
      "cost": 12.02,
      "source": "AA",
      "taxClassId": 12
    }
  ],
  "createdTime": "2018-09-18T15:48:26+00:00",
  "customer": {
    "addresses": [
      {}
    ],
    "customerGroup": {
      "id": 1,
      "name": "Wholesale customers"
    },
    "email": "janedoe@example.com",
    "firstName": "Jane",
    "fullName": "Jane Doe",
    "id": 1,
    "isGuest": false,
    "lastName": "Doe",
    "shouldEncourageSignIn": false,
    "storeCredit": 1
  },
  "customerMessage": "Thank you, BigCommerce",
  "giftCertificates": [
    {
      "balance": 4,
      "code": "1234ABC",
      "purchaseDate": "2018-09-18",
      "remaining": 2,
      "used": 5
    }
  ],
  "giftWrappingCostTotal": 0,
  "grandTotal": 211.49,
  "handlingCostTotal": 0,
  "id": "b6fbd994-61a8-4f25-9167-6ec10489c448",
  "isStoreCreditApplied": false,
  "orderId": null,
  "outstandingBalance": 211.49,
  "payments": [
    {}
  ],
  "promotions": [],
  "shippingCostBeforeDiscount": 69.94,
  "comparisonShippingCost": 64.94,
  "shippingCostTotal": 69.94,
  "shouldExecuteSpamCheck": false,
  "subtotal": 117.93,
  "taxes": [
    {
      "name": "Store Tax",
      "amount": 28.62
    }
  ],
  "taxTotal": 28.62,
  "updatedTime": "2018-09-18T16:59:45+00:00",
  "version": 1
}

Removes store credit from a checkout.

Note

Substitute your storefront domain for yourstore.example.com.

The Send a Test Request feature is not currently supported for this endpoint.

This endpoint runs in the context of an active storefront session and works on any live BigCommerce-hosted storefront, not only in a local environment. It uses same-origin CORS authentication, and write requests require a CSRF token. Stencil CLI can provide a session and CSRF token for local theme development.

Path parameters

checkoutIdstringRequiredformat: "uuid"

The ID of the subject checkout. Identical to the cart ID.

Query parameters

includelist of enumsOptionalDefaults to ["consignments.availableShippingOptions"]

cart.lineItems.physicalItems.options - physical options
cart.lineItems.digitalItems.options - digital options
cart.lineItems.physicalItems.categoryNames - physical categories
cart.lineItems.digitalItems.categoryNames - digital categories
cart.lineItems.customItems.categoryNames - custom categories
cart.lineItems.physicalItems.stockPosition - backorder and stock availability for physical items
cart.lineItems.digitalItems.stockPosition - backorder and stock availability for digital items (backorder values are always zero since digital products cannot be backordered)
customer - customer
customer.customerGroup - customer group
payments - payments
promotions - promotions
consignments.availableShippingOptions - shipping options
consignments.availablePickupOptions - pickup options

Request

This endpoint expects an object.

versionintegerOptional

The checkout version that you expect to apply the update to. If the provided version doesn’t match the current checkout version, you will receive a conflict error. This field is optional; if not provided, optimistic concurrency control will not apply.

Response

Returns the updated checkout object.

billingAddressobjectOptional

cartobjectOptional

A cart contains a collection of items, prices, discounts, etc. It does not contain customer-related data.

channelIdintegerOptional

Channel ID.

consignmentslist of objectsOptional

couponslist of objectsOptional

Coupons applied at the checkout level.

feeslist of objectsOptional

Fees applied at the checkout level.

createdTimestringOptional

Time when the cart was created.

customerobjectOptional

Customer details.

customerMessagestringOptional

Shopperʼs message provided as details for the order to be created from this cart

giftCertificateslist of objectsOptional

Applied gift certificate (as a payment method).

giftWrappingCostTotaldoubleOptional

Gift wrapping cost for all items, including or excluding tax.

grandTotalfloatOptional

The total payable amount, before applying any store credit or gift certificate.

handlingCostTotalfloatOptional

Handling cost for all consignments including or excluding tax.

idstringOptionalformat: "uuid"

isStoreCreditAppliedbooleanOptional

true value indicates StoreCredit has been applied.

orderIdstring or nullOptional

outstandingBalancedoubleOptional

grandTotal subtract the store-credit amount

paymentslist of objectsOptional

promotionslist of objectsOptional

shippingCostBeforeDiscountfloatOptional

Total shipping cost for the checkout before discounts are applied.

comparisonShippingCostfloatOptional

Total shipping cost for the checkout after automatic promotions are applied.

shippingCostTotalfloatOptional

Shipping cost before any discounts are applied.

shouldExecuteSpamCheckbooleanOptional

subtotalfloatOptional

Subtotal of the checkout before applying item-level discounts. Tax inclusive based on the store settings.

taxeslist of objectsOptional

taxTotalfloatOptional

updatedTimestringOptional

Time when the cart was last updated.

versionintegerOptional

The current version of the checkout increments with each successful update. You can use it to enable optimistic concurrency control for subsequent updates.

Errors

409

Conflict Error

Note

Path parameters

Headers

Query parameters

Request

Response

Errors