Create products add variants

POST

/preorders/offers/{id}/products/add_variants

curl --request POST \
  --url https://app.stoqapp.com/api/v2/external/preorders/offers/example/products/add_variants \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: <X-Auth-Token>' \
  --data '{ "variant_ids": [ 47284734423096, 47284734455864, 47284734488632 ] }'

• Production

Attach variants to a custom-source preorder offer.

Note: Custom source only. Idempotent: already-attached variants are skipped and reported under already_present. Runs through BulkVariantAdditionService (async).

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

id

required

string

Request Body^required

Media typeapplication/json

object

variant_ids

Example

{
  "variant_ids": [
    47284734423096,
    47284734455864,
    47284734488632
  ]
}

Responses

200

Success — example response shown.

Media typeapplication/json

object

Example

{
  "source": "custom",
  "variants": {
    "count": 6,
    "url": "/api/v2/external/preorders/offers/1/products/variants"
  },
  "custom": {
    "variant_ids_sample": [
      47284734423096,
      47284734455864,
      47284734488632,
      47284734521400,
      47284734554168,
      47284734586936
    ]
  }
}

202

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"
}

401

Missing or invalid X-Auth-Token.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "Unauthorized"
  ]
}

404

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"
  ]
}

422

The request failed validation.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

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

429

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"
  ]
}