Get integrations
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/preorders/offers/{id}/integrationsCosts 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
idstringRequiredThe offer's ID, from
GET /preorders/offers.
Returns
posobjectPoint of Sale settings.
Show 2 child attributesHide child attributes
enable_posbooleanWhether preorders can be sold on POS.
inventory_checkstringskip sells on POS without checking inventory; required keeps the inventory check.
One ofskiprequired
b2bobjectB2B settings.
Show 1 child attributeHide child attributes
enable_b2bbooleanWhether B2B customers can place preorders on this offer.
Errors
not_foundThe path is valid but nothing with that id exists in this store.
invalid_paramsOne or more fields failed the action's schema.
validation_failedThe 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.
curl "https://app.stoqapp.com/api/v2/external/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977/integrations" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977/integrations", {
headers: {
"X-Auth-Token": process.env.STOQ_API_KEY,
},
});
const data = await res.json();import os
import requests
res = requests.get(
"https://app.stoqapp.com/api/v2/external/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977/integrations",
headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.stoqapp.com/api/v2/external/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977/integrations")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"pos": {
"enable_pos": true,
"inventory_check": "skip"
},
"b2b": {
"enable_b2b": true
}
}{
"errors": [
"Invalid API key"
],
"code": "auth_invalid",
"details": [
{
"code": "auth_invalid",
"message": "Invalid API key",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"Offer not found"
],
"code": "not_found",
"details": [
{
"code": "not_found",
"message": "Offer not found",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"name is required"
],
"code": "validation_failed",
"details": [
{
"code": "validation_failed",
"message": "name is required",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"Rate limit exceeded"
],
"code": "rate_limited",
"details": [
{
"code": "rate_limited",
"message": "Rate limit exceeded",
"path": null,
"value": null,
"expected": null
}
]
}