Skip to content

Create products set source to all

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

POST
/preorders/offers/{id}/products/set_source_to_all
curl --request POST \
--url https://app.stoqapp.com/api/v2/external/preorders/offers/example/products/set_source_to_all \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: <X-Auth-Token>' \
--data '{ "confirm": "string", "exclusion_tag": "string", "excluded_variant_ids": [ "string" ] }'

Switch the offer to apply to every variant in the shop, minus exclusions. Requires confirm: true.

Note: Requires confirm: true in the body. Resolution runs async over the entire catalog.

id
required
string
Media typeapplication/json
object
confirm
exclusion_tag
excluded_variant_ids

Example

{
"confirm": "string",
"exclusion_tag": "string",
"excluded_variant_ids": [
"string"
]
}

Success — the updated resource.

Media typeapplication/json
object

Example generated

{}

Accepted — async/bulk work was queued. Poll the returned job.

Media typeapplication/json

Returned for async/bulk work — poll the job until it reaches a terminal state.

object
job_id
string
status_url
string

Example

{
"job_id": "job_a1b2c3",
"status_url": "/api/v2/external/jobs/job_a1b2c3"
}

Missing or invalid X-Auth-Token.

Media typeapplication/json

Error envelope returned by every failed request.

object
errors
required
Array<string>

Example

{
"errors": [
"Unauthorized"
]
}

The resource does not exist for this shop, or the action path is not registered.

Media typeapplication/json

Error envelope returned by every failed request.

object
errors
required
Array<string>

Example

{
"errors": [
"Offer not found"
]
}

The request failed validation.

Media typeapplication/json

Error envelope returned by every failed request.

object
errors
required
Array<string>

Example

{
"errors": [
"name is required"
]
}

Rate limited — cost-weighted per token (read 1, write 2; 360 points / 60s). Check Retry-After.

Media typeapplication/json

Error envelope returned by every failed request.

object
errors
required
Array<string>

Example

{
"errors": [
"Rate limit exceeded"
]
}
Was this page helpful?

Still stuck? Ask Quinn or chat with support