Docs
Storefront API
Checkout Spam Protection

Checkout Spam Protection

Checkout Spam Protection

POST /checkouts/{checkoutId}/spam-protection

Request

Verifies if checkout is created by human.

Note

  • Substitute your storefront domain for yourstore.example.com.
  • The Send a Test Request feature is not currently supported for this endpoint.
  • This endpoint requires using Stencil CLI, a local session, and a csrf token to work.

Parameters

  • store_domain in path - string
  • checkoutId in path - string
    required

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

  • Accept in header with default of application/json - string
    required

    The MIME type of the response body.

  • Content-Type in header with default of application/json - string
    required

    The MIME type of the request body.

Body

object | application/json
  • token
    string

example

Response

Returns Checkout Object.

Body

object | application/json
  • id
    string

  • cart
    object

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

  • billingAddress
    object

  • consignments
    array[object]

  • coupons
    array[object]

    Coupons applied at the checkout level.

  • orderId
    string or null

  • shippingCostTotal
    number

    Shipping cost before any discounts are applied.

  • giftWrappingCostTotal
    number

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

  • handlingCostTotal
    number

    Handling cost for all consignments including or excluding tax.

  • taxTotal
    number

  • taxes
    array[object]

  • subtotal
    number

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

  • grandTotal
    number

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

  • giftCertificates
    array[array]

    Applied gift certificate (as a payment method).

  • createdTime
    string

    Time when the cart was created.

  • updatedTime
    string

    Time when the cart was last updated.

  • customerMessage
    string

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

  • outstandingBalance
    number

    grandTotal subtract the store-credit amount

  • isStoreCreditApplied
    boolean

    true value indicates StoreCredit has been applied.

example

Did you find what you were looking for?