Skip to content

Get advanced settings

API v2 is in public beta: endpoints and fields can change before general availability. See the changelog

GET/preorders/offers/{id}/advanced

Costs 1 rate-limit point · Rate limits

Read the advanced settings of a preorder offer: the purchase option (checkout_method) and the cart attributes.

purchase_option_rules says, in plain sentences, what blocks turning the purchase option on, what needs it, and what turning it off would change. It is read-only.

Also searched asget advancedshow advanced settingsview advanced settingsview line item propertiesview advanced

Path parameters

Query parameters

  • localestring

    Language for translated text, such as fr or pt-BR. Omit for the shop's default language.

Returns

  • checkout_methodstring

    selling_plan uses a Shopify purchase option (selling plan); line_item_property runs the offer without one.

    One of selling_planline_item_property
  • cart_attributesobject

    What the offer adds to each preorder cart line.

    Show 3 child attributesHide child attributes
    • show_paymentboolean

      Whether payment details and savings show in the cart.

    • show_shippingboolean

      Whether the fulfillment timeline shows in the cart.

    • custom_textnull

      Free text added to every preorder cart line. Null when not set.

  • purchase_option_rulesobject

    Plain-sentence rules about the Shopify purchase option (checkout_method selling_plan) for this offer. Read-only.

    Show 2 child attributesHide child attributes
    • cannot_combine_withstring

      Settings that cannot be on while the purchase option is on. Present while it is on.

    • payment_gatewaysstring

      What the purchase option means for payment gateways. Present while it is on.

Errors

404
not_found

The path is valid but nothing with that id exists in this store.

422
invalid_params

One or more fields failed the action's schema.

422
validation_failed

The request failed validation.

Any request can also fail with auth_invalid (401) or rate_limited (429).

Every error has the same shape: see Errors and the list of error codes.

GET/preorders/offers/{id}/advanced
curl "https://app.stoqapp.com/api/v2/external/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977/advanced" \
  -H "X-Auth-Token: $STOQ_API_KEY"
Response
{
  "checkout_method": "selling_plan",
  "cart_attributes": {
    "show_payment": true,
    "show_shipping": true,
    "custom_text": null
  },
  "purchase_option_rules": {
    "cannot_combine_with": "string",
    "payment_gateways": "string"
  }
}