Skip to content

Update integrations

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

PATCH/preorders/offers/{id}/integrations

Costs 2 rate-limit points · Rate limits

Update any subset of the POS and B2B settings on a preorder offer.

Deep partial: absent fields are unchanged. This does not configure marketing or email integrations, which are shop-level.

Also searched asedit integrationschange integration settingsmodify integrationsenable posturn on posallow in posenable point of saledisable posturn off posblock from posdisable point of saleenable pos skip inventory checkskip inventory check on posbypass inventory at posallow pos sale without inventoryskip pos inventory checkdisable pos skip inventory checkenforce inventory check at posstop bypassing inventory at posenable b2bturn on b2ballow b2benable wholesaledisable b2bturn off b2bblock b2bdisable wholesaleb2b preorderswholesale preorderssell on pospos preorders

Path parameters

Headers

  • Idempotency-Keystring

    A fresh unique key for every write (a new UUID, say); reuse it only to retry that write. Keys are remembered for 1 hour: the same key and the same request within that hour returns the first result, with Idempotent-Replayed: true, without running again; the same key with a different method, path or body is refused (422 idempotency_key_reused); a retry while the first is still running gets 409 idempotency_key_in_progress. Keys are per store. Server errors and rate limits are not kept, so their retry runs.

Request body

  • posobject

    Point of Sale settings for the offer.

    Show 2 child attributesHide child attributes
    • enable_posboolean

      Sell preorders on POS.

    • inventory_checkstring

      skip sells on POS without checking inventory; required keeps the inventory check.

      One of skiprequired
  • b2bobject

    B2B settings for the offer.

    Show 1 child attributeHide child attributes
    • enable_b2bboolean

      Allow B2B customers to place preorders on this offer.

Returns

  • posobject

    Point of Sale settings.

    Show 2 child attributesHide child attributes
    • enable_posboolean

      Whether preorders can be sold on POS.

    • inventory_checkstring

      skip sells on POS without checking inventory; required keeps the inventory check.

      One of skiprequired
  • b2bobject

    B2B settings.

    Show 1 child attributeHide child attributes
    • enable_b2bboolean

      Whether B2B customers can place preorders on this offer.

Errors

404
not_found

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

409
idempotency_key_in_progress

An earlier request with the same Idempotency-Key is still running. Wait, then resend the same request with the same key.

422
invalid_params

One or more fields failed the action's schema.

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.

PATCH/preorders/offers/{id}/integrations
curl -X PATCH "https://app.stoqapp.com/api/v2/external/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977/integrations" \
  -H "X-Auth-Token: $STOQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "pos": {
      "enable_pos": true,
      "inventory_check": "skip"
    },
    "b2b": {
      "enable_b2b": false
    }
  }'
Response
{
  "pos": {
    "enable_pos": true,
    "inventory_check": "skip"
  },
  "b2b": {
    "enable_b2b": false
  }
}