Add To Offer

POST

/preorders/products/add_to_offer

curl --request POST \
  --url https://app.stoqapp.com/api/v2/external/preorders/products/add_to_offer \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: <X-Auth-Token>' \
  --data '{ "offer_id": "string", "shopify_variant_ids": [ "45000000001" ], "inventory_policy": "string" }'

• Production

Add variants to one preorder offer as the store-wide Products tab’s ‘Add to offer’ does. Like the tab, it runs no pre-flight check.

Note: shopify_variant_ids are up to 100 Shopify variant gids. Unlike /preorders/offers/:id/products/add_variants, this does not run the pre-flight check, because the tab’s ‘Add to offer’ does not: variants are added even when other offers already have them, ‘Continue selling’ is off, or a sales channel can’t sell preorders. Use add_variants to get those warnings first. Offers whose markets.scope is selected cannot be picked, and variants another market-specific offer owns are left out (skipped_market_variant_count). inventory_policy: CONTINUE then turns ‘Continue selling’ on for the variants, on an out-of-stock offer only, as the tab’s ‘Turn on Continue selling’ choice does; omit it to leave their policy. Finishes before the response.

Authorizations

• ApiKeyAuth

Request Body^required

Media typeapplication/json

object

offer_id

shopify_variant_ids

inventory_policy

Example

{
  "offer_id": "string",
  "shopify_variant_ids": [
    "45000000001"
  ],
  "inventory_policy": "string"
}

Responses

200

Success — the updated resource.

Media typeapplication/json

object

Example ^generated

{}

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

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