Skip to content

Get integrations

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

GET/preorders/offers/{id}/integrations

Costs 1 rate-limit point · Rate limits

Read integration settings for a preorder offer (POS, B2B).

Both are on for a new offer. enable_pos false keeps the offer out of STOQ's Shopify POS extension, so staff can't take preorders for its products there. inventory_check skip lets POS take a preorder even when the variant is in stock (a reached quantity limit still blocks it), and only matters while enable_pos is true. enable_b2b false hides the Preorder button from B2B customers. Edit with PATCH /preorders/offers/:id/integrations.

Also searched asget integrationsshow integrationsview pos settingsview b2b settingsintegration settings

Path parameters

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.

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}/integrations
curl "https://app.stoqapp.com/api/v2/external/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977/integrations" \
  -H "X-Auth-Token: $STOQ_API_KEY"
Response
{
  "pos": {
    "enable_pos": true,
    "inventory_check": "skip"
  },
  "b2b": {
    "enable_b2b": true
  }
}